ore 0.2.3 → 0.3.0

data/GemspecYML.md

@@ -1,272 +0,0 @@
-# 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
-
-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
-version files, it will then search within the `lib/` directory for a
-`version.rb`. Ore can load both Ruby `VERSION` constants or `Version`
-modules that contain `MAJOR`, `MINOR`, `PATCH` and `BUILD` constants.
-
-## 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:
-
-    author: Alice
-
-If a project has more than one author, each author can be listed:
-
-    author:
-     - Alice
-     - Eve
-     - Bob
-
-## email
-
-The primary email contact for the project can be listed like so:
-
-    email: alice@example.com
-
-## date
-
-The publish date of the current version can be listed like so:
-
-    date: 2010-10-23
-
-Ore will use [Date.parse](http://rubydoc.info/docs/ruby-stdlib/1.9.2/Date.parse)
-to parse the `date` value.
-
-If the `date` is not listed, Ore will default it to the current date.
-
-## 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.
-
-## default_executable
-
-The primary executable of the project can be listed like so:
-
-    default_executable: util1
-
-If `default_executable` is not listed, Ore will use the first element
-in `executables`.
-
-## has_rdoc
-
-One can specify the project contains [RDoc](http://rdoc.rubyforge.org/)
-documentation:
-
-    has_rdoc: true
-
-## has_yard
-
-If the project contains [YARD](http://yardoc.org/) and not
-[RDoc](http://rdoc.rubyforge.org/) documentation, one can specify this:
-
-    has_yard: true
-
-If neither `has_yard` or `has_rdoc` are listed, Ore will set `has_yard`
-if the `.yardopts` file exists in the root directory of the project.
-Otherwise, Ore will default `has_rdoc` to true.
-
-## 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:
-
-    file: lib/**/*.rb
-
-More than one file pattern can be specification:
-
-    file:
-     - 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`.
-
-## 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,
-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:
-
-    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:
-
-    dependencies:
-      foo: ~> 0.1.0, >= 0.0.7
-      bar: 1.2.3, 1.3.1
-

data/lib/ore.rb

@@ -1,3 +0,0 @@
-require 'ore/config'
-require 'ore/project'
-require 'ore/specification'

data/lib/ore/checks.rb

@@ -1,88 +0,0 @@
-module Ore
-  #
-  # A mixin for {Project} which provides methods for checking files.
-  #
-  module Checks
-    protected
-
-    #
-    # Checks if the path is readable.
-    #
-    # @yield [path]
-    #   The block will be passed the path, if it is readable.
-    #   Otherwise a warning will be printed.
-    #
-    # @yieldparam [String] path
-    #   A readable path.
-    #
-    def check_readable(path)
-      if File.readable?(path)
-        yield path
-      else
-        warn "#{path} is not readable!"
-      end
-    end
-
-    #
-    # Checks if the path is a readable directory.
-    #
-    # @yield [path]
-    #   The block will be passed the path, if it is a readable directory.
-    #   Otherwise a warning will be printed.
-    #
-    # @yieldparam [String] path
-    #   The directory path.
-    #
-    def check_directory(path)
-      check_readable(path) do |dir|
-        if File.directory?(dir)
-          yield dir
-        else
-          warn "#{dir} is not a directory!"
-        end
-      end
-    end
-
-    #
-    # Checks if the path is a readable file.
-    #
-    # @yield [path]
-    #   The block will be passed the path, if it is a readable file.
-    #   Otherwise a warning will be printed.
-    #
-    # @yieldparam [String] path
-    #   A file path.
-    #
-    def check_file(path)
-      if @project_files.include?(path)
-        check_readable(path) do |file|
-          if File.file?(file)
-            yield file
-          else
-            warn "#{file} is not a file!"
-          end
-        end
-      end
-    end
-
-    #
-    # Checks if the path is an executable file.
-    #
-    # @yield [path]
-    #   The block will be passed the path, if it is an executable file.
-    #   Otherwise a warning will be printed.
-    #
-    # @yieldparam [String] path
-    #   An path to an executable file.
-    #
-    def check_executable(path)
-      check_file(path) do |file|
-        if File.executable?(file)
-          yield file
-        else
-          warn "#{file} is not executable!"
-        end
-      end
-    end
-  end
-end

data/lib/ore/defaults.rb

@@ -1,141 +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