cog 0.1.0 → 0.1.1

data/bin/cog

@@ -24,6 +24,9 @@ arg_name 'name'
 default_value 'basic'
 flag :tool
 
+desc 'Suppress the use of color in output'
+switch :colorless
+
 desc 'Add cog to the project in the present working directory'
 command :init do |c|
 
@@ -93,7 +96,7 @@ command :tool do |c|
 end
 
 desc 'Manage templates'
-command :template do |c|
+command [:template, :tm] do |c|
   
   c.default_command :list
   
@@ -104,9 +107,27 @@ command :template do |c|
       puts x.join "\n" unless x.empty?
     end
   end
+  
+  c.desc 'Create a new project template'
+  c.command :new do |sub|
+    sub.desc 'Force override of existing built-in or tool templates'
+    sub.switch ['force-override', :f]
+    
+    sub.action do |gopt, opt, args|
+      args.each do |name|
+        begin
+          Cog::Controllers::TemplateController.create name, :force_override => opt[:f]
+        rescue Cog::Errors::DuplicateTemplate => e
+          STDERR.write "Use --force-override to copy the original template into your project templates\n"
+          raise
+        end
+      end
+    end
+  end
 end
 
 pre do |gopt, command, opt, args|
+  Sickill::Rainbow.enabled = false if gopt[:colorless]
   if gopt[:cogfile] && !File.exists?(gopt[:cogfile])
     STDERR.write "No such Cogfile at #{gopt[:cogfile]}\n"
     false

data/lib/cog/built_in_tools.rb

@@ -0,0 +1,9 @@
+module Cog
+  
+  # A place to store built-in +cog+ tools.
+  #
+  # Built-in tools are distributed with the +cog+ gem.
+  module BuiltInTools
+  end
+
+end

data/lib/cog/built_in_tools/basic.rb

@@ -1,9 +1,9 @@
 module Cog
-  module Tools
+  module BuiltInTools
 
     # The default +cog+ tool.
     # Creates generator/template pairs.
-    module BasicTool
+    module Basic
     end
     
   end

data/lib/cog/controllers/template_controller.rb

@@ -1,5 +1,6 @@
 require 'cog/config'
 require 'cog/errors'
+require 'cog/generator'
 require 'cog/helpers'
 require 'rainbow'
 
@@ -26,6 +27,32 @@ module Cog
         cts.to_a
       end
       
+      # Create a new project template
+      # @param name [String] name of the template, relative to the project's templates directory
+      # @option opt [Boolean] :force_override (false) if a built-in or tool template with the same name already exists, should a project override be created?
+      # @return [nil]
+      def self.create(name, opt={})
+        raise Errors::ActionRequiresProject.new('create template') unless Config.instance.project?
+        name = name.without_extension :erb
+        dest = File.join Config.instance.project_templates_path, "#{name}.erb"
+        Object.instance_eval do
+          extend Generator
+          begin
+            original = get_template name, :as_path => true
+            return if original == dest # Nothing to create
+            if opt[:force_override]
+              copy_if_missing original, dest
+            else
+              raise Errors::DuplicateTemplate.new original
+            end
+          rescue Errors::NoSuchTemplate
+            # No original, ok to create an empty template
+            touch_file dest
+          end
+          nil
+        end
+      end
+      
     end
   end
 end

data/lib/cog/errors.rb

@@ -38,7 +38,9 @@ module Cog
       "a file or directory at the given path already exists, cannot create anything there"
     end
 
-    define_error :DuplicateGenerator, 'generator name'
+    define_error :DuplicateGenerator, 'generator'
+    
+    define_error :DuplicateTemplate, 'template'
 
     define_error :DuplicateTool, 'tool'
 

data/lib/cog/generator.rb

@@ -16,7 +16,8 @@ module Cog
     # Get the template with the given name
     # @param path [String] path to template file relative one of the {Config#template_paths}
     # @option opt [Boolean] :absolute (false) is the +path+ argument absolute?
-    # @return [ERB] an instance of {http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html ERB}
+    # @option opt [Boolean] :as_path (false) return the template as an ERB instance (+false+) or an absolute path to the file (+true+)
+    # @return [ERB, String] an instance of {http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html ERB} or an absolute path to the template
     def get_template(path, opt={})
       path += '.erb'
       fullpath = if opt[:absolute]
@@ -28,7 +29,11 @@ module Cog
         end
       end
       raise Errors::NoSuchTemplate.new path unless File.exists? fullpath
-      ERB.new File.read(fullpath), 0, '>'
+      if opt[:as_path]
+        File.expand_path fullpath
+      else
+        ERB.new File.read(fullpath), 0, '>'
+      end
     end
     
     # Stamp a template into a file or return it as a string
@@ -64,6 +69,7 @@ module Cog
     # @return [nil]
     def copy_if_missing(src, dest, opt={})
       unless File.exists? dest
+        touch_path File.dirname(dest), opt
         FileUtils.cp src, dest
         STDOUT.write "Created #{dest.relative_to_project_root}\n".color(:green) unless opt[:quiet]
       end
@@ -81,6 +87,18 @@ module Cog
       nil
     end
     
+    # Create the file at the given path,
+    # Creates directories along the path as required.
+    # @param path [String] a file system path representing a file
+    # @option opt [Boolean] :quiet (false) suppress writing to STDOUT?
+    # @return [nil]
+    def touch_file(path, opt={})
+      touch_path File.dirname(path), opt
+      FileUtils.touch path
+      STDOUT.write "Created #{path.relative_to_project_root}\n".color(:green) unless opt[:quiet]
+      nil
+    end
+    
     # File extension for a snippet of the given source code language.
     # @api unstable
     # @example

data/lib/cog/helpers/string.rb

@@ -12,6 +12,15 @@ class String
   # @return [String] this string as a file system path relative to the +prefix+
   def relative_to(prefix)
     return dup if prefix.nil?
-    start_with?(prefix) ? slice(prefix.length+1..-1) : dup
+    start_with?(prefix.to_s) ? slice(prefix.to_s.length+1..-1) : dup
+  end
+  
+  # @param ext [String] file extension to remove from the end of this string
+  # @return [String] a copy of this string with the given extension removed. Does nothing if this string does not edit with the extension
+  def without_extension(ext)
+    return dup if ext.nil?
+    ext = ext.to_s
+    ext = '.' + ext unless ext.start_with? '.'
+    end_with?(ext) ? slice(0..(-ext.length - 1)) : dup
   end
 end

data/lib/cog/spec_helpers/runner.rb

@@ -19,7 +19,7 @@ module Cog
       # @param args [Array<String>] arguments to pass to +cog+
       # @return [Invocation] an object which can be used with custom {Matchers}
       def run(*args)
-        args = [@cog] + args
+        args = [@cog, '--colorless'] + args
         Invocation.new(args.collect {|x| x.to_s}, :tools => @tools)
       end
     end

data/lib/cog/version.rb

@@ -1,5 +1,5 @@
 module Cog
   unless const_defined? :VERSION
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -100,6 +100,7 @@ files:
 - templates/warning.h.erb
 - lib/cog/built_in_tools/basic/cog_tool.rb
 - lib/cog/built_in_tools/basic.rb
+- lib/cog/built_in_tools.rb
 - lib/cog/config/cogfile.rb
 - lib/cog/config/tool.rb
 - lib/cog/config.rb