cog 0.0.6 → 0.0.7

data/Default.cogfile

@@ -0,0 +1,7 @@
+# All paths are relative to the directory containing this file.
+
+# The directory in which to place Ruby generators and +ERB+ templates.
+cog_dir 'cog'
+
+# The directory in which to place generated application code.
+app_dir 'src'

data/bin/cog

@@ -12,9 +12,10 @@ unless File.respond_to? :realpath
 end
 $: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
 require 'rubygems'
-require 'gli'
-require 'cog_version'
 require 'cog'
+require 'cog_version'
+require 'gli'
+require 'fileutils'
 
 include GLI
 
@@ -27,15 +28,37 @@ switch [:v,:verbose]
 
 desc 'Add cog to a project by generating a Cogfile in the current directory'
 command :init do |c|
-  c.action do |global_options, options, args|
-    Cog.copy_default_cogfile 'Cogfile'
+  c.action do |g,o,a|
+    puts "Generated Cogfile"
+    FileUtils.cp File.join(Cog::Config.gem_dir, 'Default.cogfile'), 'Cogfile'
+  end
+end
+
+desc 'Create a new mirror class'
+arg_name 'ClassName'
+command :mirror do |c|
+  c.desc 'The target language (see languages command)'
+  c.arg_name 'language'
+  c.flag [:language, :l]
+  
+  c.desc 'Slash (/) separated prefix for generator, templates, and app code'
+  c.arg_name 'path'
+  c.flag [:package, :p]
+
+  c.action do |g,o,a|
+    tc = Cog::TemplateController.new
+    a.each do |class_name|
+      tc.stamp_generator 'mirror', class_name, o
+      tc.stamp_module 'mirror-abstract', "abstract_#{class_name}", o
+      tc.stamp_module 'mirror-impl', class_name, o
+    end
   end
 end
 
-desc 'Create a new template'
-arg_name 'NAME'
-command :template do |c|
-  c.action do |global_options, options, args|
+desc 'List supported languages'
+command :languages do |c|
+  c.action do |g,o,a|
+    puts 'c++'
   end
 end
 
@@ -45,7 +68,7 @@ pre do |global, command, options, args|
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
-  cogfile = Cog::Cogfile.for_project
+  cogfile = Cog::Config.for_project
   if !cogfile && command && command.name != :init
     puts 'No Cogfile could be found'
     false

data/lib/cog.rb

@@ -1,14 +1,6 @@
-require 'cog/cogfile'
+require 'cog/config'
 require 'cog/template_controller'
 require 'cog/mixins'
-require 'fileutils'
 
 module Cog
-
-  # 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 → config.rb}

@@ -5,17 +5,13 @@ module Cog
   
   # When the +Cogfile+ is processed, +self+ will be the singleton instance of
   # this object.
-  class Cogfile
+  class Config
     
-    # Path to the master +Cogfile+.
-    def self.master_cogfile_path
-      File.join gem_dir, 'Master.cogfile'
-    end
-
-    # Path to the default +Cogfile+.
-    def self.default_cogfile_path
-      File.join gem_dir, 'templates/Default.cogfile'
-    end
+    # The directory in which the +Cogfile+ is found.
+    attr_reader :project_root
+    
+    # The path to the +Cogfile+.
+    attr_reader :cogfile_path
     
     # Loads the default +Cogfile+ for the current project.
     # 
@@ -39,12 +35,6 @@ module Cog
       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
@@ -56,51 +46,42 @@ module Cog
       end
     end
 
-    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
+    # The directory in which to place Ruby generators and +ERB+ templates.
+    #
+    # Can be used as a getter, or a setter within the +Cogfile+. As a setter,
+    # +val+ is relative to project_root unless the option <tt>:absolute</tt>
+    # is truthy.
+    def cog_dir(val=nil, opt={})
+      get_or_set :cog_dir, val, opt
     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 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, opt={})
-      get_or_set(:template_dir, val) do |val|
-        if opt[:absolute]
-          val
-        else
-          File.join project_root, val
-        end
-      end
+    # The directory in which to place generated application code.
+    #
+    # Can be used as a getter, or a setter within the +Cogfile+. As a setter,
+    # +val+ is relative to project_root unless the option <tt>:absolute</tt>
+    # is truthy.
+    def app_dir(val=nil, opt={})
+      get_or_set :app_dir, val, opt
     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 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, opt={})
-      get_or_set(:code_dir, val) do |val|
-        if opt[:absolute]
-          val
-        else
-          File.join project_root, val
-        end
-      end
+    # The path to the routes file which maps defines how generators map to
+    # generated application code.
+    def routes_path
+      File.join cog_dir, 'routes.rb'
+    end
+
+    # The directory in which to find Ruby source files. These are files which
+    # control exactly how the code is going to be generated.
+    def generator_dir(val=nil, opt={})
+      File.join cog_dir, 'generators'
     end
     
