cauterize 0.0.1.pre5 → 0.0.1.pre7

data/lib/cauterize/scalar.rb

@@ -8,8 +8,8 @@
 module Cauterize
   module_function
 
-  def scalar(name)
-    a = Cauterize.scalars[name] || Cauterize.scalars[name] = Scalar.new(name)
+  def scalar(name, desc=nil)
+    a = Cauterize.scalars[name] || Cauterize.scalars[name] = Scalar.new(name, desc)
     yield a if block_given?
     return a
   end
@@ -27,7 +27,7 @@ module Cauterize
   end
 
   class Scalar < BaseType
-    def initialize(name)
+    def initialize(name, desc=nil)
       super
     end
 

data/lib/cauterize/variable_array.rb

@@ -1,8 +1,8 @@
 module Cauterize
   module_function
 
-  def variable_array(name)
-    a = Cauterize.variable_arrays[name] || Cauterize.variable_arrays[name] = VariableArray.new(name)
+  def variable_array(name, desc=nil)
+    a = Cauterize.variable_arrays[name] || Cauterize.variable_arrays[name] = VariableArray.new(name, desc)
     yield a if block_given?
     return a
   end
@@ -20,7 +20,7 @@ module Cauterize
   end
 
   class VariableArray < BaseType
-    def intialize(name)
+    def intialize(name, desc=nil)
       super
     end
 

data/lib/cauterize/version.rb

@@ -1,3 +1,3 @@
 module Cauterize
-  VERSION = "0.0.1.pre5"
+  VERSION = "0.0.1.pre7"
 end

data/spec/base_type_spec.rb

@@ -6,6 +6,16 @@ module Cauterize
         it { has_a_unique_id_for_each_instance(BaseType) }
       end
 
+      describe :description do
+        it "handles nil description" do
+          BaseType.new(:foo, nil).description.should be_nil
+        end
+
+        it "sets the description" do
+          BaseType.new(:foo, "a desc").description.should == "a desc"
+        end
+      end
+
       describe :type_str do
         it "is the hexadecimal representation of type" do
           f = Cauterize.enumeration(:foo) do |e|

data/spec/builders/c/group_spec.rb

@@ -12,7 +12,7 @@ module Cauterize
         @g = Cauterize.group!(:some_name) do |_g|
           _g.field(:a, :uint8_t)
           _g.field(:b, :uint8_t)
-          _g.field(:c)
+          _g.dataless(:c)
         end
         @b = Cauterize::Builders::C::Group.new(@g)
       end
@@ -84,7 +84,7 @@ module Cauterize
         _g = Cauterize.group(:oof) do |g|
           g.field(:aaa, :int32)
           g.field(:bbb, :int32)
-          g.field(:empty)
+          g.dataless(:empty)
         end
 
         Builders.get(:c, _g)

data/spec/builders/cs/group_spec.rb

@@ -6,7 +6,7 @@ module Cauterize
         @g = Cauterize.group!(:some_name) do |_g|
           _g.field(:a, :uint8_t)
           _g.field(:b, :uint8_t)
-          _g.field(:c)
+          _g.dataless(:c)
           _g.field(:d, :uint8_t)
         end
         @b = Cauterize::Builders::CS::Group.new(@g)

data/spec/builders/doc/buildable_spec.rb

@@ -0,0 +1,25 @@
+module Cauterize::Builders::Doc
+  describe Cauterize::Builders::Doc do
+    describe Buildable do
+      subject { Buildable.new(:some_blueprint) }
+
+      describe "required methods" do
+        it "raises errorson required interfaces" do
+          lambda {
+            REQUIRED_METHODS.each do |m|
+              subject.send(m)
+            end
+          }.should raise_error /must implement/
+        end
+      end
+
+      describe :method_missing do
+        it "calls the original if method not required" do
+          lambda {
+            subject.is_not_defined
+          }.should raise_error NoMethodError
+        end
+      end
+    end
+  end
+end

data/spec/builders_spec.rb

@@ -43,8 +43,10 @@ module Cauterize
         }.should raise_error /already registered/
       end
 
-      it "is nil if no builder is registered" do
-        Cauterize::Builders.get(:c, s).should be_nil
+      it "raises exception no builder is registered" do
+        lambda {
+          Cauterize::Builders.get(:c, s)
+        }.should raise_error Cauterize::Builders::UnregisteredException
       end
     end
   end

data/spec/builtin_spec.rb

@@ -13,6 +13,8 @@ module Cauterize
       end
     end
 
+    it { can_be_documented(BuiltIn) }
+
     describe :id do
      it "has a unique id for each builtin" do
        ids = Cauterize.builtins.values.map(&:id)

data/spec/c_builder_spec.rb

@@ -77,6 +77,10 @@ module Cauterize
       end
 
       describe "header generation" do
+        it "informs the user the code is generated" do
+          @h_text.should include("generated code. Do not edit")
+        end
+
         it "externs 'c'" do
           @h_lines.should include("extern \"C\" {\n")
         end
