slow_blink 0.0.3 → 0.0.4

data/lib/slow_blink/schema.rb

@@ -17,13 +17,24 @@
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'slow_blink/log'
+
 module SlowBlink
 
+    # @!macro location
+    #   Location string formatted as:
+    #       [ FILENAME, ':' ], LINE_NUMBER, ':', COLUMN_NUMBER
+    #   @return [String]
+    
     class Schema
 
-        # Initialise a Schema from one or more Blink Schema files
+        # @api user
+        #
+        # Create a Schema from one or more Blink Schema files that are evaluated
+        # in the order they appear.
         #
         # @param filename [Array<String>]
+        # @return [Schema]
         def self.read(*filename)
             input = []
             if filename.size > 0
@@ -40,12 +51,17 @@ module SlowBlink
         #
         # - These groups are of interest to message code generators
         #
-        # @return [Hash]
+        # @return [Hash<Group>]
         attr_reader :tagged
 
         # @return [Array<Namespace>]
         attr_reader :ns
 
+        # @api user
+        #
+        # Create a Schema from one or more SchemaBuffers that are evaluated
+        # in the order they appear.
+        #
         # @param buffer [Array<SchemaBuffer>]
         def initialize(*buffer)
 
@@ -61,7 +77,7 @@ module SlowBlink
             @ns = {}
             @tagged = {}
             
-            errors = 0            
+            error = false          
 
             # gather and merge namespaces
             namespace.each do |ns|
@@ -69,7 +85,7 @@ module SlowBlink
                     begin
                         @ns[ns.name].merge!(ns)
                     rescue
-                        errors += 1
+                        raise
                     end
                 else
                     @ns[ns.name] = ns
@@ -88,8 +104,8 @@ module SlowBlink
                 ns.groups.each do |g|
                     if g.nameWithID.id
                         if @tagged[g.nameWithID.id]
-                            puts "error: duplicate group id"
-                            errors += 1
+                            Log.error "error: groups that have identifiers must have unique identifiers ('#{@g.nameWithID.id}' was first assigned to '#{@tagged[g.nameWithID.id].nameWithID.name}' at #{@tagged[g.nameWithID.id].location}"
+                            error = true
                         else
                             @tagged[g.nameWithID.id] = g
                         end
@@ -100,17 +116,17 @@ module SlowBlink
             # resolve all references
             @ns.each do |name, ns|
                 if !ns.link(self)
-                    errors += 1
+                    error = true
                 end
             end
 
-            if errors > 0
-                raise Error.new "#{errors} errors"
+            if error
+                raise
             end
             
         end
 
-        # resolve a name to a definition in any namespace
+        # Resolve a name to a definition in any namespace
         #
         # @param namespace [String,nil]
         # @param name [String]

data/lib/slow_blink/schema_buffer.rb

@@ -19,6 +19,16 @@
 
 module SlowBlink
 
+    # Use schema buffer when you want to deal with schemas in-memory
+    # rather than loading from files.
+    #
+    # It combines the schema string with an optional filename string.
+    #
+    # e.g:
+    #
+    #       anonBuffer = SchemaBuffer.new("Hello/0 -> string greeting")
+    #       namedBuffer = SchemaBuffer.new("Hello/0 -> string greeting", "nameThatWillAppearInErrorMessage.txt")
+    #
     class SchemaBuffer
 
         # @return [String]
@@ -27,6 +37,10 @@ module SlowBlink
         # @return [String]
         attr_reader :filename
         
+        # @api user
+        #
+        # Create a SchemaBuffer
+        #
         # @param buffer [String] the contents of the file
         # @param filename [String] name of the file (for error reporting)
         def initialize(buffer, filename=nil)

data/lib/slow_blink/sequence.rb

@@ -25,34 +25,30 @@ module SlowBlink
         # @return [Type]
         attr_reader :type
 
-        # @private
-        #
         # @param type [Type] repeating type
         # @param location [String]    
         def initialize(type, location)
-            @type = nil
-            @rawType = type
+            @type = type
             super(location)
         end
 
-        # @private
+        # @api private
+        #
+        # Resolve references, enforce constraints, and detect cycles
         #
