jekyll-auto-image 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18c13b5cac681464310ff3fbb71d4b75fb7a98e8
+  data.tar.gz: 9e07cff0479b14b9f746730b28fd35a3931f9d56
+SHA512:
+  metadata.gz: 954ac3e60846a664cfe7777f8d70307903acf292f67e00904a917592269adf1a5453ee19870beca89c3863066f0f0f58347a1ed53ce8e5cb5a9d4c4246a268c3
+  data.tar.gz: 2dc96f8639b9cbb1440d70182c5563532fa2bf7232355b133f14f34e4646fd5c12deb3f6eb8db889c06f579a3ec7cb2cd394fccafeb2935e866397b8e4b40283

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Merlos
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 merlos
+
+MIT License
+
+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,123 @@
+# jekyll-auto-image plugin
+
+jekyll plugin that makes available the first image of a post in the template as a variable.
+
+This plugin is useful if you want to:
+
+*  list the posts of your jekyll site including an image 
+*  setting the twitter card image 
+
+# Install
+
+Copy `auto-image.rb` into your jekyll `_plugins` directory
+
+
+# Usage
+
+In each post/page, the plugin will set `{{ page.image }}` following this fallback rules:
+
+1. Front matter `image` value
+2. First image in the post/page contents
+3. Default site image (defined in `_config.yml`)
+4. Nothing (false)
+
+Basically, the plugin will return the front matter image value if set. If it is not set, then it will look for the first image asset that is defined in your post content. If the post does not have any image, then it will set the site.image defined in _config.yml.
+
+To set the default image for all pages/posts, add to the  `_config.yml` file the following line:
+
+```yaml
+ # _config.yml
+
+ image: /path/to/your/default/image.png
+```
+
+### Example of usage
+
+Example post 1:
+
+```markdown
+---
+layout: post
+title: Post 1
+---
+
+This is my example post
+
+![first image](/assets/first_image.png)
+
+```
+Example post 2:
+
+```markdown
+---
+layout: post
+title: Post 2
+image: /assets/front_matter_image.png
+---
+
+This is my example post
+
+![first image](/assets/first_image.png)
+
+```
+
+Template:
+
+```liquid
+{% for post in site.posts %}
+title: {{ post.title }}
+<br>
+image: {{ post.image }}
+<hr>
+```
+
+HTML output:
+
+```html
+title: Post 1
+<br>
+image: /assets/first_image.png
+<hr>
+
+title: Post 2
+<br>
+image: /assets/front_matter_image.png
+```
+### Example using twitter cards
+
+You can define a set of `<meta>` elements in your head.html, so when sharing a post in twitter it is displayed in a cool way. You have more info in [twitter's developers page](https://dev.twitter.com/cards/types)
+
+```html
+ <!-- twitter card -->
+  <meta name="twitter:card" content="{% if page.image %}summary_large_image{% else %}summary{% endif %}">
+  <meta name="twitter:site" content="@{{ site.twitter_username }}">
+  <meta name="twitter:creator" content="@{{ site.twitter_username }}">
+  <meta name="twitter:title" content="{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}">
+  <meta name="twitter:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 200 }}{% else %}{{ site.description }}{% endif %}">
+{% if page.image %}
+  <meta name="twitter:image:src" content="{{ page.image | prepend: site.baseurl | prepend: site.url }}"> 
+{% endif %} 
+  <!-- end twitter card -->
+```  
+
+You can validate how it will look using the [cards validator](https://cards-dev.twitter.com/validator)
+
+# To Do List
+
+ * Make the plugin a gem, so it can be installed using `gem install`
+ * add tests cases (see [https://github.com/ivantsepp/jekyll-autolink_email](https://github.com/ivantsepp/jekyll-autolink_email))
+
+# Contributing
+
+1. Fork it (https://github.com/merlos/jekyll-auto-image/fork)
+2. Create your feature branch (`git checkout -b my-new-feature)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (git push origin my-new-feature)
+4. Create a new Pull Request
+
+
+# License
+
+Copyright (c) 2015 Juan M. Merlos. (@merlos) Distributed under MIT License
+
+[www.merlos.org](http://www.merlos.org)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end

data/jekyll-auto-image.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/auto/image/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-auto-image"
+  spec.version       = Jekyll::Auto::Image::VERSION
+  spec.authors       = ["merlos"]
+  spec.email         = ["jmmerlos@merlos.org"]
+  spec.summary       = %q{jekyll plugin that makes available the first image of a post in the template}
+  spec.description   = %q{jekyll plugin that makes available the first image of a post in the template}
+  spec.homepage      = "https://github.com/merlos/jekyll-auto-image"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", '~> 2.0'
+  
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha"
+  
+end

data/lib/jekyll/auto/image.rb

@@ -0,0 +1,57 @@
+require "jekyll/auto/image/version"
+require "jekyll"
+
+module Jekyll
+ 
+  #
+  # Auto Image Generator
+  # 
+  # Sets {{page.image}} variable in liquid with the following fallback:
+  #  
+  #  1) image value in front matter
+  #  2) first image in the post/pàge
+  #  3) _config.yaml image default
+  #  4) nothing (not set)
+  #
+  #  
+  class AutoImageGenerator < Generator
+ 
+    def generate(site)
+      @site = site
+      site.pages.each do |page|
+        img = get_image(page)
+        page.data['image'] = img if img
+      end
+        # Now do the same with posts
+      site.posts.each do |post|
+        img = get_image(post)
+        post.data['image'] = img if img
+      end
+    end # generate
+    
+    #
+    # page: is either a Jekyll::Page or a Jekyll::post
+    # returns the path of the first image found in the contents
+    # of the page/post 
+    #
+    def get_image(page)
+      
+      # debug lines
+      #puts page.title
+      #puts page.name
+      #puts page.ext
+      #puts site.converters.select { |c| c.matches(page.ext) }.sort
+      if page.data['image']
+        return page.data['image']
+      end
+      # convert the contents to html, and extract the first <img src="" apearance
+      # I know, it's not efficient, but rather easy to implement :)
+      htmled = page.transform
+      img_url = htmled.match(/<img.*\ssrc=[\"\']([\S.]+)[\"\']/i)
+      return img_url[1] if img_url != nil 
+      return @site.config['image'] if @site.config['image'] != nil
+      return nil
+    end
+    
+  end # class
+end # module

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

@@ -0,0 +1,7 @@
+module Jekyll
+  module Auto
+    module Image
+      VERSION = "1.0.0"
+    end
+  end
+end

data/test/fixtures/_posts/contents-image.md

@@ -0,0 +1,11 @@
+--
+title: Has an image on the post
+--
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+
+![Image within the contents](/assets/contents-image.png)
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.

data/test/fixtures/contents-html.html

@@ -0,0 +1,14 @@
+---
+title: Page defined with HTML and with an image in the contents
+---
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+</p>
+<img alt="blabla" title="blabla" src="/assets/contents-html.png">
+
+<p>
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+</p>
+<p>
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+</p>

data/test/fixtures/contents-image.md

@@ -0,0 +1,11 @@
+---
+title: Page with an image in the contents
+---
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+
+![Image within the contents](/assets/contents-image.png)
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin finibus, ante ut tincidunt placerat, sapien nulla lobortis tellus, vel consequat quam est eget ligula.

data/test/fixtures/front-matter-image.md

@@ -0,0 +1,8 @@
+---
+title: Page that defines the front matter image
+image: /assets/front-matter-image.png
+---
+
+Although this post has the following image in the contents, the plugin should set the one in the frontmatter
+
+![In post Image](/assets/contents-image.png)

data/test/fixtures/no-image.md

@@ -0,0 +1,5 @@
+---
+title: this page does not have an image
+---
+
+This post does not have an image, in the fallback rules it should display the site.image or nothing if site.image is not defined in _config.yml

data/test/helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'shoulda'
+require 'mocha/mini_test'
+require 'jekyll'
+require 'jekyll/auto/image'

data/test/test_jekyll_auto_image.rb

@@ -0,0 +1,108 @@
+require 'helper'
+
+class Jekyll::AutoImageTest < Minitest::Test
+  def set_page_image (page, image_path) 
+    page.instance_variable_set(:@content, '<img attribute="blabla" src="' + image_path + '">')
+  end
+  
+  context 'AutoImage' do
+    
+    setup do
+      
+      @default_image_path = '/assets/default_image.png'
+          
+      # Sites   
+      @site = Jekyll::Site.new(Jekyll::Configuration::DEFAULTS)
+      
+      @config = Jekyll::Configuration::DEFAULTS.clone
+      @config['image'] = @default_image_path
+      @site_with_default_image = Jekyll::Site.new(@config)
+      
+      # Pages
+      @no_image_page = Jekyll::Page.new(@site, File.expand_path('../fixtures/', __FILE__), '', 'no-image.md')
+      @front_matter_image_page = Jekyll::Page.new(@site, File.expand_path('../fixtures/', __FILE__), '', 'front-matter-image.md')
+      @contents_image_page = Jekyll::Page.new(@site, File.expand_path('../fixtures/', __FILE__), '', 'contents-image.md')
+      @contents_html_page = Jekyll::Page.new(@site, File.expand_path('../fixtures/', __FILE__), '', 'contents-html.html')
+      
+      @auto_image = Jekyll::AutoImageGenerator.new
+      @auto_image.generate(@site)
+      @auto_image_with_default_image = Jekyll::AutoImageGenerator.new
+      @auto_image_with_default_image.generate(@site_with_default_image)
+      
+      #@page.instance_variable_set(:@content, '<div>ivan.tse1@gmail.com</div>')
+      #@site.pages << @page
+      #@email_link = '<div><a href="mailto:ivan.tse1@gmail.com">ivan.tse1@gmail.com</a></div>'
+    end
+    
+        
+    #
+    # FALLBACK LOGIC TESTS
+    #
+    
+    # Tests without {{site.image}}
+    
+    should 'not be defined site image by default' do
+      assert_nil @site.config['image'] 
+    end
+    
+    should 'not return image when not set in config and not included in page' do
+      assert_nil @auto_image.get_image(@no_image_page)
+    end
+    
+     should 'use front matter image whenever defined' do
+      assert_equal @front_matter_image_page.data['image'], @auto_image.get_image(@front_matter_image_page)
+    end
+    
+    should 'detect contents image on markdown' do
+      assert_equal '/assets/contents-image.png', @auto_image.get_image(@contents_image_page)
+    end
+      
+    should 'detect contents image in html' do
+      assert_equal '/assets/contents-html.png',  @auto_image.get_image(@contents_html_page)
+    end
+  
+    # Tests with {{site.image}} defined
+    
+    should 'be defined site_image in config' do
+      assert_equal @default_image_path, @site_with_default_image.config['image'] 
+    end  
+    
+    should 'return default image when page does not have image' do
+      assert_equal @site_with_default_image.config['image'], @auto_image_with_default_image.get_image(@no_image_page)
+    end  
+    
+    should 'return front matter image even if default image is defined' do
+      assert_equal  @front_matter_image_page.data['image'], @auto_image_with_default_image.get_image(@front_matter_image_page)
+    end  
+    
+    
+    #
+    # Tests to check if the regexp works in some use cases
+    #
+    should 'find contents image that includes http' do
+      image ="http://github.com/merlos/jekyll-auto-image/yes.png"
+      set_page_image(@no_image_page,image)
+      assert image, @auto_image.get_image(@no_image_page)
+    end
+    
+    #
+    # Tests to check if the regexp works in some use cases
+    #
+    should 'find image with weird characters in name' do
+      image ="http://github.com/merlos/%$·$%&/(),.-,.-./yes.png"
+      set_page_image(@no_image_page,image)
+      assert image, @auto_image.get_image(@no_image_page)
+    end
+    
+    #
+    # Tests to check if the regexp works in some use cases
+    #
+    should 'not find image with space in name' do
+      image ="http://github.com/merlos/jekyll auto image/yes.png"
+      set_page_image(@no_image_page,image)
+      assert_nil @auto_image.get_image(@no_image_page)
+    end
+    
+    
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-auto-image
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- merlos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: jekyll plugin that makes available the first image of a post in the template
+email:
+- jmmerlos@merlos.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-auto-image.gemspec
+- lib/jekyll/auto/image.rb
+- lib/jekyll/auto/image/version.rb
+- test/fixtures/_posts/contents-image.md
+- test/fixtures/contents-html.html
+- test/fixtures/contents-image.md
+- test/fixtures/front-matter-image.md
+- test/fixtures/no-image.md
+- test/helper.rb
+- test/test_jekyll_auto_image.rb
+homepage: https://github.com/merlos/jekyll-auto-image
+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.2.2
+signing_key: 
+specification_version: 4
+summary: jekyll plugin that makes available the first image of a post in the template
+test_files:
+- test/fixtures/_posts/contents-image.md
+- test/fixtures/contents-html.html
+- test/fixtures/contents-image.md
+- test/fixtures/front-matter-image.md
+- test/fixtures/no-image.md
+- test/helper.rb
+- test/test_jekyll_auto_image.rb
+has_rdoc: