cog 0.0.1 → 0.0.2

data/API.rdoc

@@ -0,0 +1,25 @@
+= cog API docs
+
++cog+ is a command line utility that makes it a bit easier to organize a project
+which uses code generation. Many of your interactions with +cog+ will be using
+the command line interface. However, to get any real mileage out of it you'll
+need to use the API (documented here). For more information on the command line
+interface see https://github.com/ktonon/cog#cog
+
++cog+ is configured with a +Cogfile+, which should be in the root of your
+project's file tree. The +Cogfile+ is just a ruby file and the commands
+available in it are defined in the Cog::Cogfile class. It is generated for you
+when you issue this command from a shell in the root directory of your project:
+
+  cog project
+
+and it will look something like this:
+
+  # 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'

data/bin/cog

@@ -29,7 +29,18 @@ desc 'Add cog to a project by generating a Cogfile in the current directory'
 command :project do |c|
   c.action do |global_options, options, args|
     puts 'Created Cogfile'
-    FileUtils.touch '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
   end
 end
 
@@ -37,7 +48,7 @@ desc 'Create a new template'
 arg_name 'NAME'
 command :template do |c|
   c.action do |global_options, options, args|
-    # TODO: implement me
+    puts 'Not implemented'
   end
 end
 
@@ -47,12 +58,12 @@ 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
+    cogfile = Cog.load_cogfile
   if !cogfile && command && command.name != :project
     puts 'No Cogfile could be found'
     false
   elsif cogfile && command && command.name == :project
-    puts "A Cogfile already exists at #{cogfile.path.inspect}"
+    puts "A Cogfile already exists at #{cogfile.cogfile_path.inspect}"
     false
   else
     global[:cogfile] = cogfile

data/lib/cog.rb

@@ -1,23 +1,17 @@
-require 'cog/config'
+require 'cog/cogfile'
 require 'cog/has_template'
 
 module Cog
   
-  class CogfileError < StandardError
-    def message
-      "in Cogfile, " + super
-    end
-  end
-  
-  # Loads the +Cogfile+.
+  # 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 Config which has been configured using the +Cogfile+, if
-  # one was found, otherwise +nil+.
+  # An instance of Config 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
@@ -26,14 +20,17 @@ module Cog
     end
     path = File.join(parts.slice(0, i) + ['Cogfile']) if i >= 0
     if path
-      cogfile = Config.new path
+      Cogfile.instance.instance_eval do
+        @cogfile_path = path
+        @project_root = File.dirname path
+      end
       begin
-        b = cogfile.instance_eval {binding}
+        b = Cogfile.instance.instance_eval {binding}
         eval File.read(path), b
       rescue Exception => e
         raise CogfileError.new(e.to_s)
       end
-      cogfile
+      Cogfile.instance
     end
   end
   

data/lib/cog/cogfile.rb

@@ -0,0 +1,59 @@
+require 'cog/config'
+require 'singleton'
+
+module Cog
+  
+  # When the +Cogfile+ is processed, +self+ will be the singleton instance of
+  # this object.
+  class Cogfile
+    include Singleton
+
+    def get_or_set(name, val, &block) # :nodoc:
+      if val.nil?
+        instance_variable_get "@#{name}"
+      else
+        val = block.call val unless block.nil?
+        instance_variable_set "@#{name}", val
+      end
+    end
+    
+    # The directory in which the +Cogfile+ is found.
+    attr_reader :project_root
+    
+    # The path to the +Cogfile+.
+    attr_reader :cogfile_path
+    
+    # The directory in which to find ERB template files. This is relative to
+    # project_root
+    # 
+    # 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
+      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
+    # 
+    # 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
+      end
+    end
+    
+    def to_s # :nodoc:
+      "#{project_root} #{code_dir}"
+    end
+  end
+
+  # For wrapping errors which occur during the processing of a +Cogfile+.
+  class CogfileError < StandardError
+    def message
+      "in Cogfile, " + super
+    end
+  end
+    
+end

data/lib/cog/has_template.rb

@@ -1,12 +1,44 @@
+require 'erb'
+
 module Cog
 
   # Mixin for classes that can use templates to generate code
   module HasTemplate
     
-    def cog(template_name)
-      
+    # 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
+    #   Config#template_dir and does not include the +.erb+ extension.
+    # * +dest+ - the destination path to the generated file which is relative
+    #   to Config#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)
+    end
   end
 
+  class MissingTemplate < Exception
+    def message
+      'could not find the template ' + super
+    end
+  end
 end

data/lib/cog_version.rb

@@ -1,3 +1,3 @@
 module Cog
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -52,14 +52,14 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- cog.rdoc
+- API.rdoc
 files: 
 - bin/cog
-- lib/cog/config.rb
+- lib/cog/cogfile.rb
 - lib/cog/has_template.rb
 - lib/cog.rb
 - lib/cog_version.rb
-- cog.rdoc
+- API.rdoc
 homepage: https://github.com/ktonon/cog
 licenses: []
 

data/cog.rdoc

@@ -1,3 +0,0 @@
-= cog
-
-This is the API documentation.

data/lib/cog/config.rb

@@ -1,19 +0,0 @@
-module Cog
-  
-  # When the Cogfile is processed, +self+ will be set to an instance of this
-  # object at the global context.
-  class Config
-    attr_reader :path
-    
-    # Create an empty config object
-    #
-    # === Arguments
-    # * +path+ - The path to the +Cogfile+ which will be used to configure
-    #   this object.
-    def initialize(path)
-      @path = path
-    end
-
-  end
-  
-end