-        # @macro common_link
-        def link(schema, stack=[])
-            if @schema.nil?
-                case @rawType.class
-                when REF
-                    schema.definition(@rawType)
-                when SEQUENCE
-                    puts "error: sequence of sequence is not permitted"
-                else
-                    @type = @rawType
-                    @schema = schema
-                end
-            end
-            @schema
+        # @param schema [Schema] schema this definition belongs to
+        # @param ns [Namespace] namespace this definition belongs to
+        # @param stack [nil, Array] objects that depend on this object
+        # @return [true,false] linked?
+        def link(schema, ns, stack=[])            
+            if stack.detect{|sf| sf.is_a? SEQUENCE}
+                Log.error "#{@location}: error: a sequence type specifier must not specify a sequence as the item type"
+                false
+            else
+                @type.link(schema, ns, stack << self)            
+            end                    
         end
-
+           
     end
 
 end

data/lib/slow_blink/string.rb

@@ -26,8 +26,6 @@ module SlowBlink
         # @return [nil] no maximum size
         attr_reader :size
 
-        # @private
-        #
         # @param size [Integer] maximum size
         # @param location [String]    
         def initialize(size, location)

data/lib/slow_blink/sym.rb

@@ -22,7 +22,7 @@ module SlowBlink
 
         include Annotatable
 
-        # @return [String]
+        # @macro location
         attr_reader :location
 
         # @return [String]
@@ -31,12 +31,11 @@ module SlowBlink
         # @return [Integer]
         attr_reader :val
 
+        # @api private
         def val=(value)
             @val = value.to_i
         end
 
-        # @private
-        #
         # @param name [String]
         # @param val [nil,Integer] explicit value
         # @param location [String]
@@ -47,9 +46,12 @@ module SlowBlink
             @location = location
         end
 
-        # @private
+        # @api private
+        # Resolve references, enforce constraints, and detect cycles
         #
-        # @macro common_link
+        # @param schema [Schema] schema this definition belongs to
+        # @param stack [nil, Array] objects that depend on this object
+        # @return [true,false] linked?
         def link(schema, stack=[])
             @schema = schema
         end

data/lib/slow_blink/type.rb

@@ -23,15 +23,13 @@ module SlowBlink
 
         include Annotatable
 
-        # @param [String]
+        # @macro location
         attr_reader :location
 
         def self.===(other)
             self == other                
         end
 
-        # @private
-        #
         # @param location [String]
         def initialize(location)
             @schema = nil
@@ -39,9 +37,14 @@ module SlowBlink
             @location = location
         end
 
-        # @private
+        # @api private
+        #
+        # Resolve references, enforce constraints, and detect cycles
         #
-        # @macro common_link
+        # @param schema [Schema] schema this definition belongs to
+        # @param ns [Namespace] namespace this definition belongs to
+        # @param stack [nil, Array] objects that depend on this object
+        # @return [true,false] linked?
         def link(schema, ns, stack=[])
             @schema = schema
         end

data/lib/slow_blink/version.rb

@@ -18,5 +18,5 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module SlowBlink
-    VERSION = '0.0.3'.freeze
+    VERSION = '0.0.4'.freeze
 end

data/test/tc_field.rb

@@ -50,4 +50,45 @@ class TestField < Test::Unit::TestCase
         end
     end
 
+    def test_field_direct_cycle
+        input =  <<-eos
+            test ->
+                test field
+        eos
+        assert_raise do
+            Schema.new(SchemaBuffer.new(input))
+        end    
+    end
+
+    def test_field_direct_dynamic_cycle
+        input =  <<-eos
+            test ->
+                test * field
+        eos
+        
+        Schema.new(SchemaBuffer.new(input))
+        
+    end
+
+    def test_field_indirect_cycle
+        input =  <<-eos
+            intermediate = test
+            test ->
+                intermediate field
+        eos
+        assert_raise do
+            Schema.new(SchemaBuffer.new(input))
+        end    
+    end
+
+    def test_field_indirect_dynamic_cycle
+        input =  <<-eos
+            intermediate = test *
+            test ->
+                intermediate field
+        eos
+        
+        Schema.new(SchemaBuffer.new(input))
+    end
+
 end