@@ -90,9 +94,10 @@ module Cauterize
         end
 
         it "prevents multiple inclusion in headers" do
-          @h_lines[0].should match /#ifndef TESTING_H_\d+/
-          @h_lines[1].should match /#define TESTING_H_\d+/
-          @h_lines.last.should match /#endif \/\* TESTING_H_\d+ \*\//
+          @h_lines[2].should match /#ifndef TESTING_H_\d+/
+          @h_lines[3].should match /#define TESTING_H_\d+/
+          @h_lines[-2].should match /#endif \/\* TESTING_H_\d+ \*\//
+          @h_lines.last.should == "\n"
         end
 
         it "includes prototype information for all defined types" do
@@ -109,6 +114,10 @@ module Cauterize
       end
 
       describe "c body generation" do
+        it "informs the user the code is generated" do
+          @c_text.should include("generated code. Do not edit")
+        end
+
         it "includes the generated header file" do
           @c_text.should match /#include "testing.h"/
         end

data/spec/composite_spec.rb

@@ -20,6 +20,8 @@ module Cauterize
         end
       end
 
+      it { can_be_documented(Composite) }
+
       describe :fields do
         it "defines a new field in the composite" do
           a = Cauterize.scalar(:foo)
@@ -32,6 +34,15 @@ module Cauterize
           comp.fields.values[0].type.should be a
         end
 
