ore 0.8.1 → 0.9.0

data/lib/ore/template/template.rb

@@ -0,0 +1,61 @@
+module Ore
+  module Template
+    #
+    # The templates registered with the generator.
+    #
+    # @return [Hash{Symbol => String}]
+    #   The template names and paths.
+    #  
+    # @api semipublic
+    #
+    # @since 0.9.0
+    #
+    def self.templates
+      @@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.
+    #
+    # @api semipublic
+    #
+    # @since 0.9.0
+    #
+    def self.template?(name)
+      self.templates.has_key?(name.to_sym)
+    end
+
+    #
+    # Registers a template with the generator.
+    #
+    # @param [String] path
+    #   The path to the template.
+    #
+    # @return [Symbol]
+    #   The name of the registered template.
+    #
+    # @raise [StandardError]
+    #   The given path was not a directory.
+    #
+    # @api semipublic
+    #
+    # @since 0.9.0
+    #
+    def self.register(path)
+      unless File.directory?(path)
+        raise(StandardError,"#{path.dump} is must be a directory")
+      end
+
+      name = File.basename(path).to_sym
+
+      self.templates[name] = path
+      return name
+    end
+  end
+end

data/ore.gemspec

@@ -3,43 +3,44 @@
 require 'yaml'
 
 Gem::Specification.new do |gemspec|
-  root = File.dirname(__FILE__)
+  root    = File.dirname(__FILE__)
   lib_dir = File.join(root,'lib')
-  files = if File.directory?('.git')
-            `git ls-files`.split($/)
-          elsif File.directory?('.hg')
-            `hg manifest`.split($/)
-          elsif File.directory?('.svn')
-            `svn ls -R`.split($/).select { |path| File.file?(path) }
-          else
-            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-          end
+  files   = if File.directory?('.git')
+              `git ls-files`.split($/)
+            elsif File.directory?('.hg')
+              `hg manifest`.split($/)
+            elsif File.directory?('.svn')
+              `svn ls -R`.split($/).select { |path| File.file?(path) }
+            else
+              Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+            end
 
   filter_files = lambda { |paths|
-    case paths
-    when Array
-      (files & paths)
-    when String
-      (files & Dir[paths])
-    end
+    files & case paths
+            when Array
+              paths
+            when String
+              Dir[paths]
+            end
   }
 
   version = {
-    :file => 'ore/version.rb',
+    :file     => 'ore/version.rb',
     :constant => 'Ore::VERSION'
   }
 
   defaults = {
-    'name' => File.basename(File.dirname(__FILE__)),
-    'files' => files,
-    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
-    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+    'name'            => File.basename(File.dirname(__FILE__)),
+    'files'           => files,
+    'require_paths'   => ['ext', 'lib'].select { |dir| File.directory?(dir) },
+    'executables'     => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files'      => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}']
   }
 
   metadata = defaults.merge(YAML.load_file('gemspec.yml'))
 
-  gemspec.name = metadata['name']
+  gemspec.name    = metadata['name']
   gemspec.version = if metadata['version']
                       metadata['version']
                     else
@@ -49,50 +50,29 @@ Gem::Specification.new do |gemspec|
                       eval(version[:constant])
                     end
 
-  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.summary     = metadata.fetch('summary',metadata['description'])
   gemspec.description = metadata.fetch('description',metadata['summary'])
 
-  case metadata['license']
-  when Array
-    gemspec.licenses = metadata['license']
-  when String
-    gemspec.license = metadata['license']
-  end
-
-  case metadata['authors']
-  when Array
-    gemspec.authors = metadata['authors']
-  when String
-    gemspec.author = metadata['authors']
-  end
+  gemspec.licenses = Array(metadata['license'])
+  gemspec.authors  = Array(metadata['authors'])
 
-  gemspec.email = metadata['email']
+  gemspec.email    = metadata['email']
   gemspec.homepage = metadata['homepage']
 
-  case metadata['require_paths']
-  when Array
-    gemspec.require_paths = metadata['require_paths']
-  when String
-    gemspec.require_path = metadata['require_paths']
-  end
-
-  gemspec.files = filter_files[metadata['files']]
-
-  gemspec.executables = metadata['executables']
-  gemspec.extensions = metadata['extensions']
+  gemspec.require_paths = Array(metadata['require_paths'])
+  gemspec.files         = filter_files[metadata['files']]
+  gemspec.executables   = metadata['executables']
+  gemspec.extensions    = metadata['extensions']
 
   if Gem::VERSION < '1.7.'
     gemspec.default_executable = gemspec.executables.first
   end
 
-  gemspec.test_files = filter_files[metadata['test_files']]
-
-  unless gemspec.files.include?('.document')
-    gemspec.extra_rdoc_files = metadata['extra_doc_files']
-  end
+  gemspec.test_files       = filter_files[metadata['test_files']]
+  gemspec.extra_rdoc_files = Array(metadata['extra_doc_files'])
 
   gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements = metadata['requirements']
+  gemspec.requirements         = metadata['requirements']
 
   if gemspec.respond_to?(:required_ruby_version=)
     gemspec.required_ruby_version = metadata['required_ruby_version']

data/spec/gemspec_examples.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+
+require 'ore/options'
+
+shared_examples "a gemspec" do
+  it "should have a name" do
+    subject.name.should == name
+  end
+
+  it "should not contain a version by default" do
+    subject.version.version.should == Ore::Options::DEFAULT_VERSION
+  end
+
+  it "should a dummy summary" do
+    subject.summary.should == Ore::Options::DEFAULT_SUMMARY
+  end
+
+  it "should a dummy description" do
+    subject.description.should == Ore::Options::DEFAULT_DESCRIPTION
+  end
+
+  it "should have a license" do
+    subject.license.should == Ore::Options::DEFAULT_LICENSE
+  end
+
+  it "should have authors" do
+    subject.authors.should == Ore::Options::DEFAULT_AUTHORS
+  end
+
+  it "should have a dummy homepage" do
+    subject.homepage.should_not be_empty
+  end
+end

data/spec/generator_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'gemspec_examples'
 require 'helpers/generator'
 require 'ore/generator'
 
@@ -17,38 +18,70 @@ describe Generator do
     end
 
     it "should create the lib/ directory" do
-      @path.join('lib').should be_directory
+      @path.should have_directory('lib')
     end
 
     it "should create a file to load the project within lib/" do
-      @path.join('lib','my','project.rb').should be_file
+      @path.should have_file('lib','my','project.rb')
     end
 
     it "should create a namespace directory within lib/" do
-      @path.join('lib','my','project').should be_directory
+      @path.should have_directory('lib','my','project')
     end
 
     it "should create a version.rb file within the namespace directory" do
-      @path.join('lib','my','project','version.rb').should be_file
+      @path.should have_file('lib','my','project','version.rb')
     end
 
     it "should not create the bin/ directory by default" do
-      @path.join('bin').should_not be_directory
+      @path.should_not have_directory('bin')
     end
 
     it "should create a test/ directory by default" do
-      @path.join('test').should_not be_directory
+      @path.should_not have_directory('test')
     end
 
-    it "should create a gemspec.yml file" do
-      @path.join('gemspec.yml').should be_file
+    it "should add a *.gemspec file" do
+      @path.join("#{name}.gemspec").should be_file
+    end
+
+    it "should add a .document file" do
+      @path.should have_file('.document')
+    end
+
+    it "should add a Rakefile" do
+      @path.should have_file('Rakefile')
+    end
+
+    it "should add a README.rdoc file" do
+      @path.should have_file('README.rdoc')
+    end
+
+    it "should add a ChangeLog.rdoc file" do
+      @path.should have_file('ChangeLog.rdoc')
+    end
+
+    it "should add a LICENSE.txt file" do
+      @path.should have_file('LICENSE.txt')
+    end
+  end
+
+  context "gemspec_yml" do
+    let(:name) { 'gemspec_yml_project' }
+
+    before(:all) do
+      generate!(name, :gemspec_yml => true)
+    end
+
+    it "should add a gemspec.yml file" do
+      @path.should have_file('gemspec.yml')
     end
 
     describe "gemspec.yml" do
-      subject { @gemspec }
+      subject { YAML.load_file(@path.join('gemspec.yml')) }
 
       it "should have a name" do
-        subject['name'].should == 'my-project'
+        subject['name'].should == name
       end
 
       it "should not contain a version by default" do
@@ -56,72 +89,117 @@ describe Generator do
       end
 
       it "should a dummy summary" do
-        subject['summary'].should_not be_empty
+        subject['summary'].should == Ore::Options::DEFAULT_SUMMARY
       end
 
-      it "should a description summary" do
-        subject['description'].should_not be_empty
+      it "should a dummy description" do
+        subject['description'].should == Ore::Options::DEFAULT_DESCRIPTION
       end
 
       it "should have a license" do
-        subject['license'].should == 'MIT'
+        subject['license'].should == Ore::Options::DEFAULT_LICENSE
       end
 
       it "should have authors" do
-        subject['authors'].should_not be_empty
+        subject['authors'].should == Ore::Options::DEFAULT_AUTHORS[0]
       end
 
       it "should have a dummy homepage" do
         subject['homepage'].should_not be_empty
       end
 
-      it "should have 'ore-tasks' as a development dependency" do
-        subject['development_dependencies'].should have_key('ore-tasks')
+      it "should have 'rubygems-tasks' as a development dependency" do
+        subject['development_dependencies'].should have_key('rubygems-tasks')
       end
     end
 
     it "should add a *.gemspec file" do
-      @path.join('my-project.gemspec').should be_file
+      @path.should have_file("#{name}.gemspec")
     end
 
-    it "should add a .document file" do
-      @path.join('.document').should be_file
+    describe "*.gemspec file" do
+      subject { @gemspec }
+
+      it_should_behave_like "a gemspec"
     end
+  end
 
-    it "should add a Rakefile" do
-      @path.join('Rakefile').should be_file
+  context "gemspec" do
+    let(:name) { 'gemspec_project' }
+
+    before(:all) do
+      generate!(name, :gemspec => true)
     end
 
-    it "should add a README.rdoc file" do
-      @path.join('README.rdoc').should be_file
+    it "should disable the gemspec_yml template" do
+      @generator.disabled_templates.should include(:gemspec_yml)
     end
 
-    it "should add a ChangeLog.rdoc file" do
-      @path.join('ChangeLog.rdoc').should be_file
+    it "should add a *.gemspec file" do
+      @path.should have_file("#{name}.gemspec")
     end
 
-    it "should add a LICENSE.txt file" do
-      @path.join('LICENSE.txt').should be_file
+    context "*.gemspec file" do
+      subject { @gemspec }
+
+      it_should_behave_like "a gemspec"
+
+      it "should have 'rubygems-tasks' as a development dependency" do
+        subject.should have_development_dependency('rubygems-tasks')
+      end
+    end
+  end
+
+  context "git" do
+    let(:name)   { 'git-project'      }
+
+    before(:all) do
+      generate!(name, :git => true)
+    end
+
+    it "should create a .git directory" do
+      @path.should have_directory('.git')
+    end
+
+    it "should create a .gitignore file" do
+      @path.should have_file('.gitignore')
+    end
+  end
+
+  context "hg" do
+    let(:name)   { 'hg-project'      }
+
+    before(:all) do
+      generate!(name, :hg => true)
+    end
+
+    it "should create a .hg directory" do
+      @path.should have_directory('.hg')
+    end
+
+    it "should create a .hgignore file" do
+      @path.should have_file('.hgignore')
     end
   end
 
   context "bin" do
-    let(:name) { 'script-project' }
+    let(:name)   { 'script-project'      }
+    let(:script) { File.join('bin',name) }
 
     before(:all) do
       generate!(name, :bin => true)
     end
 
     it "should add a 'bin/' directory" do
