cog 0.0.8 → 0.0.9

data/API.rdoc

@@ -16,13 +16,15 @@ when you issue this command from a shell in the root directory of your 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'
+
+  # 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'
+
+  # The default language in which to generate source code.
+  language 'c++'
 
 == Testing
 

data/Default.cogfile

@@ -5,3 +5,6 @@ cog_dir 'cog'
 
 # The directory in which to place generated application code.
 app_dir 'src'
+
+# The default language in which to generate source code.
+language 'c++'

data/bin/cog

@@ -12,12 +12,13 @@ unless File.respond_to? :realpath
 end
 $: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
 require 'rubygems'
+require 'active_support/core_ext'
 require 'cog'
 require 'cog_version'
 require 'gli'
 require 'fileutils'
 
-include GLI
+include GLI::App
 
 program_desc 'This is a utility to help you write code generators.'
 
@@ -34,26 +35,24 @@ command :init do |c|
   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 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,opt,a|
+#     a.each do |class_name|
+#       mirror_gen = Cog::Meta::MirrorGen.new class_name
+#       mirror_gen.stamp opt
+#     end
+#   end
+# end
 
 desc 'List supported languages'
 command :languages do |c|
@@ -93,4 +92,4 @@ on_error do |exception|
   true
 end
 
-exit GLI.run(ARGV)
+exit run(ARGV)

data/lib/cog.rb

@@ -1,5 +1,5 @@
 require 'cog/config'
-require 'cog/template_controller'
+require 'cog/meta'
 require 'cog/mixins'
 
 module Cog

data/lib/cog/cogfile.rb

@@ -0,0 +1,65 @@
+module Cog
+
+  # In your project's +Cogfile+, +self+ has been set to an instance of this class.
+  #
+  # ==== Example +Cogfile+
+  #   cog_dir 'cog'
+  #   app_dir 'src'
+  #   language 'c++'
+  #
+  # Typing `cog init` will create a +Cogfile+ in the present working directory.
+  #
+  # +Cogfile+ files are used to configure an instance of Config.
+  class Cogfile
+    
+    def initialize(config) # :nodoc:
+      @config = config
+    end
+    
+    # Interpret the Cogfile and initialize @config
+    def interpret # :nodoc:
+      eval File.read(@config.cogfile_path), binding
+    rescue Exception => e
+      raise CogfileError.new(e.to_s)
+    end
+    
+    # Define the directory in which to place Ruby generators and +ERB+ templates.
+    # ==== Arguments
+    # * +path+ - A file system path
+    # * +absolute+ - If false, the path is relative to the directory containing the +Cogfile+
+    def cog_dir(path, absolute=false)
+      @config.instance_eval do
+        @cog_dir = absolute ? path : File.join(project_root, path)
+        @generator_dir = File.join @cog_dir, 'generators'
+        @template_dir = File.join @cog_dir, 'templates'
+      end
+    end
+
+    # Define the directory in which to place generated application source code.
+    # ==== Arguments
+    # * +path+ - A file system path
+    # * +absolute+ - If false, the path is relative to the directory containing the +Cogfile+
+    def app_dir(path, absolute=false)
+      @config.instance_eval do
+        @app_dir = absolute ? path : File.join(project_root, path)
+      end
+    end
+
+    # Define the default language in which to generated application source code.
+    # ==== Arguments
+    # * +lang+ - A code for the language. Acceptable values are <tt>c++</tt>.
+    def language(lang)
+      @config.instance_eval do
+        @language = lang
+      end
+    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/config.rb

@@ -1,25 +1,50 @@
 require 'rubygems'
 require 'singleton'
+require 'cog/cogfile'
 
 module Cog
   
-  # When the +Cogfile+ is processed, +self+ will be the singleton instance of
-  # this object.
+  # This interface is intended for use within generators. Instances of this type
+  # are initialized via Cogfile files.
   class Config
+        
+    # Directory to which application source code is generated.
+    attr_reader :app_dir
+
+    # Path to the +Cogfile+.
+    attr_reader :cogfile_path
+
+    # Directory in which to find Ruby source files. These are files which
+    # control exactly how the code is going to be generated.
+    attr_reader :generator_dir
+
+    # Default language in which to generated application source code.
+    attr_reader :language
     
-    # The directory in which the +Cogfile+ is found.
+    # Directory in which the +Cogfile+ is found.
     attr_reader :project_root
     
-    # The path to the +Cogfile+.
-    attr_reader :cogfile_path
+    # Directory in which to find ERB template files.
+    attr_reader :template_dir
     
-    # Loads the default +Cogfile+ for the current project.
-    # 
+    # Initialize from a +Cogfile+ at the given path.
+    # ==== Arguments
+    # * +path+ - A file system path to a +Cogfile+. The file must exists.
+    def initialize(path)
+      @cogfile_path = File.expand_path path
+      @project_root = File.dirname @cogfile_path
+      cogfile = Cogfile.new self
+      cogfile.interpret
+    end
+
+    # The default configuration for the project.
+    #
+    # Initialized using 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
+    # ==== Returns
     # An instance of Cogfile which has been configured with a +Cogfile+. If no
     # such file was found then +nil+.
     def self.for_project
@@ -35,78 +60,18 @@ module Cog
       end
     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
-
-    # 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 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 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
-    
-    # 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
+    # Location of the installed cog gem
+    def self.gem_dir # :nodoc:
       spec = Gem.loaded_specs['cog']
       if spec.nil?
-        File.expand_path File.join(File.dirname($0), '..')
+        # The current __FILE__ is:
+        #   ${COG_GEM_ROOT}/lib/cog/config.rb
+        File.expand_path File.join(File.dirname(__FILE__), '..', '..')
       else
         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+.
-  class CogfileError < StandardError
-    def message
-      "in Cogfile, " + super
-    end
-  end
     
+  end
+  
 end

data/lib/cog/meta.rb

@@ -0,0 +1,9 @@
+require 'cog/meta/mirror_gen'
+
+module Cog
+  
+  # Used by cog internals.
+  module Meta
+  end
+  
+end

data/lib/cog/meta/gen_gen.rb

@@ -0,0 +1,85 @@
+require 'cog/mixins/uses_templates'
+require 'cog/config'
+
+module Cog
+  module Meta
+  
+    # An abstract generator generator.
+    #
+    # Subclasses define generators which make other generators.
+    class GenGen
+    
+      include Mixins::UsesTemplates
+
+      # 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+
+      # * <tt>:binding</tt> - specify an alternate binding to use when resolving
+      #   the +ERB+ template. If none is provided +self.binding+ will be used.
+      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,
+          :binding => opt[:binding]
+      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+
+      # * <tt>:binding</tt> - specify an alternate binding to use when resolving
+      #   the +ERB+ template. If none is provided +self.binding+ will be used.
+      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,
+            :binding => opt[:binding]
+        end
+      end
+    
+    private
+      def extensions_for_language(lang)
+        case lang.to_s
+        when /(cpp|c\+\+)/i
+          [:h, :cpp]
+        else
+          []
+        end
+      end
+    end
+    
+  end
+end

data/lib/cog/meta/mirror_gen.rb

@@ -0,0 +1,39 @@
+require 'cog/meta/gen_gen'
+
+module Cog
+  module Meta
+    
+    # Generates a Cog::Mixins::Mirror and associated templates.
+    class MirrorGen
+      
+      # Create a mirror generator
+      #
+      # === Parameters
+      # * +name+ - the name of the mirror. Will be forced to singular form.
+      def initialize(name, opt={})
+        @name = name.singularize
+        @gg = GenGen.new
+      end
+      
+      def filename
+        @name.underscore
+      end
+      
+      def classname
+        @name.camelize
+      end
+      
+      def abstract_classname
+        "Cog#{@name.camelize}"
+      end
+      
+      def stamp(opt={})
+        opt[:binding] = binding
+        @gg.stamp_generator 'mirror', filename, opt
+        @gg.stamp_module 'mirror-abstract', "abstract_#{filename}", opt
+        @gg.stamp_module 'mirror-impl', filename, opt
+      end
+    end
+      
+  end
+end

