mobile-fu 1.0.0 → 1.1.0

data/README.md

@@ -4,7 +4,7 @@ Mobile Fu
 Want to automatically detect mobile devices that access your Rails application?
 Mobile Fu allows you to do just that.  People can access your site from a Palm,
 Blackberry, iPhone, iPad, Nokia, etc. and it will automatically adjust the format
-of the request from :html to :mobile.
+of the request from :html to :mobile or :tablet.
 
 Installation
 ------------
@@ -25,18 +25,22 @@ set as :mobile format.  It is up to you to determine how you want to handle
 these requests.  It is also up to you to create the .mobile.erb versions of
 your views that are to be requested.
 
-Then add the line below to config/initializers/mime_types.rb
-
-    Mime::Type.register_alias "text/html", :mobile
+Mobile Fu automatically adds a new `:mobile` and `:tablet` to `text/html` mime type 
+alias for Rails apps. If you already have a custom `:mobile` alias registered in 
+`config/initializers/mime_types.rb`, you can remove that.
 
 I recommend that you setup a before_filter that will redirect to a specific page
 depending on whether or not it is a mobile request.  How can you check this?
 
-    is_mobile_device? # => Returns true or false depending on the device
+    is_mobile_device? # => Returns true or false depending on the device or
+
+    is_tablet_device? # => Returns true if the device is a tablet
 
 You can also determine which format is currently set in by calling the following:
 
-    is_mobile_view? # => Returns true or false depending on current req. format
+    in_mobile_view? # => Returns true or false depending on current req. format or
+
+    in_tablet_view? # => Returns true if the current req. format is for tablet view
 
 Also, if you want the ability to allow a user to switch between 'mobile' and
 'standard' format (:html), you can just adjust the mobile_view session variable
@@ -45,6 +49,9 @@ in a custom controller action.
     session[:mobile_view] # => Set to true if request format is :mobile and false
                                if set to :html
 
+    session[:tablet_view] # => Set to true if request format is :tablet and false
+                               if set to :html
+
 So, different devices need different styling.  Don't worry, we've got this
 baked in to Mobile Fu.
 
@@ -86,5 +93,11 @@ mobile device emulator, or you can call `force_mobile_format` in a before filter
       before_filter :force_mobile_format
     end
 
+You can also force the tablet view by calling `force_tablet_format` instead
+
+    class ApplicationController < ActionController::Base
+      has_mobile_fu
+      before_filter :force_tablet_format
+    end
 
 Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license

data/lib/mobile-fu.rb

@@ -25,11 +25,16 @@ module MobileFu
     end
 
     Mime::Type.register_alias "text/html", :mobile
+    Mime::Type.register_alias "text/html", :tablet
   end
 end
 
 module ActionController
   module MobileFu
+    # These are various strings that can be found in tablet devices.  Please feel free
+    # to add on to this list.
+    TABLET_USER_AGENTS =  'ipad|android 3.0|xoom|sch-i800|playbook|tablet|kindle|honeycomb'
+
     def self.included(base)
       base.extend ClassMethods
     end
@@ -55,11 +60,13 @@ module ActionController
         before_filter :set_request_format if set_request_format
 
         helper_method :is_mobile_device?
+        helper_method :is_tablet_device?
         helper_method :in_mobile_view?
+        helper_method :in_tablet_view?
         helper_method :is_device?
         helper_method :mobile_device
       end
-      
+
       # Add this to your controllers to prevent the mobile format from being set for specific actions
       #   class AwesomeController < ApplicationController
       #     has_no_mobile_fu_for :index
@@ -91,13 +98,25 @@ module ActionController
         end
       end
 
+      # Forces the request format to be :tablet
+      def force_tablet_format
+        unless request.xhr?
+          request.format = :tablet
+          session[:tablet_view] = true if session[:tablet_view].nil?
+        end
+      end
+
       # Determines the request format based on whether the device is mobile or if
-      # the user has opted to use either the 'Standard' view or 'Mobile' view.
+      # the user has opted to use either the 'Standard' view or 'Mobile' view or
+      # 'Tablet' view.
 
       def set_mobile_format
         if !mobile_exempt? && is_mobile_device? && !request.xhr?
-          request.format = session[:mobile_view] == false ? :html : :mobile
+          request.format = :mobile unless session[:mobile_view] == false
           session[:mobile_view] = true if session[:mobile_view].nil?
+        elsif !mobile_exempt? && is_tablet_device? && !request.xhr?
+          request.format = :tablet unless session[:tablet_view] == false
+          session[:tablet_view] = true if session[:tablet_view].nil?
         end
       end
 
@@ -109,6 +128,14 @@ module ActionController
         request.format.to_sym == :mobile
       end
 
+      # Returns either true or false depending on whether or not the format of the
+      # request is either :tablet or not.
+
+      def in_tablet_view?
+        return false unless request.format
+        request.format.to_sym == :tablet
+      end
+
       # Returns either true or false depending on whether or not the user agent of
       # the device making the request is matched to a device in our regex.
 
@@ -116,6 +143,10 @@ module ActionController
         !!mobile_device
       end
 
