radiant-mobile-extension 0.1.0

data/README.md

@@ -0,0 +1,91 @@
+# Mobile
+
+This very simple extension allows you to offer a cache-friendly mobile version of your radiant site.
+
+## Basic usage
+
+1. Any request to a host whose address begins 'm.' is considered to be a request for the mobile site. If you want to use a different address, put its hostname in 'mobile.host'. You can do that through the admin settings interface.
+
+2. Set 'mobile.redirect?' to true and put the full hostname in 'mobile.hostname' if you want to bounce iphone and other mobile users to your mobile site when they first arrive.
+
+3. Provide a link back to your main site by appending ?nomobile. We will skip the redirect on that request and set a session flag that will carry on blocking it for future requests.
+
+4. Use the radius tags `<r:if_mobile_>` and `<r:unless_mobile>` to make layout or content decisions based on whether this is a request for the mobile site.
+
+## Possibly AQ
+
+### Why not just set :format (or use mobile-fu)?
+
+* Because radiant renders pages within the model, using layouts chosen by association. The rails layout is always the same and there is no show-page template in the usual sense.
+
+### Why not just detect mobile devices?
+
+* We can give visitors more control this way.
+* We can't deliver variant pages through the cache: different versions of the same page must have different addresses.
+
+## Building a mobile site
+
+It's up to you how broadly the mobile context affects your site delivery. Here are some likely scenarios:
+
+### Omitted content
+
+	<r:unless_mobile>
+	  <r:content part="sidebar" />
+	<r:unless_mobile>
+
+### Different CSS
+
+	<r:if_mobile>
+	  <r:stylesheet slug="mobile.css" as="link" />
+	</r:if_mobile>
+	<r:unless_mobile>
+	  <r:stylesheet slug="standard.css" as="link" />
+	<r:unless_mobile>
+
+### Different content
+
+	<r:if_mobile>
+	  <r:content part="iphone" />
+	</r:if_mobile>
+	<r:unless_mobile>
+	  <r:content />
+	<r:unless_mobile>
+
+### Different page components
+
+	<r:if_mobile>
+	  <r:snippet name="mobile_masthead" />
+	</r:if_mobile>
+	<r:unless_mobile>
+	  <r:snippet name="standard_masthead" />
+	</r:unless_mobile>
+
+### Different layout
+
+With the `layouts` or `nested_layouts` extension you could create a simple layout-chooser layout. I haven't tried it, but this ought to work:
+
+	<r:if_mobile>
+	  <r:inside_layout name="Mobile">
+	    <r:content_for_layout />
+	  </r:inside_layout>
+	</r:if_mobile>
+	<r:unless_mobile>
+	  <r:inside_layout name="Standard">
+	  	<r:content_for_layout />
+	  </r:inside_layout>
+	</r:unless_mobile>
+
+## Status
+
+Brand new and not well tested, but there's not much to it.
+
+## Bugs and comments
+
+Github issues, please, or write to Will.
+
+## Author and copyright
+
+* Copyright spanner ltd 2010.
+* Released under the same terms as Rails and/or Radiant.
+* Contact will at spanner.org
+

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-mobile-extension"
+    gem.summary = %Q{Mobile Extension for Radiant CMS}
+    gem.description = %Q{An easy, flexible, cache-friendly mobile version of your site}
+    gem.email = "will@spanner.org"
+    gem.homepage = "http://github.com/spanner/radiant-mobile-extension"
+    gem.authors = ["spanner"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package mobile as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the mobile extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MobileExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the mobile extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/views/admin/configuration/_edit_mobile.html.haml

@@ -0,0 +1,7 @@
+%fieldset
+  %h3 
+    =t('mobile_site')
+  %p
+    = edit_config 'mobile.redirect?'
+  %p
+    = edit_config 'mobile.host'

data/app/views/admin/configuration/_mobile.html.haml

@@ -0,0 +1,6 @@
+%h4
+  = t('mobile_site')
+%p.ruled
+  = show_config 'mobile.host'
+%p.ruled
+  = show_config 'mobile.redirect?'

data/config/initializers/radiant_config.rb

@@ -0,0 +1,4 @@
+Radiant.config do |config|
+  config.define "mobile.redirect?", :default => true
+  config.define "mobile.host"
+end

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  mobile: "Mobile"
+  mobile_site: "Mobile site"
+  config:
+    mobile:
+      redirect?: "Redirect mobile users"
+      host: "Mobile site host"
+      

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  # map.namespace :admin, :member => { :remove => :get } do |admin|
+  #   admin.resources :mobile
+  # end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :mobile
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/mobile_page.rb

@@ -0,0 +1,31 @@
+module MobilePage
+  attr_accessor :mobile
+
+  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.)
+
+    *Usage:*
+    <pre><code><r:if_mobile>...</r:if_mobile></code></pre>
+  }
+  tag 'if_mobile' do |tag|
+    tag.expand if mobile?
+  end
+
+  desc %{
+    Expands unless the url of the current request matches the host name defined in Radiant::Config['mobile.host'].
+    (or if there is no such definition, unless it begins with m.)
+
+    *Usage:*
+    <pre><code><r:unless_mobile>...</r:unless_mobile></code></pre>
+  }
+  tag 'unless_mobile' do |tag|
+    tag.expand if mobile?
+  end
+end