data/test/tc_group.rb

@@ -119,4 +119,15 @@ class TestGroup < Test::Unit::TestCase
         end
     end
 
+    def test_supergroup_dynamic_reference
+        input =  <<-eos
+            Super
+            Intermediate = Super *
+            Test : Intermediate
+        eos
+        assert_raise do
+            Schema.new(SchemaBuffer.new(input))
+        end        
+    end
+
 end

data/test/tc_model_static_group.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#  
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "test/unit"
+require 'slow_blink'
+
+class TestModelStaticGroup < Test::Unit::TestCase
+
+    include SlowBlink
+
+    def setup
+
+        rawSchema = <<-eos
+        StaticGroup ->
+            string one,
+            u8 two,
+            u8 three
+            
+        Test/0x00 ->
+            string one,
+            u8 two,
+            u8 three,
+            StaticGroup four            
+        eos
+
+        schema = Schema.new(SchemaBuffer.new(rawSchema))
+        @model = Message::Model.new(schema)
+        
+    end
+
+    def test_init_individual
+
+        message = @model.group "Test" do |g|
+            g["one"] = "hello"
+            g["two"] = 42
+            g["three"] = 42
+            g["four"]["one"] = "world"
+            g["four"]["two"] = 42
+            g["four"]["three"] = 42
+        end
+        
+        assert_equal("hello", message["one"])
+        assert_equal(42, message["two"])
+        assert_equal(42, message["three"])
+        assert_equal("world", message["four"]["one"])
+        assert_equal(42, message["four"]["two"])        
+        assert_equal(42, message["four"]["three"])        
+
+    end
+    
+    def test_init_part_bulk
+
+        message = @model.group "Test" do |g|
+            g["one"] = "hello"
+            g["two"] = 42
+            g["three"] = 42
+            g["four"] = {
+                "one" => "world",
+                "two" => 42,
+                "three" => 42
+            }
+        end
+        
+        assert_equal("hello", message["one"])
+        assert_equal(42, message["two"])
+        assert_equal(42, message["three"])
+        assert_equal("world", message["four"]["one"])
+        assert_equal(42, message["four"]["two"])        
+        assert_equal(42, message["four"]["three"])        
+
+    end
+
+    def test_init_bulk
+
+        message = @model.group "Test", {                
+            "one" => "hello",
+            "two" => 42,
+            "three" => 42,
+            "four" => {
+                "one" => "world",
+                "two" => 42,
+                "three" => 42
+            }
+        }
+        
+        assert_equal("hello", message["one"])
+        assert_equal(42, message["two"])
+        assert_equal(42, message["three"])
+        assert_equal("world", message["four"]["one"])
+        assert_equal(42, message["four"]["two"])        
+        assert_equal(42, message["four"]["three"])        
+
+    end
+
+
+    
+
+end

data/test/{tc_model_encode.rb → tc_model_think_blink.rb}

@@ -20,11 +20,11 @@
 require "test/unit"
 require 'slow_blink'
 
-class TestModelEncode < Test::Unit::TestCase
+class TestModelThinkBlink < Test::Unit::TestCase
 
     include SlowBlink
 
-    def test_think_blink
+    def setup
         rawSchema = <<-eos
         OrderExecuted/0x4c ->
             string Symbol,
@@ -34,23 +34,55 @@ class TestModelEncode < Test::Unit::TestCase
             u8 MatchId
         eos
         schema = Schema.new(SchemaBuffer.new(rawSchema))        
+        @model = Message::Model.new(schema)
+    end
+
+    def test_set_individual
+
+        message = @model.group "OrderExecuted" do |g|
+            g["Symbol"] = "hey"
+            g["OrderId"] = 42 
+            g["Price"] = 42 
+            g["Qty"] = 42 
+            g["MatchId"] = 42                
+        end            
+        
+        assert_equal("hey", message["Symbol"])
+        assert_equal(42, message["OrderId"])
+        assert_equal(42, message["Price"])
+        assert_equal(42, message["Qty"])
+        assert_equal(42, message["MatchId"])        
     
