ore 0.1.4 → 0.2.0

data/ChangeLog.md

@@ -1,3 +1,20 @@
+### 0.2.0 / 2010-10-27
+
+* Added {Ore::Project#requirements}.
+* Added {Ore::Settings#set_requirements!}.
+* Added {Ore::Template::InvalidTemplate}.
+* Added {Ore::Template::Directory#load!}.
+* Suppress `no rubyforge_project specified` warnings by setting the
+  `rubyforge_project` to the project name in {Ore::Project#to_gemspec}.
+* Do not add extra dependencies to the `gemspec.yml` file when generating
+  a Bundler enabled project. Extra dependencies will be added to the
+  `Gemfile` and controlled by Bundler.
+* Allow Ore template directories to contain `template.yml` which may list
+  template variables:
+
+      data:
+        variable: Value
+
 ### 0.1.4 / 2010-10-26
 
 * Increased documentation coverage.

data/GemspecYML.md

@@ -200,6 +200,18 @@ More than one test-file pattern can be supplied:
 If `test_files` is not listed, Ore will default `files` to
 `test/{**/}test_*.rb` and `spec/{**/}*_spec.rb`.
 
+## requirements
+
+The external requirements of the project can be listed like so:
+
+    requirements: libcairo >= 1.8
+
+Multiple external requirements can also be listed:
+
+    requirements:
+     - libcairo >= 1.8.0
+     - libclutter >= 1.2.0
+
 ## required_ruby_version
 
 The version of Ruby required by the project can be listed like so:

data/README.md

@@ -2,6 +2,7 @@
 
 * [Source](http://github.com/ruby-ore/ore)
 * [Issues](http://github.com/ruby-ore/ore/issues)
+* [Documentation](http://rubydoc.info/gems/ore/file/README.md)
 * IRC: irc.freenode.net #ruby-ore
 * Postmodern (postmodern.mod3 at gmail.com)
 
@@ -44,8 +45,8 @@ 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.1.2
-    summary: Cut raw RubyGems from YAML.
+    version: 0.2.0
+    summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
       creation of Gem::Specification objects as well as building '.gem'

data/Rakefile

@@ -1,9 +1,25 @@
 require 'rubygems'
 require 'rake'
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
+begin
+  gem 'rspec', '~> 2.0.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
 task :default => :spec
 
-require 'yard'
-YARD::Rake::YardocTask.new
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+  
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/data/ore/templates/base/Rakefile.erb

@@ -10,7 +10,7 @@ rescue LoadError => e
 end
 
 begin
-  Bundler.setup(:development, :doc)
+  Bundler.setup(:development)
 rescue Bundler::BundlerError => e
   STDERR.puts e.message
   STDERR.puts "Run `bundle install` to install missing gems."

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

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

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

@@ -16,8 +16,10 @@ authors: <%= @authors.first %>
 email: <%= @email %>
 <%- end -%>
 homepage: <%= @homepage %>
-<%= includes :gem, '' -%>
+<%= includes :gemspec, '' -%>
 
 development_dependencies:
-  ore: ~> <%= @ore_version %>
+<%- unless bundler? -%>
+  ore: <%= @ore_dependency %>
+<%- end -%>
 <%= includes :dependencies, '' -%>

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

@@ -0,0 +1,2 @@
+data:
+  ore_dependency: ~> 0.2.0

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

@@ -4,17 +4,5 @@ gemspec
 
 group :development do
   gem 'rake',     '~> 0.8.7'
-<%- if yard?
-      case @markup
-      when :markdown -%>
-  case RUBY_PLATFORM
-  when 'java'
-    gem 'maruku'
-  else
-    gem 'bluecloth', '>= 2.0.0'
-  end
-<%-   when :textile -%>
-  gem 'RedCloth'
-<%-   end
-    end -%>
+<%= includes :gemfile, '' -%>
 end

data/data/ore/templates/bundler/_dependencies.erb

@@ -1 +1 @@
-  bundler: ~> 1.0.0
+  bundler: <%= @bundler_dependency %>

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

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

data/data/ore/templates/jeweler_tasks/_dependencies.erb

@@ -1,3 +1,3 @@
 <%- unless bundler? -%>
-  jeweler: ~> 1.4
+  jeweler: <%= @jeweler_dependency %>
 <%- end -%>

data/data/ore/templates/jeweler_tasks/_gemfile.erb

@@ -0,0 +1 @@
+  gem 'jeweler', '<%= @jeweler_dependency %>'

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

@@ -4,10 +4,15 @@ require 'jeweler'
 Jeweler::Tasks.new(Ore::Specification.new)
 <%- else -%>
 begin
-  gem 'ore', '~> <%= @ore_version %>'
-  gem 'jeweler', '~> 1.4'
-
+  gem 'ore', '<%= @ore_dependency %>'
   require 'ore/specification'
+rescue LoadError
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore` to install Ore."
+end
+
+begin
+  gem 'jeweler', '<%= @jeweler_dependency %>'
   require 'jeweler'
 
   Jeweler::Tasks.new(Ore::Specification.new)

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

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

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

@@ -1 +1 @@
-  ore-tasks: ~> 0.1.0
+  ore-tasks: <%= @ore_tasks_dependency %>

data/data/ore/templates/ore_tasks/_gemfile.erb

@@ -0,0 +1 @@
+  gem 'ore-tasks', '<%= @ore_tasks_dependency %>'

data/data/ore/templates/ore_tasks/_tasks.erb

@@ -3,7 +3,9 @@ require 'ore/tasks'
 Ore::Tasks.new
 <%- else -%>
 begin
+  gem 'ore-tasks', '<%= @ore_tasks_dependency %>'
   require 'ore/tasks'
+
   Ore::Tasks.new
 rescue LoadError => e
   STDERR.puts e.message

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

@@ -0,0 +1,2 @@
+data:
+  ore_tasks_dependency: ~> 0.1.0

data/data/ore/templates/rspec/_dependencies.erb

@@ -1,3 +1,3 @@
 <%- unless bundler? -%>
-  rspec: ~> 2.0.0
+  rspec: <%= @rspec_dependency %>
 <%- end -%>

data/data/ore/templates/rspec/_gemfile.erb

@@ -0,0 +1 @@
+  gem 'rspec', '<%= @rspec_dependency %>'

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

@@ -3,7 +3,9 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 <%- else -%>
 begin
+  gem 'rspec', '<%= @rspec_dependency %>'
   require 'rspec/core/rake_task'
+
   RSpec::Core::RakeTask.new
 rescue LoadError => e
   task :spec do

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

@@ -1,5 +1,5 @@
 <%- unless bundler? -%>
-gem 'rspec', '~> 2.0.0'
+gem 'rspec', '<%= @rspec_dependency %>'
 <%- end -%>
 require 'rspec'
 require '<%= @namespace_dir %>/version'

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

@@ -0,0 +1,2 @@
+data:
+  rspec_dependency: ~> 2.0.0

data/data/ore/templates/yard/_dependencies.erb

@@ -1 +1 @@
-  yard: ~> 0.6.0
+  yard: <%= @yard_dependency %>

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

@@ -0,0 +1,12 @@
+<%- case @markup
+    when :markdown -%>
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku'
+  else
+    gem 'bluecloth', '>= 2.0.0'
+  end
+<%- when :textile -%>
+  gem 'RedCloth'
+<%- end -%>
+  gem 'yard', '<%= @yard_dependency %>'

data/data/ore/templates/yard/_tasks.erb

@@ -3,7 +3,9 @@ require 'yard'
 YARD::Rake::YardocTask.new  
 <%- else -%>
 begin
+  gem 'yard', '<%= @yard_dependency %>'
   require 'yard'
+
   YARD::Rake::YardocTask.new  
 rescue LoadError => e
   task :yard do

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

@@ -0,0 +1,2 @@
+data:
+  yard_dependency: ~> 0.6.0

data/gemspec.yml

@@ -1,6 +1,6 @@
 name: ore
-version: 0.1.4
-summary: Cut raw RubyGems from YAML
+version: 0.2.0
+summary: Mine raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the
   creation of Gem::Specification objects as well as building '.gem'

data/lib/ore/generator.rb

@@ -145,8 +145,8 @@ module Ore
           exit -1
         end
 
-        self.source_paths << template_dir
         @templates << Template::Directory.new(template_dir)
+        self.source_paths << template_dir
       end
     end
 
@@ -154,8 +154,6 @@ module Ore
     # Initializes variables for the templates.
     #
     def initialize_variables!
-      @ore_version = '0.1.0'
-
       @project_dir = File.basename(destination_root)
       @name = (options.name || @project_dir)
 
@@ -193,6 +191,12 @@ module Ore
       @year = @date.year
       @month = @date.month
       @day = @date.day
+
+      @templates.each do |template|
+        template.data.each do |name,value|
+          instance_variable_set("@#{name}",value)
+        end
+      end
     end
 
     #

data/lib/ore/project.rb

@@ -94,6 +94,9 @@ module Ore
     # The test files for the project
     attr_reader :test_files
 
+    # Any external requirements needed by the project
+    attr_reader :requirements
+
     # The version of Ruby required by the project
     attr_reader :required_ruby_version
 
@@ -236,6 +239,12 @@ module Ore
         default_test_files!
       end
 
+      @requirements = []
+
+      if metadata['requirements']
+        set_requirements! metadata['requirements']
+      end
+
       if metadata['required_ruby_version']
         set_required_ruby_version! metadata['required_ruby_version']
       end
@@ -404,6 +413,8 @@ module Ore
         gemspec.files = @files
         gemspec.test_files = @test_files
 
+        gemspec.requirements = @requirements
+
         if gemspec.respond_to?(:required_ruby_version=)
           gemspec.required_ruby_version = @required_ruby_version
         end
@@ -436,6 +447,11 @@ module Ore
           end
         end
 
+        # legacy information
+        if gemspec.respond_to?(:rubyforge_project=)
+          gemspec.rubyforge_project = gemspec.name
+        end
+
         yield gemspec if block_given?
       end
     end

data/lib/ore/settings.rb

@@ -158,6 +158,22 @@ module Ore
       end
     end
 
+    #
+    # Sets the external requirements of the project.
+    #
+    # @param [Array, String] requirements
+    #   The external requirements.
+    #
+    # @since 0.2.0
+    #
+    def set_requirements!(requirements)
+      if requirements.kind_of?(Array)
+        @requirements += requirements
+      else
+        @requirements << requirements
+      end
+    end
+
     #
     # Sets the Ruby version required by the project.
     #

data/lib/ore/template/directory.rb

@@ -1,3 +1,6 @@
+require 'ore/template/exceptions/invalid_template'
+
+require 'yaml'
 require 'find'
 
 module Ore
@@ -8,8 +11,11 @@ module Ore
     #
     class Directory
 
+      # The template configuration file
+      @@config_file = 'template.yml'
+
       # Files or directory names to ignore
-      @@ignore = %w[.git]
+      @@ignore = ['.git', @@config_file]
 
       # The known markup languages and file extensions
       @@markups = {
@@ -33,6 +39,9 @@ module Ore
       # The include templates in the template directory
       attr_reader :includes
 
+      # The data to use when rendering the template files
+      attr_reader :data
+
       #
       # Initializes a new template directory.
       #
@@ -47,6 +56,9 @@ module Ore
         @templates = {}
         @includes = Hash.new { |hash,key| hash[key] = {} }
 
+        @data = {}
+
+        load!
         scan!
       end
 
@@ -105,6 +117,39 @@ module Ore
 
       protected
 
+      #
+      # Loads template configuration information from `template.yml`.
+      #
+      # @raise [InvalidTemplate]
+      #   The `template.yml` file did not contain a YAML Hash.
+      #
+      # @since 0.2.0
+      #
+      def load!
+        config_path = File.join(@path,@@config_file)
+        return false unless File.file?(config_path)
+
+        config = YAML.load_file(config_path)
+
+        unless config.kind_of?(Hash)
+          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}")
+          end
+
+          # load the template data
+          data.each do |name,value|
+            @data[name.to_sym] = value
+          end
+        end
+
+        return true
+      end
+
       #
       # Scans the template directory recursively recording the directories,
       # files and partial templates.

data/lib/ore/template/exceptions.rb

@@ -0,0 +1 @@
+require 'ore/template/exceptions/invalid_template'

data/lib/ore/template/exceptions/invalid_template.rb

@@ -0,0 +1,9 @@
+module Ore
+  module Template
+    #
+    # @since 0.2.0
+    #
+    class InvalidTemplate < RuntimeError
+    end
+  end
+end

data/spec/helpers/projects/ffi-binding/gemspec.yml

@@ -3,5 +3,7 @@ summary: FFI Binding
 description: FFI Binding for some C library
 authors: Wayne Meissner
 
+requirements: libstuff >= 1.0
+
 dependencies:
   ffi: ~> 0.6.0

data/spec/projects/ffi_binding_project_spec.rb

@@ -18,4 +18,8 @@ describe "FFI Bindings project" do
   it "should have a namespace directory" do
     @project.namespace_dir.should == 'ffi/binding'
   end
+
+  it "should have external requirements" do
+    @project.requirements.should == ['libstuff >= 1.0']
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 -07:00
+date: 2010-10-27 00:00:00 -07:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,27 +96,38 @@ 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/_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/template.yml
 - data/ore/templates/bundler/Gemfile.erb
 - data/ore/templates/bundler/_dependencies.erb
+- data/ore/templates/bundler/template.yml
 - data/ore/templates/jeweler_tasks/_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/_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/_gemfile.erb
 - data/ore/templates/rspec/_tasks.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/yard/.yardopts.erb
 - data/ore/templates/yard/_dependencies.erb
-- data/ore/templates/yard/_gem.erb
+- data/ore/templates/yard/_gemfile.erb
+- data/ore/templates/yard/_gemspec.erb
 - data/ore/templates/yard/_tasks.erb
+- data/ore/templates/yard/template.yml
 - gemspec.yml
 - lib/ore.rb
 - lib/ore/checks.rb
@@ -137,6 +148,8 @@ files:
 - lib/ore/specification.rb
 - lib/ore/template.rb
 - lib/ore/template/directory.rb
+- lib/ore/template/exceptions.rb
+- lib/ore/template/exceptions/invalid_template.rb
 - lib/ore/template/helpers.rb
 - lib/ore/template/interpolations.rb
 - lib/ore/versions.rb
@@ -208,11 +221,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: ore
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Cut raw RubyGems from YAML
+summary: Mine raw RubyGems from YAML
 test_files: 
 - spec/dependency_spec.rb
 - spec/naming_spec.rb