jekyll-image-data 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1693fc705af7e30e9587f5d139d20e304d120d7bc18bc6d53f3363a260c203
-  data.tar.gz: 3c77ee1b74bb0897cbbdfa8551fb0e44ffea3ee6647bb9de83af1d06a25a58a2
+  metadata.gz: c91e1e0aee9d8638fa3251bf005331018ac9396d28f74677db957617570ea9c2
+  data.tar.gz: 951c65eb83606857b7e7998c8621f5cd75736d1553e5d3eb60ff71e3db34c90f
 SHA512:
-  metadata.gz: eb2d3888112455ff91e843f81f69e0bf1b640611c541f00387f0bcba8d19f5686020e5e73377554a2e09a579905b3b3b6cfb2f42763758d5e55645104d12434c
-  data.tar.gz: 25daa12f0fb156a73fe0e165c90282d041d4573cdecc46aa91c4c9550feaf0251af7f9ab3bc0ac608c80cbfb68e58889bc52f095f535e09fdaa30811b5e6c66c
+  metadata.gz: b2b9b48e280d977192e026e0590ec35a981fec6ed1e87038614f4984c9debc6412db559dc6f87a52a4d2b90fc004d84498dd6019b2fd8ed5961b97a8646ca901
+  data.tar.gz: 04d53ed526a13f8477da914c347bd749e62515b48d64f8e93959df701cbf07d411e44d620d3811f350c8b78f43145fc3bddbcbd666ae506fa2200f12894872e2

data/README.md

@@ -2,9 +2,7 @@
 
 [![Build Status](https://travis-ci.org/rukbotto/jekyll-image-data.svg?branch=master)](https://travis-ci.org/rukbotto/jekyll-image-data)
 
-Image data for Jekyll posts and pages. Crawls generated HTML files in search of image
-data ("src" and "alt" attributes) and makes it available as a post/page
-metadata attribute.
+Image data for Jekyll posts and pages. Crawls generated HTML files in search of image data ("src" and "alt" attributes) and makes it available as a post/page metadata attribute.
 
 ## Installation
 
@@ -28,8 +26,7 @@ $ gem install jekyll-image-data
 
 ## Usage
 
-Define your images using Markdown format, plain HTML or by including a
-`.liquid` file:
+Define your images using Markdown format, plain HTML or by including a `.liquid` file:
 
 ```markdown
 ![Alt text](/image-url)
@@ -45,13 +42,12 @@ or
 ```
 
 ```liquid
-{% include image.liquid %}
+{% include image.liquid src="http://placehold.it/800x600" alt="Image" %}
 ```
 
-This plugin gets executed in the `:posts, :post_render` and `:pages,
-:post_render` hooks. After execution, `post.data["images"]` or
-`page.data["images"]` will hold `alt` and `src` data for all images inside
-post/page:
+Note that the included file must be named `image.liquid` or `image.html` and must accept two parameters: `src` and `alt`.
+
+This plugin gets executed in the `:posts, :pre_render` and `:pages, :post_init` hooks. After execution, `post.data["images"]` or `page.data["images"]` will hold `alt` and `src` data for all images inside post/page:
 
 ```ruby
 post.data["images"] = [
@@ -73,31 +69,21 @@ If you don't want data from some images to be included in the `post.data["images
 
 ```yaml
 image_data:
-  exclude:
-    - /media/images/800x600.png
-    - https://upload.wikimedia.org
+  exclude: "/media/images/800x600.png"
 ```
 
-You can put the complete URL of the image or just part of it. In the above example, data from any image that contains the string `/media/images/800x600.png` or `https://upload.wikimedia.org` in the `src` attribute won't be added to the data variable for any post or page.
+Remember this setting is a regular expression. You can put the complete URL of the images or just part of it. In the above example, data from any image that contains the string `/media/images/800x600.png` in the `src` attribute won't be added to the data variable for any post or page.
 
 ## Development
 
-After checking out the repo, run `script/setup` to install dependencies. Then,
-run `rake spec` to run the tests. You can also run `script/console` for an
-interactive prompt that will allow you to experiment.
+After checking out the repo, run `script/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `script/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/rukbotto/jekyll-image-data.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rukbotto/jekyll-image-data.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT
-License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/jekyll-image-data.gemspec

@@ -24,8 +24,7 @@ Gem::Specification.new do |spec|
     end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jekyll", "~> 3.3"
-  spec.add_dependency "nokogiri", "~> 1.8.2"
+  spec.add_dependency "jekyll", "~> 3.4.0"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/jekyll-image-data/crawler.rb

@@ -1,23 +1,41 @@
-require "nokogiri"
-
 module JekyllImageData
   class Crawler
+    def initialize
+      src = %r{(?:https|http|mailto)?(?:\:/)?/\S+}
+      alt = %r{[[[:alnum:]][[:space:]]-]+}
+
+      md_image = %r{!\[(.*)\]\((.*)\)}
+      md_image_ref = %r{!\[(.*)\]\[(.*)\]}
+      html_image = %r{<img.*(src="(#{src})".*alt="(#{alt})"|alt="(#{alt})".*src="(#{src})"|src="(#{src})")}
+      include_image = %r{\{\%\s*include\s*image.(liquid|html)\s*(src="(#{src})".*alt="(#{alt})"|alt="(#{alt})".*src="(#{src})")}
+
+      @image = %r{#{md_image}|#{md_image_ref}|#{html_image}|#{include_image}}
+      @image_ref = %r{\[(.*)\]:\s*(\S*)}
+    end
+
     def crawl(content, config)
       images = []
-      exclude = config.dig("image_data", "exclude") || []
-      html = Nokogiri::HTML(content)
-      html.xpath("//img").each do |item|
-        src = item.xpath("@src").first
-        alt = item.xpath("@alt").first
-        excluded = exclude.select do |exclude_item|
-          src.value.include?(exclude_item)
+      exclude = config.dig("image_data", "exclude") || ""
+      exclude = Regexp.new(exclude)
+
+      content.scan(@image) do |match|
+        src = match[1] || match[5] || match[8] || match[9] || match[12] || match[15] || ""
+        alt = match[0] || match[2] || match[6] || match[7] || match[13] || match[14] || ""
+        ref = match[3] || ""
+        images << { "url" => src, "alt" => alt, "ref" => ref }
+      end
+
+      content.scan(@image_ref) do |match|
+        images.each do |image|
+          image["url"] = match[1] if image["ref"] == match[0]
         end
-        next unless excluded.empty?
-        images << {
-          "url" => src ? src.content : "",
-          "alt" => alt ? alt.content : ""
-        }
       end
+
+      images.each do |image|
+        image.delete("ref")
+        images.delete(image) if exclude.match(image["url"])
+      end
+
       images
     end
   end

data/lib/jekyll-image-data/version.rb

@@ -1,3 +1,3 @@
 module JekyllImageData
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/jekyll-image-data.rb

@@ -5,11 +5,11 @@ require "jekyll-image-data/version"
 module JekyllImageData
   @crawler = Crawler.new
 
-  Jekyll::Hooks.register :posts, :post_render do |post|
+  Jekyll::Hooks.register :posts, :pre_render do |post|
     post.data["images"] = @crawler.crawl(post.content, post.site.config)
   end
 
-  Jekyll::Hooks.register :pages, :post_render do |page|
+  Jekyll::Hooks.register :pages, :post_init do |page|
     page.data["images"] = @crawler.crawl(page.content, page.site.config)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-image-data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jose Miguel Venegas Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Image data for Jekyll posts and pages.