jekyll_pic_container 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d259560f36cc149caf7e9c782b8eb06dd6e8619442a5b9d87de60243117f38b9
+  data.tar.gz: dcbfd7d5b108cf2929e97c89b7fb1d50bbf2ea705881a4dc0aec0f124c6de260
+SHA512:
+  metadata.gz: 6db2a209338cd80c84b7ade2c74fddf26ebac55dfb428bf57d5697d5326d1fdbe9ad347695470b5264e8c632d6691ea37d061469efa40ad98a2d109e5c4f3637
+  data.tar.gz: 5b2a1e09f900a8d1bb23cae11fa37616fd853032fc4cca5891fa9e239c27af3a415b91094d466d4065eba3d975273702273996873500a1eb69aaedd855dfcbf7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Tejus Parikh
+
+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,43 @@
+# JekyllPicContainer
+
+A simple wrapper around [Jekyll Picture Tag](https://github.com/rbuchberger/jekyll_picture_tag) to standardize my usage across
+the different blogs that I manage. This gem is unlikely to be useful to anyone else.
+
+The key benefits is that it adds some markup for easier formatting, will translate an `alt` argument into
+a caption, and provides a standardized way of sharing attribution to 3rd party CC images.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll_pic_container
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll_pic_container
+
+## Usage
+
+This tag supports three arguments, `alt`, `attr_source`, and `attr_text`.
+
+Example:
+
+```
+{% pic_container thumb  --alt Alt Text --attr_source http://picture_site/picture_image.jpg --attr_text Original Author %}
+```
+
+This will render a caption with 'Alt Text' and a link to the picture image.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/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 the created tag, 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/vi_jedi/jekyll_pic_container.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/jekyll_pic_container/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllPicContainer
+  VERSION = "0.1.0"
+end

data/lib/jekyll_pic_container.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "jekyll_pic_container/version"
+require "liquid"
+
+# Namespace for this class
+module JekyllPicContainer
+  # Provices some markup around a picture tag. This tag will process the following arguments:
+  #   --alt Alt text will be placed on the image tag as well as being provided as a caption to the image
+  #   --attr_source A link to an original image that has been copied here. 
+  #   --attr_text The text to correctly credit the original source
+  class PicContainer < Liquid::Tag
+    attr_reader :markup, :tag_arguments
+
+    def initialize(_tag_name, markup, _tokens)
+      @markup = markup
+      @tag_arguments = markup.split(/--/)[1..].freeze
+      super
+    end
+
+    def render(context)
+      tags = ['<div class="picture_container">']
+      tags.push(<<~HTML.strip)
+        {% picture #{markup} %}
+      HTML
+
+      alt = get_argument("alt")
+      tags.push(build_caption(alt)) unless alt.nil?
+      tags.push("</div>")
+
+      content = tags.join(" ")
+      Liquid::Template.parse(content).render(context)
+    end
+
+    # For a tag, the content is the markup of the tag, which means it
+    # has to be manually parsed. Picture tag 2 uses `--` to designate
+    # options after the first required ones
+    def get_argument(arg_name)
+      prefix = "#{arg_name} "
+      raw_value = tag_arguments.filter { |text| text.start_with?(prefix) }.first
+      return unless raw_value
+
+      arg_value = raw_value.dup
+      # Remove the arg prefix from the string
+      arg_value.slice!(prefix)
+
+      arg_value.strip
+    end
+
+    def build_caption(alt)
+      tags = ["<p>"]
+      tags.push(alt)
+
+      attr_source = get_argument("attr_source")
+      unless attr_source.nil?
+        tags.push(" ") # Add a space between the text and the tag
+        tags.push("<a target='_blank' rel='noreferrer' href='#{attr_source}'>")
+        attr_text = get_argument("attr_text")
+        if attr_text.nil?
+          tags.push("original source")
+        else
+          tags.push(attr_text)
+        end
+        tags.push("</a>")
+      end
+
+      tags.push("</p>")
+      tags.join("")
+    end
+  end
+end
+
+Liquid::Template.register_tag("pic_container", JekyllPicContainer::PicContainer)

data/sig/jekyll_pic_container.rbs

@@ -0,0 +1,4 @@
+module JekyllPicContainer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_pic_container
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tejus Parikh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll_picture_tag
+  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'
+description: 
+email:
+- tejus@vijedi.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jekyll_pic_container.rb
+- lib/jekyll_pic_container/version.rb
+- sig/jekyll_pic_container.rbs
+homepage: https://github.com/vijedi/jekyll_pic_container
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vijedi/jekyll_pic_container
+  source_code_uri: https://github.com/vijedi/jekyll_pic_container
+  changelog_uri: https://github.com/vijedi/jekyll_pic_container/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Simple Liquid Tag to wrap a picture tag in a caption
+test_files: []