Class: JekyllImgFlow::ManifestManager

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll-imgflow/manifest_manager.rb

Overview

Manages the manifest of generated images Tracks default vs specialized versions and page usage for cleanup

Constant Summary collapse

VERSION_TYPES = 
%w[default specialized].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(site) ⇒ ManifestManager

Returns a new instance of ManifestManager.



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 13

def initialize(site)
  @site = site
  @config = JekyllImgFlow::Config.new(site)
  @file_cleaner = GeneratedFileCleaner.new(site, @config)
  @manifest_path = File.join(@site.source, @config.cache_dir, "imgflow-manifest.json")
  @legacy_manifest_paths = legacy_manifest_paths
  @manifest = load_manifest(manifest_load_path)
  @current_provider = current_provider

  # Check if provider changed and invalidate cache if needed
  handle_provider_change if provider_changed?
end

Instance Attribute Details

#manifest_path ⇒ Object (readonly)

Returns the value of attribute manifest_path.



11
12
13
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 11

def manifest_path
  @manifest_path
end

Instance Method Details

#cleanup_deleted_originals(current_originals) ⇒ Object

Clean up manifest entries for deleted original images

Parameters:

  • current_originals (Array<String>) —

    Paths relative to the originals directory



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 103

def cleanup_deleted_originals(current_originals)
  current_set = current_originals.to_set

  @manifest.each_key do |original_name|
    next if current_set.include?(original_name)

    data = @manifest.delete(original_name)
    VERSION_TYPES.each do |type|
      (data.dig("versions", type) || []).each do |version|
        @file_cleaner.delete(version["output"])
      end
    end
    Jekyll.logger.debug "🗑️  Removed manifest entry for deleted original: #{original_name}"
  end
end

#cleanup_obsolete_defaults(expected_operations) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 119

def cleanup_obsolete_defaults(expected_operations)
  @manifest.each_value do |data|
    versions = data.dig("versions", "default") || []
    versions.reject! do |version|
      obsolete = expected_operations.none? do |operations|
        same_operations?(version["operations"], operations)
      end
      @file_cleaner.delete(version["output"]) if obsolete
      obsolete
    end
  end
end

#cleanup_orphans ⇒ Object

Cleanup orphaned specialized images



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 321

def cleanup_orphans
  orphans = find_orphans
  cleaned = []

  orphans.each do |orphan|
    if @file_cleaner.delete(orphan["output"])
      cleaned << orphan["output"]
      Jekyll.logger.info "🗑️  Cleaned orphaned image: #{orphan['output']}"
    end

    # Remove from manifest
    versions = @manifest.dig(orphan["original"], "versions", "specialized") || []
    versions.reject! { |v| same_operations?(v["operations"], orphan["operations"]) }
  end

  cleaned
end

#current_provider ⇒ Object

Get current provider from site config



99
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 99

def current_provider = @config.backend_priority&.first || "unknown"

#default_version?(original_name, operations) ⇒ Boolean

Check if image version is default type

Returns:

  • (Boolean) 


281
282
283
284
285
286
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 281

def default_version?(original_name, operations)
  return false unless @manifest[original_name]

  versions = @manifest.dig(original_name, "versions", "default") || []
  versions.any? { |v| same_operations?(v["operations"], operations) }
end

#find_orphans ⇒ Object

Find orphaned specialized images (not used on any page)



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 289

def find_orphans
  orphans = []

  @manifest.each do |original_name, data|
    specialized = data.dig("versions", "specialized") || []
    specialized.each do |version|
      next unless version["used_on"].nil? || version["used_on"].empty?

      orphans << {
        "original" => original_name,
        "output" => version["output"],
        "operations" => version["operations"]
      }
    end
  end

  orphans
end

#get_version_output(original_name, operations, type = :specialized) ⇒ Object

Get output path for a specific version



203
204
205
206
207
208
209
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 203

def get_version_output(original_name, operations, type = :specialized)
  return unless @manifest[original_name]

  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  version = versions.find { |v| same_operations?(v["operations"], operations) }
  version&.dig("output")
end

#get_versions(original_name) ⇒ Object

Get all versions for an original image



340
341
342
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 340

def get_versions(original_name)
  @manifest.dig(original_name, "versions") || { "default" => [], "specialized" => [] }
