divining_rod 0.6.2 → 0.6.3

data/README.markdown

@@ -8,12 +8,12 @@ A tool to profile web requests. Especially useful for mobile site development
     gem install divining_rod
 
 ## Example
-  
+
   Using the example configuration (found in [example_config.rb](http://github.com/markpercival/divining_rod/blob/master/example_config.rb))
-  
+
     # For a request with the user agent
     # "Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_2_1 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5H11 Safari/525.20"
-    
+
     profile = DiviningRod::Profile.new(request)
     profile.iphone?           #=> true
     profile.name              #=> 'iPhone'
@@ -31,9 +31,9 @@ Matches happen in the order they are defined, and then proceed down to the subse
         iphone.ua /iPhone/, :tags => :iphone, :name => 'iPhone'
       end
     end
-    
+
 Will match "Apple iPad" first with the /Apple/ matcher, then with the /iPad/ matcher, and the tags will be
-    
+
     [:apple, :iphone_os, :ipad] # Notice tags get appended, *not* overridden.
 
 And _:format_ will be set to _nil_
@@ -43,7 +43,7 @@ Why _nil_? Because when :format is set to _nil_ and you ask for it, DiviningRod
 ## Usage
 
 _initializers/divining\_rod.rb_
-    
+
     DiviningRod::Mappings.define do |map|
         # Android based phones
         map.ua /Android/, :format => :webkit, :name => 'Android', :tags => [:android, :youtube_capable, :google_gears]
@@ -58,16 +58,16 @@ _initializers/divining\_rod.rb_
         #Blackberry, needs more detail here
         map.ua /BlackBerry/, :tags => :blackberry, :name => 'BlackBerry'
         map.subdomain /wap/, :format => :wap, :tags => [:crappy_old_phone]
-        
+
         # Enable this to forces a default format if unmatched
         # otherwise it will return the request.format
-        # map.default :format => :html 
+        # map.default :format => :html
     end
 
 _initializers/mime\_types.rb_
-    
+
     Mime::Type.register_alias "text/html", :webkit
-    
+
 _app/controllers/mobile\_controller.rb_
 
     class MobileController < ApplicationController
@@ -84,7 +84,7 @@ _app/controllers/mobile\_controller.rb_
       end
 
     end
-    
+
 _app/views/mobile/show.webkit.html_
 
     <%- if @profile.iphone? %>
@@ -93,11 +93,25 @@ _app/views/mobile/show.webkit.html_
       <%= link_to "Direct download", @android_app_url %>
     <% end %>
 
-    
-## Note on the development
+## Writing your own custom profiler
+
+You can also include the DiviningRod::Profiler mixin in your own custom class
+
+_lib/browser_profile.rb_
+
+    class BrowserProfile
+      include DivingingRod::Profiler
+
+      def has_an_app_store?
+        android? || iphone? || windows_phone?
+      end
+
+    end
+
+Usage
 
-In version 0.3.* it was assumed you always passed in _format_. In 0.4 on, we require _format_ to
-be passed in explicitly with the rest of the options hash.
+    prof = BrowserProfile.new(request)
+    prof.has_an_app_store?
 
 ## Todo
 

data/example_config.rb

@@ -19,6 +19,7 @@ DiviningRod::Mappings.define(:format => :html) do |map|
       desktop.ua /Safari/, :tags => :safari, :name => 'Safari'
       desktop.ua /Opera/, :tags => :opera, :name => 'Opera'
       desktop.ua /MSIE/, :tags => :ie, :name => 'Internet Explorer' do |msie|
+        msie.ua /MSIE 5\.5/
         msie.ua /MSIE 6/, :version => 6
         msie.ua /MSIE 7/, :version => 7
         msie.ua /MSIE 8/, :version => 8

data/lib/divining_rod/mappings.rb

@@ -21,6 +21,10 @@ module DiviningRod
 
     def initialize(parent, default_opts = {})
       @parent = parent
+      unless default_opts == {}
+        p "Passed in default_opts"
+        p default_opts
+      end
       @default_opts = Mash.new(default_opts)
     end
 
@@ -46,7 +50,8 @@ module DiviningRod
     def method_missing(meth, *args, &blk)
       # Lets us use map.ua instead of map.pattern :ua
       if Matchers.respond_to?(meth.to_sym)
-        self.pattern(meth, args[0], args[1,], &blk)
+        opts = args[1,] || {}
+        self.pattern(meth, args[0], opts, &blk)
       else
         super
       end
@@ -55,8 +60,8 @@ module DiviningRod
     private
 
     def merged_opts(opts)
-      opts = parent.opts.merge(opts)
       opts = default_opts.merge(opts)
+      opts = parent.opts.merge(opts)
       opts
     end
 
@@ -65,6 +70,5 @@ module DiviningRod
       definition
     end
 
-
   end
 end

data/lib/divining_rod/mash.rb

@@ -5,8 +5,8 @@ module DiviningRod
       self.replace(hsh || {})
     end
 
-    def merge(opts = {})
-      return self if opts.nil?
+    def merge(opts)
+      opts = opts.dup
       if self[:tags] || opts[:tags]
         tags = Array(self[:tags]) | Array(opts[:tags])
         opts[:tags] = tags

data/lib/divining_rod/version.rb

@@ -1,3 +1,3 @@
 module DiviningRod
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/test/test_example_config.rb

@@ -1,69 +1,76 @@
 require 'test_helper'
-require 'example_config'
+
+DiviningRod::Mappings.define(:format => :html, :tags => [:foo]) do |map|
+    map.ua /First/, :name => 'First', :tags => [:first]
+    map.ua /SecondMatch/, :name => 'Second', :tags => [:second]
+    map.with_options :tags => :grouping1 do |with_options|
+      with_options.ua /ThirdMatch/, :name => "ThirdMatch", :tags => [:third_match]
+      with_options.ua /FourthMatch/, :name => "FourthMatch", :tags => [:fourth_match]
+    end
+    map.ua /FifthMatch/, :name => 'FifthMatch', :tags => [:fifth_match, :and_more]
+    map.ua /ThirdMatch/, :name => "Failure", :tags => [:failed] # Shouldn't get here
+
+    map.ua /Stuffed Crust/, :name => 'Stuffed Crust', :tags => [:woo_hoo] do |sc|
+      sc.ua /Vegan/, :name => 'Bleh'
+      sc.with_options :name => "Meat and Cheese" do |mac|
+        mac.ua /With Bacon/, :tags => :bacon
+        mac.ua /With Ham/, :tags => :round_bacon
+        mac.ua /With Tofu/, :tags => :tofu, :name => "NotMeat and Cheese"
+      end
+    end
+
+    map.with_options :tags => :second_group do |second_group|
+      second_group.ua /ThirdMatch/
+      second_group.ua /SixthMatch/
+    end
+
+    map.ua /Last/, :tags => :last
+
+    map.default :name => "Unknown", :tags => :unknown
+end
 
 def profile_ua(ua)
   DiviningRod::Profile.new(request_mock(:ua => ua))
 end
 
-
 class ExampleConfigTest < Test::Unit::TestCase
   context 'the example config' do
 
-    context "recognizing Apple devices" do
-
-      should "recognize an iPad" do
-        profile = profile_ua("Mozilla/5.0(iPad; U; CPU iPhone OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B314 Safari/531.21.10")
-        assert profile.ipad?
-      end
-
-      should "recognize an iPod touch 2.2.1" do
-        profile = profile_ua("Mozilla/5.0 (iPod; U; CPU iPhone OS 2_2_1 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5H11 Safari/525.20")
-        assert profile.ipod?
-      end
-
-      should "recognize an iPod touch 3.1.2" do
-        profile = profile_ua("Mozilla/5.0 (iPod; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16")
-        assert profile.ipod?
-      end
-
-      should "recognize an iPhone 3.1.2" do
-        profile = profile_ua("Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16")
-        assert profile.iphone?
-      end
-
-      should "recognize an iPhone 2.1.2" do
-        profile = profile_ua("Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_2_1 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5H11 Safari/525.20")
-        assert profile.iphone?
+    context "with root definition options" do
+      should "carry through" do
+        profile = profile_ua("Unknown phone")
+        assert_equal "Unknown", profile.name
+        assert_equal :html, profile.format
       end
-
     end
 
-    context "recognizing Android devices" do
-
-      should "recognize a basic android" do
-        profile = profile_ua("Mozilla/5.0 (Linux; U; Android 1.0; en-us; dream) AppleWebKit/525.10+ (KHTML, like Gecko) Version/3.0.4 Mobile Safari/523.12.2")
-        assert profile.android?
+    context "after a with_options block" do
+      should "not affect subsequest matches" do
+        profile = profile_ua("Last")
+        assert_equal [:foo, :last], profile.tags
       end
-
     end
 
-    context "recognizing desktop browsers" do
-
-      should "recognize Internet Explorer 10" do
-        profile = profile_ua("Mozilla/4.0 (compatible; MSIE 10.0; Windows NT 7.0)")
-        assert profile.desktop?
-        assert_equal profile.version, 10
-        assert profile.html5?
+    context "matching a sub options group" do
+      should "overide the parent" do
+        profile = profile_ua("Stuffed Crust With Tofu")
+        assert_equal "NotMeat and Cheese", profile.name
+        profile = profile_ua("Stuffed Crust With Bacon")
+        assert_equal "Meat and Cheese", profile.name
       end
+    end
 
+    should "match with tags" do
+      profile = profile_ua("FifthMatch")
+      assert_equal "FifthMatch", profile.name
+      assert profile.and_more?
     end
 
-    context "with root definition options" do
-      should "carry through" do
-        profile = profile_ua("Unknown phone")
-        assert_equal "Unknown", profile.name
-        assert_equal :html, profile.format
-      end
+    should "stop at the first match" do
+      profile = profile_ua("ThirdMatch")
+      assert profile.third_match?
+      assert profile.grouping1?
+      assert !profile.failed?
     end
 
 

metadata

@@ -2,7 +2,7 @@
 name: divining_rod
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors: 
 - Mark Percival
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-25 00:00:00 Z
+date: 2011-05-12 00:00:00 Z
 dependencies: []
 
 description: A DSL for writing user agent profiles
@@ -76,4 +76,3 @@ specification_version: 3
 summary: A mobile request profiler
 test_files: []
 
-has_rdoc: