ore 0.7.1 → 0.7.2

data/ChangeLog.md

@@ -1,3 +1,25 @@
+### 0.7.2 / 2011-02-26
+
+* Require ore-core ~> 0.1, >= 0.1.4.
+* Added {Ore::Generator.template?}.
+* Added {Ore::Generator#enabled_templates}.
+* Added {Ore::Generator#disabled_templates}.
+* Added {Ore::Generator#templates}.
+* Added {Ore::Generator#generated_dirs}.
+* Added {Ore::Generator#generated_files}.
+* Allow {Ore::Template::Helpers#includes} to yield output.
+* Allow the `bundler` template to load `gemfile_prelude`, `gemfile` and
+  `gemfile_development` includes.
+* Allow `--rdoc` to disable `--yard`.
+* Set `@markup` to `:rdoc` in the `rdoc` template.
+* Added separate `.document` files for the `rdoc` and `yard` templates.
+* Added the `doc` alias-task to the `rdoc` and `yard` templates.
+* Added `html/` to the generated `.gitignore` file in the `rdoc` template.
+* Allow `--test-unit` to disable `--rspec`.
+* Fixed the `test_unit` template.
+* Added a `Rakefile` task to the `test_unit` template.
+* Define options for installed templates as well.
+
 ### 0.7.1 / 2011-02-20
 
 * Added {Ore::Generator#generate_dir}.

data/README.md

@@ -43,19 +43,19 @@ the developer to keep all of the project information in a single YAML file.
 
 ## Requirements
 
-* [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1, >= 0.1.2
+* [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1, >= 0.1.4
 * [thor](http://github.com/wycats/thor) ~> 0.14.3
 
 ## Install
 
     $ gem install ore
 
-## Example gemspec.yml files
+## Example gemspec.yml File
 
 The `gemspec.yml` file used to build Ore:
 
     name: ore
-    version: 0.7.1
+    version: 0.7.2
     summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
@@ -72,7 +72,7 @@ The `gemspec.yml` file used to build Ore:
       **************************************************************************
       Generate a new Ruby library:
       
-          $ mine my_library --rspec
+          $ mine my_library --rspec --yard
       
       Build the library:
       
@@ -85,7 +85,7 @@ The `gemspec.yml` file used to build Ore:
       **************************************************************************
     
     dependencies:
-      ore-core: ~> 0.1, >= 0.1.2
+      ore-core: ~> 0.1, >= 0.1.4
       thor: ~> 0.14.3
     
     development_dependencies:
@@ -100,7 +100,7 @@ For a complete refrence to the `gemspec.yml` file, please see the
 
 Install a custom template:
 
-    $ ore install http://github.com/user/awesometest.git
+    $ ore install git://github.com/ruby-ore/mini_test.git
 
 List installed templates:
 
@@ -108,19 +108,19 @@ List installed templates:
 
 Remove a previously installed template:
 
-    $ ore remove awesometest
+    $ ore remove mini_test
 
 Generate a new project:
 
-    $ mine myproj
+    $ mine my_project
 
 Generate a new customized project:
 
-    $ mine myproj --bundler --rspec --yard
+    $ mine my_project --bundler --rspec --yard
 
 Generate a new project using previously installed templates:
 
-    $ mine myproj --bundler --rspec --yard -T awesometest
+    $ mine my_project --bundler --rspec --yard --template mini_test
 
 Add default generator options to `~/.ore/options.yml`:
 
@@ -132,7 +132,7 @@ Add default generator options to `~/.ore/options.yml`:
       - Alice
     email: alice@example.com
 
-Builds a `.gem` file in the `pkg/` directory of a project:
+Build a `.gem` file in the `pkg/` directory of a project:
 
     $ ore gem
 

data/data/ore/templates/base/gemspec.yml.erb

@@ -18,9 +18,9 @@ email: <%= @email %>
 homepage: <%= @homepage %>
 <%= includes :gemspec, '' -%>
 
-<%- unless (dependencies = includes(:dependencies,'')).empty? -%>
+<%- includes(:dependencies,'') do |dependencies| -%>
 dependencies:
-<%= dependencies %>
+<%=   dependencies %>
 
 <%- end -%>
 development_dependencies:

data/data/ore/templates/bundler/Gemfile.erb

@@ -1,8 +1,16 @@
 source :rubygems
+<%- includes(:gemfile_prelude,'') do |prelude| -%>
+
+<%= prelude %>
+<%- end -%>
 
 gemspec
 
+<%- includes(:gemfile,'') do |gemfile| -%>
+<%= gemfile %>
+
+<%- end -%>
 group :development do
   gem 'rake',     '~> 0.8.7'
-<%= includes :gemfile, '' -%>
+<%= includes :gemfile_development, '' -%>
 end

data/data/ore/templates/jeweler_tasks/template.yml

@@ -1,4 +1,4 @@
-disables:
+disable:
   - ore_tasks
 
 variables:

data/data/ore/templates/ore_tasks/template.yml

@@ -1,2 +1,5 @@
+disable:
+  - jeweler_tasks
+
 variables:
   ore_tasks_dependency: ~> 0.4

data/data/ore/templates/rdoc/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/data/ore/templates/rdoc/_gitignore.erb

@@ -0,0 +1 @@
+html/

data/data/ore/templates/rdoc/_tasks.erb

@@ -1,6 +1,5 @@
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   rdoc.title = <%= @name.dump %>
-  rdoc.rdoc_files.include("README.rdoc")
-  rdoc.rdoc_files.include("lib/**/*.rb")
 end
+task :doc => :rdoc

data/data/ore/templates/rdoc/template.yml

@@ -0,0 +1,5 @@
+disable:
+  - yard
+
+variables:
+  markup: :rdoc

data/data/ore/templates/test_unit/_tasks.erb

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/data/ore/templates/test_unit/template.yml

@@ -0,0 +1,2 @@
+disable:
+  - rspec

data/data/ore/templates/test_unit/test/test_[name].rb.erb

@@ -1,5 +1,12 @@
 require 'helper'
 require '<%= @namespace_path %>'
 
-class <%= @namespace %> < Test::Unit::TestCase
+class Test<%= @namespace %> < Test::Unit::TestCase
+
+  def test_version
+    version = <%= @namespace %>.const_get('VERSION')
+
+    assert(!version.empty?, 'should have a VERSION constant')
+  end
+
 end

data/data/ore/templates/yard/_tasks.erb

@@ -13,3 +13,4 @@ rescue LoadError => e
   end
 end
 <%- end -%>
+task :doc => :yard

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.7.1
+version: 0.7.2
 summary: Mine raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the
@@ -16,7 +16,7 @@ post_install_message: |
   **************************************************************************
   Generate a new Ruby library:
   
-      $ mine my_library --rspec
+      $ mine my_library --rspec --yard
   
   Build the library:
   
@@ -29,7 +29,7 @@ post_install_message: |
   **************************************************************************
 
 dependencies:
-  ore-core: ~> 0.1, >= 0.1.2
+  ore-core: ~> 0.1, >= 0.1.4
   thor: ~> 0.14.3
 
 development_dependencies:

data/lib/ore/generator.rb

@@ -23,6 +23,21 @@ module Ore
       @@templates ||= {}
     end
 
+    #
+    # Determines whether a template was registered.
+    #
+    # @param [Symbol, String] name
+    #   The name of the template.
+    #
+    # @return [Boolean]
+    #   Specifies whether the template was registered.
+    #
+    # @since 0.7.2
+    #
+    def self.template?(name)
+      self.templates.has_key?(name.to_sym)
+    end
+
     #
     # Registers a template with the generator.
     #
@@ -84,6 +99,21 @@ module Ore
       class_option(name,options.merge(:default => defaults[name]))
     end
 
+    # The enabled templates.
+    attr_reader :enabled_templates
+
+    # The disabled templates.
+    attr_reader :disabled_templates
+
+    # The loaded templates.
+    attr_reader :templates
+
+    # The generated directories.
+    attr_reader :generated_dirs
+
+    # The generated files.
+    attr_reader :generated_files
+
     #
     # Generates a new project.
     #
@@ -115,19 +145,17 @@ module Ore
     defaults.merge!(Config.default_options)
 
     # register builtin templates
-    Config.builtin_templates do |path|
-      name = register_template(path)
+    Config.builtin_templates { |path| register_template(path) }
+    # register installed templates
+    Config.installed_templates { |path| register_template(path) }
 
+    # define options for all templates
+    templates.each_key do |name|
       # skip the `base` template
       next if name == :base
 
-      # define options for builtin templates
-      class_option name, :type => :boolean, :default => defaults[name]
-    end
-
-    # register installed templates
-    Config.installed_templates do |path|
-      register_template(path)
+      class_option name, :type => :boolean,
+                         :default => defaults.fetch(name,false)
     end
 
     # disable the Thor namespace
@@ -229,7 +257,7 @@ module Ore
 
       return false if @enabled_templates.include?(name)
 
-      unless (template_dir = Generator.templates[name])
+      unless (template_dir = self.class.templates[name])
         say "Unknown template #{name}", :red
         exit -1
       end
@@ -264,7 +292,9 @@ module Ore
     def disable_template(name)
       name = name.to_sym
 
-      unless (template_dir = Generator.templates[name])
+      return false if @disabled_templates.include?(name)
+
+      unless (template_dir = self.class.templates[name])
         say "Unknown template #{name}", :red
         exit -1
       end
@@ -273,6 +303,7 @@ module Ore
 
       @templates.delete_if { |template| template.path == template_dir }
       @enabled_templates.delete(name)
+      @disabled_templates << name
       return true
     end
 
@@ -281,13 +312,23 @@ module Ore
     #
     def enable_templates!
       @templates = []
-      @enabled_templates = []
+      @enabled_templates = Set[]
+      @disabled_templates = Set[]
       
       enable_template :base
 
-      # enable templates specified by options
-      self.class.templates.each_key do |name|
-        enable_template(name) if options[name]
+      # enable the default templates first
+      self.class.defaults.each_key do |name|
+        if (self.class.template?(name) && options[name])
+          enable_template(name)
+        end
+      end
+
+      # enable the templates specified by option
+      options.each do |name,value|
+        if (self.class.template?(name) && value)
+          enable_template(name)
+        end
       end
 
       # enable any additionally specified templates

data/lib/ore/template/helpers.rb

@@ -12,8 +12,18 @@ module Ore
       # @param [Symbol] name
       #   The name of the include.
       #
-      # @return [String]
+      # @param [String] separator
+      #   The separator to join includes with.
+      #
+      # @yield [output]
+      #   If a block is given, it will be passed the rendered include files.
+      #
+      # @yieldparam [String] output
+      #   The combined result of the rendered include files.
+      #
+      # @return [String, nil]
       #   The combined result of the rendered include files.
+      #   If no includes were found, `nil` will be returned.
       #
       def includes(name,separator=$/)
         name = name.to_sym
@@ -34,7 +44,14 @@ module Ore
           end
         end
 
-        return output_buffer.join(separator)
+        output = output_buffer.join(separator)
+        output = nil if output.empty?
+
+        if (block_given? && output)
+          output = yield(output)
+        end
+
+        return output
       end
 
       #

data/spec/generator_spec.rb

@@ -157,6 +157,48 @@ describe Generator do
     end
   end
 
+  context "rdoc" do
+    let(:name) { 'rdoc-project' }
+
+    before(:all) do
+      generate!(name, :rdoc => true)
+    end
+
+    it "should disable the yard template" do
+      @generator.disabled_templates.should include(:yard)
+    end
+
+    it "should set @markup to :rdoc" do
+      @generator.instance_variable_get('@markup').should == :rdoc
+    end
+
+    it "should add 'html/' to the .gitignore file" do
+      gitignore.should include('html/')
+    end
+
+    it "should add a '.document' file" do
+      @path.join('.document').should be_file
+    end
+
+    context ".document" do
+      it "should include 'lib/**/*.rb'" do
+        document.should include('lib/**/*.rb')
+      end
+
+      it "should include 'README.rdoc'" do
+        document.should include('README.rdoc')
+      end
+
+      it "should include 'ChangeLog.rdoc'" do
+        document.should include('ChangeLog.rdoc')
+      end
+
+      it "should include 'LICENSE.txt'" do
+        document.should include('LICENSE.txt')
+      end
+    end
+  end
+
   context "yard" do
     let(:name) { 'yard-project' }
 
@@ -164,6 +206,10 @@ describe Generator do
       generate!(name, :yard => true)
     end
 
+    it "should disable the rdoc template" do
+      @generator.disabled_templates.should include(:rdoc)
+    end
+
     it "should add a .yardopts file" do
       @path.join('.yardopts').should be_file
     end
@@ -171,6 +217,32 @@ describe Generator do
     it "should set 'has_yard' to 'true' in the gemspec.yml file" do
       @gemspec['has_yard'].should == true
     end
+
+    it "should add a '.document' file" do
+      @path.join('.document').should be_file
+    end
+
+    context ".document" do
+      it "should not include 'lib/**/*.rb'" do
+        document.should_not include('lib/**/*.rb')
+      end
+
+      it "should include a '-' separator for non-code files" do
+        document.should include('-')
+      end
+
+      it "should not include 'README.*'" do
+        document.grep(/^README\./).should be_empty
+      end
+
+      it "should include 'ChangeLog.*'" do
+        document.should include('ChangeLog.*')
+      end
+
+      it "should include 'LICENSE.txt'" do
+        document.should include('LICENSE.txt')
+      end
+    end
   end
 
   context "yard with markdown" do
@@ -225,6 +297,30 @@ describe Generator do
     end
   end
 
+  context "test_unit" do
+    let(:name) { 'test_unit_project' }
+
+    before(:all) do
+      generate!(name, :test_unit => true)
+    end
+
+    it "should disable the rspec template" do
+      @generator.disabled_templates.should include(:rspec)
+    end
+
+    it "should create the test/ directory" do
+      @path.join('test').should be_directory
+    end
+
+    it "should create the test/helper.rb file" do
+      @path.join('test','helper.rb').should be_file
+    end
+
+    it "should add a single test_*.rb file" do
+      @path.join('test','test_test_unit_project.rb').should be_file
+    end
+  end
+
   context "rspec" do
     let(:name) { 'rspec_project' }
 
@@ -232,6 +328,10 @@ describe Generator do
       generate!(name, :rspec => true)
     end
 
+    it "should disable the test_unit template" do
+      @generator.disabled_templates.should include(:test_unit)
+    end
+
     it "should not create the test/ directory" do
       @path.join('test').should_not be_directory
     end
@@ -276,6 +376,10 @@ describe Generator do
       generate!(name, :jeweler_tasks => true)
     end
 
+    it "should disable the ore_tasks template" do
+      @generator.disabled_templates.should include(:ore_tasks)
+    end
+
     it "should add 'jeweler' as a development dependency" do
       @gemspec['development_dependencies'].should have_key('jeweler')
     end
@@ -300,6 +404,10 @@ describe Generator do
       generate!(name, :ore_tasks => true)
     end
 
+    it "should disable the jeweler_tasks template" do
+      @generator.disabled_templates.should include(:jeweler_tasks)
+    end
+
     it "should omit 'ore-core' as a development dependency" do
       @gemspec['development_dependencies'].should_not have_key('ore-core')
     end

data/spec/helpers/generator.rb

@@ -10,10 +10,11 @@ module Helpers
     def generate!(path,options={})
       path = File.join(ROOT,path)
 
-      Ore::Generator.new(
+      @generator = Ore::Generator.new(
         [path],
         options.merge(:quiet => true)
-      ).invoke_all
+      )
+      @generator.invoke_all
 
       @path = Pathname.new(path)
       @gemspec = YAML.load_file(@path.join('gemspec.yml'))
@@ -27,16 +28,32 @@ module Helpers
       @path.join('.yardopts').read
     end
 
+    def document
+      unless @document
+        @document = []
+
+        @path.join('.document').read.each_line do |line|
+          unless (line.empty? && line =~ /\s*\#/)
+            @document << line.strip
+          end
+        end
+      end
+
+      return @document
+    end
+
     def gitignore
-      lines = []
+      unless @gitignore
+        @gitignore = []
 
-      @path.join('.gitignore').read.each_line do |line|
-        unless (line.empty? && line =~ /\s*\#/)
-          lines << line.strip
+        @path.join('.gitignore').read.each_line do |line|
+          unless (line.empty? && line =~ /\s*\#/)
+            @gitignore << line.strip
+          end
         end
       end
 
-      return lines
+      return @gitignore
     end
 
     def cleanup!

metadata

@@ -2,7 +2,7 @@
 name: ore
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - Postmodern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 -08:00
+date: 2011-02-26 00:00:00 -08:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
         version: "0.1"
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.2
+        version: 0.1.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -94,7 +94,6 @@ files:
 - Rakefile
 - bin/mine
 - bin/ore
-- data/ore/templates/base/.document
 - data/ore/templates/base/.gitignore.erb
 - data/ore/templates/base/ChangeLog.md.erb
 - data/ore/templates/base/ChangeLog.rdoc.erb
@@ -105,7 +104,7 @@ files:
 - data/ore/templates/base/README.tt.erb
 - data/ore/templates/base/Rakefile.erb
 - data/ore/templates/base/[name].gemspec.erb
-- data/ore/templates/base/_gemfile.erb
+- data/ore/templates/base/_gemfile_development.erb
 - data/ore/templates/base/gemspec.yml.erb
 - data/ore/templates/base/lib/[namespace_path].rb.erb
 - data/ore/templates/base/lib/[namespace_path]/version.rb.erb
@@ -118,27 +117,33 @@ files:
 - data/ore/templates/bundler/template.yml
 - data/ore/templates/gem_test/.gemtest
 - data/ore/templates/jeweler_tasks/_development_dependencies.erb
-- data/ore/templates/jeweler_tasks/_gemfile.erb
+- data/ore/templates/jeweler_tasks/_gemfile_development.erb
 - data/ore/templates/jeweler_tasks/_tasks.erb
 - data/ore/templates/jeweler_tasks/template.yml
 - data/ore/templates/ore_tasks/_development_dependencies.erb
-- data/ore/templates/ore_tasks/_gemfile.erb
+- data/ore/templates/ore_tasks/_gemfile_development.erb
 - data/ore/templates/ore_tasks/_tasks.erb
 - data/ore/templates/ore_tasks/template.yml
+- data/ore/templates/rdoc/.document
+- data/ore/templates/rdoc/_gitignore.erb
 - data/ore/templates/rdoc/_tasks.erb
+- data/ore/templates/rdoc/template.yml
 - data/ore/templates/rspec/.rspec
 - data/ore/templates/rspec/_development_dependencies.erb
-- data/ore/templates/rspec/_gemfile.erb
+- data/ore/templates/rspec/_gemfile_development.erb
 - data/ore/templates/rspec/_tasks.erb
 - data/ore/templates/rspec/spec/[namespace_dir]_spec.rb.erb
 - data/ore/templates/rspec/spec/spec_helper.rb.erb
 - data/ore/templates/rspec/template.yml
 - data/ore/templates/rvmrc/.rvmrc.erb
+- data/ore/templates/test_unit/_tasks.erb
+- data/ore/templates/test_unit/template.yml
 - data/ore/templates/test_unit/test/helper.rb.erb
 - data/ore/templates/test_unit/test/test_[name].rb.erb
+- data/ore/templates/yard/.document
 - data/ore/templates/yard/.yardopts.erb
 - data/ore/templates/yard/_development_dependencies.erb
-- data/ore/templates/yard/_gemfile.erb
+- data/ore/templates/yard/_gemfile_development.erb
 - data/ore/templates/yard/_gemspec.erb
 - data/ore/templates/yard/_tasks.erb
 - data/ore/templates/yard/template.yml
@@ -157,7 +162,7 @@ files:
 - spec/generator_spec.rb
 - spec/helpers/generator.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://github.com/ruby-ore/ore
 licenses: 
 - MIT
@@ -165,7 +170,7 @@ post_install_message: |
   **************************************************************************
   Generate a new Ruby library:
   
-      $ mine my_library --rspec
+      $ mine my_library --rspec --yard
   
   Build the library: