mobile_fu-rails3 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,108 @@
+= 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.  
+
+== Rails 3 Compatibility
+
+There are already some versions of Mobile Fu that are compatible with Rails 3,
+however they use old conventions for gem initialization. This is a rewrite
+of the plugin using current conventions.
+
+== Usage
+
+Add this this one line to the controller.
+
+    class ApplicationController < ActionController::Base
+      has_mobile_fu
+    end
+
+Once this is in place, any request that comes from a mobile device will be be 
+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
+
+If you don't want EVERY request to automatically be converted to :mobile if the device
+is mobile, you can enable the plugin with:
+
+    class ApplicationController < ActionController::Base
+      enable_mobile_fu
+    end
+
+And then in the controller that has mobile views you do:
+
+    class WhateverController < ApplicationController
+      before_filter :set_mobile_format
+    end
+
+If you want "test mode", or to always see the mobile view use:
+
+    class WhateverController < ApplicationController
+      before_filter :force_mobile_format
+    end
+
+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
+
+You can also determine which format is currently set in by calling the following:
+
+  in_mobile_view? # => Returns true or false depending on current req. format
+
+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
+in a custom controller action.
+
+  session[:mobile_view] # => Set to true if request format is :mobile and false
+                             if set to :html
+
+So, different devices need different styling.  Don't worry, we've got this
+baked in to Mobile Fu.
+
+If you are including a css or sass file via stylesheet_link_tag, all you have
+to do is add _device to the name of one of your files to override your styling
+for a certain device.  The stylesheet that is loaded is dependant on which device 
+is making the request.
+
+  e.g., Accessing a page from a Blackberry.
+
+  ...  stylesheet_link_tag 'mobile.css' ...
+
+  This loads mobile.css, and mobile_blackberry.css if the file exists.
+
+Supported stylesheet override device extensions at the moment are:
+
+  blackberry
+  iphone (iphone,ipod)
+  ipad
+  android
+  mobileexplorer
+  nokia
+  palm
+
+The stylesheet awesomeness was derived from Michael Bleigh's browserized styles:
+http://www.intridea.com/2007/12/9/announcing-browserized-styles
+
+Inspiration for Mobile Fu came from Noel Rappin's rails_iui:
+http://blogs.pathf.com/agileajax/2008/05/rails-developme.html
+
+Hopefully this should help you create some awesome mobile applications.
+
+== Testing Mobile Interface
+	
+If you want to force the mobile interface for testing, you can either use a 
+mobile device emulator, or you can pass 'true' to has_mobile_fu. 
+
+  class ApplicationController < ActionController::Base
+    has_mobile_fu(true) 
+  end
+
+
+Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mobile_fu/controller_methods.rb

@@ -0,0 +1,85 @@
+module MobileFu
+  module ActionController
+    # These are various strings that can be found in mobile devices.  Please feel free
+    # to add on to this list.
+    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"
+    
+    module ClassMethods
+      # Add this to one of your controllers to use MobileFu.  
+      #
+      #    class ApplicationController < ActionController::Base 
+      #      has_mobile_fu
+      #    end
+      #
+      # You can also force mobile mode by passing in 'true'
+      #
+      #    class ApplicationController < ActionController::Base 
+      #      has_mobile_fu(true)
+      #    end
+      def has_mobile_fu(test_mode = false)
+        include InstanceMethods
+
+        if test_mode 
+          before_filter :force_mobile_format
+        else
+          before_filter :set_mobile_format
+        end
+
+        helper_method :is_mobile_device?
+        helper_method :in_mobile_view?
+        helper_method :is_device?
+      end
+
+      def enable_mobile_fu
+        include InstanceMethods
+        
+        helper_method :is_mobile_device?
+        helper_method :in_mobile_view?
+        helper_method :is_device?
+      end
+    end
+    
+    module InstanceMethods
+      # Forces the request format to be :mobile
+      def force_mobile_format
+        unless request.xhr?
+          session[:mobile_view] ||= true
+          request.format = :mobile
+        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.      
+      def set_mobile_format
+        debugger
+        if request.format.html? and is_mobile_device? and not request.xhr?
+          session[:mobile_view] ||= true
+          request.format = session[:mobile_view] ? :mobile : :html
+        end
+      end
+      
+      # Returns either true or false depending on whether or not the format of the
+      # request is either :mobile or not.      
+      def in_mobile_view?
+        request.format.to_sym == :mobile
+      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.      
+      def is_mobile_device?
+        !!(request.user_agent.downcase =~ Regexp.new(MobileFu::ActionController::MOBILE_USER_AGENTS))
+      end
+
+      # Can check for a specific user agent
+      # e.g., is_device?('iphone') or is_device?(:mobileexplorer)
+      def is_device?(type)
+        request.user_agent.downcase.include?(type.to_s.downcase)
+      end
+    end
+  end
+end

data/lib/mobile_fu/helper_methods.rb

