cog 0.0.3 → 0.0.4

data/API.rdoc

@@ -23,3 +23,9 @@ and it will look something like this:
   # The directory in which application code can be found. This is where
   # generated code will go. Probably along side non-generated code.
   code_dir 'src'
+
+== Testing
+
+The tests are written in +RSpec+ and can be found in the <tt>spec/</tt>
+directory. Custom matchers are available to make writing specs easier. See
+Cog::SpecHelpers for more details.

data/Master.cogfile

@@ -0,0 +1,10 @@
+# This is the master Cogfile. It is used by cog.
+
+# All paths are relative to the directory containing this file.
+
+# The directory in which to find ERB template files.
+template_dir 'templates'
+
+# The directory in which application code can be found. This is where
+# generated code will go. Probably along side non-generated code.
+code_dir Cogfile.for_project.template_dir, :absolute => true

data/bin/cog

@@ -26,21 +26,9 @@ desc 'Write extra information'
 switch [:v,:verbose]
 
 desc 'Add cog to a project by generating a Cogfile in the current directory'
-command :project do |c|
+command :init do |c|
   c.action do |global_options, options, args|
-    puts 'Created Cogfile'
-    File.open('Cogfile', 'w') do |file|
-      # TODO: use a template to do this instead
-      file.write("# All paths are relative to the directory containing this file.
-
-# The directory in which to find ERB template files.
-template_dir 'templates'
-
-# The directory in which application code can be found. This is where
-# generated code will go. Probably along side non-generated code.
-code_dir 'src'
-")
-    end
+    Cog.copy_default_cogfile 'Cogfile'
   end
 end
 
@@ -48,7 +36,6 @@ desc 'Create a new template'
 arg_name 'NAME'
 command :template do |c|
   c.action do |global_options, options, args|
-    puts 'Not implemented'
   end
 end
 
@@ -58,11 +45,11 @@ pre do |global, command, options, args|
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
-    cogfile = Cog.load_cogfile
-  if !cogfile && command && command.name != :project
+  cogfile = Cog::Cogfile.for_project
+  if !cogfile && command && command.name != :init
     puts 'No Cogfile could be found'
     false
-  elsif cogfile && command && command.name == :project
+  elsif cogfile && command && command.name == :init
     puts "A Cogfile already exists at #{cogfile.cogfile_path.inspect}"
     false
   else

data/lib/cog.rb

@@ -1,37 +1,14 @@
 require 'cog/cogfile'
-require 'cog/has_template'
+require 'cog/template_controller'
+require 'cog/mixins'
+require 'fileutils'
 
 module Cog
-  
-  # Loads the +Cogfile+ for the current project.
-  # 
-  # The +Cogfile+ will be looked for in the present working directory. If none
-  # is found there the parent directory will be checked, and then the
-  # grandparent, and so on.
-  # 
-  # === Returns
-  # An instance of Cogfile which has been configured with a Cogfile. Or +nil+ if
-  # no +Cogfile+ could be found.
-  def self.load_cogfile
-    parts = Dir.pwd.split File::SEPARATOR
-    i = parts.length
-    while i >= 0 && !File.exists?(File.join(parts.slice(0, i) + ['Cogfile']))
-      i -= 1
-    end
-    path = File.join(parts.slice(0, i) + ['Cogfile']) if i >= 0
-    if path
-      Cogfile.instance.instance_eval do
-        @cogfile_path = path
-        @project_root = File.dirname path
-      end
-      begin
-        b = Cogfile.instance.instance_eval {binding}
-        eval File.read(path), b
-      rescue Exception => e
-        raise CogfileError.new(e.to_s)
-      end
-      Cogfile.instance
-    end
+
+  # Make a cogfile at the given destination path.
+  def self.copy_default_cogfile(dest)
+    puts "Generated #{dest}"
+    FileUtils.cp Cogfile.default_cogfile_path, dest
   end
-  
+
 end

data/lib/cog/cogfile.rb

@@ -5,7 +5,55 @@ module Cog
   # When the +Cogfile+ is processed, +self+ will be the singleton instance of
   # this object.
   class Cogfile
-    include Singleton
+    
+    # Path to the master +Cogfile+.
+    def self.master_cogfile_path
+      File.join File.dirname($0), '../Master.cogfile'
+    end
+
+    # Path to the default +Cogfile+.
+    def self.default_cogfile_path
+      File.join File.dirname($0), '../templates/Default.cogfile'
+    end
+    
+    # Loads the default +Cogfile+ for the current project.
+    # 
+    # The +Cogfile+ will be looked for in the present working directory. If none
+    # is found there the parent directory will be checked, and then the
+    # grandparent, and so on.
+    # 
+    # === Returns
+    # An instance of Cogfile which has been configured with a +Cogfile+. If no
+    # such file was found then +nil+.
+    def self.for_project
+      return @for_project if @for_project
+      parts = Dir.pwd.split File::SEPARATOR
+      i = parts.length
+      while i >= 0 && !File.exists?(File.join(parts.slice(0, i) + ['Cogfile']))
+        i -= 1
+      end
+      path = File.join(parts.slice(0, i) + ['Cogfile']) if i >= 0
+      if path && File.exists?(path)
+        @for_project = self.new path
+      end
+    end
+
+    # Loads the master +Cogfile+.
+    def self.master
+      return @master if @master
+      @master = self.new master_cogfile_path
+    end
+
+    # Initialize from a +Cogfile+ at the given path.
+    def initialize(path)
+      @cogfile_path = File.expand_path path
+      @project_root = File.dirname @cogfile_path
+      begin
+        eval File.read(path), binding
+      rescue Exception => e
+        raise CogfileError.new(e.to_s)
+      end
+    end
 
     def get_or_set(name, val, &block) # :nodoc:
       if val.nil?
@@ -23,29 +71,33 @@ module Cog
     attr_reader :cogfile_path
     
     # The directory in which to find ERB template files. This is relative to
-    # project_root
+    # project_root unless the option <tt>:absolute</tt> is passed.
     # 
     # Can be used as a getter or a setter (within the +Cogfile+).
-    def template_dir(val=nil)
-      get_or_set :template_dir, val do |val|
-        File.join project_root, val
+    def template_dir(val=nil, opt={})
+      get_or_set(:template_dir, val) do |val|
+        if opt[:absolute]
+          val
+        else
+          File.join project_root, val
+        end
       end
     end
     
     # The directory in which application code can be found. This is where
     # generated code will go. Probably along side non-generated code. It is
-    # relative to project_root
+    # relative to project_root unless the option <tt>:absolute</tt> is passed.
     # 
     # Can be used as a getter or a setter (within the +Cogfile+).
-    def code_dir(val=nil)
-      get_or_set :code_dir, val do |val|
-        File.join project_root, val
+    def code_dir(val=nil, opt={})
+      get_or_set(:code_dir, val) do |val|
+        if opt[:absolute]
+          val
+        else
+          File.join project_root, val
+        end
       end
     end
-    
-    def to_s # :nodoc:
-      "#{project_root} #{code_dir}"
-    end
   end
 
   # For wrapping errors which occur during the processing of a +Cogfile+.

data/lib/cog/mixins.rb

@@ -0,0 +1,11 @@
+require 'cog/mixins/uses_templates'
+
+module Cog
+  
+  # Modules that extend your code generating classes with helper methods.
+  #
+  # * Mixins::UsesTemplates has methods for using +ERB+ template files
+  module Mixins
+  end
+  
+end

data/lib/cog/mixins/uses_templates.rb

@@ -0,0 +1,107 @@
+require 'cog/cogfile'
+require 'erb'
+
+module Cog
+  module Mixins
+    
+    # Mixin for classes that can use templates to generate code
+    module UsesTemplates
+    
+      # Use an alternate Cogfile
+      def using_cogfile(cogfile)
+        @cogfile = cogfile
+      end
+      
+      # Get the template with the given name.
+      #
+      # === Parameters
+      # * +path+ - a path to a template file which is relative to
+      #   Cogfile#template_dir and does not include the +.erb+ extension.
+      #
+      # === Returns
+      # An instance of ERB.
+      def get_template(path)
+        @cogfile ||= Cogfile.for_project
+        path = File.join @cogfile.template_dir, "#{path}.erb"
+        unless File.exists? path
+          raise MissingTemplate.new path
+        end
+        ERB.new File.read(path)
+      end
+    
+      # Stamp this object using the template at the given path.
+      #
+      # === Parameters
+      # * +path+ - the path to the template to use which is relative to
+      #   Cogfile#template_dir and does not include the +.erb+ extension.
+      # * +dest+ - the destination path to the generated file which is relative
+      #   to Cogfile#code_dir. If this is not provided, then the generated code
+      #   will be returned as a string.
+      #
+      # === Context
+      # All keys are added as instance variables to the context that is passed
+      # into the template.
+      #
+      # === Returns
+      # +nil+ if generated to a file, otherwise returns the generated code as a
+      # string.
+      def stamp(path, dest=nil, context={})
+        t = get_template path
+        context = TemplateContext.new self, context
+        b = context.instance_eval {binding}
+        if dest.nil?
+          t.result(b)
+        else
+          dest = File.join @cogfile.code_dir, dest
+          FileUtils.mkpath File.dirname(dest) unless File.exists? dest
+          scratch = "#{path}.scratch"
+          File.open(scratch, 'w') {|file| file.write t.result(b)}
+          unless same? dest, scratch
+            puts "Generated #{dest}"
+            FileUtils.mv scratch, dest
+          else
+            FileUtils.rm scratch
+          end
+          nil
+        end
+      end
+    
+    private
+      def same?(original, scratch) # :nodoc:
+        if File.exists? original
+          File.read(original) == File.read(scratch)
+        else
+          false
+        end
+      end
+      
+      class TemplateContext
+        def initialize(obj, context={})
+          @obj = obj
+          context.each do |key, value|
+            instance_variable_set "@#{key}", value
+          end
+        end
+        
+        def method_missing(meth, *args, &block)
+          if @obj.respond_to? meth
+            @obj.method(meth).call *args, &block
+          else
+            super
+          end
+        end
+      end
+    end
+    
+  end
+  
+  module Errors
+    # Indiciates an attempt to use a non-existant template.
+    class MissingTemplate < Exception
+      def message
+        'could not find the template ' + super
+      end
+    end
+  end
+  
+end

data/lib/cog/spec_helpers.rb

@@ -0,0 +1,29 @@
+require 'cog/spec_helpers/runner'
+require 'cog/spec_helpers/matchers'
+
+module Cog
+  
+  # Modules and classes to help write specs for testing +cog+
+  #
+  # === Example
+  # Requiring the helpers will make extra SpecHelpers::Matchers available to
+  # your RSpec tests. These are useful for testing a SpecHelpers::Invocation,
+  # which is returned from a call to SpecHelpers::App#run
+  #
+  #   require 'cog/spec_helpers'
+  # 
+  #   describe 'The command line interface' do
+  # 
+  #     before :all do
+  #       @cog = Cog::SpecHelpers::App.new 'bin/cog'
+  #     end
+  # 
+  #     it 'should print help when no args are passed' do
+  #       @cog.run.should show_help
+  #     end
+  # 
+  #   end
+  module SpecHelpers
+  end
+  
+end

data/lib/cog/spec_helpers/matchers.rb

@@ -0,0 +1,36 @@
+require 'rspec'
+
+module Cog
+  module SpecHelpers
+    
+    # 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.readlines.first
+            /help.*code gen/ =~ @first_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}"
+        end
+      end
+      
+      # The target Invocation should output the default help text
+      def show_help
+        ShowHelp.new
+      end
+    end
+    
+  end
+end
+
+RSpec.configure do |config|
+  config.include Cog::SpecHelpers::Matchers
+end

data/lib/cog/spec_helpers/runner.rb

@@ -0,0 +1,41 @@
+require 'open3'
+
+module Cog
+  module SpecHelpers
+
+    # Points to the +cog+ command-line app
+    class App
+
+      def initialize(path_to_cl_app)
+        @cog = path_to_cl_app
+      end
+
+      # Run cog with the given arguments
+      #
+      # === Returns
+      # 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
+      end
+    end
+    
+    # Represents a +cog+ command line invocation, which can be tested with
+    # +RSpec+ +should+ and +should_not+ custom Matchers
+    class Invocation
+      
+      def initialize(cmd) # :nodoc:
+        @cmd = cmd
+      end
+      
+      def exec(*args, &block) # :nodoc:
+        Open3.popen3 *@cmd do |i,o,e,t|
+          block.call i,o,e
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/cog/template_controller.rb

@@ -0,0 +1,16 @@
+require 'cog/mixins/uses_templates'
+require 'cog/cogfile'
+
+module Cog
+  
+  class TemplateController
+    
+    include Mixins::UsesTemplates
+    
+    def initialize(opt={})
+      using_cogfile Cogfile.master
+    end
+    
+  end
+  
+end

data/lib/cog_version.rb

@@ -1,3 +1,3 @@
 module Cog
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/templates/Default.cogfile

@@ -0,0 +1,8 @@
+# All paths are relative to the directory containing this file.
+
+# The directory in which to find ERB template files.
+template_dir 'templates'
+
+# The directory in which application code can be found. This is where
+# generated code will go. Probably along side non-generated code.
+code_dir 'src'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-12 00:00:00 Z
+date: 2012-05-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -54,9 +54,16 @@ extensions: []
 extra_rdoc_files: 
 - API.rdoc
 files: 
+- Master.cogfile
 - bin/cog
+- templates/Default.cogfile
 - lib/cog/cogfile.rb
-- lib/cog/has_template.rb
+- lib/cog/mixins/uses_templates.rb
+- lib/cog/mixins.rb
+- lib/cog/spec_helpers/matchers.rb
+- lib/cog/spec_helpers/runner.rb
+- lib/cog/spec_helpers.rb
+- lib/cog/template_controller.rb
 - lib/cog.rb
 - lib/cog_version.rb
 - API.rdoc

data/lib/cog/has_template.rb

@@ -1,59 +0,0 @@
-require 'erb'
-
-module Cog
-
-  # Mixin for classes that can use templates to generate code
-  module HasTemplate
-    
-    # Get the template with the given name.
-    #
-    # === Parameters
-    # * +path+ - a path to a template file which is relative to
-    #   Cogfile#template_dir and does not include the +.erb+ extension.
-    #
-    # === Returns
-    # An instance of ERB.
-    def get_template(path)
-      path = File.join Cogfile.instance.template_dir, "#{path}.erb"
-      unless File.exists? path
-        raise MissingTemplate.new path
-      end
-    end
-    
-    # Stamp this object using the template at the given path.
-    #
-    # === Parameters
-    # * +path+ - the path to the template to use which is relative to
-    #   Cogfile#template_dir and does not include the +.erb+ extension.
-    # * +dest+ - the destination path to the generated file which is relative
-    #   to Cogfile#code_dir. If this is not provided, then the generated code
-    #   will be returned as a string.
-    #
-    # === Returns
-    # +nil+ if generated to a file, otherwise returns the generated code as a
-    # string.
-    def stamp(path, dest=nil)
-      t = get_template path
-      scratch = "#{path}.scratch"
-      File.open(scratch, 'w') do |file|
-        file.write t.result(make_protected_binding)
-        # TODO: ...
-      end
-    end
-    
-  private
-    def same?(original, scratch) # :nodoc:
-      if File.exists? original
-        File.read(original) == File.read(scratch)
-      else
-        false
-      end
-    end
-  end
-
-  class MissingTemplate < Exception
-    def message
-      'could not find the template ' + super
-    end
-  end
-end