-        model = Message::Model.new(schema)                
-        message = model.new do
-            group "OrderExecuted" do |g|
-                g["Symbol"] = "hey"
-                g["OrderId"] = 42 
-                g["Price"] = 42 
-                g["Qty"] = 42 
-                g["MatchId"] = 42                
-            end            
-        end
+    end
+
+    def test_set_bulk
+
+        message = @model.group "OrderExecuted", {
+            "Symbol" => "hey",
+            "OrderId" => 42, 
+            "Price" => 42, 
+            "Qty" => 42, 
+            "MatchId" => 42                
+        }   
+        
 
         assert_equal("hey", message["Symbol"])
         assert_equal(42, message["OrderId"])
         assert_equal(42, message["Price"])
         assert_equal(42, message["Qty"])
-        assert_equal(42, message["MatchId"])
+        assert_equal(42, message["MatchId"])        
+    
+    end
+
+    def test_encode_compact
+        
+        message = @model.group "OrderExecuted" do |g|
+            g["Symbol"] = "hey"
+            g["OrderId"] = 42 
+            g["Price"] = 42 
+            g["Qty"] = 42 
+            g["MatchId"] = 42                
+        end            
 
         output = message.to_compact
         
@@ -60,4 +92,17 @@ class TestModelEncode < Test::Unit::TestCase
 
     end
 
+    def test_decode_compact
+        
+        input = "\x0b\x4c\x05hello\x00\x01\x02\x03"
+        
+        message = @model.decode_compact(input)
+        
+        assert_equal("hello", message["Symbol"])
+        assert_equal(0, message["OrderId"])
+        assert_equal(1, message["Price"])
+        assert_equal(2, message["Qty"])
+        assert_equal(3, message["MatchId"])        
+    end
+
 end

data/test/tc_types.rb

@@ -195,4 +195,43 @@ class TestTypes < Test::Unit::TestCase
         assert_equal(OBJECT, schema.ns[nil].group("test").field("one").type.class)        
     end
 
+    def test_type_direct_reference_cycle
+        input =  <<-eos
+            thing = thingref
+            thingref = thing
+        eos
+        assert_raise do
+           Schema.new(SchemaBuffer.new(input))
+        end        
+    end
+
+    def test_type_inderect_reference_cycle
+        input =  <<-eos
+            thing = intermediate
+            intermediate = thingref
+            thingref = thing
+        eos
+        assert_raise do
+           Schema.new(SchemaBuffer.new(input))
+        end        
+    end
+
+    def test_sequence_sequence
+        input = "test -> i32 [] test"
+        Schema.new(SchemaBuffer.new(input))        
+    end
+
+    def test_sequence_sequence_direct
+        input =  <<-eos
+            intermediate = u32 []
+            test ->
+                intermediate [] test            
+        eos
+
+        assert_raise do
+            Schema.new(SchemaBuffer.new(input))
+        end
+        
+    end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slow_blink
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Cameron Harper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -87,6 +87,7 @@ files:
 - lib/slow_blink/group.rb
 - lib/slow_blink/incremental_annotation.rb
 - lib/slow_blink/integer.rb
+- lib/slow_blink/log.rb
 - lib/slow_blink/message/binary.rb
 - lib/slow_blink/message/boolean.rb
 - lib/slow_blink/message/date.rb
@@ -122,8 +123,8 @@ files:
 - test/tc_group.rb
 - test/tc_incr_annote.rb
 - test/tc_inputs.rb
-- test/tc_model.rb
-- test/tc_model_encode.rb
+- test/tc_model_static_group.rb
+- test/tc_model_think_blink.rb
 - test/tc_namespace.rb
 - test/tc_types.rb
 homepage: https://github.com/cjhdev/slow_blink
@@ -151,14 +152,14 @@ signing_key:
 specification_version: 4
 summary: Blink Protocol in Ruby
 test_files:
+- test/tc_model_static_group.rb
 - test/tc_compact_encoder.rb
 - test/tc_group.rb
 - test/tc_inputs.rb
-- test/tc_model_encode.rb
 - test/tc_namespace.rb
 - test/tc_types.rb
 - test/capture_stderr.rb
-- test/tc_model.rb
+- test/tc_model_think_blink.rb
 - test/tc_field.rb
 - test/tc_incr_annote.rb
 has_rdoc: yard