-  private
+    # The directory in which to find ERB template files.
+    def template_dir(val=nil, opt={})
+      File.join cog_dir, 'templates'
+    end
+
+    # Location of the installed gem
     def self.gem_dir
       spec = Gem.loaded_specs['cog']
       if spec.nil?
@@ -109,6 +90,16 @@ module Cog
         spec.gem_dir
       end
     end
+
+  private
+    def get_or_set(name, val, opt={}, &block)
+      if val.nil?
+        instance_variable_get "@#{name}"
+      else
+        val = File.join project_root, val unless opt[:absolute]
+        instance_variable_set "@#{name}", val
+      end
+    end
   end
 
   # For wrapping errors which occur during the processing of a +Cogfile+.

data/lib/cog/mixins.rb

@@ -4,7 +4,9 @@ module Cog
   
   # Modules that extend your code generating classes with helper methods.
   #
-  # * Mixins::UsesTemplates has methods for using +ERB+ template files
+  # * Mixins::UsesTemplates - methods for using +ERB+ template files.
+  # * Mixins::Mirror - code the interface in Ruby and implement in the target
+  #   langauge.
   module Mixins
   end
   

data/lib/cog/mixins/mirror.rb

@@ -0,0 +1,61 @@
+require 'cog/mixins/uses_templates'
+module Cog
+  module Mixins
+
+    # Code the interface in Ruby and implement in the target langauge.
+    #
+    # <b>Not implemented</b>
+    #
+    # === Example
+    # 
+    # In Ruby
+    #   class Dog
+    #     include Cog::Mixins::Mirror
+    #
+    #     cog_reader :name, Cog::Type.string
+    #     cog_accessor :age, Cog::Type.int
+    #
+    #     meth :speak
+    #   end
+    # 
+    # In C++
+    #   class CogDog
+    #   {
+    #   protected:
+    #       char* _name;
+    #       int _age;
+    #   public:
+    #       AbstractDog();
+    #       virtual ~AbstractDog();
+    #
+    #       virtual const char* name() const { return _name; }
+    #
+    #       virtual int age() const { return _age; }
+    #       virtual void setAge(int age) { _age = age; }
+    #
+    #       virtual void speak() = 0;
+    #   };
+    #
+    #   class Dog : public CogDog
+    #   {
+    #   public:
+    #       Dog();
+    #       virtual ~Dog();
+    #   
+    #       virtual void speak();
+    #   };
+    #
+    # The abstract class +CogDog+ will be regenerated whenever the source Ruby
+    # specification is changed. The derived C++ class +Dog+ will only be
+    # generated once. The C++ compiler will let you know if any abstract methods
+    # are missing from +Dog+ when you try to instantiate it.
+    module Mirror
+      def self.included(base)
+        base.include UsesTemplates
+      end
+      
+      
+    end
+    
+  end
+end

data/lib/cog/mixins/uses_templates.rb

@@ -1,4 +1,4 @@
-require 'cog/cogfile'
+require 'cog/config'
 require 'erb'
 
 module Cog
@@ -6,59 +6,67 @@ module Cog
     
     # 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.
+      #   Config#template_dir and does not include the +.erb+ extension.
+      #
+      # === Options
+      # * <tt>:absolute</tt> - set to +true+ to indicate that path is absolute
+      #   and should not be prefixed. Default value is +false+.
       #
       # === 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
+      def get_template(path, opt={})
+        path += '.erb'
+        path = File.join Config.for_project.template_dir, path unless opt[:absolute]
+        raise MissingTemplate.new path unless File.exists? path
         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.
+      # * +path+ - to the template which is relative to Config#template_dir and 
+      #   does not include the +.erb+ extension.
       #
-      # === Context
-      # All keys are added as instance variables to the context that is passed
-      # into the template.
+      # === Options
+      # * <tt>:target</tt> - the destination path to the generated file which is
+      #   relative to either Config#app_dir or Config#cog_dir, depending on the
+      #   value of the <tt>:target_type</tt> option.
+      # * <tt>:target_type</tt> - either <tt>:cog</tt> or <tt>:app</tt>.
+      #   Determines what path to prefix to the <tt>:target</tt> option. The
+      #   default value is <tt>:app</tt>
+      # * <tt>:use_absolute_path</tt> - set to +true+ to indicate that path is
+      #   absolute and should not be prefixed. Default value is +false+.
+      # * <tt>:binding</tt> - specify an alternate binding to use when resolving
+      #   the +ERB+ template. If none is provided +self.binding+ will be used.
       #
       # === 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?