data/lib/mobile_site_controller.rb

@@ -0,0 +1,46 @@
+module MobileSiteController
+  # appraoch 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|' +
+                      'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' +
+                      'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' +
+                      'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' +
+                      'webos|amoi|novarra|cdm|alcatel|pocket|ipad|iphone|mobileexplorer|' +
+                      'mobile'
+
+  def mobile?
+    if mobile_host = @config['mobile.host']
+      request.host == mobile_host
+    else
+      request.host =~ /^m\./
+    end
+  end
+
+  def mobile_device?
+    request.user_agent.to_s.downcase =~ Regexp.new(MobileSiteController::MOBILE_USER_AGENTS)
+  end
+
+  def process_page_with_mobile(page)
+    page.mobile = mobile?
+    process_page_without_mobile(page)
+  end
+
+  def redirect_if_mobile
+    if params['url'] =~ /\?mobile/
+      session[:nomobile] = false
+    elsif params['url'] =~ /\?nomobile/
+      session[:nomobile] = true
+    end
+    if @config['mobile.redirect?'] && @config['mobile.host'] && !session[:nomobile] && !mobile? && mobile_device?
+      redirect_to request.protocol + @config['mobile.host'] + request.path_parameters['url']
+    end
+  end
+
+  def self.included(base)
+    base.class_eval do
+      before_filter :redirect_if_mobile
+      alias_method_chain :process_page, :mobile
+    end
+  end
+
+end

data/lib/tasks/mobile_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :mobile do
+      
+      desc "Runs the migration of the Mobile extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          MobileExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          MobileExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Mobile to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from MobileExtension"
+        Dir[MobileExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(MobileExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless MobileExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from MobileExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join MobileExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = MobileExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/mobile_extension.rb

@@ -0,0 +1,16 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application_controller'
+
+class MobileExtension < Radiant::Extension
+  version "0.1.0"
+  description "An easy, cache-friendly mobile version of your site"
+  url "http://github.com/spanner/radiant-mobile-extension"
+  
+  def activate
+    Page.send :include, MobilePage
+    SiteController.send :include, MobileSiteController
+    
+    admin.configuration.show.add :config, "mobile", :after => "defaults"
+    admin.configuration.edit.add :form, "edit_mobile", :after => "edit_defaults"
+  end
+end

data/spec/controllers/mobile_site_controller_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SiteController do
+  dataset :pages
+  
+  before do
+    @host = "m.test.host"
+    @page = pages(:first)
+    Radiant::Config['mobile.host'] = @host
+    Radiant::Config['mobile.redirect?'] = true
+  end
+  
+  describe "responding to a mobile-site request" do
+    before do
+      request.stub!(:host).and_return(@host)
+      controller.stub!(:find_page).and_return(@page)
+    end
+
+    it "should notice that this is a request for the mobile site" do
+      controller.mobile?.should be_true
+    end
+
+    it "should set the mobile flag on a processed page to true" do
+      @page.should_receive(:mobile=).with(true)
+      get :show_page, :url => @page.url
+    end
+  end
+  
+  describe "responding to a standard-site request" do
+    before do
+      request.stub!(:host).and_return('test.host')
+      controller.stub!(:find_page).and_return(@page)
+    end
+
+    it "should notice that this is not a request for the mobile site" do
+      controller.mobile?.should be_false
+    end
+
+    it "should set the mobile flag on a processed page to false" do
+      @page.should_receive(:mobile=).with(false)
+      get :show_page, :url => @page.url
+    end
+    
+    describe "from a mobile device" do
+      before do
+        controller.stub!(:mobile_device?).and_return(true)
+      end
+      
+      it "should redirect to the mobile site" do
+        get :show_page, :url => @page.url
+        response.should be_redirect
+        response.should redirect_to("http://#{@host}#{@page.url}")
+      end
+      
+      describe "inisting on the standard site" do
+        before do
+          get :show_page, :url => "#{@page.url}?nomobile"
+        end
+        
+        it "should not redirect to the mobile site" do
+          response.should_not be_redirect
+        end
+
+        it "should set a nomobile session flag" do
+          session[:nomobile].should be_true
+        end
+      end
+      
+    end
+  end
+  
+end

data/spec/models/mobile_page_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page do
+  let(:page){ 
+    Page.new(:title => "Page", :slug => "page", :breadcrumb => "page", :status_id => '1')
+  }
+
+  it "should get and set a mobile? attribute" do
+    page.mobile?.should be_false
+    lambda{ page.mobile = true }.should_not raise_error
+    page.mobile.should be_true
+    page.mobile?.should be_true
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-mobile-extension
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- spanner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: An easy, flexible, cache-friendly mobile version of your site
+email: will@spanner.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- 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
+- spec/controllers/mobile_site_controller_spec.rb
+- spec/models/mobile_page_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/spanner/radiant-mobile-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mobile Extension for Radiant CMS
+test_files: 
+- spec/controllers/mobile_site_controller_spec.rb
+- spec/models/mobile_page_spec.rb
+- spec/spec_helper.rb