RubyGems - quartermaster - Versions diffs - 1.0.0 - Mend

quartermaster 1.0.0

Files changed (9) hide show

data.tar.gz.sig ADDED Viewed

Binary file

data/History.txt ADDED Viewed

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-05-06
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt ADDED Viewed

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/quartermaster.rb
+test/test_quartermaster.rb

data/README.txt ADDED Viewed

@@ -0,0 +1,60 @@
+= quartermaster
+* http://contentfree.rubyforge.org/quartermaster
+== DESCRIPTION:
+A collection of shortcuts and helpers for leveraging a request's env in Rails, such as including a browser-specific stylesheet if one exists or putting a short version of the user agent in the CSS classes of the body tag. This removes the need for most hacks or conditional comments since you can now do get browser-specific with your CSS rules (ex. body.ie6 div { ... })
+== FEATURES/PROBLEMS:
+* Short user agents for major browsers
+* Detect and include browser-specific stylesheets
+* Add short user agent to CSS classes which includes OS and browser info
+== SYNOPSIS:
+# Including classes in the body tag of an HTML layout when making a request with IE6/Win:
+<body class="<%= user_agent_for_css %>"> #=> Results in: <body class="win ie ie6">
+# Including browser-specific stylesheets, using Firefox 2 and a stylesheet at public/stylesheets/browsers/firefox2.css. It
+# only includes stylesheets if they exist. Will look for stylesheets for the base browser - "firefox" - as well as
+# version-specific - "firefox2"
+<head>
+  <%= stylesheet_link_tag_for_browser %> #=> results in a link tag for the stylesheet(s) for the requesting browser
+</head>
+== CAVEATS:
+If you use user_agent_for_css, you'll lose the ability to (usefully) page cache since the first requester's browser information would get cached.
+Another trade-off if you're using stylesheet_link_tag_for_browser is that you have multiple stylesheet requests. If you want to consolidate your requests per page, don't use stylesheet_link_tag_for_browser and instead use a combination of user_agent_for_css and body.<short user agent> in your rules
+== INSTALL:
+* sudo gem install quartermaster
+== LICENSE:
+(The MIT License)
+Copyright (c) 2008 FIX
+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.

data/Rakefile ADDED Viewed

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'hoe'
+require './lib/quartermaster.rb'
+Hoe.new('quartermaster', Quartermaster::VERSION) do |p|
+  p.rubyforge_name = 'quartermaster' # if different than lowercase project name
+  p.developer('Dave Myron', 'dave.myron@contentfree.com')
+end
+# vim: syntax=Ruby

data/lib/quartermaster.rb ADDED Viewed

