cog 0.0.11 → 0.0.12

data/bin/cog

@@ -20,43 +20,45 @@ command :init do |c|
   end
 end
 
-desc 'Create a tool (or leave name blank to list available tools)'
+desc 'Create a generator (or leave name blank to list project generators)'
 arg_name 'name'
-skips_pre
-command :tool do |c|
-
+command :generator do |c|
+  
+  c.desc 'which tool to use to create the generator'
+  c.arg_name 'tool_name'
+  c.default_value 'basic'
+  c.flag :tool
+  
   c.action do |global_options, options, args|
     if args.empty?
-      puts 'Available tools:'
-      puts (Cog::Tool.available.collect {|tool| "  #{tool}"}.join "\n")
+      # List
+      x = Cog::Generator.list
+      puts x.collect {|gen| "  #{gen}"}.join "\n" unless x.empty?
     else
+      # Create
       args.each do |name|
-        unless File.exists? name
-          Cog::Tool.generate_tool name
-        else
-          puts "Could not create tool for '#{name}', a file or directory already exists with that name"
-        end
+        Cog::Generator.create name, options
       end
     end
   end
 end
 
-desc 'Create a generator (or leave name blank to list project generators)'
+desc 'Create a tool (or leave name blank to list available tools)'
 arg_name 'name'
-command :generator do |c|
-  
-  c.desc 'which tool to use to create the generator'
-  c.arg_name 'tool_name'
-  c.default_value 'generic'
-  c.flag :tool
-  
+skips_pre
+command :tool do |c|
+
   c.action do |global_options, options, args|
     if args.empty?
-      puts 'Project generators:'
-      puts (Cog::Generator.available.collect {|gen| "  #{gen}"}.join "\n")
+      puts 'Available tools:'
+      puts (Cog::Tool.list.collect {|tool| "  #{tool}"}.join "\n")
     else
       args.each do |name|
-        # TODO: create the generator
+        unless File.exists? name
+          Cog::Tool.create name
+        else
+          puts "Could not create tool for '#{name}', a file or directory already exists with that name"
+        end
       end
     end
   end
@@ -74,6 +76,19 @@ end
 desc 'Run generators in the current project'
 arg_name 'generator_name'
 command :run do |c|
+  
+  c.action do |global_options, options, args|
+    args = Cog::Generator.available if args.empty?
+    args.each do |gen|
+      filename = File.join Cog::Config.instance.project_generators_path, "#{gen}.rb"
+      if File.exists? filename
+        puts "Running generator #{gen}"
+        require filename
+      else
+        puts "No such generator #{gen}"
+      end
+    end
+  end
 end
 
 pre do |global_options, command, options, args|

data/lib/cog/config.rb

@@ -3,9 +3,10 @@ require 'singleton'
 
 module Cog
   
-  # This interface is intended for use within generators. Apps can customize
-  # Instances of this type
-  # can be configured via Cogfile files.
+  # This is a low level interface. It is mainly used by the Generator methods
+  # to determine where to find things, and where to put them. When +cog+ is used
+  # in a project the values of the singleton Config::instance should be configured using
+  # a Cogfile.
   class Config
         
     # Path to the project's +Cogfile+.
@@ -52,16 +53,16 @@ module Cog
     
     # The singleton instance.
     #
-    # Initialized using the +Cogfile+ for the current project, if any can be
-    # found. If not, then #project? will be +false+.
+    # Initialized using the Cogfile for the current project, if any can be
+    # found. If not, then #project? will be +false+ and all the +project_...+
+    # attributes will be +nil+.
     #
-    # The +Cogfile+ will be looked for in the present working directory. If none
+    # The Cogfile will be looked for in the present working directory. If none
     # is found there the parent directory will be checked, and then the
     # grandparent, and so on.
     # 
     # ==== Returns
-    # An instance of Cogfile which has been configured with a +Cogfile+. If no
-    # such file was found then +nil+.
+    # An instance of Config.
     def self.instance
       return @instance if @instance
       @instance = self.new
@@ -89,6 +90,7 @@ module Cog
 
     def initialize
       @project_root = nil
+      @language = 'c++'
     end
 
   end

data/lib/cog/generator.rb

@@ -4,15 +4,46 @@ require 'erb'
 
 module Cog
   
-  # Generators have the ability to #stamp templates into source code.
+  # This module defines an interface which can be used by generator objects.
+  # Specifically, it makes it easy to find ERB templates and render them into
+  # generated source code files, using the #stamp method.
   #
-  # This module defines a low-level interface for writing generators. To use it,
-  # just include the Generator module in your class or object.
+  # For more details on writing generators see https://github.com/ktonon/cog#generators
   module Generator
 
     # A list of available project generators
