ore 0.1.2

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/generator.rb

@@ -0,0 +1,247 @@
+require 'ore/template/directory'
+require 'ore/template/interpolations'
+require 'ore/template/helpers'
+require 'ore/naming'
+require 'ore/config'
+
+require 'thor/group'
+require 'date'
+require 'set'
+
+module Ore
+  class Generator < Thor::Group
+
+    include Thor::Actions
+    include Naming
+    include Template::Interpolations
+    include Template::Helpers
+
+    # The base template for all RubyGems
+    @@base_template = :base
+
+    #
+    # The templates registered with the generator.
+    #
+    def Generator.templates
+      @templates ||= {}
+    end
+
+    #
+    # Registers a template with the generator.
+    #
+    # @param [String] path
+    #   The path to the template.
+    #
+    # @raise [StandardError]
+    #   The given path was not a directory.
+    #
+    def Generator.register_template(path)
+      unless File.directory?(path)
+        raise(StandardError,"#{path.dump} is must be a directory")
+      end
+
+      name = File.basename(path).to_sym
+      Generator.templates[name] = path
+    end
+
+    Config.builtin_templates { |path| Generator.register_template(path) }
+    Config.installed_templates { |path| Generator.register_template(path) }
+
+    namespace ''
+
+    class_option :markdown, :type => :boolean, :default => false
+    class_option :textile, :type => :boolean, :default => false
+    class_option :templates, :type => :array,
+                             :default => [],
+                             :aliases => '-T'
+    class_option :name, :type => :string, :aliases => '-n'
+    class_option :version, :type => :string,
+                            :default => '0.1.0',
+                            :aliases => '-V'
+    class_option :summary, :default => 'TODO: Summary',
+                           :aliases => '-s'
+    class_option :description, :default => 'TODO: Description',
+                               :aliases => '-D'
+    class_option :license, :default => 'MIT', :aliases => '-L'
+    class_option :homepage, :type => :string, :aliases => '-U'
+    class_option :email, :type => :string, :aliases => '-e'
+    class_option :authors, :type => :array,
+                           :default => [ENV['USER']], :aliases => '-a'
+    class_option :rdoc, :type => :boolean, :default => true
+    class_option :yard, :type => :boolean, :default => false
+    class_option :test_unit, :type => :boolean, :default => false
+    class_option :rspec, :type => :boolean, :default => true
+    class_option :bundler, :type => :boolean, :default => false
+    class_option :jeweler_tasks, :type => :boolean, :default => false
+    class_option :ore_tasks, :type => :boolean, :default => false
+    class_option :git, :type => :boolean, :default => true
+    argument :path, :required => true
+
+    def generate
+      self.destination_root = path
+
+      enable_templates!
+      load_templates!
+      initialize_variables!
+
+      say "Generating #{self.destination_root}", :green
+
+      generate_directories!
+      generate_files!
+
+      if options.git?
+        in_root do
+          unless File.directory?('.git')
+            run 'git init'
+            run 'git add .'
+            run 'git commit -m "Initial commit."'
+          end
+        end
+      end
+    end
+
+    protected
+
+    #
+    # Enables templates.
+    #
+    def enable_templates!
+      @enabled_templates = [@@base_template]
+
+      @enabled_templates << :bundler if options.bundler?
+      @enabled_templates << :jeweler_tasks if options.jeweler_tasks?
+      @enabled_templates << :ore_tasks if options.ore_tasks?
+      
+      if options.rspec?
+        @enabled_templates << :rspec
+      elsif options.test_unit?
+        @enabled_templates << :test_unit
+      end
+
+      if options.yard?
+        @enabled_templates << :yard
+      elsif options.rdoc?
+        @enabled_templates << :rdoc
+      end
+
+      options.templates.each do |name|
+        name = name.to_sym
+
+        unless @enabled_templates.include?(name)
+          @enabled_templates << name
+        end
+      end
+    end
+
+    #
+    # Loads the given templates.
+    #
+    def load_templates!
+      @templates = []
+      
+      @enabled_templates.each do |name|
+        unless (template_dir = Generator.templates[name])
+          say "Unknown template #{name.dump}", :red
+          exit -1
+        end
+
+        self.source_paths << template_dir
+        @templates << Template::Directory.new(template_dir)
+      end
+    end
+
+    #
+    # Initializes variables for the templates.
+    #
+    def initialize_variables!
+      @ore_version = '0.1.0'
+
+      @project_dir = File.basename(destination_root)
+      @name = (options.name || @project_dir)
+
+      @modules = modules_of(@name)
+      @module_depth = @modules.length
+      @module = @modules.last
+
+      @namespace = namespace_of(@name)
+      @namespace_dirs = namespace_dirs_of(@name)
+      @namespace_dir = namespace_path_of(@name)
+
+      @version = options.version
+      @summary = options.summary
+      @description = options.description
+      @license = options.license
+      @email = options.email
+      @safe_email = @email.sub('@',' at ') if @email
+      @homepage = (options.homepage || "http://rubygems.org/gems/#{@name}")
+      @authors = options.authors
+      @author = options.authors.first
+
+      @markup = if options.yard?
+                  if options.markdown?
+                    :markdown
+                  elsif options.textile?
+                    :textile
+                  else
+                    :rdoc
+                  end
+                else
+                  :rdoc
+                end
+
+      @date = Date.today
+      @year = @date.year
+      @month = @date.month
+      @day = @date.day
+    end
+
+    #
+    # Creates directories listed in the template directories.
+    #
+    def generate_directories!
+      generated = Set[]
+
+      @templates.each do |template|
+        template.each_directory do |dir|
+          unless generated.include?(dir)
+            path = interpolate(dir)
+            empty_directory path
+
+            generated << dir
+          end
+        end
+      end
+    end
+
+    #
+    # Copies static files and renders templates in the template directories.
+    #
+    def generate_files!
+      generated = Set[]
+
+      @templates.reverse_each do |template|
+        template.each_file(@markup) do |dest,file|
+          unless generated.include?(dest)
+            path = interpolate(dest)
+            copy_file file, path
+
+            generated << dest
+          end
+        end
+
+        template.each_template(@markup) do |dest,file|
+          unless generated.include?(dest)
+            path = interpolate(dest)
+
+            @current_template_dir = File.dirname(dest)
+            template file, path
+            @current_template_dir = nil
+
+            generated << dest
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/ore/naming.rb

@@ -0,0 +1,95 @@
+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'
+
+    # Common project prefixes and namespaces
+    @@common_namespaces = {
+      'ffi' => 'FFI',
+      'dm' => 'DataMapper'
+    }
+
+    #
+    # Guesses the module names from a project name.
+    #
+    # @return [Array<String>]
+    #   The module names for a project.
+    #
+    def modules_of(name)
+      name.split('-').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)
+      name.split('-').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