mobylette 1.0.0 → 1.1.0

data/README.rdoc

@@ -1,4 +1,4 @@
-http://fd.img.v4.skyrock.net/fd6/mantaur/pics/206915407_small.jpg
+http://tscolari.github.com/mobylette/mobylette_images/mobylette.jpg
 
 = Mobylette http://travis-ci.org/tscolari/mobylette.png
 
@@ -22,7 +22,7 @@ By adding "respond_to_mobile_requests" in your application_controller (or any ot
 
 Add the gem to your gemfile:
 
-    gem 'mobylette', :git => "git://github.com/tscolari/mobylette.git"
+    gem 'mobylette'
 
 And add to your ApplicationController.rb (for enabling it to all your controllers) or to the controllers you want this functionality on:
 
@@ -32,17 +32,25 @@ After that, you may start adding your .mobile. views.
 
 == Helpers
 
-==== is_mobile_request?
+* ==== is_mobile_request?
 
-This helper returns true if the request comes from a mobile device, false if it does not.
+  This helper returns true if the request comes from a mobile device, false if it does not.
 
-==== mobylette_stylesheet_link_tag(*sources)
+* ==== is_mobile_view?
 
-This works like the stylesheet_link_tag helper, but when the request comes from a mobile device, it adds "_mobile" to the stylesheets before calling stylesheet_link_tag
+  Returns if the current format is :mobile or not.
 
-==== mobylette_javascript_include_tag(*soruces)
+There is a difference between is_mobile_view? and is_mobile_request?. You may have a user requesting from a mobile device (is_mobile_request? == true) and at the same time, you may use the sesssion override to render de default format aways (is_mobile_view? == false). There are a lot of other combinations where these 2 functions will return different results.
+  * is_mobile_request?  -> Exclusively checks for the device from where the request were made
+  * is_mobile_view?     -> Exclusively checks for the view format been rendered
 
-Same as mobylette_stylesheet_link_tag, but for javascript files and javascript_include_tag
+* ==== mobylette_stylesheet_link_tag(*sources)
+
+  This works like the stylesheet_link_tag helper, but when the request comes from a mobile device, it adds "_mobile" to the stylesheets before calling stylesheet_link_tag
+
+* ==== mobylette_javascript_include_tag(*soruces)
+
+  Same as mobylette_stylesheet_link_tag, but for javascript files and javascript_include_tag
 
 == Fall Backs
 
@@ -54,9 +62,25 @@ This would force all views (mobile) to fall back to the html views. You may also
 
     respond_to_mobile_requests :fall_back => false
 
+== Forcing/Ignoring Mobile Requests
+
+You may force your user to aways render the mobile format, or to aways render the default request format (when the request comes from a mobile device). You can use the session var :mobylette_override for doing it:
+
+    session[:mobylette_override] = :ignore_mobile
+
+This will skip the code that would force the mobile format. By doing this, your user will aways render the 'original' version of your app.
+
+    session[:mobylette_override] = :force_mobile
+
+This will force the mobile format rendering, no matter from where the user is requesting it (unless it's a xhr request).
+
+    session[:mobylette_override] = nil
+
+This will disable any override (default).
+
 == Testing
 
-http://image.tin247.com/kenh14/080918143137-689-665.jpg
+http://tscolari.github.com/mobylette/mobylette_images/helmet.jpg
 
 Don't drive your mobylette without your Helmet! It's always safer do tests!
 

data/Rakefile

@@ -33,5 +33,10 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
+require 'metric_fu'
+MetricFu::Configuration.run do |config|
+  config.rcov[:test_files] = ['spec/**/*_spec.rb']
+  config.rcov[:rcov_opts] << "-Ispec" # Needed to find spec_helper
+end
 
 task :default => :test

data/lib/mobylette.rb

@@ -1,12 +1,17 @@
+#
+# Rails automatic mobile request support
 module Mobylette
   module Controllers
     autoload "RespondToMobileRequests", "mobylette/controllers/respond_to_mobile_requests"
     autoload "Helpers"                , "mobylette/controllers/helpers"
   end
 
+  # TestHelpers
   autoload "Helmet"                   , "mobylette/helmet"
+
   require 'mobylette/railtie'
 end
 
+# Creating the :mobile format alias
 require 'action_controller'
 Mime::Type.register_alias "text/html", :mobile

data/lib/mobylette/controllers/helpers.rb

@@ -1,14 +1,16 @@
 module Mobylette
   module Controllers
 
-    #
     # Mobylette::Controllers::Helpers include few methods to
     # include different css/js files for the mobile and for
     # the normal version of your layout
     #
-    # Personal note: I'm rethinking and I guess that, since you
-    # may have (and probably will) a different layout file for the
-    # "normal" and mobile version, you probably wont use this at all
+    # Personal notes:
+    # * I'm rethinking and I guess that, since you
+    #   may have (and probably will) a different layout file for the
+    #   "normal" and mobile version, you probably wont use this at all.
+    # * Also I'm not sure it's the case of using 'is_mobile_request?'
+    #   or 'is_mobile_view?' check here.'
     module Helpers
       extend ActiveSupport::Concern
 
@@ -34,7 +36,6 @@ module Mobylette
 
       private
 
-      #
       # Anex the "_mobile" sulfix to each string in the array,
       # before the .#{extension}, if it exists
       def sulfix_mobile_assets(sources, extension)

data/lib/mobylette/controllers/respond_to_mobile_requests.rb

@@ -10,19 +10,20 @@ module Mobylette
 
       included do
         helper_method :is_mobile_request?
+        helper_method :is_mobile_view?
 
         # List of mobile agents, from mobile_fu (https://github.com/brendanlim/mobile-fu)
         MOBILE_USER_AGENTS =  'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' +
                               'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' +
                               'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' +
                               'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' +
-                              'webos|amoi|novarra|cdm|alcatel|pocket|ipad|iphone|mobileexplorer|'    +
-                              'mobile'
+                              'webos|amoi|novarra|cdm|alcatel|pocket|iphone|mobileexplorer|mobile'
       end
 
       module ClassMethods
 
         # This method enables the controller do handle mobile requests
+        #
         # You must add this to every controller you want to respond differently to mobile devices,
         # or make it application wide calling it from the ApplicationController
         #
@@ -47,16 +48,23 @@ module Mobylette
 
         private
 
-        # helper method to check if the current request if from a mobile device or not
+        # This helper returns exclusively if the request's  user_aget is from a mobile
+        # device or not.
         def is_mobile_request?
-          return true if (request.format.to_s == "mobile") or (params[:format] == "mobile")
           request.user_agent.to_s.downcase =~ /#{MOBILE_USER_AGENTS}/
         end
+
+        # This helper returns exclusively if the current format is mobile or not
+        def is_mobile_view?
+          true if (request.format.to_s == "mobile") or (params[:format] == "mobile")
+        end
+
       end
 
     end
 
     # RespondToMobileRequestsMethods is included by respond_to_mobile_requests
+    #
     # This will check if the request is from a mobile device and change
     # the request format to :mobile
     module RespondToMobileRequestsMethods
@@ -72,7 +80,8 @@ module Mobylette
         # Changes the request.form to :mobile, when the request is from
         # a mobile device
         def handle_mobile
-          if is_mobile_request?
+          return if session[:mobylette_override] == :ignore_mobile
+          if not request.xhr? and ((session[:mobylette_override] == :force_mobile) or (is_mobile_request?))
             original_format   = request.format.to_sym
             request.format    = :mobile
             if self.fall_back_format != false

data/lib/mobylette/helmet.rb

@@ -10,6 +10,7 @@ module Mobylette
     autoload "Faker"  , "mobylette/helmet/faker"
 
     # Force the request for the user_agent
+    #
     # Remember to add it BEFORE the request
     #
     # Example:
@@ -24,6 +25,7 @@ module Mobylette
     end
 
     # Reset the user_aget to the default ("Rails Testing")
+    #
     # Remember to add it BEFORE the request
     #
     # Example:
@@ -37,5 +39,14 @@ module Mobylette
       request.user_agent = "Rails Testing"
     end
 
+    # set_session_override will set the 'value' to the session override control
+    # value may be:
+    # * :ignore_mobile  -> This will disable mobile checking, and the original format will be rendered
+    # * :force_mobile   -> This will force to all requests for this session be mobile (except xhr)
+    # * nil             -> This will disable session override
+    def set_session_override(value)
+      session[:mobylette_override] = value
+    end
+
   end
 end

data/lib/mobylette/version.rb

@@ -1,3 +1,3 @@
 module Mobylette
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/controllers/actioncontroller_base_spec.rb

@@ -13,4 +13,12 @@ describe ActionController::Base do
     @controller.send(:is_mobile_request?).should be_nil
   end
 
+  it "should have the :is_mobile_request? method" do
+    # works on ruby 1.9.2, but not on 1.8.7:
+    #@controller.private_methods.include?(:is_mobile_request?).should be_true
+
+    @controller.send(:is_mobile_view?).should be_nil
+  end
+
+
 end

data/spec/controllers/home_controller_spec.rb

@@ -86,4 +86,34 @@ describe HomeController do
     response.body.should contain("THIS IS NOT A MOBILE DEVICE")
   end
 
+  #######################################################
+  # Testing XHR requests
+  it "should not use mobile format for xhr requests" do
+    force_mobile_request_agent("Android")
+    xhr :get, :index
+    response.should render_template(:index)
+    response.body.should contain("AJAX VIEW")
+  end
+
+  #######################################################
+  # Testing Session Override
+
+  it "should force mobile view if session says it so" do
+    reset_test_request_agent
+    set_session_override(:force_mobile)
+    get :index
+    response.should render_template(:index)
+    response.should contain("this is the mobile view")
+    response.should contain("THIS IS NOT A MOBILE DEVICE")
+  end
+
+  it "should ignore mobile view processing if session says it so" do
+    force_mobile_request_agent("Android")
+    set_session_override(:ignore_mobile)
+    get :index
+    response.should render_template(:index)
+    response.should contain("this is the html view")
+    response.should contain("THIS A MOBILE DEVICE")
+  end
+
 end

data/spec/dummy/app/views/home/desktop.html.erb

@@ -1 +1,3 @@
-this is a desktop html mime type
+<% unless is_mobile_view? %>
+  this is a desktop html mime type
+<% end %>

data/spec/dummy/app/views/home/index.html.erb

@@ -1,4 +1,6 @@
-this is the html view
+<% unless is_mobile_view? %>
+  this is the html view
+<% end %>
 
 <% if is_mobile_request? %>
   THIS A MOBILE DEVICE

data/spec/dummy/app/views/home/index.js.erb

@@ -0,0 +1 @@
+AJAX VIEW

data/spec/dummy/app/views/home/index.mobile.erb

@@ -1,4 +1,6 @@
-this is the mobile view
+<% if is_mobile_view? %>
+  this is the mobile view
+<% end %>
 
 <% if is_mobile_request? %>
   THIS A MOBILE DEVICE

data/spec/dummy/app/views/home/mobile.mobile.erb

@@ -1 +1,3 @@
-this is a mobile mobile view
+<% if is_mobile_view? %>
+  this is a mobile mobile view
+<% end %>

data/spec/dummy/app/views/home/no_mobile_view.html.erb

@@ -1 +1,3 @@
-This is the only view, and it's html
+<% unless is_mobile_view? %>
+  This is the only view, and it's html
+<% end %>

metadata

@@ -1,62 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mobylette
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Tiago Scolari
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-03 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2011-09-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2151944860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
-  version_requirements: *id001
-  name: rails
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id002
-  name: rspec
   prerelease: false
+  version_requirements: *2151944860
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2151943960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *2151943960
 description: Adds the mobile format for rendering views for mobile device.
-email: 
+email:
 - tscolari@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/mobylette/controllers/helpers.rb
 - lib/mobylette/controllers/respond_to_mobile_requests.rb
 - lib/mobylette/helmet/faker.rb
@@ -126,6 +109,7 @@ files:
 - spec/dummy/app/views/force_fallback/test.js.erb
 - spec/dummy/app/views/home/desktop.html.erb
 - spec/dummy/app/views/home/index.html.erb
+- spec/dummy/app/views/home/index.js.erb
 - spec/dummy/app/views/home/index.mobile.erb
 - spec/dummy/app/views/home/mobile.mobile.erb
 - spec/dummy/app/views/home/no_mobile_view.html.erb
@@ -152,65 +136,48 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/script/rails
-- spec/dummy/tmp/cache/assets/C82/3E0/sprockets%2F48eb4ac616538f8f36870451073315da
-- spec/dummy/tmp/cache/assets/CE4/1C0/sprockets%2F18d93e1533d585b2f64ec90b33176ac9
-- spec/dummy/tmp/cache/assets/CED/A70/sprockets%2F621683d8791730a9cc7ce45e17a7e46d
-- spec/dummy/tmp/cache/assets/CFC/200/sprockets%2F716f89d85d4855706b8a9abec1969c62
-- spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- spec/dummy/tmp/cache/assets/D54/ED0/sprockets%2F71c9fa01091d432b131da3bb73faf3d4
-- spec/dummy/tmp/cache/assets/D84/210/sprockets%2Fabd0103ccec2b428ac62c94e4c40b384
-- spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
-- spec/dummy/tmp/pids/server.pid
 - spec/helpers/mobylette_helpers_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/mobylette_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/tscolari/mobylette
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3248281126714591700
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3248281126714591700
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Mobile request handling for your Rails app.
-test_files: 
+test_files:
 - spec/controllers/actioncontroller_base_spec.rb
 - spec/controllers/default_fallback_controller_spec.rb
 - spec/controllers/desktop_only_controller_spec.rb
@@ -268,6 +235,7 @@ test_files:
 - spec/dummy/app/views/force_fallback/test.js.erb
 - spec/dummy/app/views/home/desktop.html.erb
 - spec/dummy/app/views/home/index.html.erb
+- spec/dummy/app/views/home/index.js.erb
 - spec/dummy/app/views/home/index.mobile.erb
 - spec/dummy/app/views/home/mobile.mobile.erb
 - spec/dummy/app/views/home/no_mobile_view.html.erb
@@ -294,26 +262,13 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config.ru
-- spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/Rakefile
 - spec/dummy/script/rails
-- spec/dummy/tmp/cache/assets/C82/3E0/sprockets%2F48eb4ac616538f8f36870451073315da
-- spec/dummy/tmp/cache/assets/CE4/1C0/sprockets%2F18d93e1533d585b2f64ec90b33176ac9
-- spec/dummy/tmp/cache/assets/CED/A70/sprockets%2F621683d8791730a9cc7ce45e17a7e46d
-- spec/dummy/tmp/cache/assets/CFC/200/sprockets%2F716f89d85d4855706b8a9abec1969c62
-- spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- spec/dummy/tmp/cache/assets/D54/ED0/sprockets%2F71c9fa01091d432b131da3bb73faf3d4
-- spec/dummy/tmp/cache/assets/D84/210/sprockets%2Fabd0103ccec2b428ac62c94e4c40b384
-- spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
-- spec/dummy/tmp/pids/server.pid
 - spec/helpers/mobylette_helpers_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/mobylette_spec.rb