cog 0.1.4 → 0.2.0

data/bin/cog

@@ -39,7 +39,7 @@ end
 desc 'Manage project generators'
 command [:generator, :gen] do |c|
   
-  c.default_command :list
+  c.default_command :run
   
   c.desc 'List project generators'
   c.command :list do |sub|
@@ -72,6 +72,8 @@ command [:generator, :gen] do |c|
   c.arg_name 'name'
   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
       args = Cog::Controllers::GeneratorController.list if args.empty?
       args.each do |name|
         Cog::Controllers::GeneratorController.run name

data/lib/cog.rb

@@ -4,6 +4,7 @@ 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.rb

@@ -30,7 +30,7 @@ module Cog
     # @return [Languages::Lanugage] target language which should be used when creating generators, and no language is explicitly specified
     attr_accessor :target_language
     
-    # @return [String] the target language which is currently active
+    # @return [Languages::Language] language which is active in the current context
     def active_language
       @active_languages.last
     end
@@ -146,6 +146,14 @@ module Cog
       end
     end
     
+    # @param ext [String] the file extension
+    # @return [Languages::Language, nil] the language for the given extension
+    def language_for_extension(ext)
+      ext = ext.to_s.downcase.to_sym
+      lang_id = @language_extension_map[ext]
+      Languages.get_language lang_id unless lang_id.nil?
+    end
+    
     # @return [Array<LangInfo>] current configuration of supported languages
     def language_summary
       summary = {}

data/lib/cog/errors.rb

@@ -64,5 +64,9 @@ module Cog
       "scope stack underflow: this can happen if you have too many *_end calls in a template"
     end
     
+    define_error :SnippetExpansionUnterminated, 'location' do
+      "a snippet expansion in the given file is missing the 'cog: }' terminator"
+    end
+    
   end
 end

data/lib/cog/generator.rb

@@ -72,5 +72,17 @@ 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
+    # @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
+        end
+      end
+    end
+
   end
 end

data/lib/cog/languages.rb

@@ -15,6 +15,7 @@ module Cog
       :hpp => 'c++',
       :java => 'java',
       :js => 'javascript',
+      :pro => 'qt',
       :py => 'python',
       :rb => 'ruby',
     }
@@ -24,6 +25,7 @@ module Cog
       'c++' => 'c_plus_plus',
       'c#' => 'c_sharp',
       'javascript' => 'java_script',
+      'qt' => 'qt_project',
     }
     
     # @return [Hash] a mapping of language identifiers to lists of aliases

data/lib/cog/languages/c_language.rb

@@ -5,12 +5,12 @@ module Cog
     
     class CLanguage < Language
 
-      # @param text [String] some text which should be rendered as a comment
-      # @return [String] a comment appropriate for this language
-      def comment(text)
-        "/*\n#{text}\n */"
+      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
+      # @return [Regexp] pattern for matching one line comments in this language
+      def comment_pattern(nested_pattern)
+        /^\s*(?:\/\/|\/\*)\s*#{nested_pattern}\s*(?:\*\/)?\s*$/i
       end
-      
+
       # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:c, :h]
@@ -38,6 +38,16 @@ module Cog
         "#endif // #{name}"
       end
 
+      protected
+      
+      def one_line_comment(text)
+        "// #{text}"
+      end
+      
+      def multi_line_comment(text)
+        "/*\n#{text}\n */"
+      end
+
     end
   end
 end

data/lib/cog/languages/language.rb

@@ -4,11 +4,21 @@ module Cog
     # Interface that must be supported by all +cog+ language helpers.
     # This base class corresponds to a plain text language.
     class Language
+
+      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
+      # @return [Regexp] pattern for matching one line comments in this language
+      def comment_pattern(nested_pattern)
+        /^\s*#{nested_pattern}\s$/
+      end
       
       # @param text [String] some text which should be rendered as a comment
       # @return [String] a comment appropriate for this language
       def comment(text)
