cog 0.2.1 → 0.2.2

data/lib/cog/embeds.rb

@@ -1,89 +1,115 @@
 require 'cog/config'
-require 'cog/embeds/context'
+require 'cog/embed_context'
 require 'cog/embeds/file_scanner'
+require 'cog/errors'
 
 module Cog
   
+  # @api developer
   # Methods for querying and manipulating project files
   module Embeds
 
     # Search through all project files for cog embeds, and remember them so that generators can refer to them later
     def gather_from_project
       @embeds ||= {}
-      @embed_pattern ||= "cog\\s*:\\s*([-A-Za-z0-9_.]+)\\s*(?:\\(\\s*(.+?)\\s*\\))?(\\s*once\\s*)?(\\s*\\{)?"
-      exts = Config.instance.language_summary.collect(&:extensions).flatten
-      sources = Dir.glob "#{Config.instance.project_source_path}/**/*.{#{exts.join ','}}"
-      sources.each do |filename|
-        ext = File.extname(filename).slice(1..-1)
-        lang = Config.instance.language_for_extension ext
-        w = File.read filename
-        w.scan(lang.comment_pattern(@embed_pattern)) do |m|
-          key = m[0].split.first
-          @embeds[key] ||= {}
-          @embeds[key][filename] ||= 0
-          @embeds[key][filename] += 1
+      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
         end
       end
     end
     
-    # @param key [String] embed key for which to find directive occurrences
-    # @yieldparam filename [String] name of the file in which the embed occurred
-    # @yieldparam index [Fixnum] occurrence index of the embed, 0 for the first occurrence, 1 for the second, and so on
-    def find(key)
-      x = @embeds[key]
+    # @param hook [String] embed hook for which to find directive occurrences
+    # @yieldparam context [EmbedContext] describes the context in which the embed statement was found
+    def find(hook)
+      x = @embeds[hook]
       unless x.nil?
         x.keys.sort.each do |filename|
-          x[filename].times do |index|
-            yield filename, index
+          c = EmbedContext.new hook, filename, x[filename]
+          Cog.activate_language :ext => c.extension do
+            c.count.times do |index|
+              c.index = index
+              yield c
+            end
           end
         end
       end
     end
     
-    # @param key [String] unique identifier for the embed
-    # @param filename [String] file in which to look for the embed
-    # @param index [Fixnum] occurrence of the embed. 0 for first, 1 for second, ...
-    # @yieldparam context [Context] describes the context in which the directive occurred
+    # @param c [EmbedContext] describes the context in which the embed statement was found
+    # @yieldparam context [EmbedContext] describes the context in which the embed statement was found
     # @yieldreturn [String] the value to substitute into the embed expansion 
-    # @return [Boolean] whether or not the expansion was updated
-    def update(key, filename, index, &block)
-      c = Context.new key, filename
-      snip_pattern = c.language.comment_pattern("cog\\s*:\\s*(#{key})\\s*(?:\\(\\s*(.+?)\\s*\\))?(\\s*once\\s*)?(?:\\s*([{]))?")
-      end_pattern = c.language.comment_pattern("cog\\s*:\\s*[}]")
-      not_end_pattern = c.language.comment_pattern("cog\\s*:\\s*(?!\\s*[}]).*$")
-      
-      s = FileScanner.new filename
-      updated = if match = s.read_until(snip_pattern, index)
-        if match.nil? # embed not found
-          false
+    # @return [Hash] whether or not the expansion was updated
+    def update(c, &block)
+      FileScanner.scan(c.path, statement(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
         else
-          c.lineno = s.marked_line_number
-          c.args = match[2].split if match[2]
-          c.once = !match[3].nil?
-          if match[4] == '{' # embed already expanded
-            unless s.capture_until end_pattern, :but_not => not_end_pattern
-              raise Errors::SnippetExpansionUnterminated.new "#{filename.relative_to_project_root}:#{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?)
-            end
-          else # embed not yet expanded
-            value = block.call(c).rstrip
-            snip_line = c.language.comment "#{c.to_directive} {"
-            unless c.once?
-              value = [snip_line, value, c.language.comment("cog: }")].join("\n")
-            end
-            s.insert_at_mark(value + "\n")
-          end
+          expand_body c, s, &block
         end
       end
-      s.close
-      updated
     end
     
-    extend self # Singleton
+    private
+    
+    # Pattern groups are
+    # * 1 - hook
+    # * 2 - args
+    # * 3 - once
+    # * 4 - expansion begin (curly <tt>{</tt>)
+    # @return [Regexp] pattern to match the beginning of a cog embed statement
+    def statement(hook, opt={})
+      lang = opt[:lang] || Cog.active_language
+      lang.comment_pattern("cog\\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*[}]")
+    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*[}]).*$")
+    end
+    
+    # @param c [EmbedContext]
+    # @param s [FileScanner]
+    # @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}"
+      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?)
+      end
+    end
+    
+    # @param c [EmbedContext]
+    # @param s [FileScanner]
+    # @return [Boolean] whether or not the scanner updated its file
+    def expand_body(c, s, &block)
+      lang = Cog.active_language
+      value = block.call(c).rstrip
+      snip_line = lang.comment "#{c.to_directive} {"
+      unless c.once?
+        value = [snip_line, value, lang.comment("cog: }")].join("\n")
+      end
+      s.insert_at_mark(value + "\n")
+    end
+    
+    public
+    
+    extend self
 
   end
 end

data/lib/cog/embeds/file_scanner.rb

@@ -1,9 +1,14 @@
 module Cog
   module Embeds
 
+    # @api developer
     # Helper for scanning files for embed expansions
     class FileScanner
 
+      # @return [MatchData, nil] match data for the last matched pattern
+      attr_reader :match
+      
+      # @api developer
       def initialize(filename)
         @filename = filename
         @f = File.open filename, 'r'
@@ -11,13 +16,31 @@ module Cog
         @mark = nil
         @cap_begin_pos = nil
         @cap_end_pos = nil
+        @match = nil # The last match object
       end
-
+      
+      # @api developer
       # Closes the scanned file, if it is not already closed
       def close
         @f.close unless @f.closed?
       end
       
+      # Opens the given file for scanning.
+      # @param filename [String] path to the file which will be scanned
+      # @param pattern [Regexp] a pattern to test for
+      # @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
+      def self.scan(filename, pattern, opt={}, &block)
+        s = new filename
+        if s.read_until pattern, opt[:occurrence] || 0
+          val = block.call s
+        end
+        s.close
+        val
+      end
+
       # Remember this position. A later call to insert_at_mark will insert at this marked position
       # @return [nil]
       def mark!
@@ -36,20 +59,20 @@ module Cog
       # Advances the file until the (n+1)th occurence of the given pattern is encountered, or the end of the file is reached
       # @param pattern [Regexp] a pattern to test for
       # @param n [Fixnum] 0 for the first, 1 for the second, and so on
-      # @return [MatchData, nil] the match object if the pattern was found
+      # @return [Boolean] whether or not a match was found. Use {#match} to retrieve the match data
       def read_until(pattern, n=0)
         i = 0
         mark!
         while (line = @f.readline) && i <= n
-          if m = pattern.match(line)
-            return m if i == n
+          if @match = pattern.match(line)
+            return true if i == n
             i += 1
           end
           mark!
         end
       rescue EOFError
         unmark!
-        nil
+        false
       end
       
       # Advances the file by one line

data/lib/cog/errors.rb

@@ -68,5 +68,8 @@ module Cog
       "a embed expansion in the given file is missing the 'cog: }' terminator"
     end
     
+    define_error :ToolMissingDefinition, 'missing' do
+      "the tool was not fully defined"
+    end
   end
 end

data/lib/cog/generator.rb

@@ -1,4 +1,5 @@
 require 'cog/config'
+require 'cog/embeds'
 require 'cog/errors'
 require 'cog/generator/file_methods'
 require 'cog/generator/filters'