-      @path.join('bin').should be_directory
+      @path.should have_directory('bin')
     end
 
     it "should add a bin/script-project file" do
-      @path.join('bin',name).should be_file
+      @path.should have_file(script)
     end
 
     it "should make the bin/script-project file executable" do
-      @path.join('bin',name).should be_executable
+      @path.should have_executable(script)
     end
   end
 
@@ -133,7 +211,7 @@ describe Generator do
     end
 
     it "should add a .gemtest file" do
-      @path.join('.gemtest').should be_file
+      @path.should have_file('.gemtest')
     end
   end
 
@@ -145,11 +223,11 @@ describe Generator do
     end
 
     it "should add a Gemfile" do
-      @path.join('Gemfile').should be_file
+      @path.should have_file('Gemfile')
     end
 
     it "should add 'bundler' as a development dependency" do
-      @gemspec['development_dependencies'].should have_key('bundler')
+      @gemspec.should have_development_dependency('bundler')
     end
 
     it "should add 'Gemfile.lock' to the .gitignore file" do
@@ -177,7 +255,7 @@ describe Generator do
     end
 
     it "should add a '.document' file" do
-      @path.join('.document').should be_file
+      @path.should have_file('.document')
     end
 
     context ".document" do
@@ -211,11 +289,11 @@ describe Generator do
     end
 
     it "should add a .yardopts file" do
-      @path.join('.yardopts').should be_file
+      @path.should have_file('.yardopts')
     end
 
     it "should add a '.document' file" do
-      @path.join('.document').should be_file
+      @path.should have_file('.document')
     end
 
     context ".document" do
@@ -249,11 +327,11 @@ describe Generator do
     end
 
     it "should add a README.md file" do
-      @path.join('README.md').should be_file
+      @path.should have_file('README.md')
     end
 
     it "should add a ChangeLog.md file" do
-      @path.join('ChangeLog.md').should be_file
+      @path.should have_file('ChangeLog.md')
     end
 
     it "should set --markup to markdown in .yardopts" do
@@ -269,11 +347,11 @@ describe Generator do
     end
 
     it "should add a README.tt file" do
-      @path.join('README.tt').should be_file
+      @path.should have_file('README.tt')
     end
 
     it "should add a ChangeLog.tt file" do
-      @path.join('ChangeLog.tt').should be_file
+      @path.should have_file('ChangeLog.tt')
     end
 
     it "should set --markup to textile in .yardopts" do
@@ -289,7 +367,7 @@ describe Generator do
     end
 
     it "should still add 'yard' as a development dependency" do
-      @gemspec['development_dependencies'].should have_key('yard')
+      @gemspec.should have_development_dependency('yard')
     end
   end
 
@@ -305,15 +383,15 @@ describe Generator do
     end
 
     it "should create the test/ directory" do
-      @path.join('test').should be_directory
+      @path.should have_directory('test')
     end
 
     it "should create the test/helper.rb file" do
-      @path.join('test','helper.rb').should be_file
+      @path.should have_file('test','helper.rb')
     end
 
     it "should add a single test_*.rb file" do
-      @path.join('test','test_test_unit_project.rb').should be_file
+      @path.should have_file('test','test_test_unit_project.rb')
     end
   end
 
@@ -329,27 +407,27 @@ describe Generator do
     end
 
     it "should not create the test/ directory" do
-      @path.join('test').should_not be_directory
+      @path.should_not have_directory('test')
     end
 
     it "should create the spec/ directory" do
-      @path.join('spec').should be_directory
+      @path.should have_directory('spec')
     end
 
     it "should add a spec_helper.rb file" do
-      @path.join('spec','spec_helper.rb').should be_file
+      @path.should have_file('spec','spec_helper.rb')
     end
 
     it "should add a single *_spec.rb file" do
-      @path.join('spec','rspec_project_spec.rb').should be_file
+      @path.should have_file('spec','rspec_project_spec.rb')
     end
 
     it "should add a .rspec file" do
-      @path.join('.rspec').should be_file
+      @path.should have_file('.rspec')
     end
 
     it "should add 'rspec' as a development dependency" do
