ore 0.3.0 → 0.4.0

data/ChangeLog.md

@@ -1,3 +1,35 @@
+### 0.4.0 / 2010-11-24
+
+* Ore Template variables are now loaded from the `variables` Hash within
+  a `template.yml` file:
+
+        variables:
+          x: foo
+          y: bar
+
+* Allow Ore Templates to list other templates to be enabled via the
+  `enable` field within a `template.yml` file:
+
+        enable:
+         - yard
+         - rspec
+
+* Allow Ore Templates to list other templates to be disabled via the
+  `disable` field within a `template.yml` file:
+
+        disable:
+         - rdoc
+
+* Renamed the `ore_depencency` template variable to `ore_core_dependency`.
+* Renamed `@namespace_dir` to `@namespace_path` within {Ore::Generator}.
+  * `@namespace_dir` now stores the last sub-directory name, derived from
+    the project name.
+* Include any `_development_dependencies.erb` and `_dependencies.erb`
+  includes into the generated `gemspec.yml` file.
+* Added a default Example to generated `README` files.
+* Bumped the `ore_tasks_dependency` template variable to `~> 0.3.0`.
+* Bumped the `jeweler_dependency` template variable to `~> 1.5.0`.
+
 ### 0.3.0 / 2010-11-07
 
 * Split all non-CLI and non-Generator related code out into

data/README.md

@@ -22,11 +22,11 @@ the developer to keep all of the project information in a single YAML file.
   * `VERSION` constants or `Version` modules defined in a `version.rb` file.
 * **Can** be used in traditional `.gemspec` files:
 
-      require 'ore/specification'
-      
-      Ore::Specification.new do |gemspec|
-        # custom logic here
-      end
+        require 'ore/specification'
+        
+        Ore::Specification.new do |gemspec|
+          # custom logic here
+        end
 
 * Provides an **extendable** project **generator** that supports
   user-installed templates.
@@ -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.3.0
+    version: 0.4.0
     summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
@@ -64,8 +64,8 @@ The `gemspec.yml` file used to build Ore:
       thor: ~> 0.14.3
     
     development_dependencies:
-      ore-tasks: ~> 0.2.0
-      rspec: ~> 2.0.0
+      ore-tasks: ~> 0.3.0
+      rspec: ~> 2.1.0
       yard: ~> 0.6.1
 
 For a complete refrence to the `gemspec.yml` file, please see the

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.2.0'
+  gem 'ore-tasks', '~> 0.3.0'
   require 'ore/tasks'
 
   Ore::Tasks.new
@@ -12,7 +12,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.0.0'
+  gem 'rspec', '~> 2.1.0'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new

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

@@ -15,6 +15,8 @@
 
 ## Examples
 
+    require '<%= @namespace_path -%>'
+
 ## Requirements
 
 ## Install

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

@@ -15,6 +15,8 @@
 
 == Examples
 
+  require '<%= @namespace_path -%>'
+
 == Requirements
 
 == Install

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

@@ -15,6 +15,9 @@ h2. Features
 
 h2. Examples
 
+bc.
+require '<%= @namespace_path -%>'
+
 h2. Requirements
 
 h2. Install

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

@@ -1 +1 @@
-  gem 'ore-core',  '<%= @ore_dependency %>'
+  gem 'ore-core',  '<%= @ore_core_dependency %>'

data/data/ore/templates/base/gemspec.yml.erb

@@ -18,8 +18,13 @@ email: <%= @email %>
 homepage: <%= @homepage %>
 <%= includes :gemspec, '' -%>
 
+<%- unless (dependencies = includes(:dependencies,'')).empty? -%>
+dependencies:
+<%= dependencies %>
+
+<%- end -%>
 development_dependencies:
 <%- unless (bundler? || ore_tasks?) -%>
-  ore-core: <%= @ore_dependency %>
+  ore-core: <%= @ore_core_dependency %>
 <%- end -%>
-<%= includes :dependencies, '' -%>
+<%= includes :development_dependencies, '' -%>

data/data/ore/templates/base/lib/[namespace_path].rb.erb

@@ -0,0 +1 @@
+require '<%= @namespace_path %>/version'

data/data/ore/templates/base/template.yml