+      def is_tablet_device?
+        request.user_agent.to_s.downcase =~ Regexp.new(ActionController::MobileFu::TABLET_USER_AGENTS)
+      end
+
       def mobile_device
         request.headers['X_MOBILE_DEVICE']
       end
@@ -126,10 +157,10 @@ module ActionController
       def is_device?(type)
         request.user_agent.to_s.downcase.include? type.to_s.downcase
       end
-      
+
       # Returns true if current action isn't supposed to use mobile format
       # See #has_no_mobile_fu_for
-      
+
       def mobile_exempt?
         self.class.instance_variable_get("@mobile_exempt_actions").try(:include?, params[:action].to_sym)
       end

data/lib/mobile-fu/helper.rb

@@ -6,18 +6,36 @@ module MobileFu
 
     def stylesheet_link_tag_with_mobilization(*sources)
       mobilized_sources = Array.new
+      
+      # Figure out where stylesheets live, which differs depending if the asset
+      # pipeline is used or not.
+      stylesheets_dir = config.stylesheets_dir # Rails.root/public/stylesheets
+      
+      # Look for mobilized stylesheets in the app/assets path if asset pipeline
+      # is enabled, because public/stylesheets will be missing in development
+      # mode without precompiling assets first, and may also contain multiple
+      # stylesheets with similar names because of checksumming during
+      # precompilation.
+      if Rails.application.config.respond_to?(:assets) # don't break pre-rails3.1
+        if Rails.application.config.assets.enabled
+          stylesheets_dir = File.join(Rails.root, 'app/assets/stylesheets/')
+        end
+      end
+      
+      device_names = respond_to?(:is_mobile_device?) && is_mobile_device? ? ['mobile', mobile_device.downcase] : []
+      
       sources.each do |source|
         mobilized_sources << source
-
-        device_names = respond_to?(:is_mobile_device?) && is_mobile_device? ? ['mobile', mobile_device.downcase] : []
-
+        
         device_names.compact.each do |device_name|
-          possible_source = "#{source.to_s.gsub '.css', ''}_#{device_name}.css"
-          path = File.join config.stylesheets_dir, possible_source
-          mobilized_sources << possible_source if File.exist?(path)
+          # support ERB and/or SCSS extensions (e.g., mobile.css.erb, mobile.css.scss.erb)
+          possible_source = source.to_s.sub(/\.css.*$/, '') + "_#{device_name}"
+          
+          mobilized_files = Dir.glob(File.join(stylesheets_dir, "#{possible_source}.css*")).map { |f| f.sub(stylesheets_dir, '') }
+          mobilized_sources += mobilized_files.map { |f| f.sub(/\.css.*/, '') }
         end
       end
-
+      
       stylesheet_link_tag_without_mobilization *mobilized_sources
     end
   end

data/lib/mobile-fu/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobile-fu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-21 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2156767760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156767760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-mobile-detect
-  requirement: &2156767340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156767340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156766920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156766920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2156766480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +70,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156766480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Want to automatically detect mobile devices that access your Rails application?
   Mobile Fu allows you to do just that. People can access your site from a Palm, Blackberry,
   iPhone, iPad, Nokia, etc. and it will automatically adjust the format of the request
@@ -66,16 +86,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG
-- Gemfile
 - MIT-LICENSE
 - README.md
-- Rakefile
 - lib/mobile-fu.rb
 - lib/mobile-fu/helper.rb
 - lib/mobile-fu/version.rb
-- mobile-fu.gemspec
 - spec/mobilized_styles_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/benlangfeld/mobile-fu
@@ -90,24 +106,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1843169329843289785
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1843169329843289785
 requirements: []
 rubyforge_project: mobile-fu
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Automatically detect mobile requests from mobile devices in your Rails application.
 test_files:
 - spec/mobilized_styles_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.gitignore

@@ -1,5 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-vendor/ruby

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in mobile-fu.gemspec
-gemspec

data/Rakefile

@@ -1,16 +0,0 @@
-require 'rake'
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new('spec')
-task :default => :spec
-
-# desc 'Generate documentation for the mobile_fu plugin.'
-# Rake::RDocTask.new(:rdoc) do |rdoc|
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title    = 'MobileFu'
-#   rdoc.options << '--line-numbers' << '--inline-source'
-#   rdoc.rdoc_files.include('README')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end

data/mobile-fu.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "mobile-fu/version"
-
-Gem::Specification.new do |s|
-  s.name        = "mobile-fu"
-  s.version     = MobileFu::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Brendan Lim", "Ben Langfeld"]
-  s.email       = ["brendangl@gmail.com, ben@langfeld.me"]
-  s.homepage    = "https://github.com/benlangfeld/mobile-fu"
-  s.summary     = %q{Automatically detect mobile requests from mobile devices in your Rails application.}
-  s.description = %q{Want to automatically detect mobile devices that access your Rails application? Mobile Fu allows you to do just that. People can access your site from a Palm, Blackberry, iPhone, iPad, Nokia, etc. and it will automatically adjust the format of the request from :html to :mobile.}
-
-  s.rubyforge_project = "mobile-fu"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency 'rails'
-  s.add_dependency 'rack-mobile-detect'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rdoc'
-end