install_theme 0.6.2 → 0.7.0

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.7.0 / 2009-10-07
+
+Major:
+* Reversed the order of the first two CLI arguments (in preparation for path/to/template to be optional)
+* content_path and --partial flags are optional after a template is installed once
+
+Minor:
+* README describes how Theme Reuse works
+* CLI shows help/error message if content_path isn't passed as argument or available from defaults file
+* improved the clean_stylesheet helper and fixed the corresponding test
+* if stylesheet path is root of template folder, then use image path for path substitutions
+
 === 0.6.2 / 2009-10-06
 
 Major:

data/README.rdoc

@@ -18,14 +18,20 @@ in action.
 
 Simple case:
 
-    install_theme path/to/template path/to/rails_app content_path
+    install_theme path/to/rails_app path/to/template content_path
 
 Replace some DOM content with <%= yield :some_label %> with --partial:
 
-    install_theme path/to/app path/to/rails_app #content_box \
+    install_theme path/to/rails_app path/to/template #content_box \
       --partial "header:#header h2" \
       --partial sidebar:#sidebar"
 
+NOTE: The order of the first two arguments has been reversed since the original
+public release. This is in preparation for path/to/template to be optional.
+
+Similarly, in 0.7.0 the content_path argument is optional after the first time
+you install a specific theme (see 'Theme Reuse' section).
+
 === Haml Support:
 
 If your application has Haml installed, the template/theme is automatically converted
@@ -35,6 +41,18 @@ Alternately, you can pass the flag --haml to force it.
 
 Or pass the flag --erb to force erb template generation.
 
+=== Theme Reuse:
+
+Once you have installed a theme into an application once, that theme remembers the content path
+and partials you selected. You won't have to type them again.
+
+That is, after running the `install_theme` command above, you could apply the same theme
+to another Rails app using just:
+
+    install_theme path/to/app path/to/another_rails_app
+
+The defaults for each theme are stored in a file `install_theme.yml`.
+
 == INSTALL:
 
 install_theme is distributed as a RubyGem, which installs the command line app automatically:

data/Rakefile

@@ -14,7 +14,6 @@ $hoe = Hoe.spec 'install_theme' do
   extra_deps << ['hpricot','>= 0.8.1']
   extra_deps << ['rubigen','>= 1.5.2']
   extra_dev_deps << ['drnic-haml', '>= 2.3.0']
-  extra_dev_deps << ['rails', '2.3.4']
 end
 
 require 'newgem/tasks'

data/lib/install_theme.rb

@@ -10,10 +10,11 @@ require 'sass/css'
 require 'haml/exec'
 
 class InstallTheme
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
   
   attr_reader :template_root, :rails_root, :index_path, :template_type
   attr_reader :stylesheet_dir, :javascript_dir, :image_dir
+  attr_reader :defaults_file
   attr_reader :content_path, :partials
   attr_reader :stdout
   attr_reader :original_named_yields, :original_body_content
@@ -22,14 +23,19 @@ class InstallTheme
     @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_path   = options[:content_path] || "content"
-    @partials       = options[:partials] || {}
+    @defaults_file  = options[:defaults_file] || "install_theme.yml"
     @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
+
+    load_template_defaults unless options[:ignore_defaults]
+    @index_path     = options[:index_path] || @index_path || "index.html"
+    @content_path   = options[:content_path] || @content_path
+    @partials       ||= {}
+    @partials.merge!(options[:partials]) if options[:partials]
     
+    create_install_theme_yml
     setup_template_temp_path
   end
   
@@ -70,8 +76,23 @@ class InstallTheme
     template_type == 'erb'
   end
   
+  def valid?
+    template_root && File.exist?(template_root) &&
+    rails_root && File.exist?(rails_root) &&
+    content_path
+  end
+  
   protected
   
+  def load_template_defaults
+    return unless File.exist?(File.join(template_root, defaults_file))
+    require "yaml"
+    defaults = YAML.load_file(File.join(template_root, defaults_file))
+    @content_path = defaults["content_path"]
+    @partials     = defaults["partials"]
+    @index_path   = defaults["index_path"]
+  end
+  
   def convert_file_to_layout(html_path, layout_path)
     File.open(File.join(template_temp_path, layout_path), "w") do |f|
       contents = File.read(File.join(template_root, html_path)).gsub(/\r/, '')
