cog 0.0.20 → 0.1.0

data/templates/cog/custom_tool/Rakefile.erb

@@ -0,0 +1,15 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb", "README.markdown"]
+  t.options = [
+    '--query', '@api.text != "unstable" && @api.text != "developer"']
+end
+
+spec = eval(File.read('<%= @tool_name %>.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end

data/templates/cog/custom_tool/cog_tool.rb.erb

@@ -0,0 +1,15 @@
+require 'cog'
+
+# Register <%= @tool_name %> as a tool with cog
+Cog::Config.instance.register_tool __FILE__ do |tool|
+
+  # Define how new <%= @tool_name %> generators are created
+  #
+  # Add context as required by your generator template.
+  #
+  # When the block is executed, +self+ will be an instance of Cog::Config::Tool::GeneratorStamper
+  tool.stamp_generator do
+    stamp '<%= @tool_name %>/generator.rb', generator_dest, :absolute_destination => true
+  end
+  
+end

data/templates/cog/custom_tool/generator.rb.erb.erb

@@ -0,0 +1,9 @@
+<%% if tool.explicit_require %>
+require '<%%= tool.path %>'
+<%% else %>
+require '<%%= tool.name %>'
+<%% end %>
+
+<%= @tool_module %>.widget '<%%= @name %>' do |w|
+  w.context = 'this is the context'
+end

data/templates/cog/custom_tool/tool.gemspec.erb

@@ -0,0 +1,18 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','<%= @tool_name %>/version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = '<%= @tool_name %>'
+  s.version = <%= @tool_module %>::VERSION
+  s.author = '<%= @tool_author %>'
+  s.email = '<%= @tool_email %>'
+  s.homepage = ''
+  s.platform = Gem::Platform::RUBY
+  s.summary = '<%= @tool_description %>'
+  s.files = %w(LICENSE) + Dir.glob('cog/**/*') + Dir.glob('lib/**/*.rb')
+  s.require_paths << 'lib'
+  s.has_rdoc = 'yard'
+  s.extra_rdoc_files = ['API.rdoc']
+  s.rdoc_options << '--title' << '<%= @tool_name %>' << '-ri'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('yard')
+end

data/templates/cog/{tool → custom_tool}/tool.rb.erb

@@ -1,18 +1,10 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__))
-require '<%= @name %>/version'
+require '<%= @tool_name %>/version'
 require 'cog'
 
-# Inject this tools templates onto the cog template lookup path
-# Do not remove this line
-Cog::Config.instance.tool_templates_path = File.expand_path(File.join(__FILE__, '..', '..', 'cog', 'templates'))
-
-# Set the template which is used to create generators for this tool
-# Do not remove this line
-Cog::Config.instance.tool_generator_template = '<%= @name %>/generator.rb'
-
-# Custom cog tool <%= @name %> 
-module <%= @module_name %> 
-
+# Custom cog tool <%= @tool_name %> 
+module <%= @tool_module %> 
+  
   # Root of the DSL
   # Feel free to rename this to something more appropriate
   def self.widget(generator_name, &block)
@@ -36,7 +28,7 @@ module <%= @module_name %>
     end
     
     def generate
-      stamp '<%= @name %>/<%= @name %>.txt', "generated_#{@generator_name}.txt"
+      stamp '<%= @tool_name %>/<%= @tool_name %>.txt', "generated_#{@generator_name}.txt"
     end
   end
 end

data/templates/cog/{tool → custom_tool}/version.rb.erb

@@ -1,4 +1,4 @@
-module <%= @module_name %> 
+module <%= @tool_module %> 
   unless const_defined? :VERSION
     VERSION = '0.0.1' # :nodoc:
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 20
-  version: 0.0.20
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-07 00:00:00 Z
+date: 2012-11-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli
@@ -85,30 +85,37 @@ files:
 - bin/cog
 - Default.cogfile
 - LICENSE
