mobile-fu 0.0.1 → 0.1.0

data/{README.rdoc → README.md}

@@ -1,27 +1,18 @@
-= Mobile Fu
+Mobile Fu
+=========
 
-Want to automatically detect mobile devices that access your Rails application?  
+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.
 
-== Rails 3 Compatibility
+Installation
+------------
 
-The master branch of this plugin is Rails 3 compatible.  
+Simply add `gem 'mobile-fu'` to your Gemfile and run bundle install.
 
-To use the Rails 3 compatible version of this plugin, please install it like so:
-
-    rails plugin install git://github.com/brendanlim/mobile-fu.git
-
-== Rails 2 Compatibility
-
-You will need to install this plugin from the 2.x branch.
-
-To use the Rails 2 compatible version of this plugin, please install it like so:
-
-    script/plugin install git://github.com/brendanlim/mobile-fu.git -r 2.x
-
-== Usage
+Usage
+-----
 
 Add this this one line to the controller.
 
@@ -29,71 +20,71 @@ Add this this one line to the controller.
       has_mobile_fu
     end
 
-Once this is in place, any request that comes from a mobile device will be be 
+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
+    Mime::Type.register_alias "text/html", :mobile
 
 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
 
 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
+    is_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
+    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
+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 
+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' ...
+    ...  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
+  * 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
+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
+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. 
+Testing Mobile Interface
+------------------------
+
+If you want to force the mobile interface for testing, you can either use a
+mobile device emulator, or you can call `force_mobile_format` in a before filter.
 
-  class ApplicationController < ActionController::Base
-    has_mobile_fu(true) 
-  end
+    class ApplicationController < ActionController::Base
+      has_mobile_fu
+      before_filter :force_mobile_format
+    end
 
 
 Copyright (c) 2008 Brendan G. Lim, Intridea, Inc., released under the MIT license

data/lib/mobile-fu.rb

@@ -28,40 +28,32 @@ module ActionController
       #      has_mobile_fu
       #    end
       #
-      # You can also force mobile mode by passing in 'true'
+      # If you don't want mobile_fu to set the device type automatically,
+      # you cal pass false here.
       #
       #    class ApplicationController < ActionController::Base
-      #      has_mobile_fu true
+      #      has_mobile_fu false
       #    end
+      #
 
-      def has_mobile_fu(test_mode = false)
+      def has_mobile_fu(set_device_type = false)
         include ActionController::MobileFu::InstanceMethods
 
-        before_filter test_mode ? :force_mobile_format : :set_mobile_format
+        before_filter :set_device_type if set_device_type
 
         helper_method :is_mobile_device?
         helper_method :in_mobile_view?
         helper_method :is_device?
         helper_method :mobile_device
       end
-
-      def is_mobile_device?
-        @@is_mobile_device
-      end
-
-      def in_mobile_view?
-        @@in_mobile_view
-      end
-
-      def is_device?(type)
-        @@is_device
-      end
     end
 
     module InstanceMethods
+      def set_device_type(force_mobile = false)
+        force_mobile ? force_mobile_format : set_mobile_format
+      end
 
       # Forces the request format to be :mobile
-
       def force_mobile_format
         unless request.xhr?
           request.format = :mobile
@@ -104,7 +96,6 @@ module ActionController
         request.user_agent.to_s.downcase.include? type.to_s.downcase
       end
     end
-
   end
 
 end

data/lib/mobile-fu/helper.rb

@@ -1,22 +1,5 @@
 module MobileFu
   module Helper
-    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') || is_device?('ipod') || is_device?('ipad') || is_device?('mobileexplorer') || is_device?('android')
     end

data/lib/mobile-fu/mobilized_styles.rb

@@ -1,72 +1,23 @@
-# 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 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') || ua.index('windows ce')
-          'mobileexplorer'
-        elsif ua.index('blackberry')
-          'blackberry'
-        elsif ua.index('iphone') || 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
+    def device_name
+      @device_name ||= headers['X_MOBILE_DEVICE']
     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
+        path = File.join config.stylesheets_dir, "#{source.to_s.gsub '.css', ''}_#{device_name}.css"
+        mobilized_sources << possible_source if File.exist?(path)
       end
 
-      stylesheet_link_tag_without_mobilization *mobilized_sources
+      stylesheet_link_tag *mobilized_sources
     end
   end
 end

data/lib/mobile-fu/version.rb

@@ -1,3 +1,3 @@
 module MobileFu
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/mobilized_styles_spec.rb

@@ -1,38 +1,30 @@
 require 'spec_helper'
 
-module ActionView
-  module Helpers
-    module AssetTagHelper
-      STYLESHEETS_DIR = "stylesheets"
-    end
-  end
-end
-
 describe MobileFu::MobilizedStyles do
 
   before(:each) do
-    @view = mock(:ActionView)
-    @request = mock(:ActionRequest)
-    @view.extend(MobileFu::MobilizedStyles)
-    @view.stub!(:request).and_return(@request)
-    @request.stub!(:user_agent)
+    @view = mock :ActionView
+    @request = mock :ActionRequest
+    @view.extend MobileFu::MobilizedStyles
+    @view.stub!(:request).and_return @request
+    @request.stub! :user_agent
   end
 
   def ua(str)
-    @request.stub!(:user_agent).and_return(str)
+    @request.stub!(:user_agent).and_return str
   end
 
   it "will include a mobilized css file if it recognizes a string in the user agent" do
     ua "iphone"
-    File.should_receive(:exist?).with("stylesheets/style_iphone.css").and_return(true)
-    @view.should_receive(:stylesheet_link_tag_without_mobilization).with("style", "style_iphone")
-    @view.stylesheet_link_tag_with_mobilization("style")
+    File.should_receive(:exist?).with("stylesheets/style_iphone.css").and_return true
+    @view.should_receive(:stylesheet_link_tag).with "style", "style_iphone"
+    @view.stylesheet_link_tag_with_mobilization "style"
   end
 
   it "includes mobiziled css files whether or not the original call to stylesheet_link_tag used a file extension" do
     ua "blackberry"
-    File.should_receive(:exist?).with("stylesheets/style_blackberry.css").and_return(true)
-    @view.should_receive(:stylesheet_link_tag_without_mobilization).with("style.css", "style_blackberry")
-    @view.stylesheet_link_tag_with_mobilization("style.css")
+    File.should_receive(:exist?).with("stylesheets/style_blackberry.css").and_return true
+    @view.should_receive(:stylesheet_link_tag).with "style.css", "style_blackberry"
+    @view.stylesheet_link_tag_with_mobilization "style.css"
   end
 end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mobile-fu
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Brendan Lim
@@ -11,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-27 00:00:00 +01:00
+date: 2011-05-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +26,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -33,6 +39,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -44,6 +52,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -55,6 +65,8 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -72,7 +84,7 @@ files:
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/mobile-fu.rb
 - lib/mobile-fu/helper.rb
@@ -95,17 +107,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: mobile-fu
-rubygems_version: 1.6.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Automatically detect mobile requests from mobile devices in your Rails application.