mobylette 1.6.0 → 2.0

data/README.rdoc

@@ -1,7 +1,12 @@
 http://tscolari.github.com/mobylette/mobylette_images/mobylette.jpg
 
+  Mobylette 2.0+ deprecated the respond_to_mobile_requests method.
+  Now you must use `include Mobylette::RespondToMobileRequests` instead.
+  to configure it, see the configuration.
+  Also stylesheet and javascript helpers were removed.
+
   Mobylette 1.6+ only supports Ruby 1.9.2+
-  For Ruby 1.8.7 support, please use version > 1.6
+  For Ruby 1.8.7 support, please use version < 1.6
 
 = Mobylette http://travis-ci.org/tscolari/mobylette.png
 
@@ -24,7 +29,7 @@ Add the gem to your gemfile:
 
 And add to your ApplicationController.rb (for enabling it to all your controllers) or to the controllers you want this functionality on:
 
-    respond_to_mobile_requests
+    include Mobyllete::RespondToMobileRequests
 
 After that, you may start adding your .mobile. views.
 
@@ -42,30 +47,36 @@ There is a difference between is_mobile_view? and is_mobile_request?. You may ha
   * 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
 
-* ==== 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
+== Configuration
 
-* ==== mobylette_javascript_include_tag(*soruces)
+You can set the configuration with the mobyllete_config method:
 
-  Same as mobylette_stylesheet_link_tag, but for javascript files and javascript_include_tag
+    mobylette_config do |config|
+      config[:fall_back] = nil
+      config[:skip_xhr_requests] = false
+    end
 
 == Fall Backs
 
-By default, when the mobile format is not found, mobylette will fall back to the request original format. For example, if a cell phone makes a request by html, and there is no mobile view, it will render the html. You may force it always to fall back to a especific format, by passing the :fall_back parameter to the respond_to_mobile_requests method:
+By default, when the mobile format is not found, mobylette will fall back to the request original format. For example, if a mobile device makes a request by html, and there is no mobile view, it will render the html. You may force it always to fall back to a especific format, by setting the :fall_back option on your controller:
 
-    respond_to_mobile_requests :fall_back => :html
+    mobylette_config do |config|
+      config[:fall_back] = :html
+    end
 
 This would force all views (mobile) to fall back to the html views. You may also disable this behavior, and no fall back will ever occur:
 
-    respond_to_mobile_requests :fall_back => false
-
+    mobylette_config do |config|
+      config[:fall_back] = false
+    end
 
 == XHR Requests
 
-By default the mobile device verification will skip XHR requests, and these will be served as if mobylette wasn't there. You can override this behavior by passing the :skip_xhr_requests => false to the respond_to_mobile_requests call.
+By default the mobile device verification will skip XHR requests, and these will be served as if mobylette wasn't there. You can override this behavior by setting the :skip_xhr_requests option to false on your controller:
 
-    respond_to_mobile_requests :skip_xhr_requests => false
+    mobylette_config do |config|
+      config[:skip_xhr_requests] = false
+    end
 
 You may need to use this if you are using JQuery mobile or something similar in your application.
 
@@ -73,7 +84,7 @@ You may need to use this if you are using JQuery mobile or something similar in
 
 In the case you need to skip a mobile_request for been treated as mobile, you can pass the `skip_mobile=true` param to the url/request.
 
-For example, you are using jquery_mobile and by that `:skip_xhr_requests => false`, but there is a special case where you need to process an Ajax, then you can use this param.
+For example, you are using jquery_mobile and by that `:skip_xhr_requests = false`, but there is a special case where you need to process an Ajax, then you can use this param.
 
 == Forcing/Ignoring Mobile Requests
 
@@ -104,28 +115,30 @@ For testing, include the Mobylette::Helmet module to your test/test_helpers.rb:
 
 For RSpec: add to your spec/spec_helpers.rb or create a spec/support/mobylette.rb with the following:
 
-    require 'mobylette/helmet' 
+    require 'mobylette/helmet'
     RSpec.configure do |config|
       config.include Mobylette::Helmet, :type => :controller
     end
 
-This will add 2 methods to your test scope:
+This will add 3 methods to your test scope:
 
-    force_mobile_request_agent
+    force_mobile_request_agent(agent = 'Android')
 
-this one will force a mobile user_agent, allowing you to test mobile requests.
+This will force a mobile user_agent, allowing you to test mobile requests.
 
     reset_test_request_agent
 
-and this one will reset your user_agent to the test default "Rails Testing". You don't need to call this everytime, all your requests by default are "Rails Testing" in your test env.
+This will reset your user_agent to the test default "Rails Testing". You don't need to call this everytime, all your requests by default are "Rails Testing" in your test env.
+
+    set_session_override(override_value)
+
+This will force the session_override value in the users session. Values possible values are:  :ignore_mobile and :force_mobile
 
 Friendly note: on your tests, call these functions BEFORE you make the request, otherwise they are useless =p
 
 == Contributions and Credits
 
-This gem is based on the mobile_fu plugin (https://github.com/brendanlim/mobile-fu).
-
-Also, these pages were very usefull when creating the gem:
+these pages were very usefull when creating this gem:
 * http://stackoverflow.com/questions/5126085/ruby-on-rails-mobile-application
 * http://www.arctickiwi.com/blog/mobile-enable-your-ruby-on-rails-site-for-small-screens
 * http://metautonomo.us/2011/01/05/mobile-devices-and-rails-maintaining-your-sanity/

data/Rakefile

@@ -20,23 +20,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
 Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  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,10 +1,7 @@
 #
 # Rails automatic mobile request support
 module Mobylette
-  module Controllers
-    require "mobylette/controllers/respond_to_mobile_requests"
-    require "mobylette/controllers/helpers"
-  end
+  require "mobylette/respond_to_mobile_requests"
 
   # TestHelpers
   # require "mobylette/helmet"

data/lib/mobylette/helmet.rb

@@ -6,8 +6,6 @@ module Mobylette
   # documentation about how to make this test wide.
   module Helmet
     extend ActiveSupport::Concern
-    require "mobylette/helmet/helpers"
-    require "mobylette/helmet/faker"
 
     # Force the request for the user_agent
     #

data/lib/mobylette/railtie.rb

@@ -4,11 +4,5 @@ module Mobylette
   # Automatic inlcudes Mobylette::Controllers::RespondToMobileRequests to ActiveController::Base and
   # load Mobylette::Controllers::Helpers as ActionController::Base helpers
   class Railtie < ::Rails::Railtie
-    initializer :mobylette do
-      ActiveSupport.on_load(:action_controller) do
-        ::ActionController::Base.send(:include, Mobylette::Controllers::RespondToMobileRequests)
-        ::ActionController::Base.helper Mobylette::Controllers::Helpers
-      end
-    end
   end
 end

data/lib/mobylette/respond_to_mobile_requests.rb

@@ -0,0 +1,135 @@
+module Mobylette
+  # Mobylette::Controllers::RespondToMobileRequests includes the respond_to_mobile_requests
+  # to your ActionController::Base.
+  #
+  # The respond_to_mobile_requests method enables the controller mobile handling
+  module RespondToMobileRequests
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :is_mobile_request?
+      helper_method :is_mobile_view?
+
+      before_filter :handle_mobile
+
+      cattr_accessor :mobylette_options
+      @@mobylette_options = Hash.new
+      @@mobylette_options[:skip_xhr_requests] = true
+      @@mobylette_options[:fall_back]         = nil
+
+      # 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|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
+      #
+      # Possible options:
+      # * fall_back: :html
+      #     You may pass a fall_back option to the method, it will force the render
+      #     to look for that other format, in case there is not a .mobile file for the view.
+      #     By default, it will fall back to the format of the original request.
+      #     If you don't want fall back at all, pass fall_back: false
+      # * skip_xhr_requests: true/false
+      #     By default this is set to true. When a xhr request enters in, it will skip the
+      #     mobile verification. This will let your ajax calls to work as intended.
+      #     You may disable this (actually you will have to) if you are using JQuery Mobile, or
+      #     other js framework that uses ajax. To disable, set skip_xhr_requests: false
+      #
+      # Example Usage:
+      #
+      #   class ApplicationController...
+      #     include Mobylette::RespondToMobileRequests
+      #     ...
+      #     mobylette_config do |config|
+      #       config[:fall_back] = :html
+      #       config[:skip_xhr_requests] = false
+      #     end
+      #     ...
+      #   end
+      #
+      def mobylette_config
+        yield(self.mobylette_options)
+      end
+    end
+
+    private
+
+    # :doc:
+    # Private: Tells if the request comes from a mobile user_agent or not
+    #
+    def is_mobile_request?
+      request.user_agent.to_s.downcase =~ /#{MOBILE_USER_AGENTS}/
+    end
+
+    # :doc:
+    # Private: Helper method that tells if the currently view is mobile or not
+    #
+    def is_mobile_view?
+      true if (params[:format] == "mobile") || (request.format.to_s == "mobile")
+    end
+
+    # Private: This is the method that tells if the request will be threated as mobile
+    #          or not
+    #
+    def respond_as_mobile?
+      impediments = stop_processing_because_xhr? || stop_processing_because_param?
+      (not impediments) && (force_mobile_by_session? || is_mobile_request? || params[:format] == 'mobile')
+    end
+
+    # Private: Returns true if the visitor has the force_mobile set in it's session
+    #
+    def force_mobile_by_session?
+      session[:mobylette_override] == :force_mobile
+    end
+
+    # Private: Tells when mobylette should not interfere in the rendering
+    #          process because the `skip_mobile` param is set to true
+    #
+    # Passing :skip_mobile = true to a request will not render it as a mobile
+    #
+    def stop_processing_because_param?
+      return true if params[:skip_mobile] == 'true'
+      false
+    end
+
+    # Private: Tells when mobylette should or not interfere in the rendering
+    #          process because of a xhr request.
+    #
+    # if the request is not xhr this will aways return false
+    # this will only return true for xhr requests, when you explicit want to
+    # not skip_xhr_requests.
+    #
+    def stop_processing_because_xhr?
+      if request.xhr? && self.mobylette_options[:skip_xhr_requests]
+        true
+      else
+        false
+      end
+    end
+
+    # :doc:
+    # Private: Process the request as mobile
+    #
+    def handle_mobile
+      return if session[:mobylette_override] == :ignore_mobile
+      if respond_as_mobile?
+
+        original_format   = request.format.to_sym
+        request.format    = :mobile
+        if self.mobylette_options[:fall_back] != false
+          request.formats << Mime::Type.new(self.mobylette_options[:fall_back] || original_format)
+        end
+      end
+    end
+
+  end
+end

data/lib/mobylette/version.rb

@@ -1,3 +1,3 @@
 module Mobylette
-  VERSION = "1.6.0"
+  VERSION = "2.0"
 end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe ApplicationController do
+
+  describe 'Helmet' do
+
+    describe "#force_mobile_request_agent" do
+      it "should set request.user_agent to Android by default" do
+        force_mobile_request_agent
+        request.user_agent.should == 'Android'
+      end
+
+      it "should set request.user_agent to whatever the argument is" do
+        force_mobile_request_agent(:any_value)
+        request.user_agent.should == :any_value
+      end
+    end
+
+    describe "#reset_test_request_agent" do
+      it "should reset request.user_agent to rails default" do
+        force_mobile_request_agent(:something_else)
+        request.user_agent.should == :something_else
+        reset_test_request_agent
+        request.user_agent.should == 'Rails Testing'
+      end
+    end
+
+    describe "#set_session_override" do
+      it "should set the session[mobylette_override] to whatever value the argument is" do
+        set_session_override(:super_testing)
+        session[:mobylette_override].should == :super_testing
+      end
+    end
+
+  end
+
+end

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

@@ -1,4 +1,3 @@
 class ApplicationController < ActionController::Base
-  protect_from_forgery
 
 end

data/spec/dummy/log/development.log

@@ -0,0 +1,116 @@
+
+
+Started GET "/" for 127.0.0.1 at 2012-03-25 16:04:55 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.html.erb within layouts/application (2.2ms)
+Compiled application.css  (0ms)  (pid 45506)
+Compiled application.js  (0ms)  (pid 45506)
+Completed 200 OK in 25ms (Views: 24.5ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2012-03-25 16:04:55 -0300
+Served asset /application.css - 200 OK (5ms)
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2012-03-25 16:04:55 -0300
+Served asset /application.js - 200 OK (3ms)
+
+
+Started GET "/" for 192.168.0.5 at 2012-03-25 16:05:53 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.mobile.erb within layouts/application (0.6ms)
+Compiled application_mobile.css  (0ms)  (pid 45506)
+Compiled application_mobile.js  (0ms)  (pid 45506)
+Completed 200 OK in 30ms (Views: 29.3ms)
+
+
+Started GET "/assets/application_mobile.css?body=1" for 192.168.0.5 at 2012-03-25 16:05:53 -0300
+Served asset /application_mobile.css - 200 OK (5ms)
+
+
+Started GET "/assets/application_mobile.js?body=1" for 192.168.0.5 at 2012-03-25 16:05:53 -0300
+Served asset /application_mobile.js - 200 OK (2ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-03-25 16:11:35 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.html.erb within layouts/application (2.5ms)
+Completed 200 OK in 34ms (Views: 33.9ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2012-03-25 16:11:35 -0300
+Served asset /application.css - 304 Not Modified (0ms)
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2012-03-25 16:11:35 -0300
+Served asset /application.js - 304 Not Modified (0ms)
+
+
+Started GET "/" for 192.168.0.5 at 2012-03-25 16:11:43 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.mobile.erb within layouts/application (0.8ms)
+Completed 200 OK in 8ms (Views: 8.1ms)
+
+
+Started GET "/assets/application_mobile.css?body=1" for 192.168.0.5 at 2012-03-25 16:11:43 -0300
+Served asset /application_mobile.css - 304 Not Modified (0ms)
+
+
+Started GET "/assets/application_mobile.js?body=1" for 192.168.0.5 at 2012-03-25 16:11:43 -0300
+Served asset /application_mobile.js - 304 Not Modified (0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-03-25 16:12:03 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.html.erb within layouts/application (0.3ms)
+Completed 200 OK in 26ms (Views: 25.6ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2012-03-25 16:12:03 -0300
+Served asset /application.css - 304 Not Modified (0ms)
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2012-03-25 16:12:03 -0300
+Served asset /application.js - 304 Not Modified (0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-03-25 16:12:05 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.html.erb within layouts/application (0.2ms)
+Completed 200 OK in 4ms (Views: 3.7ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2012-03-25 16:12:05 -0300
+Served asset /application.css - 304 Not Modified (0ms)
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2012-03-25 16:12:05 -0300
+Served asset /application.js - 304 Not Modified (0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-03-25 16:12:12 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.html.erb within layouts/application (0.2ms)
+Completed 200 OK in 4ms (Views: 3.6ms)
+
+
+Started GET "/assets/application.css?body=1" for 127.0.0.1 at 2012-03-25 16:12:12 -0300
+Served asset /application.css - 304 Not Modified (0ms)
+
+
+Started GET "/assets/application.js?body=1" for 127.0.0.1 at 2012-03-25 16:12:12 -0300
+Served asset /application.js - 304 Not Modified (0ms)
+
+
+Started GET "/" for 192.168.0.5 at 2012-03-25 16:12:15 -0300
+  Processing by HomeController#index as HTML
+Rendered home/index.mobile.erb within layouts/application (0.5ms)
+Completed 200 OK in 4ms (Views: 3.7ms)
+
+
+Started GET "/assets/application_mobile.css?body=1" for 192.168.0.5 at 2012-03-25 16:12:15 -0300
+Served asset /application_mobile.css - 200 OK (1ms)
+
+
+Started GET "/assets/application_mobile.js?body=1" for 192.168.0.5 at 2012-03-25 16:12:15 -0300
+Served asset /application_mobile.js - 200 OK (0ms)