theme_park 0.1.0.beta

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Thierry Zires
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+## theme_park
+
+theme_park is a flexible multiple theme plugin for rails3, sinatra, and more...it's rack based
+
+### Getting started (Rails.version > 3.1)
+
+Add it to your Gemfile.
+
+```console
+gem 'theme_park'
+```
+
+Install it use bundler command.
+
+```console
+bundle install
+```
+
+You can create a initializer file.
+
+```console
+rails generate theme_park:install
+```
+
+Now, let's create our first theme.
+
+```console
+rails generate theme_park:create dark
+```
+
+It will create the theme dir under the theme_park root path.
+
+```
+app/
+- themes
+  - [theme_name]
+    |- assets
+      |- images
+      |- javascripts
+      |- stylesheets
+      |- compiled           -> Compiled static files
+    |- views
+      |- layouts
+```
+
+Use this theme in controller.
+
+```ruby
+class MyController < ApplicationController
+  theme "dark", :only => :index
+end
+```
+
+```ruby
+class MyController < ApplicationController
+  def index
+    theme 'dark'
+  end
+end
+```
+
+Like rails3.1 need precompile asset files in the production environment, we also need precompile theme asset files.
+
+```console
+rake theme_park:precompile theme=dark
+```
+
+or precompile all themes
+
+```console
+rake theme_park:precompile
+```
+
+### Configuration
+
+See theme_park initializer file for more details.
+
+```
+config.root             = '/themes'
+config.handlers         = :all           # will load all handlers depends on your application.
+# other options for handlers
+# config.handlers       = [:liquid]      # only load .liquid
+# config.handlers       = [:erb, :haml]  # only load .erb and .haml
+config.prefix           = 'themes'
+config.images_path      = ':root/:name/assets/images'
+config.javascripts_path = ':root/:name/assets/javascripts'
+config.stylesheets_path = ':root/:name/assets/stylesheets'
+config.compiled_path    = ':root/:name/assets/compiled'
+config.views_path       = ':root/:name/views'
+```
+
+### Contributing to theme_park
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2012 Thierry Zires. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/generators/templates/application.css

@@ -0,0 +1,5 @@
+/*
+ *
+ *= require_self
+ *= require_tree .
+*/

data/lib/generators/templates/application.js

@@ -0,0 +1,3 @@
+//
+//
+//= require_tree .

data/lib/generators/templates/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title></title>
+  <%#= stylesheet_link_tag    "application", :media => "all" %>
+  <%#= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/lib/generators/templates/theme_park.rb

@@ -0,0 +1,31 @@
+# Convention over configuration.
+# 
+# app/
+# - themes
+#   - [theme_name]
+#     |- assets
+#        |- images
+#        |- javascripts
+#        |- stylesheets
+#        |- compiled           -> Compiled static files
+#     |- views
+#        |- layouts
+#
+# Uncomment below lines if you really need to.
+# ===
+# ThemePark.setup do |config|
+#   
+#   config.root             = '/themes'
+#   config.handlers         = :all           # will load all handlers depends on your application.
+#   # other options for handlers
+#   # config.handlers       = [:liquid]      # only load .liquid
+#   # config.handlers       = [:erb, :haml]  # only load .erb and .haml
+#   config.prefix           = 'themes'
+#   config.images_path      = ':root/:name/assets/images'
+#   config.javascripts_path = ':root/:name/assets/javascripts'
+#   config.stylesheets_path = ':root/:name/assets/stylesheets'
+#   config.compiled_path    = ':root/:name/assets/compiled'
+#   config.views_path       = ':root/:name/views'
+
+# end
+# ===

data/lib/generators/theme_park/create_generator.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require 'fileutils'
+
+module ThemePark
+  module Generators
+    class CreateGenerator < ::Rails::Generators::Base
+      # Create a new theme under theme_park root path.
+      source_root File.expand_path("../../templates", __FILE__)
+      argument :name, :type => :string
+
+      #class_option :force, :type => :boolean, :default => false, :alias => :f, :description => "Will cover exist files."
+
+      desc "Create an empty theme under theme_park root path."
+      def create_theme
+        ThemePark.theme_assets_path(name).each do |path|
+          FileUtils.mkdir_p path
+        end
+        FileUtils.mkdir_p ThemePark.views_path(name)
+        FileUtils.mkdir_p ThemePark.compiled_path(name)
+
+        copy_file "application.css", File.join( ThemePark.stylesheets_path(name), "#{name}.css" )
+        copy_file "application.js",  File.join( ThemePark.javascripts_path(name), "#{name}.js" )
+        directory "layouts",         File.join( ThemePark.views_path(name), "layouts" )
+      end
+
+    end
+  end
+end

data/lib/generators/theme_park/install_generator.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module ThemePark
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      # Create theme_park.rb under config/initializers/
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a ThemePark initializer file."
+      def copy_initializer
+        template "theme_park.rb", "config/initializers/theme_park.rb"
+      end
+
+    end
+  end
+end
+  

data/lib/tasks/theme_park.rake

