jekyll_picture_tag 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c92364f9a864fd33948b32ddfb9593b6256d1f14da56cf821175189b30c2ea4
-  data.tar.gz: ea0e199aaafcef76906b61de9a03170c84e6e6e2771bcaf2aa2e9ace7223ca80
+  metadata.gz: 938a170ac5a3ee774c6d8b95ac2a34e20a1edad04937acf49c7e7bdd081f3b81
+  data.tar.gz: 1648ce3bdf88de7acf55c17d675bfab1ce641cf00a1138b3cf32abafc4824e96
 SHA512:
-  metadata.gz: 990f28ad52b23265ae10ab7430060fddc5ef902b03d87fb9fe4d0796dc5ff221720a277d5abca89bdf2cc8973c41994a03dcae8a1ef9ba459af1ac29c53d999b
-  data.tar.gz: cfbd031a3741f63e9653cf098e5e95af411d52081f5b06ca7497d89ad64ed93dd762a0f1655c9752b18104bb913fde0854a157c0948796372439f1d7f026c99e
+  metadata.gz: ce995d57c31dd2beb97c13288a05cca94eaa2ce242e30bcfaf643154dbeec099ce5fa14566b54bd8fc14b21cf8f9da86028fa583f71ad965f368b9db46930ecf
+  data.tar.gz: 105c64ae46f7a5a92c7a198c3ae48e6d49d16493e619107afd0d7c473f577bde43c3baebdfda0692e927fe915f1743dd86ffe8aad7b09c0b48b6b50136625844

data/lib/jekyll_picture_tag/defaults/global.yml

@@ -6,6 +6,7 @@ picture:
   relative_url: true
   cdn_environments: ['production']
   nomarkdown: true
+  ignore_missing_images: false
 
 url: ''
 baseurl: ''

data/lib/jekyll_picture_tag/generated_image.rb

@@ -4,12 +4,14 @@ class GeneratedImage
   require 'mini_magick'
   require 'fastimage'
 
+  attr_reader :width
+
   def initialize(source_file:, width:, format:)
     @source = source_file
     @width  = width
     @format = format
 
-    generate_image unless File.exist? absolute_filename
+    generate_image unless File.exist?(absolute_filename) || @source.missing
   end
 
   def name
@@ -23,10 +25,6 @@ class GeneratedImage
     @absolute_filename ||= File.join(PictureTag.config.dest_dir, name)
   end
 
-  def width
-    @width
-  end
-
   private
 
   def generate_image
@@ -45,7 +43,7 @@ class GeneratedImage
 
     image.write absolute_filename
 
-    FileUtils.chmod(0644, absolute_filename)
+    FileUtils.chmod(0o644, absolute_filename)
   end
 
   # Make sure destination directory exists

data/lib/jekyll_picture_tag/instructions/configuration.rb

@@ -14,7 +14,7 @@ module PictureTag
       # Digs into jekyll context, returns current environment
       def jekyll_env
         # It would be really great if the jekyll devs actually documented
-        # the context object. 
+        # the context object.
         PictureTag.context.environments.first['jekyll']['environment']
       end
 
@@ -51,6 +51,19 @@ module PictureTag
         Utils.markdown_page? && self['picture']['nomarkdown']
       end
 
+      def continue_on_missing?
+        setting = @content['picture']['ignore_missing_images']
+
+        # Config setting can be a string, an array, or a boolean
+        if setting.is_a? Array
+          setting.include? jekyll_env
+        elsif setting.is_a? String
+          setting == jekyll_env
+        else
+          setting
+        end
+      end
+
       private
 
       def build_config
@@ -84,14 +97,14 @@ module PictureTag
       # Juuust complicated enough to extract to its own function.
       def cdn?
         self['picture']['cdn_url'] &&