-    def self.available
-      [:dummy1, :dummy2]
+    def self.list
+      if Config.instance.project?
+        Dir.glob(File.join Config.instance.project_generators_path, '*.rb').collect do |path|
+          File.basename(path).slice(0..-4)
+        end
+      else
+        []
+      end
+    end
+    
+    # Create a new generator
+    #
+    # ==== Arguments
+    # * +name+ - the name to use for the new generator
+    #
+    # ==== Options
+    # * +tool+ - the name of the tool to use (default: basic)
+    #
+    # ==== Returns
+    # Whether or not the generator was created successfully
+    def self.create(name, opt={})
+      return false unless Config.instance.project?
+      filename = File.join Config.instance.project_generators_path, "#{name}.rb"
+      return false if File.exists? filename
+      tool = (opt[:tool] || :basic).to_s
+      Object.new.instance_eval do
+        extend Generator
+        @name = name
+        @class_name = name.to_s.camelize
+        stamp 'cog/generator/basic.rb', filename
+      end
+      true
     end
 
     # Get the template with the given name.
@@ -84,7 +115,7 @@ module Cog
     # File extension for a snippet of the given source code language.
     # ==== Example
     #   snippet_extension 'c++' # => 'h'
-    def snippet_extension(lang = 'text')
+    def snippet_extension(lang = 'text') # :nodoc:
       case lang
       when /(c\+\+|c|objc)/i
         'h'
@@ -94,22 +125,22 @@ module Cog
     end
           
     # A warning that indicates a file is maintained by a generator
-    def generated_warning
+    def generated_warning # :nodoc:
       lang = Config.instance.language
       t = get_template "snippets/#{lang}/generated_warning.#{snippet_extension lang}", :cog_template => true
       t.result(binding)
     end
     
-    def include_guard_begin(name)
+    def include_guard_begin(name) # :nodoc:
       full = "COG_INCLUDE_GUARD_#{name.upcase}"
       "#ifndef #{full}\n#define #{full}"
     end
     
-    def include_guard_end
+    def include_guard_end # :nodoc:
       "#endif // COG_INCLUDE_GUARD_[...]"
     end
     
-    def namespace_begin(name)
+    def namespace_begin(name) # :nodoc:
       return if name.nil?
       case Config.instance.language
       when /c\+\+/
@@ -117,7 +148,7 @@ module Cog
       end
     end
 
-    def namespace_end(name)
+    def namespace_end(name) # :nodoc:
       return if name.nil?
       case Config.instance.language
       when /c\+\+/

data/lib/cog/spec_helpers.rb

@@ -9,14 +9,14 @@ module Cog
   # === Example
   # Requiring the helpers will make extra SpecHelpers::Matchers available to
   # your RSpec tests. These are useful for testing a SpecHelpers::Invocation,
-  # which is returned from a call to SpecHelpers::App#run
+  # which is returned from a call to SpecHelpers::Runner#run
   #
   #   require 'cog/spec_helpers'
   # 
   #   describe 'The command line interface' do
   # 
   #     before :all do
-  #       @cog = Cog::SpecHelpers::App.new 'bin/cog'
+  #       @cog = Cog::SpecHelpers::Runner.new 'bin/cog'
   #     end
   # 
   #     it 'should print help when no args are passed' do
@@ -46,6 +46,11 @@ module Cog
       File.join active_fixture_dir, 'cog'
     end
     
+    # Path to the generator with the given name
+    def generator(name)
+      File.join active_fixture_dir, 'cog', 'generators', "#{name}.rb"
+    end
+    
     # The next cog spec will execute in a fresh copy of the given fixture directory.
     # Fixture directories are stored in <tt>spec/fixtures</tt>.
     def use_fixture(name)

data/lib/cog/spec_helpers/matchers.rb

@@ -5,20 +5,21 @@ module Cog
   module SpecHelpers
     
     # Extra should or should_not matchers for RSpec.
+    # Check out #match_maker for help writing new matchers.
     module Matchers
       
-      # The target Invocation should output the default help text
-      def show_help
+      # The target Invocation should complain about a missing +Cogfile+
+      def complain_about_missing_cogfile
         match_maker do
-          message { "to [show|not show] the default help text, got #{lines.first.inspect}" }
-          test { (/help.*code gen/ =~ lines[1]) }
+          message { "to [require|not require] a Cogfile. STDOUT: #{lines.inspect}" }
+          test { (/no cogfile could be found/i =~ lines.first) }
         end
       end
-      
+
       # The target Invocation should create a +Cogfile+ where none existed before
       def make(path)
         match_maker do
-          message { "to [create|not create] the #{path}" }
+          message { "to [create|not create] #{path}. STDOUT: #{lines.inspect}" }
           before do
             @existed = File.exists? path
           end
@@ -27,8 +28,24 @@ module Cog
           end
         end
       end
