ore 0.2.3 → 0.3.0

data/lib/ore/dependency.rb

@@ -1,65 +0,0 @@
-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
-
-    #
-    # Parses a version string.
-    #
-    # @param [String] name
-    #   The name of the dependency.
-    #
-    # @param [String, nil] versions 
-    #   The version string.
-    #
-    # @return [Dependency]
-    #   The parsed dependency.
-    #
-    def self.parse_versions(name,versions)
-      versions = if versions.kind_of?(String)
-                   versions.strip.split(/,\s*/)
-                 else
-                   []
-                 end
-
-      return new(name,*versions)
-    end
-
-    #
-    # Parses a dependencey string.
-    #
-    # @param [String] dependency
-    #   The dependencey string.
-    #
-    # @return [Dependency]
-    #   The parsed dependency.
-    #
-    def self.parse(dependency)
-      name, versions = dependency.strip.split(/\s+/,2)
-
-      return parse_versions(name,versions)
-    end
-
-  end
-end

data/lib/ore/document_file.rb

@@ -1,118 +0,0 @@
-require 'set'
-
-module Ore
-  #
-  # Parses the contents of a  `.document`.
-  #
-  class DocumentFile
-
-    # The path to the `.document` file.
-    attr_reader :path
-
-    # The glob-patterns to find all code-files.
-    attr_reader :file_globs
-
-    # The glob-patterns to find all extra-files.
-    attr_reader :extra_file_globs
-
-    #
-    # Creates a new {DocumentFile}.
-    #
-    # @param [String] path
-    #   The path of the `.document` file.
-    #
-    def initialize(path)
-      @path = File.expand_path(path)
-
-      @file_globs = Set[]
-      @extra_file_globs = Set[]
-
-      parse!
-    end
-
-    @@file = '.document'
-
-    #
-    # Finds the document file in a project.
-    #
-    # @param [Project] project
-    #   The project to search within.
-    #
-    # @return [DocumentFile, nil]
-    #   The found document file.
-    #
-    def self.find(project)
-      self.new(project.path(@@file)) if project.file?(@@file)
-    end
-
-    #
-    # All files described in the `.document` file.
-    #
-    # @yield [path]
-    #   The given block will be passed every path that matches the file
-    #   globs in the `.document` file.
-    #
-    # @yieldparam [String] path
-    #   A match that matches the `.document` file patterns.
-    #
-    # @return [Enumerator]
-    #   If no block was given, an enumerator object will be returned.
-    #
-    def each_file(&block)
-      return enum_for(:each_file) unless block
-
-      @file_globs.each do |pattern|
-        Dir.glob(pattern,&block)
-      end
-    end
-
-    #
-    # All extra-files described in the `.document` file.
-    #
-    # @yield [path]
-    #   The given block will be passed every path that matches the
-    #   extra-file globs in the `.document` file.
-    #
-    # @yieldparam [String] path
-    #   A match that matches the `.document` extra-file patterns.
-    #
-    # @return [Enumerator]
-    #   If no block was given, an enumerator object will be returned.
-    #
-    def each_extra_file(&block)
-      return enum_for(:each_extra_file) unless block
-
-      @extra_file_globs.each do |pattern|
-        Dir.glob(pattern,&block)
-      end
-    end
-
-    protected
-
-    #
-    # Parses the contents of a `.document` file.
-    #
-    def parse!
-      separator = false
-
-      File.open(@path) do |file|
-        file.each_line do |line|
-          line = line.chomp.strip
-
-          next if line.empty?
-
-          unless separator
-            if line == '-'
-              separator = true
-            else
-              @file_globs << line
-            end
-          else
-            @extra_file_globs << line
-          end
-        end
-      end
-    end
-
-  end
-end

data/lib/ore/exceptions.rb

@@ -1,3 +0,0 @@
-require 'ore/exceptions/exception'
-require 'ore/exceptions/project_not_found'
-require 'ore/exceptions/invalid_metadata'

data/lib/ore/exceptions/exception.rb

@@ -1,4 +0,0 @@
-module Ore
-  class Exception < RuntimeError
-  end
-end

data/lib/ore/exceptions/invalid_metadata.rb

@@ -1,6 +0,0 @@
-require 'ore/exceptions/exception'
-
-module Ore
-  class InvalidMetadata < Exception
-  end
-end

data/lib/ore/exceptions/project_not_found.rb

@@ -1,6 +0,0 @@
-require 'ore/exceptions/exception'
-
-module Ore
-  class ProjectNotFound < Exception
-  end
-end

data/lib/ore/naming.rb