-          self['picture']['cdn_environments'].include?( jekyll_env )
+          self['picture']['cdn_environments'].include?(jekyll_env)
       end
 
       # https://example.com/my-base-path/assets/generated-images/image.jpg
       # ^^^^^^^^^^^^^^^^^^^^
       # |     domain       |  baseurl   |    j-p-t output dir   | filename
       def domain
-        if cdn? 
+        if cdn?
           self['picture']['cdn_url']
         elsif self['picture']['relative_url']
           ''
@@ -106,12 +119,11 @@ module PictureTag
       def url_prefix
         # We use file.join because the ruby url methods don't like relative
         # urls.
-          File.join(
-            domain,
-            self['baseurl'],
-          )
+        File.join(
+          domain,
+          self['baseurl']
+        )
       end
-
     end
   end
 end

data/lib/jekyll_picture_tag/instructions/preset.rb

@@ -60,8 +60,8 @@ module PictureTag
 
       def no_preset
         Utils.warning(
-          " Preset \"#{@name}\" not found in _data/picture.yml under "\
-          'markup_presets key. Using default values.'
+          " Preset \"#{@name}\" not found in #{PictureTag.config['data_dir']}/"\
+          + 'picture.yml under markup_presets key. Using default values.'
         )
 
         {}

data/lib/jekyll_picture_tag/source_image.rb

@@ -3,7 +3,7 @@ module PictureTag
   # advantage by storing expensive file reads and writes in instance variables,
   # to be reused by many different source images.
   class SourceImage
-    attr_reader :name, :shortname
+    attr_reader :name, :shortname, :missing
 
     def initialize(relative_filename)
       @shortname = relative_filename
@@ -18,12 +18,12 @@ module PictureTag
       size[:width]
     end
 
-    def aspect_ratio
-      @aspect_ratio ||= size[:width].to_f / size[:height].to_f
-    end
-
     def digest
-      @digest ||= Digest::MD5.hexdigest(File.read(@name))[0..5]
+      @digest ||= if @missing
+                    'x' * 6
+                  else
+                    Digest::MD5.hexdigest(File.read(@name))[0..5]
+                  end
     end
 
     # Includes path relative to default sorce folder, and the original filename.
@@ -40,7 +40,12 @@ module PictureTag
     private
 
     def build_size
-      width, height = FastImage.size(@name)
+      if @missing
+        width = 999_999
+        height = 999_999
+      else
+        width, height = FastImage.size(@name)
+      end
 
       {
         width: width,
@@ -52,11 +57,34 @@ module PictureTag
     def grab_file(source_file)
       source_name = File.join(PictureTag.config.source_dir, source_file)
 
-      unless File.exist? source_name
-        raise "Jekyll Picture Tag could not find #{source_name}."
+      if File.exist? source_name
+        @missing = false
+
+      elsif PictureTag.config.continue_on_missing?
+        @missing = true
+        Utils.warning missing_image_warning(source_name)
+
+      else
+        raise missing_image_error(source_name)
       end
 
       source_name
     end
+
+    def missing_image_warning(source_name)
+      <<~HEREDOC
+        Could not find #{source_name}. Your site will have broken images in it.
+        Continuing.
+      HEREDOC
+    end
+
+    def missing_image_error(source_name)
+      <<~HEREDOC
+        Jekyll Picture Tag could not find #{source_name}. You can force the
+        build to continue anyway by setting "picture: ignore_missing_images:
+        true" in "_config.yml". This setting can also accept a jekyll build
+        environment, or an array of environments.
+      HEREDOC
+    end
   end
 end

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/readme.md

@@ -178,6 +178,9 @@ modifications and I'll take care of it.
 
 # Release History
 
+* 1.6.0 Jul  2, 2019:
+  * Missing Preset warning respects `data_dir` setting
+  * Add `continue_on_missing` option
 * 1.5.0 Jun 26, 2019: 
   * better `{::nomarkdown}` necessity detection
   * allow user to override `{::nomarkdown}` autodetection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler