cog 0.0.10 → 0.0.11

data/templates/cog/tool/generator.rb.erb

@@ -0,0 +1,5 @@
+require '<%= @name %>'
+
+<%= @module_name %>.define do |definition|
+
+end

data/templates/cog/tool/tool.gemspec.erb

@@ -0,0 +1,18 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','<%= @name %>/version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = '<%= @name %>'
+  s.version = <%= @module_name %>::VERSION
+  s.author = '<%= @author %>'
+  s.email = '<%= @email %>'
+  s.homepage = ''
+  s.platform = Gem::Platform::RUBY
+  s.summary = '<%= @description %>'
+  s.files = %w(LICENSE) + Dir.glob('cog/**/*') + Dir.glob('lib/**/*.rb')
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['API.rdoc']
+  s.rdoc_options << '--title' << '<%= @name %>' << '-ri'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+end

data/templates/cog/tool/tool.rb.erb

@@ -0,0 +1,4 @@
+require '<%= @name %>/version'
+
+module <%= @module_name %> 
+end

data/templates/cog/tool/version.rb.erb

@@ -0,0 +1,5 @@
+module <%= @module_name %> 
+  unless const_defined? :VERSION
+    VERSION = '0.0.1' # :nodoc:
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-27 00:00:00 Z
+date: 2012-11-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -57,26 +57,28 @@ files:
 - bin/cog
 - Default.cogfile
 - LICENSE
-- 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
-- templates/snippets/c++/generated_warning.h.erb
-- templates/snippets/generated_warning.txt
-- lib/cog/cogfile.rb
+- templates/cog/snippets/c++/generated_warning.h.erb
+- templates/cog/snippets/generated_warning.txt
+- templates/cog/tool/API.rdoc.erb
+- templates/cog/tool/Gemfile.erb
+- templates/cog/tool/generator.rb.erb
+- templates/cog/tool/LICENSE.erb
+- templates/cog/tool/Rakefile.erb
+- templates/cog/tool/README.markdown.erb
+- templates/cog/tool/tool.gemspec.erb
+- templates/cog/tool/tool.rb.erb
+- templates/cog/tool/version.rb.erb
+- lib/cog/config/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/errors.rb
+- lib/cog/generator.rb
+- lib/cog/spec_helpers/matchers/match_maker.rb
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb
 - lib/cog/spec_helpers.rb
+- lib/cog/tool.rb
+- lib/cog/version.rb
 - lib/cog.rb
-- lib/cog_version.rb
 - API.rdoc
 homepage: https://github.com/ktonon/cog
 licenses: []

data/lib/cog/cogfile.rb

@@ -1,65 +0,0 @@
-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/meta.rb

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

data/lib/cog/meta/gen_gen.rb

@@ -1,85 +0,0 @@
-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

@@ -1,39 +0,0 @@
-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.rb

@@ -1,13 +0,0 @@
-require 'cog/mixins/uses_templates'
-
-module Cog
-  
-  # Modules that extend your code generating classes with helper methods.
-  #
-  # * Mixins::UsesTemplates - methods for using +ERB+ template files.
-  # * Mixins::Mirror - code the interface in Ruby and implement in the target
-  #   langauge.
-  module Mixins
-  end
-  
-end

data/lib/cog/mixins/mirror.rb

@@ -1,61 +0,0 @@
-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,152 +0,0 @@
-require 'cog/config'
-require 'erb'
-
-module Cog
-  module Mixins
-    
-    # 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
-      # * +path+ - a path to a template file which is relative to
-      #   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, opt={})
-        path += '.erb'
-        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
-      # * +path+ - to the template which is relative to Config#template_dir and 
-      #   does not include the +.erb+ extension.
-      #
-      # === 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, opt={})
-        t = get_template path, :absolute => opt[:use_absolute_path]
-        b = opt[:binding] || binding
-        target = opt[:target]
-        if target.nil?
-          t.result(b)
-        else
-          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 = case target_type.to_s
-          when /cog/i
-            File.join Config.for_project.cog_dir, "#{opt[:target]}.scratch"
-          when /app/i
-            File.join Config.for_project.app_dir, "#{opt[:target]}.scratch"
-          end
-          File.open(scratch, 'w') {|file| file.write t.result(b)}
-          unless same? target, scratch
-            puts "Generated #{target}"
-            FileUtils.mv scratch, target
-          else
-            FileUtils.rm scratch
-          end
-          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
-          File.read(original) == File.read(scratch)
-        else
-          false
-        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