ress 0.0.3 → 0.0.4

data/README.md

@@ -114,7 +114,14 @@ URL of the tablet site, you can load `http://tablet.foo.com/?force=1`.
 
 ### Dependencies
 
-TODO: Document Modernizr Dependency
+There are a couple of Modernizr features that must be included in order for
+Ress's javascript feature detection to function. If you are not already
+using Modernizr in your application you can automatically include a build that
+has been packaged with the gem by setting `config.include_modernizr = true` in
+`config/initializers/ress.rb`. If you include your own build (recommended),
+make sure that it includes "Touch Events" and "Media Queries", eg:
+
+http://modernizr.com/download/#-touch-mq-teststyles-prefixes
 
 ## Performance considerations
 
@@ -127,7 +134,7 @@ ress.js script and do your own server-side UA-based pushing.
 
 ## Browser support
 
-Device.js should work in all browsers that support
+The feature detection javascript should work in all browsers that support
 `document.querySelectorAll`. Notably, this excludes IE7. If you want it
 to work in IE7 and below, please include a [polyfill](https://gist.github.com/2724353).
 
@@ -141,4 +148,4 @@ in a pull request.
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/generators/ress/templates/ress.rb

@@ -1,4 +1,67 @@
+# Use this file to configure alternate versions of your application. Be sure to
+# restart your server whenever you make changes.
 Ress.configure do |config|
 
 
+  # == Canonical Subdomain
+  #
+  # If the cannonical version of your application is served under a subdomain
+  # you must set it here:
+  #
+  # config.set_canonical :subdomain => "subdomain"
+
+
+  # == Modernizr
+  #
+  # There are a couple of Modernizr features that must be included in order for
+  # Ress's javascript feature detection to function. If you are not already
+  # using Modernizr in your app you can automatically include a build that has
+  # been packaged with the gem by setting the below flag to true. If you include
+  # your own build (recommended), ensure that you include "Touch Events" and
+  # "Media Queries", eg:
+  #
+  # http://modernizr.com/download/#-touch-mq-teststyles-prefixes
+  #
+  # config.include_modernizr = false
+
+
+  # == Adding Alternate Site Versions
+  #
+  # You can register multiple alternate versions of your app by making calls to
+  # "config.add_alternate". For example:
+  #
+  # The following will add an alternate version served under
+  # "mobile.your_domain.com" and redirect devices with screens smaller than
+  # 640px wide to that version. On the server, it will prepend
+  # "app/mobile_views" to the view_paths, so templates there will take
+  # precedence over those in "app/views" and add `mobile_request?` controller /
+  # helper method to your application.
+  #
+  # config.add_alternate({
+  #  :name  => 'mobile',
+  #  :media => 'only screen and (max-width: 640px)'
+  # })
+  #
+  # You can configure the subdomain of a version by passing the ":subdomain"
+  # option to "add_alternate". For example, the below will serve the mobile
+  # version under "m.your_domain.com" but will still call the controller /
+  # helper method `mobile_request?` and prepend "app/mobile_views" to the
+  # view_paths
+  #
+  # config.add_alternate({
+  #  :name      => 'mobile',
+  #  :media     => 'only screen and (max-width: 640px)',
+  #  :subdomain => 'm'
+  # })
+  #
+  # By default the view_path added for a version is generated from the version
+  # name "app/#{name}_views". You may change this path by passing the
+  # ":view_path" option, eg:
+  #
+  # config.add_alternate({
+  #  :name      => 'mobile',
+  #  :media     => 'only screen and (max-width: 640px)',
+  #  :view_path => Rails.root.join('lib', 'mobile_views')
+  # })
+
 end

data/lib/ress.rb

@@ -26,6 +26,10 @@ module Ress
     category_collection.alternate_versions
   end
 
+  def include_modernizr?
+    category_collection.include_modernizr
+  end
+
   def configure
     yield(category_collection)
   end

data/lib/ress/category_collection.rb

@@ -2,6 +2,7 @@ module Ress
 
   class CategoryCollection
 
+    attr_accessor :include_modernizr
     attr_reader :canonical_version, :alternate_versions
 
     def initialize
@@ -15,9 +16,20 @@ module Ress
 
     def add_alternate(options)
       version = AlternateVersion.new(options.delete(:name), options.delete(:media), options)
+      define_helper_method(version) if defined? ActionController::Base
       alternate_versions << version
     end
 
+    private
+
+      def define_helper_method(version)
+        method_name = "#{version.name}_request?".to_sym
+        ActionController::Base.send(:define_method, method_name) do
+          version.matches?(request.subdomain)
+        end
+        ActionController::Base.helper_method(method_name)
+      end
+
   end
 
 end

data/lib/ress/controller_additions.rb

@@ -2,12 +2,8 @@ module Ress
 
   # This module is automatically included into all controllers.
   module ControllerAdditions
-    module ClassMethods
-      # class methods go here
-    end
 
     def self.included(base)
-      base.extend ClassMethods
       base.helper_method :canonical_request?
       base.before_filter :prepend_category_view_path
     end

data/lib/ress/version.rb

@@ -1,3 +1,3 @@
 module Ress
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/ress/view_helpers.rb

@@ -4,14 +4,21 @@ module Ress
 
     def ress_annotation_tags
       path = "#{request.host_with_port}#{request.fullpath}"
-      if canonical_request?
+      html = if canonical_request?
         Ress.alternate_versions.map do |category|
           category.link_tag(request.protocol, path, self)
-        end.join.html_safe
+        end.join
       else
         Ress.canonical_version.link_tag(request.protocol, path, request.subdomain, self)
       end
 
+      # Append the modernizr script tag if need be.
+      if Ress.include_modernizr?
+        html << self.javascript_include_tag("ress_modernizr_build")
+      end
+
+      html.html_safe
+
     end
 
   end

data/spec/ress/category_collection_spec.rb

@@ -37,4 +37,16 @@ describe Ress::CategoryCollection do
 
   end
 
+  describe '#include_modernizr' do
+
+    it 'is false by default' do
+      collection.include_modernizr.should be_false
+    end
+
+    it 'can be set' do
+      collection.include_modernizr = true
+      collection.include_modernizr.should be_true
+    end
+  end
+
 end

data/spec/ress/view_helpers_spec.rb

@@ -10,7 +10,10 @@ describe ActionView::Base do
     let(:category) { Ress::AlternateVersion.new('m', 'stuff') }
 
     before do
-      view.stub(:request => request)
+      view.stub(
+        :request => request,
+        :javascript_include_tag => '<script src="/assets/ress_modernizr_build.js" type="text/javascript"></script>'.html_safe
+      )
     end
 
     context 'alternate request' do
@@ -21,6 +24,12 @@ describe ActionView::Base do
         view.ress_annotation_tags.should == "<link href=\"http://foo.com/bar\" rel=\"canonical\" />"
       end
 
+      it 'adds a script tag for Modernizr if required' do
+        Ress.stub(:include_modernizr? => true)
+        view.ress_annotation_tags.should ==
+        "<link href=\"http://foo.com/bar\" rel=\"canonical\" /><script src=\"/assets/ress_modernizr_build.js\" type=\"text/javascript\"></script>"
+      end
+
     end
 
     context 'canonical request' do

data/spec/ress_spec.rb

@@ -35,4 +35,20 @@ describe Ress do
 
   end
 
+  describe '.include_modernizr?' do
+
+    it 'defaults to false' do
+      Ress.include_modernizr?.should be_false
+    end
+
+    it 'can be altered through Ress.configure' do
+      Ress.configure { |r| r.include_modernizr = true }
+      Ress.include_modernizr?.should be_true
+
+      Ress.configure { |r| r.include_modernizr = false }
+      Ress.include_modernizr?.should be_false
+    end
+
+  end
+
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: ress
 version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Robertson
@@ -12,32 +12,32 @@ cert_chain: []
 date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: actionpack
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
     none: false
-  name: actionpack
   type: :runtime
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
     none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: rspec
   type: :development
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -74,8 +74,8 @@ files:
 - spec/ress/controller_additions_spec.rb
 - spec/ress/view_helpers_spec.rb
 - spec/ress_spec.rb
-- vendor/assets/javascripts/modernizr.js
 - vendor/assets/javascripts/ress.js
+- vendor/assets/javascripts/ress_modernizr_build.js
 homepage: https://github.com/matthewrobertson/ress
 licenses: []
 post_install_message: