cog 0.2.2 → 0.3.0

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

@@ -1,5 +1,5 @@
 module Cog
-  module Embeds
+  module Helpers
 
     # @api developer
     # Helper for scanning files for embed expansions

data/lib/cog/language.rb

@@ -0,0 +1,140 @@
+module Cog
+
+  # Describes a language support by Cog
+  class Language
+
+    # @return [Array<String>] list of file extensions
+    attr_reader :extensions
+      
+    # @return [String] unique lower case identifier
+    attr_reader :key
+
+    # @return [String] readable name for the language
+    attr_reader :name
+    
+    # @return [String] the style of comments used by this language
+    attr_reader :comment_style
+    
+    # @return [String] the style of include guards used by this language
+    attr_reader :include_guard_style
+      
+    # @api developer
+    # Initialize with default values
+    # @param key [String] unique case-insensitive identifier
+    def initialize(key = :text)
+      @key = key.to_s.downcase
+      @name = key.to_s
+      @comment_pattern = '^\s*(%s)\s*$'
+      @comment_prefix = nil
+      @multiline_comment_prefix = nil
+      @multiline_comment_postfix = nil
+      @extensions = []
+      identibitch = lambda {|name| ''}
+      @use_named_scope_block = identibitch
+      @named_scope_begin_block = identibitch
+      @named_scope_end_block = identibitch
+      @include_guard_begin_block = identibitch
+      @include_guard_end_block = identibitch
+    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)
+      Regexp.new(@comment_pattern % nested_pattern)
+    end
+      
+    # @param text [String] some text which should be rendered as a comment
+    # @return [String] a comment appropriate for this language
+    def comment(text)
+      if text =~ /\n/
+        multi_line_comment text
+      else
+        one_line_comment text
+      end
+    end
+
+    # @api developer
+    def one_line_comment(text)
+      if @comment_prefix
+        "#{@comment_prefix} #{text}"
+      elsif @multiline_comment_prefix
+        "#{@multiline_comment_prefix} #{text} #{@multiline_comment_postfix}"
+      else
+        text
+      end
+    end
+      
+    # @api developer
+    def multi_line_comment(text)
+      if @multiline_comment_prefix
+        "#{@multiline_comment_prefix}\n#{text}\n#{@multiline_comment_postfix}"
+      elsif @comment_prefix
+        text.split("\n").collect do |line|
+          "#{@comment_prefix} #{line}"
+        end.join("\n")
+      else
+        text
+      end
+    end
+    
+    # @api developer
+    # Called after all Cogfiles have been processed
+    # @param other [Language] language to borrow notation from
+    def apply_comment_style(other)
+      @comment_prefix = other.instance_eval {@comment_prefix}
+      @multiline_comment_prefix = other.instance_eval {@multiline_comment_prefix}
+      @multiline_comment_postfix = other.instance_eval {@multiline_comment_postfix}
+      @comment_pattern = other.instance_eval {@comment_pattern}
+    end
+    
+    # @api developer
+    # Called after all Cogfiles have been processed
+    # @param other [Language] language to borrow notation from
+    def apply_include_guard_style(other)
+      @include_guard_begin_block = other.instance_eval {@include_guard_begin_block}
+      @include_guard_end_block = other.instance_eval {@include_guard_end_block}
+    end
+    
+    # @param w [FixNum] width of the first column
+    # @return [String] one line summary in two columns
+    def to_s(w=nil)
+      w ||= @name.length
+      "#{@name.ljust w} -> #{@extensions.collect {|x| x.to_s}.sort.join ', '}"
+    end
+
+    # Sort by name
+    def <=>(other)
+      @name <=> other.name
+    end
+    
+    # @param name [String] name of the scope to use
+    # @return [String] a using statement for the named scope
+    def use_named_scope(name)
+      @use_named_scope_block.call name
+    end
+      
+    # @param name [String] name of the scope
+    # @return [String] begin a named scope
+    def named_scope_begin(name)
+      @named_scope_begin_block.call name
+    end
+
+    # @param name [String] name of the scope
+    # @return [String] end the given named scope
+    def named_scope_end(name)
+      @named_scope_end_block.call name
+    end
+      
+    # @param name [String] name of the module to protect
+    # @return [String] an include guard statement
+    def include_guard_begin(name)
+      @include_guard_begin_block.call name
+    end
+      
+    # @param name [String] name of the module to protect
+    # @return [String] an include guard end statement
+    def include_guard_end(name)
+      @include_guard_end_block.call name
+    end
+  end
+end

data/lib/cog/native_extensions.rb

@@ -0,0 +1,2 @@
+require 'cog/native_extensions/string'
+require 'cog/native_extensions/array'

data/lib/cog/native_extensions/array.rb

@@ -0,0 +1,19 @@
+# @api developer
+class Array
+  
+  # Iterate through each path in this array
+  # @yieldparam source [String] readable label for the source. In the case of plugins, the plugin name
+  # @yieldparam source_type [Symbol] one of :built_in, :user, :plugin, or :project
+  # @yieldparam path [String] a path to a cog resource, such as a template or generator
+  # @return [Object] the return value of the block
+  def each_with_cog_source(&block)
+    each do |path|
+      source, source_type = if plugin = path.relative_to_which_plugin?
+        [plugin.name, :plugin]
+      else
+        path.cog_source_and_type
+      end
+      block.call source, source_type, path
+    end
+  end
+end

data/lib/cog/native_extensions/string.rb

@@ -0,0 +1,54 @@
+# @api developer
+class String
+  
+  # @return [String] strips {Cog::Config::ProjectConfig#project_root} from the beginning of this string
+  def relative_to_project_root
+    if Cog.show_fullpaths?
+      File.expand_path self
+    else
+      Cog.project? ? relative_to(Cog.project_root) : dup
+    end
+  end
+  
+  # @param prefix [String] path prefix to strip from the beginning of this string
+  # @return [String] this string as a file system path relative to the +prefix+
+  def relative_to(prefix)
+    if Cog.show_fullpaths?
+      File.expand_path self
+    else
+      prefix && start_with?(prefix.to_s) ? slice(prefix.to_s.length+1..-1) : dup
+    end
+  end
+
+  # @return [Cog::Plugin,nil] if this string can be interpretted as a path relative to one of the registered cog plugins, return that plugin, otherwise return +nil+
+  def relative_to_which_plugin?
+    Cog.plugins.each do |plugin|
+      return plugin if start_with?(plugin.path)
+    end
+    nil
+  end
+  
+  # @param ext [String] file extension to remove from the end of this string
+  # @return [String] a copy of this string with the given extension removed. Does nothing if this string does not edit with the extension
+  def without_extension(ext)
+    return dup if ext.nil?
+    ext = ext.to_s
+    ext = '.' + ext unless ext.start_with? '.'
+    end_with?(ext) ? slice(0..(-ext.length - 1)) : dup
+  end
+
+  # @return [String, String] source and type, where type is one of <tt>:project</tt>, <tt>:user</tt>, <tt>:built_in</tt>, <tt>:gem</tt>, or <tt>:unknown</tt>
+  def cog_source_and_type
+    if start_with?(Cog.project_root) || start_with?(Cog.project_template_path) || start_with?(Cog.project_generator_path) || start_with?(Cog.project_plugin_path)
+      [File.basename(Cog.project_root), :project]
+    elsif start_with? Cog.user_dir
+      [File.basename(ENV['HOME']), :user]
+    elsif start_with? Cog.gem_dir
+      ['cog', :built_in]
+    elsif start_with? File.expand_path(File.join(Cog.gem_dir, '..'))
+      ['gem', :gem]
+    else
+      ['unknown', :unknown]
+    end
+  end
+end

data/lib/cog/plugin.rb

@@ -0,0 +1,35 @@
+module Cog
+
+  # Describes a plugin found on the {Config#plugin_path}. The plugin {DSL::Cogfile} will have already been processed, and should have contained a call to {DSL::Cogfile#autoload_plugin}, which will make it's DSL available to generators via a {GeneratorSandbox}.
+  class Plugin
+      
+    # @return [String] name of the plugin
+    attr_reader :name
+
+    # @return [String] path to the plugin directory
+    attr_reader :path
+    
+    # @return [String] path to the plugin's cogfile
+    attr_reader :cogfile_path
+    
+    # @return [Block] the block to use to stamp the generator
+    attr_accessor :stamp_generator_block
+    
+    # @param cogfile_path [String] path to the plugin Cogfile
+    def initialize(cogfile_path)
+      unless File.exists?(cogfile_path)
+        raise Errors::InvalidPluginConfiguration.new(cogfile_path)
+      end
+      @cogfile_path = File.expand_path cogfile_path
+      @path = File.dirname @cogfile_path
+      @name = File.basename @path
+      @name = $1 if /^(.+?)\-(\d|\.)+(rc2)?$/ =~ @name
+    end
+    
+    # Sort plugins by name
+    def <=>(other)
+      @name <=> other.name
+    end
+  end
+
+end

data/lib/cog/spec_helpers.rb

@@ -1,6 +1,5 @@
 require 'cog/spec_helpers/runner'
 require 'cog/spec_helpers/matchers'
-require 'fileutils'
 
 module Cog
   
@@ -44,10 +43,15 @@ module Cog
       File.expand_path File.join(File.dirname(__FILE__), '..', '..', 'spec')
     end
     
-    # @return [String] directory of an active spec fixture.
+    # @return [String] directory of the active fixture.
     def active_fixture_dir
       File.join spec_root, 'active_fixture'
     end
+    
+    # @return [String] directory of the active home fixture.
+    def active_home_fixture_dir
+      File.join spec_root, 'active_home_fixture'
+    end
 
     # @return [String] path to the Cogfile in the active spec fixture
     def cogfile_path
@@ -68,15 +72,15 @@ module Cog
     # @param name [String] template identifier (without the .erb extension)
     # @return [String] absolute file system path to the template
     def template(name)
-      File.expand_path File.join(active_fixture_dir, 'cog', 'templates', "#{name}")
+      File.expand_path File.join(active_fixture_dir, 'cog', 'templates', name.to_s)
     end
     
-    # @param name [String] tool fixture identifier
-    # @return [String] path to the test tool with the given name
-    def tool(name)
-      File.expand_path File.join(spec_root, 'tools', name.to_s, 'lib', "#{name}.rb")
+    # @param name [String] plugin name
+    # @return [String] absolute file system path to the plugin directory
+    def plugin(name)
+      File.expand_path File.join(active_fixture_dir, 'cog', 'plugins', name.to_s)
     end
-    
+
     # @param filename [String] name of a generated source file
     # @return [String] absolute path to the generated file
     def generated_file(filename)
@@ -89,16 +93,34 @@ module Cog
     # @return [nil]
     def use_fixture(name)
       path = File.join spec_root, 'fixtures', name.to_s
-      if File.exists?(path) && File.directory?(path)
-        FileUtils.rm_rf active_fixture_dir if File.exists? active_fixture_dir
-        FileUtils.cp_r path, active_fixture_dir
-        Dir.chdir active_fixture_dir
+      copy_fixture path, active_fixture_dir
+      Dir.chdir active_fixture_dir
+      nil
+    end
+    
+    # The next cog spec will execute in a fresh copy of the given home fixture
+    # Home fixture directories are stored in <tt>spec/home_fixtures</tt>
+    # @param name [String] name of the home fixture
+    # @return [nil]
+    def use_home_fixture(name)
+      path = File.join spec_root, 'home_fixtures', name.to_s
+      copy_fixture path, active_home_fixture_dir
+      nil
+    end
+    
+    private
+    
+    def copy_fixture(source, dest)
+      if File.exists?(source) && File.directory?(source)
+        FileUtils.rm_rf dest if File.exists? dest
+        FileUtils.cp_r source, dest
       else
         throw :invalid_fixture_name
       end
-      nil
     end
     
+    public
+    
+    extend self
   end
-  
 end

data/lib/cog/spec_helpers/matchers.rb

@@ -1,5 +1,5 @@
-require 'cog/spec_helpers/matchers/match_maker'
 require 'rspec'
+require 'cog/spec_helpers/matchers/match_maker'
 
 module Cog
   module SpecHelpers
@@ -42,13 +42,23 @@ module Cog
       end
       
       # The target {Invocation} should write the given list of lines to standard output
-      # @param x [Array<String>] a list of lines to match against standard output
+      # @param x [Array<String>, Regexp] a list of lines to match against standard output
       # @return [nil]
       def output(x)
         match_maker do
-          message { "to [write|not write] #{x.join "\n"} to STDOUT"}
+          message do
+            if x.is_a? Regexp
+              "to [write|not write] #{x.inspect} to STDOUT"
+            else
+              "to [write|not write] #{x.join "\n"} to STDOUT"
+            end
+          end
           test do
-            lines.zip(x).all? {|a, b| a.strip == b.to_s.strip}
+            if x.is_a? Regexp
+              x =~ lines.join("\n")
+            else
+              lines.zip(x).all? {|a, b| a.strip == b.to_s.strip}
+            end
           end
         end
       end

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

@@ -92,7 +92,7 @@ module Cog
         
         def _failure_message(repl)
           msg = instance_eval &@msg_block
-          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\2'
+          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, repl
           "expected #{@invocation} #{msg}\n#{trace}"
         end
       end

data/lib/cog/spec_helpers/runner.rb

@@ -6,13 +6,9 @@ module Cog
     # Points to the +cog+ command-line app
     class Runner
 
-      # Value of the COG_TOOLS environment variable for invocations returned from #run
-      attr_accessor :tools
-      
       # @param path_to_cl_app [String] path 
       def initialize
         @cog = File.expand_path File.join(File.dirname(__FILE__), '..', '..', '..', 'bin', 'cog')
-        @tools = []
       end
 
       # Run cog with the given arguments
@@ -20,7 +16,7 @@ module Cog
       # @return [Invocation] an object which can be used with custom {Matchers}
       def run(*args)
         args = [@cog, '--colorless'] + args
-        Invocation.new(args.collect {|x| x.to_s}, :tools => @tools)
+        Invocation.new(args.collect {|x| x.to_s})
       end
     end
     
@@ -31,10 +27,8 @@ module Cog
       
       # @api developer
       # @param cmd [Array<String>] path to +cog+ executable and arguments
-      # @option opt [Array<String>] :tools ([]) a list of tools to add to the +COG_TOOLS+ environment variable just before running the command with {#exec}
       def initialize(cmd, opt={})
         @cmd = cmd
-        @tools = (opt[:tools] || []).join ':'
       end
       
       # Execute the command
@@ -43,7 +37,7 @@ module Cog
       # @return [nil]
       def exec(&block)
         @cmd = ['bundle', 'exec'] + @cmd
-        ENV['COG_TOOLS'] = @tools
+        ENV['HOME'] = SpecHelpers.active_home_fixture_dir
         Open3.popen3 *@cmd do |i,o,e,t|
           block.call i,o,e
         end
@@ -52,7 +46,7 @@ module Cog
       # @api developer
       # @return [String] loggable representation
       def to_s
-        "`COG_TOOLS=#{@tools} #{@cmd.compact.join ' '}`"
+        "`#{@cmd.compact.join ' '}`"
       end
     end
     

data/lib/cog/version.rb

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