RubyGems - install_theme - Versions diffs - 0.7.0 → 0.7.1 - Mend

install_theme 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

data/History.txt +13 -0
data/README.rdoc +1 -1
data/lib/install_theme.rb +12 -3
data/lib/install_theme/cli.rb +16 -9
data/spec/expected/rails/bloganje/app/views/layouts/application.html.erb +1 -0
data/spec/expected/rails/bloganje/app/views/layouts/application.html.haml +1 -0
data/spec/expected/rails/the-hobbit-website-template/app/views/layouts/application.html.erb +1 -0
data/spec/install_theme_cli_spec.rb +5 -1
data/spec/install_theme_spec.rb +20 -41
data/spec/spec_helper.rb +44 -10
metadata +2 -2

data/History.txt CHANGED

@@ -1,3 +1,16 @@
+=== 0.7.1 / 2009-10-08
+Major:
+* CLI has a --layout/-l flag to set the layout file name (still defaults to application[.html.erb])
+* CLI has a --defaults_file flag to select an alternate YAML file containing defaults for the theme.
+* Layout files have 'javascript_include_tag :all' added to the <head> section
+Minor:
+* refactor before(:all) blocks into common helper setup_app_with_theme
+* reorder the CLI help Usage message to show new order of arguments
+* reordering the CLI flags in the help display
+* removed the unfinished sentence about Dr Nic
 === 0.7.0 / 2009-10-07
 Major:

data/README.rdoc CHANGED

@@ -62,7 +62,7 @@ install_theme is distributed as a RubyGem, which installs the command line app a
 == AUTHOR:
-Dr Nic Williams (http://drnicwilliams.com) wrote install_theme because he wanted a very
+Dr Nic Williams (http://drnicwilliams.com)
 == LICENSE:

data/lib/install_theme.rb CHANGED

@@ -10,9 +10,10 @@ require 'sass/css'
 require 'haml/exec'
 class InstallTheme
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
   attr_reader :template_root, :rails_root, :index_path, :template_type
+  attr_reader :layout_name
   attr_reader :stylesheet_dir, :javascript_dir, :image_dir
   attr_reader :defaults_file
   attr_reader :content_path, :partials
@@ -27,6 +28,9 @@ class InstallTheme
     @stylesheet_dir = options[:stylesheet_dir] || detect_stylesheet_dir
     @javascript_dir = options[:javascript_dir] || detect_javascript_dir
     @image_dir      = options[:image_dir] || detect_image_dir
+    @layout_name    = options[:layout] || "application"
+    @layout_name.gsub!(/\..*/, '') # allow application.html.erb to be passed in, but clean it up to 'application'
     @stdout         = options[:stdout] || $stdout
     load_template_defaults unless options[:ignore_defaults]
@@ -42,7 +46,7 @@ class InstallTheme
   def apply_to_target(options = {})
     @stdout = options[:stdout] || @stdout || $stdout
     @original_named_yields = {}
-    convert_file_to_layout(index_path, 'app/views/layouts/application.html.erb')
+    convert_file_to_layout(index_path, "app/views/layouts/#{layout_name}.html.erb")
     convert_to_haml('app/views/layouts/application.html.erb') if haml?
     prepare_sample_controller_and_view
     prepare_layout_partials
@@ -113,7 +117,12 @@ class InstallTheme
       contents.gsub!(%r{(["'])/?#{stylesheet_dir}}, '\1/stylesheets') unless stylesheet_dir.blank?
       contents.gsub!(%r{(["'])/?#{javascript_dir}}, '\1/javascripts') unless javascript_dir.blank?
-      contents.sub!(%r{\s*</head>}, "\n  <%= yield(:head) %>\n</head>")
+      contents.sub!(%r{\s*</head>}, <<-EOS.gsub(/^      /, '').gsub(/\n$/, ''))
+        <%= javascript_include_tag :all %>
+        <%= yield(:head) %>
+      </head>
+      EOS
       doc = Hpricot(contents)
       doc.search(content_path).each do |elm|

data/lib/install_theme/cli.rb CHANGED

@@ -8,11 +8,23 @@ class InstallTheme
         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_path [options]
+          Usage: #{File.basename($0)} path/to/rails_app path/to/template content_path [options]
           Options are:
         BANNER
         opts.separator ""
+        opts.on("-p", "--partial KEY_AND_PATH", String,
+                "Replace the inner HTML of an element with <%= yield :key %>",
+                "Example using CSS path: --partial header:#header",
+                "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] = css_path.strip
+                end
+        opts.on("-l", "--layout application", String,
+                "Set the layout file name.",
+                "Layout files are stored in app/views/layouts and will be suffixed by .html.erb or .html.haml",
+                "Default: application") { |arg| options[:layout] = arg }
         opts.on("--erb",
                 "Generate ERb templates.",
                 "Default: auto-detect") { |arg| options[:template_type] = 'erb' }
@@ -22,14 +34,9 @@ class InstallTheme
         opts.on("--index_path index.html", String,
                 "HTML page to use for application layout.",
                 "Default: index.html") { |arg| options[:index_path] = arg }
-        opts.on("-p", "--partial KEY_AND_PATH", String,
-                "Replace the inner HTML of an element with <%= yield :key %>",
-                "Example using CSS path: --partial header:#header",
-                "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] = css_path.strip
-                end
+        opts.on("--defaults_file install_theme.yml", String,
+                "Select an alternate YAML file containing defaults for the theme.",
+                "Default: install_theme.yml") { |arg| options[:defaults_file] = arg }
         opts.on("-h", "--help",
                 "Show this help message.") { |arg| stdout.puts opts; exit }
         opts.on("-v", "--version",

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

@@ -12,6 +12,7 @@
 <!--[if IE]>
 <link rel="stylesheet" type="text/css" href="/stylesheets/ie-sucks.css" />
 <![endif]-->
+  <%= javascript_include_tag :all %>
   <%= yield(:head) %>
 </head>

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

@@ -13,6 +13,7 @@
       [if IE]>
       <link rel="stylesheet" type="text/css" href="/stylesheets/ie-sucks.css" />
       <![endif]
+    = javascript_include_tag :all
     = yield(:head)
   %body
     #container

data/spec/expected/rails/the-hobbit-website-template/app/views/layouts/application.html.erb CHANGED

@@ -8,6 +8,7 @@
 <meta name="author" content="author" />
 <link href="/stylesheets/default.css" rel="stylesheet" type="text/css" />
 <title>The Hobbit</title>
+  <%= javascript_include_tag :all %>
   <%= yield(:head) %>
 </head>

data/spec/install_theme_cli_spec.rb CHANGED

@@ -10,7 +10,9 @@ describe InstallTheme::CLI, "execute" do
         :content_path     => "#content_box",
         :index_path       => "root.html",
         :template_type    => "haml",
-        :partials         => { "header" => '#header h2', "sidebar" => '#sidebar' }
+        :partials         => { "header" => '#header h2', "sidebar" => '#sidebar' },
+        :defaults_file    => "install_theme.yml",
+        :layout           => "iphone"
       ).
       and_return(theme)
     theme.should_receive(:valid?).and_return(true)
@@ -21,6 +23,8 @@ describe InstallTheme::CLI, "execute" do
         --haml
         --partial header:#header\ h2
         -p sidebar:#sidebar
+        --defaults_file install_theme.yml
+        --layout iphone
       ])
     end
   end

data/spec/install_theme_spec.rb CHANGED

@@ -1,21 +1,10 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 describe InstallTheme do
+  include SetupThemeHelpers
   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 => @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
+    before(:all) { setup_bloganje }
     it { @theme.stylesheet_dir.should == "css" }
     it { @theme.image_dir.should == "img" }
     it { @theme.should be_erb }
@@ -53,20 +42,7 @@ describe InstallTheme do
   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 => @template_root,
-          :rails_root    => @target_application,
-          :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})
-      end
-      @expected_application = File.dirname(__FILE__) + "/expected/rails/the-hobbit-website-template"
-    end
+    before(:all) { setup_hobbit }
     it { @theme.stylesheet_dir.should == "" }
     it { @theme.image_dir.should == "img" }
     it { @theme.should be_valid }
@@ -95,18 +71,7 @@ describe InstallTheme do
   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"
+      setup_app_with_theme('bloganje', :setup_defaults => true)
     end
     it { File.should be_exist(File.join(@template_root, "install_theme.yml")) }
     it { @theme.content_path.should == "#content" }
@@ -127,7 +92,7 @@ describe InstallTheme do
       end
   end
-  context "invalid if no content_path explicitly or via defaults file" do
+  context "alternate layout file name" do
     before(:all) do
       setup_base_rails
       @template_root = File.dirname(__FILE__) + "/fixtures/bloganje"
@@ -143,5 +108,19 @@ describe InstallTheme do
     it { @theme.content_path.should be_nil }
     it { @theme.should_not be_valid }
   end
+  context "invalid if no content_path explicitly or via defaults file" do
+    before(:all) { setup_bloganje(:layout => "special") }
+    %w[app/views/layouts/special.html.erb].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
 end

data/spec/spec_helper.rb CHANGED

@@ -37,16 +37,6 @@ def clean_file(orig_file, scope)
   file
 end
-def setup_base_rails(options = {})
-  tmp_path = File.dirname(__FILE__) + "/tmp"
-  FileUtils.rm_rf(tmp_path)
-  FileUtils.mkdir_p(tmp_path  )
-  @target_application = File.join(tmp_path, "my_app")
-  FileUtils.cp_r(File.dirname(__FILE__) + "/expected/rails/base_app", @target_application)
-  `haml --rails #{@target_application}` if options[:haml]
-  @target_application
-end
 def stdout(&block)
   stdout_io = StringIO.new
   yield stdout_io
@@ -54,3 +44,47 @@ def stdout(&block)
   stdout_io.read
 end
+module SetupThemeHelpers
+  def setup_app_with_theme(theme, theme_options = {})
+    setup_base_rails
+    @template_root = File.join(File.dirname(__FILE__), "fixtures", theme)
+    FileUtils.chdir(@template_root) do
+      if theme_options.delete(:setup_defaults)
+        FileUtils.cp_r("expected_install_theme.yml", "install_theme.yml")
+      else
+        FileUtils.rm_rf("install_theme.yml")
+      end
+    end
+    @stdout = stdout do |stdout|
+      @theme = InstallTheme.new({:template_root => @template_root,
+        :rails_root   => @target_application,
+        :stdout       => stdout}.merge(theme_options))
+      @theme.apply_to_target(:stdout => stdout, :generator => {:collision => :force, :quiet => true})
+    end
+    @expected_application = File.join(File.dirname(__FILE__), "expected/rails", theme)
+  end
+  def setup_bloganje(theme_options = {})
+    setup_app_with_theme('bloganje',
+      {:content_path => "#content", :partials => { "header" => '#header h2', "sidebar" => '#sidebar' }}.
+        merge(theme_options))
+  end
+  def setup_hobbit(theme_options = {})
+    setup_app_with_theme('the-hobbit-website-template',
+      { :content_path  => "//div[@class='content']",
+        :partials      => { "menu" => "//div[@class='navigation']", "subtitle" => "//div[@class='header']/p" }}.
+      merge(theme_options))
+  end
+  def setup_base_rails(options = {})
+    tmp_path = File.dirname(__FILE__) + "/tmp"
+    FileUtils.rm_rf(tmp_path)
+    FileUtils.mkdir_p(tmp_path  )
+    @target_application = File.join(tmp_path, "my_app")
+    FileUtils.cp_r(File.dirname(__FILE__) + "/expected/rails/base_app", @target_application)
+    `haml --rails #{@target_application}` if options[:haml]
+    @target_application
+  end
+end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: install_theme
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Dr Nic Williams
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-10-07 00:00:00 +10:00
+date: 2009-10-08 00:00:00 +10:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency