cog 0.0.15 → 0.0.16

data/bin/cog

@@ -4,12 +4,15 @@ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'cog'
 require 'active_support/core_ext'
 require 'fileutils'
+require 'rainbow'
 
 include GLI::App
 
 program_desc 'This is a utility to help you write code generators.'
 
 # version Cog::VERSION
+desc 'Output more detailed information when running a command'
+switch :v
 
 desc 'Add cog to the project in the present working directory'
 skips_pre
@@ -22,7 +25,7 @@ end
 
 desc 'Create a generator (or leave name blank to list project generators)'
 arg_name 'name'
-command :generator do |c|
+command [:generator, :gen] do |c|
   
   c.desc 'which tool to use to create the generator'
   c.arg_name 'tool_name'
@@ -32,14 +35,12 @@ command :generator do |c|
   c.action do |global_options, options, args|
     if args.empty?
       # List
-      x = Cog::Generator.list
-      puts x.collect {|gen| "  #{gen}"}.join "\n" unless x.empty?
+      x = Cog::Generator.list global_options[:v]
+      puts x.join "\n" unless x.empty?
     else
       # Create
       args.each do |name|
-        unless Cog::Generator.create name, options
-          puts "Failed to create generator #{name}"
-        end
+        Cog::Generator.create name, :tool => options[:tool], :verbose => global_options[:v]
       end
     end
   end
@@ -52,47 +53,39 @@ command :tool do |c|
 
   c.action do |global_options, options, args|
     if args.empty?
-      puts 'Available tools:'
-      puts (Cog::Tool.list.collect {|tool| "  #{tool}"}.join "\n")
+      # List
+      x = Cog::Tool.list global_options[:v]
+      puts x.join "\n" unless x.empty?
     else
+      # Create
       args.each do |name|
-        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
+        Cog::Tool.create name
       end
     end
   end
 end
 
-desc 'List supported languages'
-skips_pre
-command :languages do |c|
-
-  c.action do
-    puts 'c++'
-  end
-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.list 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
+    args.each do |name|
+      Cog::Generator.run name, :verbose => global_options[:v]
     end
   end
 end
 
+desc 'List supported languages'
+skips_pre
+command :languages do |c|
+
+  c.action do
+    puts 'c++'
+  end
+end
+
 pre do |global_options, command, options, args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the
@@ -100,7 +93,8 @@ pre do |global_options, command, options, args|
   # Use skips_pre before a command to skip this block
   # on that command only
   unless Cog::Config.instance.project?
-    puts 'No Cogfile could be found. Run `cog init` to prepare an existing project.'
+    STDERR.write "No Cogfile could be found\n".color(:red)
+    STDOUT.write "Run `cog init` to prepare a project for use with cog\n"
     false
   else
     true
@@ -119,4 +113,9 @@ on_error do |exception|
   true
 end
 
-exit run(ARGV)
+begin
+  exit run(ARGV)
+rescue
+  # Don't show stack traces during normal use
+  raise unless ENV['COG_DEBUG'].nil? || /^(|0|false|no|off)$/i =~ ENV['COG_DEBUG']
+end

data/lib/cog/generator.rb

@@ -1,6 +1,7 @@
 require 'cog/config'
 require 'cog/errors'
 require 'erb'
+require 'rainbow'
 
 module Cog
   
@@ -12,11 +13,10 @@ module Cog
   module Generator
 
     # A list of available project generators
-    def self.list
+    def self.list(verbose=false)
       if Config.instance.project?
-        Dir.glob(File.join Config.instance.project_generators_path, '*.rb').collect do |path|
-          File.basename(path).slice(0..-4)
-        end
+        x = Dir.glob(File.join Config.instance.project_generators_path, '*.rb')
+        verbose ? x : (x.collect {|path| File.basename(path).slice(0..-4)})
       else
         []
       end
@@ -37,15 +37,43 @@ module Cog
       return false unless Config.instance.project?
       gen_name = File.join Config.instance.project_generators_path, "#{name}.rb"
       template_name = File.join Config.instance.project_templates_path, "#{name}.txt.erb"
