ore 0.9.2 → 0.9.3

data/ChangeLog.md

@@ -1,3 +1,23 @@
+### 0.9.3 / 2012-05-28
+
+* Added the following template variables to {Ore::Generator}:
+  * `@scm_user` - The username used by the SCM.
+  * `@scm_email` - The email address used by the SCM.
+  * `@uri` - The URI parsed from the `@homepage` variable.
+  * `@markup_ext` - The file-extension used by the markup.
+* Support autodetecting the user name by invoking `git config user.name` or
+  `hg showconfig ui.username`.
+* Support autodetecting the email address by invoking `git config user.email` or
+  `hg showconfig ui.username`.
+
+#### Templates
+
+* Further simplified the `[name].gemspec` file in the [gemspec_yml]
+  template.
+  * Also fixed a small typo that set `gemspec.required_rubygems_version` to
+    the value of `required_ruby_version` from the `gemspec.yml` file.
+* Fixed the `ChangeLog` entry in the `.document` file, from the [yard] template.
+
 ### 0.9.2 / 2012-05-21
 
 #### Templates

data/GemspecYML.md

@@ -11,8 +11,7 @@ The name of the project can be listed like so:
 
     name: foo
 
-If the name is not listed, Ore will use the base-name of the project
-directory.
+The name of the project must be specified.
 
 ## version
 

data/data/ore/templates/gemspec/[name].gemspec.erb

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
 <%- if @email -%>
   gem.email         = <%= @email.inspect %>
 <%- end -%>
-  gem.homepage      = <%= @homepage.to_s.inspect %>
+  gem.homepage      = <%= @homepage.inspect %>
 
 <%- if git? -%>
   gem.files         = `git ls-files`.split($/)
@@ -25,23 +25,23 @@ Gem::Specification.new do |gem|
 <%- end -%>
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 <%- unless @dependencies.empty? -%>
 
 <%-   @dependencies.each do |name,version| -%>
-  gem.add_dependency <%= name.inspect %>, <%= version.inspect %>
+  gem.add_dependency '<%= name %>', '<%= version %>'
 <%-   end -%>
 <%- end -%>
 
 <%- if bundler? -%>
-  gem.add_development_dependency "bundler", <%= @development_dependencies['bundler'].inspect %>
+  gem.add_development_dependency 'bundler', '<%= @development_dependencies['bundler'] %>'
 <%-   if yard? -%>
-  gem.add_development_dependency "yard", <%= @development_dependencies['yard'].inspect %>
+  gem.add_development_dependency 'yard', '<%= @development_dependencies['yard'] %>'
 <%-   end -%>
 <%- else -%>
 <%-   unless @development_dependencies.empty? -%>
 <%-     @development_dependencies.each do |name,version| -%>
-  gem.add_development_dependency <%= name.inspect %>, <%= version.inspect %>
+  gem.add_development_dependency '<%= name%>', '<%= version %>'
 <%-     end -%>
 <%-   end -%>
 <%- end -%>end

data/data/ore/templates/gemspec_yml/[name].gemspec.erb

@@ -2,111 +2,71 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  root    = File.dirname(__FILE__)
-  lib_dir = File.join(root,'lib')
-<%- if git? -%>
-  files   = `git ls-files`.split($/)
-<%- elsif hg? -%>
-  files   = `hg manifest`.split($/)
-<%- elsif svn? -%>
-  files   = `svn ls -R`.split($/).select { |path| File.file?(path) }
-<%- else -%>
-  files   = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-<%- end -%>
-
-  filter_files = lambda { |paths|
-    files & case paths
-            when Array
-              paths
-            when String
-              Dir[paths]
-            end
-  }
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  version = {
-    :file     => '<%= @namespace_path %>/version',
-    :constant => '<%= @namespace %>::VERSION'
-  }
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  defaults = {
-    'name'            => File.basename(root),
-    '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}'],
-    'doc_files'       => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}']
-  }
+                  require '<%= @namespace_path %>/version'
+                  <%= @namespace %>::VERSION
+                end
 
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
 
-  gemspec.name    = metadata['name']
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    else
-                      $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-                      require version[:file]
-                      eval(version[:constant])
-                    end
-
-  gemspec.summary     = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
-
-  gemspec.licenses = Array(metadata['license'])
-  gemspec.authors  = Array(metadata['authors'])
-
-  gemspec.email    = metadata['email']
-  gemspec.homepage = metadata['homepage']
-
-  gemspec.require_paths = Array(metadata['require_paths'])
-  gemspec.files         = filter_files[metadata['files']]
-  gemspec.executables   = metadata['executables']
-  gemspec.extensions    = metadata['extensions']
+<%- if git? -%>
+  gem.files = `git ls-files`.split($/)
+<%- elsif hg? -%>
+  gem.files = `hg manifest`.split($/)
+<%- elsif svn? -%>
+  gem.files = `svn ls -R`.split($/).select { |path| File.file?(path) }
+<%- else -%>
+  gem.files = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+<%- end -%>
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-  if Gem::VERSION < '1.7.'
-    gemspec.default_executable = gemspec.executables.first
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  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']
-
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+<%- if rspec? -%>
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+<%- elsif test_unit? -%>
+  gem.test_files       = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb}']
+<%- end -%>
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,<%= @markup_ext %>}']
 
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

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

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

data/data/ore/templates/yard/.document.erb

@@ -1,3 +1,3 @@
 - 
-ChangeLog.<%= @markup %>
+ChangeLog.<%= @markup_ext || '*' %>
 LICENSE.txt

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.9.2
+version: 0.9.3
 summary: Mine beautiful RubyGems from Ore
 description:
   Ore is a flexible Ruby project generator. Unlike other Ruby project

data/lib/ore/generator.rb

@@ -207,6 +207,26 @@ module Ore
       @project_dir = File.basename(@root)
       @name        = (options.name || @project_dir)
 
+      @scm = if File.directory?(File.join(@root,'.git'))    then :git
+             elsif File.directory?(File.join(@root,'.hg'))  then :hg
+             elsif File.directory?(File.join(@root,'.svn')) then :svn
+             elsif options.hg?  then :hg
+             elsif options.git? then :git
+             end
+
+      case @scm
+      when :git
+        @scm_user  = `git config user.name`.chomp
+        @scm_email = `git config user.email`.chomp
+
+        @github_user = `git config github.user`.chomp
+      when :hg
+        user_email = `hg showconfig ui.username`.chomp
+        user_email.scan(/([^<]+)\s+<([^>]+)>/) do |(user,email)|
+          @scm_user, @scm_email = user, email
+        end
+      end
+
       @modules      = modules_of(@name)
       @module_depth = @modules.length
       @module       = @modules.last
@@ -220,45 +240,33 @@ module Ore
       @summary     = options.summary
       @description = options.description
       @license     = options.license
-      @authors     = options.authors
+
+      @authors     = (options.authors || [@scm_user || ENV['USER']])
       @author      = @authors.first
-      @github_user = if options.git?
-                       `git config github.user`.chomp
-                     end
 
-      @email       = options.email
+      @email       = (options.email || @scm_email)
       @safe_email  = @email.sub('@',' at ') if @email
+
       @homepage    = if options.homepage
-                       URI(options.homepage)
+                       options.homepage
                      elsif !(@github_user.nil? || @github_user.empty?)
-                       URI("https://github.com/#{@github_user}/#{@name}#readme")
+                       "https://github.com/#{@github_user}/#{@name}#readme"
                      else
-                       URI("https://rubygems.org/gems/#{@name}")
+                       "https://rubygems.org/gems/#{@name}"
                      end
-      @bug_tracker = case @homepage.host
+      @uri         = URI(@homepage)
+      @bug_tracker = case @uri.host
                      when 'github.com'
-                       "https://#{@homepage.host}#{@homepage.path}/issues"
+                       "https://#{@uri.host}#{@uri.path}/issues"
                      end
 
-      @markup = if options.markdown?
-                  :markdown
-                elsif options.textile?
-                  :textile
-                else
-                  :rdoc
-                end
-
-      @scm = if File.directory?(File.join(@root,'.git'))
-               :git
-             elsif File.directory?(File.join(@root,'.hg'))
-               :hg
-             elsif File.directory?(File.join(@root,'.svn'))
-               :svn
-             elsif options.hg?
-               :hg
-             elsif options.git?
-               :git
-             end
+      @markup, @markup_ext = if options.markdown?
+                               [:markdown, 'md']
+                             elsif options.textile?
+                               [:textile, 'tt']
+                             else
+                               [:rdoc, 'rdoc']
+                             end
 
       @date  = Date.today
       @year  = @date.year
@@ -271,6 +279,7 @@ module Ore
 
       @templates.each do |template|
         @ignore.merge(template.ignore)
+
         @dependencies.merge!(template.dependencies)
         @development_dependencies.merge!(template.development_dependencies)
 

data/lib/ore/options.rb

@@ -20,9 +20,6 @@ module Ore
     # Default License
     DEFAULT_LICENSE = 'MIT'
 
-    # Default authors
-    DEFAULT_AUTHORS = [ENV['USER']]
-
     def self.included(base)
       base.extend ClassMethods
     end
@@ -40,7 +37,6 @@ module Ore
         :summary        => DEFAULT_SUMMARY,
         :description    => DEFAULT_DESCRIPTION,
         :license        => DEFAULT_LICENSE,
-        :authors        => DEFAULT_AUTHORS,
         :gemspec        => true,
         :rubygems_tasks => true,
         :rdoc           => true,

data/ore.gemspec

@@ -2,110 +2,59 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  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
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  filter_files = lambda { |paths|
-    files & case paths
-            when Array
-              paths
-            when String
-              Dir[paths]
-            end
-  }
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  version = {
-    :file     => 'ore/version.rb',
-    :constant => 'Ore::VERSION'
-  }
+                  require 'ore/version'
+                  Ore::VERSION
+                end
 
-  defaults = {
-    '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}']
-  }
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
 
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gemspec.name    = metadata['name']
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    else
-                      $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-                      require version[:file]
-                      eval(version[:constant])
-                    end
-
-  gemspec.summary     = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
-
-  gemspec.licenses = Array(metadata['license'])
-  gemspec.authors  = Array(metadata['authors'])
-
-  gemspec.email    = metadata['email']
-  gemspec.homepage = metadata['homepage']
-
-  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
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  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']
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
-
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

data/spec/gemspec_examples.rb

@@ -24,7 +24,7 @@ shared_examples "a gemspec" do
   end
 
   it "should have authors" do
-    subject.authors.should == Ore::Options::DEFAULT_AUTHORS
+    subject.authors.should_not be_empty
   end
 
   it "should have a dummy homepage" do

data/spec/generator_spec.rb

@@ -101,7 +101,7 @@ describe Generator do
       end
 
       it "should have authors" do
-        subject['authors'].should == Ore::Options::DEFAULT_AUTHORS[0]
+        subject['authors'].should_not be_empty
       end
 
       it "should have a dummy homepage" do
@@ -345,6 +345,12 @@ describe Generator do
     it "should set --markup to markdown in .yardopts" do
       yard_opts.should include('--markup markdown')
     end
+
+    context ".document" do
+      it "should include 'ChangeLog.md'" do
+        document.should include('ChangeLog.md')
+      end
+    end
   end
 
   context "yard with textile" do
@@ -365,6 +371,12 @@ describe Generator do
     it "should set --markup to textile in .yardopts" do
       yard_opts.should include('--markup textile')
     end
+
+    context ".document" do
+      it "should include 'ChangeLog.tt'" do
+        document.should include('ChangeLog.tt')
+      end
+    end
   end
 
   context "yard with bundler" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ore
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2012-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -200,6 +200,4 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Mine beautiful RubyGems from Ore
-test_files:
-- spec/generator_spec.rb
-- spec/naming_spec.rb
+test_files: []