@@ -1,113 +0,0 @@
-module Ore
-  #
-  # Provides methods for guessing the namespaces and directories
-  # of projects. {Naming} uses the naming conventions of project names
-  # defined by the
-  # [Ruby Packaging Standard (RPS)](http://chneukirchen.github.com/rps/).
-  #
-  module Naming
-    # The directory which contains executables for a project
-    @@bin_dir = 'bin'
-
-    # The directory which contains the code for a project
-    @@lib_dir = 'lib'
-
-    # The directory which contains C extension code for a project
-    @@ext_dir = 'ext'
-
-    # The directory which contains data files for a project
-    @@data_dir = 'data'
-
-    # The directory which contains unit-tests for a project
-    @@test_dir = 'test'
-
-    # The directory which contains spec-tests for a project
-    @@spec_dir = 'spec'
-
-    # The directory which contains built packages
-    @@pkg_dir = 'pkg'
-
-    # Words used in project names, but never in directory names
-    @@ignore_namespaces = %w[ruby java]
-
-    # Common project prefixes and namespaces
-    @@common_namespaces = {
-      'ffi' => 'FFI',
-      'dm' => 'DataMapper'
-    }
-
-    #
-    # Splits the project name into individual names.
-    #
-    # @param [String] name
-    #   The name to split.
-    #
-    # @return [Array<String>]
-    #   The individual names of the project name.
-    #
-    def names_in(name)
-      name.split('-').reject do |word|
-        @@ignore_namespaces.include?(word)
-      end
-    end
-
-    #
-    # Guesses the module names from a project name.
-    #
-    # @return [Array<String>]
-    #   The module names for a project.
-    #
-    def modules_of(name)
-      names_in(name).map do |words|
-        words.split('_').map { |word|
-          @@common_namespaces[word] || word.capitalize
-        }.join
-      end
-    end
-
-    #
-    # Guesses the full namespace for a project.
-    #
-    # @return [String]
-    #   The full module namespace for a project.
-    #
-    def namespace_of(name)
-      modules_of(name).join('::')
-    end
-
-    #
-    # Converts a camel-case name to an underscored file name.
-    #
-    # @param [String] name
-    #   The name to underscore.
-    #
-    # @return [String]
-    #   The underscored version of the name.
-    #
-    def underscore(name)
-      name.gsub(/[^A-Z_][A-Z][^A-Z_]/) { |cap|
-        cap[0,1] + '_' + cap[1..-1]
-      }.downcase
-    end
-
-    #
-    # Guesses the namespace directories within `lib/` for a project.
-    #
-    # @return [Array<String>]
-    #   The namespace directories for the project.
-    #
-    def namespace_dirs_of(name)
-      names_in(name).map { |word| underscore(word) }
-    end
-
-    #
-    # Guesses the namespace directory within `lib/` for a project.
-    #
-    # @return [String]
-    #   The namespace directory for the project.
-    #
-    def namespace_path_of(name)
-      File.join(namespace_dirs_of(name))
-    end
-  end
-end

data/lib/ore/paths.rb

@@ -1,146 +0,0 @@
-require 'ore/naming'
-
-module Ore
-  #
-  # A mixin for {Project} which provides methods for working with paths.
-  #
-  module Paths
-    include Naming
-
-    #
-    # Builds a path relative to the project.
-    #
-    # @param [Array] names
-    #   The directory names of the path.
-    #
-    # @return [Pathname]
-    #   The new path.
-    #
-    def path(*names)
-      @root.join(*names)
-    end
-
-    #
-    # The `bin/` directory of the project.
-    #
-    # @return [Pathname]
-    #   The path to the `bin/` directory.
-    #
-    def bin_dir
-      @root.join(@@lib_dir)
-    end
-
-    #
-    # The `lib/` directory of the project.
-    #
-    # @return [Pathname]
-    #   The path to the `lib/` directory.
-    #
-    def lib_dir
-      @root.join(@@lib_dir)
-    end
-
-    #
-    # The `pkg/` directory of the project.
-    #
-    # @return [Pathname]
-    #   The path to the `pkg/` directory.
-    #
-    def pkg_dir
-      @root.join(@@pkg_dir)
-    end
-
-    #
-    # Builds a path relative to the `lib/` directory.
-    #
-    # @param [Array] names
-    #   The directory names of the path.
-    #
-    # @return [Pathname]
-    #   The new path.
-    #
-    def lib_path(*names)
-      path(@@lib_dir,*names)
-    end
-
-    #
-    # Builds a relative path into the `pkg/` directory for the `.gem` file.
-    #
-    # @return [String]
-    #   The path of a `.gem` file for the project.
-    #
-    def pkg_file
-      File.join(@@pkg_dir,"#{@name}-#{@version}.gem")
-    end
-
-    #
-    # Determines if a directory exists within the project.
-    #
-    # @param [String] path
-    #   The path of the directory, relative to the project.
-    #
-    # @return [Boolean]
-    #   Specifies whether the directory exists in the project.
-    #
-    def directory?(path)
-      @root.join(path).directory?
-    end
-
-    #
-    # Determines if a file exists within the project.
-    #
-    # @param [String] path
-    #   The path of the file, relative to the project.
-    #
-    # @return [Boolean]
-    #   Specifies whether the file exists in the project.
-    #
-    def file?(path)
-      @project_files.include?(path)
-    end
-
-    #
-    # Determines if a directory exists within the `lib/` directory of the
-    # project.
-    #
-    # @return [Boolean]
-    #   Specifies that the directory exists within the `lib/` directory.
-    #
-    def lib_directory?(path)
-      directory?(File.join(@@lib_dir,path))
-    end
-
-    #
-    # Determines if a file exists within the `lib/` directory of the
-    # project.
-    #
-    # @return [Boolean]
-    #   Specifies that the file exists within the `lib/` directory.
-    #
-    def lib_file?(path)
-      file?(File.join(@@lib_dir,path))
-    end
-
-    #
-    # Finds paths within the project that match a glob pattern.
-    #
-    # @param [String] pattern
-    #   The glob pattern.
-    #
-    # @yield [path]
-    #   The given block will be passed matching paths.
-    #
-    # @yieldparam [String] path
-    #   A path relative to the root directory of the project.
-    #
-    def glob(pattern)
-      within do
-        Dir.glob(pattern) do |path|
-          if (@project_files.include?(path) || File.directory?(path))
-            yield path
-          end
-        end
-      end
-    end
-  end
-end