-      @gemspec['development_dependencies'].should have_key('rspec')
+      @gemspec.should have_development_dependency('rspec')
     end
   end
 
@@ -361,7 +439,7 @@ describe Generator do
     end
 
     it "should not add 'rspec' as a development dependency" do
-      @gemspec['development_dependencies'].should_not have_key('rspec')
+      @gemspec.should_not have_development_dependency('rspec')
     end
   end
 
@@ -372,12 +450,16 @@ describe Generator do
       generate!(name, :jeweler_tasks => true)
     end
 
-    it "should disable the ore_tasks template" do
-      @generator.disabled_templates.should include(:ore_tasks)
+    it "should disable the rubygems_tasks template" do
+      @generator.disabled_templates.should include(:rubygems_tasks)
+    end
+
+    it "should disable the bundler_tasks template" do
+      @generator.disabled_templates.should include(:bundler_tasks)
     end
 
     it "should add 'jeweler' as a development dependency" do
-      @gemspec['development_dependencies'].should have_key('jeweler')
+      @gemspec.should have_development_dependency('jeweler')
     end
   end
 
@@ -389,43 +471,79 @@ describe Generator do
     end
 
     it "should not add 'jeweler' as a development dependency" do
-      @gemspec['development_dependencies'].should_not have_key('jeweler')
+      @gemspec.should_not have_development_dependency('jeweler')
     end
   end
 
-  context "ore tasks" do
-    let(:name) { 'ore_project' }
+  context "rubygems-tasks" do
+    let(:name) { 'rubygems_tasks_project' }
 
     before(:all) do
-      generate!(name, :ore_tasks => true)
+      generate!(name, :rubygems_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')
+    it "should disable the bundler_tasks template" do
+      @generator.disabled_templates.should include(:bundler_tasks)
     end
 
-    it "should add 'ore-tasks' as a development dependency" do
-      @gemspec['development_dependencies'].should have_key('ore-tasks')
+    it "should add 'rubygems-tasks' as a development dependency" do
+      @gemspec.should have_development_dependency('rubygems-tasks')
     end
   end
 
-  context "ore tasks with bundler" do
+  context "rubygems-tasks with bundler" do
     let(:name) { 'bundled_ore_project' }
 
     before(:all) do
-      generate!(name, :bundler => true, :ore_tasks => true)
+      generate!(name, :bundler => true, :rubygems_tasks => true)
+    end
+
+    it "should not add 'rubygems-tasks' as a development dependency" do
+      @gemspec.should_not have_development_dependency('rubygems-tasks')
     end
+  end
+
+  context "bundler_tasks" do
+    let(:name) { 'bundler_tasks_project' }
 
-    it "should omit 'ore-core' as a development dependency" do
-      @gemspec['development_dependencies'].should_not have_key('ore-core')
+    before(:all) do
+      generate!(name, :bundler_tasks => true)
+    end
+
+    it "should disable the jeweler_tasks template" do
+      @generator.disabled_templates.should include(:jeweler_tasks)
+    end
+
+    it "should disable the rubygems_tasks template" do
+      @generator.disabled_templates.should include(:rubygems_tasks)
+    end
+
+    it "should enable the bundler template" do
+      @generator.enabled_templates.should include(:bundler)
+    end
+  end
+
+  context "gem_package_task" do
+    let(:name) { 'gem_package_task_project' }
+
+    before(:all) do
+      generate!(name, :gem_package_task => true)
+    end
+
+    it "should disable the rubygems_tasks template" do
+      @generator.disabled_templates.should include(:rubygems_tasks)
+    end
+
+    it "should disable the jeweler_tasks template" do
+      @generator.disabled_templates.should include(:jeweler_tasks)
     end
 
-    it "should not add 'ore-tasks' as a development dependency" do
-      @gemspec['development_dependencies'].should_not have_key('ore-tasks')
+    it "should disable the bundler_tasks template" do
+      @generator.disabled_templates.should include(:bundler_tasks)
     end
   end