+      def stamp(path, opt={})
+        t = get_template path, :absolute => opt[:use_absolute_path]
+        b = opt[:binding] || binding
+        target = opt[:target]
+        if target.nil?
           t.result(b)
         else
-          dest = File.join @cogfile.code_dir, dest
-          FileUtils.mkpath File.dirname(dest) unless File.exists? dest
+          target_type = opt[:target_type] || :app
+          target = case target_type.to_s
+          when /cog/i
+            File.join Config.for_project.cog_dir, target
+          when /app/i
+            File.join Config.for_project.app_dir, target
+          end
+          FileUtils.mkpath File.dirname(target) unless File.exists? target
           scratch = "#{path}.scratch"
           File.open(scratch, 'w') {|file| file.write t.result(b)}
-          unless same? dest, scratch
-            puts "Generated #{dest}"
-            FileUtils.mv scratch, dest
+          unless same? target, scratch
+            puts "Generated #{target}"
+            FileUtils.mv scratch, target
           else
             FileUtils.rm scratch
           end
@@ -74,23 +82,6 @@ module Cog
           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

data/lib/cog/template_controller.rb

@@ -1,16 +1,74 @@
 require 'cog/mixins/uses_templates'
-require 'cog/cogfile'
+require 'cog/config'
 
 module Cog
   
   class TemplateController
     
     include Mixins::UsesTemplates
-    
-    def initialize(opt={})
-      using_cogfile Cogfile.master
+
+    # Create a ruby generator from a template.
+    #
+    # === Parameters
+    # * +ruby_template+ - name of the ruby template. This is a template
+    #   which is distributed in the cog gem. It is relative to
+    #   <tt>templates/</tt>
+    # * +generator_name+ - name of the generator
+    #
+    # === Options
+    # * <tt>:language</tt> - only <tt>'c++'</tt> is accepted at this time
+    # * <tt>:package</tt> - slash (/) separated path which will prefix
+    #   +generator_name+
+    def stamp_generator(ruby_template, generator_name, opt={})
+      template = File.join Config.gem_dir, 'templates', "#{ruby_template}.rb"
+      target = "#{generator_name}.rb"
+      target = File.join opt[:package], target if opt[:package]
+      target = File.join 'generators', target
+      stamp template,
+        :target => target,
+        :target_type => :cog,
+        :use_absolute_path => true
+    end
+
+    # Create an app module template from a template.
+    #
+    # === Parameters
+    # * +source_template+ - name of the source template. This is a template
+    #   which is distributed in the cog gem. It is relative to
+    #   <tt>templates/{language}/</tt>, where language is specified by the
+    #   <tt>:language</tt> option. Do not include any file extension such as
+    #   <tt>.h</tt> (the <tt>:language</tt> will also determine this)
+    # * +module_name+ - name of the module. For languages like <tt>:c++</tt>,
+    #   two templates will be generated (i.e. one <tt>.h</tt> and one
+    #   <tt>.cpp</tt>)
+    #
+    # === Options
+    # * <tt>:language</tt> - only <tt>'c++'</tt> is accepted at this time
+    # * <tt>:package</tt> - slash (/) separated path which will prefix
+    #   +module_name+
+    def stamp_module(source_template, module_name, opt={})
+      lang = opt[:language] || 'c++'
+      extensions_for_language(lang).each do |ext|
+        template = File.join Config.gem_dir, 'templates', lang, "#{source_template}.#{ext}"
+        target = "#{module_name}.#{ext}"
+        target = File.join opt[:package], target if opt[:package]
+        target = File.join 'templates', target
+        stamp template,
+          :target => target,
+          :target_type => :cog,
+          :use_absolute_path => true
+      end
     end
     
+  private
+    def extensions_for_language(lang)
+      case lang.to_s
+      when /(cpp|c\+\+)/i
+        [:h, :cpp]
+      else
+        []
+      end
+    end
   end
   
 end

data/lib/cog_version.rb

@@ -1,3 +1,3 @@
 module Cog
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-13 00:00:00 Z
+date: 2012-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -55,9 +55,14 @@ extra_rdoc_files:
 - API.rdoc
 files: 
 - bin/cog
-- Master.cogfile
-- templates/Default.cogfile
-- lib/cog/cogfile.rb
+- Default.cogfile
+- templates/c++/mirror-abstract.cpp.erb
+- templates/c++/mirror-abstract.h.erb
+- templates/c++/mirror-impl.cpp.erb
+- templates/c++/mirror-impl.h.erb
+- templates/mirror.rb.erb
+- lib/cog/config.rb
+- lib/cog/mixins/mirror.rb
 - lib/cog/mixins/uses_templates.rb
 - lib/cog/mixins.rb
 - lib/cog/spec_helpers/matchers.rb

data/Master.cogfile

@@ -1,10 +0,0 @@
-# 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/templates/Default.cogfile

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