@@ -33,57 +34,90 @@ module Cog
     
     # Stamp a template into a file or return it as a string
     # @param template_path [String] path to template file relative one of the {Config#template_paths}
-    # @param destination [String] path to which the generated file should be written, relative to the {Config#project_source_path}
+    # @param destination [String] path to which the generated file should be written, relative to the {Config::ProjectMethods#project_source_path}
     # @option opt [Boolean] :absolute_template_path (false) is the +template_path+ absolute?
     # @option opt [Boolean] :absolute_destination (false) is the +destination+ absolute?
-    # @option opt [String, Array<String>] :filter (nil) filter the result through the named methods
+    # @option opt [Binding] :binding (nil) an optional binding to use while evaluating the template
+    # @option opt [String, Array<String>] :filter (nil) name(s) of {Filters}
     # @option opt [Boolean] :quiet (false) suppress writing to STDOUT?
     # @return [nil or String] if +destination+ is not provided, the stamped template is returned as a string
     def stamp(template_path, destination=nil, opt={})
       # Ignore destination if its a hash, its meant to be opt
       opt, destination = destination, nil if destination.is_a? Hash
       
-      # Find and render the template
-      t = get_template template_path, :absolute => opt[:absolute_template_path]
-      b = opt[:binding] || binding
-      r = Config.instance.activate_language :ext => File.extname(template_path.to_s) do
-        t.result(b)
-      end
-      
-      # Run r through filters
-      f = opt[:filter]
-      f = [f].compact unless f.is_a?(Array)
-      f.each {|name| r = call_filter name, r }
-      
+      # Render and filter
+      r = find_and_render template_path, opt
+      r = filter_through r, opt[:filter]
       return r if destination.nil?
 
       # Place it in a file
-      dest = opt[:absolute_destination] ? destination : File.join(Config.instance.project_source_path, destination)
-      FileUtils.mkpath File.dirname(dest) unless File.exists? dest
-      scratch = "#{dest}.scratch"
-      File.open(scratch, 'w') {|file| file.write r}
-      if files_are_same? dest, scratch
-        FileUtils.rm scratch
-      else
-        updated = File.exists? dest
-        FileUtils.mv scratch, dest
-        STDOUT.write "#{updated ? :Updated : :Created} #{dest.relative_to_project_root}\n".color(updated ? :white : :green) unless opt[:quiet]
+      write_scratch_file(destination, r, opt[:absolute_destination]) do |path, scratch|
+        if files_are_same? path, scratch
+          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
       end
       nil
     end
 
-    # Provide a value for the embed with the given key
-    # @param key [String] a unique identifier for the embed
-    # @yieldparam context [Embeds::Context] provides information about the environment in which the embed statement was found
+    # Provide a value for embeds with the given hook
+    # @param hook [String] hook name used in the embed statements
+    # @yieldparam context [Embeds::EmbedContext] provides information about the environment in which the embed statement was found
     # @yieldreturn The value which will be used to expand the embed (or replace the embedded content)
     # @return [nil]
-    def embed(key, &block)
-      Embeds.find(key) do |filename, index|
-        if Embeds.update key, filename, index, &block
-          STDOUT.write "Updated #{filename.relative_to_project_root} - #{(index + 1).ordinalize} occurrence of embed '#{key}'\n".color :white
+    def embed(hook, &block)
+      eaten = 0 # keep track of eaten statements so that the index can be adjusted
+      Embeds.find(hook) do |c|
+        c.eaten = eaten
+        if Embeds.update c, &block
+          eaten += 1 if c.once?
+          STDOUT.write "Updated #{c.path.relative_to_project_root} - #{(c.index + 1).ordinalize} occurrence of embed '#{c.hook}'\n".color :white
         end
       end
     end
