convert_theme 0.3.0 → 0.3.1

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.3.1 / 2009-09-27
+
+Major:
+* Display sample Ruby for how to use the named yields inserted into the layout.
+
+Minor:
+* Include sample for the automatically included <%= yield(:head) %>
+* passing target rails path into #new instead of #apply_to; which is renamed to #apply_to_target
+* More spec cleanup
+* remove script folder from expected rails apps; not required
+* minor refactoring of specs
+
 === 0.3.0 / 2009-09-27
 
 Major:

data/Manifest.txt

@@ -154,16 +154,6 @@ spec/expected/rails/bloganje/public/stylesheets/theme1.css
 spec/expected/rails/bloganje/public/stylesheets/theme2.css
 spec/expected/rails/bloganje/public/stylesheets/theme3.css
 spec/expected/rails/bloganje/public/stylesheets/theme4.css
-spec/expected/rails/bloganje/script/about
-spec/expected/rails/bloganje/script/console
-spec/expected/rails/bloganje/script/dbconsole
-spec/expected/rails/bloganje/script/destroy
-spec/expected/rails/bloganje/script/generate
-spec/expected/rails/bloganje/script/performance/benchmarker
-spec/expected/rails/bloganje/script/performance/profiler
-spec/expected/rails/bloganje/script/plugin
-spec/expected/rails/bloganje/script/runner
-spec/expected/rails/bloganje/script/server
 spec/expected/rails/bloganje/test/performance/browsing_test.rb
 spec/expected/rails/bloganje/test/test_helper.rb
 spec/expected/rails/webresourcedepot/README
@@ -224,16 +214,6 @@ spec/expected/rails/webresourcedepot/public/javascripts/effects.js
 spec/expected/rails/webresourcedepot/public/javascripts/prototype.js
 spec/expected/rails/webresourcedepot/public/robots.txt
 spec/expected/rails/webresourcedepot/public/stylesheets/all.css
-spec/expected/rails/webresourcedepot/script/about
-spec/expected/rails/webresourcedepot/script/console
-spec/expected/rails/webresourcedepot/script/dbconsole
-spec/expected/rails/webresourcedepot/script/destroy
-spec/expected/rails/webresourcedepot/script/generate
-spec/expected/rails/webresourcedepot/script/performance/benchmarker
-spec/expected/rails/webresourcedepot/script/performance/profiler
-spec/expected/rails/webresourcedepot/script/plugin
-spec/expected/rails/webresourcedepot/script/runner
-spec/expected/rails/webresourcedepot/script/server
 spec/expected/rails/webresourcedepot/test/performance/browsing_test.rb
 spec/expected/rails/webresourcedepot/test/test_helper.rb
 spec/fixtures/bloganje/README.md

data/README.rdoc

@@ -23,7 +23,7 @@ Replace some DOM content with <%= yield :some_label %> with --inside_yields:
 
     convert_theme path/to/app path/to/rails_app content_box \
       "--inside_yield=header=>#header h2" \
-      --inside_yield=sidebar=>#sidebar
+      "--inside_yield=sidebar=>#sidebar"
 
 == INSTALL:
 

data/lib/convert_theme.rb

@@ -1,19 +1,23 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require "hpricot"
-require "rubigen"
+require 'hpricot'
+require 'rubigen'
 require 'rubigen/scripts/generate'
 
 class ConvertTheme
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
   
-  attr_reader :template_root, :index_path, :rails_path, :template_type
+  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] || {}
@@ -25,13 +29,13 @@ class ConvertTheme
     setup_template_temp_path
   end
   
-  def apply_to(rails_path, options = {})
-    @rails_path = rails_path
-    @template_type = (options[:template_type] || detect_template).to_s
-
+  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
@@ -67,7 +71,10 @@ class ConvertTheme
       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 { |elm| elm.inner_html = "<%= yield(:#{name}) %>"}
+        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')
@@ -101,7 +108,7 @@ class ConvertTheme
     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_path)
+      :source => template_temp_path, :destination => rails_root)
     RubiGen::Scripts::Generate.new.run(["convert_theme"], generator_options)
   end
 