@@ -0,0 +1,33 @@
+# Precompile your asset source file in compiled folder.
+# Usage:
+#   rake theme_park:precompile theme=dark
+# if theme_name not given, it will precompile all themes.
+namespace :theme_park do
+  
+  desc "Precompile your asset source file in compiled folder"
+  task :precompile => :environment do
+    
+    unless ::Rails.application.config.assets.enabled
+      warn "Cannot precompile assets if sprockets is disabled. Please set config.assets.enabled to true"
+      exit
+    end
+
+    theme    = ENV["theme"]
+    env      = ::Rails.application.assets
+
+    themes = if theme
+      [ theme ]
+    else
+      Dir.glob( File.join(ThemePark.base_root, "*") ).map{ |path| File.basename(path) }
+    end
+    
+    themes.each do |name|
+      target   = ThemePark.compiled_path(name)
+      paths    = [/(?:\/|\\|\A)#{name}\.(css|js)$/]
+      compiler = Sprockets::StaticCompiler.new(env, target, paths)
+      compiler.compile
+    end 
+
+  end
+
+end

data/lib/theme_park.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+require 'active_support/core_ext/module/delegation'
+# 
+# convention over configuration.
+#
+# Rails application example:
+# app/
+# - themes
+#   - [theme_name]
+#     |- assets
+#        |- images
+#        |- javascripts
+#        |- stylesheets
+#        |- compiled           -> Compiled static files
+#     |- views
+#        |- layouts
+#   
+module ThemePark
+  autoload :Configuration, 'theme_park/configuration'
+  autoload :Version,       'theme_park/version'
+  autoload :Server,        'theme_park/server'
+
+  module Rails
+    autoload :ActionController, 'theme_park/rails/action_controller'
+    autoload :AssetTagHelper,   'theme_park/rails/asset_tag_helper'
+    autoload :Server,           'theme_park/rails/server'
+  end
+
+  # Setup and return itself.
+  def self.setup
+    yield config if block_given?
+    self
+  end
+
+  class << self
+
+    delegate :base, :root, :base_root, :prefix, :handlers, :to => :config
+
+    def config
+      @@config ||= ThemePark::Configuration.new
+    end
+
+    def version
+      ThemePark::Version::STRING
+    end
+
+    # Return the path of given theme name.
+    def path(theme_name)
+      File.join base_root, theme_name
+    end
+
+    def exist?(theme_name)
+      Dir.exist? path(theme_name)
+    end
+
+    def interpolate(pattern, theme_name)
+      pattern.gsub(":root", base_root).gsub(":name", theme_name.to_s)
+    end
+    
+    ##
+    # :method: images_path
+    #
+    # :call-seq: images_path(theme_name)
+    #
+    # Return images path for the theme name
+
+    ##
+    # :method: javascripts_path
+    #
+    # :call-seq: javascripts_path(theme_name)
+    #
+    # Return javascripts path for the theme name
+
+    ##
+    # :method: stylesheets_path
+    #
+    # :call-seq: stylesheets_path(theme_name)
+    #
+    # Return stylesheets path for the theme name
+
+    ##
+    # :method: compiled_path
+    #
+    # :call-seq: compiled_path(theme_name)
+    #
+    # Return compiled file path for the theme name
+
+    ##
+    # :method: views_path
+    #
+    # :call-seq: views_path(theme_name)
+    #
+    # Return views path for the theme name
+
+    [ :images, :javascripts, :stylesheets, :compiled, :views ].each do |dir|
+      class_eval <<-DIR_EVAL, __FILE__, __LINE__ + 1
+        
+        def #{dir}_path(theme_name) 
+          pattern = config.send :#{dir}_path
+          interpolate(pattern, theme_name)
+        end
+
+      DIR_EVAL
+    end
+
+    # The theme assets path is a array contains images, javascripts and stylesheets path.
+    def theme_assets_path(theme_name)
+      [ images_path(theme_name), javascripts_path(theme_name), stylesheets_path(theme_name) ]
+    end
+
+    # The assets path contains all themes' images, javascripts and stylesheets path.
+    def assets_path
+      Dir.glob( File.join(self.base_root, "*") ).map do |theme_name|
+        theme_name = File.basename(theme_name)
+        theme_assets_path(theme_name)
+      end.flatten
+    end
+
+  end
+
+end
+
+require 'theme_park/railtie' if defined?(Rails)

data/lib/theme_park/configuration.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+module ThemePark
+  
+  class Configuration
+    
+    # It is the base path for putting themes folder.
+    # For example in rails application is:
+    # === 
+    # Rails.root
+    attr_accessor :base
+
+    # It is the root path for putting each theme folder.
+    # usual is:
+    # ===
+    # /themes
+    attr_accessor :root
+
+    # The prefix is used to mount route.
+    attr_accessor :prefix
+
+    # The place contains images, javascripts, stylesheets, compiled files and view files.
+    attr_accessor :images_path, :javascripts_path, :stylesheets_path, :compiled_path, :views_path
+
+    # Handlers.
+    # In some scenes, we may want only one or several handlers.
+    attr_accessor :handlers
+
+    def initialize
+      # Default settings
+      @base             = ''
+      @handlers         = :all
+      @root             = '/themes'
+      @prefix           = 'themes'
+      @images_path      = ':root/:name/assets/images'
+      @javascripts_path = ':root/:name/assets/javascripts'
+      @stylesheets_path = ':root/:name/assets/stylesheets'
+      @compiled_path    = ':root/:name/assets/compiled'
+      @views_path       = ':root/:name/views'
+    end
+
+    def base_root
+      File.join(base, root).chomp('/')
+    end
+
+  end
+
+end