@@ -1,2 +1,2 @@
-data:
-  ore_dependency: ~> 0.1.0
+variables:
+  ore_core_dependency: ~> 0.1.0

data/data/ore/templates/bundler/template.yml

@@ -1,2 +1,2 @@
-data:
+variables:
   bundler_dependency: ~> 1.0.0

data/data/ore/templates/jeweler_tasks/_tasks.erb

@@ -4,7 +4,7 @@ require 'jeweler'
 Jeweler::Tasks.new(Ore::Specification.new)
 <%- else -%>
 begin
-  gem 'ore', '<%= @ore_dependency %>'
+  gem 'ore', '<%= @ore_core_dependency %>'
   require 'ore/specification'
 rescue LoadError
   STDERR.puts e.message

data/data/ore/templates/jeweler_tasks/template.yml

@@ -1,2 +1,2 @@
-data:
-  jeweler_dependency: ~> 1.4
+variables:
+  jeweler_dependency: ~> 1.5.0

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

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

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

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require '<%= @namespace_dir %>'
+require '<%= @namespace_path %>'
 
 describe <%= @namespace %> do
   it "should have a VERSION constant" do

data/data/ore/templates/rspec/spec/spec_helper.rb.erb

@@ -2,6 +2,6 @@
 gem 'rspec', '<%= @rspec_dependency %>'
 <%- end -%>
 require 'rspec'
-require '<%= @namespace_dir %>/version'
+require '<%= @namespace_path %>/version'
 
 include <%= @namespace %>

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

@@ -1,2 +1,4 @@
-data:
-  rspec_dependency: ~> 2.0.0
+disable:
+  - test_unit
+variables:
+  rspec_dependency: ~> 2.1.0

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

@@ -1,5 +1,5 @@
 require 'helper'
-require '<%= @namespace_dir %>'
+require '<%= @namespace_path %>'
 
 class <%= @namespace %> < Test::Unit::TestCase
 end

data/data/ore/templates/yard/template.yml

@@ -1,2 +1,4 @@
-data:
+disable:
+  - rdoc
+variables:
   yard_dependency: ~> 0.6.0

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.3.0
+version: 0.4.0
 summary: Mine raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the
@@ -18,6 +18,6 @@ dependencies:
   thor: ~> 0.14.3
 
 development_dependencies:
-  ore-tasks: ~> 0.2.0
-  rspec: ~> 2.0.0
+  ore-tasks: ~> 0.3.0
+  rspec: ~> 2.1.0
   yard: ~> 0.6.1

data/lib/ore/generator.rb

@@ -81,7 +81,6 @@ module Ore
       self.destination_root = path
 
       enable_templates!
-      load_templates!
       initialize_variables!
 
       say "Generating #{self.destination_root}", :green
@@ -103,50 +102,90 @@ module Ore
     protected
 
     #
-    # Enables templates.
+    # Enables a template, adding it to the generator.
     #
-    def enable_templates!
-      @enabled_templates = [@@base_template]
+    # @param [Symbol, String] name
+    #   The name of the template to add.
+    #
+    # @since 0.4.0
+    #
+    def enable_template(name)
+      name = name.to_sym
 
-      @enabled_templates << :bundler if options.bundler?
-      @enabled_templates << :jeweler_tasks if options.jeweler_tasks?
-      @enabled_templates << :ore_tasks if options.ore_tasks?
-      
-      if options.rspec?
-        @enabled_templates << :rspec
-      elsif options.test_unit?
-        @enabled_templates << :test_unit
+      return false if @enabled_templates.include?(name)
+
+      unless (template_dir = Generator.templates[name])
+        say "Unknown template #{name}", :red
+        exit -1
       end
 
-      if options.yard?
-        @enabled_templates << :yard
-      elsif options.rdoc?
-        @enabled_templates << :rdoc
+      new_template = Template::Directory.new(template_dir)
+
+      # mark the template as enabled
+      @enabled_templates << name
+
+      # enable any other templates
+      new_template.enable.each do |sub_template|
+        enable_template(sub_template)
       end
 
-      options.templates.each do |name|
-        name = name.to_sym
+      # append the new template to the end of the list,
+      # to override previously loaded templates
+      @templates << new_template
 