@@ -109,8 +116,8 @@ class ConvertTheme
     FileUtils.chdir(template_root, &block)
   end
   
-  def in_rails_path(&block)
-    FileUtils.chdir(rails_path, &block)
+  def in_rails_root(&block)
+    FileUtils.chdir(rails_root, &block)
   end
 
   def detect_template
@@ -122,7 +129,7 @@ class ConvertTheme
   end
   
   def detect_template_haml
-    in_rails_path do
+    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
@@ -163,4 +170,25 @@ class ConvertTheme
   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/convert_theme/cli.rb

@@ -5,7 +5,7 @@ class ConvertTheme
     def self.execute(stdout, arguments=[])
       options = {}
       options[:template_root] = arguments.shift
-      path_to_rails_app       = arguments.shift
+      options[:rails_root]    = arguments.shift
       options[:content_id]    = arguments.shift
       parser = OptionParser.new do |opts|
         opts.banner = <<-BANNER.gsub(/^          /,'')
@@ -32,10 +32,10 @@ class ConvertTheme
                 "Show this help message.") { stdout.puts opts; exit }
         opts.parse!(arguments)
       end
-      unless options[:template_root] && path_to_rails_app
+      unless options[:template_root] && options[:rails_root]
         stdout.puts parser; exit
       end
-      ConvertTheme.new(options).apply_to(path_to_rails_app)
+      ConvertTheme.new(options).apply_to_target
     end
   end
 end

data/spec/convert_theme_cli_spec.rb

@@ -6,13 +6,14 @@ describe ConvertTheme::CLI, "execute" do
     theme = stub
     ConvertTheme.should_receive(:new).
       with(:template_root => "path/to/app", 
+        :rails_root => "path/to/rails_app",
         :content_id => "content_box",
         :index_path => "root.html",
         :template_type => "haml",
         :inside_yields => { :header => '#header h2', :sidebar => '#sidebar' }
       ).
       and_return(theme)
-    theme.should_receive(:apply_to).with("path/to/rails_app")
+    theme.should_receive(:apply_to_target)
     @stdout = stdout do |stdout_io|
       ConvertTheme::CLI.execute(stdout_io, %w[path/to/app path/to/rails_app content_box
         --index_path=root.html

data/spec/convert_theme_spec.rb

@@ -6,28 +6,31 @@ describe ConvertTheme do
       setup_base_rails
       stdout do |stdout|
         @theme = ConvertTheme.new(:template_root => File.dirname(__FILE__) + "/fixtures/bloganje", 
-          :content_id => "content",
-          :inside_yields => { :header => '#header h2' },
-          :stdout => stdout)
-        @theme.apply_to(@target_application, :generator => {:collision => :force, :quiet => true})
+          :rails_root    => @target_application,
+          :content_id    => "content",
+          :inside_yields => { :header => '#header h2', :sidebar => '#sidebar' },
+          :stdout        => stdout)
       end
       @expected_application = File.dirname(__FILE__) + "/expected/rails/bloganje"
     end
-    it { @theme.should be_erb }
     it { @theme.stylesheet_dir.should == "css" }
     it { @theme.image_dir.should == "img" }
+    it { @theme.should be_erb }
     describe "becomes a Rails app with html templates" do
-      %w[app/views/layouts/application.html.erb].each do |matching_file|
-        it { File.should be_exist(File.join(@target_application, matching_file)) }
-        it { File.should be_exist(File.join(@expected_application, matching_file)) }
-        it do
-          expected = clean_file(File.join(@expected_application, matching_file))
-          actual   = File.join(@target_application, matching_file)
-          diff = `diff #{expected} #{actual}  2> /dev/null`
-          rputs diff unless diff.strip.empty?
-          diff.strip.should == ""
+      before do
+        @stdout = stdout do |stdout|
+          @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
         end
       end
+      it { File.should be_exist(File.join(@target_application, "app/views/layouts/application.html.erb")) }
+      it { File.should be_exist(File.join(@expected_application, "app/views/layouts/application.html.erb")) }
+      it "should create app/views/layouts/application.html.erb as a layout file" do
+        expected = clean_file(File.join(@expected_application, "app/views/layouts/application.html.erb"))
+        actual   = File.join(@target_application, "app/views/layouts/application.html.erb")
+        diff = `diff #{expected} #{actual}  2> /dev/null`
+        rputs diff unless diff.strip.empty?
+        diff.strip.should == ""
+      end
       
       %w[public/stylesheets/style.css
         public/stylesheets/theme.css].each do |matching_file|
@@ -41,30 +44,30 @@ describe ConvertTheme do
             diff.strip.should == ""
           end
         end
+      it { @stdout.should include("<% content_for :head do -%>\n  <script>...</script>\n<% end -%>") }
+      it { @stdout.should include("<% content_for :header do -%>\n  My eCommerce Admin area\n<% end -%>") }
     end
   end
 
   context "webresourcedepot theme to ERb" do
     before do
       setup_base_rails
-        stdout do |stdout|
+        @stdout = stdout do |stdout|
           @theme = ConvertTheme.new(
             :template_root => File.dirname(__FILE__) + "/fixtures/webresourcedepot",
-            :content_id => "center-column", :stdout => $stdout)
-          @theme.apply_to(@target_application, :generator => {:collision => :force, :quiet => true})
+            :rails_root    => @target_application,
+            :content_id    => "center-column", :stdout => stdout)
+          @theme.apply_to_target(:generator => {:collision => :force, :quiet => true})
         end
       @expected_application = File.dirname(__FILE__) + "/expected/rails/webresourcedepot"
     end
-    it { @theme.should be_erb }
     describe "becomes a Rails app" do
-      %w[app/views/layouts/application.html.erb].each do |matching_file|
-        it do
-          expected = clean_file(File.join(@expected_application, matching_file))
-          actual   = File.join(@target_application, matching_file)
-          diff = `diff #{expected} #{actual}  2> /dev/null`
-          rputs diff unless diff.strip.empty?
-          diff.strip.should == ""
-        end
+      it "should create app/views/layouts/application.html.erb as a layout file" do
+        expected = clean_file(File.join(@expected_application, "app/views/layouts/application.html.erb"))
+        actual   = File.join(@target_application, "app/views/layouts/application.html.erb")
+        diff = `diff #{expected} #{actual}  2> /dev/null`
+        rputs diff unless diff.strip.empty?
+        diff.strip.should == ""
       end
       
       %w[public/stylesheets/all.css].each do |matching_file|
@@ -81,3 +84,4 @@ describe ConvertTheme do
     end
   end
 end
+

data/spec/expected/rails/bloganje/app/views/layouts/application.html.erb

@@ -43,40 +43,7 @@
       </div>
         <div id="wrapper">
             <div id="content"><%= yield %></div>
-            <div id="sidebar">
-  				<ul>
-                	<li><h3><a href="#" class="house">Dashboard</a></h3>
-                        <ul>
-                        	<li><a href="#" class="report">Sales Report</a></li>
-                    		<li><a href="#" class="report_seo">SEO Report</a></li>
-                            <li><a href="#" class="search">Search</a></li>
-                        </ul>
-                    </li>
-                    <li><h3><a href="#" class="folder_table">Orders</a></h3>
-          				<ul>
-                        	<li><a href="#" class="addorder">New order</a></li>
-                          <li><a href="#" class="shipping">Shipments</a></li>
-                            <li><a href="#" class="invoices">Invoices</a></li>
-                        </ul>
-                    </li>
-                    <li><h3><a href="#" class="manage">Manage</a></h3>
-          				<ul>
-                            <li><a href="#" class="manage_page">Pages</a></li>
-                            <li><a href="#" class="cart">Products</a></li>
-                            <li><a href="#" class="folder">Product categories</a></li>
-            				<li><a href="#" class="promotions">Promotions</a></li>
-                        </ul>
-                    </li>
-                  <li><h3><a href="#" class="user">Users</a></h3>
-          				<ul>
-                            <li><a href="#" class="useradd">Add user</a></li>
-                            <li><a href="#" class="group">User groups</a></li>
-            				<li><a href="#" class="search">Find user</a></li>
-                            <li><a href="#" class="online">Users online</a></li>
-                        </ul>
-                    </li>
-				</ul>       
-          </div>
+            <div id="sidebar"><%= yield(:sidebar) %></div>
       </div>
         <div id="footer">
         <div id="credits">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: convert_theme
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -237,16 +237,6 @@ files:
 - spec/expected/rails/bloganje/public/stylesheets/theme2.css
 - spec/expected/rails/bloganje/public/stylesheets/theme3.css
 - spec/expected/rails/bloganje/public/stylesheets/theme4.css
