ore 0.7.2 → 0.8.0

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.8.0 / 2011-06-18
+
+* Added the `markup`, `date`, `year`, `month` and `day` keywords to
+  {Ore::Template::Interpolations}.
+* Added `encoding` comments to generated `Rakefile` and `*.gemspec` files.
+* Fixed chmoding of bin files.
+* Updated the generated `yard` dependency to `~> 0.7.0`.
+* No longer add `has_yard: true` to generated `gemspec.yml` files.
+* Generate a pure-Ruby `*.gemspec` file, which loads `gemspec.yml`.
+
 ### 0.7.2 / 2011-02-26
 
 * Require ore-core ~> 0.1, >= 0.1.4.

data/GemspecYML.md

@@ -0,0 +1,263 @@
+# gemspec.yml
+
+Ore uses the `gemspec.yml` file to store all static data about a project.
+The `gemspec.yml` is a simple YAML file, which contains the same data
+that a normal Ruby `.gemspec` file would. Below is the complete listing
+of valid data that can be listed in a `gemspec.yml` file.
+
+## name
+
+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.
+
+## version
+
+The version of the project can be listed like so:
+
+    version: 1.2.3
+
+If the version is not listed, Ore will first search for a `VERSION`
+file in the root of the project. If Ore cannot find any version files,
+it will then search within the `lib/` directory for a `version.rb`.
+
+## summary
+
+The summary of the project can be listed like so:
+
+    summary: My awesome project
+
+## description
+
+The description of the project can be listed in a variety of ways:
+
+* Single line:
+
+      description: My project, which provides various functionality.
+
+* Text block:
+
+      description:
+        My project, which provides the developer with various attributes
+        and behaviors.
+
+If the description is not listed, it will default to the `summary`.
+
+## license
+
+The license of the project can be listed like so:
+
+    license: MIT
+
+Multiple licenses can also be listed:
+
+    license:
+     - LGPL-2.1
+     - GPL-2
+
+## authors
+
+The authors of the project can be listed like so:
+
+    authors: Alice
+
+If a project has more than one author, each author can be listed:
+
+    authors:
+     - Alice
+     - Eve
+     - Bob
+
+## email
+
+The primary email contact for the project can be listed like so:
+
+    email: alice@example.com
+
+If a project has more than one email contact, each email address can be
+listed:
+
+    email:
+      - alice@example.com
+      - eve@example.com
+      - bob@example.com
+
+## require_paths
+
+The require_paths of a project can be listed like so:
+
+    require_paths: lib
+
+If there are more than one require_path that needs listing:
+
+    require_paths:
+     - ext
+     - lib
+
+## executables
+
+The names of the executables provided by the project can be listed like so:
+
+    executables: bin/*
+
+One can also list the executables individually:
+
+    executables:
+     - util1
+     - util2
+
+If the `executables` are not listed, Ore will use the names of any
+executable file within the `bin/` directory.
+
+## extensions
+
+Any Ruby C-extensions can be listed like so:
+
+    extensions: ext/foo/extconf.rb
+
+## documentation
+
+The format of the documentation can be listed like so:
+
+    documentation: yard
+
+## extra_doc_files
+
+The extra files that should also be scanned for documentation can be listed
+like so:
+
+    extra_doc_files:
+     - ChangeLog.md
+     - LICENSE.txt
+
+If `extra_doc_files` is not listed, Ore will use the extra-files listed in
+the `.document` file.
+
+## files
+
+The files of the project can be listed like so:
+
+    files: lib/**/*.rb
+
+More than one file pattern can be specification:
+
+    files:
+     - lib/**/*.rb
+     - spec/**/*
+     - data/**/*
+
+If `files` is not listed, Ore will check if the project is using
+[Git](http://www.git-scm.org/), can will find all tracked files using:
+
+    git ls-files -z
+
+If the project is not using Git, Ore will default `files` to every file in
+the project.
+
+## test_files
+
+The files used to test the project can be listed like so:
+
+    test_files: spec/**/*_spec.rb
+
+More than one test-file pattern can be supplied:
+
+    test_files:
+     - spec/**/*_spec.rb
+     - features/**/*
+
+If `test_files` is not listed, Ore will default `files` to
+`test/{**/}test_*.rb` and `spec/{**/}*_spec.rb`.
+
+## post_install_message
+
+The post-installation message for a project can be listed like so:
+
+    post_install_message: |
+
+      Thank you for installing MyProject 0.1.0. To start MyProject, simply
+      run the following command:
+
+      $ my_project
+      
+
+## 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:
+
+    required_ruby_version: >= 1.9.1
+
+## required_rubygems_version
+
+The version of RubyGems required by the project can be listed like so:
+
+    required_rubygems_version: >= 1.3.7
+
+If `required_rubygems_version` is not listed and the project uses
+[Bundler](http://gembundler.com/), Ore will default `required_rubygems_version`
+to `>= 1.3.6`.
+
+## dependencies
+
+The dependencies of the project can be listed like so:
+
+    dependencies:
+      foo: ~> 0.1.0
+      bar: 1.2.3
+
+More than one version can be specified for each dependency:
+
+    dependencies:
+      foo: ~> 0.1.0, >= 0.0.7
+      bar:
+       - 1.2.3
+       - 1.3.1
+
+## runtime_dependencies
+
+The purely runtime-dependencies for a project can be specified like so:
+
+    runtime_dependencies:
+      foo: ~> 0.1.0
+      bar: 1.2.3
+
+More than one version can be specified for each dependency:
+
+    runtime_dependencies:
+      foo: ~> 0.1.0, >= 0.0.7
+      bar:
+       - 1.2.3
+       - 1.3.1
+
+## development_dependencies
+
+The purely developmental-dependencies for a project can be specified
+like so:
+
+    development_dependencies:
+      foo: ~> 0.1.0
+      bar: 1.2.3
+
+More than one version can be specified for each dependency:
+
+    development_dependencies:
+      foo: ~> 0.1.0, >= 0.0.7
+      bar:
+       - 1.2.3
+       - 1.3.1
+

data/README.md

@@ -8,42 +8,34 @@
 
 ## 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.
+Ore is a flexible Ruby project generator. Unlike other Ruby project
+generators, Ore provides many builtin templates and allows custom
+templates to be installed from Git repositories.
 
 ## Features
 
-* Stores project information in **one YAML file** (`gemspec.yml`).
-* **Does not** impose a development workflow onto the developer. One could
-  even use Ore with `Jeweler::Tasks`.
-* **Can** load the project version from:
-  * `VERSION` or `VERSION.yml` files.
-  * `VERSION` constants or `Version` modules defined in a `version.rb` file.
-* **Can** be used in traditional `.gemspec` files:
-
-        require 'ore/specification'
-        
-        begin
-          Ore::Specification.new do |gemspec|
-            # custom logic here
-          end
-        rescue NameError
-          begin
-            require 'ore/specification'
-            retry
-          rescue LoadError
-            STDERR.puts "The '#{__FILE__}' file requires Ore."
-            STDERR.puts "Run `gem install ore-core` to install Ore."
-          end
-        end
-
-* Provides an **extendable** project **generator** that supports
-  user-installed templates.
+* Stores project metadata in **one YAML file** (`gemspec.yml`).
+* Generates a **pure Ruby** `.gemspec` supporting:
+  * Git
+  * `gemspec.yml`
+  * `VERSION` or `version.rb` files
+* Provides many builtin templates:
+  * bundler
+  * rvmrc
+  * jeweler
+  * rdoc
+  * yard
+  * test_unit
+  * rspec
+  * gem_test
+* Allows installing custom templates from Git repositories:
+
+      $ ore install git://github.com/ruby-ore/cucumber.git
 
 ## Requirements
 
 * [ore-core](http://github.com/ruby-ore/ore-core) ~> 0.1, >= 0.1.4
+* [env](http://github.com/postmodern/env) ~> 0.1.2
 * [thor](http://github.com/wycats/thor) ~> 0.14.3
 
 ## Install
@@ -55,7 +47,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.7.2
+    version: 0.8.0
     summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
@@ -67,7 +59,6 @@ The `gemspec.yml` file used to build Ore:
     authors: Postmodern
     email: postmodern.mod3@gmail.com
     homepage: http://github.com/ruby-ore/ore
-    has_yard: true
     post_install_message: |
       **************************************************************************
       Generate a new Ruby library:
@@ -86,15 +77,16 @@ The `gemspec.yml` file used to build Ore:
     
     dependencies:
       ore-core: ~> 0.1, >= 0.1.4
+      env: ~> 0.1.2
       thor: ~> 0.14.3
     
     development_dependencies:
       ore-tasks: ~> 0.4
       rspec: ~> 2.4
-      yard: ~> 0.6.1
+      yard: ~> 0.7.0
 
 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/file/GemspecYML.html).
 
 ## Synopsis
 
@@ -120,7 +112,7 @@ Generate a new customized project:
 
 Generate a new project using previously installed templates:
 
-    $ mine my_project --bundler --rspec --yard --template mini_test
+    $ mine my_project --bundler --rspec --yard --templates mini_test
 
 Add default generator options to `~/.ore/options.yml`:
 

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

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rubygems'
 <%- if bundler? -%>
 

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

@@ -1,15 +1,127 @@
-# -*- encoding: utf-8 -*-
-
-begin
-  Ore::Specification.new do |gemspec|
-    # custom logic here
-  end
-rescue NameError
-  begin
-    require 'ore/specification'
-    retry
-  rescue LoadError
-    STDERR.puts "The '#{__FILE__}' file requires Ore."
-    STDERR.puts "Run `gem install ore-core` to install Ore."
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  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
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/<%= @namespace_dir %>/version.rb',
+    :constant => '<%= @namespace %>::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    '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}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  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
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  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
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
   end
 end

data/data/ore/templates/test_unit/_tasks.erb

@@ -1,6 +1,6 @@
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+Rake::TestTask.new do |test|
+  test.libs << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end

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

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

data/gemspec.yml

@@ -1,17 +1,15 @@
 name: ore
-version: 0.7.2
+version: 0.8.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'
-  files. Ore allows the developer to keep all of the project information
-  in a single YAML file.
+  Ore is a flexible Ruby project generator. Unlike other Ruby project
+  generators, Ore provides many builtin templates and allows custom
+  templates to be installed from Git repositories.
 
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: http://github.com/ruby-ore/ore
-has_yard: true
 post_install_message: |
   **************************************************************************
   Generate a new Ruby library:
@@ -30,9 +28,10 @@ post_install_message: |
 
 dependencies:
   ore-core: ~> 0.1, >= 0.1.4
+  env: ~> 0.1.2
   thor: ~> 0.14.3
 
 development_dependencies:
   ore-tasks: ~> 0.4
   rspec: ~> 2.4
-  yard: ~> 0.6.1
+  yard: ~> 0.7.0

data/lib/ore/config.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'env'
 
 module Ore
   module Config
@@ -6,7 +7,7 @@ module Ore
     @@enabled = true
 
     # The users home directory
-    @@home = File.expand_path(ENV['HOME'] || ENV['HOMEPATH'])
+    @@home = Env.home
 
     # Ore config directory
     @@path = File.join(@@home,'.ore')

data/lib/ore/generator.rb

@@ -7,6 +7,7 @@ require 'ore/config'
 require 'thor/group'
 require 'date'
 require 'set'
+require 'env'
 
 module Ore
   class Generator < Thor::Group
@@ -76,7 +77,7 @@ module Ore
         :summary => 'TODO: Summary',
         :description => 'TODO: Description',
         :license => 'MIT',
-        :authors => [ENV['USER']],
+        :authors => [Env.user],
         :ore_tasks => true,
         :rdoc => true,
         :rspec => true,
@@ -193,12 +194,12 @@ module Ore
     # @since 0.7.1
     #
     def generate_dir(dest)
-      return if @generated_dirs.include?(dest)
+      return if @generated_dirs.has_key?(dest)
 
       path = interpolate(dest)
       empty_directory path
 
-      @generated_dirs << dest
+      @generated_dirs[dest] = path
       return path
     end
 
@@ -223,7 +224,7 @@ module Ore
     # @since 0.7.1
     #
     def generate_file(dest,file,options={})
-      return if @generated_files.include?(dest)
+      return if @generated_files.has_key?(dest)
 
       path = interpolate(dest)
 
@@ -235,12 +236,7 @@ module Ore
         copy_file file, path
       end
 
-      if File.executable?(file)
-        umask = File.stat(File.join(destination_root,path)).mode
-        chmod path, (umask | 0111)
-      end
-
-      @generated_files << dest
+      @generated_files[dest] = path
       return path
     end
 
@@ -385,8 +381,8 @@ module Ore
         end
       end
 
-      @generated_dirs = Set[]
-      @generated_files = Set[]
+      @generated_dirs = {}
+      @generated_files = {}
     end
 
     #
@@ -417,6 +413,14 @@ module Ore
           generate_file dest, file, :template => true
         end
       end
+
+      @generated_files.each_value do |path|
+        dir = path.split(File::SEPARATOR,2).first
+
+        if dir == 'bin'
+          chmod path, 0755
+        end
+      end
     end
 
   end

data/lib/ore/template/interpolations.rb

@@ -16,9 +16,15 @@ module Ore
       # The accepted interpolation keywords that may be used in paths
       @@keywords = %w[
         name
+        version
         project_dir
         namespace_path
         namespace_dir
+        markup
+        date
+        year
+        month
+        day
       ]
 
       protected

data/spec/generator_spec.rb

@@ -214,10 +214,6 @@ describe Generator do
       @path.join('.yardopts').should be_file
     end
 
-    it "should set 'has_yard' to 'true' in the gemspec.yml file" do
-      @gemspec['has_yard'].should == true
-    end
-
     it "should add a '.document' file" do
       @path.join('.document').should be_file
     end

data/spec/helpers/generator.rb

@@ -32,9 +32,11 @@ module Helpers
       unless @document
         @document = []
 
-        @path.join('.document').read.each_line do |line|
-          unless (line.empty? && line =~ /\s*\#/)
-            @document << line.strip
+        @path.join('.document').open do |file|
+          file.each_line do |line|
+            unless (line.empty? && line =~ /\s*\#/)
+              @document << line.strip
+            end
           end
         end
       end
@@ -46,9 +48,11 @@ module Helpers
       unless @gitignore
         @gitignore = []
 
-        @path.join('.gitignore').read.each_line do |line|
-          unless (line.empty? && line =~ /\s*\#/)
-            @gitignore << line.strip
+        @path.join('.gitignore').open do |file|
+          file.each_line do |line|
+            unless (line.empty? && line =~ /\s*\#/)
+              @gitignore << line.strip
+            end
           end
         end
       end

metadata

@@ -2,7 +2,7 @@
 name: ore
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors: 
 - Postmodern
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 -08:00
-default_executable: ore
+date: 2011-06-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ore-core
@@ -19,59 +18,70 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.1"
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.1.4
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.1"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: env
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.14.3
+        version: 0.1.2
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: ore-tasks
+  name: thor
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.4"
-  type: :development
+        version: 0.14.3
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: ore-tasks
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "2.4"
+        version: "0.4"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.6.1
+        version: "2.4"
   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.
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+  type: :development
+  version_requirements: *id006
+description: Ore is a flexible Ruby project generator. Unlike other Ruby project generators, Ore provides many builtin templates and allows custom templates to be installed from Git repositories.
 email: 
 - postmodern.mod3@gmail.com
 executables: 
@@ -89,6 +99,7 @@ files:
 - .rspec
 - .yardopts
 - ChangeLog.md
+- GemspecYML.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -144,7 +155,6 @@ files:
 - data/ore/templates/yard/.yardopts.erb
 - data/ore/templates/yard/_development_dependencies.erb
 - data/ore/templates/yard/_gemfile_development.erb
-- data/ore/templates/yard/_gemspec.erb
 - data/ore/templates/yard/_tasks.erb
 - data/ore/templates/yard/template.yml
 - gemspec.yml
@@ -162,7 +172,6 @@ files:
 - spec/generator_spec.rb
 - spec/helpers/generator.rb
 - spec/spec_helper.rb
-has_rdoc: yard
 homepage: http://github.com/ruby-ore/ore
 licenses: 
 - MIT
@@ -201,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ore
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Mine raw RubyGems from YAML

data/data/ore/templates/yard/_gemspec.erb

@@ -1 +0,0 @@
-has_yard: true