cog 0.3.0 → 0.3.1

data/lib/cog/config/language_config.rb

@@ -10,9 +10,10 @@ module Cog
       end
 
       # Activate a given language within the scope of the provided block.
-      # Either provide <tt>key</tt> or <tt>:ext</tt> but not both. If the extension does not match any of the supported languages, the {#active_language} will not change, but the block will still be called.
+      # Either provide <tt>key</tt>, <tt>:ext</tt>, or <tt>:filename</tt> but not more than one. If the extension does not match any of the supported languages, the {#active_language} will not change, but the block will still be called.
       # @param key [:String] the lanuage identifier. Type <tt>cog language list</tt> to see the possible values
       # @option opt [:String] :ext (nil) a file extension which will map to a language identifier. Type <tt>cog language map</tt> to see mapped extensions
+      # @option opt [:String] :filename (nil) a filename or path to file which will map to a language identifier
       # @yield within this block the {#active_language} will be set to the desired value
       # @return [Object] the value returned by the block
       def activate_language(key, opt={}, &block)
@@ -22,6 +23,9 @@ module Cog
           ext = opt[:ext].to_s.downcase
           ext = ext.slice(1..-1) if ext.start_with?('.')
           @language_extension_map[ext] unless ext.empty?
+        elsif opt[:filename]
+          ext = File.extname(opt[:filename]).slice(1..-1)
+          @language_extension_map[ext] unless ext.nil? || ext.empty?
         else
           key
         end

data/lib/cog/embed_context.rb

@@ -38,6 +38,7 @@ module Cog
       @path = path.to_s
       @count = count
       @eaten = 0
+      @index = 0
     end
       
     # @return [Array<String>] arguments provided with the embed statement
@@ -74,6 +75,9 @@ module Cog
       @once
     end
 
+    # @api developer
+    attr_accessor :keep_body
+    
     # @api developer
     # @param value [String, nil] set the body to this value
     def body=(value)
@@ -115,11 +119,11 @@ module Cog
     def actual_index
       @index - @eaten
     end
-      
+    
     # @api developer
     # @return [String]
-    def to_directive
-      x = "cog: #{hook}"
+    def to_statement(type='cog')
+      x = "#{type}: #{hook}"
       x += "(#{args.join ' '})" if args
       x += " once" if once?
       x

data/lib/cog/embeds.rb

@@ -8,14 +8,54 @@ module Cog
     def gather_from_project
       @embeds ||= {}
       Cog.supported_project_files.each do |filename|
-        lang = Cog.language_for filename
-        File.read(filename).scan(statement '[-A-Za-z0-9_.]+', :lang => lang) do |m|
-          hook = m[0]
-          @embeds[hook] ||= {}
-          @embeds[hook][filename] ||= 0
-          @embeds[hook][filename] += 1
+        gather_from_file filename, :hash => @embeds, :type => 'cog'
+      end
+    end
+    
+    # Copy keep bodies from the original file to the scratch file
+    # @param original [String] file in which to search for keep statements. If the original does not exist, then scratch will serve as the original (we do this so that the keeps will get expanded in any case)
+    # @param scratch [String] file to which keep bodies will be copied
+    # @return [nil]
+    def copy_keeps(original, scratch)
+      keeps = {}
+      Cog.activate_language(:filename => original) do
+        original = scratch unless File.exists? original
+        gather_from_file(original, :type => 'keep').each_pair do |hook, count|
+          c = keeps[hook] = EmbedContext.new(hook, scratch, count[original])
+          raise Errors::DuplicateKeep.new :hook => hook if c.count > 1
+          Helpers::FileScanner.scan(original, statement('keep', hook)) do |s|
+            c.keep_body = if s.match[4] == '{'
+              s.capture_until end_statement('keep')
+              s.captured_text
+            else
+              ''
+            end
+          end
         end
+        keeps.each_pair do |hook, c|
+          result = update c, :type => 'keep' do |c|
+            c.keep_body
+          end
+          raise Errors::UnrecognizedKeepHook.new :hook => hook, :filename => original if result.nil?
+        end
+      end
+    end
+
+    # @param filename [String] file from which to gather statements
+    # @option opt [Hash] :hash ({}) object in which to gather the mapping
+    # @option opt [String] :type ('cog') one of <tt>'cog'</tt> or <tt>'keep'</tt>
+    # @return [Hash] mapping from hooks to <tt>{ 'filename' => count }</tt> hashes
+    def gather_from_file(filename, opt={})
+      bucket = opt[:hash] || {}
+      type = opt[:type] || 'cog'
+      lang = Cog.language_for filename
+      File.read(filename).scan(statement type, '[-A-Za-z0-9_.]+', :lang => lang) do |m|
+        hook = m[0]
+        bucket[hook] ||= {}
+        bucket[hook][filename] ||= 0
+        bucket[hook][filename] += 1
       end
