loadergif 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36589ec9422c4198c13c175f065a2edcf626198f0561ceeda0b65f16f784795a
+  data.tar.gz: e5a3f08de972d9bd8b2e6b30b8bd6427feea630314fe119ddd86e690a360763e
+SHA512:
+  metadata.gz: d59f67d3194ed68be29b00a96cb6e434f1095d156711acd17042b42dee1a62cf0dad82bcb0b92aa3e1125eb936aac11beddb6b41f5e89f89a1e2f9f7ad04086a
+  data.tar.gz: 70854670eab9b83a2ed1a05c81783ef1b772d6d263a59264f7e1b12e765ebbdd063d8881ac33eb3b1c5c6862a4e82ab82da871f939e53089e8fdb8467eec9e59

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at neelam.j@cisinlabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in loadergif.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 cis-neelam
+
+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,97 @@
+## Loadergif
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/loadergif`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+### Features
+
+* Add `lazy: true` option to Rails `image_tag` helpers to render lazyload-friendly img tags.
+* Global config available to make them lazy by default.
+* Simple (really). That's pretty much it.
+
+### Example
+
+```erb
+<%= image_tag "kittenz.png", lazy: true %>
+```
+
+or
+
+```ruby
+# config/initializers/lazyload.rb
+Loadergif::Rails.configure do |config|
+  config.lazy_by_default = true
+end
+```
+```erb
+<%= image_tag "kittenz.png" %>
+```
+
+Equals:
+
+```html
+<img src="data:image/gif;base64,R0lGODdhAQABAPAAAMPDwwAAACwAAAAAAQABAAACAkQBADs="
+     data-original="/images/kittenz.png" />
+```
+
+**PRO TIP!** You must set image dimensions either as width and height attributes or in CSS. Otherwise it might not work properly.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loadergif'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loadergif
+
+2. Download the [jQuery Lazy Load Plugin](https://raw.githubusercontent.com/cis-neelam/loder/master/jquery.loader.js)
+into your `vendor/assets/javascripts` directory.
+
+3. Include it however you prefer. For example, in your application.js you could add:
+
+        //= require jquery.lazyload
+
+4. In your JavaScript code do:
+
+        $("img").lazyload();
+
+*__Important__: Remember that the Lazy Load Plugin depends on jQuery.*
+
+## Configuration
+
+```ruby
+# config/initializers/lazyload.rb
+Loadergif::Rails.configure do |config|
+  # By default, a 1x1 grey gif is used as placeholder ("data:image/gif;base64,...").
+  # This can be easily customized:
+  config.placeholder = "/public/img/grey.gif"
+
+  # image_tag can return lazyload-friendly images by default,
+  # no need to pass the { lazy: true } option
+  config.lazy_by_default = true
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/[USERNAME]/loadergif. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Loadergif project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/loadergif/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "loadergif"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/loadergif.rb

@@ -0,0 +1,73 @@
+require "nokogiri"
+require "action_view"
+require "loadergif/version"
+require "loadergif/config"
+
+module Loadergif
+  class Error < StandardError; end
+  module Rails
+
+    def self.configuration
+      @configuration ||= Loadergif::Rails::Configuration.new
+    end
+
+    def self.configuration=(new_configuration)
+      @configuration = new_configuration
+    end
+
+    # Yields the global configuration to a block.
+    #
+    # Example:
+    #   Lazyload::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 = extract_options_and_args(*attrs)
+    image_html = rails_image_tag(*args)
+
+    is_lazy = options.fetch(:lazy) { Loadergif::Rails.configuration.lazy_by_default }
+
+    if is_lazy
+      to_lazy(image_html)
+    else
+      image_html
+    end
+  end
+
+  private
+
+  def to_lazy(image_html)
+    img = Nokogiri::HTML::DocumentFragment.parse(image_html).at_css("img")
+
+    img["data-original"] = img["src"]
+    img["src"] = Loadergif::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)
+    else
+      options = {}
+    end
+
+    [options, args]
+  end
+end

data/lib/loadergif/config.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+module Loadergif
+  module Rails
+
+    # Stores runtime configuration information.
+    #
+    # Example settings
+    #   Lazyload::Rails.configure do |c|
+    #     c.placeholder  = "/public/img/grey.gif"
+    #   end
+    class Configuration
+
+      # The placeholder image to put into the img src attribute
+      # (default: 1×1 pixel grey gif at
+      # "http://www.appelsiini.net/projects/lazyload/img/grey.gif").
+      def placeholder
+        @placeholder
+      end
+      def placeholder=(new_placeholder)
+        @placeholder = new_placeholder
+      end
+
+      # When set to true every image_tag will include { lazy: true } by default
+      def lazy_by_default=(lazy_by_default)
+        @lazy_by_default = !!lazy_by_default
+      end
+      def lazy_by_default
+        @lazy_by_default
+      end
+
+      # Set default settings
+      def initialize
+        @placeholder = "data:image/gif;base64,R0lGODdhAQABAPAAAMPDwwAAACwAAAAAAQABAAACAkQBADs="
+        @lazy_by_default = false
+      end
+    end
+  end
+end

data/lib/loadergif/version.rb

@@ -0,0 +1,3 @@
+module Loadergif
+  VERSION = "0.1.0"
+end

data/loadergif.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "loadergif/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "loadergif"
+  spec.version       = Loadergif::VERSION
+  spec.authors       = ["cis-neelam"]
+  spec.email         = ["neelam.j@cisinlabs.com"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "http://rubygems.org/gems/loadergif"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: loadergif
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cis-neelam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Write a longer description or delete this line.
+email:
+- neelam.j@cisinlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/loadergif.rb
+- lib/loadergif/config.rb
+- lib/loadergif/version.rb
+- loadergif.gemspec
+homepage: http://rubygems.org/gems/loadergif
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []