ore-core 0.1.0

data/lib/ore/settings.rb

@@ -0,0 +1,274 @@
+require 'ore/exceptions/invalid_metadata'
+require 'ore/versions/version'
+require 'ore/dependency'
+
+module Ore
+  #
+  # A mixin for {Project} which provides methods for normalizing and
+  # setting project attributes.
+  #
+  module Settings
+    protected
+
+    #
+    # Sets the version of the project.
+    #
+    # @param [Hash<Integer>, String] version
+    #   The version from the metadata file.
+    #
+    # @raise [InvalidVersion]
+    #   The version must either be a `String` or a `Hash`.
+    #
+    def set_version!(version)
+      case version
+      when Hash
+        major = version['major']
+        minor = version['minor']
+        patch = version['patch']
+        build = version['build']
+
+        @version = Versions::Version.new(major,minor,patch,build)
+      when String
+        @version = Versions::Version.parse(version.to_s)
+      else
+        raise(InvalidMetadata,"version must be a Hash or a String")
+      end
+    end
+
+    #
+    # Sets the license(s) of the project.
+    #
+    # @param [Array, String] license
+    #   The license(s) of the project.
+    #
+    def set_license!(license)
+      if license.kind_of?(Array)
+        @licenses += license
+      else
+        @licenses << license
+      end
+    end
+
+    #
+    # Sets the authors of the project.
+    #
+    # @param [Array<String>, String] authors
+    #   The authors listed in the metadata file.
+    #
+    def set_authors!(authors)
+      if authors.kind_of?(Array)
+        @authors += authors
+      else
+        @authors << authors
+      end
+    end
+
+    #
+    # Sets the release date of the project.
+    #
+    # @param [String] date
+    #   The release date from the metadata file.
+    #
+    def set_date!(date)
+      @date = Date.parse(date)
+    end
+
+    #
+    # Sets the require-paths of the project.
+    #
+    # @param [Array<String>, String] paths
+    #   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
+    end
+
+    #
+    # Sets the executables of the project.
+    #
+    # @param [Array<String>, String]
+    #   The executable names or the glob-pattern listed in the metadata
+    #   file.
+    #   
+    def set_executables!(paths)
+      if paths.kind_of?(Array)
+        paths.each { |path| add_executable(path) }
+      else
+        glob(paths) { |path| add_executable(path) }
+      end
+    end
+
+    #
+    # Sets the default executable of the project.
+    #
+    # @param [String] name
+    #   The default executable name listed in the metadata file.
+    #
+    def set_default_executable!(name)
+      if @executables.include?(name)
+        @default_executable = name
+      else
+        warn "#{name} is not in the executables list"
+      end
+    end
+
+    #
+    # Sets the extra documentation files of the project.
+    #
+    # @param [Array<String>, String] paths
+    #   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
+    end
+
+    #
+    # Sets the files of the project.
+    #
+    # @param [Array<String>, String] paths
+    #   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
+    end
+
+    #
+    # Sets the test-files of the project.
+    #
+    # @param [Array<String>, String] paths
+    #   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
+    end
+
+    #
+    # Sets the external requirements of the project.
+    #
+    # @param [Array, String] requirements
+    #   The external requirements.
+    #
+    # @since 0.2.0
+    #
+    def set_requirements!(requirements)
+      if requirements.kind_of?(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.
+    #
+    # @param [Hash{String => String}] dependencies
+    #   The dependencey names and versions listed in the metadata file.
+    #
+    # @raise [InvalidMetadata]
+    #   The dependencies must be a `Hash`.
+    #
+    def set_dependencies!(dependencies)
+      unless dependencies.kind_of?(Hash)
+        raise(InvalidMetadata,"dependencies must be a Hash")
+      end
+
+      dependencies.each do |name,versions|
+        versions = versions.to_s
+
+        @dependencies << Dependency.parse_versions(name,versions)
+      end
+    end
+
+    #
+    # Sets the runtime-dependencies of the project.
+    #
+    # @param [Hash{String => String}] dependencies
+    #   The runtime-dependencey names and versions listed in the metadata
+    #   file.
+    #
+    # @raise [InvalidMetadata]
+    #   The runtime-dependencies must be a `Hash`.
+    #
+    def set_runtime_dependencies!(dependencies)
+      unless dependencies.kind_of?(Hash)
+        raise(InvalidMetadata,"runtime_dependencies must be a Hash")
+      end
+
+      dependencies.each do |name,versions|
+        versions = versions.to_s
+
+        @runtime_dependencies << Dependency.parse_versions(name,versions)
+      end
+    end
+
+    #
+    # Sets the development-dependencies of the project.
+    #
+    # @param [Hash{String => String}] dependencies
+    #   The development-dependencey names and versions listed in the
+    #   metadata file.
+    #
+    # @raise [InvalidMetadata]
+    #   The development-dependencies must be a `Hash`.
+    #
+    def set_development_dependencies!(dependencies)
+      unless dependencies.kind_of?(Hash)
+        raise(InvalidMetadata,"development_dependencies must be a Hash")
+      end
+
+      dependencies.each do |name,versions|
+        versions = versions.to_s
+
+        @development_dependencies << Dependency.parse_versions(name,versions)
+      end
+    end
+  end
+end

data/lib/ore/specification.rb

@@ -0,0 +1,29 @@
+require 'ore/project'
+
+module Ore
+  #
+  # Acts as a drop-in replacement for calling `Gem::Specification.new`
+  # in a projects gemspec file.
+  #
+  module Specification
+    #
+    # Creates a new Gem Specification, and automatically populates it
+    # using the metadata file.
+    #
+    # @yield [gemspec]
+    #   The given block will be passed the populated Gem Specification
+    #   object.
+    #
+    # @yieldparam [Gem::Specification] gemspec
+    #   The newly created Gem Specification.
+    #
+    # @return [Gem::Specification]
+    #   The Gem Specification.
+    #
+    # @see Project#to_gemspec
+    #
+    def Specification.new(&block)
+      Project.find.to_gemspec(&block)
+    end
+  end
+end

data/lib/ore/versions.rb

@@ -0,0 +1,3 @@
+require 'ore/versions/version'
+require 'ore/versions/version_file'
+require 'ore/versions/version_constant'

data/lib/ore/versions/exceptions.rb

@@ -0,0 +1 @@
+require 'ore/versions/exceptions/invalid_version'

data/lib/ore/versions/exceptions/invalid_version.rb

@@ -0,0 +1,8 @@
+require 'ore/exceptions/exception'
+
+module Ore
+  module Versions
+    class InvalidVersion < Exception
+    end
+  end
+end

data/lib/ore/versions/version.rb

@@ -0,0 +1,75 @@
+require 'ore/versions/exceptions/invalid_version'
+
+require 'rubygems/version'
+
+module Ore
+  module Versions
+    #
+    # Represents a standard three-number version.
+    #
+    # @see http://semver.org/
+    #
+    class Version < Gem::Version
+
+      # Major version number
+      attr_reader :major
+
+      # Minor version number
+      attr_reader :minor
+
+      # Patch version number
+      attr_reader :patch
+
+      # The build string
+      attr_reader :build
+
+      #
+      # Creates a new version.
+      #
+      # @param [Integer, nil] major
+      #   The major version number.
+      #
+      # @param [Integer, nil] minor
+      #   The minor version number.
+      #
+      # @param [Integer, nil] patch
+      #   The patch version number.
+      #
+      # @param [Integer, nil] build (nil)
+      #   The build version number.
+      #
+      def initialize(major,minor,patch,build=nil)
+        @major = (major || 0)
+        @minor = (minor || 0)
+        @patch = (patch || 0)
+        @build = build
+
+        numbers = [@major,@minor,@patch]
+        numbers << @build if  @build
+
+        super(numbers.join('.'))
+      end
+
+      #
+      # Parses a version string.
+      #
+      # @param [String] string
+      #   The version string.
+      #
+      # @return [Version]
+      #   The parsed version.
+      #
+      def self.parse(string)
+        major, minor, patch, build = string.split('.',4)
+
+        return self.new(
+          (major || 0).to_i,
+          (minor || 0).to_i,
+          (patch || 0).to_i,
+          build
+        )
+      end
+
+    end
+  end
+end

data/lib/ore/versions/version_constant.rb

@@ -0,0 +1,126 @@
+require 'ore/versions/version'
+require 'ore/naming'
+
+module Ore
+  module Versions
+    #
+    # Represents a version loaded from a Ruby `VERSION` constant or
+    # `Version` module.
+    #
+    class VersionConstant < Version
+
+      include Naming
+
+      # Common file-name that the `VERSION` constant or `Version` module
+      # is defined within.
+      @@file_name = 'version.rb'
+
+      #
+      # Finds the `version.rb` file.
+      #
+      # @param [Project] project
+      #   The project.
+      #
+      # @return [VersionConstant, nil]
+      #   The loaded version constant.
+      #
+      def self.find(project)
+        if project.namespace_dir
+          path = File.join(project.namespace_dir,@@file_name)
+
+          self.load(project.lib_path(path)) if project.lib_file?(path)
+        end
+      end
+
+      #
+      # Extracts the `VERSION` constant or the major / minor / patch / build
+      # version numbers from the `Version` module.
+      #
+      # @param [String] path
+      #   The path to the `version.rb` file.
+      #
+      # @return [VersionConstant, nil]
+      #   The loaded version constant.
+      #
+      def self.load(path)
+        major = nil
+        minor = nil
+        patch = nil
+        build = nil
+
+        File.open(path) do |file|
+          file.each_line do |line|
+            unless line =~ /^\s*#/ # skip commented lines
+              if line =~ /(VERSION|Version)\s*=\s*/
+                version = extract_version(line)
+
+                return self.parse(version) if version
+              elsif line =~ /(MAJOR|Major)\s*=\s*/
+                major ||= extract_number(line)
+              elsif line =~ /(MINOR|Minor)\s*=\s*/
+                minor ||= extract_number(line)
+              elsif line =~ /(PATCH|Patch)\s*=\s*/
+                patch ||= extract_number(line)
+              elsif line =~ /(BUILD|Build)\s*=\s*/
+                build ||= extract_string(line)
+              end
+
+              break if (major && minor && patch && build)
+            end
+          end
+        end
+
+        return self.new(major,minor,patch,build)
+      end
+
+      protected
+
+      #
+      # Extracts the version string from a `VERSION` constant declaration.
+      #
+      # @param [String] line
+      #   The line of Ruby code where the `VERSION` constant was defined.
+      #
+      # @return [String, nil]
+      #   The extracted version string.
+      #
+      def self.extract_version(line)
+        if (match = line.match(/=\s*['"](\d+\.\d+\.\d+(\.\w+)?)['"]/))
+          match[1]
+        end
+      end
+
+      #
+      # Extracts a number from a `BUILD` constant declaration.
+      #
+      # @param [String] line
+      #   The line of Ruby code where the constant was defined.
+      #
+      # @return [String, nil]
+      #   The extracted string.
+      #
+      def self.extract_string(line)
+        if (match = line.match(/=\s*['"]?(\w+)['"]?/))
+          match[1]
+        end
+      end
+
+      #
+      # Extracts a version number from a `MAJOR`, `MINOR`, `PATCH` or
+      # `BUILD` constant declaration.
+      #
+      # @param [String] line
+      #   The line of Ruby code where the constant was defined.
+      #
+      # @return [Integer, nil]
+      #   The extracted version number.
+      #
+      def self.extract_number(line)
+        if (match = line.match(/=\s*['"]?(\d+)['"]?/))
+          match[1].to_i
+        end
+      end
+
+    end
+  end
+end