ore-core 0.1.0

data/lib/ore.rb

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

data/lib/ore/checks.rb

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

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

data/lib/ore/dependency.rb

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

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

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

data/lib/ore/exceptions/exception.rb

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

data/lib/ore/exceptions/invalid_metadata.rb

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

data/lib/ore/exceptions/project_not_found.rb

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

data/lib/ore/naming.rb

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