cog 0.2.0 → 0.2.1

data/bin/cog

@@ -73,7 +73,7 @@ command [:generator, :gen] do |c|
   c.command :run do |sub|
     sub.action do |gopt, opt, args|
       raise Cog::Errors::ActionRequiresProject.new('run generator') unless Cog::Config.instance.project?
-      Cog::Project.gather_cog_directives
+      Cog::Embeds.gather_from_project
       args = Cog::Controllers::GeneratorController.list if args.empty?
       args.each do |name|
         Cog::Controllers::GeneratorController.run name

data/lib/cog.rb

@@ -1,10 +1,10 @@
 require 'cog/config'
 require 'cog/controllers'
+require 'cog/embeds'
 require 'cog/errors'
 require 'cog/generator'
 require 'cog/helpers'
 require 'cog/languages'
-require 'cog/project'
 require 'cog/version'
 
 # +cog+ is a command line utility that makes it a bit easier to organize a project

data/lib/cog/config/cogfile.rb

@@ -10,10 +10,31 @@ module Cog
     # +Cogfile+ files are used to configure an instance of {Config}.
     #
     # @example
+    #   # All paths are relative to the directory containing this file.
+    # 
+    #   # Define the directory in which to find project generators
     #   project_generators_path 'cog/generators'
+    # 
+    #   # Define the directory in which to find custom project templates
     #   project_templates_path 'cog/templates'
+    # 
+    #   # Define the directory to which project source code is generated
     #   project_source_path 'src'
-    #   language 'c++'
+    # 
+    #   # Explicitly specify a mapping from file extensions to languages
+    #   #
+    #   # key => value pairs from this mapping will override the default
+    #   # language map supplied by +cog+
+    #   #
+    #   # Type `cog language list` to see a list of supported languages
+    #   # and the current file extension mappings
+    #   language_extensions({
+    #     # :h => 'c++',
+    #   })
+    # 
+    #   # Define the target language which should be used when
+    #   # creating generators, and no language is explicitly specified
+    #   default_target_language 'c++'
     #
     class Cogfile
       

data/lib/cog/embeds.rb

@@ -0,0 +1,89 @@
+require 'cog/config'
+require 'cog/embeds/context'
+require 'cog/embeds/file_scanner'
+
+module Cog
+  
+  # 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
+        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]
+      unless x.nil?
+        x.keys.sort.each do |filename|
+          x[filename].times do |index|
+            yield filename, index
+          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
+    # @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
+        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
+        end
+      end
+      s.close
+      updated
+    end
+    
+    extend self # Singleton
+
+  end
+end

data/lib/cog/embeds/context.rb

@@ -0,0 +1,86 @@
+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

data/lib/cog/{project.rb → embeds/file_scanner.rb}

@@ -1,77 +1,7 @@
-require 'cog/config'
-
 module Cog
-  
-  # Methods for querying and manipulating project files
-  module Project
+  module Embeds
 
-    # Search through all project files for cog directives, and remember them so that generators can refer to them later
-    def gather_cog_directives
-      @snippets ||= {}
-      @snippet_pattern ||= "cog\\s*:\\s*snippet\\s*\\(\\s*(.*?)\\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(@snippet_pattern)) do |m|
-          key = m[0]
-          @snippets[key] ||= {}
-          @snippets[key][filename] ||= 0
-          @snippets[key][filename] += 1
-        end
-      end
-    end
-    
-    # @param key [String] snippet key for which to find directive occurrences
-    # @yieldparam filename [String] name of the file in which the snippet occurred
-    # @yieldparam index [Fixnum] occurrence index of the snippet, 0 for the first occurrence, 1 for the second, and so on
-    def snippet_directives(key)
-      x = @snippets[key]
-      unless x.nil?
-        x.keys.sort.each do |filename|
-          x[filename].times do |index|
-            yield filename, index
-          end
-        end
-      end
-    end
-    
-    # @param key [String] unique identifier for the snippet
-    # @param filename [String] file in which to look for the snippet
-    # @param index [Fixnum] occurrence of the snippet. 0 for first, 1 for second, ...
-    # @param value [String] expansion value to use as the update
-    # @return [Boolean] whether or not the expansion was updated
-    def update_snippet_expansion(key, filename, index, value)
-      value = value.rstrip
-      ext = File.extname(filename).slice(1..-1)
-      lang = Config.instance.language_for_extension ext
-      
-      snip_pattern = lang.comment_pattern("cog\\s*:\\s*snippet\\s*\\(\\s*(#{key})\\s*\\)(?:\\s*([{]))?")
-      end_pattern = lang.comment_pattern("cog\\s*:\\s*[}]")
-      not_end_pattern = lang.comment_pattern("cog\\s*:\\s*(?!\\s*[}]).*$")
-      
-      s = FileScanner.new filename
-      updated = if match = s.read_until(snip_pattern, index)
-        if match.nil? # snippet not found
-          false 
-        elsif match[2] == '{' # snippet 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
-          s.replace_captured_text(value + "\n") if value != s.captured_text
-        else # snippet not yet expanded
-          snip_line = lang.comment "cog: snippet(#{match[1]}) {"
-          value = [snip_line, value, lang.comment("cog: }") + "\n"]
-          s.insert_at_mark value.join("\n")
-        end
-      end
-      s.close
-      updated
-    end
-    
-    # Helper for scanning files for snippet expansions
+    # Helper for scanning files for embed expansions
     class FileScanner
 
       def initialize(filename)
@@ -92,7 +22,7 @@ module Cog
       # @return [nil]
       def mark!
         @mark = @f.pos
-        @marked_line_number = @f.lineno
+        @marked_line_number = @f.lineno + 1
       end
       
       def unmark!
@@ -161,13 +91,15 @@ module Cog
       end
       
       # @param value [String] value to replace the captured_text with
+      # @param opt [Boolean] :once (false) if once, the cog delimiters will be removed
       # @return [Boolean] whether or not the operation succeeded
-      def replace_captured_text(value)
+      def replace_captured_text(value, opt={})
         return false if @cap_begin_pos.nil? || @cap_end_pos.nil?
         @f.seek 0
-        tmp.write @f.read(@cap_begin_pos)
+        tmp.write @f.read(opt[:once] ? @mark : @cap_begin_pos)
         tmp.write value
         @f.seek @cap_end_pos
+        @f.readline if opt[:once]
         tmp.write @f.read
         tmp.close
         close
@@ -201,7 +133,5 @@ module Cog
       end
     end
     
-    extend self # Singleton
   end
-  
 end

data/lib/cog/errors.rb

@@ -65,7 +65,7 @@ module Cog
     end
     
     define_error :SnippetExpansionUnterminated, 'location' do
-      "a snippet expansion in the given file is missing the 'cog: }' terminator"
+      "a embed expansion in the given file is missing the 'cog: }' terminator"
     end
     
   end

data/lib/cog/generator.rb

@@ -72,14 +72,15 @@ module Cog
       nil
     end
 
-    # Provide a value for the snippet with the given key
-    # @param key [String] a unique identifier for the snippet
-    # @yield The return value of the provided block will be used to expand the snippet
+    # 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
+    # @yieldreturn The value which will be used to expand the embed (or replace the embedded content)
     # @return [nil]
-    def snippet(key, &block)
-      Project.snippet_directives(key) do |filename, index|
-        if Project.update_snippet_expansion key, filename, index, block.call
-          STDOUT.write "Updated #{filename.relative_to_project_root} - #{(index + 1).ordinalize} occurrence of snippet '#{key}'\n".color :white
+    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
         end
       end
     end

data/lib/cog/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-09 00:00:00 Z
+date: 2012-12-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli
@@ -146,6 +146,9 @@ files:
 - lib/cog/controllers/template_controller.rb
 - lib/cog/controllers/tool_controller.rb
 - lib/cog/controllers.rb
+- lib/cog/embeds/context.rb
+- lib/cog/embeds/file_scanner.rb
+- lib/cog/embeds.rb
 - lib/cog/errors.rb
 - lib/cog/generator/file_methods.rb
 - lib/cog/generator/filters.rb
@@ -165,7 +168,6 @@ files:
 - lib/cog/languages/qt_project_language.rb
 - lib/cog/languages/ruby_language.rb
 - lib/cog/languages.rb
-- lib/cog/project.rb
 - lib/cog/spec_helpers/matchers/match_maker.rb
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb