ore 0.2.2 → 0.2.3

data/ChangeLog.md

@@ -1,3 +1,16 @@
+### 0.2.3 / 2010-11-01
+
+* Fixed path interpolation on Windows:
+  * Windows does not allow the `:` character in paths, so path interpolation
+    keywords are now wrapped in `[` and `]` characters.
+
+        interpolate("[name].gemspec")
+        # => "my-project.gemspec"
+
+* Do not include `ore-tasks` as a developmnet dependency in generated
+  projects that also use Bundler.
+* Added more specs to {Ore::Generator} and the builtin templates.
+
 ### 0.2.2 / 2010-10-30
 
 * Added {Ore::Project#root}.

data/data/ore/templates/ore_tasks/_dependencies.erb

@@ -1 +1,3 @@
+<%- unless bundler? -%>
   ore-tasks: <%= @ore_tasks_dependency %>
+<%- end -%>

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.2.2
+version: 0.2.3
 summary: Mine raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the

data/lib/ore/template/interpolations.rb

@@ -4,10 +4,10 @@ module Ore
     # Handles the expansion of paths and substitution of path keywords.
     # The following keywords are supported:
     #
-    # * `:name:` - The name of the project.
-    # * `:project_dir:` - The directory base-name derived from the project
+    # * `[name]` - The name of the project.
+    # * `[project_dir]` - The directory base-name derived from the project
     #   name.
-    # * `:namespace_dir:` - The full directory path derived from the
+    # * `[namespace_dir]` - The full directory path derived from the
     #   project name.
     #
     module Interpolations
@@ -31,18 +31,18 @@ module Ore
       #   The expanded path.
       #
       # @example Assuming `@project_dir` contains `my_project`.
-      #   interpolate "lib/:project_dir:.rb"
+      #   interpolate("lib/[project_dir].rb")
       #   # => "lib/my_project.rb"
       #
       # @example Assuming `@namespace_dir` contains `my/project`.
-      #   interpolate "spec/:namespace_dir:_spec.rb"
+      #   interpolate("spec/[namespace_dir]_spec.rb")
       #   # => "spec/my/project_spec.rb"
       #
       def interpolate(path)
         dirs = path.split(File::SEPARATOR)
 
         dirs.each do |dir|
-          dir.gsub!(/(:[a-z_]+:)/) do |capture|
+          dir.gsub!(/(\[[a-z_]+\])/) do |capture|
             keyword = capture[1..-2]
 
             if @@keywords.include?(keyword)

data/spec/generator_spec.rb

@@ -0,0 +1,287 @@
+require 'spec_helper'
+require 'helpers/generator'
+require 'ore/generator'
+
+describe Generator do
+  include Helpers::Generator
+
+  context "default" do
+    let(:name) { 'my-project' }
+
+    before(:all) do
+      generate!(name)
+    end
+
+    it "should create the project root directory" do
+      @path.should be_directory
+    end
+
+    it "should create the lib/ directory" do
+      @path.join('lib').should be_directory
+    end
+
+    it "should create a file to load the project within lib/" do
+      @path.join('lib','my','project.rb').should be_file
+    end
+
+    it "should create a namespace directory within lib/" do
+      @path.join('lib','my','project').should be_directory
+    end
+
+    it "should create a version.rb file within the namespace directory" do
+      @path.join('lib','my','project','version.rb').should be_file
+    end
+
+    it "should not create the bin/ directory by default" do
+      @path.join('bin').should_not be_directory
+    end
+
+    it "should create a test/ directory by default" do
+      @path.join('test').should_not be_directory
+    end
+
+    it "should create a gemspec.yml file" do
+      @path.join('gemspec.yml').should be_file
+    end
+
+    describe "gemspec.yml" do
+      subject { @gemspec }
+
+      it "should have a name" do
+        subject['name'].should == 'my-project'
+      end
+
+      it "should not contain a version by default" do
+        subject.should_not have_key('version')
+      end
+
+      it "should a dummy summary" do
+        subject['summary'].should_not be_empty
+      end
+
+      it "should a description summary" do
+        subject['description'].should_not be_empty
+      end
+
+      it "should have a license" do
+        subject['license'].should == 'MIT'
+      end
+
+      it "should have authors" do
+        subject['authors'].should_not be_empty
+      end
+
+      it "should have a dummy homepage" do
+        subject['homepage'].should_not be_empty
+      end
+
+      it "should have 'ore' as a development dependency" do
+        subject['development_dependencies'].should have_key('ore')
+      end
+    end
+
+    it "should add a *.gemspec file" do
+      @path.join('my-project.gemspec').should be_file
+    end
+
+    it "should add a .document file" do
+      @path.join('.document').should be_file
+    end
+
+    it "should add a Rakefile" do
+      @path.join('Rakefile').should be_file
+    end
+
+    it "should add a README.rdoc file" do
+      @path.join('README.rdoc').should be_file
+    end
+
+    it "should add a ChangeLog.rdoc file" do
+      @path.join('ChangeLog.rdoc').should be_file
+    end
+
+    it "should add a LICENSE.txt file" do
+      @path.join('LICENSE.txt').should be_file
+    end
+  end
+
+  context "bundler" do
+    let(:name) { 'bundled_project' }
+
+    before(:all) do
+      generate!(name, :bundler => true)
+    end
+
+    it "should add a Gemfile" do
+      @path.join('Gemfile').should be_file
+    end
+
+    it "should add 'bundler' as a development dependency" do
+      @gemspec['development_dependencies'].should have_key('bundler')
+    end
+  end
+
+  context "yard" do
+    let(:name) { 'yard-project' }
+
+    before(:all) do
+      generate!(name, :yard => true)
+    end
+
+    it "should add a .yardopts file" do
+      @path.join('.yardopts').should be_file
+    end
+
+    it "should set 'has_yard' to 'true' in the gemspec.yml file" do
+      @gemspec['has_yard'].should == true
+    end
+  end
+
+  context "yard with markdown" do
+    let(:name) { 'yard_markdown-project' }
+
+    before(:all) do
+      generate!(name, :yard => true, :markdown => true)
+    end
+
+    it "should add a README.md file" do
+      @path.join('README.md').should be_file
+    end
+
+    it "should add a ChangeLog.md file" do
+      @path.join('ChangeLog.md').should be_file
+    end
+
+    it "should set --markup to markdown in .yardopts" do
+      yard_opts.should include('--markup markdown')
+    end
+  end
+
+  context "yard with textile" do
+    let(:name) { 'yard_textile-project' }
+
+    before(:all) do
+      generate!(name, :yard => true, :textile => true)
+    end
+
+    it "should add a README.tt file" do
+      @path.join('README.tt').should be_file
+    end
+
+    it "should add a ChangeLog.tt file" do
+      @path.join('ChangeLog.tt').should be_file
+    end
+
+    it "should set --markup to textile in .yardopts" do
+      yard_opts.should include('--markup textile')
+    end
+  end
+
+  context "yard with bundler" do
+    let(:name) { 'bundled_yard_project' }
+
+    before(:all) do
+      generate!(name, :bundler => true, :yard => true)
+    end
+
+    it "should still add 'yard' as a development dependency" do
+      @gemspec['development_dependencies'].should have_key('yard')
+    end
+  end
+
+  context "rspec" do
+    let(:name) { 'rspec_project' }
+
+    before(:all) do
+      generate!(name, :rspec => true)
+    end
+
+    it "should not create the test/ directory" do
+      @path.join('test').should_not be_directory
+    end
+
+    it "should create the spec/ directory" do
+      @path.join('spec').should be_directory
+    end
+
+    it "should add a spec_helper.rb file" do
+      @path.join('spec','spec_helper.rb').should be_file
+    end
+
+    it "should add a single *_spec.rb file" do
+      @path.join('spec','rspec_project_spec.rb').should be_file
+    end
+
+    it "should add a .rspec file" do
+      @path.join('.rspec').should be_file
+    end
+
+    it "should add 'rspec' as a development dependency" do
+      @gemspec['development_dependencies'].should have_key('rspec')
+    end
+  end
+
+  context "rspec with bundler" do
+    let(:name) { 'bundled_rspec_project' }
+
+    before(:all) do
+      generate!(name, :bundler => true, :rspec => true)
+    end
+
+    it "should not add 'rspec' as a development dependency" do
+      @gemspec['development_dependencies'].should_not have_key('rspec')
+    end
+  end
+
+  context "jeweler tasks" do
+    let(:name) { 'jewelery_project' }
+
+    before(:all) do
+      generate!(name, :jeweler_tasks => true)
+    end
+
+    it "should add 'jeweler' as a development dependency" do
+      @gemspec['development_dependencies'].should have_key('jeweler')
+    end
+  end
+
+  context "jeweler tasks with bundler" do
+    let(:name) { 'bundled_jewelery_project' }
+
+    before(:all) do
+      generate!(name, :bundler => true, :jeweler_tasks => true)
+    end
+
+    it "should not add 'jeweler' as a development dependency" do
+      @gemspec['development_dependencies'].should_not have_key('jeweler')
+    end
+  end
+
+  context "ore tasks" do
+    let(:name) { 'ore_project' }
+
+    before(:all) do
+      generate!(name, :ore_tasks => true)
+    end
+
+    it "should add 'ore-tasks' as a development dependency" do
+      @gemspec['development_dependencies'].should have_key('ore-tasks')
+    end
+  end
+
+  context "ore tasks with bundler" do
+    let(:name) { 'bundled_ore_project' }
+
+    before(:all) do
+      generate!(name, :bundler => true, :ore_tasks => true)
+    end
+
+    it "should not add 'ore-tasks' as a development dependency" do
+      @gemspec['development_dependencies'].should_not have_key('ore-tasks')
+    end
+  end
+
+  after(:all) do
+    cleanup!
+  end
+end

data/spec/helpers/generator.rb

@@ -0,0 +1,34 @@
+require 'tempfile'
+require 'pathname'
+require 'yaml'
+require 'fileutils'
+
+module Helpers
+  module Generator
+    ROOT = File.join(Dir.tmpdir,'ore')
+
+    def generate!(path,options={})
+      path = File.join(ROOT,path)
+
+      Ore::Generator.new(
+        [path],
+        options.merge(:quiet => true)
+      ).invoke_all
+
+      @path = Pathname.new(path)
+      @gemspec = YAML.load_file(@path.join('gemspec.yml'))
+    end
+
+    def rspec_opts
+      @path.join('.rspec').read
+    end
+
+    def yard_opts
+      @path.join('.yardopts').read
+    end
+
+    def cleanup!
+      FileUtils.rm_r(ROOT)
+    end
+  end
+end

data/spec/helpers/projects/{dm-plugin/dm-plugin.gemspec → dm-is-plugin/dm-is-plugin.gemspec}

@@ -5,6 +5,6 @@ begin
     # custom logic here
   end
 rescue NameError
-  STDERR.puts "The 'my-project.gemspec' file requires Ore."
+  STDERR.puts "The 'dm-is-plugin.gemspec' file requires Ore."
   STDERR.puts "Run `gem install ore` to install Ore."
 end

data/spec/helpers/projects/{dm-plugin → dm-is-plugin}/gemspec.yml

@@ -1,4 +1,4 @@
-name: dm-plugin
+name: dm-is-plugin
 summary: DataMapper Plugin
 description: A plugin for DataMapper
 authors: Dan Kubb

data/spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-plugin/is/plugin'
+
+DataMapper::Model.append_extensions DataMapper::Is::Plugin

data/spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin/is/plugin.rb

@@ -0,0 +1,6 @@
+module DataMapper
+  module Is
+    module Plugin
+    end
+  end
+end

data/spec/projects/dm_plugin_project_spec.rb

@@ -6,17 +6,17 @@ describe "DataMapper Plugin project" do
   include Helpers::Projects
 
   before(:all) do
-    @project = project('dm-plugin')
+    @project = project('dm-is-plugin')
   end
 
   it_should_behave_like 'an Ore Project'
 
   it "should correctly guess the namespace" do
-    @project.namespace.should == 'DataMapper::Plugin'
+    @project.namespace.should == 'DataMapper::Is::Plugin'
   end
 
   it "should have a namespace directory" do
-    @project.namespace_dir.should == 'dm-plugin'
+    @project.namespace_dir.should == 'dm-is-plugin'
   end
 
   it "should use Bundler" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 -07:00
+date: 2010-11-01 00:00:00 -07:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,7 +87,6 @@ files:
 - bin/ore
 - data/ore/templates/base/.document
 - data/ore/templates/base/.gitignore.erb
-- data/ore/templates/base/:name:.gemspec.erb
 - data/ore/templates/base/ChangeLog.md.erb
 - data/ore/templates/base/ChangeLog.rdoc.erb
 - data/ore/templates/base/ChangeLog.tt.erb
@@ -96,10 +95,11 @@ files:
 - data/ore/templates/base/README.rdoc.erb
 - 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/gemspec.yml.erb
-- data/ore/templates/base/lib/:namespace_dir:.rb.erb
-- data/ore/templates/base/lib/:namespace_dir:/version.rb.erb
+- data/ore/templates/base/lib/[namespace_dir].rb.erb
+- data/ore/templates/base/lib/[namespace_dir]/version.rb.erb
 - data/ore/templates/base/template.yml
 - data/ore/templates/bundler/Gemfile.erb
 - data/ore/templates/bundler/_dependencies.erb
@@ -117,11 +117,11 @@ files:
 - data/ore/templates/rspec/_dependencies.erb
 - data/ore/templates/rspec/_gemfile.erb
 - data/ore/templates/rspec/_tasks.erb
-- data/ore/templates/rspec/spec/:namespace_dir:_spec.rb.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/test_unit/test/helper.rb.erb
-- data/ore/templates/test_unit/test/test_:name:.rb.erb
+- data/ore/templates/test_unit/test/test_[name].rb.erb
 - data/ore/templates/yard/.yardopts.erb
 - data/ore/templates/yard/_dependencies.erb
 - data/ore/templates/yard/_gemfile.erb
@@ -162,16 +162,19 @@ files:
 - ore.gemspec
 - spec/dependency_spec.rb
 - spec/document_file_spec.rb
+- spec/generator_spec.rb
 - spec/helpers/files.rb
 - spec/helpers/files/.document
 - spec/helpers/files/VERSION
 - spec/helpers/files/VERSION.yml
+- spec/helpers/generator.rb
 - spec/helpers/projects.rb
-- spec/helpers/projects/dm-plugin/Gemfile
-- spec/helpers/projects/dm-plugin/VERSION
-- spec/helpers/projects/dm-plugin/dm-plugin.gemspec
-- spec/helpers/projects/dm-plugin/gemspec.yml
-- spec/helpers/projects/dm-plugin/lib/dm-plugin.rb
+- spec/helpers/projects/dm-is-plugin/Gemfile
+- spec/helpers/projects/dm-is-plugin/VERSION
+- spec/helpers/projects/dm-is-plugin/dm-is-plugin.gemspec
+- spec/helpers/projects/dm-is-plugin/gemspec.yml
+- spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin.rb
+- spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin/is/plugin.rb
 - spec/helpers/projects/explicit/gemspec.yml
 - spec/helpers/projects/explicit/lib/explicit/version.rb
 - spec/helpers/projects/ffi-binding/gemspec.yml
@@ -230,6 +233,7 @@ test_files:
 - spec/dependency_spec.rb
 - spec/naming_spec.rb
 - spec/document_file_spec.rb
+- spec/generator_spec.rb
 - spec/versions/version_spec.rb
 - spec/versions/version_file_spec.rb
 - spec/projects/jeweler_project_spec.rb

data/spec/helpers/projects/dm-plugin/lib/dm-plugin.rb

@@ -1 +0,0 @@
-require 'dm-core'