-- spec/expected/rails/bloganje/script/about
-- spec/expected/rails/bloganje/script/console
-- spec/expected/rails/bloganje/script/dbconsole
-- spec/expected/rails/bloganje/script/destroy
-- spec/expected/rails/bloganje/script/generate
-- spec/expected/rails/bloganje/script/performance/benchmarker
-- spec/expected/rails/bloganje/script/performance/profiler
-- spec/expected/rails/bloganje/script/plugin
-- spec/expected/rails/bloganje/script/runner
-- spec/expected/rails/bloganje/script/server
 - spec/expected/rails/bloganje/test/performance/browsing_test.rb
 - spec/expected/rails/bloganje/test/test_helper.rb
 - spec/expected/rails/webresourcedepot/README
@@ -307,16 +297,6 @@ files:
 - spec/expected/rails/webresourcedepot/public/javascripts/prototype.js
 - spec/expected/rails/webresourcedepot/public/robots.txt
 - spec/expected/rails/webresourcedepot/public/stylesheets/all.css
-- spec/expected/rails/webresourcedepot/script/about
-- spec/expected/rails/webresourcedepot/script/console
-- spec/expected/rails/webresourcedepot/script/dbconsole
-- spec/expected/rails/webresourcedepot/script/destroy
-- spec/expected/rails/webresourcedepot/script/generate
-- spec/expected/rails/webresourcedepot/script/performance/benchmarker
-- spec/expected/rails/webresourcedepot/script/performance/profiler
-- spec/expected/rails/webresourcedepot/script/plugin
-- spec/expected/rails/webresourcedepot/script/runner
-- spec/expected/rails/webresourcedepot/script/server
 - spec/expected/rails/webresourcedepot/test/performance/browsing_test.rb
 - spec/expected/rails/webresourcedepot/test/test_helper.rb
 - spec/fixtures/bloganje/README.md

data/spec/expected/rails/bloganje/script/about

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
-require 'commands/about'

data/spec/expected/rails/bloganje/script/console

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/console'

data/spec/expected/rails/bloganje/script/dbconsole

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/dbconsole'

data/spec/expected/rails/bloganje/script/destroy

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/destroy'

data/spec/expected/rails/bloganje/script/generate

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/generate'

data/spec/expected/rails/bloganje/script/performance/benchmarker

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../../config/boot',  __FILE__)
-require 'commands/performance/benchmarker'

data/spec/expected/rails/bloganje/script/performance/profiler

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../../config/boot',  __FILE__)
-require 'commands/performance/profiler'

data/spec/expected/rails/bloganje/script/plugin

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/plugin'

data/spec/expected/rails/bloganje/script/runner

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/runner'

data/spec/expected/rails/bloganje/script/server

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/server'

data/spec/expected/rails/webresourcedepot/script/about

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-$LOAD_PATH.unshift "#{RAILTIES_PATH}/builtin/rails_info"
-require 'commands/about'

data/spec/expected/rails/webresourcedepot/script/console

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/console'

data/spec/expected/rails/webresourcedepot/script/dbconsole

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/dbconsole'

data/spec/expected/rails/webresourcedepot/script/destroy

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/destroy'

data/spec/expected/rails/webresourcedepot/script/generate

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/generate'

data/spec/expected/rails/webresourcedepot/script/performance/benchmarker

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../../config/boot',  __FILE__)
-require 'commands/performance/benchmarker'

data/spec/expected/rails/webresourcedepot/script/performance/profiler

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../../config/boot',  __FILE__)
-require 'commands/performance/profiler'

data/spec/expected/rails/webresourcedepot/script/plugin

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/plugin'

data/spec/expected/rails/webresourcedepot/script/runner

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/runner'

data/spec/expected/rails/webresourcedepot/script/server

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/server'