distorted-jekyll 0.5.7 → 0.6.0

data/lib/distorted-jekyll/static_state.rb

@@ -0,0 +1,201 @@
+
+require 'fileutils'
+require 'set'
+
+require 'distorted/error_code'
+
+
+module Jekyll; end
+module Jekyll::DistorteD; end
+
+# This module implements the methods our tag needs in order to
+# pretend to be a Jekyll::StaticFile so we don't need to
+# redundantly re-implement a Generator and Jekyll::Cleaner.
+module Jekyll::DistorteD::StaticState
+
+
+  ATTRIBUTES = Set[:title]
+
+
+  # Returns the to-be-written path of a single standard StaticFile.
+  # The value returned by this method is only the 'main' or 'original'
+  # (even if modified somehow) file and does not include the
+  # path/filenames of any variations.
+  # This method will be called by jekyll/lib/cleaner#new_files
+  # to generate the list of files that need to be build or rebuilt
+  # for a site. For this reason, this method shouldn't do any kind
+  # of checking the real filesystem, since e.g. its URL-based
+  # destdir might not exist yet if the Site.dest is completely blank.
+  def destination(dest_root)
+    File.join(dest_root, @relative_dest, @name)
+  end
+
+  # This method will be called by our monkey-patched Jekyll::Cleaner#new_files
+  # in place of the single-destination method usually used.
+  # This allows us to tell Jekyll about more than a single file
+  # that should be kept when regenerating the site.
+  # This makes DistorteD fast!
+  def destinations(dest_root)
+    wanted_files.map{|f| File.join(dest_root, @relative_dest, f)}
+  end
+
+  # HACK HACK HACK
+  # Jekyll does not pass this method a site.dest like it does write() and
+  # others, but I want to be able to short-circuit here if all the
+  # to-be-generated files already exist.
+  def modified?
+    # Assume modified for the sake of freshness :)
+    modified = true
+
+    site_dest = Jekyll::DistorteD::Floor::config(:destination).to_s
+    if Dir.exist?(site_dest)
+      if Dir.exist?(File.join(site_dest, @relative_dest))
+        extant_files = Dir.entries(File.join(site_dest, @relative_dest)).to_set
+
+        # TODO: Make this smarter. It's not enough that all the generated
+        # filenames should exist. Try a few more ways to detect subtler
+        # "changes to the source file since generation of variations.
+        if wanted_files.subset?(extant_files)
+          Jekyll.logger.debug(@name, "All variations present: #{wanted_files}")
+          modified = false
+        else
+          Jekyll.logger.debug(@name, "Missing variations: #{wanted_files - extant_files}")
+        end
+
+      end  # relative_dest.exists?
+    end  # site_dest.exists?
+    Jekyll.logger.debug("#{@name} modified?",  modified)
+    return modified
+  end  # modified?
+
+  # Whether to write the file to the filesystem
+  #
+  # Returns true unless the defaults for the destination path from
+  # _config.yml contain `published: false`.
+  def write?
+    publishable = defaults.fetch('published'.freeze, true)
+    return publishable unless @collection
+
+    publishable && @collection.write?
+  end
+
+  # Write the static file to the destination directory (if modified).
+  #
+  # dest - The String path to the destination dir.
+  #
+  # Returns false if the file was not modified since last time (no-op).
+  def write(dest_root)
+    plug
+    return false if File.exist?(path) && !modified?
+
+    # Create any directories to the depth of the intended destination.
+    FileUtils.mkdir_p(File.join(dest_root, @relative_dest))
+    # Save every desired variation of this image.
+    # This will be a Set of Hashes each describing the name, type,
+    # dimensions, attributes, etc of each output variation we want.
+    # Full-size outputs will have the special tag `:full`.
+    files.each { |variation|
+      type = variation&.dig(:type)
+      filename = File.join(dest_root, @relative_dest, variation&.dig(:name) || @name)
+
+      if self.respond_to?(type.distorted_method)
+        Jekyll.logger.debug("DistorteD::#{type.distorted_method}", filename)
+        self.send(type.distorted_method, filename, **variation)
+      elsif extname == ".#{type.preferred_extension}"
+        Jekyll.logger.debug(@name, <<~RAWCOPY
+            No #{type.distorted_method} method is defined,
+            but the intended output type #{type.to_s} is the same
+            as the input type, so I will fall back to copying the raw file.
+          RAWCOPY
+        )
+        copy_file(filename)
+      else
+        Jekyll.logger.error(@name, "Missing rendering method #{type.distorted_method}")
+        raise MediaTypeOutputNotImplementedError.new(filename, type, self.class.name)
+      end
+    }
+  end  # write
+
+  private
+
+  def copy_file(dest_path, *a, **k)
+    if @site.safe || Jekyll.env == "production"
+      FileUtils.cp(path, dest_path)
+    else
+      FileUtils.copy_entry(path, dest_path)
+    end
+  end  # copy_file
+
+  # Basic file properties
+
+  # Filename without the dot-and-extension.
+  def basename
+    File.basename(@name, '.*')
+  end
+
+  # Returns the extname /!\ including the dot /!\
+  def extname
+    File.extname(@name)
+  end
+
+  # Returns last modification time for this file.
+  def mtime
+    (@modified_time ||= File.stat(path).mtime).to_i
+  end
+
+  # Returns source file path.
+  def path
+    @path ||= begin
+      # Static file is from a collection inside custom collections directory
+      if !@collection.nil? && !@site.config['collections_dir'.freeze].empty?
+        File.join(*[@base, @site.config['collections_dir'.freeze], @dir, @name].compact)
+      else
+        File.join(*[@base, @dir, @name].compact)
+      end
+    end
+  end
+
+  # Returns a Hash keyed by MIME::Type objects with value as a Set of Hashes
+  # describing the media's output variations to be generated for each Type.
+  def variations
+    changes(abstract(:changes)).map{ |t|
+      [t, outer_limits(abstract(:outer_limits)).map{ |d|
+
+        # Don't change the filename of full-size variations
+        tag = d&.dig(:tag) != :full ? '-'.concat(d&.dig(:tag).to_s) : ''.freeze
+        # Use the original extname for LastResort
+        ext = t == CHECKING::YOU::OUT('application/x.distorted.last-resort') ? File.extname(@name) : t.preferred_extension
+        # Handle LastResort for files that might be a bare name with no extension
+        dot = '.'.freeze unless ext.nil? || ext&.empty?
+
+        d.merge({
+          # e.g. 'SomeImage-medium.jpg` but just `SomeImage.jpg` and not `SomeImage-full.jpg`
+          # for the full-resolution outputs.
+          # The default `.jpeg` preferred_extension is monkey-patched to `.jpg` because lol
+          :name => "#{basename}#{tag}#{dot}#{ext}",
+        })
+
+      }]
+    }.to_h
+  end
+
+  # Returns a flat Set of Hashes that each describe one variant of
+  # media file output that should exist for a given input file.
+  def files
+    filez = Set[]
+    variations.each_pair{ |t,v|
+      # Merge the type in to each variation Hash since we will no longer
+      # have it as the key to this Set in its container Hash.
+      v.each{ |d| filez.add(d.merge({:type => t})) }
+    }
+    filez
+  end
+
+  # Returns a Set of just the String filenames we want for this media.
+  # This will be used by `modified?` among others.
+  def wanted_files
+    files.map{|f| f[:name]}.to_set
+  end
+
+
+end