@@ -0,0 +1,52 @@
+module Quartermaster
+  VERSION = '1.0.0'
+  module Helper
+    # Uses the output of +browser_from_user_agent+ to figure out what stylesheets to look for and then uses +stylesheet_link_tag+
+    # to produce the link tags. Stylesheets must appear in STYLESHEETS_DIR/browsers/ (STYLESHEETS_DIR is public/stylesheets by default) and be named the same as the output of +browser_from_user_agents+. If both firefox.css and firefox2.css, for example, are
+    # present and Firefox 2 makes a request, both stylesheets will be loaded. Takes any options that can be passed to
+    # +stylesheet_link_tag+
+    def stylesheet_link_tag_for_browser( options = {} )
+      agent_attributes = [os_from_user_agent] + browser_from_user_agent
+      agent_attributes.select{ |attribute| File.exists?( File.join(self.class::STYLESHEETS_DIR, 'browsers', "#{attribute}.css" )) }.collect{ |attribute| stylesheet_link_tag( attribute, options )}.to_s
+    end
+    # Very similar to +stylesheet_link_tag_for_browser+ except for javascripts
+    def javascript_include_tag_for_browser( options = {} )
+      agent_attributes = [os_from_user_agent] + browser_from_user_agent
+      agent_attributes.select{ |attribute| File.exists?( File.join(self.class::JAVASCRIPTS_DIR, 'browsers', "#{attribute}.js" )) }.collect{ |attribute| javascript_include_tag( attribute, options )}.to_s
+    end
+    # Returns a space-separated string of the OS and the short user agents for the requesting browser
+    def user_agent_for_css
+      "#{os_from_user_agent} #{browser_from_user_agent.join(' ')}"
+    end
+    # Returns an array containing the base browser name and a version-specific name (except for Konqueror) for the given +user_agent+ which defaults to Rails' +request.user_agent+
+    def browser_from_user_agent( user_agent = request.user_agent )
+      @browser_from_user_agent ||= case user_agent.downcase
+        when /opera[ \/](\d)/     then "opera opera#{$1}" # Have to check for opera before msie
+        when /msie (\d)/          then "ie ie#{$1}" # F U ie5.5 - todo: Support minor versions
+        when /firefox\/(\d)/      then "firefox firefox#{$1}"
+        when /safari\/([2-9])/   then "safari safari#{$1.to_i - 2}" # Safari uses the webkit build number. Only works with Safari 1.3+
+        when /rv:([^)]+)\) gecko/ then "gecko gecko#{$1}"
+        when /applewebkit\/(\d)/  then "webkit webkit#{$1}"
+        when /konqueror/          then 'konqueror'
+      end.split(' ')
+    end
+    # Returns a short version of the OS name for the given +user_agent+ which defaults to Rails' +request.user_agent+
+    def os_from_user_agent( user_agent = request.user_agent )
+      @os_from_user_agent ||= case user_agent.downcase
+        when /win/         then 'win'
+        when /mac/         then 'mac'
+        when /(linux|x11)/ then 'linux'
+      end
+    end
+  end
+end
+if defined?(RAILS_ROOT)
+  # Automatically include it into Rails
+  ActionView::Base.class_eval { include Quartermaster::Helper }
+end

data/test/test_quartermaster.rb ADDED Viewed

