ore 0.8.1 → 0.9.0

data/lib/ore/naming.rb

@@ -0,0 +1,160 @@
+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/).
+  #
+  # @since 0.9.0
+  #
+  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[core ruby rb java]
+
+    # Common acronyms used in namespaces
+    NAMESPACE_ACRONYMS = %w[
+      ffi yard i18n
+      http https ftp smtp imap pop3 ssh ssl tcp udp dns rpc
+      url uri www css html xhtml xml xsl json yaml csv
+      posix unix bsd
+      cpp asm
+    ]
+
+    # Common project prefixes and namespaces
+    COMMON_NAMESPACES = {
+      'rubygems' => 'Gem',
+      'ar'       => 'ActiveRecord',
+      'dm'       => 'DataMapper',
+      'js'       => 'JavaScript',
+      'msgpack'  => 'MsgPack',
+      'github'   => 'GitHub',
+      'rdoc'     => 'RDoc'
+    }
+
+    #
+    # 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 name for a word within a project name.
+    #
+    # @param [String] word
+    #   The word within a project name.
+    #
+    # @return [String]
+    #   The module name.
+    #
+    # @since 0.1.1
+    #
+    def module_of(word)
+      if COMMON_NAMESPACES.has_key?(word)
+        COMMON_NAMESPACES[word]
+      elsif NAMESPACE_ACRONYMS.include?(word)
+        word.upcase
+      else
+        word.capitalize
+      end
+    end
+
+    #
+    # Guesses the module names from a project name.
+    #
+    # @param [String] name
+    #   The name of the project.
+    #
+    # @return [Array<String>]
+    #   The module names for a project.
+    #
+    def modules_of(name)
+      names_in(name).map do |words|
+        words.split('_').map { |word| module_of(word) }.join
+      end
+    end
+
+    #
+    # Guesses the full namespace for a project.
+    #
+    # @param [String] name
+    #   The name of the 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.
+    #
+    # @param [String] name
+    #   The name of the 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.
+    #
+    # @param [String] name
+    #   The name of the project.
+    #
+    # @return [String]
+    #   The namespace directory for the project.
+    #
+    def namespace_path_of(name)
+      File.join(namespace_dirs_of(name))
+    end
+  end
+end

data/lib/ore/options.rb

@@ -0,0 +1,67 @@
+require 'ore/config'
+require 'ore/template'
+
+module Ore
+  #
+  # @api semipublic
+  #
+  # @since 0.9.0
+  #
+  module Options
+    # Default version
+    DEFAULT_VERSION = '0.1.0'
+
+    # Default summary
+    DEFAULT_SUMMARY = %q{TODO: Summary}
+
+    # Default description
+    DEFAULT_DESCRIPTION = %q{TODO: Description}
+
+    # Default License
+    DEFAULT_LICENSE = 'MIT'
+
+    # Default authors
+    DEFAULT_AUTHORS = [ENV['USER']]
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    #
+    # Default options for the generator.
+    #
+    # @return [Hash{Symbol => Object}]
+    #   The option names and default values.
+    #
+    def self.defaults
+      @@defaults ||= {
+        :templates      => [],
+        :version        => DEFAULT_VERSION,
+        :summary        => DEFAULT_SUMMARY,
+        :description    => DEFAULT_DESCRIPTION,
+        :license        => DEFAULT_LICENSE,
+        :authors        => DEFAULT_AUTHORS,
+        :gemspec        => true,
+        :rubygems_tasks => true,
+        :rdoc           => true,
+        :rspec          => true,
+        :git            => true
+      }.merge(Config.options)
+    end
+
+    module ClassMethods
+      #
+      # Defines a generator option.
+      #
+      # @param [Symbol] name
+      #   The name of the option.
+      #
+      # @param [Hash{Symbol => Object}] options
+      #   The Thor options of the option.
+      #
+      def generator_option(name,options={})
+        class_option(name,options.merge(:default => Options.defaults[name]))
+      end
+    end
+  end
+end

data/lib/ore/template.rb

