cog 0.3.1 → 0.3.2

data/lib/cog/native_extensions/array.rb

@@ -1,6 +1,6 @@
-# @api developer
 class Array
   
+  # @api developer
   # Iterate through each path in this array
   # @yieldparam source [String] readable label for the source. In the case of plugins, the plugin name
   # @yieldparam source_type [Symbol] one of :built_in, :user, :plugin, or :project

data/lib/cog/native_extensions/string.rb

@@ -1,6 +1,6 @@
-# @api developer
 class String
   
+  # @api developer
   # @return [String] strips {Cog::Config::ProjectConfig#project_root} from the beginning of this string
   def relative_to_project_root
     if Cog.show_fullpaths?
@@ -10,6 +10,7 @@ class String
     end
   end
   
+  # @api developer
   # @param prefix [String] path prefix to strip from the beginning of this string
   # @return [String] this string as a file system path relative to the +prefix+
   def relative_to(prefix)
@@ -20,6 +21,7 @@ class String
     end
   end
 
+  # @api developer
   # @return [Cog::Plugin,nil] if this string can be interpretted as a path relative to one of the registered cog plugins, return that plugin, otherwise return +nil+
   def relative_to_which_plugin?
     Cog.plugins.each do |plugin|
@@ -28,6 +30,7 @@ class String
     nil
   end
   
+  # @api developer
   # @param ext [String] file extension to remove from the end of this string
   # @return [String] a copy of this string with the given extension removed. Does nothing if this string does not edit with the extension
   def without_extension(ext)
@@ -37,6 +40,7 @@ class String
     end_with?(ext) ? slice(0..(-ext.length - 1)) : dup
   end
 
+  # @api developer
   # @return [String, String] source and type, where type is one of <tt>:project</tt>, <tt>:user</tt>, <tt>:built_in</tt>, <tt>:gem</tt>, or <tt>:unknown</tt>
   def cog_source_and_type
     if start_with?(Cog.project_root) || start_with?(Cog.project_template_path) || start_with?(Cog.project_generator_path) || start_with?(Cog.project_plugin_path)

data/lib/cog/primitive.rb

@@ -0,0 +1,111 @@
+class Symbol
+  # @return [String] assuming this symbol represents a cog primitive type, returns an identifier of the mapped primitive in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  # @example
+  #   # For Objective-C
+  #   :boolean.to_prim # => 'BOOL'
+  #
+  #   # For Java
+  #   :boolean.to_prim # => 'boolean'
+  #
+  #   # For C#
+  #   :boolean.to_prim # => 'bool'
+  def to_prim
+    Cog.active_language.to_prim(self)
+  end
+end
+
+# Helpers for {Bignum} and {Fixnum}
+module Cognum
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  def to_lit
+    Cog.active_language.to_integer(self) || Cog.active_language.to_long(self)
+  end
+
+  # @param bits [Fixnum] the size of a signed integer
+  # @return [Boolean] whether or not this number can fit in a singed integer of the given size in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  def signed?(bits)
+    limit = 2 ** (bits - 1)
+    self >= -limit && self < limit
+  end
+end
+
+class Bignum
+  include Cognum
+end
+
+class Fixnum
+  include Cognum
+end
+
+class Float
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  def to_lit
+    Cog.active_language.to_float(self) || Cog.active_language.to_double(self)
+  end
+end
+
+class String
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  # @example
+  #   # For Objective-C
+  #   "my cat walks over the keyboard".to_lit # => '@"my cat walks over the keyboard"'
+  #
+  #   # For Java
+  #   "my cat walks over the keyboard".to_lit # => '"my cat walks over the keyboard"'
+  def to_lit
+    Cog.active_language.to_char(self) || Cog.active_language.to_string(self)
+  end
+  
+  # @return [String] a safe identifier name in the {Cog::Config::LanguageConfig#active_language Cog.active_language} so as not to conflict with any {Cog::DSL::LanguageDSL#reserved reserved words}
+  # @example
+  #   # For Java
+  #   "boolean".to_ident # => 'boolean_'
+  #   "bool".to_ident    # => 'bool'
+  #
+  #   # For C#
+  #   "boolean".to_ident # => 'boolean'
+  #   "bool".to_ident    # => 'bool_'
+  def to_ident
+    Cog.active_language.to_ident(self)
+  end
+end
+
+class TrueClass
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  # @example
+  #   # For Objective-C
+  #   true.to_lit # => 'YES'
+  #
+  #   # For Java
+  #   true.to_lit # => 'true'
+  def to_lit
+    Cog.active_language.to_boolean(self)
+  end
+end
+
+class FalseClass
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  # @example
+  #   # For Objective-C
+  #   false.to_lit # => 'NO'
+  #
+  #   # For Java
+  #   false.to_lit # => 'false'
+  def to_lit
+    Cog.active_language.to_boolean(self)
+  end
+end
+
+class NilClass
+  # @return [String] literal representation in the {Cog::Config::LanguageConfig#active_language Cog.active_language}
+  # @example
+  #   # For C
+  #   nil.to_lit # => 'NULL'
+  #
+  #   # For C#
+  #   nil.to_lit # => 'null'
+  def to_lit
+    Cog.active_language.to_null(self)
+  end
+end
+

data/lib/cog/seed.rb

@@ -0,0 +1,68 @@
+module Cog
+  
+  # Template for a class in a target language
+  class Seed
+    
+    include Generator
+    
+    autoload :Feature, 'cog/seed/feature'
+    autoload :Var, 'cog/seed/var'
+    
+    # @return [String] name of the class
+    attr_reader :name
+    
+    # @return [String,nil] path to the header file
+    attr_reader :header_path
+    
+    # @return [String,nil] name of the scope in which classes generated by this seed will be found
+    attr_reader :in_scope
+    
+    # @api developer
+    # @param name [String] name of the class
+    def initialize(name)
+      @name = name.to_s.camelize.to_ident
+      @features = [] # [Feature]
+    end
+
+    # @return [String] begin the include guard
+    def guard
+      x = [@in_scope, @name].compact.collect &:upcase
+      include_guard_begin "__COG_SPROUT__#{x.join '_'}_H__"
+    end
+    
+    # @return [Array<Feature>] a sorted list of features
+    def features
+      @features.sort
+    end
+    
+    # Render the class in the currently active language
+    # @param path [String] file system path without the extension, relative to the project root. The extension will be determined based on the currently active language
+    # @option opt [String] :language key for the language to use. The language must define a seed extension
+    def stamp_class(path, opt={})
+      Cog.activate_language opt[:language] do
+        l = Cog.active_language
+        raise Errors::ActiveLanguageDoesNotSupportSeeds.new :language => l if l.nil? || l.seed_extension.nil?
+        
+        @in_header = false
+        @header_path = if l.seed_header
+          "#{path}.#{l.seed_header}"
+        end
+        stamp "cog/#{l.key}/seed.#{l.seed_extension}", "#{path}.#{l.seed_extension}"
+        if l.seed_header
+          @in_header = true
+          stamp "cog/#{l.key}/seed.#{l.seed_header}", @header_path
+        end
+      end
+    end
+
+    def in_header?
+      @in_header
+    end
+
+    # Sort by name
+    def <=>(other)
+      @name <=> other
+    end
+      
+  end
+end

data/lib/cog/seed/feature.rb