@@ -0,0 +1,161 @@
+require './lib/quartermaster'
+require 'rubygems'
+require 'spec'
+class QMTest
+  STYLESHEETS_DIR = 'path/to/stylesheets'
+  JAVASCRIPTS_DIR = 'path/to/javascripts'
+  include Quartermaster::Helper
+  # Mock a couple ActionView helpers
+  def stylesheet_link_tag(*sources)
+    sources.pop if sources.last.is_a?(Hash)
+    "<link for #{sources.join(',')}>"
+  end
+  def javascript_include_tag(*sources)
+    sources.pop if sources.last.is_a?(Hash)
+    "<script for #{sources.join(',')}>"
+  end
+end
+USER_AGENTS = {
+  :firefox2  => 'Mozilla/5.0 (Windows; Windows NT 5.1; en-US; rv:1.8.1.9) Gecko/20071025 Firefox/2.0.0.9',
+  :firefox3  => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9b5) Gecko/2008032619 Firefox/3.0b5',
+  :ie6       => 'Mozilla/4.0 (Windows; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727)',
+  :ie7       => 'Mozilla/5.0 (Windows; U; MSIE 7.0; Windows NT 6.0; en-US)',
+  :safari2   => 'Mozilla/5.0 (Macintosh; U; PPC Mac OS; en-en) AppleWebKit/412 (KHTML, like Gecko) Safari/412',
+  :safari3   => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en) AppleWebKit/522.11 (KHTML, like Gecko) Version/3.0.2 Safari/522.12',
+  :opera8    => 'Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; en) Opera 8.00',
+  :opera9    => 'Opera/9.00 (Windows NT 5.1; U; en)',
+  :konqueror => 'Mozilla/5.0 (compatible; Konqueror/3.5; Linux) KHTML/3.5.9 (like Gecko)'
+}
+OS_USER_AGENTS = {
+  :mac   => USER_AGENTS[:safari3],
+  :win   => USER_AGENTS[:ie6],
+  :linux => USER_AGENTS[:konqueror]
+}
+describe 'Quartermaster' do
+  before(:each) do
+    @qm = QMTest.new
+  end
+  USER_AGENTS.each do |short_agent_name, user_agent|
+    it "should correctly detect #{short_agent_name}" do
+      @qm.browser_from_user_agent( user_agent ).last.should == short_agent_name.to_s
+    end
+  end
+  describe 'after a request has been made' do
+    before(:each) do
+      @request = mock('Request', :user_agent => USER_AGENTS[:firefox2])
+      @qm.stub!(:request).and_return(@request)
+    end
+    describe 'when calculating classes for CSS' do
+      OS_USER_AGENTS.each do |os, user_agent|
+        describe "for #{os}" do
+          it "should include '#{os}' in the classes" do
+            @request.stub!(:user_agent).and_return(user_agent)
+            @qm.user_agent_for_css.split(' ').should include(os.to_s)
+          end
+        end
+      end
+      USER_AGENTS.each do |browser, user_agent|
+        describe "for #{browser}" do
+          before(:each) do
+            @request.stub!(:user_agent).and_return(user_agent)
+          end
+          it "should include '#{browser}' in the classes" do
+            @qm.user_agent_for_css.split(' ').should include(browser.to_s)
+          end
+          if browser.to_s =~ /\d$/
+            it "should include the base browser name '#{browser.to_s[0..-2]}' in the classes" do
+              @qm.user_agent_for_css.split(' ').should include(browser.to_s[0..-2])
+            end
+          end
+        end
+      end
+    end
+    # Uses mocked helpers defined in QMTest class
+    describe 'when creating stylesheet link tags' do
+      before(:each) do
+        %w(win.css firefox.css firefox2.css).each do |file|
+          File.stub!(:exists?).with(File.join(QMTest::STYLESHEETS_DIR, 'browsers', file )).and_return(true)
+        end
+      end
+      def expected_output_for( *sources )
+        sources.collect{ |attribute| @qm.stylesheet_link_tag(attribute)}.to_s
+      end
+      it "should create links to the os file, the browser-base file, and the browser-specific file" do
+        @qm.stylesheet_link_tag_for_browser.should == expected_output_for( *%w(win firefox firefox2) )
+      end
+      describe "and the OS-specific file doesn't exist" do
+        it "should not create a link to the file" do
+          File.stub!(:exists?).with(File.join(QMTest::STYLESHEETS_DIR, 'browsers', 'win.css')).and_return(false)
+          @qm.stylesheet_link_tag_for_browser.should == expected_output_for( *%w(firefox firefox2) )
+        end
+      end
+      describe "and the browser-base version doesn't exist" do
+        it "should not create a link to the file" do
+          File.stub!(:exists?).with(File.join(QMTest::STYLESHEETS_DIR, 'browsers', 'firefox.css')).and_return(false)
+          @qm.stylesheet_link_tag_for_browser.should == expected_output_for( *%w(win firefox2) )
+        end
+      end
+      describe "and the browser-specific version doesn't exist" do
+        it "should not create a link to the file" do
+          File.stub!(:exists?).with(File.join(QMTest::STYLESHEETS_DIR, 'browsers', 'firefox2.css')).and_return(false)
+          @qm.stylesheet_link_tag_for_browser.should == expected_output_for( *%w(win firefox) )
+        end
+      end
+    end
+    describe 'when creating javascript include tags' do
+      before(:each) do
+        %w(win.js firefox.js firefox2.js).each do |file|
+          File.stub!(:exists?).with(File.join(QMTest::JAVASCRIPTS_DIR, 'browsers', file )).and_return(true)
+        end
+      end
+      def expected_output_for( *sources )
+        sources.collect{ |attribute| @qm.javascript_include_tag(attribute)}.to_s
+      end
+      it "should create script tags for the os file, the browser-base file, and the browser-specific file" do
+        @qm.javascript_include_tag_for_browser.should == expected_output_for( *%w(win firefox firefox2) )
+      end
+      describe "and the OS-specific file doesn't exist" do
+        it "should not create a script tag for the file" do
+          File.stub!(:exists?).with(File.join(QMTest::JAVASCRIPTS_DIR, 'browsers', 'win.js')).and_return(false)
+          @qm.javascript_include_tag_for_browser.should == expected_output_for( *%w(firefox firefox2) )
+        end
+      end
+      describe "and the browser-base version doesn't exist" do
+        it "should not create a script tag for the file" do
+          File.stub!(:exists?).with(File.join(QMTest::JAVASCRIPTS_DIR, 'browsers', 'firefox.js')).and_return(false)
+          @qm.javascript_include_tag_for_browser.should == expected_output_for( *%w(win firefox2) )
+        end
+      end
+      describe "and the browser-specific version doesn't exist" do
+        it "should not create a script tag for the file" do
+          File.stub!(:exists?).with(File.join(QMTest::JAVASCRIPTS_DIR, 'browsers', 'firefox2.js')).and_return(false)
+          @qm.javascript_include_tag_for_browser.should == expected_output_for( *%w(win firefox) )
+        end
+      end
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: quartermaster
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dave Myron
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQjCCAiqgAwIBAgIBADANBgkqhkiG9w0BAQUFADBHMRMwEQYDVQQDDApkYXZl
+  Lm15cm9uMRswGQYKCZImiZPyLGQBGRYLY29udGVudGZyZWUxEzARBgoJkiaJk/Is
+  ZAEZFgNjb20wHhcNMDgwNDE3MTAwNTMzWhcNMDkwNDE3MTAwNTMzWjBHMRMwEQYD
+  VQQDDApkYXZlLm15cm9uMRswGQYKCZImiZPyLGQBGRYLY29udGVudGZyZWUxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+  AQDS5jTexxypvZPqoIRWYcbNGbbgHMn5pd2dUA74fq5IJ0y0J9TK/xy2Ncf8Hv6l
+  o43531AmDVlPQ7aTTZfqDHQQEoCsHiTxtIc8S3mRQ03exGG+sJIq5Fsgzqg2jvQh
+  MF3lWjVgENU8/INxpW4f/iST/ojn/PciYSIKs6SBcm9tHfU/jiMOT0qxCkyVAxM0
+  0rD/yPQyPb7ogUNsO3RU1v5KBrlcV3lQPRQyRCDUpJ6H0AmeAa4iax/xfK0d/ta+
+  A9t4MmelIMUohH3VYEgYzCN/SnJsLMcEWbaXYFJMUUk07f+EmV060VUi4vsqvrMy
+  vyRmhHyxBuiyNNoSi/wfF3ebAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQD
+  AgSwMB0GA1UdDgQWBBSYmhWA9lg6R++f6Z0m5/ZJ8mwTAzANBgkqhkiG9w0BAQUF
+  AAOCAQEANprOIqYQsh0myh1GeHwTYo75bFHeMns5kkx44pVRSNWO4M5WEVFztyqO
+  VW8ZS4aHOqZ/XvOZ3YIP0mNNJEOM3jVirbdRBBnu75q87xDuPX0HVkk687qXFfJ7
+  Qb+KYshgOEn3n1iBzL6zIYyPOFRxFBEeix7uAZw9gq/EJf7isDToYKG+BE+q53ES
+  i/ul3Zg65QMGyXWBJlDEcQ7bxD/+pdUhOqew5tBuMvgxB/9XUPTCTLK9rfhakiBd
+  ZOWAbHDEFtZtQMT5GUHvuZ5jqfEKsE8tkFfFnUPY7DwpqWKkhuQzmmunB2J9aykn
+  arkBVHd8TABNoJ+MQvwL/7sCwSTiTg==
+  -----END CERTIFICATE-----
+date: 2008-05-06 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    version:
+description: A collection of shortcuts and helpers for leveraging a request's env in Rails, such as including a browser-specific stylesheet if one exists or putting a short version of the user agent in the CSS classes of the body tag. This removes the need for most hacks or conditional comments since you can now do get browser-specific with your CSS rules (ex. body.ie6 div { ... })
+email:
+- dave.myron@contentfree.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/quartermaster.rb
+- test/test_quartermaster.rb
+has_rdoc: true
+homepage: http://contentfree.rubyforge.org/quartermaster
+post_install_message:
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: quartermaster
+rubygems_version: 1.1.1
+signing_key:
+specification_version: 2
+summary: A collection of shortcuts and helpers for leveraging a request's env in Rails, such as including a browser-specific stylesheet if one exists or putting a short version of the user agent in the CSS classes of the body tag
+test_files:
+- test/test_quartermaster.rb

metadata.gz.sig ADDED Viewed

Binary file