-        unless @enabled_templates.include?(name)
-          @enabled_templates << name
-        end
+      # add the template directory to the source-paths
+      self.source_paths << new_template.path
+      return true
+    end
+
+    #
+    # Disables a template in the generator.
+    #
+    # @param [Symbol, String] name
+    #   The name of the template.
+    #
+    # @since 0.4.0
+    #
+    def disable_template(name)
+      name = name.to_sym
+
+      unless (template_dir = Generator.templates[name])
+        say "Unknown template #{name}", :red
+        exit -1
       end
+
+      self.source_paths.delete(template_dir)
+
+      @templates.delete_if { |template| template.path == template_dir }
+      @enabled_templates.delete(name)
+      return true
     end
 
     #
-    # Loads the given templates.
+    # Enables templates.
     #
-    def load_templates!
+    def enable_templates!
       @templates = []
+      @enabled_templates = []
       
-      @enabled_templates.each do |name|
-        unless (template_dir = Generator.templates[name])
-          say "Unknown template #{name}", :red
-          exit -1
-        end
+      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?
 
-        @templates << Template::Directory.new(template_dir)
-        self.source_paths << template_dir
+      enable_template(:yard) if options.yard?
+      enable_template(:rdoc) if options.rdoc?
+
+      # enable any additionally specified templates
+      options.templates.each { |name| enable_template(name) }
+
+      # disable any previously enabled templates
+      @templates.reverse_each do |template|
+        template.disable.each { |name| disable_template(name) }
       end
     end
 
@@ -163,7 +202,8 @@ module Ore
 
       @namespace = namespace_of(@name)
       @namespace_dirs = namespace_dirs_of(@name)
-      @namespace_dir = namespace_path_of(@name)
+      @namespace_path = namespace_path_of(@name)
+      @namespace_dir = @namespace_dirs.last
 
       @version = options.version
       @summary = options.summary
@@ -175,14 +215,10 @@ module Ore
       @authors = options.authors
       @author = options.authors.first
 
-      @markup = if options.yard?
-                  if options.markdown?
-                    :markdown
-                  elsif options.textile?
-                    :textile
-                  else
-                    :rdoc
-                  end
+      @markup = if options.markdown?
+                  :markdown
+                elsif options.textile?
+                  :textile
                 else
                   :rdoc
                 end
@@ -193,7 +229,7 @@ module Ore
       @day = @date.day
 
       @templates.each do |template|
-        template.data.each do |name,value|
+        template.variables.each do |name,value|
           instance_variable_set("@#{name}",value)
         end
       end
@@ -223,7 +259,10 @@ module Ore
     def generate_files!
       generated = Set[]
 
+      # iterate through the templates in reverse, so files in the templates
+      # loaded last override the previously templates.
       @templates.reverse_each do |template|
+        # copy in the static files first
         template.each_file(@markup) do |dest,file|
           unless generated.include?(dest)
             path = interpolate(dest)
@@ -233,6 +272,7 @@ module Ore
           end
         end
 
+        # then render the templates
         template.each_template(@markup) do |dest,file|
           unless generated.include?(dest)
             path = interpolate(dest)

data/lib/ore/template/directory.rb

@@ -39,8 +39,14 @@ module Ore
       # The include templates in the template directory
       attr_reader :includes
 
-      # The data to use when rendering the template files
-      attr_reader :data
+      # Other templates to be disabled
+      attr_reader :disable
+
+      # Other templates to be enabled
+      attr_reader :enable
+
+      # The variables to use when rendering the template files
+      attr_reader :variables
 
       #
       # Initializes a new template directory.
@@ -56,7 +62,9 @@ module Ore
         @templates = {}
         @includes = Hash.new { |hash,key| hash[key] = {} }
 
-        @data = {}
+        @disable = []
+        @enable = []
+        @variables = {}
 
         load!
         scan!
@@ -135,15 +143,31 @@ module Ore
           raise(InvalidTemplate,"invalid configuration in #{config_path.dump}")
         end
 
