ore-core 0.1.2 → 0.1.3

data/ChangeLog.md

@@ -1,3 +1,13 @@
+### 0.1.3 / 2011-02-12
+
+* Added {Ore::Project#emails}.
+* Added {Ore::Project#email}.
+* Added {Ore::Paths#each_path}.
+* Added {Ore::Settings#set_emails!}.
+* Have {Ore::Dependency} inherit from `Gem::Dependency`.
+* DRYed up {Ore::Settings}.
+* Fixed typos in {file:GemspecYML.md}.
+
 ### 0.1.2 / 2011-02-08
 
 * Opted into [gem-testers.org](http://gem-testers.org/).

data/GemspecYML.md

@@ -72,11 +72,11 @@ Multiple licenses can also be listed:
 
 The authors of the project can be listed like so:
 
-    author: Alice
+    authors: Alice
 
 If a project has more than one author, each author can be listed:
 
-    author:
+    authors:
      - Alice
      - Eve
      - Bob
@@ -176,11 +176,11 @@ the `.document` file.
 
 The files of the project can be listed like so:
 
-    file: lib/**/*.rb
+    files: lib/**/*.rb
 
 More than one file pattern can be specification:
 
-    file:
+    files:
      - lib/**/*.rb
      - spec/**/*
      - data/**/*
@@ -244,8 +244,9 @@ 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,
-Ore will default `required_rubygems_version` to `>= 1.3.6`.
+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
 
@@ -279,7 +280,7 @@ More than one version can be specified for each dependency:
        - 1.2.3
        - 1.3.1
 
-## development_dependencies:
+## development_dependencies
 
 The purely developmental-dependencies for a project can be specified
 like so:

data/gemspec.yml

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

data/lib/ore/dependency.rb

@@ -1,28 +1,10 @@
+require 'rubygems/dependency'
+
 module Ore
   #
   # Represents a RubyGem dependency.
   #
-  class Dependency
-
-    # The name of the dependency
-    attr_reader :name
-
-    # The required versions
-    attr_reader :versions
-
-    #
-    # Creates a new dependency.
-    #
-    # @param [String] name
-    #   The name of the dependency.
-    #
-    # @param [Array<String>] versions
-    #   The required versions.
-    #
-    def initialize(name,*versions)
-      @name = name
-      @versions = versions
-    end
+  class Dependency < Gem::Dependency
 
     #
     # Parses a version string.
@@ -64,5 +46,17 @@ module Ore
       return parse_versions(name,versions)
     end
 
+    #
+    # The version requirements of the dependency.
+    #
+    # @return [Array<String>]
+    #   The version requirement Strings.
+    #
+    # @since 0.1.3
+    #
+    def versions
+      requirements_list.map { |req| req.to_s }
+    end
+
   end
 end

data/lib/ore/paths.rb

@@ -142,5 +142,28 @@ module Ore
         end
       end
     end
+
+    #
+    # Iterates over the paths.
+    #
+    # @param [Array<String>, String] paths
+    #   The paths or path glob pattern to iterate over.
+    #
+    # @yield [path]
+    #   The given block will be passed each individual path.
+    #
+    # @yieldparam [String] path
+    #   An individual path.
+    #
+    # @ since 0.1.3
+    #
+    def each_path(paths,&block)
+      case paths
+      when Array
+        paths.each(&block)
+      else
+        glob(paths,&block)
+      end
+    end
   end
 end

data/lib/ore/project.rb

@@ -69,8 +69,8 @@ module Ore
     # The homepage for the project
     attr_reader :homepage
 
-    # The email contact for the project
-    attr_reader :email
+    # The email contacts for the project
+    attr_reader :emails
 
     # The build date for any project gems
     attr_reader :date
@@ -179,7 +179,11 @@ module Ore
       end
 
       @homepage = metadata['homepage']
-      @email = metadata['email']
+      @emails = []
+      
+      if metadata['email']
+        set_emails! metadata['email']
+      end
 
       if metadata['date']
         set_date! metadata['date']
@@ -248,7 +252,7 @@ module Ore
       end
 
       if metadata['post_install_message']
-        set_post_install_message! metadata['post_install_message']
+        @post_install_message = metadata['post_install_message']
       end
 
       @requirements = []
@@ -258,11 +262,11 @@ module Ore
       end
 
       if metadata['required_ruby_version']
-        set_required_ruby_version! metadata['required_ruby_version']
+        @required_ruby_version = metadata['required_ruby_version']
       end
 
       if metadata['required_rubygems_version']
-        set_required_rubygems_version! metadata['required_rubygems_version']
+        @required_rubygems_version = metadata['required_rubygems_version']
       else
         infer_required_rubygems_version!
       end
@@ -339,6 +343,18 @@ module Ore
       @licenses.first
     end
 
+    #
+    # The primary email address of the project.
+    #
+    # @return [String, nil]
+    #   The primary email address for the project.
+    #
+    # @since 0.1.3
+    #
+    def email
+      @emails.first
+    end
+
     #
     # Determines whether the project prefers using
     # [RVM](http://rvm.beginrescueend.com/).
@@ -420,7 +436,7 @@ module Ore
         gemspec.licenses = @licenses
         gemspec.authors = @authors
         gemspec.homepage = @homepage
-        gemspec.email = @email
+        gemspec.email = @emails
         gemspec.date = @date
 
         @require_paths.each do |path|

data/lib/ore/settings.rb

@@ -42,7 +42,8 @@ module Ore
     #   The license(s) of the project.
     #
     def set_license!(license)
-      if license.kind_of?(Array)
+      case license
+      when Array
         @licenses += license
       else
         @licenses << license
@@ -56,13 +57,31 @@ module Ore
     #   The authors listed in the metadata file.
     #
     def set_authors!(authors)
-      if authors.kind_of?(Array)
+      case authors
+      when Array
         @authors += authors
       else
         @authors << authors
       end
     end
 
+    #
+    # Sets the email contacts of the project.
+    #
+    # @param [Array<String>, String] emails
+    #   The email addresses listed in the metadata file.
+    #
+    # @since 0.1.3
+    #
+    def set_emails!(emails)
+      case emails
+      when Array
+        @emails += emails
+      else
+        @emails << emails
+      end
+    end
+
     #
     # Sets the release date of the project.
     #
@@ -80,11 +99,7 @@ module Ore
     #   The require-paths or the glob-pattern listed in the metadata file.
     #
     def set_require_paths!(paths)
-      if paths.kind_of?(Array)
-        paths.each { |path| add_require_path(path) }
-      else
-        glob(paths) { |path| add_require_path(path) }
-      end
+      each_path(paths) { |path| add_require_path(path) }
     end
 
     #
@@ -95,11 +110,7 @@ module Ore
     #   file.
     #   
     def set_executables!(paths)
-      if paths.kind_of?(Array)
-        paths.each { |path| add_executable(path) }
-      else
-        glob(paths) { |path| add_executable(path) }
-      end
+      each_path(paths) { |path| add_executable(path) }
     end
 
     #
@@ -123,11 +134,7 @@ module Ore
     #   The file paths or the glob-pattern listed in the metadata file.
     #
     def set_extra_doc_files!(paths)
-      if paths.kind_of?(Array)
-        paths.each { |path| add_extra_doc_file(path) }
-      else
-        glob(paths) { |path| add_extra_doc_file(path) }
-      end
+      each_path(paths) { |path| add_extra_doc_file(path) }
     end
 
     #
@@ -137,11 +144,7 @@ module Ore
     #   The files or the glob-pattern listed in the metadata file.
     #
     def set_files!(paths)
-      if paths.kind_of?(Array)
-        paths.each { |path| add_file(path) }
-      else
-        glob(paths) { |path| add_file(path) }
-      end
+      each_path(paths) { |path| add_file(path) }
     end
 
     #
@@ -151,23 +154,7 @@ module Ore
     #   The test-files of the glob-pattern listed in the metadata file.
     #
     def set_test_files!(paths)
-      if paths.kind_of?(Array)
-        paths.each { |path| add_test_file(path) }
-      else
-        glob(paths) { |path| add_test_file(path) }
-      end
-    end
-
-    #
-    # Sets the post-installation message.
-    #
-    # @param [String] message
-    #   The post-install message.
-    #
-    # @since 0.1.0
-    #
-    def set_post_install_message!(message)
-      @post_install_message = message
+      each_path(paths) { |path| add_test_file(path) }
     end
 
     #
@@ -179,33 +166,14 @@ module Ore
     # @since 0.2.0
     #
     def set_requirements!(requirements)
-      if requirements.kind_of?(Array)
+      case requirements
+      when Array
         @requirements += requirements
       else
         @requirements << requirements
       end
     end
 
-    #
-    # Sets the Ruby version required by the project.
-    #
-    # @param [String] version
-    #   The version requirement.
-    #
-    def set_required_ruby_version!(version)
-      @required_ruby_version = version.to_s
-    end
-
-    #
-    # Sets the RubyGems version required by the project.
-    #
-    # @param [String] version
-    #   The version requirement.
-    #
-    def set_required_rubygems_version!(version)
-      @required_rubygems_version = version.to_s
-    end
-
     #
     # Sets the dependencies of the project.
     #

data/spec/dependency_spec.rb

@@ -9,7 +9,7 @@ describe Dependency do
       dep = subject.parse('foo')
 
       dep.name.should == 'foo'
-      dep.versions.should be_empty
+      dep.versions.should == ['>= 0']
     end
 
     it "should parse a dependency with a version" do

metadata

@@ -2,7 +2,7 @@
 name: ore-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Postmodern
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 -08:00
+date: 2011-02-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,7 +36,8 @@ dependencies:
   type: :development
   version_requirements: *id002
 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: []
 
 extensions: []