@@ -0,0 +1,26 @@
+module MobileFu
+  module ActionView
+    module HelperMethods
+      ACCEPTABLE_TYPES = [:mobile, :basic]
+  
+      def mobile_xhtml_doctype(type = :mobile, version = '1.0')
+        raise Exception.new("MobileFu: XHTML DOCTYPE type must either be ':mobile' or ':basic'") unless ACCEPTABLE_TYPES.include?(type)
+        raise Exception.new("MobileFu: XHTML DOCTYPE version must be in the format of '1.0' or '1.1', etc.") unless version.include?('.')
+    
+        doc_type = "<?xml version=\"1.0\" charset=\"UTF-8\" ?>\n"
+        doc_type += "<!DOCTYPE html PUBLIC "
+        doc_type += case type
+                    when :mobile
+                      "\"-//WAPFORUM//DTD XHTML Mobile #{version}//EN\" \"http://www.openmobilealliance.org/tech/DTD/xhtml-mobile#{version.gsub('.','')}.dtd\">"
+                    when :basic
+                      "\"-//W3C//DTD XHTML Basic #{version}//EN\" \"http://www.w3.org/TR/xhtml-basic/xhtml-basic#{version.gsub('.','')}.dtd\">"
+                    end
+        doc_type
+      end
+  
+      def js_enabled_mobile_device?
+        is_device?('iphone') or is_device?('ipod') or is_device?('ipad') or is_device?('mobileexplorer') or is_device?('android')
+      end
+    end
+  end
+end

data/lib/mobile_fu/mobilized_styles.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2008 Brendan G. Lim (brendan@intridea.com)
+# 
+# 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.
+
+module MobileFu
+  module ActionView
+    module MobilizedStyles
+      # This logic was taken from Michael Bleigh's browserized styles
+      # with modification to work for mobile browsers.
+      def user_agent_device_name
+        @user_agent_device_name ||= begin
+          ua = request.user_agent
+          return nil if ua.nil?
+          ua.downcase!
+
+          if ua.index('mobileexplorer') or ua.index('windows ce')
+            'mobileexplorer'
+          elsif ua.index('blackberry') 
+            'blackberry'
+          elsif ua.index('iphone') or ua.index('ipod')
+            'iphone'
+          elsif ua.index('ipad')
+            'ipad'
+          elsif ua.index('android')
+            'android'
+          elsif ua.index('nokia') 
+            'nokia'
+          elsif ua.index('palm') 
+            'palm'
+          end
+        end
+      end
+
+      def stylesheet_link_tag_with_mobilization(*sources)
+        mobilized_sources = Array.new
+        sources.each do |source|
+          subbed_source = source.to_s.gsub('.css', '')
+
+          possible_sources = ["#{subbed_source.to_s}_#{user_agent_device_name}"]
+
+          mobilized_sources << source
+
+          for possible_source in possible_sources
+            path = File.join(config.stylesheets_dir,"#{possible_source}.css")
+            sass_path = File.join(config.stylesheets_dir,"sass","#{possible_source}.sass")
+            mobilized_sources << possible_source if File.exist?(path) || File.exist?(sass_path)
+          end
+        end
+
+        stylesheet_link_tag_without_mobilization(*mobilized_sources)
+      end
+    end
+  end
+end

data/lib/mobile_fu/railtie.rb

@@ -0,0 +1,19 @@
+require 'mobile_fu/controller_methods'
+require 'mobile_fu/helper_methods'
+require 'mobile_fu/mobilized_styles'
+
+module MobileFu
+  class Railtie < Rails::Railtie
+    initializer 'mobile_fu.initialize' do
+      ActiveSupport.on_load(:action_controller) do 
+        extend MobileFu::ActionController::ClassMethods
+      end
+      
+      ActiveSupport.on_load(:action_view) do
+        include MobileFu::ActionView::HelperMethods
+        include MobileFu::ActionView::MobilizedStyles
+        alias_method_chain :stylesheet_link_tag, :mobilization
+      end
+    end
+  end
+end

data/lib/mobile_fu-rails3.rb

@@ -0,0 +1 @@
+require 'mobile_fu/railtie.rb'

data/mobile_fu-rails3.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "mobile_fu-rails3"
+  s.version     = "1.0.0"
+  s.authors     = ["Jori Hardman"]
+  s.email       = ["jorihardman@gmail.com"]
+  s.homepage    = "https://github.com/jyro215/mobile_fu-rails3"
+  s.summary     = "Easily handling of mobile requests in action controller."
+  s.description = "This is a rewrite of the mobile-fu gem using Rails 3 railsties."
+
+  s.rubyforge_project = "mobile_fu-rails3"
+
+  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", ">= 3.0.0")
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: mobile_fu-rails3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jori Hardman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-23 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2168726260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168726260
+description: This is a rewrite of the mobile-fu gem using Rails 3 railsties.
+email:
+- jorihardman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/.DS_Store
+- lib/mobile_fu-rails3.rb
+- lib/mobile_fu/controller_methods.rb
+- lib/mobile_fu/helper_methods.rb
+- lib/mobile_fu/mobilized_styles.rb
+- lib/mobile_fu/railtie.rb
+- mobile_fu-rails3.gemspec
+has_rdoc: true
+homepage: https://github.com/jyro215/mobile_fu-rails3
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mobile_fu-rails3
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easily handling of mobile requests in action controller.
+test_files: []