jekyll-twoxify 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16afe64002ada926a66c0ff341d23731c9433090
+  data.tar.gz: cbeb8c8bcd85699402df27c05d6156bdee9a0885
+SHA512:
+  metadata.gz: 051c424503c877efd94b9a6cb462d156236a66b8661808d82aec15050577efe6b4b47c78c95f3914f8dffbfcda7e3c2e44aa66e0bcb126b8bcc19e6c645b5924
+  data.tar.gz: 345296debb5003362f6a739998ac12289dfba5b206a180ff3fcd3a3412e60101eebd78c9a1dad25a050d6eb8ea6503c022e1ac1437d03a50907cd70e709f278b

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE.md

@@ -0,0 +1,26 @@
+# DON'T BE A DICK PUBLIC LICENSE
+
+> Version 1.1, December 2016
+
+> Copyright (C) 2019 WarrantyNowVoid.com
+ 
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document.
+
+> DON'T BE A DICK PUBLIC LICENSE
+> TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 1. Do whatever you like with the original work, just don't be a dick.
+
+     Being a dick includes - but is not limited to - the following instances:
+
+   1a. Outright copyright infringement - Don't just copy the original work/works and change the name.  
+   1b. Selling the unmodified original with no work done what-so-ever, that's REALLY being a dick.  
+   1c. Modifying the original work to contain hidden harmful content. That would make you a PROPER dick.  
+
+ 2. If you become rich through modifications, related works/services, or supporting the original work,
+ share the love. Only a dick would make loads off this work and not buy the original work's 
+ creator(s) a pint.
+ 
+ 3. Code is provided with no warranty. Using somebody else's code and bitching when it goes wrong makes 
+ you a DONKEY dick. Fix the problem yourself. A non-dick would submit the fix back or submit a [bug report](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)

data/README.md

@@ -0,0 +1,87 @@
+# Jekyll TwoXify
+
+Generate the @2x `img` tag `src` and `srcset` (see <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset>) attributes for a given image path, only including a 2x `srcset` if it exists on the filesystem.
+
+## Doesn't this seem like overkill for a simple thing?
+
+Listen, I got really tired of pasting this absolute nonsense into my templates all over the place:
+
+````
+  {% assign retinaImage = postImage | split: "" | reverse | join: "" | replace_first: '.', '.x2@' | split: "" | reverse | join: "" %}
+````
+
+ugggh
+
+## Installation
+
+(https://jekyllrb.com/docs/plugins/installation/)
+
+One of two options:
+
+### Bundler Config
+:warning: **If using bundler with a vendor prefix, this is the required method**
+
+1. In your `Gemfile`, add the `jekyll_plugins` group if it doesn't already exist, and add `jekyll-twoxify` to it. For example: 
+
+  ```ruby
+  group :jekyll_plugins do
+    gem "jekyll-twoxify"
+  end
+  ```
+
+2. Tell bundler to install any plugins with
+
+  ```
+  $ bundle install
+  ```
+
+
+### Jekyll Config
+
+1. In your `_config.yml`, add the `plugins` key if it doesn't already exist, and add a value of `jekyll-twoxify`. For example:
+
+	```yaml
+	plugins: 
+	  - jekyll-twoxify
+	```
+
+2. Install this gem
+
+  ```
+  $ gem install jekyll-twoxify
+  ```
+
+## Usage
+
+### Tag
+
+Add the `twoxify` template tag to any `img` tag in place of both the `src` and `srcset` attributes, with the desired image path. The tag will output the `src` value and, if it exists in the filesystem, the `srcset` attribute with the @2x path. It will automagically prepend the `site.url` to both paths.
+
+Pass in image as a string:
+
+```
+<img {% twoxify "assets/img/mycoolphoto.jpg" %} />
+```
+
+If `mycoolphoto@2x.jpg` exists, results in:
+
+```
+<img 
+  src="https://mycoolwebsite.com/assets/img/mycoolphoto.jpg" 
+  srcset="https://mycoolwebsite.com/assets/img/mycoolphoto@2x.jpg 2x" />
+```
+
+Else:
+
+```
+<img src="https://mycoolwebsite.com/assets/img/mycoolphoto.jpg" />
+```
+
+Variables or frontmatter are also supported:
+
+```
+<img {% twoxify post.image %} />
+
+{% assign copied_image = "/assets/wow/numbertwo.png" %}
+<img {% twoxify copied_image %} />
+```

data/jekyll-twoxify.gemspec

@@ -0,0 +1,17 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-twoxify/version"
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-twoxify"
+  spec.summary       = "Generate the src and srcset img tag attributes for an image"
+  spec.description   = "Jekyll plugin to generate src attribute for an img tag with the given image, and also the srcset with an appropriate @2x path for the image if one exists on the filesystem."
+  spec.version       = Jekyll::TwoXify::VERSION
+  spec.authors       = ["Nick Pettazzoni"]
+  spec.email         = ["pettazz@gmail.com"]
+  spec.homepage      = "https://github.com/warrantynowvoid/jekyll-twoxify"
+  spec.licenses      = ["Nonstandard"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 3.0"
+end

data/lib/jekyll-twoxify.rb

@@ -0,0 +1,8 @@
+require "jekyll"
+require "jekyll-twoxify/jekyll-twoxify-tag"
+require "jekyll-twoxify/version"
+
+module Jekyll
+  module TwoXify
+  end
+end

data/lib/jekyll-twoxify/jekyll-twoxify-tag.rb

@@ -0,0 +1,32 @@
+module Jekyll
+  module TwoXify
+    class TwoXifyTag < Liquid::Tag
+
+      def initialize(tagName, image_arg, tokens)
+        super
+        @image_arg = image_arg
+      end
+
+      def render(context)
+        # if we pass in something like "post.image.feature" instead of a path,
+        # the variable name gets passed in as a string, so we can look it up in the context
+        image_path = "#{context[@image_arg.strip]}"
+        image_path[0] = "" if image_path[0] == "/"
+
+        site_url = context["site.url"]
+
+        extension = File.extname(image_path)
+        image_path_stripped = File.join(File.dirname(image_path), File.basename(image_path, extension))
+        image_2x_path = "#{image_path_stripped}@2x#{extension}"
+
+        if File.exist?(image_2x_path)
+          "src=\"#{site_url}/#{image_path}\" srcset=\"#{site_url}/#{image_2x_path}\""
+        else
+          "src=\"#{site_url}/#{image_path}\""
+        end
+      end
+
+      Liquid::Template.register_tag "twoxify", self
+    end
+  end
+end

data/lib/jekyll-twoxify/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module TwoXify
+    VERSION = "1.0.1"
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-twoxify
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nick Pettazzoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Jekyll plugin to generate src attribute for an img tag with the given
+  image, and also the srcset with an appropriate @2x path for the image if one exists
+  on the filesystem.
+email:
+- pettazz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.md
+- README.md
+- jekyll-twoxify.gemspec
+- lib/jekyll-twoxify.rb
+- lib/jekyll-twoxify/jekyll-twoxify-tag.rb
+- lib/jekyll-twoxify/version.rb
+homepage: https://github.com/warrantynowvoid/jekyll-twoxify
+licenses:
+- Nonstandard
+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.14
+signing_key: 
+specification_version: 4
+summary: Generate the src and srcset img tag attributes for an image
+test_files: []