-      return false if File.exists?(gen_name) || File.exists?(template_name)
-      Object.new.instance_eval do
-        extend Generator
-        @name = name
-        @class_name = name.to_s.camelize
-        stamp 'cog/generator/basic.rb', gen_name, :absolute_destination => true
-        stamp 'cog/generator/basic-template.txt.erb', template_name, :absolute_destination => true
+      if File.exists? gen_name
+        STDERR.write "Generator '#{gen_name}' already exists\n".color(:red)
+        false
+      elsif File.exists? template_name
+        STDERR.write "Template '#{template_name}' already exists\n".color(:red)
+        false
+      else
+        Object.new.instance_eval do
+          extend Generator
+          @name = name
+          @class_name = name.to_s.camelize
+          stamp 'cog/generator/basic.rb', gen_name, :absolute_destination => true
+          stamp 'cog/generator/basic-template.txt.erb', template_name, :absolute_destination => true
+        end
+        true
+      end
+    end
+    
+    # Run the generator with the given name
+    #
+    # ==== Arguments
+    # * +name+ - the name of the generator
+    #
+    # ==== Returns
+    # Whether or not the generator could be found
+    def self.run(name, opt={})
+      filename = File.join Cog::Config.instance.project_generators_path, "#{name}.rb"
+      if File.exists? filename
+        require filename
+        return true
       end
-      true
+      STDERR.write "No such generator '#{name}'\n".color(:red)
+      false
+    rescue => e
+      trace = opt[:verbose] ? "\n#{e.backtrace.join "\n"}" : ''
+      STDERR.write "Generator '#{name}' failed: #{e}#{trace}\n".color(:red)
+      false
     end
 
     # Get the template with the given name.
@@ -93,8 +121,9 @@ module Cog
       if same? dest, scratch
         FileUtils.rm scratch
       else
-        puts "Generated #{dest}"
+        updated = File.exists? dest
         FileUtils.mv scratch, dest
+        STDOUT.write "#{updated ? :Updated : :Created} #{dest}\n".color(updated ? :white : :green)
       end
       nil
     end
@@ -103,7 +132,7 @@ module Cog
     def copy_if_missing(src, dest)
       unless File.exists? dest
         FileUtils.cp src, dest
-        puts "Created #{dest}"
+        STDOUT.write "Created #{dest}".color(:white)
       end
     end
 
@@ -112,7 +141,7 @@ module Cog
       path = File.join path_components
       unless File.exists? path
         FileUtils.mkdir_p path
-        puts "Created #{path}"
+        STDOUT.write "Created #{path}".color(:white)
       end
     end
     

data/lib/cog/spec_helpers.rb

@@ -48,7 +48,12 @@ module Cog
     
     # Path to the generator with the given name
     def generator(name)
-      File.join active_fixture_dir, 'cog', 'generators', "#{name}.rb"
+      File.expand_path File.join(active_fixture_dir, 'cog', 'generators', "#{name}.rb")
+    end
+    
+    # Path to the test tool with the given name
+    def tool(name)
+      File.expand_path File.join(spec_root, 'tools', name.to_s)
     end
     
     # The next cog spec will execute in a fresh copy of the given fixture directory.
@@ -56,7 +61,7 @@ module Cog
     def use_fixture(name)
       path = File.join spec_root, 'fixtures', name.to_s
       if File.exists?(path) && File.directory?(path)
-        FileUtils.rmtree active_fixture_dir if File.exists? active_fixture_dir
+        FileUtils.rm_rf active_fixture_dir if File.exists? active_fixture_dir
         FileUtils.cp_r path, active_fixture_dir
         Dir.chdir active_fixture_dir
       else

data/lib/cog/spec_helpers/matchers.rb

@@ -8,18 +8,18 @@ module Cog
     # Check out #match_maker for help writing new matchers.
     module Matchers
       
-      # The target Invocation should complain about a missing +Cogfile+
-      def complain_about_missing_cogfile
+      # The target Invocation should write something to STDERR, indicating an error
+      def complain
         match_maker do
-          message { "to [require|not require] a Cogfile. STDOUT: #{lines.inspect}" }
-          test { (/no cogfile could be found/i =~ lines.first) }
+          message { "to [write something|not write anything] to STDERR" }
+          test { !error.empty? }
         end
       end
 
       # The target Invocation should create a +Cogfile+ where none existed before
       def make(path)
         match_maker do
-          message { "to [create|not create] #{path}. STDOUT: #{lines.inspect}" }
+          message { "to [create|not create] #{path}" }
           before do
             @existed = File.exists? path
           end
@@ -32,15 +32,25 @@ module Cog
       # 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}" }
+          message { "to [write something|not write anything] to STDOUT" }
           test { !lines.empty? }
         end
       end
       
+      # The target Invocation should write the given list of lines to standard output
+      def output(x)
+        match_maker do
+          message { "to [write|not write] #{x.join "\n"} to STDOUT"}
+          test do
+            lines.zip(x).all? {|a, b| a.strip == b.to_s.strip}
+          end
+        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}" }
+          message { "to [show|not show] the default help text, got #{lines.first.inspect}" }
           test { (/help.*code gen/ =~ lines[1]) }
         end
       end

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