-        text
+        if text =~ /\n/
+          multi_line_comment text
+        else
+          one_line_comment text
+        end
       end
       
       # @return [Array<String>] a set of extensions needed to define a module in this language
@@ -46,6 +56,18 @@ module Cog
         ""
       end
 
+      protected
+      
+      def one_line_comment(text)
+        text
+      end
+      
+      def multi_line_comment(text)
+        text.split("\n").collect do |line|
+          one_line_comment line
+        end.join "\n"
+      end
+      
     end
   end
 end

data/lib/cog/languages/python_language.rb

@@ -5,12 +5,12 @@ module Cog
     
     class PythonLanguage < Language
 
-      # @param text [String] some text which should be rendered as a comment
-      # @return [String] a comment appropriate for this language
-      def comment(text)
-        "'''\n#{text}\n'''"
+      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
+      # @return [Regexp] pattern for matching one line comments in this language
+      def comment_pattern(nested_pattern)
+        /^\s*\#\s*#{nested_pattern}\s*$/i
       end
-      
+
       # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:py]
@@ -36,6 +36,16 @@ module Cog
         ""
       end
 
+      protected
+      
+      def one_line_comment(text)
+        "# #{text}"
+      end
+      
+      def multi_line_comment(text)
+        "'''\n#{text}\n'''"
+      end
+
     end
   end
 end

data/lib/cog/languages/qt_project_language.rb

@@ -0,0 +1,47 @@
+require 'cog/languages/language'
+
+module Cog
+  module Languages
+    
+    class QtProjectLanguage < Language
+
+      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
+      # @return [Regexp] pattern for matching one line comments in this language
+      def comment_pattern(nested_pattern)
+        /^\s*\#\s*#{nested_pattern}\s*$/i
+      end
+
+      # @return [Array<String>] a set of extensions needed to define a module in this language
+      def module_extensions
+        [:pro]
+      end
+      
+      # @return [String] ignored for Qt Project files
+      def named_scope_begin(name)
+        ""
+      end
+
+      # @return [String] ignored for Qt Project files
+      def named_scope_end(name)
+        ""
+      end
+      
+      # @return [String] ignored for Qt Project files
+      def include_guard_begin(name)
+        ""
+      end
+      
+      # @return [String] ignored for Qt Project files
+      def include_guard_end(name)
+        ""
+      end
+
+      protected
+      
+      def one_line_comment(text)
+        "# #{text}"
+      end
+      
+    end
+  end
+end

data/lib/cog/languages/ruby_language.rb

@@ -5,12 +5,12 @@ module Cog
     
     class RubyLanguage < Language
 
-      # @param text [String] some text which should be rendered as a comment
-      # @return [String] a comment appropriate for this language
-      def comment(text)
-        "=begin\n#{text}\n=end"
+      # @param nested_pattern [String] regular expression pattern (as a string) to embed in the regular expression which matches one line comments in this language
+      # @return [Regexp] pattern for matching one line comments in this language
+      def comment_pattern(nested_pattern)
+        /^\s*\#\s*#{nested_pattern}\s*$/i
       end
-      
+
       # @return [Array<String>] a set of extensions needed to define a module in this language
       def module_extensions
         [:rb]
@@ -38,6 +38,16 @@ module Cog
         ""
       end
 
+      protected
+      
+      def one_line_comment(text)
+        "# #{text}"
+      end
+      
+      def multi_line_comment(text)
+        "=begin\n#{text}\n=end"
+      end
+
     end
   end
 end

data/lib/cog/project.rb

@@ -0,0 +1,207 @@
+require 'cog/config'
+
+module Cog
+  
+  # Methods for querying and manipulating project files
+  module Project
+
+    # 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
+    class FileScanner
+
+      def initialize(filename)
+        @filename = filename
+        @f = File.open filename, 'r'
+        @lines = []
+        @mark = nil
+        @cap_begin_pos = nil
+        @cap_end_pos = nil
+      end
+
+      # Closes the scanned file, if it is not already closed
+      def close
+        @f.close unless @f.closed?
+      end
+      
+      # Remember this position. A later call to insert_at_mark will insert at this marked position
+      # @return [nil]
+      def mark!
+        @mark = @f.pos
+        @marked_line_number = @f.lineno
+      end
+      
+      def unmark!
+        @mark = nil
+        @marked_line_number = -1
+      end
+      
+      # @return [Fixnum] line number where mark! was called or -1 if mark! was not called
+      attr_reader :marked_line_number
+      
+      # 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
+      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
+            i += 1
+          end
+          mark!
+        end
+      rescue EOFError
+        unmark!
+        nil
+      end
+      
+      # Advances the file by one line
+      # @param pattern [Regexp] a pattern to test for
+      # @return [Boolean] whether or not the next line matched the pattern
+      def readline_matches?(pattern)
+        !!(@f.readline =~ pattern)
+      rescue EOFError
+        false
+      end
+      
+      # Advances the file until the given pattern is encountered and captures lines as it reads. The line which matches the pattern will not be captured. Captured lines can later be recovered with captured_text
+      # @param pattern [Regexp] a pattern to test for
+      # @option opt [Array<Regexp>, Regexp] :but_not (nil) if a line matching any of the provided patterns is found before the desired pattern :bad_pattern_found will be thrown
+      # @return [Boolean] whether or not the pattern was found
+      def capture_until(pattern, opt={})
+        @cap_begin_pos = @f.pos
+        but_not = opt[:but_not] || []
+        but_not = [but_not] unless but_not.is_a?(Array)
+        while line = @f.readline
+          but_not.each do |bad_pattern|
+            if bad_pattern =~ line
+              return false
+            end
+          end
+          return true if line =~ pattern
+          @lines << line
+          @cap_end_pos = @f.pos
+        end
+      rescue EOFError
+        false
+      end
+      
+      # @return [String] text captured during capture_until. The last newline is stripped
+      def captured_text
+        x = @lines.join('')
+        x = x.slice(0..-2) if x =~ /\n$/
+        x
+      end
+      
+      # @param value [String] value to replace the captured_text with
+      # @return [Boolean] whether or not the operation succeeded
+      def replace_captured_text(value)
+        return false if @cap_begin_pos.nil? || @cap_end_pos.nil?
+        @f.seek 0
+        tmp.write @f.read(@cap_begin_pos)
+        tmp.write value
+        @f.seek @cap_end_pos
+        tmp.write @f.read
+        tmp.close
+        close
+        FileUtils.mv tmp_filename, @filename
+        true
+      end
+      
+      # @param value [String] value to be inserted into the file at the current position
+      # @return [Boolean] whether or not the operation succeeded
+      def insert_at_mark(value)
+        return false if @mark.nil?
+        @f.seek 0
+        tmp.write @f.read(@mark)
+        tmp.write value
+        @f.readline # discard original
+        tmp.write @f.read
+        tmp.close
+        close
+        FileUtils.mv tmp_filename, @filename
+        true
+      end
+      
+      private
+      
+      def tmp_filename
+        @tmp_filename ||= "#{@filename}.tmp"
+      end
+      
+      def tmp
+        @tmp ||= File.open(tmp_filename, 'w')
+      end
+    end
+    
+    extend self # Singleton
+  end
+  
+end

data/lib/cog/spec_helpers/runner.rb

@@ -10,8 +10,8 @@ module Cog
       attr_accessor :tools
       
       # @param path_to_cl_app [String] path 
-      def initialize(path_to_cl_app)
-        @cog = File.expand_path path_to_cl_app
+      def initialize
+        @cog = File.expand_path File.join(File.dirname(__FILE__), '..', '..', '..', 'bin', 'cog')
         @tools = []
       end
 

data/lib/cog/version.rb

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

data/templates/basic/generator.rb.erb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-14 00:00:00 Z
+date: 2012-12-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli
@@ -162,8 +162,10 @@ files:
 - lib/cog/languages/java_script_language.rb
 - lib/cog/languages/language.rb
 - lib/cog/languages/python_language.rb
+- 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