jekyll-bits 0.4.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 358f13f6d9f79531d32f6fb4c07b7d2952676821
-  data.tar.gz: 784166e5b9ba4002bf92b4296c412c14004b8c16
+  metadata.gz: 162d0a9061d3e1902780dd3b30948da8a6498b1d
+  data.tar.gz: feb40e9c53871753e24f71b29fee3f25c92916b1
 SHA512:
-  metadata.gz: 824d846ded68ab1c7fd4da81d99e7ce7404304cc7925a756a74ce47cf18c5d9675c8c7742b284c72ff855b61ba2c9b16339ffa4e6f613cc7f167e265256762b0
-  data.tar.gz: a6caeacb7779e3272860616574933ea910d09f794d9f82abe30601b7e660e66b4f1afe219e3d3b9ef08dbffa2834eb01728febc3251407f62a56ff5d5fef511b
+  metadata.gz: f7c5f566cb617f5db19ce11d47cb61d026f223e4c31a7ed59d48ac3033eb6b41488779e73b89bc93de46012c778c97026d6b719a6c16beb1749c243e6878359b
+  data.tar.gz: 425bde36082f1a9fd24526e1d08984b08361c0a1875ece7d262c0afe8f971e1852f03bd4d883583f961302194b704d86841545ed8d036e485b4de36c42731a82

data/.rubocop.yml

@@ -7,3 +7,11 @@ MethodLength:
   Max: 30
 Metrics/BlockLength:
   Max: 50
+Style/ConditionalAssignment:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/AbcSize:
+  Max: 40

data/README.md

@@ -32,9 +32,12 @@ Or with more details:
 ```yaml
 ---
 jb_picture:
-  src: ... SRC attribute of <IMG>
-  alt: ... ALT attribute of <IMG>
-  href: ... HREF attribute of <A>
+  src: SRC attribute of <IMG> (mandatory)
+  alt: ALT attribute of <IMG> (optional)
+  href: HREF attribute of <A> (optional)
+  caption: text of <FIGCAPTION> (optional)
+  width: width in pixels (optional)
+  height: height in pixels (optional)
 ---
 ```
 

data/Rakefile

@@ -22,10 +22,9 @@
 
 require 'rubygems'
 require 'rake'
-require 'rdoc'
 require 'rake/clean'
 
-CLEAN = FileList['coverage', 'rdoc']
+CLEAN = FileList['coverage']
 
 def name
   @name ||= File.basename(Dir['*.gemspec'].first, '.*')
@@ -35,7 +34,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: [:clean, :test, :rdoc, :rubocop]
+task default: [:clean, :test, :rubocop]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -45,15 +44,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = false
 end
 
-require 'rdoc/task'
-desc 'Build RDoc documentation'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 require 'rubocop/rake_task'
 desc 'Run RuboCop on all directories'
 RuboCop::RakeTask.new(:rubocop) do |task|

data/jekyll-bits.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2.2'
   s.required_ruby_version = '>= 1.9.3'
   s.name = 'jekyll-bits'
-  s.version = '0.4.1'
+  s.version = '0.5'
   s.license = 'MIT'
   s.summary = 'Jekyll Bits'
   s.description = 'Useful and very simple Jekyll plugins'
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('jekyll', '>=1.5.1')
   s.add_development_dependency 'bundler', '~> 1.5'
   s.add_development_dependency 'coveralls', '0.7.0'
-  s.add_development_dependency 'minitest', '5.4.0'
+  s.add_development_dependency 'test-unit', '3.0.8'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rdoc', '3.11'
   s.add_development_dependency 'rubocop', '0.46.0'

data/lib/jekyll-bits/picture.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+#
+# (The MIT License)
+#
+# Copyright (c) 2016 Yegor Bugayenko
+#
+# 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.
+
+require 'liquid'
+
+# Jekyll module
+module Jekyll
+  # All our custom filters
+  module JbFilters
+    def jb_picture_head(page)
+      yaml = page['jb_picture']
+      return unless yaml
+      if yaml.is_a?(Hash)
+        raise "src is absent for jb_picture in #{page.url}" unless yaml['src']
+        src = yaml['src']
+      else
+        src = yaml
+      end
+      "<meta property='og:image' content='#{src}'/>"
+    end
+
+    def jb_picture_body(page)
+      yaml = page['jb_picture']
+      return unless yaml
+      html = "<img itemprop='image' alt='"
+      if yaml.is_a?(Hash) && yaml['alt']
+        html += CGI.escapeHTML(yaml['alt'])
+      else
+        html += 'front image'
+      end
+      html += "' src='"
+      if yaml.is_a?(Hash)
+        raise "src is absent for jb_picture in #{page.url}" unless yaml['src']
+        html += CGI.escapeElement(yaml['src'])
+      else
+        html += yaml
+      end
+      html += "'"
+      html += " width='#{yaml['width']}'" \
+        if yaml.is_a?(Hash) && yaml['width']
+      html += " height='#{yaml['height']}'" \
+        if yaml.is_a?(Hash) && yaml['height']
+      html += '/>'
+      html = "<a href='#{CGI.escapeHTML(yaml['href'])}'>#{html}</a>" \
+        if yaml.is_a?(Hash) && yaml['href']
+      html = "<figure class='jb_picture'>" + html
+      html += "<figcaption>#{CGI.escapeHTML(yaml['caption'])}</figcaption>" \
+        if yaml.is_a?(Hash) && yaml['caption']
+      html + '</figure>'
+    end
+  end
+
+  # Box for testing and calling static methods.
+  class JbBox
+    include JbFilters
+  end
+
+  # Jekyll block
+  class JbPictureBlock < Liquid::Tag
+    def render(context)
+      JbBox.new.jb_picture_body(context.registers[:page])
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::JbFilters)
+Liquid::Template.register_tag('jb_picture_body', Jekyll::JbPictureBlock)

