echo_lazy_loader 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kinaan Khan
+
+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,73 @@
+# EchoLazyLoader
+
+Gem for lazily loading the images using [Echo](https://github.com/toddmotto/echo) javascript library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'echo_lazy_loader'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install echo_lazy_loader
+
+## Usage
+
+Add the following to your `app/assets/javascripts/application.js`:
+
+    //= require echo
+
+To use minified version use this:
+
+    //= require echo.min
+
+Use the following helper function instead of `image_tag` for images that you want to lazily load
+	
+	echo_image_tag src, options
+
+This function takes same parameters as the `image_tag` helper.
+
+You will also have to call the following function ( prefereably in application layout ).
+
+	echo_init
+
+If you want to apply lazy loading to images that donot show on scrolling but are swaped by some slider or filter layout , you can directly use this javascript code
+
+	<script type="text/javascript">
+		Echo.render();
+	</script>
+	
+## Configuration
+
+you can use `rails g echo_lazy_loader:config` that will generate `echo_lazy_loader.rb` in project's initializer folder.
+
+The configurable options ( with default values) are as follows.
+
+	default_image = "/assets/blankloading.gif"
+	offset= 100
+	throttle= 250
+
+`default_image` is the path to the image which you want to show when the actual image is loading .
+`offset` and `throttle` are used by the `Echo Library` and has been explained in its [documentation](https://github.com/toddmotto/echo#init-api-options) .
+
+You can also pass the `offset` and `throttle` while calling `echo_init`. The values passed to the function will be used instead of those given in configuration file.
+
+
+## Contributors
+
+1. [Kinaan Khan Sherwani](https://github.com/kinaan-khan-confiz) ( kinaan.khan@confiz.com )
+2. [Usman Ali](https://github.com/usman-ali-confiz) ( usman.ali@confiz.com)
+3. [Ahmad Hussain](https://github.com/ahmad-hussain-confiz) ( ahmad.hussain@confiz.com)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/helpers/echo_lazy_loader_helper.rb

@@ -0,0 +1,20 @@
+module EchoLazyLoaderHelper
+
+	def echo_image_tag src,options = {}
+		options.merge!({"data-echo" => path_to_image(src)})
+		raw(image_tag(EchoLazyLoader::default_image,options))
+		# TODO: add noscript
+	end
+
+	def echo_init(offest = EchoLazyLoader::offset, throttle = EchoLazyLoader::throttle)
+		javascript_tag do
+  			raw("
+  				window.onload= function(){
+  					Echo.init({
+    					offset: #{offest},
+    					throttle: #{throttle}
+  					});
+  				} ;")
+  		end
+	end
+end

data/echo_lazy_loader.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'echo_lazy_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "echo_lazy_loader"
+  spec.version       = EchoLazyLoader::VERSION
+  spec.authors       = ["Confiz Limited"]
+  spec.email         = ["kinaan.khan@confiz.com"]
+  spec.description   = %q{Gem for loading images lazily using echo js library}
+  spec.summary       = %q{Gem for loading images lazily using echo js library}
+  spec.homepage      = "http://github.com/confiz/echo_lazy_loader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/echo_lazy_loader.rb

@@ -0,0 +1,20 @@
+require "echo_lazy_loader/version"
+
+module EchoLazyLoader
+	mattr_accessor :default_image
+	@@default_image="/assets/blankloading.gif"
+	mattr_accessor :offset
+	@@default_image=100
+	mattr_accessor :throttle
+	@@throttle=250
+
+	class << self
+		def setup
+			yield self
+		end
+	end
+	
+	class Engine < Rails::Engine
+	
+	end  
+end

data/lib/echo_lazy_loader/version.rb

@@ -0,0 +1,3 @@
+module EchoLazyLoader
+  VERSION = "0.0.1"
+end

data/lib/generators/echo_lazy_loader/config_generator.rb

@@ -0,0 +1,9 @@
+module EchoLazyLoader
+	class ConfigGenerator < Rails::Generators::Base
+		source_root File.expand_path('../templates', __FILE__)
+
+		def add_initializer_file
+			 template "initializer.rb", "config/initializers/echo_lazy_loader.rb"
+		end
+	end
+end

data/lib/generators/echo_lazy_loader/templates/initializer.rb

@@ -0,0 +1,5 @@
+EchoLazyLoader.setup do |s|
+	s.default_image = "/assets/blankloading.gif"
+	s.offset= 100
+	s.throttle= 250
+end

data/vendor/assets/javascripts/echo.js

@@ -0,0 +1,58 @@
+/*!
+ *  Echo v1.4.0
+ *  Lazy-loading with data-* attributes, offsets and throttle options
+ *  Project: https://github.com/toddmotto/echo
+ *  by Todd Motto: http://toddmotto.com
+ *  Copyright. MIT licensed.
+ */
+window.Echo = (function (window, document, undefined) {
+
+  'use strict';
+
+  var store = [], offset, throttle, poll;
+
+  var _inView = function (el) {
+    var coords = el.getBoundingClientRect();
+    return ((coords.top >= 0 && coords.left >= 0 && coords.top) <= (window.innerHeight || document.documentElement.clientHeight) + parseInt(offset));
+  };
+
+  var _pollImages = function () {
+    for (var i = store.length; i--;) {
+      var self = store[i];
+      if (_inView(self)) {
+        self.src = self.getAttribute('data-echo');
+        store.splice(i, 1);
+      }
+    }
+  };
+
+  var _throttle = function () {
+    clearTimeout(poll);
+    poll = setTimeout(_pollImages, throttle);
+  };
+
+  var init = function (obj) {
+    var nodes = document.querySelectorAll('[data-echo]');
+    var opts = obj || {};
+    offset = opts.offset || 0;
+    throttle = opts.throttle || 250;
+
+    for (var i = 0; i < nodes.length; i++) {
+      store.push(nodes[i]);
+    }
+
+    _throttle();
+
+    if (document.addEventListener) {
+      window.addEventListener('scroll', _throttle, false);
+    } else {
+      window.attachEvent('onscroll', _throttle);
+    }
+  };
+
+  return {
+    init: init,
+    render: _throttle
+  };
+
+})(window, document);

data/vendor/assets/javascripts/echo.min.js

@@ -0,0 +1,8 @@
+/*!
+ *  Echo v1.4.0
+ *  Lazy-loading with data-* attributes, offsets and throttle options
+ *  Project: https://github.com/toddmotto/echo
+ *  by Todd Motto: http://toddmotto.com
+ *  Copyright. MIT licensed.
+ */
+window.Echo=function(a,b){"use strict";var c,d,e,f=[],g=function(d){var e=d.getBoundingClientRect();return(e.top>=0&&e.left>=0&&e.top)<=(a.innerHeight||b.documentElement.clientHeight)+parseInt(c)},h=function(){for(var a=f.length;a--;){var b=f[a];g(b)&&(b.src=b.getAttribute("data-echo"),f.splice(a,1))}},i=function(){clearTimeout(e),e=setTimeout(h,d)},j=function(e){var g=b.querySelectorAll("[data-echo]"),h=e||{};c=h.offset||0,d=h.throttle||250;for(var j=0;j<g.length;j++)f.push(g[j]);i(),b.addEventListener?a.addEventListener("scroll",i,!1):a.attachEvent("onscroll",i)};return{init:j,render:i}}(window,document);

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: echo_lazy_loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Confiz Limited
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for loading images lazily using echo js library
+email:
+- kinaan.khan@confiz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/echo_lazy_loader_helper.rb
+- echo_lazy_loader.gemspec
+- lib/echo_lazy_loader.rb
+- lib/echo_lazy_loader/version.rb
+- lib/generators/echo_lazy_loader/config_generator.rb
+- lib/generators/echo_lazy_loader/templates/initializer.rb
+- vendor/assets/images/blankloading.gif
+- vendor/assets/javascripts/echo.js
+- vendor/assets/javascripts/echo.min.js
+homepage: http://github.com/confiz/echo_lazy_loader
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4550767949091289016
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4550767949091289016
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem for loading images lazily using echo js library
+test_files: []