data/lib/cog/mixins/uses_templates.rb

@@ -7,6 +7,18 @@ module Cog
     # Mixin for classes that can use templates to generate code
     module UsesTemplates
       
+      # 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
+      
       # Get the template with the given name.
       #
       # === Parameters
@@ -21,11 +33,16 @@ module Cog
       # An instance of ERB.
       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)
+        prefix = if opt[:cog_template]
+          File.join Config.gem_dir, 'templates'
+        elsif !opt[:absolute]
+          Config.for_project.template_dir
+        end
+        path = File.join prefix, path unless prefix.nil?
+        raise Errors::MissingTemplate.new path unless File.exists? path
+        ERB.new File.read(path), 0, '>'
       end
-    
+      
       # Stamp this object using the template at the given path.
       #
       # === Parameters
@@ -78,7 +95,39 @@ module Cog
           nil
         end
       end
-    
+      
+      # A warning that indicates a file is maintained by a generator
+      def generated_warning
+        lang = Config.for_project.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.for_project.language
+        when /c\+\+/
+          "namespace #{name} {"
+        end
+      end
+
+      def namespace_end(name)
+        return if name.nil?
+        case Config.for_project.language
+        when /c\+\+/
+          "} // namespace #{name}"
+        end
+      end
+      
     private
       def same?(original, scratch) # :nodoc:
         if File.exists? original

data/lib/cog/spec_helpers/matchers.rb

@@ -10,8 +10,9 @@ module Cog
         def matches?(runner)
           @runner = runner
           @runner.exec do |i,o,e|
-            @first_line = o.readlines.first
-            /help.*code gen/ =~ @first_line
+            @first_line = o.readline
+            @second_line = o.readline
+            /help.*code gen/ =~ @second_line
           end
         end
         def failure_message

data/lib/cog_version.rb

@@ -1,3 +1,3 @@
 module Cog
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/templates/c++/mirror-abstract.h.erb

@@ -0,0 +1,6 @@
+<%= @gg.generated_warning %>
+
+class <%= abstract_classname %>
+{
+
+};

data/templates/c++/mirror-impl.cpp.erb

@@ -0,0 +1 @@
+class

data/templates/mirror.rb.erb

@@ -0,0 +1,10 @@
+class <%= classname %>
+  include Cog::Mixins::Mirror
+  
+  # Attributes
+  string :name, :access => :r # Read-only string attribute
+  int :age # Read-write integer attribute
+  
+  # Methods
+  meth :speak
+end

data/templates/snippets/c++/generated_warning.h.erb

@@ -0,0 +1,9 @@
+/* --------------------------------------------------------------------------
+   WARNING
+
+   This is a generated file. DO NOT EDIT THIS FILE! Your changes will be lost
+   the next time this file is regenerated.
+   
+   This file was generating using cog
+   https://github.com/ktonon/cog
+   -------------------------------------------------------------------------- */

data/templates/snippets/generated_warning.txt

@@ -0,0 +1,7 @@
+WARNING
+
+This is a generated file. DO NOT EDIT THIS FILE! Your changes will be lost
+the next time this file is regenerated.
+
+This file was generating using cog
+https://github.com/ktonon/cog

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-15 00:00:00 Z
+date: 2012-10-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -61,14 +61,19 @@ files:
 - templates/c++/mirror-impl.cpp.erb
 - templates/c++/mirror-impl.h.erb
 - templates/mirror.rb.erb
+- templates/snippets/c++/generated_warning.h.erb
+- templates/snippets/generated_warning.txt
+- lib/cog/cogfile.rb
 - lib/cog/config.rb
+- lib/cog/meta/gen_gen.rb
+- lib/cog/meta/mirror_gen.rb
+- lib/cog/meta.rb
 - lib/cog/mixins/mirror.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
@@ -106,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: This is a utility to help you write code generators.

data/lib/cog/template_controller.rb

@@ -1,74 +0,0 @@
-require 'cog/mixins/uses_templates'
-require 'cog/config'
-
-module Cog
-  
-  class TemplateController
-    
-    include Mixins::UsesTemplates
-
-    # 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