jekyll-image-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 456c90366b3ce72cdfd944852c67147ade715708
+  data.tar.gz: dc561ea2a575e93a8f8d81651bde617882b3441a
+SHA512:
+  metadata.gz: 559660d27bf9e06d28705037ae95ce5474b6ff45c5cd57cb008b82d92813bbe4d88b0511871d659f2d4736b8b71803048fe30f50b0be25b68fd4f610054e5346
+  data.tar.gz: 653af743b2e03bfb1d3de0811f3e5d1033e476cac1f39820ee8d6507e321e77e11a18cb3571a3fd0f35fd8191908867c7532716df48aaf0915beedd81aa5c2a5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/dest/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--tty

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jose Miguel Venegas Mendoza
+
+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,70 @@
+# Jekyll Image Data
+
+[![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 markdown files in search of image
+data ("src" and "alt" attributes) and makes it available as a post/page
+metadata attribute.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "jekyll-image-data"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install jekyll-image-data
+```
+
+## Usage
+
+This plugin gets executed in the `:posts, :pre_render` and `:pages,
+:pre_render` 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"] = [
+  { "alt" => "Alt text", "url" => "/media/images/800x600.png" },
+  { "alt" => "Alt text", "url" => "/media/images/800x600.jpg" },
+  { "alt" => "Alt text", "url" => "/media/images/800x600.gif" }
+]
+```
+
+```liquid
+{% for image in page.images %}
+  <img alt="{{ image.alt }}" src="{{ image.url }}" >
+{% endfor %}
+```
+
+## 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.
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-image-data.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-image-data/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = "jekyll-image-data"
+  spec.version  = JekyllImageData::VERSION
+  spec.authors  = ["Jose Miguel Venegas Mendoza"]
+  spec.email    = ["jvenegasmendoza@gmail.com"]
+  spec.homepage = "https://github.com/rukbotto/jekyll-image-data"
+  spec.license  = "MIT"
+
+  spec.summary     = "Image data for Jekyll posts and pages."
+  spec.description = <<-DESCRIPTION
+    Image data for Jekyll posts and pages. Crawls markdown files in search of
+    image data ("src" and "alt" attributes) and makes it available as a
+    post/page metadata attribute.
+  DESCRIPTION
+
+  spec.files =
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "~> 3.3"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

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

@@ -0,0 +1,31 @@
+module JekyllImageData
+  class Crawler
+    def initialize
+      @alt = %r{!\[(.*)\]}
+      @url = %r{(/[\w/.-]*\.(jpg|png|gif))}
+      @tag = %r{\[(.*)\]}
+      @image = %r{#{@alt}(\(#{@url}\).*|#{@tag})}
+      @reference = %r{#{@tag}: *#{@url}}
+    end
+
+    def crawl(content)
+      images = []
+
+      content.scan(@image) do |match|
+        if $3
+          images << { "alt" => "#{$1}", "url" => "#{$3}" }
+        elsif $5
+          images << { "alt" => "#{$1}", "url" => "#{$5}" }
+        end
+      end
+
+      content.scan(@reference) do |match|
+        images.map do |image|
+          image["url"] = $2 if image["url"] == $1
+        end
+      end
+
+      images
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module JekyllImageData
+  VERSION = "0.1.0"
+end

data/lib/jekyll-image-data.rb

@@ -0,0 +1,15 @@
+require "jekyll"
+require "jekyll-image-data/crawler"
+require "jekyll-image-data/version"
+
+module JekyllImageData
+  @crawler = Crawler.new
+
+  Jekyll::Hooks.register :posts, :pre_render do |post, payload|
+    post.data["images"] = @crawler.crawl(post.content)
+  end
+
+  Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+    page.data["images"] = @crawler.crawl(page.content)
+  end
+end

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/image/crawler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/script/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-image-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Miguel Venegas Mendoza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Image data for Jekyll posts and pages. Crawls markdown files in search of
+      image data ("src" and "alt" attributes) and makes it available as a
+      post/page metadata attribute.
+email:
+- jvenegasmendoza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-image-data.gemspec
+- lib/jekyll-image-data.rb
+- lib/jekyll-image-data/crawler.rb
+- lib/jekyll-image-data/version.rb
+- script/console
+- script/setup
+homepage: https://github.com/rukbotto/jekyll-image-data
+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.10
+signing_key: 
+specification_version: 4
+summary: Image data for Jekyll posts and pages.
+test_files: []