end

#handle_provider_change ⇒ Object

Handle provider change by invalidating cache and cleaning optimized directory



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 184

def handle_provider_change
  Jekyll.logger.warn "ImgFlow:",
                     "Provider changed from '#{@cached_provider}' to '#{@current_provider}'"
  Jekyll.logger.warn "ImgFlow:", "Invalidating cache and cleaning optimized directory..."

  deleted_count = @file_cleaner.clear
  Jekyll.logger.warn "ImgFlow:",
                     "Deleted #{deleted_count} cached images from optimized directory"

  # Clear manifest cache
  @manifest.clear
  Jekyll.logger.warn "ImgFlow:",
                     "Manifest cache cleared - all images will be regenerated with '#{@current_provider}'"

  # Update cached provider to current
  @cached_provider = @current_provider
end

#load_manifest(path = @manifest_path) ⇒ Object

Load existing manifest or create new one



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 27

def load_manifest(path = @manifest_path)
  if path && File.exist?(path)
    begin
      data = JSON.parse(File.read(path))

      # Handle new format with provider at top level
      if data.is_a?(Hash) && data.key?("images")
        @cached_provider = data["provider"]
        images = data["images"] || {}
      else
        # Old format - just image data
        @cached_provider = nil
        images = data
      end

      migrate_legacy_manifest(images)
    rescue JSON::ParserError => e
      Jekyll.logger.warn "ImgFlow: Corrupt manifest file, starting fresh: #{e.message}"
      @cached_provider = nil
      {}
    end
  else
    @cached_provider = nil
    {}
  end
end

#migrate_legacy_manifest(images) ⇒ Object

Detect and migrate legacy manifest entries (pre-0.1.11 format). Old entries have operations like 400 without format/quality and no file_digest. Clearing them lets the build re-register existing output files without reprocessing (output_up_to_date? check handles this).



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 58

def migrate_legacy_manifest(images)
  legacy = images.any? do |_name, data|
    versions = data.dig("versions", "default") || []
    versions.any? { |v| v["file_digest"].nil? || !v["operations"].key?("format") }
  end
  if legacy
    Jekyll.logger.info "ImgFlow: Detected legacy manifest format, " \
                       "clearing entries for re-registration."
    images.clear
  end
  images
end

#normalize_operations(operations) ⇒ Object

Normalize operations for consistent comparison after JSON persistence.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 141

def normalize_operations(operations)
  case operations
  when Hash
    operations.to_h do |key, value|
      [key.to_s, normalize_operations(value)]
    end
  when Array
    operations.map { |value| normalize_operations(value) }
  when Symbol
    operations.to_s
  else
    operations
  end
end

#provider_changed? ⇒ Boolean

Check if the provider has changed since the manifest was created

Returns:

  • (Boolean) 


175
176
177
178
179
180
181
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 175

def provider_changed?
  # If no cached provider, this is a new manifest
  return false if @cached_provider.nil?

  # Provider changed if current doesn't match cached
  @cached_provider != @current_provider
end

#register_version(original_name, output_path, operations, type, page_path, file_digest = nil, provider = nil) ⇒ Object

Register a new image version



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 233

def register_version(original_name, output_path, operations, type, page_path,
                     file_digest = nil, provider = nil)
  @manifest[original_name] ||= {
    "versions" => { "default" => [], "specialized" => [] },
    "file_digest" => file_digest # Store SHA256 digest of original file
  }

  # Update file digest if provided
  @manifest[original_name]["file_digest"] = file_digest if file_digest

  versions = @manifest[original_name]["versions"][type.to_s] ||= []
  normalized_operations = normalize_operations(operations)

  # Find or create version entry
  version = versions.find { |v| same_operations?(v["operations"], normalized_operations) }

  # Normalize page_path to array
  page_paths = if page_path.is_a?(Array)
                 page_path
               else
                 (page_path ? [page_path] : [])
               end

  if version
    # Add pages to used_on list if not already present
    version["used_on"] ||= []
    page_paths.each do |path|
      version["used_on"] << path if path && !version["used_on"].include?(path)
    end
    version["output"] = output_path
    version["file_digest"] = file_digest if file_digest
    # Update provider if provided
    version["provider"] = provider if provider
  else
    # Create new version entry
    versions << {
      "output" => output_path,
      "operations" => normalized_operations,
      "type" => type.to_s,
      "used_on" => page_paths,
      "created_at" => Time.now.to_i,
      "file_digest" => file_digest,
      "provider" => provider
    }
  end
