ore 0.1.2

data/lib/ore/template/helpers.rb

@@ -0,0 +1,144 @@
+module Ore
+  module Template
+    module Helpers
+      protected
+
+      #
+      # Renders all include files with the given name.
+      #
+      # @param [Symbol] name
+      #   The name of the include.
+      #
+      # @return [String]
+      #   The combined result of the rendered include files.
+      #
+      def includes(name,separator=$/)
+        name = name.to_sym
+        output_buffer = []
+
+        if @current_template_dir
+          context = instance_eval('binding')
+
+          @templates.each do |template|
+            if template.includes.has_key?(@current_template_dir)
+              path = template.includes[@current_template_dir][name]
+
+              if path
+                erb = ERB.new(File.read(path),nil,'-')
+                output_buffer << erb.result(context)
+              end
+            end
+          end
+        end
+
+        return output_buffer.join(separator)
+      end
+
+      #
+      # Determines if a template was enabled.
+      #
+      # @return [Boolean]
+      #   Specifies whether the template was enabled.
+      #
+      def enabled?(name)
+        @enabled_templates.include?(name.to_sym)
+      end
+
+      #
+      # Determines if the project will contain RDoc documented.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project will contain RDoc documented.
+      #
+      def rdoc?
+        options.rdoc?
+      end
+
+      #
+      # Determines if the project will contain YARD documented.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project will contain YARD documentation.
+      #
+      def yard?
+        enabled?(:yard)
+      end
+
+      #
+      # Determines if the project is using test-unit.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project is using test-unit.
+      #
+      def test_unit?
+        enabled?(:test_unit)
+      end
+
+      #
+      # Determines if the project is using RSpec.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project is using RSpec.
+      #
+      def rspec?
+        enabled?(:rspec)
+      end
+
+      #
+      # Determines if the project is using Bundler.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project is using Bundler.
+      #
+      def bundler?
+        enabled?(:bundler)
+      end
+
+      #
+      # Creates an indentation string.
+      #
+      # @param [Integer] n
+      #   The number of times to indent.
+      #
+      # @param [Integer] spaces
+      #   The number of spaces to indent by.
+      #
+      # @return [String]
+      #   The indentation string.
+      #
+      def indent(n,spaces=2)
+        (' ' * spaces) * n
+      end
+
+      #
+      # Escapes data for YAML encoding.
+      #
+      # @param [String] data
+      #   The data to escape.
+      #
+      # @return [String]
+      #   The YAML safe data.
+      #
+      def yaml_escape(data)
+        case data
+        when String
+          if data =~ /:\s/
+            data.dump
+          elsif data.include?($/)
+            lines = ['']
+
+            data.each_line do |line|
+              lines << "  #{line.strip}"
+            end
+
+            lines.join($/)
+          else
+            data
+          end
+        else
+          data.to_s
+        end
+      end
+    end
+  end
+end

data/lib/ore/template/interpolations.rb

@@ -0,0 +1,31 @@
+module Ore
+  module Template
+    module Interpolations
+      @@keywords = %w[
+        name
+        project_dir
+        namespace_dir
+      ]
+
+      protected
+
+      def interpolate(path)
+        dirs = path.split(File::SEPARATOR)
+
+        dirs.each do |dir|
+          dir.gsub!(/(:[a-z_]+:)/) do |capture|
+            keyword = capture[1..-2]
+
+            if @@keywords.include?(keyword)
+              instance_variable_get("@#{keyword}")
+            else
+              capture
+            end
+          end
+        end
+
+        return File.join(dirs.reject { |dir| dir.empty? })
+      end
+    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

data/lib/ore/versions/version_file.rb

@@ -0,0 +1,66 @@
+require 'ore/versions/exceptions/invalid_version'
+require 'ore/versions/version'
+
+require 'yaml'
+
+module Ore
+  module Versions
+    #
+    # Represents a version loaded from a `VERSION` file.
+    #
+    class VersionFile < Version
+
+      # Common `VERSION` file-names.
+      @@files = %w[VERSION VERSION.yml]
+
+      #
+      # Finds the `VERSION` file.
+      #
+      # @param [Project] project
+      #   The Ore project.
+      #
+      # @return [VersionFile, nil]
+      #   The version file of the project.
+      #
+      def self.find(project)
+        @@files.each do |name|
+          return load(project.path(name)) if project.file?(name)
+        end
+
+        return nil
+      end
+
+      #
+      # Loads the version file of the project.
+      #
+      # @param [String] path
+      #   The path to the version file.
+      #
+      # @return [VersionFile]
+      #   The loaded version file.
+      #
+      # @raise [InvalidVersion]
+      #   The `VERSION` file must contain either a `Hash` or a `String`.
+      #
+      def self.load(path)
+        data = YAML.load_file(path)
+
+        case data
+        when Hash
+          self.new(
+            (data[:major] || data['major']),
+            (data[:minor] || data['minor']),
+            (data[:patch] || data['patch']),
+            (data[:build] || data['build'])
+          )
+        when String
+          self.parse(data)
+        else
+          file = File.basename(@path)
+          raise(InvalidVersion,"invalid version data in #{file.dump}")
+        end
+      end
+
+    end
+  end
+end