ore 0.10.0 → 0.11.0

data/data/ore/templates/yard/_tasks.erb

@@ -3,13 +3,12 @@ require 'yard'
 YARD::Rake::YardocTask.new  
 <%- else -%>
 begin
-  gem 'yard', '<%= @development_dependencies['yard'] %>'
   require 'yard'
 
-  YARD::Rake::YardocTask.new  
+  YARD::Rake::YardocTask.new
 rescue LoadError => e
   task :yard do
-    abort "Please run `gem install yard` to install YARD."
+    warn e.message
   end
 end
 <%- end -%>

data/data/ore/templates/yard/template.yml

@@ -2,7 +2,8 @@ disable:
   - rdoc
 
 ignore:
-  - doc/
+  - /doc/
+  - /.yardoc/
 
 development_dependencies:
   yard: ~> 0.8

data/gemspec.yml

@@ -1,9 +1,8 @@
 name: ore
-summary: Mine beautiful RubyGems from Ore
+summary: Generate perfect Ruby gems
 description:
-  Ore is a flexible Ruby project generator. Unlike other Ruby project
-  generators, Ore provides many builtin templates and allows custom
-  templates to be installed from Git repositories.
+  Ore is a fully configurable and extendable Ruby gem generator. With Ore you
+  spend less time editing files, and more time writing code.
 
 license: MIT
 authors: Postmodern
@@ -25,10 +24,10 @@ post_install_message: |
   
   **************************************************************************
 
+required_ruby_version: ">= 1.9.1"
+
 dependencies:
   thor: ~> 0.15
 
 development_dependencies:
-  rubygems-tasks: ~> 0.2
-  rspec: ~> 2.4
-  yard: ~> 0.8
+  bundler: ~> 1.0

data/lib/ore/actions.rb

@@ -21,7 +21,7 @@ module Ore
     # @see http://rubydoc.info/gems/thor/Thor/Actions#run-instance_method
     #
     def run(command,config={})
-      super(command,config.merge(:capture => true))
+      super(command,config.merge(capture: true))
     end
 
     #

data/lib/ore/cli.rb

@@ -1,4 +1,5 @@
 require 'ore/config'
+require 'ore/generator'
 require 'ore/version'
 
 require 'thor'

data/lib/ore/config.rb

@@ -1,5 +1,4 @@
-require 'rubygems'
-require 'pathname'
+require 'ore/options'
 
 module Ore
   module Config
@@ -15,34 +14,40 @@ module Ore
     # Custom Ore Templates directory
     TEMPLATES_DIR = File.join(PATH,'templates')
 
-    # The `data/` directory for Ore
-    DATA_DIR = File.expand_path(File.join('..','..','data'),File.dirname(__FILE__))
+    # The `data/ore` directory for Ore
+    DATA_DIR = File.expand_path(File.join('..','..','data','ore'),File.dirname(__FILE__))
 
-    # Specifies whether user settings will be loaded
-    @@enabled = true
+    # The `data/ore/templates` directory for Ore
+    BUILTIN_TEMPLATES_DIR = File.join(DATA_DIR,'templates')
 
+    @enabled = true
+
+    #
+    # Enables access to user config.
     #
-    # Enables access to user settings.
+    # @api private
     #
     # @since 0.5.0
     #
-    def Config.enable!
-      @@enabled = true
+    def self.enable!
+      @enabled = true
     end
 
     #
-    # Disables access to user settings.
+    # Disables access to user config.
+    #
+    # @api private
     #
     # @since 0.5.0
     #
-    def Config.disable!
-      @@enabled = false
+    def self.disable!
+      @enabled = false
     end
 
     #
     # Loads the default options from `~/.ore/options.yml`.
     #
-    # @return [Hash]
+    # @return [Options]
     #   The loaded default options.
     #
     # @raise [RuntimeError]
@@ -50,23 +55,12 @@ module Ore
     #
     # @since 0.9.0
     #
-    def Config.options
-      options = {}
-
-      if (@@enabled && File.file?(OPTIONS_FILE))
-        new_options = YAML.load_file(OPTIONS_FILE)
-
-        # default options must be a Hash
-        unless new_options.kind_of?(Hash)
-          raise("#{OPTIONS_FILE} must contain a YAML encoded Hash")
-        end
-
-        new_options.each do |name,value|
-          options[name.to_sym] = value
-        end
-      end
-
-      return options
+    def self.options
+      @options ||= if @enabled && File.file?(OPTIONS_FILE)
+                     Options.load(OPTIONS_FILE)
+                   else
+                     Options.new
+                   end
     end
 
     #
@@ -78,11 +72,9 @@ module Ore
     # @yieldparam [String] path
     #   The path of a Ore template directory.
     #
