bcms_mobile 1.0.0

data/lib/bcms_mobile.rb

@@ -0,0 +1,3 @@
+require 'bcms_mobile/engine'
+require 'bcms_mobile/routes'
+

data/lib/bcms_mobile/engine.rb

@@ -0,0 +1,68 @@
+require 'browsercms'
+require 'mobylette'
+require 'bcms_mobile/mobile_aware'
+
+module BcmsMobile
+  class Engine < Rails::Engine
+    include Cms::Module
+    config.to_prepare do
+
+      ApplicationHelper.class_eval do
+        include BcmsMobile::MobileHelpers
+      end
+
+      Cms::ContentController.class_eval do
+        include BcmsMobile::MobileAware
+
+        #before_filter :print_request_info
+        before_filter :configure_cache_directory
+
+        def print_request_info
+          w "*" * 20
+          w "User Agent: #{request.user_agent}"
+          m = "Mobile Request?: "
+          if respond_as_mobile?
+            m += "Yes"
+          else
+            m += "No"
+          end
+          w m
+        end
+
+        def configure_cache_directory
+          if respond_as_mobile?
+            self.class.page_cache_directory = mobile_cache_directory
+          else
+            self.class.page_cache_directory = cms_cache_directory
+          end
+        end
+
+        # Because of caching, CMS pages should only return mobile content on a separate subdomain.
+        # or if a CMS editor wants to see the mobile version of the page.
+        def respond_as_mobile?
+          w "Checking the subdomain for #{request.domain} is #{request.subdomain}"
+          if params[:template] =='mobile'
+            session[:mobile_mode] = true
+          elsif params[:template] =='full'
+            session[:mobile_mode] = false
+          end
+
+          request.subdomain == "m" || (session[:mobile_mode] == true && current_user.able_to?(:edit_content))
+        end
+
+        private
+        # Overrides core behavior to swap layouts based on whether this is a mobile request or not.
+        def render_page
+          @_page_route.execute(self) if @_page_route
+          prepare_connectables_for_render
+          template = determine_page_template
+          render :layout => template, :action => 'show'
+        end
+
+
+      end
+    end
+
+
+  end
+end

data/lib/bcms_mobile/mobile_aware.rb

@@ -0,0 +1,69 @@
+module BcmsMobile
+
+  module MobileHelpers
+
+    def full_site_url
+      url_for(:host=>SITE_DOMAIN, :prefer_full_site=>true)
+    end
+
+    def mobile_site_url
+      url_for(:host=>SITE_DOMAIN, :prefer_mobile_site=>true)
+    end
+
+
+  end
+
+  module MobileAware
+
+    def w(m)
+      logger.warn m
+    end
+
+    def banner(m)
+      w "*" * 20
+      w m
+    end
+
+    # Returns the directory where BrowserCMS should write out it's Page cache files for the mobile version of the site.
+    # (Optionally) It can be configured in environment files via:
+    #   config.bcms_mobile_cache_directory = File.join(Rails.root, 'some', 'mobile_dir')
+    def mobile_cache_directory
+      configured_dir = Rails.application.config.bcms_mobile_cache_directory
+      configured_dir ? configured_dir : default_mobile_cache_directory
+    end
+
+    # Returns the directory where BrowserCMS should write out it's Page cache files for the full version of the site.
+    # This should be exactly the same as where a typical CMS project stores it's files.
+    # (Optionally) It can be configured in environment files via:
+    #   config.browsercms_cache_directory = File.join(Rails.root, 'some', 'dir')
+    def cms_cache_directory
+      configured_dir = Rails.application.config.browsercms_cache_directory
+      configured_dir ? configured_dir : default_browsercms_cache_directory
+    end
+
+    # Looks for a mobile template if the request is mobile, falling back to the html template if it can't be found.
+    def determine_page_template
+      layout = @page.layout
+      layout_name = @page.template_file_name
+
+      if respond_as_mobile?
+        w "Does html layout exist?:#{template_exists?(layout_name, "layouts/templates")}"
+        mobile_exists = template_exists?(layout_name, "layouts/mobile")
+        w "Does mobile layout exist?:#{mobile_exists}"
+        layout = "mobile/#{layout_name}" if mobile_exists
+      end
+      w "layout = #{layout}"
+      layout
+    end
+
+    private
+    def default_browsercms_cache_directory
+      File.join(Rails.root, 'public', 'cache')
+    end
+
+    def default_mobile_cache_directory
+      File.join(Rails.root, 'public', 'mobile_cache')
+    end
+  end
+
+end

data/lib/bcms_mobile/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_mobile
+    namespace(:cms) do
+      #content_blocks :bcms_mobiles
+    end
+  end
+end

data/lib/bcms_mobile/version.rb

@@ -0,0 +1,3 @@
+module BcmsMobile
+  VERSION = "1.0.0"
+end

data/lib/generators/bcms_mobile/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs the bcms_mobile module.
+
+Example:
+    rails generate bcms_mobile:install
+
+    This will:
+		1. Copy any migrations from the gem into the project.
+		2. Add the routes to the config/routes.rb
+

data/lib/generators/bcms_mobile/install/install_generator.rb

@@ -0,0 +1,12 @@
+require 'cms/module_installation'
+
+class BcmsMobile::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+
+  # Add migrations to be copied, by uncommenting the following file and editing as needed.
+  # copy_migration_file 'DATESTAMP_create_name_of_content_block.rb'
+
+  def make_mobile_templates_directory
+    empty_directory 'app/views/layouts/mobile'
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: bcms_mobile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mobylette
+  requirement: &70342244972020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342244972020
+- !ruby/object:Gem::Dependency
+  name: browsercms
+  requirement: &70342244966100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342244966100
+description: 
+email: github@browsermedia.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- app/views/bcms_mobile/_mobile_toggle.html.erb
+- app/views/layouts/_page_toolbar.html.erb
+- db/migrate/20100117144039_browsercms315.rb
+- lib/bcms_mobile/engine.rb
+- lib/bcms_mobile/mobile_aware.rb
+- lib/bcms_mobile/routes.rb
+- lib/bcms_mobile/version.rb
+- lib/bcms_mobile.rb
+- lib/generators/bcms_mobile/install/install_generator.rb
+- lib/generators/bcms_mobile/install/USAGE
+- LICENSE.txt
+- GPL.txt
+- Gemfile
+- Copyright.txt
+- README.markdown
+homepage: http://www.github.com/browsermedia/bcms_mobile
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1881617308010632469
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1881617308010632469
+requirements: []
+rubyforge_project: bcms_mobile
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Bcms Mobile Module for BrowserCMS
+test_files: []