+      
+      # The target Invocation should do something, as determined by standard output
+      def do_something
+        match_maker do
+          message { "to [write something|not write anything] to stdout. STDOUT: #{lines.inspect}" }
+          test { !lines.empty? }
+        end
+      end
+      
+      # The target Invocation should output the default help text
+      def show_help
+        match_maker do
+          message { "to [show|not show] the default help text, got #{lines.first.inspect}. STDOUT: #{lines.inspect}" }
+          test { (/help.*code gen/ =~ lines[1]) }
+        end
+      end
+      
     end
-    
   end
 end
 

data/lib/cog/spec_helpers/matchers/match_maker.rb

@@ -2,20 +2,39 @@ module Cog
   module SpecHelpers
     module Matchers
       
+      # Within Matchers#match_maker blocks, +self+ is set to an instance of this
+      # class.
       class MatchMaker
+        # A list of lines read from standard output after executing the Invocation.
         attr_reader :lines
 
-        # Define the failure message
+        # Define a block which runs after a test fails and should return
+        # a failure message template.
+        # 
+        # The template is used for both positive and negative failures.
+        # Substrings which look like this <tt>"[positive|negative]</tt>" will
+        # be replaced with the appropriate section. For example
+        #   message { "to [show|not show] the default help text" }
+        # 
+        # would read "expected cog to show the default help text"
+        # for a positive failure and "expected cog to not show the
+        # default help text" for a negative failure. The "expected cog"
+        # part is inserted automatically.
         def message(&block)
           @msg_block = block
         end
         
-        # Define a block which runs before the Invocation
+        # Define a block which runs before the Invocation.
+        #
+        # This is not required, but can be used to save context that is used
+        # the in post invocation #test.
         def before(&block)
           @before_block = block
         end
         
         # Define the test which runs after the Invocation
+        #
+        # This can make use of instance variables set during #before.
         def test(&block)
           @test_block = block
         end
@@ -40,6 +59,18 @@ module Cog
         end
       end
       
+      # Makes it easy to write RSpec matchers
+      #
+      # Here is how the matcher for Matchers#show_help is written using this method
+      # #match_maker method.
+      #   def show_help
+      #     match_maker do
+      #       message { "to [show|not show] the default help text, got #{lines.first.inspect}" }
+      #       test { (/help.*code gen/ =~ lines[1]) }
+      #     end
+      #   end
+      #
+      # Within the +match_maker+ block, +self+ is set to an instance of MatchMaker.
       def match_maker(&block)
         m = MatchMaker.new
         m.instance_eval &block

data/lib/cog/spec_helpers/runner.rb

@@ -22,7 +22,8 @@ module Cog
     end
     
     # Represents a +cog+ command line invocation, which can be tested with
-    # +RSpec+ +should+ and +should_not+ custom Matchers
+    # +RSpec+ +should+ and +should_not+ custom Matchers. This is the kind of
+    # object returned by Runner#run.
     class Invocation
       
       def initialize(cmd) # :nodoc:
@@ -36,7 +37,7 @@ module Cog
         end
       end
 
-      def to_s
+      def to_s # :nodoc:
         "`#{@s}`"
       end
     end

data/lib/cog/tool.rb

@@ -3,30 +3,17 @@ require 'cog/generator'
 
 module Cog
   
+  # For more details on writing tools see https://github.com/ktonon/cog#tools
   class Tool
 
-    # Lower case command-line version of the name
-    attr_reader :name
-    
-    # Capitalized module name
-    attr_reader :module_name
-
-    # Name of the person who will be given copyright for the generated code
-    attr_reader :author
-    
-    # Email address of the author
-    attr_reader :email
-    
-    # A one-line description of the tool
-    attr_reader :description
-    
     # A list of available tools
-    def self.available
+    def self.list
       # TODO: use paths to instantiate a list of Tool objects
       paths = ENV['COG_TOOLS'] || []
     end
     
-    def self.generate_tool(name)
+    # Generate a new tool with the given name
+    def self.create(name)
       Object.new.instance_eval do
         class << self ; include Generator ; end
         @name = name.to_s.downcase

data/lib/cog/version.rb

@@ -1,3 +1,3 @@
 module Cog
-  VERSION = '0.0.11' unless const_defined? :VERSION
+  VERSION = '0.0.12' unless const_defined? :VERSION
 end

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

@@ -0,0 +1,11 @@
+require 'cog'
+
+class <%= @class_name %> 
+  include Cog::Generator
+  
+  def generate
+    # TODO: create a template and use stamp here to generate source code
+  end
+end
+
+<%= @class_name %>.new.generate

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-03 00:00:00 Z
+date: 2012-11-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -57,6 +57,7 @@ files:
 - bin/cog
 - Default.cogfile
 - LICENSE
+- templates/cog/generator/basic.rb.erb
 - templates/cog/snippets/c++/generated_warning.h.erb
 - templates/cog/snippets/generated_warning.txt
 - templates/cog/tool/API.rdoc.erb