end

#remove_page_usage(page_path) ⇒ Object

Remove page from all image version usage tracking



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 309

def remove_page_usage(page_path)
  @manifest.each_value do |data|
    VERSION_TYPES.each do |type|
      versions = data.dig("versions", type) || []
      versions.each do |version|
        version["used_on"]&.delete(page_path)
      end
    end
  end
end

#reset_page_usage ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 132

def reset_page_usage
  @manifest.each_value do |data|
    (data.dig("versions", "specialized") || []).each do |version|
      version["used_on"] = []
    end
  end
end

#same_operations?(left, right) ⇒ Boolean

Returns:

  • (Boolean) 


156
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 156

def same_operations?(left, right) = normalize_operations(left) == normalize_operations(right)

#save ⇒ Object

Save manifest to disk



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 72

def save
  # Store current provider at top level of manifest
  manifest_data = {
    "provider" => @current_provider,
    "images" => @manifest
  }
  content = JSON.pretty_generate(manifest_data)
  if File.exist?(@manifest_path) && File.binread(@manifest_path) == content
    cleanup_legacy_manifests
    return
  end

  directory = File.dirname(@manifest_path)
  temporary_path = "#{@manifest_path}.tmp-#{Process.pid}-#{Thread.current.object_id}"
  FileUtils.mkdir_p(directory)
  File.open(temporary_path, "wb") do |file|
    file.write(content)
    file.flush
    file.fsync
  end
  File.rename(temporary_path, @manifest_path)
  cleanup_legacy_manifests
ensure
  FileUtils.rm_f(temporary_path) if temporary_path
end

#update_page_usage(original_name, operations, type, page_path) ⇒ Object

Update page usage for an existing version This is a convenience method that calls register_version



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 213

def update_page_usage(original_name, operations, type, page_path)
  Jekyll.logger.debug "🔍 update_page_usage: original_name=#{original_name}, operations=#{operations.inspect}, type=#{type}, page_path=#{page_path}"

  # Get the existing version's output path (already relative)
  output_path = get_version_output(original_name, operations, type)
  Jekyll.logger.debug "🔍 update_page_usage: output_path=#{output_path}"
  return unless output_path

  # Get the existing version to preserve provider
  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  version = versions.find { |v| same_operations?(v["operations"], operations) }
  provider = version&.dig("provider")
  Jekyll.logger.debug "🔍 update_page_usage: provider=#{provider}, current used_on=#{version&.dig('used_on')&.inspect}"

  # Call register_version to update page usage (output_path is already relative)
  register_version(original_name, output_path, operations, type, page_path, nil, provider)
  Jekyll.logger.debug "🔍 update_page_usage: completed register_version call"
end

#version_exists?(original_name, operations, type = :specialized, file_digest = nil) ⇒ Boolean

Check if a specific image version exists and is up-to-date

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 159

def version_exists?(original_name, operations, type = :specialized, file_digest = nil)
  return false unless @manifest[original_name]

  # Provider change is already handled in initialize, so just check operations
  versions = @manifest.dig(original_name, "versions", type.to_s) || []
  Jekyll.logger.debug "🔍 ManifestManager: Looking for operations: #{operations.inspect} in #{versions.length} #{type} versions"

  result = versions.any? do |version|
    same_operations?(version["operations"], operations) &&
      (!file_digest || version["file_digest"] == file_digest)
  end
  Jekyll.logger.debug "🔍 ManifestManager: Final result: #{result}"
  result
end

#versions?(original_name) ⇒ Boolean

Check if original image has any versions

Returns:

  • (Boolean) 


345
346
347
348
349
350
 
# File 'lib/jekyll-imgflow/manifest_manager.rb', line 345

def versions?(original_name)
  return false unless @manifest[original_name]

  versions = @manifest[original_name]["versions"]
  (versions["default"]&.any? || false) || (versions["specialized"]&.any? || false)
end