ore 0.4.1 → 0.5.0

data/ChangeLog.md

@@ -1,3 +1,21 @@
+### 0.5.0 / 2011-01-19
+
+* Require ore-core ~> 0.1.1.
+* Require rspec ~> 2.4.0.
+* Load default options from `~/.ore/options.yml`.
+* Added the `gem_test` template and `--gem-test` to {Ore::Generator}.
+  This opts-in projects to be tested via the `gem test` command.
+* Auto-define options in {Ore::Generator} for builtin templates.
+* Added `lib/ore.rb`.
+* Added {Ore::Config.enable!}.
+* Added {Ore::Config.disable!}.
+* Added {Ore::Config.default_options}.
+* Added {Ore::Generator.defaults}.
+* Added {Ore::Generator.generator_option}.
+* Added `vendor/cache/*.gem` to `.gitignore` if `--bundler` is specified.
+* Attempt to auto-load `ore/specification` in the generated `*.gemspec`
+  files.
+
 ### 0.4.1 / 2010-12-17
 
 * Added a post-install message.

data/README.md

@@ -33,7 +33,7 @@ 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
+* [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1.1
 * [thor](http://github.com/wycats/thor) ~> 0.14.3
 
 ## Install
@@ -45,7 +45,7 @@ the developer to keep all of the project information in a single YAML file.
 The `gemspec.yml` file used to build Ore:
 
     name: ore
-    version: 0.4.1
+    version: 0.5.0
     summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
@@ -75,12 +75,12 @@ The `gemspec.yml` file used to build Ore:
       **************************************************************************
     
     dependencies:
-      ore-core: ~> 0.1.0
+      ore-core: ~> 0.1.1
       thor: ~> 0.14.3
     
     development_dependencies:
       ore-tasks: ~> 0.3.0
-      rspec: ~> 2.3.0
+      rspec: ~> 2.4.0
       yard: ~> 0.6.1
 
 For a complete refrence to the `gemspec.yml` file, please see the
@@ -112,6 +112,16 @@ Generate a new project using previously installed templates:
 
     $ mine myproj --bundler --rspec --yard -T awesometest
 
+Add default generator options to `~/.ore/options.yml`:
+
+    ore_tasks: true
+    rspec: true
+    yard: true
+    markdown: true
+    authors:
+      - Alice
+    email: alice@example.com
+
 Builds a `.gem` file in the `pkg/` directory of a project:
 
     $ ore

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

@@ -5,6 +5,11 @@ begin
     # custom logic here
   end
 rescue NameError
-  STDERR.puts "The '<%= @name %>.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore-core` to install Ore."
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The '<%= @name %>.gemspec' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
 end

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

@@ -1,3 +1,5 @@
+require 'ore/specification'
+
 source :rubygems
 
 gemspec

data/data/ore/templates/bundler/_gitignore.erb

@@ -1 +1,2 @@
 Gemfile.lock
+vendor/cache/*.gem

data/data/ore/templates/gem_test/_tasks.erb

@@ -0,0 +1,3 @@
+<%- if rspec? -%>
+task :test => :spec
+<%- end -%>

data/data/ore/templates/rspec/spec/[namespace_dir]_spec.rb.erb

@@ -3,6 +3,6 @@ require '<%= @namespace_path %>'
 
 describe <%= @namespace %> do
   it "should have a VERSION constant" do
-    <%= @namespace %>.const_get('VERSION').should_not be_empty
+    subject.const_get('VERSION').should_not be_empty
   end
 end

data/data/ore/templates/rspec/template.yml

@@ -1,4 +1,4 @@
 disable:
   - test_unit
 variables:
-  rspec_dependency: ~> 2.1.0
+  rspec_dependency: ~> 2.4.0

data/data/ore/templates/yard/_gemfile.erb

@@ -1,12 +1,6 @@
 <%- case @markup
     when :markdown -%>
-  platforms :jruby do
-    gem 'maruku'
-  end
-
-  platforms :ruby do
-    gem 'bluecloth', '>= 2.0.0'
-  end
+  gem 'kramdown'
 <%- when :textile -%>
   gem 'RedCloth'
 <%- end -%>

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.4.1
+version: 0.5.0
 summary: Mine raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the
@@ -29,10 +29,10 @@ post_install_message: |
   **************************************************************************
 
 dependencies:
-  ore-core: ~> 0.1.0
+  ore-core: ~> 0.1.1
   thor: ~> 0.14.3
 
 development_dependencies:
   ore-tasks: ~> 0.3.0
-  rspec: ~> 2.3.0
+  rspec: ~> 2.4.0
   yard: ~> 0.6.1

data/lib/ore.rb

@@ -0,0 +1,5 @@
+require 'ore-core'
+
+require 'ore/config'
+require 'ore/generator'
+require 'ore/cli'

data/lib/ore/config.rb

@@ -2,14 +2,17 @@ require 'pathname'
 
 module Ore
   module Config
+    # Specifies whether user settings will be loaded
+    @@enabled = true
+
     # The users home directory
     @@home = File.expand_path(ENV['HOME'] || ENV['HOMEPATH'])
 
     # Ore config directory
     @@path = File.join(@@home,'.ore')
 
-    # Default `ore` options file.
-    @@options_file = File.join(@@path,'default.opts')
+    # Default options file.
+    @@options_file = File.join(@@path,'options.yml')
 
     # Custom Ore Templates directory
     @@templates_dir = File.join(@@path,'templates')
@@ -17,6 +20,54 @@ module Ore
     # The `data/` directory for Ore
     @@data_dir = File.expand_path(File.join('..','..','data'),File.dirname(__FILE__))
 
+    #
+    # Enables access to user settings.
+    #
+    # @since 0.5.0
+    #
+    def Config.enable!
+      @@enabled = true
+    end
+
+    #
+    # Disables access to user settings.
+    #
+    # @since 0.5.0
+    #
+    def Config.disable!
+      @@enabled = false
+    end
+
+    #
+    # Loads the default options from `~/.ore/options.yml`.
+    #
+    # @return [Hash]
+    #   The loaded default options.
+    #
+    # @raise [RuntimeError]
+    #   The `~/.ore/options.yml` did not contain a YAML encoded Hash.
+    #
+    # @since 0.5.0
+    #
+    def Config.default_options
+      options = {}
+
+      if (@@enabled && File.file?(@@options_file))
+        new_options = YAML.load_file(@@options_file)
+
+        # default options must be a Hash
+        unless new_options.kind_of?(Hash)
+          raise("#{@@options_file} must contain a YAML encoded Hash")
+        end
+
+        new_options.each do |name,value|
+          options[name.to_sym] = value
+        end
+      end
+
+      return options
+    end
+
     #
     # The builtin templates.
     #
@@ -46,6 +97,8 @@ module Ore
     #   The path of a Ore template directory.
     #
     def Config.installed_templates
+      return unless @@enabled
+
       if File.directory?(@@templates_dir)
         Dir.glob("#{@@templates_dir}/*") do |template|
           yield template if File.directory?(template)

data/lib/ore/generator.rb

@@ -16,14 +16,11 @@ module Ore
     include Template::Interpolations
     include Template::Helpers
 
-    # The base template for all RubyGems
-    @@base_template = :base
-
     #
     # The templates registered with the generator.
     #
-    def Generator.templates
-      @templates ||= {}
+    def self.templates
+      @@templates ||= {}
     end
 
     #
@@ -32,51 +29,63 @@ module Ore
     # @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.
     #
-    def Generator.register_template(path)
+    def self.register_template(path)
       unless File.directory?(path)
         raise(StandardError,"#{path.dump} is must be a directory")
       end
 
       name = File.basename(path).to_sym
-      Generator.templates[name] = path
-    end
 
-    Config.builtin_templates { |path| Generator.register_template(path) }
-    Config.installed_templates { |path| Generator.register_template(path) }
+      self.templates[name] = path
+      return name
+    end
 
-    namespace ''
+    #
+    # Default options for the generator.
+    #
+    # @return [Hash{Symbol => Object}]
+    #   The option names and default values.
+    #
+    # @since 0.5.0
+    #
+    def self.defaults
+      @@defaults ||= {
+        :templates => [],
+        :version => '0.1.0',
+        :summary => 'TODO: Summary',
+        :description => 'TODO: Description',
+        :license => 'MIT',
+        :authors => [ENV['USER']],
+        :rdoc => true,
+        :rspec => true,
+        :git => true
+      }
+    end
 
-    class_option :markdown, :type => :boolean, :default => false
-    class_option :textile, :type => :boolean, :default => false
-    class_option :templates, :type => :array,
-                             :default => [],
-                             :aliases => '-T'
-    class_option :name, :type => :string, :aliases => '-n'
-    class_option :version, :type => :string,
-                            :default => '0.1.0',
-                            :aliases => '-V'
-    class_option :summary, :default => 'TODO: Summary',
-                           :aliases => '-s'
-    class_option :description, :default => 'TODO: Description',
-                               :aliases => '-D'
-    class_option :license, :default => 'MIT', :aliases => '-L'
-    class_option :homepage, :type => :string, :aliases => '-U'
-    class_option :email, :type => :string, :aliases => '-e'
-    class_option :authors, :type => :array,
-                           :default => [ENV['USER']], :aliases => '-a'
-    class_option :rdoc, :type => :boolean, :default => true
-    class_option :yard, :type => :boolean, :default => false
-    class_option :test_unit, :type => :boolean, :default => false
-    class_option :rspec, :type => :boolean, :default => true
-    class_option :bundler, :type => :boolean, :default => false
-    class_option :jeweler_tasks, :type => :boolean, :default => false
-    class_option :ore_tasks, :type => :boolean, :default => false
-    class_option :git, :type => :boolean, :default => true
-    argument :path, :required => true
+    #
+    # Defines a generator option.
+    #
+    # @param [Symbol] name
+    #   The name of the option.
+    #
+    # @param [Hash{Symbol => Object}] options
+    #   The Thor options of the option.
+    #
+    # @since 0.5.0
+    #
+    def self.generator_option(name,options={})
+      class_option(name,options.merge(:default => defaults[name]))
+    end
 
+    #
+    # Generates a new project.
+    #
     def generate
       self.destination_root = path
 
@@ -101,6 +110,48 @@ module Ore
 
     protected
 
+    # merge default options
+    defaults.merge!(Config.default_options)
+
+    # register builtin templates
+    Config.builtin_templates do |path|
+      name = register_template(path)
+
+      # 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)
+    end
+
+    # disable the Thor namespace
+    namespace ''
+
+    # define the options
+    generator_option :markdown, :type => :boolean
+    generator_option :textile, :type => :boolean
+    generator_option :templates, :type => :array,
+                                 :aliases => '-T',
+                                 :banner => 'TEMPLATE [...]'
+    generator_option :name, :type => :string, :aliases => '-n'
+    generator_option :version, :type => :string, :aliases => '-V'
+    generator_option :summary, :aliases => '-s'
+    generator_option :description, :aliases => '-D'
+    generator_option :authors, :type => :array,
+                               :aliases => '-a',
+                               :banner => 'NAME [...]'
+    generator_option :email, :type => :string, :aliases => '-e'
+    generator_option :homepage, :type => :string, :aliases => '-U'
+    generator_option :license, :aliases => '-L'
+    generator_option :git, :type => :boolean
+
+    argument :path, :required => true
+
     #
     # Enables a template, adding it to the generator.
     #
@@ -154,7 +205,7 @@ module Ore
         exit -1
       end
 
-      self.source_paths.delete(template_dir)
+      source_paths.delete(template_dir)
 
       @templates.delete_if { |template| template.path == template_dir }
       @enabled_templates.delete(name)
@@ -168,17 +219,12 @@ module Ore
       @templates = []
       @enabled_templates = []
       
-      enable_template(@@base_template)
-
-      enable_template(:bundler) if options.bundler?
-      enable_template(:jeweler_tasks) if options.jeweler_tasks?
-      enable_template(:ore_tasks) if options.ore_tasks?
-      
-      enable_template(:rspec) if options.rspec?
-      enable_template(:test_unit) if options.test_unit?
+      enable_template :base
 
-      enable_template(:yard) if options.yard?
-      enable_template(:rdoc) if options.rdoc?
+      # enable templates specified by options
+      self.class.templates.each_key do |name|
+        enable_template(name) if options[name]
+      end
 
       # enable any additionally specified templates
       options.templates.each { |name| enable_template(name) }

data/ore.gemspec

@@ -5,6 +5,11 @@ begin
     # custom logic here
   end
 rescue NameError
-  STDERR.puts "The 'ore.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore-core` to install Ore."
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The 'ore.gemspec' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
 end

data/spec/generator_spec.rb

@@ -105,6 +105,18 @@ describe Generator do
     end
   end
 
+  context "gem test" do
+    let(:name) { 'gem_test_project' }
+
+    before(:all) do
+      generate!(name, :gem_test => true)
+    end
+
+    it "should add a .gemtest file" do
+      @path.join('.gemtest').should be_file
+    end
+  end
+
   context "bundler" do
     let(:name) { 'bundled_project' }
 

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
-gem 'rspec', '~> 2.3.0'
+gem 'rspec', '~> 2.4.0'
 require 'rspec'
 
 gem 'ore-core', '~> 0.1.0'
 require 'ore/config'
+Ore::Config.disable!
 
 include Ore

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 -08:00
+date: 2011-01-19 00:00:00 -08:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,8 @@ dependencies:
         segments: 
         - 0
         - 1
-        - 0
-        version: 0.1.0
+        - 1
+        version: 0.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -72,9 +72,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 3
+        - 4
         - 0
-        version: 2.3.0
+        version: 2.4.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -133,6 +133,8 @@ files:
 - data/ore/templates/bundler/_development_dependencies.erb
 - data/ore/templates/bundler/_gitignore.erb
 - data/ore/templates/bundler/template.yml
+- data/ore/templates/gem_test/.gemtest
+- data/ore/templates/gem_test/_tasks.erb
 - data/ore/templates/jeweler_tasks/_development_dependencies.erb
 - data/ore/templates/jeweler_tasks/_gemfile.erb
 - data/ore/templates/jeweler_tasks/_tasks.erb
@@ -158,6 +160,7 @@ files:
 - data/ore/templates/yard/_tasks.erb
 - data/ore/templates/yard/template.yml
 - gemspec.yml
+- lib/ore.rb
 - lib/ore/cli.rb
 - lib/ore/config.rb
 - lib/ore/generator.rb