@@ -0,0 +1,54 @@
+module Cog
+  class Seed
+    
+    # Template for a method in a target language
+    class Feature
+      
+      include Generator
+      
+      attr_reader :seed
+      
+      # @return [String] name of the method
+      attr_reader :name
+      
+      attr_reader :params
+      
+      attr_reader :return_type
+      
+      # @api developer
+      # @param name [String] name of the method
+      def initialize(seed, name, opt={})
+        @seed = seed
+        @name = name.to_s.to_ident
+        @abstract = false
+        @params = [] # [Var]
+        @return_type = :void
+      end
+
+      # @return [Boolean] is this an abstract method?
+      def abstract?
+        @abstract
+      end
+      
+      def desc
+        @desc || 'Undocumented'
+      end
+      
+      def keep_name
+        "#{@seed.name}_#{@name}"
+      end
+            
+      def stamp_method
+        l = Cog.active_language
+        ext = @seed.in_header? ? l.seed_header : l.seed_extension
+        stamp "cog/#{l.key}/feature.#{ext}"
+      end
+      
+      # Sort by name
+      def <=>(other)
+        @name <=> other.name
+      end
+
+    end
+  end
+end

data/lib/cog/seed/var.rb

@@ -0,0 +1,43 @@
+module Cog
+  class Seed
+    
+    # Template for a variable in a target language
+    class Var
+      
+      include Generator
+      
+      # @return [String] name of the variable
+      attr_reader :name
+      
+      attr_reader :desc
+      
+      attr_reader :type
+      
+      attr_reader :scope
+      
+      # @api developer
+      def initialize(type, name, opt={})
+        @type = type
+        @name = name.to_s.to_ident
+        @desc = opt[:desc]
+        @scope = opt[:scope]
+      end
+
+      def qualify?
+        @qualify
+      end
+
+      def stamp_decl(qualify = false)
+        l = Cog.active_language
+        @qualify = qualify && @scope
+        stamp "cog/#{l.key}/var_decl.#{l.seed_extension}"
+      end
+      
+      # Sort by name
+      def <=>(other)
+        @name <=> other
+      end
+
+    end
+  end
+end

data/lib/cog/version.rb

@@ -1,5 +1,5 @@
 module Cog
   unless const_defined? :VERSION
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cog
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Kevin Tonon
@@ -15,10 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-05 00:00:00 Z
+date: 2013-01-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: gli
+  name: active_support
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -32,7 +32,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rainbow
+  name: gli
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,7 +46,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: active_support
+  name: i18n
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -60,7 +60,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: rainbow
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -88,7 +88,7 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: redcarpet
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -101,6 +101,34 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
 description: 
 email: kevin@betweenconcepts.com
 executables: 
@@ -116,6 +144,11 @@ files:
 - built_in/generators/sort.rb
 - built_in/plugins/basic/Cogfile
 - built_in/plugins/basic/templates/basic/generator.rb.erb
+- built_in/templates/cog/c++/feature.cpp.erb
+- built_in/templates/cog/c++/feature.h.erb
+- built_in/templates/cog/c++/seed.cpp.erb
+- built_in/templates/cog/c++/seed.h.erb
+- built_in/templates/cog/c++/var_decl.cpp.erb
 - built_in/templates/cog/Cogfile.erb
 - built_in/templates/cog/plugin/generator.rb.erb.erb
 - built_in/templates/cog/plugin/plugin.rb.erb
@@ -129,7 +162,9 @@ files:
 - lib/cog/controllers/template_controller.rb
 - lib/cog/controllers.rb
 - lib/cog/dsl/cogfile.rb
+- lib/cog/dsl/feature_dsl.rb
 - lib/cog/dsl/language_dsl.rb
+- lib/cog/dsl/seed_dsl.rb
 - lib/cog/dsl.rb
 - lib/cog/embed_context.rb
 - lib/cog/embeds.rb
@@ -148,6 +183,10 @@ files:
 - lib/cog/native_extensions/string.rb
 - lib/cog/native_extensions.rb
 - lib/cog/plugin.rb
+- lib/cog/primitive.rb
+- lib/cog/seed/feature.rb
+- lib/cog/seed/var.rb
+- lib/cog/seed.rb
 - lib/cog/spec_helpers/matchers/match_maker.rb
 - lib/cog/spec_helpers/matchers.rb
 - lib/cog/spec_helpers/runner.rb