-        if (data = config['data'])
-          # data must be a Hash
-          unless data.kind_of?(Hash)
-            raise(InvalidTemplate,"data must be a Hash: #{config_path.dump}")
+        if (templates = config['disable'])
+          if templates.kind_of?(Array)
+            templates.each { |name| @disable << name.to_sym }
+          else
+            @disable << templates.to_sym
+          end
+        end
+
+        if (templates = config['enable'])
+          if templates.kind_of?(Array)
+            templates.each { |name| @enable << name.to_sym }
+          else
+            @enable << templates.to_sym
+          end
+        end
+
+        if (variables = config['variables'])
+          # variables must be a Hash
+          unless variables.kind_of?(Hash)
+            raise(InvalidTemplate,"template variables must be a Hash: #{config_path.dump}")
           end
 
-          # load the template data
-          data.each do |name,value|
-            @data[name.to_sym] = value
+          # load the template variables
+          variables.each do |name,value|
+            @variables[name.to_sym] = value
           end
         end
 

data/lib/ore/template/interpolations.rb

@@ -7,14 +7,17 @@ module Ore
     # * `[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_path]` - The full directory path derived from the
     #   project name.
+    # * `[namespace_dir]` - The last directory name derivied from the
+    #    project name.
     #
     module Interpolations
       # The accepted interpolation keywords that may be used in paths
       @@keywords = %w[
         name
         project_dir
+        namespace_path
         namespace_dir
       ]
 
@@ -34,8 +37,8 @@ module Ore
       #   interpolate("lib/[project_dir].rb")
       #   # => "lib/my_project.rb"
       #
-      # @example Assuming `@namespace_dir` contains `my/project`.
-      #   interpolate("spec/[namespace_dir]_spec.rb")
+      # @example Assuming `@namespace_path` contains `my/project`.
+      #   interpolate("spec/[namespace_path]_spec.rb")
       #   # => "spec/my/project_spec.rb"
       #
       def interpolate(path)

data/ore.gemspec

@@ -6,5 +6,5 @@ begin
   end
 rescue NameError
   STDERR.puts "The 'ore.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore-ore` to install Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+gem 'rspec', '~> 2.1.0'
 require 'rspec'
 
 gem 'ore-core', '~> 0.1.0'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 00:00:00 -07:00
+date: 2010-11-24 00:00:00 -08:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,9 +57,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
+        - 3
         - 0
-        version: 0.2.0
+        version: 0.3.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -72,9 +72,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
+        - 1
         - 0
-        - 0
-        version: 2.0.0
+        version: 2.1.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -126,23 +126,23 @@ files:
 - 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_path].rb.erb
+- data/ore/templates/base/lib/[namespace_path]/version.rb.erb
 - data/ore/templates/base/template.yml
 - data/ore/templates/bundler/Gemfile.erb
-- data/ore/templates/bundler/_dependencies.erb
+- data/ore/templates/bundler/_development_dependencies.erb
 - data/ore/templates/bundler/template.yml
-- data/ore/templates/jeweler_tasks/_dependencies.erb
+- data/ore/templates/jeweler_tasks/_development_dependencies.erb
 - data/ore/templates/jeweler_tasks/_gemfile.erb
 - data/ore/templates/jeweler_tasks/_tasks.erb
 - data/ore/templates/jeweler_tasks/template.yml
-- data/ore/templates/ore_tasks/_dependencies.erb
+- data/ore/templates/ore_tasks/_development_dependencies.erb
 - data/ore/templates/ore_tasks/_gemfile.erb
 - data/ore/templates/ore_tasks/_tasks.erb
 - data/ore/templates/ore_tasks/template.yml
 - data/ore/templates/rdoc/_tasks.erb
 - data/ore/templates/rspec/.rspec
-- data/ore/templates/rspec/_dependencies.erb
+- data/ore/templates/rspec/_development_dependencies.erb
 - data/ore/templates/rspec/_gemfile.erb
 - data/ore/templates/rspec/_tasks.erb
 - data/ore/templates/rspec/spec/[namespace_dir]_spec.rb.erb
@@ -151,7 +151,7 @@ files:
 - 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
-- data/ore/templates/yard/_dependencies.erb
+- data/ore/templates/yard/_development_dependencies.erb
 - data/ore/templates/yard/_gemfile.erb
 - data/ore/templates/yard/_gemspec.erb
 - data/ore/templates/yard/_tasks.erb

data/data/ore/templates/base/lib/[namespace_dir].rb.erb

@@ -1 +0,0 @@
-require '<%= @namespace_dir %>/version'