-    def Config.builtin_templates
-      path = File.join(DATA_DIR,'ore','templates')
-
-      if File.directory?(path)
-        Dir.glob("#{path}/*") do |template|
+    def self.builtin_templates
+      if File.directory?(BUILTIN_TEMPLATES_DIR)
+        Dir.glob("#{BUILTIN_TEMPLATES_DIR}/*") do |template|
           yield template if File.directory?(template)
         end
       end
@@ -97,12 +89,12 @@ module Ore
     # @yieldparam [String] path
     #   The path of a Ore template directory.
     #
-    def Config.installed_templates
-      if @@enabled
-        if File.directory?(TEMPLATES_DIR)
-          Dir.glob("#{TEMPLATES_DIR}/*") do |template|
-            yield template if File.directory?(template)
-          end
+    def self.installed_templates
+      return unless @enabled
+
+      if File.directory?(TEMPLATES_DIR)
+        Dir.glob("#{TEMPLATES_DIR}/*") do |template|
+          yield template if File.directory?(template)
         end
       end
     end

data/lib/ore/generator.rb

@@ -1,5 +1,4 @@
 require 'ore/config'
-require 'ore/options'
 require 'ore/actions'
 require 'ore/naming'
 require 'ore/template'
@@ -13,12 +12,63 @@ module Ore
   class Generator < Thor::Group
 
     include Thor::Actions
-    include Options
     include Actions
     include Naming
     include Template::Interpolations
     include Template::Helpers
 
+    #
+    # Defines a generator option.
+    #
+    # @param [Symbol] name
+    #
+    # @param [Hash] options
+    #
+    def self.generator_option(name,options={})
+      default = options.fetch(:default,Config.options[name])
+
+      class_option(name,options.merge(default: default))
+    end
+
+    Template.templates.each_key do |name|
+      # skip the `base` template
+      next if name == :gem
+
+      generator_option name, type: :boolean, group: :template
+    end
+
+    # disable the Thor namespace
+    namespace ''
+
+    # define the options
+    generator_option :markup, type:   :string,
+                              banner: 'markdown|textile|rdoc'
+    generator_option :markdown, type: :boolean
+    generator_option :textile, type: :boolean
+    generator_option :templates, type:    :array,
+                                 default: [],
+                                 aliases: '-T',
+                                 banner:  'TEMPLATE [...]'
+    generator_option :name, type: :string, aliases: '-n'
+    generator_option :namespace, type: :string, aliases: '-N'
+    generator_option :version, type:    :string,
+                               aliases: '-V'
+    generator_option :summary, type:    :string,
+                               aliases: '-s'
+    generator_option :description, type:    :string,
+                                   aliases: '-D'
+    generator_option :author,  type: :string,
+                               aliases: '-A',
+                               banner: 'NAME'
+    generator_option :authors, type: :array,
+                               aliases: '-a',
+                               banner: 'NAME [...]'
+    generator_option :email, type: :string, aliases: '-e'
+    generator_option :homepage, type: :string, aliases: %w[-U --website]
+    generator_option :bug_tracker, type: :string, aliases: '-B'
+
+    argument :path, required: true
+
     # The enabled templates.
     attr_reader :enabled_templates
 
@@ -34,36 +84,6 @@ module Ore
     # The generated files.
     attr_reader :generated_files
 
-    # disable the Thor namespace
-    namespace ''
-
-    Template.templates.each_key do |name|
-      # skip the `base` template
-      next if name == :base
-
-      generator_option name, :type => :boolean
-    end
-
-    # define the options
-    generator_option :markdown, :type => :boolean
-    generator_option :textile, :type => :boolean
-    generator_option :templates, :type => :array,
-                                 :aliases => '-T',
-                                 :banner => 'TEMPLATE [...]'
-    generator_option :name, :type => :string, :aliases => '-n'
-    generator_option :version, :type => :string, :aliases => '-V'
-    generator_option :summary, :aliases => '-s'
-    generator_option :description, :aliases => '-D'
-    generator_option :authors, :type => :array,
-                               :aliases => '-a',
-                               :banner => 'NAME [...]'
-    generator_option :email, :type => :string, :aliases => '-e'
-    generator_option :homepage, :type => :string, :aliases => '-U'
-    generator_option :bug_tracker, :type => :string, :aliases => '-B'
-    generator_option :license, :aliases => '-L'
-
-    argument :path, :required => true
-
     #
     # Generates a new project.
     #
@@ -73,36 +93,15 @@ module Ore
       enable_templates!
       initialize_variables!
 
+      extend Template::Helpers::MARKUP.fetch(@markup)
+
       unless options.quiet?
         say "Generating #{self.destination_root}", :green
       end
 
       generate_directories!
       generate_files!
-
-      in_root do
-        case @scm
-        when :git
-          unless File.directory?('.git')
-            run 'git init'
-            run 'git add .'
-            run 'git commit -m "Initial commit."'
-          end
-        when :hg
-          unless File.directory?('.hg')
-            run 'hg init'
-            run 'hg add .'
-            run 'hg commit -m "Initial commit."'
-          end
-        when :svn
-          @ignore.each do |pattern|
-            run "svn propset svn:ignore #{pattern.dump}"
-          end
-
-          run 'svn add .'
-          run 'svn commit -m "Initial commit."'
-        end
-      end
+      initialize_scm!
     end
 
     protected