+        it "supports a doc string" do
+          a = Cauterize.scalar(:foo)
+          comp = Cauterize.composite(:comp) do |c|
+            c.field :a_foo, :foo, "some foo"
+          end
+
+          comp.fields.values[0].description.should == "some foo"
+        end
+
         it "errors on duplicate field names" do
           a = Cauterize.scalar(:foo)
           lambda {

data/spec/cs_builder_spec.rb

@@ -70,6 +70,10 @@ module Cauterize
         @cs_lines = @cs_text.lines.to_a
       end
 
+      it "informs the user the code is generated" do
+        @cs_text.should match /generated code. Do not edit/
+      end
+
       it "includes namespaces" do
         @cs_lines.should include("using System;\n")
         @cs_lines.should include("using Cauterize;\n")
@@ -80,8 +84,8 @@ module Cauterize
       end
 
       it "creates a cauterize info class with version and date" do
-        @cs_text.should match /Name = \"Testing\";/
-        @cs_text.should match /GeneratedVersion = \"1.2.3\";/
+        @cs_text.should match /Name = \"Testing\",/
+        @cs_text.should match /GeneratedVersion = \"1.2.3\",/
         @cs_text.should match /GeneratedDate = /
       end
 

data/spec/doc_builder_spec.rb

@@ -0,0 +1,247 @@
+require 'tmpdir'
+require 'fileutils'
+
+module Cauterize
+  describe Cauterize::DocBuilder do
+    before do
+      @tempdir = Dir.mktmpdir
+      @doc_path = File.join(@tempdir, "testing.txt")
+
+      @db = DocBuilder.new(@doc_path, "testing")
+    end
+
+    after do
+      FileUtils.rm_rf @tempdir
+    end
+
+    describe :initialize do
+      it "should save the name" do
+        @db.name.should == "testing"
+        @db.doc_path.should == @doc_path
+      end
+    end
+
+    describe :build do
+      before do
+        Cauterize.set_version("1.2.3")
+
+        Cauterize.scalar(:an_int, "a useful int") {|t| t.type_name :int32}
+        Cauterize.scalar(:another_int) {|t| t.type_name :int32}
+
+        Cauterize.composite(:a_composite, "some useful fields") do |t|
+          t.field :an_int, :int32, "a pretty integer"
+          t.field :another_int, :int32, "another pretty integer"
+          t.field :undescribed, :int32
+        end
+
+        Cauterize.composite(:mystery) do |t|
+          t.field :undescribed, :int32
+        end
+
+        Cauterize.fixed_array(:a_fixed_array, "a few things") do |t|
+          t.array_type :an_int
+          t.array_size 5
+        end
+
+        Cauterize.fixed_array(:a_mystery_array) do |t|
+          t.array_type :uint8
+          t.array_size 1
+        end
+
+        Cauterize.variable_array(:a_var_array, "maybe some things") do |t|
+          t.array_type :an_int
+          t.array_size 5
+          t.size_type :uint8
+        end
+
+        Cauterize.variable_array(:a_var_mystery) do |t|
+          t.array_type :uint8
+          t.array_size 1
+          t.size_type :uint8
+        end
+
+        Cauterize.enumeration(:some_colors, "several colors to choose from") do |t|
+          t.value :red
+          t.value :blue
+          t.value :green
+        end
+
+        Cauterize.enumeration(:mystery_things) do |t|
+          t.value :thing1
+          t.value :thing2
+          t.value :thing3
+        end
+
+        Cauterize.group(:oddness, "a mix of weird things") do |t|
+          t.field :a_color, :some_colors, "a color"
+          t.field :a_cool_int, :int16, "only cool ints fit here"
+          t.dataless :a_thing, "only a thing"
+          t.dataless :undescribed
+        end
+
+        Cauterize.group(:mystery_oddness) do |t|
+          t.field :a_color, :some_colors
+          t.field :a_cool_int, :int16
+          t.dataless :a_thing, "only a thing"
+          t.dataless :undescribed
+        end
+
+        @db.build
+        @doc_text = File.read(@doc_path)
+        @doc_lines = @doc_text.lines.to_a
+      end
+
+      describe "doc generation" do
+        it "contains type details" do
+          t = <<EOF
+Type Name: int8
+Cauterize Class: built-in
+Description: <none>
+  data - size: 1 bytes
+
+Type Name: int16
+Cauterize Class: built-in
+Description: <none>
+  data - size: 2 bytes
+
+Type Name: int32
+Cauterize Class: built-in
+Description: <none>
+  data - size: 4 bytes
+
+Type Name: int64
+Cauterize Class: built-in
+Description: <none>
+  data - size: 8 bytes
+
+Type Name: uint8
+Cauterize Class: built-in
+Description: <none>
+  data - size: 1 bytes
+
+Type Name: uint16
+Cauterize Class: built-in
+Description: <none>
+  data - size: 2 bytes
+
+Type Name: uint32
+Cauterize Class: built-in
+Description: <none>
+  data - size: 4 bytes
+
+Type Name: uint64
+Cauterize Class: built-in
+Description: <none>
+  data - size: 8 bytes
+
+Type Name: an_int
+Cauterize Class: scalar
+Description:  - a useful int
+  data - type: int32
+
+Type Name: another_int
+Cauterize Class: scalar
+Description: <none>
+  data - type: int32
+
+Type Name: a_composite
+Cauterize Class: composite
+Description: some useful fields
+  an_int - type: int32 - description: a pretty integer
+  another_int - type: int32 - description: another pretty integer
+  undescribed - type: int32
+
+Type Name: mystery
+Cauterize Class: composite
+Description: <none>
+  undescribed - type: int32
+
+Type Name: a_fixed_array
+Cauterize Class: fixed-array
+Description: a few things
+Stored Type: an_int
+Value Count: 5
+  data - 5 values of type an_int
+
+Type Name: a_mystery_array
+Cauterize Class: fixed-array
+Description: <none>
+Stored Type: uint8
+Value Count: 1
+  data - 1 values of type uint8
+
+Type Name: a_var_array
+Cauterize Class: variable-array
+Description: maybe some things
+Maximum Value Count: 5
+  length - type uint8
+  data - 0 to 5 values of type an_int
+
+Type Name: a_var_mystery
+Cauterize Class: variable-array
+Description: <none>
+Maximum Value Count: 1
+  length - type uint8
+  data - 0 to 1 values of type uint8
+
+Type Name: some_colors
+Cauterize Class: enumeration
+Description: several colors to choose from
+Encoding: int8
+    red = 0
+    blue = 1
+    green = 2
+
+Type Name: mystery_things
+Cauterize Class: enumeration
+Description: <none>
+Encoding: int8
+    thing1 = 0
+    thing2 = 1
+    thing3 = 2
+
+Type Name: group_oddness_type
+Cauterize Class: enumeration
+Description: <none>
+Encoding: int8
+    GROUP_ODDNESS_TYPE_A_COLOR = 0
+    GROUP_ODDNESS_TYPE_A_COOL_INT = 1
+    GROUP_ODDNESS_TYPE_A_THING = 2
+    GROUP_ODDNESS_TYPE_UNDESCRIBED = 3
+
+Type Name: oddness
+Cauterize Class: group
+Description: a mix of weird things
+  kind tag: group_oddness_type
+  kinds:
+    a_color - payload: some_colors - description: a color
+    a_cool_int - payload: int16 - description: only cool ints fit here
+    a_thing - payload: <no payload> - description: only a thing
+    undescribed - payload: <no payload>
+
+Type Name: group_mystery_oddness_type
+Cauterize Class: enumeration
+Description: <none>
+Encoding: int8
+    GROUP_MYSTERY_ODDNESS_TYPE_A_COLOR = 0
+    GROUP_MYSTERY_ODDNESS_TYPE_A_COOL_INT = 1
+    GROUP_MYSTERY_ODDNESS_TYPE_A_THING = 2
+    GROUP_MYSTERY_ODDNESS_TYPE_UNDESCRIBED = 3
+
+Type Name: mystery_oddness
+Cauterize Class: group
+Description: <none>
+  kind tag: group_mystery_oddness_type
+  kinds:
+    a_color - payload: some_colors
+    a_cool_int - payload: int16
+    a_thing - payload: <no payload> - description: only a thing
+    undescribed - payload: <no payload>
+EOF
+          @doc_text.should == t
+        end
+      end
+    end
+  end
+
+end