cog 0.2.2 → 0.3.0

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-15 00:00:00 Z
+date: 2012-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gli
@@ -111,35 +111,27 @@ extra_rdoc_files: []
 
 files: 
 - bin/cog
-- Default.cogfile
+- BuiltIn.cogfile
 - LICENSE
-- templates/basic/generator.rb.erb
-- templates/cog/custom_tool/cog_tool.rb.erb
-- templates/cog/custom_tool/Gemfile.erb
-- templates/cog/custom_tool/generator.rb.erb.erb
-- templates/cog/custom_tool/LICENSE.erb
-- templates/cog/custom_tool/Rakefile.erb
-- templates/cog/custom_tool/README.markdown.erb
-- templates/cog/custom_tool/template.txt.erb.erb
-- templates/cog/custom_tool/tool.gemspec.erb
-- templates/cog/custom_tool/tool.rb.erb
-- templates/cog/custom_tool/version.rb.erb
-- templates/warning.erb
-- lib/cog/built_in_tools/basic/cog_tool.rb
-- lib/cog/built_in_tools/basic.rb
-- lib/cog/built_in_tools.rb
-- lib/cog/config/cogfile.rb
-- lib/cog/config/lang_info.rb
-- lib/cog/config/language_methods.rb
-- lib/cog/config/project_methods.rb
-- lib/cog/config/tool_methods.rb
+- built_in/generators/sort.rb
+- built_in/plugins/basic/Cogfile
+- built_in/plugins/basic/templates/basic/generator.rb.erb
+- built_in/templates/cog/Cogfile.erb
+- built_in/templates/cog/plugin/generator.rb.erb.erb
+- built_in/templates/cog/plugin/plugin.rb.erb
+- built_in/templates/warning.erb
+- lib/cog/config/language_config.rb
+- lib/cog/config/plugin_config.rb
+- lib/cog/config/project_config.rb
 - lib/cog/config.rb
 - lib/cog/controllers/generator_controller.rb
+- lib/cog/controllers/plugin_controller.rb
 - lib/cog/controllers/template_controller.rb
-- lib/cog/controllers/tool_controller.rb
 - lib/cog/controllers.rb
+- lib/cog/dsl/cogfile.rb
+- lib/cog/dsl/language_dsl.rb
+- lib/cog/dsl.rb
 - lib/cog/embed_context.rb
-- lib/cog/embeds/file_scanner.rb
 - lib/cog/embeds.rb
 - lib/cog/errors.rb
 - lib/cog/generator/file_methods.rb
@@ -147,28 +139,19 @@ files:
 - lib/cog/generator/language_methods/scope.rb
 - lib/cog/generator/language_methods.rb
 - lib/cog/generator.rb
-- lib/cog/helpers/cascading_template_set.rb
-- lib/cog/helpers/string.rb
+- lib/cog/generator_sandbox.rb
+- lib/cog/helpers/cascading_set.rb
+- lib/cog/helpers/file_scanner.rb
 - lib/cog/helpers.rb
-- lib/cog/languages/c_language.rb
-- lib/cog/languages/c_plus_plus_language.rb
-- lib/cog/languages/c_sharp_language.rb
-- lib/cog/languages/java_language.rb
-- lib/cog/languages/java_script_language.rb
-- lib/cog/languages/language.rb
-- lib/cog/languages/mixins/c_style_comments.rb
-- lib/cog/languages/mixins/hash_comments.rb
-- lib/cog/languages/mixins.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/language.rb
+- lib/cog/native_extensions/array.rb
+- lib/cog/native_extensions/string.rb
+- lib/cog/native_extensions.rb
+- lib/cog/plugin.rb
 - lib/cog/spec_helpers/matchers/match_maker.rb
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb
 - lib/cog/spec_helpers.rb
-- lib/cog/tool/dsl.rb
-- lib/cog/tool.rb
 - lib/cog/version.rb
 - lib/cog.rb
 - yard-templates/default/fulldoc/html/css/common.css

data/Default.cogfile

@@ -1,25 +0,0 @@
-# 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'
-
-# 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++'

data/lib/cog/built_in_tools.rb

@@ -1,9 +0,0 @@
-module Cog
-  
-  # A place to store built-in +cog+ tools.
-  #
-  # Built-in tools are distributed with the +cog+ gem.
-  module BuiltInTools
-  end
-
-end

data/lib/cog/built_in_tools/basic.rb

@@ -1,10 +0,0 @@
-module Cog
-  module BuiltInTools
-
-    # The default +cog+ tool.
-    # Creates an example generator.
-    module Basic
-    end
-    
-  end
-end

data/lib/cog/built_in_tools/basic/cog_tool.rb

@@ -1,11 +0,0 @@
-require 'cog'
-include Cog::Generator
-
-Cog.register_tool __FILE__, :built_in => true do |tool|
-
-  tool.stamp_generator do |name, dest|
-    @name = name
-    stamp 'basic/generator.rb', dest, :absolute_destination => true
-  end
-  
-end

data/lib/cog/config/cogfile.rb

@@ -1,117 +0,0 @@
-require 'active_support/core_ext'
-require 'cog/languages'
-
-module Cog
-  module Config
-    
-    # In your project's +Cogfile+, +self+ has been set to an instance of this class.
-    # Typing <tt>cog init</tt> will create a +Cogfile+ in the present working directory.
-    #
-    # @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'
-    # 
-    #   # 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
-      
-      # Initialize with an instance of {Config}
-      # @api developer
-      # @param config [Config] the object which will be configured by this Cogfile
-      def initialize(config)
-        @config = config
-      end
-    
-      # Interpret the +Cogfile+ at {Config::ProjectMethods#cogfile_path}
-      # @api developer
-      # @return [nil]
-      def interpret
-        eval File.read(@config.cogfile_path), binding
-        nil
-      rescue Exception => e
-        raise CogfileError.new(e.to_s)
-      end
-    
-      # Define the directory in which to find project generators
-      # @param path [String] a file system path
-      # @param absolute [Boolean] if +false+, the path is relative to {Config::ProjectMethods#project_root}
-      # @return [nil]
-      def project_generators_path(path, absolute=false)
-        @config.instance_eval do
-          @project_generators_path = absolute ? path : File.join(project_root, path)
-        end
-        nil
-      end
-
-      # Define the directory in which to find custom project templates
-      # @param path [String] a file system path
-      # @param absolute [Boolean] if +false+, the path is relative to {Config::ProjectMethods#project_root}
-      # @return [nil]
-      def project_templates_path(path, absolute=false)
-        @config.instance_eval do
-          @project_templates_path = absolute ? path : File.join(project_root, path)
-        end
-        nil
-      end
-
-      # Define the directory to which project source code is generated
-      # @param path [String] a file system path
-      # @param absolute [Boolean] if +false+, the path is relative to {Config::ProjectMethods#project_root}
-      # @return [nil]
-      def project_source_path(path, absolute=false)
-        @config.instance_eval do
-          @project_source_path = absolute ? path : File.join(project_root, path)
-        end
-        nil
-      end
-
-      # Explicitly specify a mapping from file extensions to languages
-      # @param map [Hash] key-value pairs from this mapping will override the default language map supplied by +cog+
-      # @return [nil]
-      def language_extensions(map)
-        @config.instance_eval do
-          @language_extension_map.update map
-        end
-        nil
-      end
-      
-      # Define the target language which should be used when
-      # creating generators, and no language is explicitly specified
-      # @param lang_id [String] a language identifier
-      def default_target_language(lang_id)
-        @config.instance_eval do
-          @target_language = Cog::Languages.get_language(lang_id)
-        end
-      end
-    end
-
-    # For wrapping errors which occur during the processing of a {Cogfile}
-    class CogfileError < StandardError
-      def message
-        "in Cogfile, " + super
-      end
-    end
-    
-  end
-end

data/lib/cog/config/lang_info.rb

@@ -1,40 +0,0 @@
-module Cog
-  module Config
-    
-    # Describes configuration of a supported language
-    class LangInfo
-      # @return [String] a language identifier
-      attr_reader :lang_id
-      
-      # @return [Array<String>] a list of aliases
-      attr_reader :aliases
-      
-      # @return [Array<Symbol>] a list of extension which currently map to this language
-      attr_reader :extensions
-      
-      # @return [String] readable name of the language
-      attr_reader :name
-      
-      # @api developer
-      def initialize(lang_id, aliases)
-        @lang_id = lang_id
-        @aliases = aliases.dup
-        @name = @aliases.empty? ? @lang_id : @aliases.join(', ')
-        @extensions = []
-      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
-    end
-    
-  end
-end

data/lib/cog/config/project_methods.rb

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

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