+      bucket
     end
     
     # @param hook [String] embed hook for which to find directive occurrences
@@ -36,18 +76,20 @@ module Cog
     end
     
     # @param c [EmbedContext] describes the context in which the embed statement was found
+    # @option opt [String] :type ('cog') one of <tt>'cog'</tt> or <tt>'keep'</tt>
     # @yieldparam context [EmbedContext] describes the context in which the embed statement was found
     # @yieldreturn [String] the value to substitute into the embed expansion 
-    # @return [Hash] whether or not the expansion was updated
-    def update(c, &block)
-      Helpers::FileScanner.scan(c.path, statement(c.hook), :occurrence => c.actual_index) do |s|
+    # @return [Boolean,nil] +true+ if the statement was expanded or updated, +false+ if the statement was found, but not changed, +nil+ if it could not be found.
+    def update(c, opt={}, &block)
+      type = opt[:type] || 'cog'
+      Helpers::FileScanner.scan(c.path, statement(type, c.hook), :occurrence => c.actual_index) do |s|
         c.lineno = s.marked_line_number
         c.args = s.match[2].split if s.match[2]
         c.once = !s.match[3].nil?
         if s.match[4] == '{'
-          update_body c, s, &block
+          update_body c, s, opt, &block
         else
-          expand_body c, s, &block
+          expand_body c, s, opt, &block
         end
       end
     end
@@ -60,44 +102,50 @@ module Cog
     # * 3 - once
     # * 4 - expansion begin (curly <tt>{</tt>)
     # @return [Regexp] pattern to match the beginning of a cog embed statement
-    def statement(hook, opt={})
+    def statement(type, hook, opt={})
       lang = opt[:lang] || Cog.active_language
-      lang.comment_pattern("cog\\s*:\\s*(#{hook})\\s*(?:\\(\\s*(.+?)\\s*\\))?(\\s*once\\s*)?(?:\\s*([{]))?")
+      lang.comment_pattern("#{type}\\s*:\\s*(#{hook})\\s*(?:\\(\\s*(.+?)\\s*\\))?(\\s*once\\s*)?(?:\\s*([{]))?")
     end
     
     # @return [Regexp] pattern to match the end of a cog embed statement
-    def end_statement
-      Cog.active_language.comment_pattern("cog\\s*:\\s*[}]")
+    def end_statement(type = 'cog')
+      Cog.active_language.comment_pattern("#{type}\\s*:\\s*[}]")
     end
 
     # @return [Regexp] pattern to match an line that looks like a cog statement, but is not the end statement
-    def anything_but_end
-      Cog.active_language.comment_pattern("cog\\s*:\\s*(?!\\s*[}]).*$")
+    def anything_but_end(type = 'cog')
+      Cog.active_language.comment_pattern("#{type}\\s*:\\s*(?!\\s*[}]).*$")
     end
     
     # @param c [EmbedContext]
     # @param s [FileScanner]
+    # @option opt [String] :type ('cog') one of <tt>'cog'</tt> or <tt>'keep'</tt>
     # @return [Boolean] whether or not the scanner updated its file
-    def update_body(c, s, &block)
-      unless s.capture_until end_statement, :but_not => anything_but_end
-        raise Errors::SnippetExpansionUnterminated.new "#{c.path.relative_to_project_root}:#{s.marked_line_number}"
+    def update_body(c, s, opt={}, &block)
+      type = opt[:type] || 'cog'
+      unless s.capture_until end_statement(type), :but_not => anything_but_end(type)
+        raise Errors::SnippetExpansionUnterminated.new :filename => c.path.relative_to_project_root, :line => s.marked_line_number
       end
       c.body = s.captured_text
       value = block.call(c).rstrip
       if c.once? || value != s.captured_text
         s.replace_captured_text(value + "\n", :once => c.once?)
+      else
+        false
       end
     end
     
     # @param c [EmbedContext]
     # @param s [FileScanner]
+    # @option opt [String] :type ('cog') one of <tt>'cog'</tt> or <tt>'keep'</tt>
     # @return [Boolean] whether or not the scanner updated its file
-    def expand_body(c, s, &block)
+    def expand_body(c, s, opt={}, &block)
+      type = opt[:type] || 'cog'
       lang = Cog.active_language
       value = block.call(c).rstrip
-      snip_line = lang.comment "#{c.to_directive} {"
+      snip_line = lang.comment "#{c.to_statement type} {"
       unless c.once?
-        value = [snip_line, value, lang.comment("cog: }")].join("\n")
+        value = [snip_line, value, lang.comment("#{type}: }")].join("\n")
       end
       s.insert_at_mark(value + "\n")
     end

data/lib/cog/errors.rb

@@ -4,58 +4,69 @@ module Cog
     
     # Root type for all cog errors
     class CogError < Exception
+      def initialize(details={})
+        @details = if details.is_a? Hash
+          details.to_a.collect do |key, value|
+            "#{key} => #{value.inspect}"
+          end.sort
+        else
+          [details]
+        end
+      end
+
+      def message
+        w = custom_message || self.class.name.underscore.split('/').last.gsub('_', ' ')
+        w += " (#{@details.join ', '})" unless @details.empty?
+        w
+      end
     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)
+    def self.define_error(class_name, &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})"
+        define_method :custom_message do
+          block.call if block
         end
       end
     end
 
-    define_error :ActionRequiresProjectGeneratorPath, 'action'
-    define_error :ActionRequiresProjectTemplatePath, 'action'
-    define_error :ActionRequiresProjectPluginPath, 'action'
+    define_error :ActionRequiresProjectGeneratorPath
+    define_error :ActionRequiresProjectTemplatePath
+    define_error :ActionRequiresProjectPluginPath
     
-    define_error :DuplicateGenerator, 'generator'
-    define_error :DuplicatePlugin, 'plugin'
+    define_error :DuplicateGenerator
+    define_error :DuplicatePlugin
+    define_error :DuplicateKeep
 
-    define_error :InvalidPluginConfiguration, 'path to cog_plugin.rb file' do
+    define_error :InvalidPluginConfiguration do
       "invalid directory structure for a cog plugin"
     end
     
-    define_error :NoSuchFilter, 'filter'
-    define_error :NoSuchGenerator, 'generator'
-    define_error :NoSuchLanguage, 'language'
-    define_error :NoSuchTemplate, 'template'
-    define_error :NoSuchPlugin, 'plugin'
+    define_error :UnrecognizedKeepHook do
+      "looks like that hook is longer being generated"
+    end
+    
+    define_error :NoSuchFilter
+    define_error :NoSuchGenerator
+    define_error :NoSuchLanguage
+    define_error :NoSuchTemplate
+    define_error :NoSuchPlugin
     
-    define_error :PluginPathIsNotADirectory, 'plugin_path'
+    define_error :PluginPathIsNotADirectory
     
-    define_error :ScopeStackUnderflow, 'caller' do
+    define_error :ScopeStackUnderflow do
       "scope stack underflow: this can happen if you have too many *_end calls in a template"
     end
     
-    define_error :SnippetExpansionUnterminated, 'location' do
+    define_error :SnippetExpansionUnterminated do
       "a embed expansion in the given file is missing the 'cog: }' terminator"
     end
     
-    define_error :PluginMissingDefinition, 'missing' do
+    define_error :PluginMissingDefinition do
       "the plugin was not fully defined"
     end
   end

data/lib/cog/generator.rb

@@ -47,10 +47,11 @@ module Cog
 
       # Place it in a file
       write_scratch_file(destination, r, opt[:absolute_destination]) do |path, scratch|
-        if files_are_same?(path, scratch) || (opt[:once] && File.exists?(path))
+        updated = File.exists? path
+        Embeds.copy_keeps(path, scratch)
+        if files_are_same?(path, scratch) || (opt[:once] && updated)
           FileUtils.rm scratch
         else
-          updated = File.exists? path
           FileUtils.mv scratch, path
           STDOUT.write "#{updated ? :Updated : :Created} #{path.relative_to_project_root}\n".color(updated ? :white : :green) unless opt[:quiet]
         end

data/lib/cog/helpers/file_scanner.rb

@@ -31,11 +31,13 @@ module Cog
       # @option opt [Fixnum] :occurrence (0) 0 for the first, 1 for the second, and so on
       # @yieldparam scanner [FileScanner] a file scanner
       # @yieldreturn [Object]
-      # @return [Object] the return value of the block
+      # @return [Object,nil] the return value of the block, or +nil+ if the pattern was not found
       def self.scan(filename, pattern, opt={}, &block)
         s = new filename
-        if s.read_until pattern, opt[:occurrence] || 0
-          val = block.call s
+        val = if s.read_until pattern, opt[:occurrence] || 0
+          block.call s
+        else
+          nil
         end
         s.close
         val

data/lib/cog/plugin.rb

@@ -18,7 +18,7 @@ module Cog
     # @param cogfile_path [String] path to the plugin Cogfile
     def initialize(cogfile_path)
       unless File.exists?(cogfile_path)
-        raise Errors::InvalidPluginConfiguration.new(cogfile_path)
+        raise Errors::InvalidPluginConfiguration.new :cogfile => cogfile_path
       end
       @cogfile_path = File.expand_path cogfile_path
       @path = File.dirname @cogfile_path

data/lib/cog/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-30 00:00:00 Z
+date: 2013-01-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli