unveil-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11ac877c26c44d8716fcd650f8539357e06f94a3
+  data.tar.gz: 803b516ad64838c23968b555167e01d90830c81a
+SHA512:
+  metadata.gz: 68f73d490a9ad2603714f43a39274d5a53f07e2cb6db0d16f337cc782bd6da229890fa6ecc6dc867aff0054364813ce36931ff0541c692224ce08653af99591b
+  data.tar.gz: 1ada1b0cdb1497d1c196723253f817c356c026b7bcde1a330bc209981b0e2c9d2394b3b2e2f6b4412b6758c02c90d80fc5483a27ce855db5f690320447ed38b2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Made Tech Ltd
+
+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,77 @@
+# Unveil.js for Rails
+
+This gem will help you get started with unveil.js rather quickly.
+
+## Installation
+
+Add the gem:
+
+``` ruby
+gem 'unveil-rails', '~> 0.1.0'
+```
+
+Install the assets:
+
+```
+bin/rails g unveil:rails:install
+```
+
+Include the asset in your JS:
+
+``` js
+//= require unveil_init
+```
+
+Now use the helper method whereever you want lazy images:
+
+```erb
+<%= lazy_image_tag('an-image.png') %>
+<%= lazy_image_tag('an-image.png', retina: 'a-retina-image.png') %>
+<%= lazy_image_tag('an-image.png', placeholder: 'placeholder.png') %>
+```
+
+## Configuration
+
+The installation generator will have added an initializer to your application.
+In this file there are a couple of settings you can change.
+
+### Threshold
+
+``` ruby
+Unveil::Rails.config.threshold = 200
+```
+
+Setting this variable to an integer will set the unveil threshold setting
+as [documented here][unveil-docs].
+
+### Default placeholder
+
+You may set an alternative default placeholder image:
+
+``` ruby
+Unveil::Rails.config.default_placeholder = 'default.jpg'
+```
+
+You can set the placeholder per lazy image by passing in the placeholder option:
+
+``` erb
+<%= lazy_image_tag('an-image.png', placeholder: 'placeholder.png') %>
+```
+
+## Credits
+
+[![made](https://s3-eu-west-1.amazonaws.com/made-assets/googleapps/google-apps.png)][made]
+
+Developed and maintained by [Made Tech][made]. Key contributions:
+
+ * [Luke Morton](https://github.com/DrPheltRight)
+
+## License
+
+Copyright © 2014 Made Tech Ltd. It is free software, and may be
+redistributed under the terms specified in the [LICENSE][license] file.
+
+[made]: http://www.madetech.co.uk?ref=github&repo=cf-deploy
+[license]: https://github.com/madebymade/cf-deploy/blob/master/LICENSE
+[unveil-github]: https://github.com/luis-almeida/unveil
+[unveil-docs]: http://luis-almeida.github.io/unveil/

data/lib/unveil-rails.rb

@@ -0,0 +1,3 @@
+require 'unveil/rails'
+require 'unveil/rails/config'
+require 'unveil/rails/railtie' if defined?(Rails)

data/lib/unveil/rails.rb

@@ -0,0 +1,7 @@
+module Unveil
+  class Rails
+    def self.config
+      @@config ||= Config.new
+    end
+  end
+end

data/lib/unveil/rails/config.rb

@@ -0,0 +1,9 @@
+module Unveil
+  class Rails
+    class Config < Struct.new(:threshold, :default_placeholder)
+      def default_placeholder
+        super || 'blank.gif'
+      end
+    end
+  end
+end

data/lib/unveil/rails/install_generator.rb

@@ -0,0 +1,31 @@
+module Unveil
+  class Rails
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../assets', __FILE__)
+
+      def copy_initializer
+        initializer 'unveil.rb' do
+          <<-CONFIG
+Unveil::Rails.config.threshold = nil
+Unveil::Rails.config.default_placeholder = 'blank.gif'
+          CONFIG
+        end
+      end
+
+      def copy_blank_gif_into_app_images
+        copy_file 'blank.gif', 'app/assets/images/blank.gif'
+      end
+
+      def copy_unveil_into_vendor
+        copy_file 'jquery.unveil.js', 'vendor/assets/javascripts/jquery.unveil.js'
+        copy_file 'unveil_init.js.erb', 'vendor/assets/javascripts/unveil_init.js.erb'
+
+        puts ''
+        puts 'Please add the following line to your JS:'
+        puts ''
+        puts '  //= require unveil_init'
+        puts ''
+      end
+    end
+  end
+end

data/lib/unveil/rails/railtie.rb

@@ -0,0 +1,15 @@
+require 'unveil/rails/view_helper'
+
+module Unveil
+  class Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'unveil-rails.view_helpers' do
+        ActionView::Base.send(:include, ViewHelper)
+      end
+
+      generators do
+        require 'unveil/rails/install_generator'
+      end
+    end
+  end
+end

data/lib/unveil/rails/version.rb

@@ -0,0 +1,5 @@
+module Unveil
+  class Rails
+    VERSION='0.1.0'
+  end
+end

data/lib/unveil/rails/view_helper.rb

@@ -0,0 +1,24 @@
+module Unveil
+  class Rails
+    module ViewHelper
+      def lazy_image_tag(source, options = {})
+        placeholder_source = options[:placeholder] || Unveil::Rails.config.default_placeholder
+
+        lazy_options = options.merge('data-src' => image_path(source),
+                                     alt: image_alt(source))
+
+        if options.has_key?(:retina)
+          lazy_options['data-src-retina'] = image_path(options[:retina])
+        end
+
+        html = [image_tag(placeholder_source, lazy_options)]
+
+        html << '<noscript>'
+        html << image_tag(source, options)
+        html << '</noscript>'
+
+        html.join("\n").html_safe
+      end
+    end
+  end
+end

data/spec/helpers/view_helper_spec.rb

@@ -0,0 +1,61 @@
+require 'unveil/rails/view_helper'
+require_relative '../mocks/context_mock'
+
+describe Unveil::Rails::ViewHelper do
+  let(:helper) { ContextMock.new }
+
+  before do
+    String.instance_eval do
+      alias_method :html_safe, :to_s
+    end
+  end
+
+  context '#lazy_image_tag' do
+    subject { helper.lazy_image_tag('my-image.png', options) }
+
+    context 'when called without options' do
+      let(:options) { {} }
+
+      let(:expected_html) do
+        <<-HTML
+<img src="/blank.gif" data-src="/my-image.png" />
+<noscript>
+<img src="/my-image.png" />
+</noscript>
+        HTML
+      end
+
+      it { is_expected.to eq(expected_html.strip) }
+    end
+
+    context 'when alternate placeholder provided' do
+      let(:options) { { placeholder: 'place.gif' } }
+
+      let(:expected_html) do
+        <<-HTML
+<img src="/place.gif" data-src="/my-image.png" />
+<noscript>
+<img src="/my-image.png" />
+</noscript>
+        HTML
+      end
+
+      it { is_expected.to eq(expected_html.strip) }
+    end
+
+    context 'when retina image provided' do
+      let(:options) { { retina: 'my-retina-image.png' } }
+
+      let(:expected_html) do
+        <<-HTML
+<img src="/blank.gif" data-src="/my-image.png" data-src-retina="/my-retina-image.png" />
+<noscript>
+<img src="/my-image.png" />
+</noscript>
+        HTML
+      end
+
+      it { is_expected.to eq(expected_html.strip) }
+    end
+  end
+end

data/spec/mocks/context_mock.rb

@@ -0,0 +1,18 @@
+class ContextMock
+  include Unveil::Rails::ViewHelper
+
+  def image_path(path)
+    "/#{path}"
+  end
+
+  def image_alt(alt)
+    alt
+  end
+
+  def image_tag(source, options = {})
+    options_html = ''
+    options_html << " data-src=\"#{options['data-src']}\"" if options['data-src']
+    options_html << " data-src-retina=\"#{options['data-src-retina']}\"" if options['data-src-retina']
+    "<img src=\"#{image_path(source)}\"#{options_html} />"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'unveil/rails'
+require 'unveil/rails/config'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: unveil-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Morton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email:
+- luke@madetech.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/unveil-rails.rb
+- lib/unveil/rails.rb
+- lib/unveil/rails/config.rb
+- lib/unveil/rails/install_generator.rb
+- lib/unveil/rails/railtie.rb
+- lib/unveil/rails/version.rb
+- lib/unveil/rails/view_helper.rb
+- spec/helpers/view_helper_spec.rb
+- spec/mocks/context_mock.rb
+- spec/spec_helper.rb
+homepage: https://github.com/madebymade/unveil-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.2.2
+signing_key: 
+specification_version: 4
+summary: Lazy loaded images for rails
+test_files: []
+has_rdoc: