layzr-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fec3097e57da47bc33415bd484eb8943e1e9be2
+  data.tar.gz: 213ee8ea7245201e1063b0fcc70132c0d25ade84
+SHA512:
+  metadata.gz: dd425ff8689ae7fbdc14e57d3daf9f3d7a0a050505108aa8e1e5f2a568ad19b4dd0f50a93eeacd87b1f4591e93b79adc6677f6b45b0bdcc6c5fae22e33ec8e87
+  data.tar.gz: d45821d79369ba7d94f7b7a7efb406e57e3661995853fa37b289e94f017b849ce540f2ea176ffb72c6d4c55e9292a6743e1c840d397e542aa6c5aa81969bcc53

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,64 @@
+## Layzr-Rails
+
+This project integrates the jQuery [Layzr Plugin](https://github.com/callmecavs/layzr.js)
+for Rails `image_tag` helpers
+
+### What's jQuery Layzr Plugin?
+
+From the project page:
+
+*A small, fast, and modern library for lazy loading images.*
+
+See [live demo](http://callmecavs.com/layzr.js/)
+
+## Documentation
+
+### Installation
+
+Add it in your gemfile
+
+    gem 'layzr-rails'
+
+Create a configuration file and put it in your initializers `config/initializers/layzr.rb`
+
+
+      Layzr::Rails.configure do |config|
+        config.placeholder = "/assets/some-default-image.png"
+      end
+
+Require layzr library in application.js ie:
+
+    //= require layzr
+
+And place the jvascript code:
+
+    $(document).ready(function() {
+       const instance = Layzr()
+    });
+
+### Features
+
+* Add `lazy: true` option to Rails `image_tag` helpers to render layzr-friendly img tags.
+* Simple (really). That's pretty much it.
+
+### Example
+
+    <%= image_tag "kittenz.png", alt: "OMG a cat!", lazy: true %>
+
+Equals:
+
+    <img alt="OMG a cat!" data-normal="/images/kittenz.png" src="/assets/some-default-image.png">
+
+### More options
+
+  
+    <%= image_tag "normal.jpg", lazy: true, layzr: { retina: "retina.jpg", srcset: "small.jpg 320w, medium.jpg 768w, large.jpg 1024w"} %>
+
+Equals:
+
+    <img src="/assets/some-default-image.png" data-normal="normal.jpg" data-retina="retina.jpg" data-srcset="small.jpg 320w, medium.jpg 768w, large.jpg 1024w">  
+
+
+## License
+
+Layzr-Rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/layzr-rails.rb

@@ -0,0 +1,77 @@
+require "nokogiri"
+require "action_view"
+
+require "layzr-rails/version"
+require "layzr-rails/configuration"
+
+module Layzr
+  module Rails
+
+    def self.configuration
+      @configuration ||= Layzr::Rails::Configuration.new
+    end
+
+    def self.configuration=(new_configuration)
+      @configuration = new_configuration
+    end
+
+    # Yields the global configuration to a block.
+    #
+    # Example:
+    #   Layzr::Rails.configure do |config|
+    #     config.placeholder = '/public/images/foo.gif'
+    #   end
+    def self.configure
+      yield configuration if block_given?
+    end
+
+    def self.reset
+      @configuration = nil
+    end
+  end
+end
+
+ActionView::Helpers::AssetTagHelper.module_eval do
+  alias :rails_image_tag :image_tag
+
+  def image_tag(*attrs)
+    options, args, layzr_options = extract_options_and_args(*attrs)
+    image_html = rails_image_tag(*args)
+
+    if options[:lazy]
+      to_lazy_image(image_html, layzr_options)
+    else
+      image_html
+    end
+  end
+
+  private
+
+  def to_lazy_image(image_html, layzr_options)
+    img = Nokogiri::HTML::DocumentFragment.parse(image_html).at_css("img")
+
+    img["data-normal"] = img["src"]
+    unless layzr_options.nil?
+      img['data-retina'] = layzr_options[:retina] unless layzr_options[:retina].blank?
+      img['data-srcset'] = layzr_options[:srcset] unless layzr_options[:srcset].blank?
+    end
+    img["src"] = Layzr::Rails.configuration.placeholder
+
+    img.to_s.html_safe
+  end
+
+  def extract_options_and_args(*attrs)
+    args = attrs
+    if args.size > 1
+      options = attrs.last.dup
+      args.last.delete(:lazy)
+      layzr_options = args.last.delete(:layzr) || {}
+    else
+      layzr_options = {}
+      options = {}
+    end
+
+    [options, args, layzr_options]
+  end
+
+end

data/lib/layzr-rails/configuration.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+module Layzr
+  module Rails
+
+    # Stores runtime configuration information.
+    #
+    # Example settings
+    #   Layzr::Rails.configure do |c|
+    #     c.placeholder  = "/public/img/grey.gif"
+    #   end
+    class Configuration
+
+      def placeholder
+        @placeholder
+      end
+
+      def placeholder=(new_placeholder)
+        @placeholder = new_placeholder
+      end
+
+    end
+  end
+end

data/lib/layzr-rails/version.rb

@@ -0,0 +1,5 @@
+module Layzr
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: layzr-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mohit Jain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: layzr-rails project integrates Layzr JS for Rails image_tag helpers
+email: jain.mohit27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/layzr-rails.rb
+- lib/layzr-rails/configuration.rb
+- lib/layzr-rails/version.rb
+homepage: https://github.com/mohitjain/layzr-rails
+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.3
+signing_key: 
+specification_version: 4
+summary: Layzr JS Wrapper for Rails image_tag helpers
+test_files: []