cog 0.0.10 → 0.0.11

data/lib/cog/generator.rb

@@ -0,0 +1,138 @@
+require 'cog/config'
+require 'cog/errors'
+require 'erb'
+
+module Cog
+  
+  # Generators have the ability to #stamp templates into source code.
+  #
+  # This module defines a low-level interface for writing generators. To use it,
+  # just include the Generator module in your class or object.
+  module Generator
+
+    # A list of available project generators
+    def self.available
+      [:dummy1, :dummy2]
+    end
+
+    # Get the template with the given name.
+    #
+    # ==== Parameters
+    # * +path+ - a path to a template file which is relative to
+    #   one of the template directories
+    #
+    # ==== Options
+    # * <tt>:absolute</tt> - is the +path+ argument absolute? (default: +false+)
+    #
+    # ==== Returns
+    # An instance of ERB.
+    def get_template(path, opt={})
+      path += '.erb'
+      fullpath = if opt[:absolute]
+        path
+      else
+        Config.instance.template_paths.inject('') do |found, prefix|
+          x = File.join prefix, path
+          found.empty? && File.exists?(x) ? x : found
+        end
+      end
+      raise Errors::MissingTemplate.new fullpath unless File.exists? fullpath
+      ERB.new File.read(fullpath), 0, '>'
+    end
+    
+    # Stamp a template +source+ onto a +destination+.
+    #
+    # ==== Arguments
+    # * +template_path+ - a path to a template file which is relative to one
+    #   of the template directories
+    # * +destination+ - a path to which the generated file should be written
+    #
+    # ==== Options
+    # * <tt>:absolute_template_path</tt> - is the +template_path+ argument absolute? (default: +false+)
+    def stamp(template_path, destination, opt={})
+      t = get_template template_path, :absolute => opt[:absolute_template_path]
+      b = opt[:binding] || binding
+      FileUtils.mkpath File.dirname(destination) unless File.exists? destination
+      scratch = "#{destination}.scratch"
+      File.open(scratch, 'w') {|file| file.write t.result(b)}
+      if same? destination, scratch
+        FileUtils.rm scratch
+      else
+        puts "Generated #{destination}"
+        FileUtils.mv scratch, destination
+      end
+      nil
+    end
+
+    # Copy a file from +src+ to +dest+, but only if +dest+ does not already exist.
+    def copy_if_missing(src, dest)
+      unless File.exists? dest
+        FileUtils.cp src, dest
+        puts "Created #{dest}"
+      end
+    end
+
+    # Recursively create directories in the given path if they are missing.
+    def touch_path(*path_components)
+      path = File.join path_components
+      unless File.exists? path
+        FileUtils.mkdir_p path
+        puts "Created #{path}"
+      end
+    end
+    
+    # File extension for a snippet of the given source code language.
+    # ==== Example
+    #   snippet_extension 'c++' # => 'h'
+    def snippet_extension(lang = 'text')
+      case lang
+      when /(c\+\+|c|objc)/i
+        'h'
+      else
+        'txt'
+      end
+    end
+          
+    # A warning that indicates a file is maintained by a generator
+    def generated_warning
+      lang = Config.instance.language
+      t = get_template "snippets/#{lang}/generated_warning.#{snippet_extension lang}", :cog_template => true
+      t.result(binding)
+    end
+    
+    def include_guard_begin(name)
+      full = "COG_INCLUDE_GUARD_#{name.upcase}"
+      "#ifndef #{full}\n#define #{full}"
+    end
+    
+    def include_guard_end
+      "#endif // COG_INCLUDE_GUARD_[...]"
+    end
+    
+    def namespace_begin(name)
+      return if name.nil?
+      case Config.instance.language
+      when /c\+\+/
+        "namespace #{name} {"
+      end
+    end
+
+    def namespace_end(name)
+      return if name.nil?
+      case Config.instance.language
+      when /c\+\+/
+        "} // namespace #{name}"
+      end
+    end
+    
+  private
+    def same?(original, scratch) # :nodoc:
+      if File.exists? original
+        File.read(original) == File.read(scratch)
+      else
+        false
+      end
+    end
+
+  end
+end

data/lib/cog/spec_helpers.rb

@@ -1,5 +1,6 @@
 require 'cog/spec_helpers/runner'
 require 'cog/spec_helpers/matchers'
+require 'fileutils'
 
 module Cog
   
@@ -24,6 +25,40 @@ module Cog
   # 
   #   end
   module SpecHelpers
+
+    # Absolute path to the root spec directory
+    def spec_root
+      File.expand_path File.join(File.dirname(__FILE__), '..', '..', 'spec')
+    end
+    
+    # Directory of an active spec fixture.
+    def active_fixture_dir
+      File.join spec_root, 'active_fixture'
+    end
+
+    # Path to the Cogfile in the active spec fixture
+    def cogfile_path
+      File.join active_fixture_dir, 'Cogfile'
+    end
+    
+    # Path to the cog directory in the active spec fixture
+    def cog_directory
+      File.join active_fixture_dir, 'cog'
+    end
+    
+    # The next cog spec will execute in a fresh copy of the given fixture directory.
+    # Fixture directories are stored in <tt>spec/fixtures</tt>.
+    def use_fixture(name)
+      path = File.join spec_root, 'fixtures', name.to_s
+      if File.exists?(path) && File.directory?(path)
+        FileUtils.rmtree active_fixture_dir if File.exists? active_fixture_dir
+        FileUtils.cp_r path, active_fixture_dir
+        Dir.chdir active_fixture_dir
+      else
+        throw :invalid_fixture_name
+      end
+    end
+    
   end
   
 end

data/lib/cog/spec_helpers/matchers.rb

@@ -1,3 +1,4 @@
+require 'cog/spec_helpers/matchers/match_maker'
 require 'rspec'
 
 module Cog
@@ -6,26 +7,25 @@ module Cog
     # Extra should or should_not matchers for RSpec.
     module Matchers
       
-      class ShowHelp # :nodoc:
-        def matches?(runner)
-          @runner = runner
-          @runner.exec do |i,o,e|
-            @first_line = o.readline
-            @second_line = o.readline
-            /help.*code gen/ =~ @second_line
-          end
-        end
-        def failure_message
-          "expected #{@runner} to show the default help text, got #{@first_line.inspect}"
-        end
-        def negative_failure_message
-          "expected #{@runner} to not show the default help text, got #{@first_line.inspect}"
+      # The target Invocation should output the default help text
+      def show_help
+        match_maker do
+          message { "to [show|not show] the default help text, got #{lines.first.inspect}" }
+          test { (/help.*code gen/ =~ lines[1]) }
         end
       end
       
-      # The target Invocation should output the default help text
-      def show_help
-        ShowHelp.new
+      # The target Invocation should create a +Cogfile+ where none existed before
+      def make(path)
+        match_maker do
+          message { "to [create|not create] the #{path}" }
+          before do
+            @existed = File.exists? path
+          end
+          test do
+            !@existed && File.exists?(path)
+          end
+        end
       end
     end
     

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

@@ -0,0 +1,51 @@
+module Cog
+  module SpecHelpers
+    module Matchers
+      
+      class MatchMaker
+        attr_reader :lines
+
+        # Define the failure message
+        def message(&block)
+          @msg_block = block
+        end
+        
+        # Define a block which runs before the Invocation
+        def before(&block)
+          @before_block = block
+        end
+        
+        # Define the test which runs after the Invocation
+        def test(&block)
+          @test_block = block
+        end
+        
+        def matches?(runner) # :nodoc:
+          @runner = runner
+          instance_eval &@before_block unless @before_block.nil?
+          @runner.exec do |input, output, error|
+            @lines = output.readlines
+          end
+          instance_eval &@test_block
+        end
+        def failure_message # :nodoc:
+          msg = instance_eval &@msg_block
+          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\1'
+          "expected #{@runner} #{msg}"
+        end
+        def negative_failure_message # :nodoc:
+          msg = instance_eval &@msg_block
+          msg = msg.gsub /\[([^\|\]]*)(?:\|([^\]]*)\])?/, '\2'
+          "expected #{@runner} #{msg}"
+        end
+      end
+      
+      def match_maker(&block)
+        m = MatchMaker.new
+        m.instance_eval &block
+        m
+      end
+      
+    end
+  end
+end

data/lib/cog/spec_helpers/runner.rb

@@ -4,10 +4,10 @@ module Cog
   module SpecHelpers
 
     # Points to the +cog+ command-line app
-    class App
+    class Runner
 
       def initialize(path_to_cl_app)
-        @cog = path_to_cl_app
+        @cog = File.expand_path path_to_cl_app
       end
 
       # Run cog with the given arguments
@@ -16,8 +16,8 @@ module Cog
       # An instance of Invocation configured with the arguments. Use should and
       # should_not with the custom Matchers
       def run(*args)
-        args.unshift @cog
-        Invocation.new args
+        args = ['bundle', 'exec', @cog] + args
+        Invocation.new(args.collect {|x| x.to_s})
       end
     end
     
@@ -30,11 +30,15 @@ module Cog
       end
       
       def exec(*args, &block) # :nodoc:
+        @s = ([File.basename @cmd[2]] + @cmd.slice(3..-1)).join ' '
         Open3.popen3 *@cmd do |i,o,e,t|
           block.call i,o,e
         end
       end
-      
+
+      def to_s
+        "`#{@s}`"
+      end
     end
     
   end

data/lib/cog/tool.rb

@@ -0,0 +1,51 @@
+require 'cog/config'
+require 'cog/generator'
+
+module Cog
+  
+  class Tool
+
+    # Lower case command-line version of the name
+    attr_reader :name
+    
+    # Capitalized module name
+    attr_reader :module_name
+
+    # Name of the person who will be given copyright for the generated code
+    attr_reader :author
+    
+    # Email address of the author
+    attr_reader :email
+    
+    # A one-line description of the tool
+    attr_reader :description
+    
+    # A list of available tools
+    def self.available
+      # TODO: use paths to instantiate a list of Tool objects
+      paths = ENV['COG_TOOLS'] || []
+    end
+    
+    def self.generate_tool(name)
+      Object.new.instance_eval do
+        class << self ; include Generator ; end
+        @name = name.to_s.downcase
+        @module_name = name.to_s.capitalize
+        @author = '<Your name goes here>'
+        @email = 'youremail@...'
+        @description = 'A one-liner'
+        @cog_version = Cog::VERSION
+        stamp 'cog/tool/tool.rb', "#{@name}/lib/#{@name}.rb"
+        stamp 'cog/tool/version.rb', "#{@name}/lib/#{@name}/version.rb"
+        stamp 'cog/tool/generator.rb', "#{@name}/cog/templates/#{@name}/generator.rb.erb"
+        stamp 'cog/tool/Gemfile', "#{@name}/Gemfile"
+        stamp 'cog/tool/Rakefile', "#{@name}/Rakefile"
+        stamp 'cog/tool/tool.gemspec', "#{@name}/#{@name}.gemspec"
+        stamp 'cog/tool/API.rdoc', "#{@name}/API.rdoc"
+        stamp 'cog/tool/LICENSE', "#{@name}/LICENSE"
+        stamp 'cog/tool/README.markdown', "#{@name}/README.markdown"
+      end
+    end
+  end
+
+end

data/lib/cog/version.rb

@@ -0,0 +1,3 @@
+module Cog
+  VERSION = '0.0.11' unless const_defined? :VERSION
+end

data/templates/cog/tool/API.rdoc.erb

@@ -0,0 +1,7 @@
+= <%= @name %> 
+
+These are the API docs for +<%= @name %>+, which is +cog+ tool.
+
+Please see the <tt>README.markdown</tt> file for a introduction to the
++<%= @name %>+ tool. To find out more about +cog+ in general visit
+https://github.com/ktonon/cog#readme

data/templates/cog/tool/Gemfile.erb

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+
+gem "cog", "~> <%= @cog_version %>"

data/templates/cog/tool/LICENSE.erb

@@ -0,0 +1,18 @@
+Copyright (c) 2012 <%= @author %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/templates/cog/tool/README.markdown.erb

@@ -0,0 +1,18 @@
+= <%= @name %> 
+
+<%= @description %>
+
+Get it
+------
+
+From a terminal
+
+```bash
+gem install <%= @name %> 
+```
+
+or in your Gemfile
+
+```ruby
+gem "<%= @name %>", "~> 0.0.1"
+```

data/templates/cog/tool/Rakefile.erb

@@ -0,0 +1,15 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "API.rdoc"
+  rd.rdoc_files.include("API.rdoc", "lib/**/*.rb")
+  rd.title = '<%= @module_name %> API Docs'
+end
+
+spec = eval(File.read('<%= @name %>.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end