ore 0.8.1 → 0.9.0

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

@@ -1,5 +1,8 @@
 disable:
   - rdoc
 
-variables:
-  yard_dependency: ~> 0.7
+ignore:
+  - doc/
+
+development_dependencies:
+  yard: ~> 0.7

data/gemspec.yml

@@ -1,6 +1,6 @@
 name: ore
-version: 0.8.1
-summary: Mine raw RubyGems from YAML
+version: 0.9.0
+summary: Mine beautiful RubyGems from Ore
 description:
   Ore is a flexible Ruby project generator. Unlike other Ruby project
   generators, Ore provides many builtin templates and allows custom
@@ -9,7 +9,7 @@ description:
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://github.com/ruby-ore/ore
+homepage: https://github.com/ruby-ore/ore#readme
 post_install_message: |
   **************************************************************************
   Generate a new Ruby library:
@@ -27,11 +27,9 @@ post_install_message: |
   **************************************************************************
 
 dependencies:
-  ore-core: ~> 0.1, >= 0.1.4
-  env: ~> 0.1.2
   thor: ~> 0.14.3
 
 development_dependencies:
-  ore-tasks: ~> 0.4
+  rubygems-tasks: ~> 0.2
   rspec: ~> 2.4
-  yard: ~> 0.7.0
+  yard: ~> 0.7

data/lib/ore.rb

@@ -1,5 +1,3 @@
-require 'ore-core'
-
 require 'ore/config'
 require 'ore/generator'
 require 'ore/cli'

data/lib/ore/actions.rb

@@ -0,0 +1,85 @@
+module Ore
+  #
+  # Additional actions for the {Generator}.
+  #
+  # @api semipublic
+  #
+  # @since 0.9.0
+  #
+  module Actions
+    protected
+
+    #
+    # Runs a command.
+    #
+    # @param [String] command
+    #   The command to execute.
+    #
+    # @param [Hash] config
+    #   Additional options.
+    #
+    # @see http://rubydoc.info/gems/thor/Thor/Actions#run-instance_method
+    #
+    def run(command,config={})
+      super(command,config.merge(:capture => true))
+    end
+
+    #
+    # Generates an empty directory.
+    #
+    # @param [String] dest
+    #   The uninterpolated destination path.
+    #
+    # @return [String]
+    #   The destination path of the directory.
+    #
+    # @since 0.7.1
+    #
+    def generate_dir(dest)
+      return if @generated_dirs.has_key?(dest)
+
+      path = interpolate(dest)
+      empty_directory path
+
+      @generated_dirs[dest] = path
+      return path
+    end
+
+    #
+    # Generates a file.
+    #
+    # @param [String] dest
+    #   The uninterpolated destination path.
+    #
+    # @param [String] file
+    #   The source file or template.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Boolean] :template
+    #   Specifies that the file is a template, and should be rendered.
+    #
+    # @return [String]
+    #   The destination path of the file.
+    #
+    # @since 0.7.1
+    #
+    def generate_file(dest,file,options={})
+      return if @generated_files.has_key?(dest)
+
+      path = interpolate(dest)
+
+      if options[:template]
+        @current_template_dir = File.dirname(dest)
+        template file, path
+        @current_template_dir = nil
+      else
+        copy_file file, path
+      end
+
+      @generated_files[dest] = path
+      return path
+    end
+  end
+end

data/lib/ore/cli.rb

@@ -7,10 +7,6 @@ require 'uri'
 module Ore
   class CLI < Thor
 
-    include Config
-
-    default_task :gem
-
     map '-l' => :list
     map '-u' => :update
     map '-r' => :remove
@@ -46,7 +42,7 @@ module Ore
       name = File.basename(url.path)
       name.gsub!(/\.git$/,'')
 
-      path = File.join(@@templates_dir,name)
+      path = File.join(Config::TEMPLATES_DIR,name)
 
       if File.directory?(path)
         say "Template #{name} already installed.", :red
@@ -80,7 +76,7 @@ module Ore
     #
     def remove(name)
       name = File.basename(name)
-      path = File.join(@@templates_dir,name)
+      path = File.join(Config::TEMPLATES_DIR,name)
 
       unless File.exists?(path)
         say "Unknown template: #{name}", :red
@@ -90,31 +86,5 @@ module Ore
       FileUtils.rm_rf(path)
     end
 
-    desc 'gemspec', 'Dumps a Ruby gemspec for the project'
-    method_option :ruby, :type => :boolean,
-                         :default => true,
-                         :aliases => '-R'
-    method_option :yaml, :type => :boolean, :aliases => '-Y'
-
-    def gemspec
-      require 'ore/project'
-
-      gemspec = Project.find.to_gemspec
-      
-      if options.yaml?
-        print YAML.dump(gemspec)
-      else
-        print gemspec.to_ruby
-      end
-    end
-
-    desc 'gem', 'Builds a RubyGem'
-
-    def gem
-      require 'ore/project'
-
-      Project.find.build!
-    end
-
   end
 end

data/lib/ore/config.rb

@@ -1,25 +1,25 @@
+require 'rubygems'
 require 'pathname'
-require 'env'
 
 module Ore
   module Config
-    # Specifies whether user settings will be loaded
-    @@enabled = true
-
     # The users home directory
-    @@home = Env.home
+    HOME = Gem.user_home
 
     # Ore config directory
-    @@path = File.join(@@home,'.ore')
+    PATH = File.join(HOME,'.ore')
 
     # Default options file.
-    @@options_file = File.join(@@path,'options.yml')
+    OPTIONS_FILE = File.join(PATH,'options.yml')
 
     # Custom Ore Templates directory
-    @@templates_dir = File.join(@@path,'templates')
+    TEMPLATES_DIR = File.join(PATH,'templates')
 
     # The `data/` directory for Ore
-    @@data_dir = File.expand_path(File.join('..','..','data'),File.dirname(__FILE__))
+    DATA_DIR = File.expand_path(File.join('..','..','data'),File.dirname(__FILE__))
+
+    # Specifies whether user settings will be loaded
+    @@enabled = true
 
     #
     # Enables access to user settings.
@@ -48,17 +48,17 @@ module Ore
     # @raise [RuntimeError]
     #   The `~/.ore/options.yml` did not contain a YAML encoded Hash.
     #
-    # @since 0.5.0
+    # @since 0.9.0
     #
-    def Config.default_options
+    def Config.options
       options = {}
 
-      if (@@enabled && File.file?(@@options_file))
-        new_options = YAML.load_file(@@options_file)
+      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")
+          raise("#{OPTIONS_FILE} must contain a YAML encoded Hash")
         end
 
         new_options.each do |name,value|
@@ -79,7 +79,7 @@ module Ore
     #   The path of a Ore template directory.
     #
     def Config.builtin_templates
-      path = File.join(@@data_dir,'ore','templates')
+      path = File.join(DATA_DIR,'ore','templates')
 
       if File.directory?(path)
         Dir.glob("#{path}/*") do |template|
@@ -98,11 +98,11 @@ module Ore
     #   The path of a Ore template directory.
     #
     def Config.installed_templates
-      return unless @@enabled
-
-      if File.directory?(@@templates_dir)
-        Dir.glob("#{@@templates_dir}/*") do |template|
-          yield template if File.directory?(template)
+      if @@enabled
+        if File.directory?(TEMPLATES_DIR)
+          Dir.glob("#{TEMPLATES_DIR}/*") do |template|
+            yield template if File.directory?(template)
+          end
         end
       end
     end

data/lib/ore/generator.rb

@@ -1,105 +1,24 @@
-require 'ore/template/directory'
-require 'ore/template/interpolations'
-require 'ore/template/helpers'
-require 'ore/naming'
 require 'ore/config'
+require 'ore/options'
+require 'ore/actions'
+require 'ore/naming'
+require 'ore/template'
 
 require 'thor/group'
 require 'date'
 require 'set'
-require 'env'
+require 'uri'
 
 module Ore
   class Generator < Thor::Group
 
     include Thor::Actions
+    include Options
+    include Actions
     include Naming
     include Template::Interpolations
     include Template::Helpers
 
-    #
-    # The templates registered with the generator.
-    #
-    def self.templates
-      @@templates ||= {}
-    end
-
-    #
-    # Determines whether a template was registered.
-    #
-    # @param [Symbol, String] name
-    #   The name of the template.
-    #
-    # @return [Boolean]
-    #   Specifies whether the template was registered.
-    #
-    # @since 0.7.2
-    #
-    def self.template?(name)
-      self.templates.has_key?(name.to_sym)
-    end
-
-    #
-    # Registers a template with the generator.
-    #
-    # @param [String] path
-    #   The path to the template.
-    #
-    # @return [Symbol]
-    #   The name of the registered template.
-    #
-    # @raise [StandardError]
-    #   The given path was not a directory.
-    #
-    def self.register_template(path)
-      unless File.directory?(path)
-        raise(StandardError,"#{path.dump} is must be a directory")
-      end
-
-      name = File.basename(path).to_sym
-
-      self.templates[name] = path
-      return name
-    end
-
-    #
-    # Default options for the generator.
-    #
-    # @return [Hash{Symbol => Object}]
-    #   The option names and default values.
-    #
-    # @since 0.5.0
-    #
-    def self.defaults
-      @@defaults ||= {
-        :templates => [],
-        :version => '0.1.0',
-        :summary => 'TODO: Summary',
-        :description => 'TODO: Description',
-        :license => 'MIT',
-        :authors => [Env.user],
-        :ore_tasks => true,
-        :rdoc => true,
-        :rspec => true,
-        :git => true
-      }
-    end
-
-    #
-    # Defines a generator option.
-    #
-    # @param [Symbol] name
-    #   The name of the option.
-    #
-    # @param [Hash{Symbol => Object}] options
-    #   The Thor options of the option.
-    #
-    # @since 0.5.0
-    #
-    def self.generator_option(name,options={})
-      class_option(name,options.merge(:default => defaults[name]))
-    end
-
     # The enabled templates.
     attr_reader :enabled_templates
 
@@ -115,53 +34,16 @@ module Ore
     # The generated files.
     attr_reader :generated_files
 
-    #
-    # Generates a new project.
-    #
-    def generate
-      self.destination_root = path
-
-      enable_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
-
-    # merge default options
-    defaults.merge!(Config.default_options)
-
-    # register builtin templates
-    Config.builtin_templates { |path| register_template(path) }
-    # register installed templates
-    Config.installed_templates { |path| register_template(path) }
+    # disable the Thor namespace
+    namespace ''
 
-    # define options for all templates
-    templates.each_key do |name|
+    Template.templates.each_key do |name|
       # skip the `base` template
       next if name == :base
 
-      class_option name, :type => :boolean,
-                         :default => defaults.fetch(name,false)
+      generator_option name, :type => :boolean
     end
 
-    # disable the Thor namespace
-    namespace ''
-
     # define the options
     generator_option :markdown, :type => :boolean
     generator_option :textile, :type => :boolean
@@ -177,69 +59,50 @@ module Ore
                                :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'
-    generator_option :git, :type => :boolean
 
     argument :path, :required => true
 
     #
-    # Generates an empty directory.
-    #
-    # @param [String] dest
-    #   The uninterpolated destination path.
-    #
-    # @return [String]
-    #   The destination path of the directory.
-    #
-    # @since 0.7.1
+    # Generates a new project.
     #
-    def generate_dir(dest)
-      return if @generated_dirs.has_key?(dest)
+    def generate
+      self.destination_root = path
 
-      path = interpolate(dest)
-      empty_directory path
+      enable_templates!
+      initialize_variables!
 
-      @generated_dirs[dest] = path
-      return path
-    end
+      unless options.quiet?
+        say "Generating #{self.destination_root}", :green
+      end
 
-    #
-    # Generates a file.
-    #
-    # @param [String] dest
-    #   The uninterpolated destination path.
-    #
-    # @param [String] file
-    #   The source file or template.
-    #
-    # @param [Hash] options
-    #   Additional options.
-    #
-    # @option options [Boolean] :template
-    #   Specifies that the file is a template, and should be rendered.
-    #
-    # @return [String]
-    #   The destination path of the file.
-    #
-    # @since 0.7.1
-    #
-    def generate_file(dest,file,options={})
-      return if @generated_files.has_key?(dest)
+      generate_directories!
+      generate_files!
 
-      path = interpolate(dest)
+      in_root do
+        case @scm
+        when :git
+          run 'git init' unless File.directory?('.git')
+          run 'git add .'
+          run 'git commit -m "Initial commit."'
+        when :hg
+          run 'hg init' unless File.directory?('.hg')
+          run 'hg add .'
+          run 'hg commit -m "Initial commit."'
+        when :svn
+          @ignore.each do |pattern|
+            run "svn propset svn:ignore #{pattern.dump}"
+          end
 
