radiant-mobile-extension 0.1.4 → 0.1.5

data/config/initializers/radiant_config.rb

@@ -1,4 +1,6 @@
 Radiant.config do |config|
-  config.define "mobile.redirect?", :default => true
-  config.define "mobile.host"
-end
+  config.namespace('mobile') do |mob|
+    mob.define 'host', :allow_blank => true
+    mob.define 'redirect?', :default => true
+  end
+end 

data/lib/mobile_page.rb

@@ -1,15 +1,17 @@
 module MobilePage
   attr_accessor :mobile
 
+  # The extended site controller calls page.mobile = true if we are in a mobile context
+  #
   def mobile?
     !!@mobile
   end
-  
+
   include Radiant::Taggable
 
   desc %{
     Expands if the url of the current request matches the host name defined in Radiant::Config['mobile.host'].
-    (or if there is no such definition, if it begins with m.)
+    (or if there is no such definition, if the domain begins with m.)
 
     *Usage:*
     <pre><code><r:if_mobile>...</r:if_mobile></code></pre>
@@ -28,4 +30,5 @@ module MobilePage
   tag 'unless_mobile' do |tag|
     tag.expand unless mobile?
   end
+
 end

data/lib/mobile_site_controller.rb

@@ -1,4 +1,10 @@
 module MobileSiteController
+  #
+  # This extends the normal site controller in two ways: if we detect a mobile device,
+  # we can redirect to the corresponding page in a mobile site, and if we are on the mobile
+  # site we set a flag on the page that radius tags can use to select content.
+  
+  
   # approach and UA strings borrowed from mobile-fu
   # http://github.com/brendanlim/mobile-fu/tree/master
   MOBILE_USER_AGENTS = 'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' +
@@ -8,23 +14,38 @@ module MobileSiteController
                        'webos|amoi|novarra|cdm|alcatel|pocket|iphone|mobileexplorer|' +
                        'mobile'
 
+  # Returns true if the requested host matches the defined mobile host
+  # (or in the absence of such a definition, if the host begins m.)
+  #
   def mobile?
-    if mobile_host = @config['mobile.host']
+    mobile_host = Radiant.config['mobile.host']
+    unless mobile_host.blank?
       request.host == mobile_host
     else
       request.host =~ /^m\./
     end
   end
 
+  # Returns true if the request comes from a mobile device
+  # (based on the supplied user-agent string)
+  #
   def mobile_device?
     request.user_agent.to_s.downcase =~ Regexp.new(MobileSiteController::MOBILE_USER_AGENTS)
   end
 
+  # Extends the process_page method to place a 'mobile' flag in the page-rendering 
+  # context to support presentation choices in radius tags.
+  #
   def process_page_with_mobile(page)
     page.mobile = mobile?
     process_page_without_mobile(page)
   end
 
+  # Issues a redirect to the mobile site if this request comes from a mobile device, and if the
+  # mobile site is configured, and if the request does not have a 'nomobile' parameter.
+  # If there is a 'nomobile' parameter, a session marker is placed to indicate that the browser
+  # should not be redirected in future.
+  #
   def redirect_if_mobile
     if params['url'] =~ /\?mobile/
       session[:nomobile] = false
@@ -38,7 +59,7 @@ module MobileSiteController
     end
   end
 
-  def self.included(base)
+  def self.included(base) #:nodoc:
     base.class_eval do
       before_filter :redirect_if_mobile
       alias_method_chain :process_page, :mobile

data/lib/radiant-mobile-extension.rb

@@ -0,0 +1,8 @@
+module RadiantMobileExtension
+  VERSION = '0.1.5'
+  SUMMARY = %q{Provide a mobile version of your radiant site with minimal reworking.}
+  DESCRIPTION = %q{This extension provides radius tags and a redirection mechanism that makes it trivially simple to provide a mobile version of your site.}
+  URL = "http://github.com/spanner/radiant-mobile-extension"
+  AUTHORS = ["William Ross"]
+  EMAIL = ["radiant@spanner.org"]
+end

data/mobile_extension.rb

@@ -2,9 +2,9 @@
 # require_dependency 'application_controller'
 
 class MobileExtension < Radiant::Extension
-  version "0.1.4"
-  description "An easy, cache-friendly mobile version of your site"
-  url "http://github.com/spanner/radiant-mobile-extension"
+  version RadiantMobileExtension::VERSION
+  description RadiantMobileExtension::DESCRIPTION
+  url RadiantMobileExtension::URL
   
   def activate
     Page.send :include, MobilePage

data/radiant-mobile-extension.gemspec

@@ -1,62 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-mobile-extension"
 
 Gem::Specification.new do |s|
-  s.name = %q{radiant-mobile-extension}
-  s.version = "0.1.4"
+  s.name        = "radiant-mobile-extension"
+  s.version     = RadiantMobileExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantMobileExtension::AUTHORS
+  s.email       = RadiantMobileExtension::EMAIL
+  s.homepage    = RadiantMobileExtension::URL
+  s.summary     = RadiantMobileExtension::SUMMARY
+  s.description = RadiantMobileExtension::DESCRIPTION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["spanner"]
-  s.date = %q{2010-11-10}
-  s.description = %q{An easy, flexible, cache-friendly mobile version of your site}
-  s.email = %q{will@spanner.org}
-  s.extra_rdoc_files = [
-    "README.md"
-  ]
-  s.files = [
-    ".gitignore",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "app/views/admin/configuration/_edit_mobile.html.haml",
-     "app/views/admin/configuration/_mobile.html.haml",
-     "config/initializers/radiant_config.rb",
-     "config/locales/en.yml",
-     "config/routes.rb",
-     "cucumber.yml",
-     "features/support/env.rb",
-     "features/support/paths.rb",
-     "lib/mobile_page.rb",
-     "lib/mobile_site_controller.rb",
-     "lib/tasks/mobile_extension_tasks.rake",
-     "mobile_extension.rb",
-     "radiant-mobile-extension.gemspec",
-     "spec/controllers/mobile_site_controller_spec.rb",
-     "spec/models/mobile_page_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/spanner/radiant-mobile-extension}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Mobile Extension for Radiant CMS}
-  s.test_files = [
-    "spec/controllers/mobile_site_controller_spec.rb",
-     "spec/models/mobile_page_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency "paperclip", "~> 2.3.16"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
   else
+    []
   end
-end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+
+  s.post_install_message = %{
+  Add this to your radiant project with a line in your Gemfile:
+
+    gem 'radiant-mobile-extension', '~> #{RadiantMobileExtension::VERSION}'
+
+  }
 
+end

data/spec/controllers/mobile_site_controller_spec.rb

@@ -12,7 +12,7 @@ describe SiteController do
   
   describe "responding to a mobile-site request" do
     before do
-      request.stub!(:host).and_return(@host)
+      request.stub!(:host).and_return("m.test.host")
       controller.stub!(:find_page).and_return(@page)
     end
 
@@ -68,5 +68,4 @@ describe SiteController do
       
     end
   end
-  
 end

metadata

@@ -1,37 +1,48 @@
 --- !ruby/object:Gem::Specification 
 name: radiant-mobile-extension
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 17
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
-- spanner
+- William Ross
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 +00:00
-default_executable: 
-dependencies: []
-
-description: An easy, flexible, cache-friendly mobile version of your site
-email: will@spanner.org
+date: 2011-10-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 3
+        - 16
+        version: 2.3.16
+  type: :runtime
+  version_requirements: *id001
+description: This extension provides radius tags and a redirection mechanism that makes it trivially simple to provide a mobile version of your site.
+email: 
+- radiant@spanner.org
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files: []
+
 files: 
-- .gitignore
-- README.md
-- Rakefile
-- VERSION
 - app/views/admin/configuration/_edit_mobile.html.haml
 - app/views/admin/configuration/_mobile.html.haml
 - config/initializers/radiant_config.rb
@@ -42,20 +53,24 @@ files:
 - features/support/paths.rb
 - lib/mobile_page.rb
 - lib/mobile_site_controller.rb
+- lib/radiant-mobile-extension.rb
 - lib/tasks/mobile_extension_tasks.rake
 - mobile_extension.rb
+- radiant-mobile-extension-0.1.5.gem
 - radiant-mobile-extension.gemspec
+- Rakefile
+- README.md
 - spec/controllers/mobile_site_controller_spec.rb
 - spec/models/mobile_page_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
+- VERSION
 homepage: http://github.com/spanner/radiant-mobile-extension
 licenses: []
 
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+post_install_message: "\n  Add this to your radiant project with a line in your Gemfile:\n\n    gem 'radiant-mobile-extension', '~> 0.1.5'\n\n  "
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -79,11 +94,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Mobile Extension for Radiant CMS
+summary: Provide a mobile version of your radiant site with minimal reworking.
 test_files: 
 - spec/controllers/mobile_site_controller_spec.rb
 - spec/models/mobile_page_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb

data/.gitignore

@@ -1 +0,0 @@
-pkg/*