data/lib/jekyll-bits.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+#
 # (The MIT License)
 #
 # Copyright (c) 2016 Yegor Bugayenko
@@ -20,47 +22,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'liquid'
-
-puts 'jekyll-bits is alive'
-
-# Jekyll module
-module Jekyll
-  # All our custom filters
-  module JbFilters
-    def jb_picture_head(page)
-      yaml = page['jb_picture']
-      return unless yaml
-      src = if yaml.is_a?(Array)
-              yaml['src']
-            else
-              yaml
-            end
-      "<meta property='og:image' content='#{src}'/>"
-    end
-
-    def jb_picture_body(page)
-      yaml = page['jb_picture']
-      return unless yaml
-      if yaml.is_a?(Array)
-        "<figure class='jb_picture'><a \
-href='#{CGI.escapeElement(yaml['href'])}'>\
-<img alt='#{CGI.escapeElement(yaml['alt'])}' \
-src='#{CGI.escapeElement(yaml['src'])}'/></a></figure>"
-      else
-        "<figure class='jb_picture'><img \
-alt='front picture' src='#{CGI.escapeElement(yaml)}'/></figure>"
-      end
-    end
-  end
-
-  # Jekyll block
-  class JbPictureBlock < Liquid::Tag
-    def render(context)
-      Jekyll::JbFilters.jb_picture_body(context.registers[:page])
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::JbFilters)
-Liquid::Template.register_tag('jb_picture_body', Jekyll::JbPictureBlock)
+require 'jekyll-bits/picture'

data/test/test_picture.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+#
+# (The MIT License)
+#
+# Copyright (c) 2016 Yegor Bugayenko
+#
+# 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.
+
+require 'test/unit'
+require_relative '../lib/jekyll-bits/picture'
+
+# Picture test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2016 Yegor Bugayenko
+# License:: MIT
+module Jekyll
+  class TestPicture < Test::Unit::TestCase
+    def test_generates_html_simple_head
+      html = JbBox.new.jb_picture_head('jb_picture' => '/img.png')
+      assert_match(/meta/, html)
+      assert_match(/img\.png/, html)
+    end
+
+    def test_generates_html_complex_head
+      html = JbBox.new.jb_picture_head(
+        'jb_picture' => {
+          'src' => '/img2.png'
+        }
+      )
+      assert_match(/meta/, html)
+      assert_match(/img2\.png/, html)
+    end
+
+    def test_generates_html_simple_body
+      html = JbBox.new.jb_picture_body('jb_picture' => '/img1.png')
+      assert_match(/img/, html)
+      assert_match(/figure/, html)
+    end
+
+    def test_generates_html_complex_body
+      html = JbBox.new.jb_picture_body(
+        'jb_picture' => {
+          'src' => '/img1.png',
+          'href' => 'http://www.yegor256.com',
+          'caption' => 'it is <simple>',
+          'alt' => "nothing 'to' say",
+          'width' => 500
+        }
+      )
+      assert_match(/figcaption/, html)
+      assert_match(/figure/, html)
+      assert_match(/<figcaption>it is &lt;simple&gt;/, html)
+      assert_match(/alt='nothing &#39;to&#39; say'/, html)
+      assert_match(/width='500'/, html)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-bits
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2016-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 3.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 3.0.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,8 @@ files:
 - Rakefile
 - jekyll-bits.gemspec
 - lib/jekyll-bits.rb
+- lib/jekyll-bits/picture.rb
+- test/test_picture.rb
 homepage: http://github.com/yegor256/jekyll-bits
 licenses:
 - MIT
@@ -165,4 +167,5 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 2
 summary: Jekyll Bits
-test_files: []
+test_files:
+- test/test_picture.rb