install_theme 0.4.0

data/bin/install_theme

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-9-26.
+#  Copyright (c) 2009. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/install_theme")
+require "install_theme/cli"
+
+InstallTheme::CLI.execute(STDOUT, ARGV)

data/lib/install_theme.rb

@@ -0,0 +1,194 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'hpricot'
+require 'rubigen'
+require 'rubigen/scripts/generate'
+
+class InstallTheme
+  VERSION = "0.4.0"
+  
+  attr_reader :template_root, :rails_root, :index_path, :template_type
+  attr_reader :stylesheet_dir, :javascript_dir, :image_dir
+  attr_reader :content_id, :inside_yields
+  attr_reader :stdout
+  attr_reader :inside_yields_originals
+  
+  def initialize(options = {})
+    @template_root  = File.expand_path(options[:template_root] || File.dirname('.'))
+    @rails_root     = File.expand_path(options[:rails_root] || File.dirname('.'))
+    @template_type  = (options[:template_type] || detect_template).to_s
+    @index_path     = options[:index_path] || "index.html"
+    @content_id     = options[:content_id] || "content"
+    @inside_yields  = options[:inside_yields] || {}
+    @stylesheet_dir = options[:stylesheet_dir] || detect_stylesheet_dir
+    @javascript_dir = options[:javascript_dir] || detect_javascript_dir
+    @image_dir      = options[:image_dir] || detect_image_dir
+    @stdout         = options[:stdout] || $stdout
+    
+    setup_template_temp_path
+  end
+  
+  def apply_to_target(options = {})
+    @stdout = options[:stdout] || @stdout || $stdout
+    @inside_yields_originals = {}
+    convert_file_to_layout(index_path, 'app/views/layouts/application.html.erb')
+    prepare_assets
+    run_generator(options)
+    show_readme
+  end
+  
+  # This generator's templates folder is temporary
+  # and is accessed via source_root within the generator.
+  def template_temp_path
+    @template_temp_path ||= begin
+      tmp_dir = ENV['TMPDIR'] || '/tmp'
+      template_path = File.join(tmp_dir, "install_theme", "templates")
+    end
+  end
+  
+  def setup_template_temp_path
+    FileUtils.rm_rf(template_temp_path)
+    FileUtils.mkdir_p(template_temp_path)
+    %w[app/views/layouts public/images public/javascripts public/stylesheets].each do |app_path|
+      FileUtils.mkdir_p(File.join(template_temp_path, app_path))
+    end
+  end
+  
+  def haml?
+    template_type == 'haml'
+  end
+  
+  def erb?
+    template_type == 'erb'
+  end
+  
+  protected
+  
+  def convert_file_to_layout(html_path, layout_path)
+    File.open(File.join(template_temp_path, layout_path), "w") do |file|
+      index_file = File.read(File.join(template_root, html_path)).gsub(/\r/, '')
+      doc = Hpricot(index_file)
+      doc.search("##{content_id}").each { |elm| elm.inner_html = "<%= yield %>" }
+      inside_yields.to_a.each do |name, css_path|
+        doc.search(css_path).each do |elm|
+          inside_yields_originals[name] = elm.inner_html.strip
+          elm.inner_html = "<%= yield(:#{name}) %>"
+        end
+      end
+      contents = doc.to_html
+      contents.gsub!(%r{(["'])/?#{image_dir}}, '\1/images')
+      contents.gsub!(%r{(["'])/?#{stylesheet_dir}}, '\1/stylesheets')
+      contents.gsub!(%r{(["'])/?#{javascript_dir}}, '\1/javascripts')
+      contents.sub!(%r{\s*</head>}, "\n  <%= yield(:head) %>\n</head>")
+      file << contents
+    end
+  end
+
+  def prepare_assets
+    template_stylesheets.each do |file|
+      File.open(File.join(template_temp_path, 'public/stylesheets', File.basename(file)), "w") do |f|
+        contents = File.read(file)
+        contents.gsub!(%r{url\((["']?)[./]*#{image_dir}}, 'url(\1/images')
+        f << contents
+      end
+    end
+    template_javascripts.each do |file|
+      FileUtils.cp_r(file, File.join(template_temp_path, 'public/javascripts'))
+    end
+    template_images.each do |file|
+      FileUtils.cp_r(file, File.join(template_temp_path, 'public/images'))
+    end
+  end
+  
+  def run_generator(options)
+    # now use rubigen to install the files into the rails app
+    # so users can get conflict resolution options from command line
+    RubiGen::Base.reset_sources
+    RubiGen::Base.prepend_sources(RubiGen::PathSource.new(:internal, File.dirname(__FILE__)))
+    generator_options = options[:generator] || {}
+    generator_options.merge!(:stdout => @stdout, :no_exit => true,
+      :source => template_temp_path, :destination => rails_root)
+    RubiGen::Scripts::Generate.new.run(["install_theme"], generator_options)
+  end
+
+  def in_template_root(&block)
+    FileUtils.chdir(template_root, &block)
+  end
+  
+  def in_rails_root(&block)
+    FileUtils.chdir(rails_root, &block)
+  end
+
+  def detect_template
+    if detect_template_haml
+      'haml'
+    else
+      'erb'
+    end
+  end
+  
+  def detect_template_haml
+    in_rails_root do
+      return true if File.exist?('vendor/plugins/haml')
+      return true if File.exist?('config/environment.rb') && File.read('config/environment.rb') =~ /haml/
+    end
+  end
+  
+  def detect_stylesheet_dir
+    if path = Dir[File.join(template_root, '**/*.css')].first
+      File.dirname(path).gsub(template_root, '').gsub(%r{^/}, '')
+    else
+      'stylescheets'
+    end
+  end
+  
+  def detect_javascript_dir
+    if path = Dir[File.join(template_root, '**/*.js')].first
+      File.dirname(path).gsub(template_root, '').gsub(%r{^/}, '')
+    else
+      'javascripts'
+    end
+  end
+  
+  def detect_image_dir
+    if path = Dir[File.join(template_root, '**/*.{jpg,png,gif}')].first
+      File.dirname(path).gsub(template_root, '').gsub(%r{^/}, '')
+    else
+      'images'
+    end
+  end
+  
+  def template_stylesheets
+    Dir[File.join(template_root, stylesheet_dir, '*')]
+  end
+  
+  def template_javascripts
+    Dir[File.join(template_root, javascript_dir, '*')]
+  end
+
+  def template_images
+    Dir[File.join(template_root, image_dir, '*')]
+  end
+  
+  def show_readme
+    stdout.puts <<-README
+    
+    Your theme has been installed into your app.
+    
+    README
+    stdout.puts "You are using named yields. Here are examples how to use them: "
+    stdout.puts <<-EOS.gsub(/^    /, '')
+    <% content_for :head do -%>
+      <script>...</script>
+    <% end -%>
+    EOS
+    inside_yields_originals.to_a.each do |key, original_contents|
+      stdout.puts <<-EOS.gsub(/^      /, '')
+      <% content_for :#{key} do -%>
+        #{original_contents}
+      <% end -%>
+      EOS
+    end
+  end
+end

data/lib/install_theme/cli.rb

@@ -0,0 +1,41 @@
+require 'optparse'
+
+class InstallTheme
+  class CLI
+    def self.execute(stdout, arguments=[])
+      options = {}
+      options[:template_root] = arguments.shift
+      options[:rails_root]    = arguments.shift
+      options[:content_id]    = arguments.shift
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          Use any HTML template as a theme generator for your Rails app.
+
+          Usage: #{File.basename($0)} path/to/template path/to/rails_app content_id [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+        opts.on("--haml",
+                "Generate HAML templates.") { |arg| options[:template_type] = 'haml' }
+        opts.on("--index_path=index.html", String,
+                "HTML page to use for application layout.",
+                "Default: index.html") { |arg| options[:index_path] = arg }
+        opts.on("--inside_yield=KEY_AND_CSS_PATH", String,
+                "Replace the inner HTML of an element with <%= yield :key %>",
+                "Default: nil") do |arg|
+                  options[:inside_yields] ||= {}
+                  key, css_path = arg.split(/\s*=>\s*/)[0..1]
+                  options[:inside_yields][key.strip.to_sym] = css_path.strip
+                end
+        opts.on("-h", "--help",
+                "Show this help message.") { stdout.puts opts; exit }
+        opts.parse!(arguments)
+      end
+      unless options[:template_root] && options[:rails_root]
+        stdout.puts parser; exit
+      end
+      InstallTheme.new(options).apply_to_target
+    end
+  end
+end

data/lib/install_theme/install_theme_generator.rb

@@ -0,0 +1,20 @@
+class InstallTheme::InstallThemeGenerator < RubiGen::Base
+  # NOTE: runtime_options[:source] needs to be passed in to #new
+  
+  def manifest
+    record do |m|
+      files = Dir[File.join(source_root, "**/*")].map do |f|
+        f.gsub(source_root, "").gsub(%r{^/}, '')
+      end
+      directories = files.map { |f| File.dirname(f) }.uniq.sort
+      directories.each do |dir|
+        m.directory dir
+      end
+      files.sort.each do |f|
+        next if File.directory?(File.join(source_root, f))
+        m.file f, f
+      end
+    end
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/install_theme.rb'}"
+puts "Loading install_theme gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/expected/rails/README.md

@@ -0,0 +1 @@
+Using rails version 2.3.4 to generate the base of these expected apps

data/spec/expected/rails/base_app/README

@@ -0,0 +1,243 @@
+== 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, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== 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/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) 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 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(: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 you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that 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 enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+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.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/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>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+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.
+  Most models will descend from ActiveRecord::Base.
+
+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.
+
+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 script/generate 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. Contains subdirectories for images, stylesheets,
+  and javascripts. 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 script/generate scripts, 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.