-- templates/cog/generator/basic-template.txt.erb.erb
-- templates/cog/generator/basic.rb.erb
-- templates/cog/tool/API.rdoc.erb
-- templates/cog/tool/Gemfile.erb
-- templates/cog/tool/generator.rb.erb.erb
-- templates/cog/tool/LICENSE.erb
-- templates/cog/tool/Rakefile.erb
-- templates/cog/tool/README.markdown.erb
-- templates/cog/tool/template.txt.erb.erb
-- templates/cog/tool/tool.gemspec.erb
-- templates/cog/tool/tool.rb.erb
-- templates/cog/tool/version.rb.erb
+- templates/basic/generator.rb.erb
+- templates/basic/template.txt.erb.erb
+- templates/cog/custom_tool/cog_tool.rb.erb
+- templates/cog/custom_tool/Gemfile.erb
+- templates/cog/custom_tool/generator.rb.erb.erb
+- templates/cog/custom_tool/LICENSE.erb
+- templates/cog/custom_tool/Rakefile.erb
+- templates/cog/custom_tool/README.markdown.erb
+- templates/cog/custom_tool/template.txt.erb.erb
+- templates/cog/custom_tool/tool.gemspec.erb
+- templates/cog/custom_tool/tool.rb.erb
+- templates/cog/custom_tool/version.rb.erb
 - templates/warning.h.erb
+- lib/cog/built_in_tools/basic/cog_tool.rb
+- lib/cog/built_in_tools/basic.rb
 - lib/cog/config/cogfile.rb
+- lib/cog/config/tool.rb
 - lib/cog/config.rb
+- lib/cog/controllers/generator_controller.rb
+- lib/cog/controllers/template_controller.rb
+- lib/cog/controllers/tool_controller.rb
+- lib/cog/controllers.rb
 - lib/cog/errors.rb
 - lib/cog/generator.rb
+- lib/cog/helpers/cascading_template_set.rb
 - lib/cog/helpers/string.rb
 - lib/cog/helpers.rb
 - lib/cog/spec_helpers/matchers/match_maker.rb
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb
 - lib/cog/spec_helpers.rb
-- lib/cog/tool.rb
 - lib/cog/version.rb
 - lib/cog.rb
 - yard-templates/default/fulldoc/html/css/common.css

data/lib/cog/tool.rb

@@ -1,81 +0,0 @@
-require 'cog/config'
-require 'cog/generator'
-require 'rainbow'
-
-module Cog
-  
-  # @see https://github.com/ktonon/cog#tools Introduction to Tools
-  class Tool
-
-    # A list of available tools
-    # @param verbose [Boolean] should full paths be listed for tools which are explicitly referenced?
-    # @return [Array<String>] a list of strings which can be passed to +require+
-    def self.list(verbose=false)
-      x = (ENV['COG_TOOLS'] || '').split ':'
-      if x.all? {|path| path.slice(-3..-1) != '.rb' || File.exists?(path)}
-        if verbose
-          x.collect {|path| path.slice(-3..-1) == '.rb' ? File.expand_path(path) : path}
-        else
-          x.collect {|path| path.slice(-3..-1) == '.rb' ? File.basename(path).slice(0..-4) : path}
-        end
-      else
-        x.each do |path|
-          if !File.exists? path
-            STDERR.write "No such cog tool at path '#{path}'\n".color(:red)
-          elsif !File.directory? path
-            STDERR.write "Not a cog tool at path '#{path}'\n".color(:red)
-          end
-        end
-        []
-      end
-    end
-    
-    # Generate a new tool with the given name
-    # @param name [String] name of the tool to create. Should not conflict with other tool names
-    # @return [Boolean] was the tool created successfully?
-    def self.create(name)
-      if File.exists? name
-        STDERR.write "A #{File.directory?(name) ? :directory : :file} named '#{name}' already exists\n".color(:red)
-        false
-      else
-        Object.new.instance_eval do
-          extend Generator
-          @name = name.to_s.downcase
-          @module_name = name.to_s.capitalize
-          @letter = name.to_s.slice(0,1).downcase
-          @author = '<Your name goes here>'
-          @email = 'youremail@...'
-          @description = 'A one-liner'
-          @cog_version = Cog::VERSION
-          stamp 'cog/tool/tool.rb', "#{@name}/lib/#{@name}.rb", :absolute_destination => true
-          stamp 'cog/tool/version.rb', "#{@name}/lib/#{@name}/version.rb", :absolute_destination => true
-          stamp 'cog/tool/generator.rb.erb', "#{@name}/cog/templates/#{@name}/generator.rb.erb", :absolute_destination => true
-          stamp 'cog/tool/template.txt.erb', "#{@name}/cog/templates/#{@name}/#{@name}.txt.erb", :absolute_destination => true
-          stamp 'cog/tool/Gemfile', "#{@name}/Gemfile", :absolute_destination => true
-          stamp 'cog/tool/Rakefile', "#{@name}/Rakefile", :absolute_destination => true
-          stamp 'cog/tool/tool.gemspec', "#{@name}/#{@name}.gemspec", :absolute_destination => true
-          stamp 'cog/tool/API.rdoc', "#{@name}/API.rdoc", :absolute_destination => true
-          stamp 'cog/tool/LICENSE', "#{@name}/LICENSE", :absolute_destination => true
-          stamp 'cog/tool/README.markdown', "#{@name}/README.markdown", :absolute_destination => true
-        end
-        true
-      end
-    end
-
-    # Find an available tool with the given name
-    # @param name [String] name of the tool to search for
-    # @return [String] a fully qualified tool path, which can be passed to +require+
-    def self.find(name)
-      x = (ENV['COG_TOOLS'] || '').split ':'
-      x.each do |path|
-        if path.slice(-3..-1) == '.rb'
-          short = File.basename(path).slice(0..-4)
-          return path if short == name
-        else
-          return path if path == name
-        end
-      end
-    end
-
-  end
-end

