cog 0.2.2 → 0.3.0

data/lib/cog/controllers/tool_controller.rb

@@ -1,50 +0,0 @@
-require 'cog/config'
-require 'cog/errors'
-require 'cog/generator'
-require 'rainbow'
-
-module Cog
-  module Controllers
-    
-    # Manage +cog+ tools
-    #
-    # @see https://github.com/ktonon/cog#tools Introduction to Tools
-    module ToolController
-
-      # Generate a new tool with the given name
-      # @param name [String] name of the tool to create. Should not conflict with other tool names
-      # @return [nil]
-      def self.create(name)
-        raise Errors::DestinationAlreadyExists.new(name) if File.exists?(name)
-        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={})
-        Cog.tools.collect do |tool|
-          opt[:verbose] ? tool.path : tool.name
-        end
-      end
-
-    end
-  end
-end

data/lib/cog/helpers/cascading_template_set.rb

@@ -1,75 +0,0 @@
-require 'cog/helpers/string'
-require 'rainbow'
-
-module Cog
-  module Helpers
-    
-    # @api developer
-    class TemplateInfo
-      attr_reader :name
-      attr_accessor :path
-      
-      def initialize(name)
-        @sources = []
-        @source_types = []
-        @name = name
-      end
-      
-      def add_source(source, source_type)
-        @sources << source
-        @source_types << source_type
-      end
-      
-      def style(text, type)
-        case type
-        when :built_in
-          text.color :cyan
-        when :tool
-          text.color :yellow
-        when :project
-          text.color(:white).bright
-        end
-      end
-      
-      def override_s(width=nil)
-        colorless = "[#{@sources.join ' < '}]"
-        if width
-          x = @sources.zip(@source_types).collect {|s, t| style s, t}
-          "[#{x.join ' < '}]" + " " * (width - colorless.length)
-        else
-          colorless
-        end
-      end
-      
-      def <=>(other)
-        (@path || @name) <=> (other.path || other.name)
-      end
-      
-      def to_s(override_column_width)
-        "#{override_s override_column_width} #{style @path || @name, @source_types.last}"
-      end
-    end
-    
-    # @api developer
-    class CascadingTemplateSet
-      def initialize
-        @templates = {}
-      end
-      
-      def add_templates(source, source_type, root, opt={})
-        Dir.glob("#{root}/**/*.erb") do |path|
-          name = path.relative_to(root).slice(0..-5)
-          @templates[name] ||= TemplateInfo.new name
-          @templates[name].path = path if opt[:verbose]
-          @templates[name].add_source source, source_type
-        end
-      end
-      
-      def to_a
-        w = @templates.values.collect {|t| t.override_s.length}.max
-        @templates.values.sort.collect {|t| t.to_s(w)}
-      end
-    end
-    
-  end
-end

data/lib/cog/helpers/string.rb

@@ -1,26 +0,0 @@
-require 'cog/config'
-
-class String
-  
-  # @return [String] strips {Cog::Config::ProjectMethods#project_root} from the beginning of this string
-  def relative_to_project_root
-    return dup unless Cog.project?
-    relative_to Cog.project_root
-  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)
-    return dup if prefix.nil?
-    start_with?(prefix.to_s) ? slice(prefix.to_s.length+1..-1) : dup
-  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
-end

data/lib/cog/languages.rb

@@ -1,52 +0,0 @@
-require 'cog/errors'
-require 'cog/languages/language'
-require 'cog/languages/mixins'
-
-module Cog
-  
-  # Submodules define helpers for the target languages supported by +cog+
-  module Languages
-    
-    # @return [Hash] a mapping from file extensions to languages identifiers
-    DEFAULT_LANGUAGE_EXTENSION_MAP = {
-      :c => 'c',
-      :cpp => 'c++',
-      :cs => 'c#',
-      :h => 'c',
-      :hpp => 'c++',
-      :java => 'java',
-      :js => 'javascript',
-      :pri => 'qt',
-      :pro => 'qt',
-      :py => 'python',
-      :rb => 'ruby',
-    }
-
-    # @return [Hash] a mapping from language aliases to language identifiers
-    ALIAS = {
-      'c++' => 'c_plus_plus',
-      'c#' => 'c_sharp',
-      'javascript' => 'java_script',
-      'qt' => 'qt_project',
-    }
-    
-    # @return [Hash] a mapping of language identifiers to lists of aliases
-    REV_ALIAS = {}
-    ALIAS.each_pair do |a, lang|
-      REV_ALIAS[lang] ||= []
-      REV_ALIAS[lang] << a
-    end
-    
-    # @param lang_id [String] a langauge identifier
-    # @return [Language] a language helper corresponding to the given identifier
-    def self.get_language(lang_id)
-      lang_id = Languages::ALIAS[lang_id] || lang_id
-      require "cog/languages/#{lang_id.to_s.downcase}_language"
-      Languages.instance_eval {const_get "#{lang_id.camelize}Language"}.new
-    rescue LoadError
-      raise Errors::NoSuchLanguage.new lang_id
-    end
-    
-  end
-
-end

