cog 0.2.1 → 0.2.2

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

@@ -73,17 +73,13 @@ module Cog
         # @api developer
         # @return [String] positive interpretation of the {#message} block result
         def failure_message
-          msg = instance_eval &@msg_block
-          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\1'
-          "expected #{@invocation} #{msg}\n#{trace}"
+          _failure_message '\1'
         end
         
         # @api developer
         # @return [String] negative interpretation of the {#message} block result
         def negative_failure_message
-          msg = instance_eval &@msg_block
-          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\2'
-          "expected #{@invocation} #{msg}\n#{trace}"
+          _failure_message '\2'
         end
         
         # @api developer
@@ -91,6 +87,14 @@ module Cog
         def trace
           "STDOUT:\n#{@lines.join "\n"}\nSTDERR:\n#{@error.join "\n"}"
         end
+        
+        private
+        
+        def _failure_message(repl)
+          msg = instance_eval &@msg_block
+          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\2'
+          "expected #{@invocation} #{msg}\n#{trace}"
+        end
       end
       
       # Makes it easier to write RSpec matchers for testing +cog+ command invocations

data/lib/cog/tool.rb

@@ -0,0 +1,61 @@
+require 'cog/tool/dsl'
+require 'cog/errors'
+
+module Cog
+
+  class Tool
+      
+    # @return [String] name of the tool
+    attr_reader :name
+
+    # @return [String] explicit path to the tool
+    attr_reader :path
+      
+    # @return [String] directory in which to find tool templates
+    attr_reader :templates_path
+      
+    # @return [Boolean] the tool needs to be explicitly required
+    attr_reader :explicit_require
+
+    # @api developer
+    # @return [GeneratorStamper] 
+    attr_reader :generator_stamper
+      
+    # @param path [String] path to the <tt>cog_tool.rb</tt> file
+    # @option opt [Boolean] :built_in (false) if +true+, {#templates_path} will be +nil+ for this tool, as the templates should be included with +cog+
+    # @option opt [Boolean] :explicit_require (false) the tool needs to be explicitly required
+    def initialize(path, opt={})
+      unless File.basename(path) == 'cog_tool.rb' && File.exists?(path)
+        raise Errors::InvalidToolConfiguration.new(path)
+      end
+      dir = File.dirname(path)
+      @name = File.basename dir
+      @path = File.expand_path File.join(dir, '..', "#{@name}.rb")
+      @explicit_require = opt[:explicit_require]
+      unless opt[:built_in]
+        @templates_path = File.expand_path File.join(dir, '..', '..', 'cog', 'templates')
+      end
+    end
+      
+    # Fully load the tool
+    def load
+      require @path
+    end
+
+    # Stamp the generator
+    # @param name [String] name of the generator to stamp
+    # @param dest [String] file system path where the file will be created
+    # @return [nil]
+    def stamp_generator(name, dest)
+      raise Errors::ToolMissingDefinition.new('stamp_generator') if @stamp_generator_block.nil?
+      @stamp_generator_block.call name.to_s, dest.to_s
+      nil
+    end
+
+    # Sort tools by name
+    def <=>(other)
+      @name <=> other.name
+    end
+  end
+
+end

data/lib/cog/tool/dsl.rb

@@ -0,0 +1,26 @@
+module Cog
+  class Tool
+    
+    # Domain-specific language for defining cog tools
+    class DSL
+
+      # @api developer
+      # @param tool [Tool] the tool which is being defined
+      def initialize(tool)
+        @tool = tool
+      end
+      
+      # Define a block to call when stamping a generator for this tool
+      # @yieldparam name [String] name of the generator to stamp
+      # @yieldparam dest [String] file system path where the file will be created
+      # @yieldreturn [nil]
+      # @return [nil]
+      def stamp_generator(&block)
+        @tool.instance_eval do
+          @stamp_generator_block = block
+        end
+      end
+      
+    end
+  end
+end

data/lib/cog/version.rb

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

data/templates/basic/generator.rb.erb

@@ -1,10 +1,4 @@
 require 'cog'
 include Cog::Generator
 
-# Setup the template context
-@class = '<%= name.gsub ' ', '' %>'
-
-# Render the templates
-<% @language.module_extensions.each do |ext| %>
-stamp '<%= name %>.<%= ext %>', 'generated_<%= name %>.<%= ext %>'
-<% end %>
+# This is the <%= @name %> generator

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

