cog 0.2.1 → 0.2.2

data/lib/cog/config/language_methods.rb

@@ -0,0 +1,71 @@
+require 'cog/config/lang_info'
+
+module Cog
+  module Config
+    
+    # {Config} methods related to languages
+    module LanguageMethods
+      
+      # @return [Languages::Lanugage] target language which should be used when creating generators, and no language is explicitly specified
+      attr_accessor :target_language
+      
+      # @return [Languages::Language] language which is active in the current context
+      def active_language
+        @active_languages.last
+      end
+
+      # Activate a given language within the scope of the provided block.
+      # Either provide <tt>:id</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.
+      # @option opt [:String] :id (nil) 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
+      # @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(opt={}, &block)
+        throw :ActivateLanguageRequiresABlock if block.nil?
+        lang_id = if opt[:ext]
+          ext = opt[:ext].to_s
+          ext = ext.slice(1..-1) if ext.start_with?('.')
+          @language_extension_map[ext.downcase.to_sym] unless ext.empty?
+        else
+          opt[:id]
+        end
+        if lang_id
+          @active_languages << Languages.get_language(lang_id)
+          r = block.call
+          @active_languages.pop
+          r
+        else
+          block.call
+        end
+      end
+
+      # @return [Array<String>] list of file extensions for supported languages
+      def language_extensions
+        @language_extension_map.keys
+      end
+
+      # @param path [String] the file system extension, or full path to a file
+      # @return [Languages::Language, nil] the language for the given extension
+      def language_for(path)
+        ext = File.extname(path.to_s)
+        ext = path.to_s if ext.empty?
+        ext = ext.downcase
+        ext = ext.slice(1..-1) if ext.start_with? '.'
+        lang_id = @language_extension_map[ext.to_sym]
+        Languages.get_language lang_id unless lang_id.nil?
+      end
+
+      # @return [Array<LangInfo>] current configuration of supported languages
+      def language_summary
+        summary = {}
+        @language_extension_map.each_pair do |ext, lang_id|
+          lang_id = Languages::ALIAS[lang_id] || lang_id
+          summary[lang_id] ||= LangInfo.new(lang_id, Languages::REV_ALIAS[lang_id] || [])
+          summary[lang_id].extensions << ext
+        end
+        summary.values.sort
+      end
+    
+    end
+  end
+end

data/lib/cog/config/project_methods.rb

@@ -0,0 +1,35 @@
+module Cog
+  module Config
+
+    # {Config} methods related to projects
+    module ProjectMethods
+      
+      # @return [String] path to the project's {Cogfile}
+      attr_reader :cogfile_path
+
+      # @return [String] directory in which to find project generators
+      attr_reader :project_generators_path
+
+      # @return [String] directory in which the project's {Cogfile} is found
+      attr_reader :project_root
+    
+      # @return [String] directory to which project source code is generated
+      attr_reader :project_source_path
+
+      # @return [String] directory in which to find custom project templates
+      attr_reader :project_templates_path
+      
+      # @return [Boolean] whether or not we operating in the context of a project
+      def project?
+        !@project_root.nil?
+      end
+
+      # @return [Array<String>] list of paths to files in the {#project_source_path} which are written in a supported language
+      def supported_project_files
+        exts = Cog.language_extensions.join ','
+        Dir.glob "#{Cog.project_source_path}/**/*.{#{exts}}"
+      end
+      
+    end
+  end
+end

data/lib/cog/config/tool_methods.rb

@@ -0,0 +1,94 @@
+module Cog
+  module Config
+    
+    # {Config} methods related to tools
+    module ToolMethods
+      
+      # @return [Tool] the active tool affects the creation of new generators
+      def active_tool
+        @active_tools.last
+      end
+    
+      # @return [Array<Tool>] a sorted list of available tools
+      def tools
+        @tools.values.sort
+      end
+    
+      # Register built-in and custom tools.
+      # @api developer
+      #
+      # Custom tools are specified in the +COG_TOOLS+ environment variable.
+      # @return [nil]
+      def register_tools
+        # Register built-in tools
+        [:basic].each do |built_in|
+          require File.join(Cog.gem_dir, 'lib', 'cog', 'built_in_tools', built_in.to_s, 'cog_tool.rb')
+        end
+        # Register custom tools defined in COG_TOOLS
+        (ENV['COG_TOOLS'] || '').split(':').each do |path|
+          explicit = path.end_with? '.rb'
+          @next_tool_was_required_explicitly = explicit
+          path = "#{path}/cog_tool" unless explicit
+          begin
+            require path
+          rescue LoadError
+            raise Errors::CouldNotLoadTool.new path
+          end
+        end
+        nil
+      end
+
+      # Define a new +cog+ tool
+      # @param path [String] path to the <tt>cog_tool.rb</tt> file. This method should be called from the <tt>cog_tool.rb</tt> file, in which case <tt>__FILE__</tt> should be used as the argument
+      # @option opt [Boolean] :built_in (false) if +true+, then treat this tool as a built-in tool. If you are defininig a custom tool, leave this value as +false+
+      # @yield [Tool::DSL] define the tool
+      # @return [nil]
+      # @example
+      #   require 'cog'
+      #   include Cog::Generator
+      # 
+      #   Cog.register_tool __FILE__ do |tool|
+      #
+      #     # Define a method which creates the generator
+      #     tool.stamp_generator do |name, dest|
+      #
+      #       # Setup context for the template
+      #       @name = name
+      #
+      #       # Create the generator file
+      #       stamp 'my_tool/generator.rb', dest, :absolute_destination => true
+      #
+      #     end
+      #   end
+      def register_tool(path, opt={}, &block)
+        tool = Tool.new path, :built_in => opt[:built_in], :explicit_require => @next_tool_was_required_explicitly
+        dsl = Tool::DSL.new tool
+        block.call dsl
+        @tools[tool.name] = tool
+        nil
+      end
+    
+      # @api developer
+      # @return [Boolean] whether or not a tool is registered with the given name
+      def tool_registered?(name)
+        @tools.member? name
+      end
+    
+      # Activate the registered tool with the given name within the scope of the provided block. If no block is provided, the tool will remain active indefinitely.
+      # @param name [String] name of the registered tool to activate
+      # @yield the tool will be active within this block
+      # @return [nil]
+      def activate_tool(name, &block)
+        name = name.to_s
+        raise Errors::NoSuchTool.new(name) unless tool_registered?(name)
+        @tools[name].load
+        @active_tools << @tools[name]
+        if block
+          block.call
+          @active_tools.pop
+        end
+      end
+      
+    end
+  end
+end

data/lib/cog/controllers/generator_controller.rb

@@ -13,19 +13,18 @@ module Cog
       # @param name [String] the name to use for the new generator
       # @return [Boolean] was the generator successfully created?
       def self.create(name)
-        raise Errors::ActionRequiresProject.new('create generator') unless Config.instance.project?
-        generator_dest = File.join Config.instance.project_generators_path, "#{name}.rb"
+        raise Errors::ActionRequiresProject.new('create generator') unless Cog.project?
+        generator_dest = File.join Cog.project_generators_path, "#{name}.rb"
         raise Errors::DuplicateGenerator.new(generator_dest) if File.exists?(generator_dest)
-        gs = Config.instance.active_tool.generator_stamper
-        gs.stamp_generator name, generator_dest, Config.instance
+        Cog.active_tool.stamp_generator name, generator_dest
       end
 
       # List the available project generators
       # @option opt [Boolean] :verbose (false) list full paths to generator files
       # @return [Array<String>] a list of generators
       def self.list(opt={})
-        raise Errors::ActionRequiresProject.new('list generators') unless Config.instance.project?
-        x = Dir.glob(File.join Config.instance.project_generators_path, '*.rb')
+        raise Errors::ActionRequiresProject.new('list generators') unless Cog.project?
+        x = Dir.glob(File.join Cog.project_generators_path, '*.rb')
         opt[:verbose] ? x : (x.collect {|path| File.basename(path).slice(0..-4)})
       end
 
@@ -33,8 +32,8 @@ module Cog
       # @param name [String] name of the generator as returned by {GeneratorController.list}
       # @return [nil]
       def self.run(name)
-        raise Errors::ActionRequiresProject.new('run generator') unless Config.instance.project?
-        path = File.join Config.instance.project_generators_path, "#{name}.rb"
+        raise Errors::ActionRequiresProject.new('run generator') unless Cog.project?
+        path = File.join Cog.project_generators_path, "#{name}.rb"
         raise Errors::NoSuchGenerator.new(name) unless File.exists?(path)
         require path
         nil

data/lib/cog/controllers/template_controller.rb

@@ -15,13 +15,13 @@ module Cog
       # @return [Array<String>] a list of templates
       def self.list(opt={})
         cts = Helpers::CascadingTemplateSet.new
-        cts.add_templates 'built-in', :built_in, Config.cog_templates_path, opt
-        tool = Config.instance.active_tool
+        cts.add_templates 'built-in', :built_in, Cog.cog_templates_path, opt
+        tool = Cog.active_tool
         unless tool.templates_path.nil?
           cts.add_templates tool.name, :tool, tool.templates_path, opt
         end
-        if Config.instance.project?
-          cts.add_templates 'project', :project, Config.instance.project_templates_path, opt
+        if Cog.project?
+          cts.add_templates 'project', :project, Cog.project_templates_path, opt
         end
         cts.to_a
       end
@@ -31,25 +31,22 @@ module Cog
       # @option opt [Boolean] :force_override (false) if a built-in or tool template with the same name already exists, should a project override be created?
       # @return [nil]
       def self.create(name, opt={})
-        raise Errors::ActionRequiresProject.new('create template') unless Config.instance.project?
+        raise Errors::ActionRequiresProject.new('create template') unless Cog.project?
         name = name.without_extension :erb
-        dest = File.join Config.instance.project_templates_path, "#{name}.erb"
-        Object.instance_eval do
-          extend Generator
-          begin
-            original = get_template name, :as_path => true
-            return if original == dest # Nothing to create
-            if opt[:force_override]
-              copy_file_if_missing original, dest
-            else
-              raise Errors::DuplicateTemplate.new original
-            end
-          rescue Errors::NoSuchTemplate
-            # No original, ok to create an empty template
-            touch_file dest
-          end
-          nil
+        dest = File.join Cog.project_templates_path, "#{name}.erb"
+
+        original = Generator.get_template name, :as_path => true
+        return if original == dest # Nothing to create
+        if opt[:force_override]
+          Generator.copy_file_if_missing original, dest
+        else
+          raise Errors::DuplicateTemplate.new original
         end
+        nil
+      rescue Errors::NoSuchTemplate
+        # No original, ok to create an empty template
+        touch_file dest
+        nil
       end
       
     end

data/lib/cog/controllers/tool_controller.rb

@@ -16,38 +16,35 @@ module Cog
       # @return [nil]
       def self.create(name)
         raise Errors::DestinationAlreadyExists.new(name) if File.exists?(name)
-        raise Errors::DuplicateTool.new(name) if Config.instance.tool_registered?(name)
-        Object.new.instance_eval do
-          extend Generator
-          @tool_name = name.to_s.downcase
-          @tool_module = name.to_s.capitalize
-          @tool_author = '<Your name goes here>'
-          @tool_email = 'youremail@...'
-          @tool_description = 'A one-liner'
-          @cog_version = Cog::VERSION
-          stamp 'cog/custom_tool/tool.rb', "#{@tool_name}/lib/#{@tool_name}.rb", :absolute_destination => true
-          stamp 'cog/custom_tool/cog_tool.rb', "#{@tool_name}/lib/#{@tool_name}/cog_tool.rb", :absolute_destination => true
-          stamp 'cog/custom_tool/version.rb', "#{@tool_name}/lib/#{@tool_name}/version.rb", :absolute_destination => true
-          stamp 'cog/custom_tool/generator.rb.erb', "#{@tool_name}/cog/templates/#{@tool_name}/generator.rb.erb", :absolute_destination => true
-          stamp 'cog/custom_tool/template.txt.erb', "#{@tool_name}/cog/templates/#{@tool_name}/#{@tool_name}.txt.erb", :absolute_destination => true
-          stamp 'cog/custom_tool/Gemfile', "#{@tool_name}/Gemfile", :absolute_destination => true
-          stamp 'cog/custom_tool/Rakefile', "#{@tool_name}/Rakefile", :absolute_destination => true
-          stamp 'cog/custom_tool/tool.gemspec', "#{@tool_name}/#{@tool_name}.gemspec", :absolute_destination => true
-          stamp 'cog/custom_tool/LICENSE', "#{@tool_name}/LICENSE", :absolute_destination => true
-          stamp 'cog/custom_tool/README.markdown', "#{@tool_name}/README.markdown", :absolute_destination => true
-        end
+        raise Errors::DuplicateTool.new(name) if Cog.tool_registered?(name)
+        @tool_name = name.to_s.downcase
+        @tool_module = name.to_s.capitalize
+        @tool_author = '<Your name goes here>'
+        @tool_email = 'youremail@...'
+        @tool_description = 'A one-liner'
+        @cog_version = Cog::VERSION
+        opt = { :absolute_destination => true, :binding => binding }
+        Generator.stamp 'cog/custom_tool/tool.rb', "#{@tool_name}/lib/#{@tool_name}.rb", opt
+        Generator.stamp 'cog/custom_tool/cog_tool.rb', "#{@tool_name}/lib/#{@tool_name}/cog_tool.rb", opt
+        Generator.stamp 'cog/custom_tool/version.rb', "#{@tool_name}/lib/#{@tool_name}/version.rb", opt
+        Generator.stamp 'cog/custom_tool/generator.rb.erb', "#{@tool_name}/cog/templates/#{@tool_name}/generator.rb.erb", opt
+        Generator.stamp 'cog/custom_tool/template.txt.erb', "#{@tool_name}/cog/templates/#{@tool_name}/#{@tool_name}.txt.erb", opt
+        Generator.stamp 'cog/custom_tool/Gemfile', "#{@tool_name}/Gemfile", opt
+        Generator.stamp 'cog/custom_tool/Rakefile', "#{@tool_name}/Rakefile", opt
+        Generator.stamp 'cog/custom_tool/tool.gemspec', "#{@tool_name}/#{@tool_name}.gemspec", opt
+        Generator.stamp 'cog/custom_tool/LICENSE', "#{@tool_name}/LICENSE", opt
+        Generator.stamp 'cog/custom_tool/README.markdown', "#{@tool_name}/README.markdown", opt
         nil
       end
 
       # @param opt [Boolean] :verbose (false) list full paths to tools
       # @return [Array<String>] a list of available tools
       def self.list(opt={})
-        Config.instance.tools.collect do |tool|
+        Cog.tools.collect do |tool|
           opt[:verbose] ? tool.path : tool.name
         end
       end
 
-
     end
   end
 end

data/lib/cog/embed_context.rb

@@ -0,0 +1,131 @@
+require 'cog/config'
+
+module Cog
+
+  # Describes the environment of an embed statement including the file in which it was found, the line number, the language, an more.
+  class EmbedContext
+      
+    # @return [String] for expanded embed statements, the body of text which occurs between the curly braces
+    # @example
+    #   // cog: my-hook {
+    #   this is
+    #   the
+    #   body
+    #   // cog: }
+    attr_reader :body
+      
+    # @return [String] hook name used in the embed statement
+    # @example
+    #   // cog: this-is-the-hook-name
+    attr_reader :hook
+
+    # @return [Fixnum] line number at which the embed statement was found, with 1 being the first line in the file
+    attr_reader :lineno
+      
+    # @return [Fixnum] if multiple embeds with the same {#hook} occurred more than once in the same file, this value indicates to which occurrence this context belongs. 0 for the first, 1 for the second, and so on...
+    attr_reader :index
+      
+    # @return [Fixnum] if multiple embeds with the same {#hook} occurred more than once in the same file, this value indicates the total number of occurrences
+    attr_reader :count
+      
+    # @return [String] full file system path to the file
+    attr_reader :path
+      
+    # @api developer
+    # @param hook [String] hook name used in the embed statement
+    # @param path [String] path to the file in which the cog directive was found
+    # @param count [Fixnum] total occurrences in file
+    def initialize(hook, path, count)
+      @hook = hook.to_s
+      @path = path.to_s
+      @count = count
+      @eaten = 0
+    end
+      
+    # @return [Array<String>] arguments provided with the embed statement
+    # @example
+    #   // cog: my-hook (these are the args)
+    def args
+      @args
+    end
+      
+    # @return [String] the filename extension (without the period)
+    def extension
+      @ext ||= File.extname(filename).slice(1..-1)
+    end
+
+    # @return [String] basename of the file in which the embed statement was found
+    def filename
+      @filename ||= File.basename @path
+    end
+      
+    # @return [Boolean] whether or not this was the first occurrence of the embed {#hook} in the file
+    def first?
+      @index == 0
+    end
+
+    # @return [Boolean] whether or not this was the last occurrence of the embed {#hook} in the file
+    def last?
+      @index == @count - 1
+    end
+      
+    # @return [Boolean] was the 'once' switch used? Embed statements using this switch will be removed after the statement is expanded
+    # @example
+    #   // cog: my-hook once
+    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 [Fixnum] set the line number
+    def lineno=(value)
+      @lineno = 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
+    # @param index [Fixnum] occurrence in file, 0 for first
+    def index=(index)
+      @index = index
+    end
+      
+    # @api developer
+    # @param value [Fixnum] the number of once statements before this one that were eaten. Used to adjust the actual_index so that the file_scanner looks for the right statement
+    def eaten=(value)
+      @eaten = value
+    end
+      
+    # @api developer
+    # @return [Fixnum] takes into account the number of once statements that have been eaten
+    def actual_index
+      @index - @eaten
+    end
+      
+    # @api developer
+    # @return [String]
+    def to_directive
+      x = "cog: #{hook}"
+      x += "(#{args.join ' '})" if args
+      x += " once" if once?
+      x
+    end
+      
+  end
+end