data/lib/distorted-jekyll/template/13th-style.css

@@ -6,6 +6,7 @@ div.distorted::after {
 }
 div.distorted.svg {background-color: #fbfbf8;}
 div.distorted.pdf > object {min-height: 76vh;}
+div.distorted > video {object-fit: contain;}
 div.distorted-caption {
     color: #8888888;
     margin-top: 0.5em;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distorted-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - okeeblow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,28 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.7
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: ruby-filemagic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 description: Jekyll::DistorteD is a Liquid tag for embedding media in a Jekyll site
   with automatic thumbnailing, cropping, and format conversion.
 email:
@@ -150,27 +122,18 @@ files:
 - lib/distorted-jekyll/13th-style.rb
 - lib/distorted-jekyll/_config_default.yml
 - lib/distorted-jekyll/blocks.rb
-- lib/distorted-jekyll/error_code.rb
 - lib/distorted-jekyll/floor.rb
-- lib/distorted-jekyll/injection_of_love.rb
 - lib/distorted-jekyll/invoker.rb
-- lib/distorted-jekyll/molecule/abstract.rb
+- lib/distorted-jekyll/md_injection.rb
 - lib/distorted-jekyll/molecule/font.rb
 - lib/distorted-jekyll/molecule/image.rb
-- lib/distorted-jekyll/molecule/last-resort.rb
+- lib/distorted-jekyll/molecule/lastresort.rb
 - lib/distorted-jekyll/molecule/pdf.rb
 - lib/distorted-jekyll/molecule/svg.rb
 - lib/distorted-jekyll/molecule/text.rb
 - lib/distorted-jekyll/molecule/video.rb
 - lib/distorted-jekyll/monkey_business/jekyll/cleaner.rb
-- lib/distorted-jekyll/static/font.rb
-- lib/distorted-jekyll/static/image.rb
-- lib/distorted-jekyll/static/lastresort.rb
-- lib/distorted-jekyll/static/pdf.rb
-- lib/distorted-jekyll/static/state.rb
-- lib/distorted-jekyll/static/svg.rb
-- lib/distorted-jekyll/static/text.rb
-- lib/distorted-jekyll/static/video.rb
+- lib/distorted-jekyll/static_state.rb
 - lib/distorted-jekyll/template/13th-style.css
 - lib/distorted-jekyll/template/error_code.liquid
 - lib/distorted-jekyll/template/font.liquid

data/lib/distorted-jekyll/error_code.rb

@@ -1,24 +0,0 @@
-require 'distorted/error_code'
-
-
-module Jekyll
-  module DistorteD
-    class OutOfDateLibraryError < LoadError
-    end
-
-    # The built-in NotImplementedError is for "when a feature is not implemented
-    # on the current platform", so make our own more appropriate ones.
-    class MediaTypeNotImplementedError < StandardDistorteDError
-      attr_reader :media_type, :name
-      def initialize(name)
-        super("No supported media type for #{name}")
-      end
-    end
-    class MediaTypeNotFoundError < StandardDistorteDError
-      attr_reader :media_type, :name
-      def initialize(name)
-        super("Failed to detect media type for #{name}")
-      end
-    end
-  end
-end

data/lib/distorted-jekyll/molecule/abstract.rb

@@ -1,238 +0,0 @@
-require 'set'
-
-require 'distorted-jekyll/floor'
-
-require 'jekyll'
-require 'liquid/errors'
-require 'liquid/template'
-require 'mime/types'
-
-
-module Jekyll
-  module DistorteD
-    module Molecule
-      module Abstract
-
-        # This list should contain global attributes only, as symbols.
-        # The final attribute set will be this + the media-type-specific set.
-        # https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes
-        GLOBAL_ATTRS = Set[:title]
-
-
-        # Returns a Set of Arrays of search keys to try in config()
-        def search_keys(*keys)
-          # It's likely that we will get a default argument of [nil]
-          # here due to the output of attr_value(:whatever) for unset attrs.
-          keys = keys.compact
-          # If a search key path was given, construct one based
-          # on the MIME::Type union Set between the source media
-          # and the plugged MediaMolecule.
-          if keys.empty? or keys.all?{|k| k.nil?}
-            try_keys = @mime.map{ |t|
-              # Use only the first part of complex sub_types like 'svg+xml'
-              [t.media_type, t.sub_type.split('+').first].compact
-            }
-          else
-            # Or use a user-provided config path.
-            try_keys = Set[keys]
-          end
-        end
-
-        # Loads configuration data telling us how to open certain
-        # types of files.
-        def welcome(*keys)
-          # Try each set of keys until we find a match
-          for try in search_keys(*keys)
-            tried = Jekyll::DistorteD::Floor::config(
-              Jekyll::DistorteD::Floor::CONFIG_ROOT,
-              :welcome,
-              *try,
-            )
-            # Is the YAML config of the appropriate structure?
-            if tried.is_a?(Hash)
-              # Non-Hashes may not respond to `empty?`
-              unless tried.empty?
-                return tried
-              end
-            end
-          end
-        end
-
-        # Load configuration telling us what media-types to generate
-        # for any given media-type input.
-        def changes(*keys)
-          out = Set[]
-          # `changes` media-type[sub_type] config will contain information about
-          # what variations output format are desired for what input format,
-          # e.g. {:image => {:jpeg => Set['image/jpeg', 'image/webp']}}
-          # It is not automatically implied that the source format is also
-          # an output format!
-          for try in search_keys(*keys)
-            tried = Jekyll::DistorteD::Floor::config(
-            Jekyll::DistorteD::Floor::CONFIG_ROOT,
-              :changes,
-              *try,
-            )
-            if tried.is_a?(Enumerable) and tried.all?{|t| t.is_a?(String)} and not tried.empty?
-              tried.each{ |t|
-                # MIME::Type.new() won't give us a usable Type object:
-                #
-                # irb> MIME::Types['image/svg+xml'].first.preferred_extension
-                # => "svg"
-                # irb> MIME::Type.new('image/svg+xml').preferred_extension
-                # => nil
-                out.merge(MIME::Types[t])
-              }
-            end
-          end
-
-          # If the config didn't give us any MIME::Type changes
-          # then we will just output the same type we loaded.
-          if out.empty?
-            return @mime
-          else
-            return out
-          end
-        end
-
-        # Loads configuration telling us what variations to generate for any
-        # given type of file, or for an arbitrary key hierarchy.
-        def outer_limits(*keys)
-          out = Set[]
-          # See if any config data exists for each given key hierarchy,
-          # but under the root DistorteD config key.
-          for try in search_keys(*keys)
-            tried = Jekyll::DistorteD::Floor::config(
-              Jekyll::DistorteD::Floor::CONFIG_ROOT,
-              :outer_limits,
-              *try,
-            )
-
-            # Is the YAML config of the appropriate structure?
-            # Merge a shallow copy of it with the Liquid-given attrs.
-            # If we don't take a copy the attrs will be memoized into the config.
-            if tried.is_a?(Enumerable) and tried.all?{|t| t.is_a?(Hash)} and not tried.empty?
-              out.merge(tried.dup.map{ |d| d.merge(attrs) })
-            end
-          end
-
-          # We should output something if the config didn't give us anything.
-          # This is kind of a mess right now with redundancies in the call sites
-          # of things like Molecule::Image. I'll come up with a better general-
-          # purpose fallback solution at some point, but for now this will get
-          # non-Image StaticFiles working with no config :)
-          if out.empty?
-            out << {
-              :tag => :full,
-              :crop => :none,
-            }
-          end
-
-          return out
-        end
-
-        # Returns a Hash of any attribute provided to DD's Liquid tag and its value.
-        def attrs
-          # Value of every Molecule-defined attr will be nil if that attr
-          # is not provided to our Liquid tag.
-          @attrs.keep_if{|attr,val| val != nil}
-        end
-
-        # Returns the value for an attribute as given to the Liquid tag,
-        # the default value if the given value is not in the accepted Set,
-        # or nil for unset attrs with no default defined.
-        def attr_value(attribute)
-          # Set of all supported attributes:
-          # - Global output-element attributes
-          # - Molecule-specific output-element attributes
-          # - Filetype change and output-template config paths
-          accepted_attrs = self.singleton_class.const_get(:GLOBAL_ATTRS) + self.singleton_class.const_get(:ATTRS) + Set[:changes, :outer_limits]
-
-          # Set of acceptable values for the given attribute, e.g. Image::loading => Set[:eager, :lazy]
-          # Will be empty if this attribute takes freeform input (like `title` or `alt`)
-          accepted_vals = self.singleton_class.const_get(:ATTRS_VALUES)&.dig(attribute)
-
-          # The value, if any, provided to our Liquid tag for this attr.
-          liquid_val = attrs&.dig(attribute)
-
-          # Is the requested attribute name defined as an accepted attribute
-          # either globally or within the plugged MediaMolecule?
-          if accepted_attrs.include?(attribute.to_sym)
-
-            # Does this attr define a set of acceptable values?
-            if accepted_vals.is_a?(Set)
-              # Yes, it does. Is the Liquid-given value in that Set of acceptable values?
-              if accepted_vals.include?(liquid_val) or accepted_vals.include?(liquid_val&.to_sym) or accepted_vals.include?(liquid_val&.to_s)
-
-                # Yes, it is! Use it.
-                liquid_val.to_s
-              else
-                # No, it isn't. Warn and return the default.
-                unless liquid_val.nil?
-                  Jekyll.logger.warn('DistorteD', "#{liquid_val.to_s} is not an acceptable value for #{attribute.to_s}: #{accepted_vals}")
-                end
-                self.singleton_class.const_get(:ATTRS_DEFAULT)&.dig(attribute).to_s
-              end
-            elsif accepted_vals.is_a?(Regexp)
-              if accepted_vals =~ liquid_val.to_s
-                liquid_val.to_s
-              else
-                unless liquid_val.nil?
-                  Jekyll.logger.warn('DistorteD', "#{liquid_val.to_s} is not a Regexp match for #{attribute.to_s}: #{accepted_vals}")
-                end
-                self.singleton_class.const_get(:ATTRS_DEFAULT)&.dig(attribute)
-              end
-            else
-              # No, this attribute does not define a Set of acceptable values.
-              # The freeform Liquid-given value is fine, but if it's nil
-              # we can still try for a default.
-              if liquid_val.nil?
-                self.singleton_class.const_get(:ATTRS_DEFAULT)&.dig(attribute)
-              else
-                liquid_val
-              end
-            end
-          else
-            Jekyll.logger.error('DistorteD', "#{attribute.to_s} is not a supported attribute")
-            nil
-          end
-        end
-
-        # Returns a Hash keyed by MIME::Type objects with value as a Set of Hashes
-        # describing the media's output variations to be generated for each Type.
-        def variations
-          changes(attr_value(:changes)).map{ |t|
-            [t, outer_limits(attr_value(:outer_limits)).map{ |d|
-              d.merge({
-                # e.g. 'SomeImage-medium.jpg` but just `SomeImage.jpg` and not `SomeImage-full.jpg`
-                # for the full-resolution outputs.
-                # The default `.jpeg` preferred_extension is monkey-patched to `.jpg` because lol
-                :name => "#{File.basename(@name, '.*')}#{'-'.concat(d&.dig(:tag).to_s) if d&.dig(:tag) != :full}.#{t.preferred_extension}",
-              })
-            }]
-          }.to_h
-        end
-
-        # Returns a flat Set of Hashes that each describe one variant of
-        # media file output that should exist for a given input file.
-        def files
-          filez = Set[]
-          variations.each_pair{ |t,v|
-            # Merge the type in to each variation Hash since we will no longer
-            # have it as the key to this Set in its container Hash.
-            v.each{ |d| filez.add(d.merge({:type => t})) }
-          }
-          filez
-        end
-
-        # Returns a Set of just the String filenames we want for this media.
-        # This will be used by `modified?` among others.
-        def filenames
-          files.map{|f| f[:name]}.to_set
-        end
-
-
-      end  # Abstract
-    end  # Molecule
-  end  # DistorteD
-end  # Jekyll