@@ -176,10 +175,10 @@ module Ore
       @enabled_templates  = Set[]
       @disabled_templates = Set[]
       
-      enable_template :base
+      enable_template :gem
 
       # enable the default templates first
-      Options.defaults.each_key do |name|
+      Options::DEFAULT_TEMPLATES.each do |name|
         if (Template.template?(name) && options[name])
           enable_template(name)
         end
@@ -233,7 +232,7 @@ module Ore
       @module_depth = @modules.length
       @module       = @modules.last
 
-      @namespace      = namespace_of(@name)
+      @namespace      = options.namespace || namespace_of(@name)
       @namespace_dirs = namespace_dirs_of(@name)
       @namespace_path = namespace_path_of(@name)
       @namespace_dir  = @namespace_dirs.last
@@ -241,9 +240,12 @@ module Ore
       @version     = options.version
       @summary     = options.summary
       @description = options.description
-      @license     = options.license
 
-      @authors     = (options.authors || [@scm_user || ENV['USER']])
+      @authors     = if options.author || options.author
+                       [*options.author, *options.authors]
+                     else
+                       [@scm_user || ENV['USERNAME'] || ENV['USER'].capitalize]
+                     end
       @author      = @authors.first
 
       @email       = (options.email || @scm_email)
@@ -262,10 +264,15 @@ module Ore
                        "https://#{@uri.host}#{@uri.path}/issues"
                      end
 
-      @markup, @markup_ext = if    options.markdown? then [:markdown, 'md']
-                             elsif options.textile?  then [:textile, 'tt']
-                             else                         [:rdoc, 'rdoc']
-                             end
+      @markup = if    options.markdown? then :markdown
+                elsif options.textile?  then :textile
+                elsif options.markup?   then options.markup.to_sym
+                end
+
+      @markup_ext = Template::Markup::EXT.fetch(@markup) do
+        say "Unknown markup: #{@markup}", :red
+        exit -1
+      end
 
       @date  = Date.today
       @year  = @date.year
@@ -316,7 +323,7 @@ module Ore
 
         # then render the templates
         template.each_template(@markup) do |dest,file|
-          generate_file dest, file, :template => true
+          generate_file dest, file, template: true
         end
       end
 
@@ -329,5 +336,36 @@ module Ore
       end
     end
 
+    #
+    # Initializes the project repository and commits all files.
+    #
+    # @since 0.10.0
+    #
+    def initialize_scm!
+      in_root do
+        case @scm
+        when :git
+          unless File.directory?('.git')
+            run 'git init'
+            run 'git add .'
+            run 'git commit -m "Initial commit."'
+          end
+        when :hg
+          unless File.directory?('.hg')
+            run 'hg init'
+            run 'hg add .'
+            run 'hg commit -m "Initial commit."'
+          end
+        when :svn
+          @ignore.each do |pattern|
+            run "svn propset svn:ignore #{pattern.dump}"
+          end
+
+          run 'svn add .'
+          run 'svn commit -m "Initial commit."'
+        end
+      end
+    end
+
   end
 end

data/lib/ore/naming.rb

@@ -1,3 +1,7 @@
+require 'ore/config'
+
+require 'yaml'
+
 module Ore
   #
   # Provides methods for guessing the namespaces and directories
@@ -32,25 +36,14 @@ module Ore
     # 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 abbrevations used in namespaces
+    COMMON_ABBREVIATIONS = Hash[File.readlines(File.join(Config::DATA_DIR,'abbreviations.txt')).map { |abbrev|
+      abbrev.chomp!
+      [abbrev.downcase, abbrev]
+    }]
 
     # Common project prefixes and namespaces
-    COMMON_NAMESPACES = {
-      'rubygems' => 'Gem',
-      'ar'       => 'ActiveRecord',
-      'dm'       => 'DataMapper',
-      'js'       => 'JavaScript',
-      'msgpack'  => 'MsgPack',
-      'github'   => 'GitHub',
-      'rdoc'     => 'RDoc'
-    }
+    COMMON_NAMESPACES = YAML.load_file(File.join(Config::DATA_DIR,'common_namespaces.yml'))
 
     #
     # Splits the project name into individual names.
@@ -81,8 +74,8 @@ module Ore
     def module_of(word)
       if COMMON_NAMESPACES.has_key?(word)
         COMMON_NAMESPACES[word]
-      elsif NAMESPACE_ACRONYMS.include?(word)
-        word.upcase
+      elsif COMMON_ABBREVIATIONS.has_key?(word)
+        COMMON_ABBREVIATIONS[word]
       else
         word.capitalize
       end