jekyll-cloudinary 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3cc2859c5c4fea6e38e98866189e0bbb97b49c5
+  data.tar.gz: 68e5e29e4c1af56b889e300183c749cd899197cd
+SHA512:
+  metadata.gz: 1b6e1b313d511dddd19db4cc105649f696abce40a3e7efb25d272d8b33840d38bc1ff2ac2480ffc9ab6cd6fe3000e000f46727bf8b7260111df7ca2bcb898105
+  data.tar.gz: 10e9f60d5cbf6862dcd543bc7b24f8fd8f7989bb8484a6fa2ae86ce1c1faac0a175cc9f5712eb96e6214b94b7d9a84d383f566ed25f19f4cb12598e25ef1c616

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-post-files.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Hoizey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# jekyll-cloudinary
+
+Liquid tag for Jekyll to use Cloudinary for optimized responsive posts images.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/jekyll-cloudinary.rb

@@ -0,0 +1 @@
+require "jekyll/cloudinary"

data/lib/jekyll/cloudinary.rb

@@ -0,0 +1,179 @@
+=begin
+  Liquid tag to use Cloudinary for optimized responsive posts images.
+  Usage:
+    {% cloudinary [preset] path/to/img.jpg [attr="value"] %}
+  Examples:
+    {% cloudinary image1.jpg alt="alternate" %}
+    {% cloudinary onethird image2.jpg alt="other" title="yet another one" %}
+
+  Configuration
+    In _config.yml:
+
+    cloudinary:
+      api_id: …
+      auto: true
+      verbose: true
+      presets:
+        default:
+          min_size: 320
+          max_size: 1600
+          steps: 5
+          sizes: "(min-width: 50rem) 50rem, 90vw"
+          attributes:
+            class: onethird
+
+=end
+module Jekyll
+  module Cloudinary
+
+    class CloudinaryTag < Liquid::Tag
+      # priority :normal
+
+      require "RMagick"
+
+      def initialize(tag_name, markup, tokens)
+        @markup = markup
+        super
+      end
+
+      def render(context)
+
+        # Default settings
+        preset_defaults = {
+          "min_width" => 320,
+          "max_width" => 1200,
+          "steps" => 5,
+          "sizes" => "100vw",
+          "caption" => "auto",
+          "attributes" => { },
+          "verbose" => false
+        }
+
+        # Settings
+        site = context.registers[:site]
+        url = site.config['url']
+        settings = site.config['cloudinary']
+
+        preset_user_defaults = {}
+        if settings['presets']
+          if settings['presets']['default']
+            preset_user_defaults = settings['presets']['default']
+          end
+        end
+
+        preset = preset_defaults.merge(preset_user_defaults)
+
+        # Render any liquid variables in tag arguments and unescape template code
+        rendered_markup = Liquid::Template.parse(@markup).render(context).gsub(/\\\{\\\{|\\\{\\%/, '\{\{' => '{{', '\{\%' => '{%')
+
+        # Extract tag segments
+        markup = /^(?:(?<preset>[^\s.:\/]+)\s+)?(?<image_src>[^\s]+\.[a-zA-Z0-9]{3,4})\s*(?<html_attr>[\s\S]+)?$/.match(rendered_markup)
+        raise "Cloudinary can't read this tag. Try {% cloudinary [preset] path/to/img.jpg [attr=\"value\"] %}." unless markup
+
+        image_src = markup[:image_src]
+
+        # Build source image URL
+        is_image_path_absolute = /^\/.*$/.match(image_src)
+        if is_image_path_absolute
+          image_path = File.join(site.config['destination'], image_src)
+          image_url = File.join(url, image_src)
+        else
+          image_path = File.join(site.config['destination'], File.dirname(context['page'].url), image_src)
+          image_url = File.join(url, File.dirname(context['page'].url), image_src)
+        end
+
+        # Get source image natural width
+        image = Magick::Image::read(image_path).first
+        natural_width = image.columns
+
+        if markup[:preset]
+          if settings['presets'][markup[:preset]]
+            preset = preset.merge(settings['presets'][markup[:preset]])
+          else
+            if settings['verbose']
+              puts "\n[Cloudinary] '#{markup[:preset]}' preset for the Cloudinary plugin doesn't exist in _config.yml, using the default one"
+            end
+          end
+        end
+
+        attributes = preset['attributes']
+
+        # Deep copy preset for single instance manipulation
+        instance = Marshal.load(Marshal.dump(preset))
+
+        # Process attributes
+        html_attr = if markup[:html_attr]
+                      Hash[ *markup[:html_attr].scan(/(?<attr>[^\s="]+)(?:="(?<value>[^"]+)")?\s?/).flatten ]
+                    else
+                      {}
+                    end
+
+        if instance['attr']
+          html_attr = instance.delete('attr').merge(html_attr)
+        end
+
+        # Classes from the tag should complete, not replace, the ones from the preset
+        if html_attr['class'] && attributes['class']
+          html_attr['class'] << " #{attributes['class']}"
+        end
+        html_attr = attributes.merge(html_attr)
+
+        # Deal with the "caption" attribute as a true <figcaption>
+        if html_attr['caption']
+          caption = html_attr['caption']
+          html_attr.delete('caption')
+        end
+
+        # alt and title attributes should go only to the <img> even when there is a caption
+        img_attr = ""
+        if html_attr['alt']
+          img_attr << " alt=\"#{html_attr['alt']}\""
+          html_attr.delete('alt')
+        end
+        if html_attr['title']
+          img_attr << " title=\"#{html_attr['title']}\""
+          html_attr.delete('title')
+        end
+
+        attr_string = html_attr.map { |a,v| "#{a}=\"#{v}\"" }.join(' ')
+
+        srcset = []
+        steps = preset['steps'].to_i
+        min_width = preset['min_width'].to_i
+        max_width = preset['max_width'].to_i
+        step_width = (max_width - min_width) / steps
+        sizes = preset['sizes']
+
+        if natural_width < min_width
+          if settings['verbose']
+            puts "[Cloudinary] Natural width of source image '#{File.basename(image_src)}' (#{natural_width}px) in #{context['page'].path} not enough for creating any srcset version"
+          end
+          srcset << "http://res.cloudinary.com/#{settings['api_id']}/image/fetch/q_auto,f_auto/#{image_url} #{natural_width}w"
+        else
+          (0..steps).each do |factor|
+            width = min_width + factor * step_width
+            if width <= natural_width
+              srcset << "http://res.cloudinary.com/#{settings['api_id']}/image/fetch/c_scale,w_#{width},q_auto,f_auto/#{image_url} #{width}w"
+            else
+              if settings['verbose']
+                puts "[Cloudinary] Natural width of source image '#{File.basename(image_src)}' (#{natural_width}px) in #{context['page'].path} not enough for creating #{width}px version"
+              end
+            end
+          end
+        end
+        srcset_string = srcset.join(",\n")
+
+        # preset['caption'] can be 'never', 'auto' or 'always'
+        if (caption || preset['caption'] == 'always') && preset['caption'] != 'never'
+          "\n<figure #{attr_string}>\n<img src=\"#{image_url}\" srcset=\"#{srcset_string}\" sizes=\"#{sizes}\" #{img_attr} />\n<figcaption>#{caption}</figcaption>\n</figure>\n"
+        else
+          "<img src=\"#{image_url}\" srcset=\"#{srcset_string}\" sizes=\"#{sizes}\" #{attr_string} #{img_attr} />"
+        end
+      end
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('cloudinary', Jekyll::CloudinaryTag)
+

data/lib/jekyll/cloudinary/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Cloudinary
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cloudinary
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nicolas Hoizey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "    Liquid tag to use Cloudinary for optimized responsive posts images.\n"
+email:
+- nicolas@hoizey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/jekyll-cloudinary.rb
+- lib/jekyll/cloudinary.rb
+- lib/jekyll/cloudinary/version.rb
+homepage: http://github.com/nhoizey/jekyll-cloudinary/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Liquid tag for Jekyll with Cloudinary
+test_files: []