@@ -249,6 +270,12 @@ class InstallTheme
   def in_rails_root(&block)
     FileUtils.chdir(rails_root, &block)
   end
+  
+  def create_install_theme_yml
+    config = { "content_path" => content_path, "partials" => partials }
+    install_theme_yml = File.join(template_root, 'install_theme.yml')
+    File.open(install_theme_yml, 'w') {|f| f << config.to_yaml}
+  end
 
   def detect_template
     if detect_template_haml
@@ -302,7 +329,10 @@ class InstallTheme
   end
   
   def clean_stylesheet(contents)
-    contents.gsub(%r{url\((["']?)[\./]*(?:#{image_dir}|#{stylesheet_dir}|)\/?}, 'url(\1/images/')
+    contents.gsub(%r{url\((["']?)[\./]*(#{image_dir}|#{stylesheet_dir}|)\/?}) do |match|
+      target_path = (!stylesheet_dir.blank? && $2 == stylesheet_dir) ? "stylesheets" : "images"
+      "url(#{$1}/#{target_path}/"
+    end
   end
   
   def show_readme

data/lib/install_theme/cli.rb

@@ -28,7 +28,7 @@ class InstallTheme
                 "Example using XPath: --partial \"header://div[@id='header']\"") do |arg|
                   options[:partials] ||= {}
                   key, css_path = arg.split(/\s*:\s*/)[0..1]
-                  options[:partials][key.strip.to_sym] = css_path.strip
+                  options[:partials][key.strip] = css_path.strip
                 end
         opts.on("-h", "--help",
                 "Show this help message.") { |arg| stdout.puts opts; exit }
@@ -37,14 +37,14 @@ class InstallTheme
                 ) { |arg| stdout.puts InstallTheme::VERSION; exit }
         opts.parse!(arguments)
       end
-      options[:template_root] = arguments.shift
       options[:rails_root]    = arguments.shift
+      options[:template_root] = arguments.shift
       options[:content_path]  = arguments.shift
-      unless options[:template_root] && options[:rails_root]
-        stdout.puts "trying"
+      theme = InstallTheme.new(options)
+      unless theme.valid?
         stdout.puts parser; exit
       end
-      InstallTheme.new(options).apply_to_target
+      theme.apply_to_target
     end
   end
 end

data/spec/expected/rails/bloganje/public/stylesheets/sass/style.sass

@@ -4,7 +4,7 @@
 
 
 img, div, a
-  behavior: url(css/iepngfix.htc) 
+  behavior: url(/stylesheets/iepngfix.htc) 
 
 
 body
@@ -260,7 +260,7 @@ td, th
 thead
 
 #infowrap li
-  display: inline:
+  display: inline:
 
 
 
@@ -294,7 +294,7 @@ thead
       text-align: left
       float: left
       padding: 0 2px
-      font-size: 14px
+      font-size: 14px
 
 
     a

data/spec/expected/rails/bloganje/public/stylesheets/style.css

@@ -5,7 +5,7 @@
 	margin:0;
 	padding:0;
 }
-img, div,a { behavior: url(css/iepngfix.htc) }
+img, div,a { behavior: url(/stylesheets/iepngfix.htc) }
 body{
 	font-size: 12px;
 	font-family: Arial, Tahoma, Verdana;

data/spec/install_theme_cli_spec.rb

@@ -2,20 +2,21 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'install_theme/cli'
 
 describe InstallTheme::CLI, "execute" do
-  before(:each) do
+  it("parses arguments and run generator") do
     theme = stub
     InstallTheme.should_receive(:new).
-      with(:template_root => "path/to/app", 
+      with(:template_root => "path/to/template", 
         :rails_root       => "path/to/rails_app",
         :content_path     => "#content_box",
         :index_path       => "root.html",
         :template_type    => "haml",
-        :partials         => { :header => '#header h2', :sidebar => '#sidebar' }
+        :partials         => { "header" => '#header h2', "sidebar" => '#sidebar' }
       ).
       and_return(theme)
+    theme.should_receive(:valid?).and_return(true)
     theme.should_receive(:apply_to_target)
     @stdout = stdout do |stdout_io|
-      InstallTheme::CLI.execute(stdout_io, %w[path/to/app path/to/rails_app #content_box
+      InstallTheme::CLI.execute(stdout_io, %w[path/to/rails_app path/to/template #content_box
         --index_path=root.html
         --haml
         --partial header:#header\ h2
@@ -23,6 +24,19 @@ describe InstallTheme::CLI, "execute" do
       ])
     end
   end
-  
-  it("parses arguments and run generator") { }
+
+  it("allows for content_path and partials to be derived from defaults file") do
+    theme = stub
+    InstallTheme.should_receive(:new).
+      with(:template_root => "path/to/template", 
+        :rails_root       => "path/to/rails_app",
+        :content_path     => nil
+      ).
+      and_return(theme)
+    theme.should_receive(:valid?).and_return(true)
+    theme.should_receive(:apply_to_target)
+    @stdout = stdout do |stdout_io|
+      InstallTheme::CLI.execute(stdout_io, %w[path/to/rails_app path/to/template])
+    end
+  end
 end

data/spec/install_theme_haml_spec.rb

@@ -4,17 +4,20 @@ describe InstallTheme do
   context "bloganje theme to haml" do
     before(:all) do
       setup_base_rails :haml => true
+      @template_root = File.dirname(__FILE__) + "/fixtures/bloganje"
+      FileUtils.rm_rf(File.join(@template_root, "install_theme.yml"))
       @stdout = stdout do |stdout|
-        @theme = InstallTheme.new(:template_root => File.dirname(__FILE__) + "/fixtures/bloganje", 
-          :rails_root    => @target_application,
-          :content_path    => "content",
-          :partials => { :header => '#header h2', :sidebar => '#sidebar' },
-          :stdout        => stdout)
+        @theme = InstallTheme.new(:template_root => @template_root,
+          :rails_root   => @target_application,
+          :content_path => "#content",
+          :partials     => { "header" => '#header h2', "sidebar" => '#sidebar' },
+          :stdout       => stdout)
         @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
       end
       @expected_application = File.dirname(__FILE__) + "/expected/rails/bloganje"
     end
     it { @theme.should be_haml }
+    it { @theme.should be_valid }
 
     %w[app/views/layouts/application.html.haml
       app/views/layouts/_header.html.haml

data/spec/install_theme_spec.rb

@@ -4,11 +4,13 @@ describe InstallTheme do
   context "bloganje theme to ERb using CSS path" do
     before(:all) do
       setup_base_rails
+      @template_root = File.dirname(__FILE__) + "/fixtures/bloganje"
+      FileUtils.rm_rf(File.join(@template_root, "install_theme.yml"))
       @stdout = stdout do |stdout|
-        @theme = InstallTheme.new(:template_root => File.dirname(__FILE__) + "/fixtures/bloganje", 
+        @theme = InstallTheme.new(:template_root => @template_root,
           :rails_root   => @target_application,
           :content_path => "#content",
-          :partials     => { :header => '#header h2', :sidebar => '#sidebar' },
+          :partials     => { "header" => '#header h2', "sidebar" => '#sidebar' },
           :stdout       => stdout)
         @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
       end
@@ -17,6 +19,7 @@ describe InstallTheme do
     it { @theme.stylesheet_dir.should == "css" }
     it { @theme.image_dir.should == "img" }
     it { @theme.should be_erb }
+    it { @theme.should be_valid }
 
     %w[app/views/layouts/application.html.erb
       app/views/layouts/_header.html.erb
@@ -24,7 +27,7 @@ describe InstallTheme do
       app/helpers/template_helper.rb
       public/stylesheets/style.css
       public/stylesheets/theme.css].each do |matching_file|
-        it do
+        it "should having matching file #{matching_file}" do
           expected = clean_file File.join(@expected_application, matching_file), 'expected'
           actual   = clean_file File.join(@target_application, matching_file), 'actual'
           diff = `diff #{expected} #{actual}  2> /dev/null`
@@ -40,16 +43,24 @@ describe InstallTheme do
       it { should include("<% content_for :header do -%>\n  My eCommerce Admin area\n<% end -%>") }
       it { should include('<div id="rightnow">') }
     end
+    it "should create install_theme.yml containing the partial information" do
+      expected = clean_file File.join(@template_root, "expected_install_theme.yml"), 'expected'
+      actual   = clean_file File.join(@template_root, "install_theme.yml"), 'actual'
+      diff = `diff #{expected} #{actual}  2> /dev/null`
+      rputs diff unless diff.strip.empty?
+      diff.strip.should == ""
+    end
   end
 
   context "the-hobbit-website-template theme to ERb using xpath" do
     before(:all) do
       setup_base_rails
+      @template_root = File.dirname(__FILE__) + "/fixtures/the-hobbit-website-template"
+      FileUtils.rm_rf(File.join(@template_root, "install_theme.yml"))
       @stdout = stdout do |stdout|
-        @theme = InstallTheme.new(
-          :template_root => File.dirname(__FILE__) + "/fixtures/the-hobbit-website-template",
+        @theme = InstallTheme.new(:template_root => @template_root,
           :rails_root    => @target_application,
-          :partials      => { :menu => "//div[@class='navigation']", :subtitle => "//div[@class='header']/p" },
+          :partials      => { "menu" => "//div[@class='navigation']", "subtitle" => "//div[@class='header']/p" },
           :content_path  => "//div[@class='content']", 
           :stdout        => stdout)
         @theme.apply_to_target(:generator => {:collision => :force, :quiet => true})
@@ -58,6 +69,7 @@ describe InstallTheme do
     end
     it { @theme.stylesheet_dir.should == "" }
     it { @theme.image_dir.should == "img" }
+    it { @theme.should be_valid }
 
     %w[app/views/layouts/application.html.erb
       app/helpers/template_helper.rb
@@ -72,6 +84,64 @@ describe InstallTheme do
           diff.strip.should == ""
         end
       end
+    it "should create install_theme.yml containing the partial information" do
+      expected = clean_file File.join(@template_root, "expected_install_theme.yml"), 'expected'
+      actual   = clean_file File.join(@template_root, "install_theme.yml"), 'actual'
+      diff = `diff #{expected} #{actual}  2> /dev/null`
+      rputs diff unless diff.strip.empty?
+      diff.strip.should == ""
+    end
+  end
+
+  context "use install_theme.yml for defaults" do
+    before(:all) do
+      setup_base_rails
+      @template_root = File.dirname(__FILE__) + "/fixtures/bloganje"
+      FileUtils.chdir(@template_root) do
+        FileUtils.cp_r("expected_install_theme.yml", "install_theme.yml")
+      end
+      @stdout = stdout do |stdout|
+        @theme = InstallTheme.new(:template_root => @template_root,
+          :rails_root   => @target_application,
+          :stdout       => stdout)
+        @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
+      end
+      @expected_application = File.dirname(__FILE__) + "/expected/rails/bloganje"
+    end
+    it { File.should be_exist(File.join(@template_root, "install_theme.yml")) }
+    it { @theme.content_path.should == "#content" }
+    it { @theme.should be_valid }
+    %w[app/views/layouts/application.html.erb
+      app/views/layouts/_header.html.erb
+      app/views/layouts/_sidebar.html.erb
+      app/helpers/template_helper.rb
+      public/stylesheets/style.css
+      public/stylesheets/theme.css].each do |matching_file|
+        it "should having matching file #{matching_file}" do
+          expected = clean_file File.join(@expected_application, matching_file), 'expected'
+          actual   = clean_file File.join(@target_application, matching_file), 'actual'
+          diff = `diff #{expected} #{actual}  2> /dev/null`
+          rputs diff unless diff.strip.empty?
+          diff.strip.should == ""
+        end
+      end
+  end
+
+  context "invalid if no content_path explicitly or via defaults file" do
+    before(:all) do
+      setup_base_rails
+      @template_root = File.dirname(__FILE__) + "/fixtures/bloganje"
+      FileUtils.rm_rf(File.join(@template_root, "install_theme.yml"))
+      @stdout = stdout do |stdout|
+        @theme = InstallTheme.new(:template_root => @template_root,
+          :rails_root   => @target_application,
+          :stdout       => stdout)
+        @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
+      end
+      @expected_application = File.dirname(__FILE__) + "/expected/rails/bloganje"
+    end
+    it { @theme.content_path.should be_nil }
+    it { @theme.should_not be_valid }
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: install_theme
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +10:00
+date: 2009-10-07 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,16 +42,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.0
     version: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 2.3.4
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development