-      if options[:template]
-        @current_template_dir = File.dirname(dest)
-        template file, path
-        @current_template_dir = nil
-      else
-        copy_file file, path
+          run 'svn add .'
+          run 'svn commit -m "Initial commit."'
+        end
       end
-
-      @generated_files[dest] = path
-      return path
     end
 
+    protected
+
     #
     # Enables a template, adding it to the generator.
     #
@@ -253,7 +116,7 @@ module Ore
 
       return false if @enabled_templates.include?(name)
 
-      unless (template_dir = self.class.templates[name])
+      unless (template_dir = Template.templates[name])
         say "Unknown template #{name}", :red
         exit -1
       end
@@ -290,7 +153,7 @@ module Ore
 
       return false if @disabled_templates.include?(name)
 
-      unless (template_dir = self.class.templates[name])
+      unless (template_dir = Template.templates[name])
         say "Unknown template #{name}", :red
         exit -1
       end
@@ -307,22 +170,22 @@ module Ore
     # Enables templates.
     #
     def enable_templates!
-      @templates = []
-      @enabled_templates = Set[]
+      @templates          = []
+      @enabled_templates  = Set[]
       @disabled_templates = Set[]
       
       enable_template :base
 
       # enable the default templates first
-      self.class.defaults.each_key do |name|
-        if (self.class.template?(name) && options[name])
+      Options.defaults.each_key do |name|
+        if (Template.template?(name) && options[name])
           enable_template(name)
         end
       end
 
       # enable the templates specified by option
       options.each do |name,value|
-        if (self.class.template?(name) && value)
+        if (Template.template?(name) && value)
           enable_template(name)
         end
       end
@@ -340,27 +203,42 @@ module Ore
     # Initializes variables for the templates.
     #
     def initialize_variables!
-      @project_dir = File.basename(destination_root)
-      @name = (options.name || @project_dir)
+      @root        = destination_root
+      @project_dir = File.basename(@root)
+      @name        = (options.name || @project_dir)
 
-      @modules = modules_of(@name)
+      @modules      = modules_of(@name)
       @module_depth = @modules.length
-      @module = @modules.last
+      @module       = @modules.last
 
-      @namespace = namespace_of(@name)
+      @namespace      = namespace_of(@name)
       @namespace_dirs = namespace_dirs_of(@name)
       @namespace_path = namespace_path_of(@name)
-      @namespace_dir = @namespace_dirs.last
+      @namespace_dir  = @namespace_dirs.last
 
-      @version = options.version
-      @summary = options.summary
+      @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
+      @license     = options.license
+      @authors     = options.authors
+      @author      = @authors.first
+      @github_user = if options.git?
+                       `git config github.user`.chomp
+                     end
+
+      @email       = options.email
+      @safe_email  = @email.sub('@',' at ') if @email
+      @homepage    = if options.homepage
+                       URI(options.homepage)
+                     elsif !(@github_user.nil? || @github_user.empty?)
+                       URI("https://github.com/#{@github_user}/#{@name}#readme")
+                     else
+                       URI("https://rubygems.org/gems/#{@name}")
+                     end
+      @bug_tracker = case @homepage.host
+                     when 'github.com'
+                       "https://#{@homepage.host}#{@homepage.path}/issues"
+                     end
 
       @markup = if options.markdown?
                   :markdown
@@ -370,18 +248,38 @@ module Ore
                   :rdoc
                 end
 
-      @date = Date.today
-      @year = @date.year
+      @scm = if File.directory?(File.join(@root,'.git'))
+               :git
+             elsif File.directory?(File.join(@root,'.hg'))
+               :hg
+             elsif File.directory?(File.join(@root,'.svn'))
+               :svn
+             elsif options.hg?
+               :hg
+             elsif options.git?
+               :git
+             end
+
+      @date  = Date.today
+      @year  = @date.year
       @month = @date.month
-      @day = @date.day
+      @day   = @date.day
+
+      @ignore                   = SortedSet[]
+      @dependencies             = {}
+      @development_dependencies = {}
 
       @templates.each do |template|
+        @ignore.merge(template.ignore)
+        @dependencies.merge!(template.dependencies)
+        @development_dependencies.merge!(template.development_dependencies)
+
         template.variables.each do |name,value|
           instance_variable_set("@#{name}",value)
         end
       end
 
-      @generated_dirs = {}
+      @generated_dirs  = {}
       @generated_files = {}
     end