cog 0.0.20 → 0.1.0

data/lib/cog/controllers.rb

@@ -0,0 +1,13 @@
+require 'cog/controllers/generator_controller'
+require 'cog/controllers/template_controller'
+require 'cog/controllers/tool_controller'
+require 'cog/errors'
+
+module Cog
+
+  # Contains controllers for managing basic +cog+ objects like generators, templates, and tools
+  module Controllers
+  end
+
+end
+

data/lib/cog/controllers/generator_controller.rb

@@ -0,0 +1,45 @@
+require 'cog/config'
+require 'cog/errors'
+require 'cog/helpers'
+require 'rainbow'
+
+module Cog
+  module Controllers
+    
+    # Manage a project's generators
+    module GeneratorController
+      
+      # Create a new generator
+      # @param name [String] the name to use for the new generator
+      # @return [Boolean] was the generator successfully created?
+      def self.create(name)
+        raise Errors::ActionRequiresProject.new('create generator') unless Config.instance.project?
+        generator_dest = File.join Config.instance.project_generators_path, "#{name}.rb"
+        raise Errors::DuplicateGenerator.new(generator_dest) if File.exists?(generator_dest)
+        gs = Config.instance.active_tool.generator_stamper
+        gs.stamp_generator name, generator_dest, Config.instance
+      end
+
+      # List the available project generators
+      # @option opt [Boolean] :verbose (false) list full paths to generator files
+      # @return [Array<String>] a list of generators
+      def self.list(opt={})
+        raise Errors::ActionRequiresProject.new('list generators') unless Config.instance.project?
+        x = Dir.glob(File.join Config.instance.project_generators_path, '*.rb')
+        opt[:verbose] ? x : (x.collect {|path| File.basename(path).slice(0..-4)})
+      end
+
+      # Run the generator with the given name
+      # @param name [String] name of the generator as returned by {GeneratorController.list}
+      # @return [nil]
+      def self.run(name)
+        raise Errors::ActionRequiresProject.new('run generator') unless Config.instance.project?
+        path = File.join Config.instance.project_generators_path, "#{name}.rb"
+        raise Errors::NoSuchGenerator.new(name) unless File.exists?(path)
+        require path
+        nil
+      end
+      
+    end
+  end
+end

data/lib/cog/controllers/template_controller.rb

@@ -0,0 +1,31 @@
+require 'cog/config'
+require 'cog/errors'
+require 'cog/helpers'
+require 'rainbow'
+
+module Cog
+  module Controllers
+    
+    # Manage a project's templates
+    module TemplateController
+
+      # List the available templates
+      # @option opt [Boolean] :verbose (false) list full template paths
+      # @return [Array<String>] a list of templates
+      def self.list(opt={})
+        cts = Helpers::CascadingTemplateSet.new
+        cts.add_templates 'built-in', :built_in, Config.cog_templates_path, opt
+        Config.instance.tools.each do |tool|
+          unless tool.templates_path.nil?
+            cts.add_templates tool.name, :tool, tool.templates_path, opt
+          end
+        end
+        if Config.instance.project?
+          cts.add_templates 'project', :project, Config.instance.project_templates_path, opt
+        end
+        cts.to_a
+      end
+      
+    end
+  end
+end

data/lib/cog/controllers/tool_controller.rb

@@ -0,0 +1,53 @@
+require 'cog/config'
+require 'cog/errors'
+require 'cog/generator'
+require 'rainbow'
+
+module Cog
+  module Controllers
+    
+    # Manage +cog+ tools
+    #
+    # @see https://github.com/ktonon/cog#tools Introduction to Tools
+    module ToolController
+
+      # 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 [nil]
+      def self.create(name)
+        raise Errors::DestinationAlreadyExists.new(name) if File.exists?(name)
+        raise Errors::DuplicateTool.new(name) if Config.instance.tool_registered?(name)
+        Object.new.instance_eval do
+          extend Generator
+          @tool_name = name.to_s.downcase
+          @tool_module = name.to_s.capitalize
+          @tool_author = '<Your name goes here>'
+          @tool_email = 'youremail@...'
+          @tool_description = 'A one-liner'
+          @cog_version = Cog::VERSION
+          stamp 'cog/custom_tool/tool.rb', "#{@tool_name}/lib/#{@tool_name}.rb", :absolute_destination => true
+          stamp 'cog/custom_tool/cog_tool.rb', "#{@tool_name}/lib/#{@tool_name}/cog_tool.rb", :absolute_destination => true
+          stamp 'cog/custom_tool/version.rb', "#{@tool_name}/lib/#{@tool_name}/version.rb", :absolute_destination => true
+          stamp 'cog/custom_tool/generator.rb.erb', "#{@tool_name}/cog/templates/#{@tool_name}/generator.rb.erb", :absolute_destination => true
+          stamp 'cog/custom_tool/template.txt.erb', "#{@tool_name}/cog/templates/#{@tool_name}/#{@tool_name}.txt.erb", :absolute_destination => true
+          stamp 'cog/custom_tool/Gemfile', "#{@tool_name}/Gemfile", :absolute_destination => true
+          stamp 'cog/custom_tool/Rakefile', "#{@tool_name}/Rakefile", :absolute_destination => true
+          stamp 'cog/custom_tool/tool.gemspec', "#{@tool_name}/#{@tool_name}.gemspec", :absolute_destination => true
+          stamp 'cog/custom_tool/LICENSE', "#{@tool_name}/LICENSE", :absolute_destination => true
+          stamp 'cog/custom_tool/README.markdown', "#{@tool_name}/README.markdown", :absolute_destination => true
+        end
+        nil
+      end
+
+      # @param opt [Boolean] :verbose (false) list full paths to tools
+      # @return [Array<String>] a list of available tools
+      def self.list(opt={})
+        Config.instance.tools.collect do |tool|
+          opt[:verbose] ? tool.path : tool.name
+        end
+      end
+
+
+    end
+  end
+end

