ore 0.5.0 → 0.6.0

data/ChangeLog.md

@@ -1,3 +1,24 @@
+### 0.6.0 / 2011-02-12
+
+* Require ore-core ~> 0.1.2.
+* Opted into [gem-testers.org](http://gem-testers.org/).
+* Added the `rvmrc` template and `--rvmrc` option to {Ore::Generator}:
+  * Generates an `.rvmrc` file that creates a new gemset for the project
+    and supports Bundler.
+* Added `mailto:` to the `Email` links in the generated `README` files.
+* Renamed the `ore cut` command to `ore gem`.
+* Use `__FILE__` instead of hard-coding the file name into the generated
+  `.gemspec` file.
+* No longer necessary to require `ore/specification` in the generated
+  `Gemfile`:
+  * The new generated `.gemspec` files can auto-load `Ore::Specification`.
+* Do not include `ore-core` in the generated `Gemfile`, if `ore-tasks`
+  has already been included.
+* Bumped the `ore-tasks` dependency to `~> 0.4.0` in the `ore_tasks`
+  template.
+* Fixed typos in the documentation thanks to
+  [yard-spellcheck](http://github.com/postmodern/yard-spellcheck).
+
 ### 0.5.0 / 2011-01-19
 
 * Require ore-core ~> 0.1.1.

data/LICENSE.txt

@@ -1,5 +1,4 @@
-
-Copyright (c) 2010 Hal Brodigan
+Copyright (c) 2010-2011 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,8 +3,8 @@
 * [Source](http://github.com/ruby-ore/ore)
 * [Issues](http://github.com/ruby-ore/ore/issues)
 * [Documentation](http://rubydoc.info/gems/ore/file/README.md)
+* [Email](mailto:postmodern.mod3 at gmail.com)
 * IRC: irc.freenode.net #ruby-ore
-* Postmodern (postmodern.mod3 at gmail.com)
 
 ## Description
 
@@ -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.1
+* [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1.2
 * [thor](http://github.com/wycats/thor) ~> 0.14.3
 
 ## Install
@@ -62,7 +62,7 @@ The `gemspec.yml` file used to build Ore:
       **************************************************************************
       Generate a new Ruby library:
       
-          $ mine my_library --rspec --ore-tasks
+          $ mine my_library --ore-tasks --rspec
       
       Build the library:
       
@@ -75,16 +75,16 @@ The `gemspec.yml` file used to build Ore:
       **************************************************************************
     
     dependencies:
-      ore-core: ~> 0.1.1
+      ore-core: ~> 0.1.2
       thor: ~> 0.14.3
     
     development_dependencies:
-      ore-tasks: ~> 0.3.0
+      ore-tasks: ~> 0.4.0
       rspec: ~> 2.4.0
       yard: ~> 0.6.1
 
 For a complete refrence to the `gemspec.yml` file, please see the
-[GemspecYML Reference](http://rubydoc.info/gems/ore-core/file/GemspecYML.html)
+[GemspecYML Reference](http://rubydoc.info/gems/ore-core/file/GemspecYML.html).
 
 ## Synopsis
 
@@ -124,9 +124,10 @@ Add default generator options to `~/.ore/options.yml`:
 
 Builds a `.gem` file in the `pkg/` directory of a project:
 
-    $ ore
+    $ ore gem
 
 ## License
 
-See {file:LICENSE.txt} for license information.
+Copyright (c) 2010-2011 Hal Brodigan
 
+See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.3.0'
+  gem 'ore-tasks', '~> 0.4.0'
   require 'ore/tasks'
 
   Ore::Tasks.new
@@ -12,7 +12,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.3.0'
+  gem 'rspec', '~> 2.4.0'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new
@@ -21,6 +21,7 @@ rescue LoadError
     abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :test => :spec
 task :default => :spec
 
 begin

data/data/ore/templates/base/README.md.erb

@@ -5,7 +5,7 @@
 <%- end -%>
 * [Documentation](http://rubydoc.info/gems/<%= @name %>)
 <%- if @safe_email -%>
-* [Email](<%= @safe_email %>)
+* [Email](mailto:<%= @safe_email %>)
 <%- end -%>
 
 ## Description

data/data/ore/templates/base/README.rdoc.erb

@@ -5,7 +5,7 @@
 <%- end -%>
 * {Documentation}[http://rubydoc.info/gems/<%= @name %>]
 <%- if @safe_email -%>
-* {Email}[<%= @safe_email %>]
+* {Email}[mailto:<%= @safe_email %>]
 <%- end -%>
 
 == Description

data/data/ore/templates/base/README.tt.erb

@@ -5,7 +5,7 @@ h1. <%= @name %>
 <%- end -%>
 * "Documentation":http://rubydoc.info/gems/<%= @name %>
 <%- if @safe_email -%>
-* "Email":<%= @safe_email %>
+* "Email":mailto:<%= @safe_email %>
 <%- end -%>
 
 h2. Description

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

@@ -9,7 +9,7 @@ rescue NameError
     require 'ore/specification'
     retry
   rescue LoadError
-    STDERR.puts "The '<%= @name %>.gemspec' file requires Ore."
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
     STDERR.puts "Run `gem install ore-core` to install Ore."
   end
 end

data/data/ore/templates/base/_gemfile.erb

@@ -1 +1,3 @@
+<%- unless ore_tasks? -%>
   gem 'ore-core',  '<%= @ore_core_dependency %>'
+<%- end -%>

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

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

data/data/ore/templates/bundler/_tasks.erb

@@ -0,0 +1,3 @@
+<%- unless (jeweler_tasks? || ore_tasks?) -%>
+Bundler::GemHelper.install_tasks
+<%- end -%>

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

@@ -1,2 +1,2 @@
 variables:
-  ore_tasks_dependency: ~> 0.3.0
+  ore_tasks_dependency: ~> 0.4.0

data/data/ore/templates/rspec/_tasks.erb

@@ -13,4 +13,6 @@ rescue LoadError => e
   end
 end
 <%- end -%>
+
+task :test => :spec
 task :default => :spec

data/data/ore/templates/rvmrc/.rvmrc.erb

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="<%= if defined?(::RUBY_ENGINE)
+          if RUBY_ENGINE == 'ruby'
+            RUBY_VERSION
+          else
+            RUBY_ENGINE
+          end
+        else
+          RUBY_VERSION
+        end -%>@<%= @name -%>"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file, this is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id"
+fi
+<%- if bundler? -%>
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory you can uncomment the following code.
+#
+
+# Ensure that ore-core is installed.
+if [[ `gem list -i ore-core` -ne "true" ]]; then
+  printf "The rubygem 'ore-core' is not installed, installing it now.\n"
+  gem install ore-core --version <%= @ore_core_dependency.dump %>
+fi
+
+# Ensure that Bundler is installed, install it if it is not.
+if ! command -v bundle ; then
+  printf "The rubygem 'bundler' is not installed, installing it now.\n"
+  gem install bundler --version <%= @bundler_dependency.dump %>
+fi
+
+# Bundle while reducing excess noise.
+printf "Bundling your gems this may take a few minutes on a fresh clone.\n"
+bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
+<%- end -%>

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.5.0
+version: 0.6.0
 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 --ore-tasks
+      $ mine my_library --ore-tasks --rspec
   
   Build the library:
   
@@ -29,10 +29,10 @@ post_install_message: |
   **************************************************************************
 
 dependencies:
-  ore-core: ~> 0.1.1
+  ore-core: ~> 0.1.2
   thor: ~> 0.14.3
 
 development_dependencies:
-  ore-tasks: ~> 0.3.0
+  ore-tasks: ~> 0.4.0
   rspec: ~> 2.4.0
   yard: ~> 0.6.1

data/lib/ore/cli.rb

@@ -9,7 +9,7 @@ module Ore
 
     include Config
 
-    default_task :cut
+    default_task :gem
 
     map '-l' => :list
     map '-u' => :update
@@ -108,9 +108,9 @@ module Ore
       end
     end
 
-    desc 'cut', 'Cuts a new RubyGem'
+    desc 'gem', 'Builds a RubyGem'
 
-    def cut
+    def gem
       require 'ore/project'
 
       Project.find.build!

data/lib/ore/template/directory.rb

@@ -241,7 +241,7 @@ module Ore
       #   The specified type of markup.
       #
       # @return [Boolean]
-      #   Specifies whether the file has the sepcified formatting.
+      #   Specifies whether the file contains the given formatting.
       #
       def formatted_like?(path,markup)
         @@markups[markup].include?(File.extname(path))

data/lib/ore/template/interpolations.rb

@@ -9,7 +9,7 @@ module Ore
     #   name.
     # * `[namespace_path]` - The full directory path derived from the
     #   project name.
-    # * `[namespace_dir]` - The last directory name derivied from the
+    # * `[namespace_dir]` - The last directory name derived from the
     #    project name.
     #
     module Interpolations

data/ore.gemspec

@@ -9,7 +9,7 @@ rescue NameError
     require 'ore/specification'
     retry
   rescue LoadError
-    STDERR.puts "The 'ore.gemspec' file requires Ore."
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
     STDERR.puts "Run `gem install ore-core` to install Ore."
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ore
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 0
-  version: 0.5.0
+  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 -08:00
+date: 2011-02-12 00:00:00 -08:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,11 +21,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 1
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 14
-        - 3
         version: 0.14.3
   type: :runtime
   version_requirements: *id002
@@ -55,11 +43,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
-        version: 0.3.0
+        version: 0.4.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -70,10 +54,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
         version: 2.4.0
   type: :development
   version_requirements: *id004
@@ -85,15 +65,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 1
         version: 0.6.1
   type: :development
   version_requirements: *id005
 description: Ore is a simple RubyGem building solution. Ore handles the creation of Gem::Specification objects as well as building '.gem' files. Ore allows the developer to keep all of the project information in a single YAML file.
-email: postmodern.mod3@gmail.com
+email: 
+- postmodern.mod3@gmail.com
 executables: 
 - mine
 - ore
@@ -105,6 +82,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files: 
 - .document
+- .gemtest
 - .rspec
 - .yardopts
 - ChangeLog.md
@@ -132,9 +110,9 @@ files:
 - data/ore/templates/bundler/Gemfile.erb
 - data/ore/templates/bundler/_development_dependencies.erb
 - data/ore/templates/bundler/_gitignore.erb
+- data/ore/templates/bundler/_tasks.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
@@ -151,6 +129,7 @@ files:
 - 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/test/helper.rb.erb
 - data/ore/templates/test_unit/test/test_[name].rb.erb
 - data/ore/templates/yard/.yardopts.erb
@@ -174,7 +153,7 @@ files:
 - spec/generator_spec.rb
 - spec/helpers/generator.rb
 - spec/spec_helper.rb
-has_rdoc: yard
+has_rdoc: true
 homepage: http://github.com/ruby-ore/ore
 licenses: 
 - MIT
@@ -182,7 +161,7 @@ post_install_message: |
   **************************************************************************
   Generate a new Ruby library:
   
-      $ mine my_library --rspec --ore-tasks
+      $ mine my_library --ore-tasks --rspec
   
   Build the library:
   
@@ -203,21 +182,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ore
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Mine raw RubyGems from YAML

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

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