ore 0.1.3 → 0.1.4

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.1.4 / 2010-10-26
+
+* Increased documentation coverage.
+* Make sure {Ore::Config.builtin_templates} and
+  {Ore::Config.installed_templates} only yield valid directories.
+* Ensure that {Ore::Settings} handles versions as Strings.
+* Fixed two typos.
+
 ### 0.1.3 / 2010-10-25
 
 * Fixed URLs in the `gemspec.yml` and {file:README.md}.

data/GemspecYML.md

@@ -18,7 +18,15 @@ directory.
 
 The version of the project can be listed like so:
 
-    version: 0.1.0
+    version: 1.2.3
+
+The `version` may also be listed as a Hash:
+
+    version:
+      major: 1
+      minor: 2
+      patch: 3
+      build: pre
 
 If the version is not listed, Ore will first search for a `VERSION` or
 `VERSION.yml` file in the root of the project. If Ore cannot find any

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ore
-version: 0.1.3
+version: 0.1.4
 summary: Cut raw RubyGems from YAML
 description:
   Ore is a simple RubyGem building solution. Ore handles the

data/lib/ore/checks.rb

@@ -1,4 +1,7 @@
 module Ore
+  #
+  # A mixin for {Project} which provides methods for checking files.
+  #
   module Checks
     protected
 

data/lib/ore/config.rb

@@ -26,11 +26,13 @@ module Ore
     # @yieldparam [String] path
     #   The path of a Ore template directory.
     #
-    def Config.builtin_templates(&block)
+    def Config.builtin_templates
       path = File.join(@@data_dir,'ore','templates')
 
       if File.directory?(path)
-        Dir.glob("#{path}/*",&block)
+        Dir.glob("#{path}/*") do |template|
+          yield template if File.directory?(template)
+        end
       end
     end
 
@@ -43,9 +45,11 @@ module Ore
     # @yieldparam [String] path
     #   The path of a Ore template directory.
     #
-    def Config.installed_templates(&block)
+    def Config.installed_templates
       if File.directory?(@@templates_dir)
-        Dir.glob("#{@@templates_dir}/*",&block)
+        Dir.glob("#{@@templates_dir}/*") do |template|
+          yield template if File.directory?(template)
+        end
       end
     end
   end

data/lib/ore/defaults.rb

@@ -4,6 +4,10 @@ require 'ore/versions'
 require 'date'
 
 module Ore
+  #
+  # A mixin for {Project} which provides methods for assigning default
+  # values to project attributes.
+  #
   module Defaults
     include Naming
 
@@ -43,7 +47,7 @@ module Ore
       )
 
       unless @version
-        #raise(InvalidMetadata,"no version file or constant in #{@root}")
+        raise(InvalidMetadata,"no version file or constant in #{@root}")
       end
     end
 

data/lib/ore/dependency.rb

@@ -1,4 +1,7 @@
 module Ore
+  #
+  # Represents a RubyGem dependency.
+  #
   class Dependency
 
     # The name of the dependency

data/lib/ore/paths.rb

@@ -1,6 +1,9 @@
 require 'ore/naming'
 
 module Ore
+  #
+  # A mixin for {Project} which provides methods for working with paths.
+  #
   module Paths
     include Naming
 

data/lib/ore/project.rb

@@ -13,6 +13,10 @@ require 'find'
 require 'fileutils'
 
 module Ore
+  #
+  # Combinds the metadata from the `gemspec.yml` file and the inferred
+  # information from the project directory.
+  #
   class Project
 
     include Naming

data/lib/ore/settings.rb

@@ -3,6 +3,10 @@ require 'ore/versions/version'
 require 'ore/dependency'
 
 module Ore
+  #
+  # A mixin for {Project} which provides methods for normalizing and
+  # setting project attributes.
+  #
   module Settings
     protected
 
@@ -25,7 +29,7 @@ module Ore
 
         @version = Versions::Version.new(major,minor,patch,build)
       when String
-        @version = Versions::Version.parse(version)
+        @version = Versions::Version.parse(version.to_s)
       else
         raise(InvalidMetadata,"version must be a Hash or a String")
       end
@@ -39,9 +43,9 @@ module Ore
     #
     def set_license!(license)
       if license.kind_of?(Array)
-        license.each { |name| @licenses << name.to_s }
+        @licenses += license
       else
-        @licenses << license.to_s
+        @licenses << license
       end
     end
 
@@ -189,6 +193,8 @@ module Ore
       end
 
       dependencies.each do |name,versions|
+        versions = versions.to_s
+
         @dependencies << Dependency.parse_versions(name,versions)
       end
     end
@@ -209,6 +215,8 @@ module Ore
       end
 
       dependencies.each do |name,versions|
+        versions = versions.to_s
+
         @runtime_dependencies << Dependency.parse_versions(name,versions)
       end
     end
@@ -229,6 +237,8 @@ module Ore
       end
 
       dependencies.each do |name,versions|
+        versions = versions.to_s
+
         @development_dependencies << Dependency.parse_versions(name,versions)
       end
     end

data/lib/ore/template/directory.rb

@@ -2,6 +2,10 @@ require 'find'
 
 module Ore
   module Template
+    #
+    # Represents a template directory and the static files, ERb files
+    # and sub-directories within it.
+    #
     class Directory
 
       # Files or directory names to ignore

data/lib/ore/template/helpers.rb

@@ -1,5 +1,8 @@
 module Ore
   module Template
+    #
+    # Helper methods that can be used within ERb templates.
+    #
     module Helpers
       protected
 

data/lib/ore/template/interpolations.rb

@@ -1,6 +1,17 @@
 module Ore
   module Template
+    #
+    # Handles the expansion of paths and substitution of path keywords.
+    # The following keywords are supported:
+    #
+    # * `: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
+    #   project name.
+    #
     module Interpolations
+      # The accepted interpolation keywords that may be used in paths
       @@keywords = %w[
         name
         project_dir
@@ -9,6 +20,24 @@ module Ore
 
       protected
 
+      #
+      # Expands the given path by substituting the interpolation keywords
+      # for the related instance variables.
+      #
+      # @param [String] path
+      #   The path to expand.
+      #
+      # @return [String]
+      #   The expanded path.
+      #
+      # @example Assuming `@project_dir` contains `my_project`.
+      #   interpolate "lib/:project_dir:.rb"
+      #   # => "lib/my_project.rb"
+      #
+      # @example Assuming `@namespace_dir` contains `my/project`.
+      #   interpolate "spec/:namespace_dir:_spec.rb"
+      #   # => "spec/my/project_spec.rb"
+      #
       def interpolate(path)
         dirs = path.split(File::SEPARATOR)
 

data/lib/rubygems_plugin.rb

@@ -21,7 +21,7 @@ module Ore
         lib_dir = File.expand_path(File.dirname(__FILE__))
 
         # modify the $LOAD_PATH is 'ore/specification' is not available
-        $LOAD_PATH << ORE_LIB_DIR unless $LOAD_PATH.include?(ORE_LIB_DIR)
+        $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
         begin
           # attempt loading 'ore/specification' again

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 -07:00
+date: 2010-10-26 00:00:00 -07:00
 default_executable: ore
 dependencies: 
 - !ruby/object:Gem::Dependency