+    
+    private
+    
+    # @param template_path [String] path to template file relative one of the {Config#template_paths}
+    # @option opt [Boolean] :absolute_template_path (false) is the +template_path+ absolute?
+    # @option opt [Binding] :binding (nil) an optional binding to use while evaluating the template
+    # @return [String] result of rendering the template
+    def find_and_render(template_path, opt={})
+      t = get_template template_path, :absolute => opt[:absolute_template_path]
+      b = opt[:binding] || binding
+      Cog.activate_language :ext => File.extname(template_path.to_s) do
+        t.result(b)
+      end
+    end
+    
+    # @param text [String] text to run through filters
+    # @param f [String, Array<String>] name(s) of {Filters}
+    def filter_through(text, f)
+      f = [f].compact unless f.is_a?(Array)
+      f.each {|name| text = call_filter name, text }
+      text
+    end
+    
+    # @param original [String] path to the original file
+    # @param text [String] text to write into the scratch file
+    # @param absolute [Boolean] is the path absolute or relative to the project root?
+    # @yieldparam original [String] absolute path to original file
+    # @yieldparam scratch [String] path to the scratch file
+    # @return [nil]
+    def write_scratch_file(original, text, absolute=false, &block)
+      path = absolute ? original : File.join(Cog.project_source_path, original)
+      FileUtils.mkpath File.dirname(path) unless File.exists? path
+      scratch = "#{path}.scratch"
+      File.open(scratch, 'w') {|file| file.write text}
+      block.call path, scratch
+    end
 
+    public
+    
+    extend self
+    
   end
 end

data/lib/cog/generator/file_methods.rb

@@ -15,7 +15,7 @@ module Cog
         fullpath = if opt[:absolute]
           path
         else
-          Config.instance.template_paths.inject('') do |found, prefix|
+          Cog.template_paths.inject('') do |found, prefix|
             x = File.join prefix, path
             found.empty? && File.exists?(x) ? x : found
           end

data/lib/cog/generator/filters.rb

@@ -9,7 +9,7 @@ module Cog
       # @param text [String] some text which should be rendered as a comment
       # @return [String] a comment appropriate for the current language context
       def comment(text)
-        Config.instance.active_language.comment text
+        Cog.active_language.comment text
       end
 
       # @api developer

data/lib/cog/generator/language_methods.rb

@@ -17,7 +17,7 @@ module Cog
       # @return [String] the scope begin statement
       def scope_begin(scope)
         gcontext[:scopes] << scope
-        Config.instance.active_language.method("#{scope.type}_begin").call(scope.name)
+        Cog.active_language.method("#{scope.type}_begin").call(scope.name)
       end
       
       # End the scope, popping it off the scope stack
@@ -29,7 +29,7 @@ module Cog
           return nil
         end
         scope = gcontext[:scopes].pop
-        Config.instance.active_language.method("#{scope.type}_end").call(scope.name)
+        Cog.active_language.method("#{scope.type}_end").call(scope.name)
       end
       
       # End all scope currently on the stack
@@ -45,7 +45,7 @@ module Cog
       # @param name [String] name of the scope to use
       # @return [String] a using statement for the named scope
       def use_named_scope(name)
-        Config.instance.active_language.use_named_scope(name)
+        Cog.active_language.use_named_scope(name)
       end
 
       # @param name [String] name of the scope

data/lib/cog/helpers/string.rb

@@ -2,10 +2,10 @@ require 'cog/config'
 
 class String
   
-  # @return [String] strips {Cog::Config#project_root} from the beginning of this string
+  # @return [String] strips {Cog::Config::ProjectMethods#project_root} from the beginning of this string
   def relative_to_project_root
-    return dup unless Cog::Config.instance.project?
-    relative_to Cog::Config.instance.project_root
+    return dup unless Cog.project?
+    relative_to Cog.project_root
   end
   
   # @param prefix [String] path prefix to strip from the beginning of this string

data/lib/cog/languages.rb

@@ -1,5 +1,6 @@
 require 'cog/errors'
 require 'cog/languages/language'
+require 'cog/languages/mixins'
 
 module Cog
   
@@ -15,6 +16,7 @@ module Cog
       :hpp => 'c++',
       :java => 'java',
       :js => 'javascript',
+      :pri => 'qt',
       :pro => 'qt',
       :py => 'python',
       :rb => 'ruby',