@@ -1,15 +1,17 @@
 require 'cog'
+include Cog::Generator
 
 # Register <%= @tool_name %> as a tool with cog
-Cog::Config.instance.register_tool __FILE__ do |tool|
+Cog.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
+  # Define a method which creates a <%= @tool_name %> generator
+  tool.stamp_generator do |name, dest|
+    
+    # Setup context for the template
+    @name = name # Generator name
+    
+    # Create the generator file
+    stamp '<%= @tool_name %>/generator.rb', dest, :absolute_destination => true
   end
   
 end

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

@@ -1,7 +1,7 @@
-<%% if tool.explicit_require %>
-require '<%%= tool.path %>'
+<%% if Cog.active_tool.explicit_require %>
+require '<%%= Cog.active_tool.path %>'
 <%% else %>
-require '<%%= tool.name %>'
+require '<%%= Cog.active_tool.name %>'
 <%% end %>
 
 <%= @tool_module %>.widget '<%%= @name %>' do |w|

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

@@ -13,7 +13,7 @@ module <%= @tool_module %>
     
     # Activate <%= @tool_name %> while rendering templates
     # so that cog will be able to find <%= @tool_name %> templates
-    Cog::Config.instance.activate_tool '<%= @tool_name %>' do
+    Cog.activate_tool '<%= @tool_name %>' do
       w.generate
     end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-12 00:00:00 Z
+date: 2012-12-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli
@@ -114,16 +114,6 @@ files:
 - Default.cogfile
 - LICENSE
 - templates/basic/generator.rb.erb
-- templates/basic/template.c.erb.erb
-- templates/basic/template.cpp.erb.erb
-- templates/basic/template.cs.erb.erb
-- templates/basic/template.h.erb.erb
-- templates/basic/template.hpp.erb.erb
-- templates/basic/template.java.erb.erb
-- templates/basic/template.js.erb.erb
-- templates/basic/template.py.erb.erb
-- templates/basic/template.rb.erb.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
@@ -140,13 +130,15 @@ files:
 - lib/cog/built_in_tools.rb
 - lib/cog/config/cogfile.rb
 - lib/cog/config/lang_info.rb
-- lib/cog/config/tool.rb
+- lib/cog/config/language_methods.rb
+- lib/cog/config/project_methods.rb
+- lib/cog/config/tool_methods.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/embeds/context.rb
+- lib/cog/embed_context.rb
 - lib/cog/embeds/file_scanner.rb
 - lib/cog/embeds.rb
 - lib/cog/errors.rb
@@ -164,6 +156,9 @@ files:
 - lib/cog/languages/java_language.rb
 - lib/cog/languages/java_script_language.rb
 - lib/cog/languages/language.rb
+- lib/cog/languages/mixins/c_style_comments.rb
+- lib/cog/languages/mixins/hash_comments.rb
+- lib/cog/languages/mixins.rb
 - lib/cog/languages/python_language.rb
 - lib/cog/languages/qt_project_language.rb
 - lib/cog/languages/ruby_language.rb
@@ -172,6 +167,8 @@ files:
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb
 - lib/cog/spec_helpers.rb
+- lib/cog/tool/dsl.rb
+- lib/cog/tool.rb
 - lib/cog/version.rb
 - lib/cog.rb
 - yard-templates/default/fulldoc/html/css/common.css

data/lib/cog/config/tool.rb

@@ -1,99 +0,0 @@
-require 'cog/errors'
-require 'cog/generator'
-
-module Cog
-  class Config
-
-    class Tool
-      
-      # @return [String] name of the tool
-      attr_reader :name
-
-      # @return [String] explicit path to the tool
-      attr_reader :path
-      
-      # @return [String] directory in which to find tool templates
-      attr_reader :templates_path
-      
-      # @return [Boolean] the tool needs to be explicitly required
-      attr_reader :explicit_require
-      
-      # @param path [String] path to the <tt>cog_tool.rb</tt> file
-      # @option opt [Boolean] :built_in (false) if +true+, {#templates_path} will be +nil+ for this tool, as the templates should be included with +cog+
-      # @option opt [Boolean] :explicit_require (false) the tool needs to be explicitly required
-      def initialize(path, opt={})
-        unless File.basename(path) == 'cog_tool.rb' && File.exists?(path)
-          raise Errors::InvalidToolConfiguration.new(path)
-        end
-        dir = File.dirname(path)
-        @name = File.basename dir
-        @path = File.expand_path File.join(dir, '..', "#{@name}.rb")
-        @explicit_require = opt[:explicit_require]
-        unless opt[:built_in]
-          @templates_path = File.expand_path File.join(dir, '..', '..', 'cog', 'templates')
-        end
-      end
-      
-      # Fully load the tool
-      def load
-        require @path
-      end
-
-      # Encapsulates the block which stamps the generator for this tool
-      class GeneratorStamper
-        
-        include Generator
-        
-        # @return [Config] singleton instance
-        attr_accessor :config
-        
-        # @return [String] path to the generator file which should be created
-        attr_reader :generator_dest
-        
-        # @return [String] +underscore_version+ of the generator name
-        attr_reader :name
-        
-        # @return [Tool] the tool for which this stamps generators
-        attr_reader :tool
-        
-        # @return [String] +CamelizedVersion+ of the generator name
-        def camelized
-          @name.camelize
-        end
-        
-        # @api developer
-        # @param tool [Tool]
-        # @param block [Block]
-        def initialize(tool, block)
-          @tool = tool
-          @block = block
-        end
-        
-        # Stamp the generator
-        # @api developer
-        def stamp_generator(name, generator_dest, config)
-          @name = name.to_s.underscore
-          @config = config
-          @generator_dest = generator_dest
-          instance_eval &@block
-        end
-      end
-      
-      # @api developer
-      # @return [GeneratorStamper] 
-      attr_reader :generator_stamper
-
-      # Define a block to call when stamping a generator for this tool
-      #
-      # @yield The block should do the work of stamping the generator file, and any custom templates. The block's +self+ object will be a {GeneratorStamper}
-      def stamp_generator(&block)
-        @generator_stamper = GeneratorStamper.new self, block
-      end
-      
-      # Sort tools by name
-      def <=>(other)
-        @name <=> other.name
-      end
-    end
-  end
-end

data/lib/cog/embeds/context.rb

@@ -1,86 +0,0 @@
-require 'cog/config'
-
-module Cog
-  module Embeds
-    
-    # Describes the environment of an embed statement including the file in which it was found, the line number, the language, an more.
-    class Context
-      
-      # @return [Fixnum] line number at which the directive was found
-      attr_accessor :lineno
-      
-      # @return [String] the value for the given key
-      attr_reader :name
-
-      # @param path [String] path to the file in which the cog directive was found
-      def initialize(name, path)
-        @name = name
-        @options = {}
-        @path = path
-      end
-      
-      # @return [Array<String>] arguments passed to the directive
-      def args
-        @args
-      end
-      
-      # @return [String] for block directives, the body of text which occurs between the curly braces.
-      # @example
-      #   // cog: snippet(my-snip) {
-      #   body
-      #   // cog: }
-      def body
-        @body
-      end
-      
-      # @return [String] the filename extension
-      def extension
-        @ext ||= File.extname(filename).slice(1..-1)
-      end
-
-      # @return [String] basename of the file in which the cog directive was found
-      def filename
-        @filename ||= File.basename @path
-      end
-
-      # @return [Languages::Language] the language of the file
-      def language
-        @lang ||= Config.instance.language_for_extension extension
-      end
-      
-      # @return [Boolean] was the once switch used?
-      def once?
-        @once
-      end
-
-      # @api developer
-      # @param value [String, nil] set the body to this value
-      def body=(value)
-        @body = value
-      end
-      
-      # @api developer
-      # @param value [Boolean] was the once switch used?
-      def once=(value)
-        @once = !!value
-      end
-      
-      # @api developer
-      # @param value [Array<String>] arguments used with the directive
-      def args=(value)
-        @args = value
-      end
-      
-      # @api developer
-      # @return [String]
-      def to_directive
-        x = "cog: #{name}"
-        x += args.join ' ' if args
-        x += " once" if once?
-        x
-      end
-      
-    end
-    
-  end
-end