ore 0.1.2

data/lib/ore/settings.rb

@@ -0,0 +1,236 @@
+require 'ore/exceptions/invalid_metadata'
+require 'ore/versions/version'
+require 'ore/dependency'
+
+module Ore
+  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)
+      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)
+        license.each { |name| @licenses << name.to_s }
+      else
+        @licenses << license.to_s
+      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 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|
+        @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|
+        @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|
+        @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/template.rb

@@ -0,0 +1,3 @@
+require 'ore/template/directory'
+require 'ore/template/interpolations'
+require 'ore/template/helpers'

data/lib/ore/template/directory.rb

@@ -0,0 +1,179 @@
+require 'find'
+
+module Ore
+  module Template
+    class Directory
+
+      # Files or directory names to ignore
+      @@ignore = %w[.git]
+
+      # The known markup languages and file extensions
+      @@markups = {
+        :markdown => %w[.md .markdown],
+        :textile => %w[.tt .textile],
+        :rdoc => %w[.rdoc]
+      }
+
+      # The path of the template directory
+      attr_reader :path
+
+      # The directories within the template directory
+      attr_reader :directories
+
+      # The static files in the template directory
+      attr_reader :files
+
+      # The ERb templates in the template directory
+      attr_reader :templates
+
+      # The include templates in the template directory
+      attr_reader :includes
+
+      #
+      # Initializes a new template directory.
+      #
+      # @param [String] path
+      #   The path to the template directory.
+      #
+      def initialize(path)
+        @path = File.expand_path(path)
+
+        @directories = []
+        @files = {}
+        @templates = {}
+        @includes = Hash.new { |hash,key| hash[key] = {} }
+
+        scan!
+      end
+
+      #
+      # Enumerates through the directories in the template directory.
+      #
+      # @yield [path]
+      #   The given block will be passed each directory path.
+      #
+      # @yieldparam [String] path
+      #   The relative path of a directory within the template directory.
+      #
+      def each_directory(&block)
+        @directories.each(&block)
+      end
+
+      #
+      # Enumerates through every file in the template directory.
+      #
+      # @param [Symbol] markup
+      #   The markup to look for.
+      #
+      # @yield [path]
+      #   The given block will be passed each file path.
+      #
+      # @yieldparam [String] path
+      #   A relative path of a file within the template directory.
+      #
+      def each_file(markup)
+        @files.each do |dest,file|
+          if (formatted_like?(dest,markup) || !formatted?(dest))
+            yield dest, file
+          end
+        end
+      end
+
+      #
+      # Enumerates over every template within the template directory.
+      #
+      # @param [Symbol] markup
+      #   The markup to look for.
+      #
+      # @yield [path]
+      #   The given block will be passed each template path.
+      #
+      # @yieldparam [String] path
+      #   A relative path of a template within the template directory.
+      #
+      def each_template(markup)
+        @templates.each do |dest,file|
+          if (formatted_like?(dest,markup) || !formatted?(dest))
+            yield dest, file
+          end
+        end
+      end
+
+      protected
+
+      #
+      # Scans the template directory recursively recording the directories,
+      # files and partial templates.
+      #
+      def scan!
+        Dir.chdir(@path) do
+          Find.find('.') do |file|
+            next if file == '.'
+
+            # ignore the ./
+            file = file[2..-1]
+            name = File.basename(file)
+
+            # ignore certain files/directories
+            Find.prune if @@ignore.include?(name)
+
+            if File.directory?(file)
+              @directories << file
+            elsif File.file?(file)
+              src = File.join(@path,file)
+
+              case File.extname(name)
+              when '.erb'
+                # erb template
+                if name[0,1] == '_'
+                  # partial template
+                  template_dir = File.dirname(file)
+                  template_name = name[1...-4].to_sym
+
+                  @includes[template_dir][template_name] = src
+                else
+                  dest = file[0...-4]
+
+                  @templates[dest] = src
+                end
+              else
+                # static file
+                @files[file] = src
+              end
+            end
+          end
+        end
+      end
+
+      #
+      # Determines whether a file is markup formatted.
+      #
+      # @param [String] path
+      #   The path to the file.
+      #
+      # @return [Boolean]
+      #   Specifies whether the file is formatting.
+      #
+      def formatted?(path)
+        @@markups.values.any? { |exts| exts.include?(File.extname(path)) }
+      end
+
+      #
+      # Determines if a file has a specific type of markup formatting.
+      #
+      # @param [String] path
+      #   The path to the file.
+      #
+      # @param [Symbol] markup
+      #   The specified type of markup.
+      #
+      # @return [Boolean]
+      #   Specifies whether the file has the sepcified formatting.
+      #
+      def formatted_like?(path,markup)
+        @@markups[markup].include?(File.extname(path))
+      end
+
+    end
+  end
+end