@@ -1,3 +1,11 @@
 require 'ore/template/directory'
 require 'ore/template/interpolations'
 require 'ore/template/helpers'
+require 'ore/template/template'
+require 'ore/config'
+
+# register builtin templates
+Ore::Config.builtin_templates { |path| Ore::Template.register(path) }
+
+# register installed templates
+Ore::Config.installed_templates { |path| Ore::Template.register(path) }

data/lib/ore/template/directory.rb

@@ -6,22 +6,22 @@ require 'find'
 module Ore
   module Template
     #
-    # Represents a template directory and the static files, ERb files
+    # Represents a template directory and the static files, `.erb` files
     # and sub-directories within it.
     #
     class Directory
 
       # The template configuration file
-      @@config_file = 'template.yml'
+      CONFIG_FILE = 'template.yml'
 
       # Files or directory names to ignore
-      @@ignore = ['.git', @@config_file]
+      IGNORE = ['.git', CONFIG_FILE]
 
       # The known markup languages and file extensions
-      @@markups = {
+      MARKUPS = {
         :markdown => %w[.md .markdown],
-        :textile => %w[.tt .textile],
-        :rdoc => %w[.rdoc]
+        :textile  => %w[.tt .textile],
+        :rdoc     => %w[.rdoc]
       }
 
       # The path of the template directory
@@ -48,6 +48,21 @@ module Ore
       # The variables to use when rendering the template files
       attr_reader :variables
 
+      # Files to ignore
+      #
+      # @since 0.9.0
+      attr_reader :ignore
+
+      # Runtime dependencies defined by the template
+      #
+      # @since 0.9.0
+      attr_reader :dependencies
+
+      # Development dependencies defined by the template
+      #
+      # @since 0.9.0
+      attr_reader :development_dependencies
+
       #
       # Initializes a new template directory.
       #
@@ -58,13 +73,17 @@ module Ore
         @path = File.expand_path(path)
 
         @directories = []
-        @files = {}
-        @templates = {}
-        @includes = Hash.new { |hash,key| hash[key] = {} }
+        @files       = {}
+        @templates   = {}
+        @includes    = Hash.new { |hash,key| hash[key] = {} }
 
         @disable = []
-        @enable = []
-        @variables = {}
+        @enable  = []
+
+        @ignore                   = []
+        @dependencies             = {}
+        @development_dependencies = {}
+        @variables                = {}
 
         load!
         scan!
@@ -134,41 +153,41 @@ module Ore
       # @since 0.2.0
       #
       def load!
-        config_path = File.join(@path,@@config_file)
+        config_path = File.join(@path,CONFIG_FILE)
         return false unless File.file?(config_path)
 
         config = YAML.load_file(config_path)
+        return false unless config.kind_of?(Hash)
 
-        unless config.kind_of?(Hash)
-          raise(InvalidTemplate,"invalid configuration in #{config_path.dump}")
-        end
+        @disable = Array(config['disable']).map(&:to_sym)
+        @enable  = Array(config['enable']).map(&:to_sym)
 
-        if (templates = config['disable'])
-          if templates.kind_of?(Array)
-            templates.each { |name| @disable << name.to_sym }
-          else
-            @disable << templates.to_sym
-          end
-        end
+        @ignore = Array(config['ignore'])
 
-        if (templates = config['enable'])
-          if templates.kind_of?(Array)
-            templates.each { |name| @enable << name.to_sym }
-          else
-            @enable << templates.to_sym
-          end
+        case (dependencies = config['dependencies'])
+        when Hash
+          @dependencies.merge!(dependencies)
+        when nil
+        else
+          raise(InvalidTemplate,"template dependencies must be a Hash: #{config_path.dump}")
         end
 
-        if (variables = config['variables'])
-          # variables must be a Hash
-          unless variables.kind_of?(Hash)
-            raise(InvalidTemplate,"template variables must be a Hash: #{config_path.dump}")
-          end
+        case (dependencies = config['development_dependencies'])
+        when Hash
+          @development_dependencies.merge!(dependencies)
+        when nil
+        else
+          raise(InvalidTemplate,"template dependencies must be a Hash: #{config_path.dump}")
+        end
 
-          # load the template variables
+        case (variables = config['variables'])
+        when Hash
           variables.each do |name,value|
             @variables[name.to_sym] = value
           end
+        when nil
+        else
+          raise(InvalidTemplate,"template variables must be a Hash: #{config_path.dump}")
         end
 
         return true
@@ -188,7 +207,7 @@ module Ore
             name = File.basename(file)
 
             # ignore certain files/directories
-            Find.prune if @@ignore.include?(name)
+            Find.prune if IGNORE.include?(name)
 
             if File.directory?(file)
               @directories << file
@@ -198,14 +217,14 @@ module Ore
               case File.extname(name)
               when '.erb'
                 # erb template
-                if name[0,1] == '_'
+                if name.start_with?('_')
                   # partial template
-                  template_dir = File.dirname(file)
-                  template_name = name[1...-4].to_sym
+                  template_dir  = File.dirname(file)
+                  template_name = name[1..-1].chomp('.erb').to_sym
 
                   @includes[template_dir][template_name] = src
                 else
-                  dest = file[0...-4]
+                  dest = file.chomp('.erb')
 
                   @templates[dest] = src
                 end
@@ -228,7 +247,7 @@ module Ore
       #   Specifies whether the file is formatting.
       #
       def formatted?(path)
-        @@markups.values.any? { |exts| exts.include?(File.extname(path)) }
+        MARKUPS.values.any? { |exts| exts.include?(File.extname(path)) }
       end
 
       #
@@ -244,7 +263,7 @@ module Ore
       #   Specifies whether the file contains the given formatting.
       #
       def formatted_like?(path,markup)
-        @@markups[markup].include?(File.extname(path))
+        MARKUPS[markup].include?(File.extname(path))
       end
 
     end

data/lib/ore/template/helpers.rb

@@ -63,7 +63,31 @@ module Ore
       # @since 0.7.0
       #
       def git?
-        options.git?
+        @scm == :git
+      end
+
+      #
+      # Determines if Hg is enabled.
+      #
+      # @return [Boolean]
+      #   Specifies whether Hg was enabled.
+      #
+      # @since 0.9.0
+      #
+      def hg?
+        @scm == :hg
+      end
+
+      #
+      # Determines if SVN is enabled.
+      #
+      # @return [Boolean]
+      #   Specifies whether SVN was enabled.
+      #
+      # @since 0.9.0
+      #
+      def svn?
+        @scm == :svn
       end
 
       #
@@ -95,7 +119,7 @@ module Ore
       #   Specifies whether the project will contain RDoc documented.
       #
       def rdoc?
-        options.rdoc?
+        enabled?(:rdoc)
       end
 
       #
@@ -138,6 +162,30 @@ module Ore
         enabled?(:bundler)
       end
 
+      #
+      # Determines if the project is using `Bundler::GemHelper`.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project is using `Bundler::GemHelper`.
+      #
+      # @since 0.9.0
+      #
+      def bundler_tasks?
+        enabled?(:bundler_tasks)
+      end
+
+      #
+      # Determines if the project is using `Gem::Tasks`.
+      #
+      # @return [Boolean]
+      #   Specifies whether the project is using `Gem::Tasks`.
+      #
+      # @since 0.9.0
+      #
+      def rubygems_tasks?
+        enabled?(:rubygems_tasks)
+      end
+
       #
       # Determines if the project is using `Jeweler::Tasks`.
       #
@@ -151,15 +199,15 @@ module Ore
       end
 
       #
-      # Determines if the project is using `Ore::Tasks`.
+      # Determines if the project is using `Gem::PackageTask`.
       #
       # @return [Boolean]
-      #   Specifies whether the project is using `Ore::Tasks`.
+      #   Specifies whether the project is using `Gem::PackageTask`.
       #
-      # @since 0.3.0
+      # @since 0.9.0
       #
-      def ore_tasks?
-        enabled?(:ore_tasks)
+      def gem_package_task?
+        enabled?(:gem_package_task)
       end
 
       #