data/lib/cog/languages/c_language.rb

@@ -1,29 +0,0 @@
-require 'cog/languages/language'
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    class CLanguage < Language
-      include Mixins::CStyleComments
-
-      # @return [Array<String>] a set of extensions needed to define a module in this language
-      def module_extensions
-        [:c, :h]
-      end
-            
-      # @param name [String] name of the module to protect
-      # @return [String] an include guard statement
-      def include_guard_begin(name)
-        "#ifndef #{name}\n#define #{name}"
-      end
-      
-      # @param name [String] name of the module to protect
-      # @return [String] an include guard end statement
-      def include_guard_end(name)
-        "#endif // #{name}"
-      end
-
-    end
-  end
-end

data/lib/cog/languages/c_plus_plus_language.rb

@@ -1,28 +0,0 @@
-require 'cog/languages/c_language'
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    class CPlusPlusLanguage < Language
-      include Mixins::CStyleComments
-
-      def module_extensions
-        [:cpp, :hpp]
-      end
-      
-      def use_named_scope(name)
-        "using namespace #{name};"
-      end
-
-      def named_scope_begin(name)
-        "namespace #{name} {"
-      end
-
-      def named_scope_end(name)
-        "} // namespace #{name}"
-      end
-
-    end
-  end
-end

data/lib/cog/languages/c_sharp_language.rb

@@ -1,24 +0,0 @@
-require 'cog/languages/c_language'
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    class CSharpLanguage < Language
-      include Mixins::CStyleComments
-
-      def module_extensions
-        [:cs]
-      end
-      
-      def named_scope_begin(name)
-        "namespace #{name} {"
-      end
-
-      def named_scope_end(name)
-        "} // namespace #{name}"
-      end
-      
-    end
-  end
-end

data/lib/cog/languages/java_language.rb

@@ -1,24 +0,0 @@
-require 'cog/languages/c_language'
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    class JavaLanguage < Language
-      include Mixins::CStyleComments
-
-      def module_extensions
-        [:java]
-      end
-      
-      def named_scope_begin(name)
-        "package #{name};"
-      end
-
-      def named_scope_end(name)
-        "// end of package: #{name}"
-      end
-      
-    end
-  end
-end

data/lib/cog/languages/java_script_language.rb

@@ -1,24 +0,0 @@
-require 'cog/languages/c_language'
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    class JavaScriptLanguage < Language
-      include Mixins::CStyleComments
-
-      def module_extensions
-        [:js]
-      end
-      
-      def named_scope_begin(name)
-        "var #{name} = { // named scope"
-      end
-
-      def named_scope_end(name)
-        "}; // named scope: #{name}"
-      end
-
-    end
-  end
-end

data/lib/cog/languages/language.rb

@@ -1,73 +0,0 @@
-module Cog
-  module Languages
-
-    # 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)
-        if text =~ /\n/
-          multi_line_comment text
-        else
-          one_line_comment text
-        end
-      end
-
-      # @api developer
-      def one_line_comment(text)
-        text
-      end
-      
-      # @api developer
-      def multi_line_comment(text)
-        text.split("\n").collect do |line|
-          one_line_comment line
-        end.join "\n"
-      end
-      
-      # @return [Array<String>] a set of extensions needed to define a module in this language
-      def module_extensions
-        [:txt]
-      end
-      
-      # @param name [String] name of the scope to use
-      # @return [String] a using statement for the named scope
-      def use_named_scope(name)
-        ""
-      end
-      
-      # @param name [String] name of the scope
-      # @return [String] begin a named scope
-      def named_scope_begin(name)
-        ""
-      end
-
-      # @param name [String] name of the scope
-      # @return [String] end the given named scope
-      def named_scope_end(name)
-        ""
-      end
-      
-      # @param name [String] name of the module to protect
-      # @return [String] an include guard statement
-      def include_guard_begin(name)
-        ""
-      end
-      
-      # @param name [String] name of the module to protect
-      # @return [String] an include guard end statement
-      def include_guard_end(name)
-        ""
-      end
-
-    end
-  end
-end

data/lib/cog/languages/mixins.rb

@@ -1,10 +0,0 @@
-require 'cog/languages/mixins/c_style_comments'
-
-module Cog
-  module Languages
-    
-    # Place for mixins which define common patterns in language syntax
-    module Mixins
-    end
-  end
-end

data/lib/cog/languages/mixins/c_style_comments.rb

@@ -1,23 +0,0 @@
-module Cog
-  module Languages
-    module Mixins
-      
-      # Methods for defining single and multiline c-style comments
-      module CStyleComments
-        
-        def comment_pattern(nested_pattern)
-          /^\s*(?:\/\/|\/\*)\s*#{nested_pattern}\s*(?:\*\/)?\s*$/i
-        end
-
-        def one_line_comment(text)
-          "// #{text}"
-        end
-      
-        def multi_line_comment(text)
-          "/*\n#{text}\n */"
-        end
-        
-      end
-    end
-  end
-end