mobile_view 0.1.0 → 0.2.0

data/.gitignore

@@ -1,8 +1,7 @@
 .bundle/
 log/*.log
 pkg/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mobile_view (0.1.0)
+    mobile_view (0.2.0)
       rack-mobile-detect (~> 0.4.0)
       rails (~> 3.2.0)
 
@@ -38,19 +38,23 @@ GEM
     addressable (2.3.2)
     arel (3.0.2)
     builder (3.0.4)
-    capybara (2.0.1)
+    capybara (1.1.3)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
-      xpath (~> 1.0.0)
+      xpath (~> 0.1.4)
     childprocess (0.3.6)
       ffi (~> 1.0, >= 1.0.6)
     diff-lcs (1.1.3)
     erubis (2.7.0)
+    eventmachine (1.0.0)
+    faye-websocket (0.4.6)
+      eventmachine (>= 0.12.0)
     ffi (1.2.0)
     hike (1.2.1)
+    http_parser.rb (0.5.3)
     i18n (0.6.1)
     journey (1.0.4)
     jquery-rails (2.1.4)
@@ -67,6 +71,12 @@ GEM
     mime-types (1.19)
     multi_json (1.5.0)
     nokogiri (1.5.6)
+    poltergeist (1.0.2)
+      capybara (~> 1.1)
+      childprocess (~> 0.3)
+      faye-websocket (~> 0.4, >= 0.4.4)
+      http_parser.rb (~> 0.5.3)
+      multi_json (~> 1.0)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -124,14 +134,15 @@ GEM
       polyglot (>= 0.3.1)
     tzinfo (0.3.35)
     websocket (1.0.6)
-    xpath (1.0.0)
+    xpath (0.1.4)
       nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  capybara
+  capybara (~> 1.1.0)
   jquery-rails
   mobile_view!
+  poltergeist
   rspec-rails

data/README.markdown

@@ -1,24 +1,28 @@
 # MobileView
 
-View template for mobile devices made easy.
+Rails view template for mobile devices made easy.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem "mobile_view", "~> 0.1.0"
+    gem "mobile_view", "~> 0.2.0"
 
 And then execute:
 
     $ bundle
 
+## Dependency
+
+  * Rails 3.2.x
+
 ## Usage
 
 ### `action.mobile.html.erb` View Template
 
 #### Scenario
 
-You have a view template for `posts#show`, with many DOM elements and JavaScripts, which is good for desktop, but painful for mobile devices. You're tired of `<%= render_something if mobile_device? %>` conditional hell. You want to make it mobile-friendly, with a view that is mostly different form scratch.
+You have a view template for `posts#show`, with many DOM elements and JavaScripts, which is good for desktop, but painful for mobile devices. You're tired of `<%= render_something if mobile? %>` conditional hell. You want to make it mobile-friendly, with a view that is mostly different form scratch.
 
 #### Solution
 
@@ -30,9 +34,41 @@ It also works for partial views. When a mobile version of partial view is not av
 
 It also works for layout view. So you can now use `views/layouts/application.mobile.html.erb` for mobile devices.
 
-### `mobile_device?` Helper
+### `mobile?` Helper
+
+Still want to detect mobile device in Controller and View? Use `mobile?` helper. It returns `true` if it thinks the browser is a mobile device, `false` otherwise.
+
+To use `mobile?` helper in a mounted engine, for example, [Rails Cell](https://github.com/apotonick/cells), simply include the `MobileView::ControllerAdditions` module:
+
+```ruby
+class PostCell < Cell::Rails
+  include MobileView::ControllerAdditions
+end
+```
+
+## Cookie-based Mobile View Switching
+
+By setting `mobile` cookie, you can force it to load mobile views. This is helpful when debugging the app in desktop browsers, or allowing user to switch to mobile version manually.
+
+Example:
 
-Still want to detect mobile device in Controller and View? Use `mobile_device?` helper. It returns `true` if it thinks the browser is a mobile device, `false` otherwise.
+```ruby
+class AppliactionController < ActionController::Base
+  before_filter :manual_mobile_switching
+
+  protected
+  # Detects `_mobile_view` parameter.
+  # If it is any value other than 0, turn on mobile view,
+  # otherwise, turn off mobile view.
+  def manual_mobile_switching
+    if params[:_mobile_view] != "0"
+      cookies["mobile"] = true # or anything other than falsy value
+    else
+      cookies.delete "mobile" # remove `mobile' cookie
+    end
+  end
+end
+```
 
 ## Known Issues
 
@@ -46,6 +82,22 @@ According to the algorithm of [Rack::MobileDetect](https://github.com/talison/ra
 * [#397 Action View Walkthrough (pro) - RailsCasts](http://railscasts.com/episodes/397-action-view-walkthrough)
 * [Implementing a Rails 3 View Resolver - jkfill blog](http://jkfill.com/2011/03/11/implementing-a-rails-3-view-resolver/)
 
+## Changelog
+
+### 0.2.0
+
+* Support cookie-based switching
+* Rename helper `mobile_device?` to `mobile?` since it now not only detects mobile device, but also accepts cookie-based switching.
+* Ability to have other mounted engines use `mobile?` helper. (Inspired from [Devise](https://github.com/plataformatec/devise/blob/v2.1.2/lib/devise/controllers/helpers.rb))
+
+### 0.1.0
+
+:birthday: First Release
+
+* `*.mobile` view template auto-overriding
+* Automatically mobile device detection
+* `mobile_device?` helper for controller and view
+
 ## License
 
 The MIT License
@@ -56,4 +108,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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/lib/mobile_view/controller_additions.rb

@@ -0,0 +1,20 @@
+module MobileView
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    included do
+      # make mobile? method a view helper too
+      helper_method :mobile?
+
+      # find mobile view templates first, if mobile device is detected.
+      before_filter do
+        prepend_view_path(MobileView.resolver) if mobile?
+      end
+    end
+
+    protected
+    def mobile?
+      cookies[:mobile].present? || request.headers["X_MOBILE_DEVICE"].present?
+    end
+  end
+end

data/lib/mobile_view/engine.rb

@@ -1,4 +1,4 @@
-require "mobile_view/controller_helper"
+require "mobile_view/controller_additions"
 require "rack/mobile-detect"
 
 module MobileView
@@ -8,15 +8,9 @@ module MobileView
     end
 
     initializer "mobile_view.controller_methods" do |app|
-      ActionController::Base.send :include, MobileView::ControllerHelper
-
-      # make mobile_device? method a view helper too
-      ActionController::Base.send :helper_method, :mobile_device?
-
-      # find mobile view templates first, if mobile device is detected.
-      ActionController::Base.send :before_filter, Proc.new {
-        prepend_view_path(MobileView.resolver) if mobile_device?
-      }
+      ActiveSupport.on_load(:action_controller) do
+        include MobileView::ControllerAdditions
+      end
     end
   end
 end

data/lib/mobile_view/resolver.rb

@@ -1,5 +1,7 @@
 module MobileView
   class Resolver < ::ActionView::FileSystemResolver
+    # pattern is modified from ActionView
+    # https://github.com/rails/rails/blob/v3.2.9/actionpack/lib/action_view/template/resolver.rb#L106
     MOBILE_PATTERN = ":prefix/:action.mobile{.:locale,}{.:formats,}{.:handlers,}"
 
     def initialize(path)

data/lib/mobile_view/version.rb

@@ -1,3 +1,3 @@
 module MobileView
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/mobile_view.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Yu-Cheng Chuang"]
   s.email       = ["ducksteven@gmail.com"]
   s.homepage    = "https://github.com/chitsaou/mobile_view"
-  s.summary     = "View template for mobile devices made easy."
-  s.description = "Easily specify mobile view template for mobile devices."
+  s.summary     = "Rails view template for mobile devices made easy."
+  s.description = "Easily specify mobile-specific view template for mobile devices in Rails application."
 
   s.files       = `git ls-files`.split($\)
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
   s.add_dependency "rack-mobile-detect", "~> 0.4.0"
 
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "capybara"
+  s.add_development_dependency "capybara", "~> 1.1.0"
+  s.add_development_dependency "poltergeist"
 
   s.require_paths = ["lib"]
 end

data/spec/dummy/app/controllers/pages_controller.rb

@@ -16,9 +16,9 @@ class PagesController < ApplicationController
     render :layout => "yet-another"
   end
 
-  # This page uses mobile_device? helper to determine the content to be rendered
+  # This page uses mobile? helper to determine the content to be rendered
   def conditional
-    @text = if mobile_device?
+    @text = if mobile?
       "Hi Mobile!"
     else
       "Hi Desktop!"

data/spec/dummy/app/views/pages/conditional.html.erb

@@ -1,4 +1,4 @@
-<% if mobile_device? %>
+<% if mobile? %>
 <div id="mobile-device"><%= @text %></div>
 <% else %>
 <div id="non-mobile-device"><%= @text %></div>

data/spec/features/mobile_view_spec.rb

@@ -4,90 +4,120 @@ require 'spec_helper'
 IPHONE_USER_AGNET = "Mozilla/5.0 (iPhone; U; CPU iOS 2_0 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/XXXXX Safari/525.20"
 
 def use_iphone
-  # depends on defualt driver Capybara::RackTest::Driver
-  page.driver.header("USER_AGENT", IPHONE_USER_AGNET)
+  # depends on poltergeist
+  page.driver.headers = { "User-Agent" => IPHONE_USER_AGNET }
+end
+
+def set_mobile_cookie
+  # depends on poltergeist
+  page.driver.set_cookie "mobile", true
 end
 
 describe "View Template Overriding" do
-  context "Action view template" do
-    it "renders mobile template when client is a mobile device" do
+  context "when client is mobile device" do
+    before :each do
       use_iphone
+    end
 
+    it "renders mobile-specific action view template" do
       visit "/pages/action_view"
 
       page.should have_selector('#mobile-view')
     end
 
-    it "renders default template when client is not a mobile device" do
-      visit "/pages/action_view"
+    it "renders mobile-specific partial view template" do
+      visit "/pages/partial_view"
 
-      page.should have_selector('#default-view')
+      page.should have_selector('#mobile-partial-view')
     end
-  end
 
-  context "Overriding partial view template" do
-    it "renders mobile template when client is a mobile device" do
-      use_iphone
+    it "renders mobile-specific layout view template" do
+      visit "/pages/layout_template"
 
-      visit "/pages/partial_view"
+      page.should have_selector('body.mobile')
+    end
 
-      page.should have_selector('#mobile-partial-view')
+    it "renders default view template when there is no mobile-specific overriding" do
+      visit "/pages/default"
+
+      page.should have_selector('#hello-world')
     end
 
-    it "renders default template when client is not a mobile device" do
-      visit "/pages/partial_view"
+    it "renders mobile-specific content" do
+      visit "/pages/conditional"
 
-      page.should have_selector('#default-partial-view')
+      page.should have_selector('#mobile-device')
+      page.should have_content('Hi Mobile!')
     end
   end
 
-  context "Overriding layout view template" do
-    it "renders mobile layout template when client is a mobile device" do
-      use_iphone
+  context "when client provides mobile cookie" do
+    before :each do
+      set_mobile_cookie
+    end
 
-      visit "/pages/layout_template"
+    it "renders mobile-specific action view template" do
+      visit "/pages/action_view"
 
-      page.should have_selector('body.mobile')
+      page.should have_selector('#mobile-view')
     end
 
-    it "renders default layout template when client is not a mobile device" do
-      visit "/pages/layout_template"
+    it "renders mobile-specific partial view template" do
+      visit "/pages/partial_view"
 
-      page.should have_selector('body.desktop')
+      page.should have_selector('#mobile-partial-view')
     end
-  end
 
-  context "Not overriding" do
-    it "renders default template when client is a mobile device" do
-      use_iphone
+    it "renders mobile-specific layout view template" do
+      visit "/pages/layout_template"
+
+      page.should have_selector('body.mobile')
+    end
 
+    it "renders default view template when there is no mobile-specific overriding" do
       visit "/pages/default"
 
       page.should have_selector('#hello-world')
     end
 
-    it "renders default template when client is not a mobile device" do
-      visit "/pages/default"
+    it "renders mobile-specific content" do
+      visit "/pages/conditional"
 
-      page.should have_selector('#hello-world')
+      page.should have_selector('#mobile-device')
+      page.should have_content('Hi Mobile!')
     end
   end
-end
 
-describe "mobile_device? usage" do
-  it "renders mobile-specific content when client is a mobile device" do
-    use_iphone
+  context "when client is not mobile browser" do
+    it "renders default action view template" do
+      visit "/pages/action_view"
 
-    visit "/pages/conditional"
+      page.should have_selector('#default-view')
+    end
 
-    page.should have_selector('#mobile-device')
-    page.should have_content('Hi Mobile!')
-  end
+    it "renders default partial view template" do
+      visit "/pages/partial_view"
 
-  it "renders general content when client is not a mobile device" do
-    visit "/pages/conditional"
+      page.should have_selector('#default-partial-view')
+    end
+
+    it "renders default layout view template" do
+      visit "/pages/layout_template"
+
+      page.should have_selector('body.desktop')
+    end
+
+    it "renders default view template when there is no mobile-specific overriding" do
+      visit "/pages/default"
+
+      page.should have_selector('#hello-world')
+    end
 
-    page.should have_selector('#non-mobile-device')
-    page.should have_content('Hi Desktop!')
+    it "renders general content" do
+      visit "/pages/conditional"
+
+      page.should have_selector('#non-mobile-device')
+      page.should have_content('Hi Desktop!')
+    end
   end
-end
+end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ require 'capybara/rspec'
 
 Capybara.app = Dummy::Application
 
+require 'capybara/poltergeist'
+Capybara.default_driver = :poltergeist
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobile_view
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -61,6 +61,22 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -75,7 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Easily specify mobile view template for mobile devices.
+description: Easily specify mobile-specific view template for mobile devices in Rails
+  application.
 email:
 - ducksteven@gmail.com
 executables: []
@@ -89,7 +106,7 @@ files:
 - README.markdown
 - Rakefile
 - lib/mobile_view.rb
-- lib/mobile_view/controller_helper.rb
+- lib/mobile_view/controller_additions.rb
 - lib/mobile_view/engine.rb
 - lib/mobile_view/resolver.rb
 - lib/mobile_view/version.rb
@@ -153,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1475394104596427624
+      hash: 232344584105567251
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,13 +179,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1475394104596427624
+      hash: 232344584105567251
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: View template for mobile devices made easy.
+summary: Rails view template for mobile devices made easy.
 test_files:
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile

data/lib/mobile_view/controller_helper.rb

@@ -1,8 +0,0 @@
-module MobileView
-  module ControllerHelper
-    protected
-    def mobile_device?
-      request.headers["X_MOBILE_DEVICE"].present?
-    end
-  end
-end