theme_park 0.1.0.beta

data/lib/theme_park/rails/action_controller.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module ThemePark
+
+  # For rails, we need to resolve the handlers.
+  def self.resolve_views_path(name)
+    views_path = self.views_path(name)
+    if ThemePark.handlers.to_s != 'all'
+      handers = ThemePark.handlers.to_a.join(',')
+      ActionView::FileSystemResolver.new(views_path, ":prefix/:action{.:locale,}{.:formats,}{.{#{handers}},}")
+    else
+      views_path
+    end
+  end
+
+  module Rails
+    module ActionController
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Example:
+        # ===
+        # class MyController < ApplicationController
+        #   theme "dark", :only => :index
+        # end
+        # ===
+        def theme(name, options = {})
+          path = ThemePark.resolve_views_path(name)
+          before_filter(options) do |controller|
+            @current_theme = name
+            controller.prepend_view_path path
+          end
+        end
+
+      end
+
+      private
+      # Example:
+      # ===
+      # class MyController < ApplicationController
+      #   def index
+      #     theme 'dark'
+      #   end
+      # end
+      # ===
+      def theme(name)
+        @current_theme = name
+        path           = ThemePark.resolve_views_path(name)
+        prepend_view_path path
+      end
+      
+    end
+  end
+end

data/lib/theme_park/rails/asset_tag_helper.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+module ThemePark
+  module Rails
+    module AssetTagHelper
+      extend ActiveSupport::Concern
+
+      # if theme option is nil, it will use current_theme.
+      # ===
+      # Usage:
+      #   theme_stylesheet_link_tag application, :theme => 'dark'
+      # 
+      def theme_stylesheet_link_tag(*sources)
+        options = sources.extract_options!
+        theme   = options.delete(:theme) || current_theme
+        if serve_theme_compiled?
+          sources.collect do |source|
+            stylesheet_link_tag theme_compiled_path(source, theme)
+          end.join("\n").html_safe
+        else
+          stylesheet_link_tag(*sources)
+        end
+      end
+
+      def theme_javascript_include_tag(*sources)
+        options = sources.extract_options!
+        theme   = options.delete(:theme) || current_theme
+        if serve_theme_compiled?
+          sources.collect do |source|
+            javascript_include_tag theme_compiled_path(source, theme)
+          end.join("\n").html_safe
+        else
+          javascript_include_tag(*sources)
+        end
+      end
+
+      def theme_image_tag(source, options = {})
+        theme = options.delete(:theme) || current_theme
+        if serve_theme_compiled?
+          image_tag(theme_compiled_path(source, theme), options)
+        else
+          image_tag(source, options)
+        end
+      end
+
+      # Get the right path to theme compiled directory.
+      def theme_compiled_path(source, theme = nil)
+        theme = theme || current_theme
+        "/#{ThemePark.prefix}/#{theme}/#{source}"
+      end
+
+      # sprocket assets pipeline enabled or not.
+      def assets_enabled?
+        ::Rails.application.config.assets.enabled
+      end
+
+      # serve static assets or not.
+      def serve_static_assets?
+        ::Rails.application.config.serve_static_assets
+      end
+
+      # use sprockets or not.
+      def assets_digest?
+        ::Rails.application.config.assets.digest
+      end
+
+      # Decide to serve static files under theme compiled directory or not.
+      def serve_theme_compiled?
+        serve_static_assets? and assets_digest?
+      end
+
+      # In some use case, you may need to override this method.
+      def current_theme
+        @current_theme
+      end
+
+    end
+  end
+end

data/lib/theme_park/rails/server.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'action_dispatch/middleware/static'
+
+module ThemePark
+  module Rails
+    class Server < ThemePark::Server
+
+      # Only for Rails application.
+      def call(env)
+        path        = env['PATH_INFO'].chomp('/')
+        theme_name  = env['action_dispatch.request.path_parameters'][:theme_name]
+        lookup_path = ThemePark.compiled_path(theme_name)
+        if File.file?( File.join(lookup_path, path) )
+          ActionDispatch::Static.new(@app, lookup_path, @cache_control).call(env)
+        else
+          # Need return 404
+          fail(404, "File not found: #{path}")
+        end
+      end
+
+      private
+
+      # Copy form ::Rack::File#fail
+      def fail(status, body)
+        body += "\n"
+        [
+          status,
+          {
+            "Content-Type" => "text/plain",
+            "Content-Length" => body.size.to_s,
+            "X-Cascade" => "pass"
+          },
+          [body]
+        ]
+      end
+    end
+  end
+end

data/lib/theme_park/railtie.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+module ThemePark
+  class Railtie < ::Rails::Railtie
+    
+    rake_tasks do
+      load "tasks/theme_park.rake"
+    end
+
+    generators do
+      require "generators/theme_park/install_generator"
+      require "generators/theme_park/create_generator"
+    end
+
+    initializer "ThemePark.environment", :group => :all do |app|
+
+      config = app.config
+      
+      config.theme_park = ThemePark.setup do |config|
+        config.base = ::Rails.root
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include ThemePark::Rails::AssetTagHelper
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        include ThemePark::Rails::ActionController
+      end
+
+      config.to_prepare do
+        # append assets path if enabled
+        if config.assets.enabled
+          ThemePark.assets_path.each do |path|
+            config.assets.paths << path
+          end
+        end
+      end #config.to_prepare
+
+      config.after_initialize do |app|
+        # If rails's static asset server is disabled.
+        # We will not mount routes
+        if config.serve_static_assets
+          app.routes.prepend do
+            mount ThemePark::Rails::Server.new(app, config.static_cache_control) => "#{ThemePark.prefix}/:theme_name"
+          end
+        end
+      end #config.after_initialize
+
+    end #initializer
+
+  end #Railtie
+end #ThemePark

data/lib/theme_park/server.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'rack/utils'
+
+module ThemePark
+  # This is a rack middleware handles static file request.
+  # For generic rack application.
+  # The theme url may like this: {ThemePark.prefix}/{theme_name}/{resource_name}
+  # Example:
+  # /themes/default/application.js
+  class Server
+    
+    def initialize(app, cache_control = nil)
+      @app = app
+      @cache_control = cache_control
+    end
+
+    def call(env)
+      request    = Rack::Request.new(env)
+      theme_name = request.params['theme_name']
+      path       = ThemePark.compiled_path(theme_name)
+      ::Rack::File.new(path, @cache_control)
+    end
+
+  end
+end

data/lib/theme_park/version.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+module ThemePark
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = "beta"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.