data/lib/cog/errors.rb

@@ -1,16 +1,58 @@
 module Cog
   
   module Errors
-    # Indiciates an attempt to use a non-existant template.
-    class MissingTemplate < Exception
-      def initialize(template_path)
-        @template_path = template_path
-      end
-      
-      def message
-        "could not find the template '#{@template_path}'\n#{super}"
+    
+    # Root type for all cog errors
+    class CogError < Exception
+    end
+    
+    # Define a +cog+ error class
+    # @api developer
+    #
+    # @param class_name [String] name of the error class
+    # @param arg [String] name of the argument to the constructor, will appear in error messages
+    # @yield +self+ will be set to an instance of the error class and <tt>@msg</tt> will contain 
+    def self.define_error(class_name, arg, &block)
+      cls = Class.new CogError
+      Errors.instance_eval { const_set class_name, cls }
+      cls.instance_eval do
+        define_method(:initialize) {|value| @value = value}
+        define_method :message do
+          msg = if block.nil?
+            class_name.to_s.underscore.gsub '_', ' '
+          else
+            instance_eval &block
+          end
+          "#{msg} (#{arg} => #{@value})"
+        end
       end
     end
-  end
 
+    define_error :ActionRequiresProject, 'action' do
+      "the action requires a project, but no Cogfile was found"
+    end
+    
+    define_error :CouldNotLoadTool, 'tool'
+    
+    define_error :DestinationAlreadyExists, 'path' do
+      "a file or directory at the given path already exists, cannot create anything there"
+    end
+
+    define_error :DuplicateGenerator, 'generator name'
+
+    define_error :DuplicateTool, 'tool'
+
+    define_error :InvalidToolConfiguration, 'path to cog_tool.rb file' do
+      "invalid directory structure for a cog tool"
+    end
+    
+    define_error :NoSuchGenerator, 'generator'
+
+    define_error :NoSuchTemplate, 'template'
+
+    define_error :NoSuchTool, 'tool' do
+      "no such tool, make sure it appears in the COG_TOOLS environment variable"
+    end
+    
+  end
 end

data/lib/cog/generator.rb

@@ -13,79 +13,6 @@ module Cog
   # @see https://github.com/ktonon/cog#generators Introduction to Generators
   module Generator
 
-    # List the available project generators
-    # @param verbose [Boolean] should full generator paths be listed?
-    # @return [Array<String>] a list of generator names
-    def self.list(verbose=false)
-      if Config.instance.project?
-        x = Dir.glob(File.join Config.instance.project_generators_path, '*.rb')
-        verbose ? x : (x.collect {|path| File.basename(path).slice(0..-4)})
-      else
-        []
-      end
-    end
-    
-    # Create a new generator
-    # @param name [String] the name to use for the new generator
-    # @option opt [String] :tool ('basic') the name of the tool to use
-    # @return [Boolean] was the generator successfully created?
-    def self.create(name, opt={})
-      return false unless Config.instance.project?
-
-      gen_name = File.join Config.instance.project_generators_path, "#{name}.rb"
-      if File.exists? gen_name
-        STDERR.write "Generator '#{gen_name}' already exists\n".color(:red)
-        return false
-      end
-
-      tool = (opt[:tool] || :basic).to_s
-      template_name = File.join Config.instance.project_templates_path, "#{name}.txt.erb"
-      if tool == 'basic' && File.exists?(template_name)
-        STDERR.write "Template '#{template_name}' already exists\n".color(:red)
-        return false
-      end
-      
-      Object.new.instance_eval do
-        extend Generator
-        @name = name
-        @class_name = name.to_s.camelize
-        if tool == 'basic'
-          stamp 'cog/generator/basic.rb', gen_name, :absolute_destination => true
-          stamp 'cog/generator/basic-template.txt.erb', template_name, :absolute_destination => true
-        else
-          tool_path = Tool.find(tool)
-          if tool_path.nil?
-            STDERR.write "No such tool '#{tool}'"
-            false
-          else
-            require tool_path
-            @absolute_require = tool_path != tool
-            @tool_parent_path = File.dirname(tool_path)
-            stamp Config.instance.tool_generator_template, gen_name, :absolute_destination => true
-            true
-          end
-        end
-      end
-    end
-    
-    # Run the generator with the given name
-    # @param name [String] name of the generator as returned by {Generator.list}
-    # @option opt [Boolean] :verbose (false) in the case of an exception, should a full stack trace be written?
-    # @return [Boolean] was the generator run successfully?
-    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
-      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
     # @param path [String] path to template file relative one of the {Config#template_paths}
     # @option opt [Boolean] :absolute (false) is the +path+ argument absolute?
@@ -100,7 +27,7 @@ module Cog
           found.empty? && File.exists?(x) ? x : found
         end
       end
-      raise Errors::MissingTemplate.new path unless File.exists? fullpath
+      raise Errors::NoSuchTemplate.new path unless File.exists? fullpath
       ERB.new File.read(fullpath), 0, '>'
     end
     

data/lib/cog/helpers.rb

@@ -1 +1,2 @@
+require 'cog/helpers/cascading_template_set'
 require 'cog/helpers/string'

data/lib/cog/helpers/cascading_template_set.rb

@@ -0,0 +1,75 @@
+require 'cog/helpers/string'
+require 'rainbow'
+
+module Cog
+  module Helpers
+    
+    # @api developer
+    class TemplateInfo
+      attr_reader :name
+      attr_accessor :path
+      
+      def initialize(name)
+        @sources = []
+        @source_types = []
+        @name = name
+      end
+      
+      def add_source(source, source_type)
+        @sources << source
+        @source_types << source_type
+      end
+      
+      def style(text, type)
+        case type
+        when :built_in
+          text.color :cyan
+        when :tool
+          text.color :yellow
+        when :project
+          text.color(:white).bright
+        end
+      end
+      
+      def override_s(width=nil)
+        colorless = "[#{@sources.join ' < '}]"
+        if width
+          x = @sources.zip(@source_types).collect {|s, t| style s, t}
+          "[#{x.join ' < '}]" + " " * (width - colorless.length)
+        else
+          colorless
+        end
+      end
+      
+      def <=>(other)
+        (@path || @name) <=> (other.path || other.name)
+      end
+      
+      def to_s(override_column_width)
+        "#{override_s override_column_width} #{style @path || @name, @source_types.last}"
+      end
+    end
+    
+    # @api developer
+    class CascadingTemplateSet
+      def initialize
+        @templates = {}
+      end
+      
+      def add_templates(source, source_type, root, opt={})
+        Dir.glob("#{root}/**/*.erb") do |path|
+          name = path.relative_to(root).slice(0..-5)
+          @templates[name] ||= TemplateInfo.new name
+          @templates[name].path = path if opt[:verbose]
+          @templates[name].add_source source, source_type
+        end
+      end
+      
+      def to_a
+        w = @templates.values.collect {|t| t.override_s.length}.max
+        @templates.values.sort.collect {|t| t.to_s(w)}
+      end
+    end
+    
+  end
+end

data/lib/cog/helpers/string.rb

@@ -4,8 +4,14 @@ class String
   
   # @return [String] strips {Cog::Config#project_root} from the beginning of this string
   def relative_to_project_root
-    return unless Cog::Config.instance.project?
-    root = Cog::Config.instance.project_root
-    start_with?(root) ? slice(root.length+1..-1) : dup
+    return dup unless Cog::Config.instance.project?
+    relative_to Cog::Config.instance.project_root
+  end
+  
+  # @param prefix [String] path prefix to strip from the beginning of this 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
   end
 end

data/lib/cog/version.rb

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

data/templates/basic/generator.rb.erb

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

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

@@ -2,3 +2,7 @@ source :rubygems
 gemspec
 
 gem "cog", "~> <%= @cog_version %>"
+
+# Documentation
+gem "yard"
+gem "redcarpet"

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

@@ -1,4 +1,4 @@
-Copyright (c) 2012 <%= @author %>
+Copyright (c) 2012 <%= @tool_author %>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

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

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