data/templates/cog/generator/basic.rb.erb

@@ -1,12 +0,0 @@
-require 'cog'
-
-class <%= @class_name %> 
-  include Cog::Generator
-  
-  def generate
-    @some_context = :my_context_value
-    stamp '<%= @name %>.txt', 'generated_<%= @name %>.txt'
-  end
-end
-
-<%= @class_name %>.new.generate

data/templates/cog/tool/API.rdoc.erb

@@ -1,7 +0,0 @@
-= <%= @name %> 
-
-These are the API docs for +<%= @name %>+, which is +cog+ tool.
-
-Please see the <tt>README.markdown</tt> file for a introduction to the
-+<%= @name %>+ tool. To find out more about +cog+ in general visit
-https://github.com/ktonon/cog#readme

data/templates/cog/tool/README.markdown.erb

@@ -1,18 +0,0 @@
-= <%= @name %> 
-
-<%= @description %>
-
-Get it
-------
-
-From a terminal
-
-```bash
-gem install <%= @name %> 
-```
-
-or in your Gemfile
-
-```ruby
-gem "<%= @name %>", "~> 0.0.1"
-```

data/templates/cog/tool/Rakefile.erb

@@ -1,15 +0,0 @@
-require 'rake/clean'
-require 'rubygems'
-require 'rubygems/package_task'
-require 'rdoc/task'
-
-Rake::RDocTask.new do |rd|
-  rd.main = "API.rdoc"
-  rd.rdoc_files.include("API.rdoc", "lib/**/*.rb")
-  rd.title = '<%= @module_name %> API Docs'
-end
-
-spec = eval(File.read('<%= @name %>.gemspec'))
-
-Gem::PackageTask.new(spec) do |pkg|
-end

data/templates/cog/tool/generator.rb.erb.erb

@@ -1,6 +0,0 @@
-<%% if @absolute_require %>$LOAD_PATH << "<%%= @tool_parent_path %>"
-<%% end %>require '<%= @name %>'
-
-<%= @module_name %>.widget '<%%= @name %>' do |w|
-  w.context = 'this is the context'
-end

data/templates/cog/tool/tool.gemspec.erb

@@ -1,18 +0,0 @@
-# Ensure we require the local version and not one we might have installed already
-require File.join([File.dirname(__FILE__),'lib','<%= @name %>/version.rb'])
-spec = Gem::Specification.new do |s| 
-  s.name = '<%= @name %>'
-  s.version = <%= @module_name %>::VERSION
-  s.author = '<%= @author %>'
-  s.email = '<%= @email %>'
-  s.homepage = ''
-  s.platform = Gem::Platform::RUBY
-  s.summary = '<%= @description %>'
-  s.files = %w(LICENSE) + Dir.glob('cog/**/*') + Dir.glob('lib/**/*.rb')
-  s.require_paths << 'lib'
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['API.rdoc']
-  s.rdoc_options << '--title' << '<%= @name %>' << '-ri'
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rdoc')
-end