@@ -5,9 +5,13 @@ module Cog
       # 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.
+
+        # A list of lines read from STDOUT after executing the Invocation
         attr_reader :lines
 
+        # A list of lines read from STDERR after executing the Invocation
+        attr_reader :error
+
         # Define a block which runs after a test fails and should return
         # a failure message template.
         # 
@@ -44,18 +48,23 @@ module Cog
           instance_eval &@before_block unless @before_block.nil?
           @runner.exec do |input, output, error|
             @lines = output.readlines
+            @error = error.readlines
           end
           instance_eval &@test_block
         end
         def failure_message # :nodoc:
           msg = instance_eval &@msg_block
           msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\1'
-          "expected #{@runner} #{msg}"
+          "expected #{@runner} #{msg}\n#{trace}"
         end
         def negative_failure_message # :nodoc:
           msg = instance_eval &@msg_block
           msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\2'
-          "expected #{@runner} #{msg}"
+          "expected #{@runner} #{msg}\n#{trace}"
+        end
+        
+        def trace # :nodoc
+          "STDOUT:\n#{@lines.join "\n"}\nSTDERR:\n#{@error.join "\n"}"
         end
       end
       

data/lib/cog/spec_helpers/runner.rb

@@ -6,8 +6,12 @@ module Cog
     # Points to the +cog+ command-line app
     class Runner
 
+      # Value of the COG_TOOLS environment variable for invocations returned from #run
+      attr_accessor :tools
+      
       def initialize(path_to_cl_app)
         @cog = File.expand_path path_to_cl_app
+        @tools = []
       end
 
       # Run cog with the given arguments
@@ -16,8 +20,8 @@ module Cog
       # An instance of Invocation configured with the arguments. Use should and
       # should_not with the custom Matchers
       def run(*args)
-        args = ['bundle', 'exec', @cog] + args
-        Invocation.new(args.collect {|x| x.to_s})
+        args = [@cog] + args
+        Invocation.new(args.collect {|x| x.to_s}, :tools => @tools)
       end
     end
     
@@ -26,19 +30,21 @@ module Cog
     # object returned by Runner#run.
     class Invocation
       
-      def initialize(cmd) # :nodoc:
+      def initialize(cmd, opt={}) # :nodoc:
         @cmd = cmd
+        @tools = opt[:tools].join ':'
       end
       
       def exec(*args, &block) # :nodoc:
-        @s = ([File.basename @cmd[2]] + @cmd.slice(3..-1)).join ' '
+        @cmd = ['bundle', 'exec'] + @cmd
+        ENV['COG_TOOLS'] = @tools
         Open3.popen3 *@cmd do |i,o,e,t|
           block.call i,o,e
         end
       end
 
       def to_s # :nodoc:
-        "`#{@s}`"
+        "`COG_TOOLS=#{@tools} #{@cmd.compact.join ' '}`"
       end
     end
     

data/lib/cog/tool.rb

@@ -1,5 +1,6 @@
 require 'cog/config'
 require 'cog/generator'
+require 'rainbow'
 
 module Cog
   
@@ -7,30 +8,54 @@ module Cog
   class Tool
 
     # A list of available tools
-    def self.list
-      # TODO: use paths to instantiate a list of Tool objects
-      paths = ENV['COG_TOOLS'] || []
+    def self.list(verbose=false)
+      x = (ENV['COG_TOOLS'] || '').split ':'
+      if x.all? {|path| File.exists?(path) && File.directory?(path)}
+        if verbose
+          x.collect {|path| File.expand_path path}
+        else
+          x.collect {|path| File.basename 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
+    #
+    # ==== Returns
+    # Whether or not the generator was created successfully
     def self.create(name)
-      Object.new.instance_eval do
-        class << self ; include Generator ; end
-        @name = name.to_s.downcase
-        @module_name = name.to_s.capitalize
-        @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', "#{@name}/cog/templates/#{@name}/generator.rb.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
+      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
+          @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', "#{@name}/cog/templates/#{@name}/generator.rb.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
   end

data/lib/cog/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
   - 0
-  - 15
-  version: 0.0.15
+  - 16
+  version: 0.0.16
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -18,7 +18,7 @@ cert_chain: []
 date: 2012-11-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: gli
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -29,10 +29,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: rainbow
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -43,8 +43,36 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: 
 email: kevin@betweenconcepts.com
 executables: