octopress-image-caption-tag 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 580aafb32a39bc4905bc13addc574516a8185a21
+  data.tar.gz: bfb64275f2b77a1508ac1d9ecc21f4420adbf3f9
+SHA512:
+  metadata.gz: f17f366dd0d72b3a1fcc99b116dd120cc91c2af4a07eddba539db01142e9464d5e8d8feee1fbf059a07178dc5fd92742673b832919c2b589c6a26a66a1e8a8a1
+  data.tar.gz: 10f6bc1f9b6585b89c6a776144debe0772148812d617ef1cb171ce65e1d285d9af74d7f589dbf3d24953087c109329d1b0f14b2bc533ae6a02b9c934de9edd5d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+### 0.0.3 (2015-11-14)
+- Added README and tests
+### 0.0.2 (2015-11-13)
+- Initial block version added
+### 0.0.1 (2015-11-13)
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brandon Mathis
+
+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,48 @@
+# Octopress Image Caption Tag
+
+A fork of [octopress/image-tag][img] that incorporates [Robert
+Anderson's][zerosharp] technique, adds extended features, a block version,
+and wraps it all up in a gem.
+
+## Using the Tag version
+```liquid
+{% imgcap [right|left|center] url_or_path 200 200 ["Some Title Text" ["Some alt text"]] %}
+```
+Width and height can be either absolute or as a percentage. By default, width is
+set to 33% for right and left aligned and 100% for centered images, and height
+is auto-scaled.
+
+If no alt text is specified, the title text is used. The title text will be used
+for the caption.
+
+## Using the Block version
+```liquid
+{% imgcaption [right|left|center] url_or_path 200 200 ["Some Title Text" ["Some alt text"]] %}
+**Any** standard [Markdown][md] text can be used in captions using the block
+version.
+{% endimgcaption %}
+```
+The block version uses the same options as the tag version, but instead of using
+the title text for the caption, a block is taken to allow Markdown formatting
+in the caption text.
+
+## Output
+The output for either version is the same, and of the form:
+```html
+<figure class='caption-wrapper right|left|center' style='width:WIDTH'>
+  <a class='image-popup' href='IMGSRC'>
+    <img class='caption' src='IMGSRC' width='100%' title='TITLE' alt='ALT'>
+  </a>
+  <figcaption class='caption-text'>CAPTION</figcaption>
+</figure>
+```
+
+## Styling
+This gem does not include stylesheets for the image captions. [Robert
+Anderson's][zerosharp] original blog post includes a nice example of how to
+style them.
+
+
+[md]: https://daringfireball.net/projects/markdown/
+[img]: https://github.com/octopress/image-tag
+[zerosharp]: http://blog.zerosharp.com/image-captions-for-octopress/

data/lib/octopress-image-caption-tag.rb

@@ -0,0 +1,138 @@
+require "octopress-image-caption-tag/version"
+require "liquid"
+
+# Title: Simple Image tag for Jekyll
+# Authors: Brandon Mathis http://brandonmathis.com
+#          Felix Schäfer, Frederic Hemberger
+#
+
+module Octopress
+  module Tags
+    module ImageCaptionTag
+      class Tag < Liquid::Tag
+        @img = nil
+        @title = nil
+        @class = ''
+        @width = ''
+        @height = ''
+
+        def initialize(tag_name, markup, tokens)
+          if markup =~ /(\S.*\s+)?(https?:\/\/|\/)(\S+)(\s+\d+%?\s+\d+%?)?(\s+.+)?/i
+            @class = $1 || ''
+            @img = $2 + $3
+            if $5
+              @title = $5.strip
+            end
+            if $4 =~ /\s*(\d+%?)\s+(\d+%?)/
+              @width = $1
+              @height = $2
+            elsif @class.rstrip == "right" or @class.rstrip == "left"
+              @width = "33%"
+            else
+              @width = "100%"
+            end
+            if /(?:"|')(?<title>[^"']+)?(?:"|')\s+(?:"|')(?<alt>[^"']+)?(?:"|')/ =~ @title
+              @title  = title
+              @alt    = alt
+            else
+              @alt    = @title.gsub!(/"/, '&#34;') if @title
+            end
+          end
+          super
+        end
+
+        def render(context)
+          super
+          if @img && @width[-1] == "%" # Relative width, so width goes on outer span
+            "<figure class='#{('caption-wrapper ' + @class).rstrip}' style='width:#{@width};'>" +
+              "<a class='image-popup' href='#{@img}'>" +
+              "<img class='caption' src='#{@img}' width='100%' height='100%' title='#{@title}' alt='#{@alt}'>" +
+              "</a>" +
+              "<figurecaption class='caption-text'>#{@title}</figurecaption>" +
+              "</figure>"
+          elsif @img # Absolute width, so width goes on the img tag and text span gets sytle-width:@width-15;
+            "<figure class='#{('caption-wrapper ' + @class).rstrip}'>" +
+              "<a class='image-popup' href='#{@img}'>" +
+              "<img class='caption' src='#{@img}' width='#{@width}px' height='#{@height}px' title='#{@title}' alt='#{@alt}'>" +
+              "</a>" +
+              "<figurecaption class='caption-text' style='width:#{@width.to_i - 10}px;'>#{@title}</figurecaption>" +
+              "</figure>"
+          else
+            "Error processing input, expected syntax: {% imgcap [class name(s)] /url/to/image [width height] [title [alt]] %}"
+          end
+        end
+      end
+
+      class Block < Liquid::Block
+        @img = nil
+        @title = nil
+        @class = ''
+        @width = ''
+        @height = ''
+
+        def initialize(tag_name, markup, tokens)
+          if markup =~ /(\S.*\s+)?(https?:\/\/|\/)(\S+)(\s+\d+%?\s+\d+%?)?(\s+.+)?/i
+            @class = $1 || ''
+            @img = $2 + $3
+            if $5
+              @title = $5.strip
+            end
+            if $4 =~ /\s*(\d+%?)\s+(\d+%?)/
+              @width = $1
+              @height = $2
+            elsif @class.rstrip == "right" or @class.rstrip == "left"
+              @width = "33%"
+            else
+              @width = "100%"
+            end
+            if /(?:"|')(?<title>[^"']+)?(?:"|')\s+(?:"|')(?<alt>[^"']+)?(?:"|')/ =~ @title
+              @title  = title
+              @alt    = alt
+            else
+              @alt    = @title.gsub!(/"/, '&#34;') if @title
+            end
+          end
+          super
+        end
+
+        def render(context)
+          @caption = super
+          site = context.registers[:site]
+          converter = site.getConverterImpl(Jekyll::Converters::Markdown)
+          if @img && @width[-1] == "%" # Relative width, so width goes on outer span
+            "<figure class='#{('caption-wrapper ' + @class).rstrip}' style='width:#{@width};'>" +
+              "<a class='image-popup' href='#{@img}'>" +
+              "<img class='caption' src='#{@img}' width='100%' height='100%' title='#{@title}' alt='#{@alt}'>" +
+              "</a>" +
+              "<figurecaption class='caption-text'>#{@caption}</figurecaption>" +
+              "</figure>"
+          elsif @img # Absolute width, so width goes on the img tag and text span gets sytle-width:@width-15;
+            "<figure class='#{('caption-wrapper ' + @class).rstrip}'>" +
+              "<a class='image-popup' href='#{@img}'>" +
+              "<img class='caption' src='#{@img}' width='#{@width}px' height='#{@height}px' title='#{@title}' alt='#{@alt}'>" +
+              "</a>" +
+              "<figurecaption class='caption-text' style='width:#{@width.to_i - 10}px;'>#{converter.convert(@caption)}</figurecaption>" +
+              "</figure>"
+          else
+            "Error processing input, expected syntax: {% imgcaption [class name(s)] /url/to/image [width height] [title [alt]] %} Caption Text {% endimgcaption %}"
+          end
+        end
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('imgcap', Octopress::Tags::ImageCaptionTag::Tag)
+Liquid::Template.register_tag('imgcaption', Octopress::Tags::ImageCaptionTag::Block)
+
+if defined? Octopress::Docs
+  Octopress::Docs.add({
+    name:        "Octopress Image Caption Tag",
+    gem:         "octopress-image-caption-tag",
+    description: "A tag to create images with pretty captions for Jekyll and Octopress blogs",
+    path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+    source_url:  "https://github.com/eToThePiIPower/octopress-image-caption-tag",
+    version:     Octopress::Tags::ImageCaptionTag::VERSION
+  })
+end

data/lib/octopress-image-caption-tag/version.rb

@@ -0,0 +1,7 @@
+module Octopress
+  module Tags
+    module ImageCaptionTag
+      VERSION = "0.0.3"
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: octopress-image-caption-tag
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Charles Beynon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: clash
+  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: pry-byebug
+  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: A tag to create images with pretty captions for Jekyll and Octopress
+  blogs.
+email:
+- eToThePiIPower@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/octopress-image-caption-tag.rb
+- lib/octopress-image-caption-tag/version.rb
+homepage: https://github.com/eToThePiIPower/octopress-image-caption-tag
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A tag to create images with pretty captions for Jekyll and Octopress blogs.
+test_files: []