ore-core 0.1.1 → 0.1.2

data/ChangeLog.md

@@ -1,3 +1,25 @@
+### 0.1.2 / 2011-02-08
+
+* Opted into [gem-testers.org](http://gem-testers.org/).
+* Added `rb` to the list of words to ignore in project names.
+* Added common project acronyms to {Ore::Naming}.
+* Added more common project name / namespace mappings:
+  * `rubygems` -> `Gem`
+  * `ar` -> `ActiveRecord`
+  * `dm` -> `DataMapper`
+  * `js` -> `JavaScript`
+  * `msgpack` -> `MsgPack`
+  * `github` -> `GitHub`
+  * `rdoc` -> `RDoc`
+* Renamed `Ore::Defaults` to {Ore::Inferences}.
+* Explicitly require `rubygems/specification` and `rubygems/builder`
+  to work around a RubyGems 1.5.0 issue.
+* Do not explicitly convert dependency versions into Strings.
+* Default the root directory passed to {Ore::Project#initialize} to the current
+  working directory.
+* Fixed typos in the YARD documentation thanks to
+  [yard-spellcheck](http://github.com/postmodern/yard-spellcheck).
+
 ### 0.1.1 / 2011-01-19
 
 * Require yard ~> 0.6.1.
@@ -22,7 +44,7 @@
     * Added {Ore::Versions::VersionFile}.
   * Added {Ore::Project}:
     * Added {Ore::Checks}.
-    * Added {Ore::Defaults}.
+    * Added `Ore::Defaults`.
     * Added {Ore::Settings}.
   * Added {Ore::Specification}.
 * Added {Ore::Project#post_install_message}.

data/GemspecYML.md

@@ -87,6 +87,14 @@ 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
+
 ## date
 
 The publish date of the current version can be listed like so:

data/LICENSE.txt

@@ -1,5 +1,4 @@
-
-Copyright (c) 2010 Hal Brodigan
+Copyright (c) 2010-2011 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,23 +1,25 @@
-# Ore
+# Ore (Core)
 
 * [Source](http://github.com/ruby-ore/ore-core)
 * [Issues](http://github.com/ruby-ore/ore-core/issues)
 * [Documentation](http://rubydoc.info/gems/ore-core/file/README.md)
+* [Email](postmodern.mod3 at gmail.com)
 * IRC: irc.freenode.net #ruby-ore
-* Postmodern (postmodern.mod3 at gmail.com)
 
 ## 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.
+[Gem::Specification](http://docs.rubygems.org/read/chapter/20) objects as
+well as building `.gem` files. Ore allows the developer to keep all of the
+project information in a single YAML file.
 
 ## Features
 
 * Stores project information in **one YAML file** (`gemspec.yml`).
 * **Does not** have dependencies.
-* **Does not** impose a development workflow onto the developer. One could
-  even use Ore with `Jeweler::Tasks`.
+* **Does not** impose a development workflow onto the developer.
+  One could even use Ore with
+  [Jeweler::Tasks](https://github.com/technicalpickles/jeweler#readme).
 * **Can** load the project version from:
   * `VERSION` or `VERSION.yml` files.
   * `VERSION` constants or `Version` modules defined in a `version.rb` file.
@@ -28,10 +30,17 @@ the developer to keep all of the project information in a single YAML file.
           # custom logic here
         end
       rescue NameError
-        STDERR.puts "The 'my_project.gemspec' file requires Ore."
-        STDERR.puts "Run `gem install ore-ore` to install Ore."
+        begin
+          require 'ore/specification'
+          retry
+        rescue LoadError
+          STDERR.puts "The 'my_project.gemspec' file requires Ore."
+          STDERR.puts "Run `gem install ore-core` to install Ore."
+        end
       end
 
+* **Can** be used with [Bundler](http://gembundler.com).
+
 ## Install
 
     $ gem install ore-core
@@ -41,7 +50,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-core
-    version: 0.1.0
+    version: 0.1.2
     summary: Mine raw RubyGems from YAML.
     description:
       Ore is a simple RubyGem building solution. Ore handles the
@@ -57,12 +66,13 @@ The `gemspec.yml` file used to build Ore:
     
     development_dependencies:
       yard: ~> 0.6.1
-      rspec: ~> 2.0.0
+      rspec: ~> 2.4.0
 
 For a complete refrence to the `gemspec.yml` file, please see
-{file:GemspecYML.md}.
+[GemspecYML Reference](http://rubydoc.info/gems/ore-core/file/GemspecYML.html).
 
 ## License
 
-See {file:LICENSE.txt} for license information.
+Copyright (c) 2010-2011 Hal Brodigan
 
+See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -11,6 +11,7 @@ rescue LoadError
     abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :test => :spec
 task :default => :spec
 
 begin

data/gemspec.yml

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

data/lib/ore/dependency.rb

@@ -50,10 +50,10 @@ module Ore
     end
 
     #
-    # Parses a dependencey string.
+    # Parses a dependency string.
     #
     # @param [String] dependency
-    #   The dependencey string.
+    #   The dependency string.
     #
     # @return [Dependency]
     #   The parsed dependency.

data/lib/ore/inferences.rb

@@ -0,0 +1,215 @@
+require 'ore/naming'
+require 'ore/versions'
+
+require 'date'
+
+module Ore
+  #
+  # A mixin for {Project} which provides methods for assigning default
+  # values to project attributes.
+  #
+  module Inferences
+    include Naming
+
+    # The default require-paths
+    @@require_paths = [@@lib_dir, @@ext_dir]
+
+    # The glob to find default executables
+    @@executables = "#{@@bin_dir}/*"
+
+    # The globs to find all testing-files
+    @@test_files = [
+      "#{@@test_dir}/{**/}*_test.rb",
+      "#{@@spec_dir}/{**/}*_spec.rb"
+    ]
+
+    # The files to always exclude
+    @@exclude_files = %w[
+      .gitignore
+    ]
+
+    protected
+
+    #
+    # Infers the Source Code Management used by the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_scm!
+      if @root.join('.git').directory?
+        @scm = :git
+      else
+        @scm = nil
+      end
+    end
+
+    #
+    # Infers the project files.
+    #
+    # @since 0.1.2.
+    #
+    def infer_project_files!
+      @project_files = Set[]
+
+      filter_path = lambda { |path|
+        check_readable(path) { |file| @project_files << file }
+      }
+
+      within do
+        case @scm
+        when :git
+          `git ls-files -z`.split("\0").each(&filter_path)
+        else
+          within { Dir.glob('{**/}*',&filter_path) }
+        end
+      end
+    end
+
+    #
+    # Infers the namespace of the project based on the project name.
+    #
+    # @since 0.1.2.
+    #
+    def infer_namespace!
+      @namespace_modules = modules_of(@name)
+      @namespace = namespace_of(@name)
+
+      dir = namespace_path_of(@name)
+
+      @namespace_dir = if lib_directory?(dir)
+                          dir
+                        elsif lib_directory?(@name)
+                          @name
+                        end
+    end
+
+    #
+    # Infers the project name using the directory name of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_name!
+      @name = @root.basename.to_s
+    end
+
+    #
+    # Finds and sets the version of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_version!
+      @version = (
+        Versions::VersionFile.find(self) ||
+        Versions::VersionConstant.find(self)
+      )
+
+      unless @version
+        raise(InvalidMetadata,"no version file or constant in #{@root}")
+      end
+    end
+
+    #
+    # Infers the release date of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_date!
+      @date = Date.today
+    end
+
+    #
+    # Infers the require-paths of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_require_paths!
+      @@require_paths.each do |name|
+        @require_paths << name if @root.join(name).directory?
+      end
+    end
+
+    #
+    # Infers the executables of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_executables!
+      glob(@@executables) do |path|
+        check_executable(path) { |exe| @executables << File.basename(exe) }
+      end
+    end
+
+    #
+    # Infers the default executable of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_default_executable!
+      @default_executable = if @executables.include?(@name)
+                              @name
+                            else
+                              @executables.first
+                            end
+    end
+
+    #
+    # Infers documentation of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_documentation!
+      if file?('.yardopts')
+        @documentation = :yard
+      else
+        @documentation = :rdoc
+      end
+    end
+
+    #
+    # Infers the extra documentation files of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_extra_doc_files!
+      glob('README.*') { |path| add_extra_doc_file(path) }
+
+      if @document
+        @document.each_extra_file { |path| add_extra_doc_file(path) }
+      end
+    end
+
+    #
+    # Infers the files of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_files!
+      @project_files.each do |file|
+        @files << file unless @@exclude_files.include?(file)
+      end
+    end
+
+    #
+    # Infers the test-files of the project.
+    #
+    # @since 0.1.2.
+    #
+    def infer_test_files!
+      @@test_files.each do |pattern|
+        glob(pattern) { |path| add_test_file(path) }
+      end
+    end
+
+    #
+    # Infers the required version of RubyGems to `>= 1.3.6`, if the
+    # project uses Bundler.
+    #
+    # @since 0.1.2.
+    #
+    def infer_required_rubygems_version!
+      if bundler?
+        @required_rubygems_version = '>= 1.3.6'
+      end
+    end
+  end
+end

data/lib/ore/naming.rb

@@ -28,11 +28,11 @@ module Ore
     @@pkg_dir = 'pkg'
 
     # Words used in project names, but never in directory names
-    @@ignore_namespaces = %w[ruby java]
+    @@ignore_namespaces = %w[ruby rb java]
 
     # Common acronyms used in namespaces
     @@namespace_acronyms = %w[
-      ffi i18n
+      ffi yard i18n
       http https ftp smtp imap pop3 ssh ssl tcp udp dns rpc
       url uri www css html xhtml xml xsl json yaml csv
       posix unix bsd
@@ -41,11 +41,13 @@ module Ore
 
     # Common project prefixes and namespaces
     @@common_namespaces = {
+      'rubygems' => 'Gem',
       'ar' => 'ActiveRecord',
       'dm' => 'DataMapper',
       'js' => 'JavaScript',
       'msgpack' => 'MsgPack',
-      'github' => 'GitHub'
+      'github' => 'GitHub',
+      'rdoc' => 'RDoc'
     }
 
     #

data/lib/ore/project.rb

@@ -3,7 +3,7 @@ require 'ore/exceptions/invalid_metadata'
 require 'ore/naming'
 require 'ore/paths'
 require 'ore/checks'
-require 'ore/defaults'
+require 'ore/inferences'
 require 'ore/settings'
 require 'ore/document_file'
 
@@ -11,10 +11,12 @@ require 'pathname'
 require 'yaml'
 require 'find'
 require 'fileutils'
+require 'rubygems/specification'
+require 'rubygems/builder'
 
 module Ore
   #
-  # Combinds the metadata from the `gemspec.yml` file and the inferred
+  # Combines the metadata from the `gemspec.yml` file and the inferred
   # information from the project directory.
   #
   class Project
@@ -22,7 +24,7 @@ module Ore
     include Naming
     include Paths
     include Checks
-    include Defaults
+    include Inferences
     include Settings
 
     # The project metadata file
@@ -40,7 +42,7 @@ module Ore
     # The fully-qualified namespace of the project
     attr_reader :namespace
 
-    # The infered namespace modules of the project
+    # The inferred namespace modules of the project
     attr_reader :namespace_modules
 
     # The directory contain the project code.
@@ -124,7 +126,7 @@ module Ore
     # @param [String] root
     #   The root directory of the project.
     #
-    def initialize(root)
+    def initialize(root=Dir.pwd)
       @root = Pathname.new(root).expand_path
 
       unless @root.directory?
@@ -149,7 +151,7 @@ module Ore
       if metadata['name']
         @name = metadata['name'].to_s
       else
-        default_name!
+        infer_name!
       end
 
       # infer the namespace from the project name
@@ -158,7 +160,7 @@ module Ore
       if metadata['version']
         set_version! metadata['version']
       else
-        default_version!
+        infer_version!
       end
 
       @summary = (metadata['summary'] || metadata['description'])
@@ -182,7 +184,7 @@ module Ore
       if metadata['date']
         set_date! metadata['date']
       else
-        default_date!
+        infer_date!
       end
 
       @document = DocumentFile.find(self)
@@ -192,7 +194,7 @@ module Ore
       if metadata['require_paths']
         set_require_paths! metadata['require_paths']
       else
-        default_require_paths!
+        infer_require_paths!
       end
 
       @executables = []
@@ -200,7 +202,7 @@ module Ore
       if metadata['executables']
         set_executables! metadata['executables']
       else
-        default_executables!
+        infer_executables!
       end
 
       @default_executable = nil
@@ -208,7 +210,7 @@ module Ore
       if metadata['default_executable']
         set_default_executable! metadata['default_executable']
       else
-        default_executable!
+        infer_default_executable!
       end
 
       if metadata['has_yard']
@@ -218,7 +220,7 @@ module Ore
                            :rdoc
                          end
       else
-        default_documentation!
+        infer_documentation!
       end
 
       @extra_doc_files = []
@@ -226,7 +228,7 @@ module Ore
       if metadata['extra_doc_files']
         set_extra_doc_files! metadata['extra_doc_files']
       else
-        default_extra_doc_files!
+        infer_extra_doc_files!
       end
 
       @files = []
@@ -234,7 +236,7 @@ module Ore
       if metadata['files']
         set_files! metadata['files']
       else
-        default_files!
+        infer_files!
       end
 
       @test_files = []
@@ -242,7 +244,7 @@ module Ore
       if metadata['test_files']
         set_test_files! metadata['test_files']
       else
-        default_test_files!
+        infer_test_files!
       end
 
       if metadata['post_install_message']
@@ -262,7 +264,7 @@ module Ore
       if metadata['required_rubygems_version']
         set_required_rubygems_version! metadata['required_rubygems_version']
       else
-        default_required_rubygems_version!
+        infer_required_rubygems_version!
       end
 
       @dependencies = []
@@ -337,6 +339,19 @@ module Ore
       @licenses.first
     end
 
+    #
+    # Determines whether the project prefers using
+    # [RVM](http://rvm.beginrescueend.com/).
+    #
+    # @return [Boolean]
+    #   Specifies whether the project prefers being developed under RVM.
+    #
+    # @since 0.1.2
+    #
+    def rvm?
+      file?('.rvmrc')
+    end
+
     #
     # Determines whether the project uses Bundler.
     #
@@ -367,6 +382,8 @@ module Ore
       @documentation == :rdoc
     end
 
+    alias has_rdoc? has_rdoc
+
     #
     # Determines if the project contains YARD documentation.
     #
@@ -377,6 +394,8 @@ module Ore
       @documentation == :yard
     end
 
+    alias has_yard? has_yard
+
     #
     # Populates a Gem Specification using the metadata of the project.
     #
@@ -494,53 +513,6 @@ module Ore
       messages.each { |mesg| STDERR.puts("WARNING: #{mesg}") }
     end
 
-    #
-    # Infers the Source Code Management used by the project.
-    #
-    def infer_scm!
-      if @root.join('.git').directory?
-        @scm = :git
-      else
-        @scm = nil
-      end
-    end
-
-    #
-    # Infers the project files.
-    #
-    def infer_project_files!
-      @project_files = Set[]
-
-      filter_path = lambda { |path|
-        check_readable(path) { |file| @project_files << file }
-      }
-
-      within do
-        case @scm
-        when :git
-          `git ls-files -z`.split("\0").each(&filter_path)
-        else
-          within { Dir.glob('{**/}*',&filter_path) }
-        end
-      end
-    end
-
-    #
-    # Infers the namespace of the project based on the project name.
-    #
-    def infer_namespace!
-      @namespace_modules = modules_of(@name)
-      @namespace = namespace_of(@name)
-
-      dir = namespace_path_of(@name)
-
-      @namespace_dir = if lib_directory?(dir)
-                          dir
-                        elsif lib_directory?(@name)
-                          @name
-                        end
-    end
-
     #
     # Adds a require-path to the project.
     #

data/lib/ore/settings.rb

@@ -210,7 +210,7 @@ module Ore
     # Sets the dependencies of the project.
     #
     # @param [Hash{String => String}] dependencies
-    #   The dependencey names and versions listed in the metadata file.
+    #   The dependency names and versions listed in the metadata file.
     #
     # @raise [InvalidMetadata]
     #   The dependencies must be a `Hash`.
@@ -221,8 +221,6 @@ module Ore
       end
 
       dependencies.each do |name,versions|
-        versions = versions.to_s
-
         @dependencies << Dependency.parse_versions(name,versions)
       end
     end
@@ -231,7 +229,7 @@ module Ore
     # Sets the runtime-dependencies of the project.
     #
     # @param [Hash{String => String}] dependencies
-    #   The runtime-dependencey names and versions listed in the metadata
+    #   The runtime-dependency names and versions listed in the metadata
     #   file.
     #
     # @raise [InvalidMetadata]
@@ -243,8 +241,6 @@ module Ore
       end
 
       dependencies.each do |name,versions|
-        versions = versions.to_s
-
         @runtime_dependencies << Dependency.parse_versions(name,versions)
       end
     end
@@ -253,7 +249,7 @@ module Ore
     # Sets the development-dependencies of the project.
     #
     # @param [Hash{String => String}] dependencies
-    #   The development-dependencey names and versions listed in the
+    #   The development-dependency names and versions listed in the
     #   metadata file.
     #
     # @raise [InvalidMetadata]
@@ -265,8 +261,6 @@ module Ore
       end
 
       dependencies.each do |name,versions|
-        versions = versions.to_s
-
         @development_dependencies << Dependency.parse_versions(name,versions)
       end
     end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ore-core
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 -08:00
+date: 2011-02-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 1
         version: 0.6.1
   type: :development
   version_requirements: *id001
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
         version: 2.4.0
   type: :development
   version_requirements: *id002
@@ -60,6 +48,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files: 
 - .document
+- .gemtest
 - .rspec
 - .yardopts
 - ChangeLog.md
@@ -70,13 +59,13 @@ files:
 - gemspec.yml
 - lib/ore-core.rb
 - lib/ore/checks.rb
-- lib/ore/defaults.rb
 - lib/ore/dependency.rb
 - lib/ore/document_file.rb
 - lib/ore/exceptions.rb
 - lib/ore/exceptions/exception.rb
 - lib/ore/exceptions/invalid_metadata.rb
 - lib/ore/exceptions/project_not_found.rb
+- lib/ore/inferences.rb
 - lib/ore/naming.rb
 - lib/ore/paths.rb
 - lib/ore/project.rb
@@ -138,21 +127,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ore-core
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Mine raw RubyGems from YAML

data/lib/ore/defaults.rb

@@ -1,140 +0,0 @@
-require 'ore/naming'
-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
-
-    # The default require-paths
-    @@require_paths = [@@lib_dir, @@ext_dir]
-
-    # The glob to find default executables
-    @@executables = "#{@@bin_dir}/*"
-
-    # The globs to find all testing-files
-    @@test_files = [
-      "#{@@test_dir}/{**/}*_test.rb",
-      "#{@@spec_dir}/{**/}*_spec.rb"
-    ]
-
-    # The files to always exclude
-    @@exclude_files = %w[
-      .gitignore
-    ]
-
-    protected
-
-    #
-    # Sets the project name using the directory name of the project.
-    #
-    def default_name!
-      @name = @root.basename.to_s
-    end
-
-    #
-    # Finds and sets the version of the project.
-    #
-    def default_version!
-      @version = (
-        Versions::VersionFile.find(self) ||
-        Versions::VersionConstant.find(self)
-      )
-
-      unless @version
-        raise(InvalidMetadata,"no version file or constant in #{@root}")
-      end
-    end
-
-    #
-    # Sets the release date of the project.
-    #
-    def default_date!
-      @date = Date.today
-    end
-
-    #
-    # Sets the require-paths of the project.
-    #
-    def default_require_paths!
-      @@require_paths.each do |name|
-        @require_paths << name if @root.join(name).directory?
-      end
-    end
-
-    #
-    # Sets the executables of the project.
-    #
-    def default_executables!
-      glob(@@executables) do |path|
-        check_executable(path) { |exe| @executables << File.basename(exe) }
-      end
-    end
-
-    #
-    # sets the default executable of the project.
-    #
-    def default_executable!
-      @default_executable = if @executables.include?(@name)
-                              @name
-                            else
-                              @executables.first
-                            end
-    end
-
-    #
-    # Sets the default documentation of the project.
-    #
-    def default_documentation!
-      if file?('.yardopts')
-        @documentation = :yard
-      else
-        @documentation = :rdoc
-      end
-    end
-
-    #
-    # Sets the extra documentation files of the project.
-    #
-    def default_extra_doc_files!
-      glob('README.*') { |path| add_extra_doc_file(path) }
-
-      if @document
-        @document.each_extra_file { |path| add_extra_doc_file(path) }
-      end
-    end
-
-    #
-    # Sets the files of the project.
-    #
-    def default_files!
-      @project_files.each do |file|
-        @files << file unless @@exclude_files.include?(file)
-      end
-    end
-
-    #
-    # Sets the test-files of the project.
-    #
-    def default_test_files!
-      @@test_files.each do |pattern|
-        glob(pattern) { |path| add_test_file(path) }
-      end
-    end
-
-    #
-    # Defaults the required version of RubyGems to `>= 1.3.6`, if the
-    # project uses Bundler.
-    #
-    def default_required_rubygems_version!
-      if bundler?
-        @required_rubygems_version = '>= 1.3.6'
-      end
-    end
-  end
-end