lazyload-rails 0.1.0 → 0.2.0

data/README.md

@@ -3,6 +3,16 @@
 This project integrates the jQuery Lazy Load Plugin
 for Rails `image_tag` helpers
 
+### What's jQuery Lazy Load?
+
+From the project page:
+
+*Lazy Load is a jQuery plugin written in JavaScript. It delays loading of images in long web pages. Images outside of viewport (visible part of web page) won't be loaded before user scrolls to them. This is opposite of image preloading.*
+
+*Using Lazy Load on long web pages containing many large images makes the page load faster. Browser will be in ready state after loading visible images. In some cases it can also help to reduce server load.*
+
+See [example](http://backbonejs.org/#examples) (scroll down to see images load)
+
 ## Documentation
 
 ### Features
@@ -28,8 +38,23 @@ Add this line to your application's Gemfile:
 Download the [jQuery Lazy Load Plugin](https://raw.github.com/tuupola/jquery_lazyload/master/jquery.lazyload.js)
 into your `vendor/assets/javascripts` directory and include it however you prefer.
 
+And in your JavaScript code do:
+
+    $("img").lazyload();
+
+Lazy Load can be customized, [see more options](http://www.appelsiini.net/projects/lazyload)
+
 *Important: Remember that the Lazy Load Plugin depends on jQuery.*
 
+## Configuration
+
+By default, a 1x1 grey gif is used as placeholder (from [http://appelsiini.net/projects/lazyload/img/grey.gif](http://www.appelsiini.net/projects/lazyload/img/grey.gif)). This can be easily customized:
+
+    # config/initializers/lazyload.rb
+    Lazyload::Rails.configure do |config|
+      config.placeholder = "/public/img/grey.gif"
+    end
+
 ## FAQ
 
 * *Q: How can I use the old `image_tag` method?*

data/lib/lazyload-rails.rb

@@ -1,12 +1,41 @@
 require "nokogiri"
 require "action_view"
+
 require "lazyload-rails/version"
+require "lazyload-rails/configuration"
+
+module Lazyload
+  module Rails
+
+    def self.configuration
+      @configuration ||= Lazyload::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 :x_image_tag :image_tag
 
   def image_tag(*attrs)
-    placeholder = "http://www.appelsiini.net/projects/lazyload/img/grey.gif"
+    placeholder = Lazyload::Rails.configuration.placeholder
     img = Nokogiri::HTML::DocumentFragment.parse(x_image_tag(*attrs)).at_css("img")
     src = img["src"]
 

data/lib/lazyload-rails/configuration.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+module Lazyload
+  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
+
+      # Set default settings
+      def initialize
+        @placeholder = "http://www.appelsiini.net/projects/lazyload/img/grey.gif"
+      end
+    end
+  end
+end

data/lib/lazyload-rails/version.rb

@@ -1,5 +1,5 @@
 module Lazyload
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazyload-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.9
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.9
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -43,24 +43,18 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-description: ! "    lazyload-rails project integrates jQuery Lazy Load\n    Plugin
-  for Rails image_tag helpers\n"
-email:
-- javier@tractical.com
+description: lazyload-rails project integrates jQuery Lazy Load Plugin for Rails image_tag
+  helpers
+email: javier@tractical.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- Gemfile
-- MIT-LICENSE
 - README.md
-- Rakefile
-- lazyload-rails.gemspec
-- lib/lazyload-rails.rb
+- MIT-LICENSE
+- lib/lazyload-rails/configuration.rb
 - lib/lazyload-rails/version.rb
-- test/asset_tag_helper_test.rb
+- lib/lazyload-rails.rb
 homepage: https://github.com/jassa/lazyload-rails
 licenses:
 - MIT
@@ -86,5 +80,4 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: jQuery Lazy Load for Rails image_tag helpers
-test_files:
-- test/asset_tag_helper_test.rb
+test_files: []

data/.gitignore

@@ -1,6 +0,0 @@
-*.gem
-.bundle
-.DS_Store
-bin
-Gemfile.lock
-pkg

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 1.9.2

data/Gemfile

@@ -1,7 +0,0 @@
-source "http://rubygems.org"
-
-gemspec
-
-group :test do
-  gem "rake"
-end

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.test_files = FileList['test/*_test.rb']
-end
-
-task :default => :test

data/lazyload-rails.gemspec

@@ -1,22 +0,0 @@
-$:.push File.expand_path("../lib", __FILE__)
-require "lazyload-rails/version"
-
-Gem::Specification.new do |gem|
-  gem.author      = ["Javier Saldana"]
-  gem.email       = ["javier@tractical.com"]
-  gem.homepage    = "https://github.com/jassa/lazyload-rails"
-  gem.name        = "lazyload-rails"
-  gem.license     = "MIT"
-  gem.version     = Lazyload::Rails::VERSION
-  gem.summary     = "jQuery Lazy Load for Rails image_tag helpers"
-  gem.description = <<-EOS
-    lazyload-rails project integrates jQuery Lazy Load
-    Plugin for Rails image_tag helpers
-  EOS
-
-  gem.files       = `git ls-files`.split($/)
-  gem.test_files  = gem.files.grep(%r{^(test|spec|features)/})
-
-  gem.add_dependency "nokogiri", "~> 1.5.9"
-  gem.add_development_dependency "actionpack", ">= 3.1"
-end

data/test/asset_tag_helper_test.rb

@@ -1,57 +0,0 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__),'..','lib')
-
-require "test/unit"
-require "action_view"
-require "lazyload-rails"
-
-class BasicController
-  attr_accessor :request
-
-  def config
-    @config ||= ActiveSupport::InheritableOptions.new(ActionController::Base.config).tap do |config|
-      public_dir = File.expand_path("../fixtures/public", __FILE__)
-      config.assets_dir = public_dir
-      config.assets = ActiveSupport::InheritableOptions.new({ :prefix => "assets" })
-      config
-    end
-  end
-end
-
-class AssetTagHelperTest < ActionView::TestCase
-  tests ActionView::Helpers::AssetTagHelper
-
-  attr_reader :request
-
-  def setup
-    super
-
-    @controller = BasicController.new
-
-    @request = Class.new do
-      attr_accessor :script_name
-      def protocol() 'http://' end
-      def ssl?() false end
-      def host_with_port() 'localhost' end
-      def base_url() 'http://www.example.com' end
-    end.new
-
-    @controller.request = @request
-  end
-
-  def test_lazy_attributes
-    expected = '<img alt="Foo" height="150"' +
-      ' src="http://www.appelsiini.net/projects/lazyload/img/grey.gif"' +
-      ' width="100" data-original="/images/foo.png">'
-
-    assert_equal expected, image_tag("foo.png", size: "100x150")
-  end
-
-  def test_lazy_attributes_override
-    expected = '<img alt="Bar" data-original="/images/bar.png" height="150"' +
-      ' src="http://www.appelsiini.net/projects/lazyload/img/grey.gif" width="200">'
-
-    actual = image_tag("bar.png", size: "200x150", data: { original: "foo" })
-
-    assert_equal expected, actual
-  end
-end