slow_blink 0.0.3 → 0.0.4

data/lib/slow_blink/annotatable.rb

@@ -18,13 +18,12 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module SlowBlink
+
     module Annotatable
 
         # @return [Array<Annotation>]
         attr_reader :annotes
 
-        # @private
-        #
         # @param annotes [Array<Annotation,Integer>]
         def annote(annotes)
             annotes.each do |a|

data/lib/slow_blink/annotation.rb

@@ -1,3 +1,4 @@
+
 # Copyright (c) 2016 Cameron Harper
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -18,12 +19,18 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module SlowBlink
+
     class Annotation
 
+        # @macro location
         attr_reader :location
+
+        # @return [String]
         attr_reader :id
+
+        # @return [Integer]
         attr_reader :value
-        
+
         # @param id [String] any string
         # @param value [String] any string
         # @param location [String]

data/lib/slow_blink/compact_encoder.rb

@@ -19,6 +19,7 @@
 
 module SlowBlink
 
+    # @api private
     module CompactEncoder
 
         # @!method getU8(input)

data/lib/slow_blink/definition.rb

@@ -1,3 +1,4 @@
+
 # Copyright (c) 2016 Cameron Harper
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -18,6 +19,7 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module SlowBlink
+
     class Definition
 
         include Annotatable
@@ -26,14 +28,13 @@ module SlowBlink
             self == other                
         end
 
-        # @return [String]
+        # @macro location
         attr_reader :location
 
-        # @return [String]
+        # @return [NameWithID]
         attr_reader :nameWithID
 
-        # @return [ENUMERATION]
-        # @return [Type]
+        # @return [Type,ENUMERATION]
         attr_reader :type
 
         # @param namespace [Namespace]
@@ -41,25 +42,48 @@ module SlowBlink
             @ns = namespace
         end
 
-        # @private
-        #
         # @param nameWithID [NameWithID]
         # @param type [ENUMERATION, Type]
         # @param location [String]
         def initialize(nameWithID, type, location)
             @annotes = {}
-            @schema = nil
             @type = type
             @location = location
             @nameWithID = nameWithID
             @ns = nil
         end
 
+        # @api private
+        # Resolve references, enforce constraints, and detect cycles
+        #
+        # @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=[])
-            if @schema.nil?
-                @schema = @type.link(schema, @ns, stack << self)
+                     
+            # a definition can resolve to a definition only if there is a dynamic
+            # link somewhere in the chain
+            sf = stack.each
+            begin
+                loop do
+                    if sf.next == self
+                        loop do
+                            begin
+                                f = sf.next
+                                if f.respond_to? "dynamic?".to_sym and f.dynamic?
+                                    return schema
+                                end
+                            rescue StopIteration
+                                raise Error.new "#{self.location}: error: invalid cycle detected"
+                            end                                   
+                        end
+                    end
+                end
+            rescue StopIteration
             end
-            @schema
+
+            @type.link(schema, @ns, stack << self)
+            
         end
 
     end

data/lib/slow_blink/enumeration.rb

@@ -27,8 +27,6 @@ module SlowBlink
             self == other                
         end
 
-        # @private
-        #
         # @param syms [Array<Sym>] symbol list
         def initialize(syms)
             @annotes = {}
@@ -37,20 +35,28 @@ module SlowBlink
             @schema = nil       
         end
 
+        # @api private
+        #
+        # Resolve references, enforce constraints, and detect cycles
+        #
+        # @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 @schema.nil?
                 value = 0
-                errors = 0
-                @syms = {}                        
+                @syms = {}
+                @schema = schema
                 @rawSyms.each do |s|
                     if @syms[s.name]
-                        puts "#{s.location}: error: duplicate name '#{s.name}' (first defined at #{@syms[s.name].location})"
-                        errors += 1
+                        Log.error "#{s.location}: error: symbols within an enumeration must have unique names ('#{s.name}' first appears at #{@syms[s.name].location})"
+                        @schema = nil
                     else
                         if s.val
                             if @syms.values.include? s.val
-                                puts "#{s.location}: error: duplicate value"
-                                errors += 1
+                                Log.error "#{s.location}: error: values of symbols must be distinct ('#{s.val}' first appears at #{@syms[s.val].location})"
+                                @schema = nil
                             else
                                 value = s.val + 1
                             end                        
@@ -60,10 +66,7 @@ module SlowBlink
                         end
                         @syms[s.name] = s
                     end
-                end
-                if errors == 0
-                    @schema = schema
-                end
+                end                
             end
             @schema            
         end

data/lib/slow_blink/field.rb

@@ -23,7 +23,7 @@ module SlowBlink
         
         include Annotatable
 
-        # @return [String]
+        # @macro location
         attr_reader :location
 
         # @return [Type]
@@ -38,8 +38,6 @@ module SlowBlink
             @opt
         end
 
-        # @private
-        #
         # @param nameWithID [NameWithID]
         # @param type   [Type]
         # @param opt    [true,false] field is optional?
@@ -53,14 +51,17 @@ module SlowBlink
             @nameWithID = nameWithID
         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=[])
             if @schema.nil?
-                if @type.link(schema, ns, stack << self)
-                    @schema = schema
-                end
+                @schema = @type.link(schema, ns, stack << self)
             end
             @schema
         end

data/lib/slow_blink/group.rb

@@ -27,7 +27,7 @@ module SlowBlink
             self == other                
         end
 
-        # @return [String]
+        # @macro location
         attr_reader :location
 
         # @return [NameWithID]
@@ -43,8 +43,6 @@ module SlowBlink
             @ns = namespace
         end
 
-        # @private
-        #
         # @param nameWithID [NameWithID]
         # @param superGroup [REF, nil]
         # @param fields [Array<Field>]
@@ -59,42 +57,82 @@ module SlowBlink
             @nameWithID = nameWithID
             @ns = nil
         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=[])
+            
             if @schema.nil?
-                errors = 0
+
+                # a definition can resolve to a definition only if there is a dynamic
+                # link somewhere in the chain
+                sf = stack.each
+                begin
+                    loop do
+                        if sf.next == self
+                            loop do
+                                begin
+                                    f = sf.next
+                                    if f.respond_to? "dynamic?".to_sym and f.dynamic?
+                                        return schema
+                                    end
+                                rescue StopIteration
+                                    raise Error.new "#{self.location}: error: invalid cycle detected"
+                                end
+                            end
+                        end
+                    end
+                rescue StopIteration
+                end
+
+                error = false
                 @fields = {}
                 if !@superGroup or (@superGroup and @superGroup.link(schema, @ns, stack << self))                    
                     if !@superGroup or @superGroup.ref.is_a?(Group)
                         if @superGroup
-                            @superGroup.ref.fields.each do |f|
-                                 @fields[f.nameWithID.name] = f
-                            end
-                        end
-                        @rawFields.each do |f|
-                            if @fields[f.nameWithID.name]
-                                puts "#{f.location}: error: duplicate field name '#{f.nameWithID.name}' (first defined at #{@fields[f.nameWithID.name].location})"
-                                errors += 1
+                            if @superGroup.dynamic_reference?
+                                Log.error "#{@superGroup.location}: error: reference to supergroup must not be dynamic"
+                                error = true                                
                             else
-                                if f.link(schema, @ns, stack.dup << self)
+                                @superGroup.ref.fields.each do |f|
                                     @fields[f.nameWithID.name] = f
-                                else
-                                    errors += 1
                                 end
                             end
                         end
-                        if errors == 0
-                            @schema = schema
+                        if !error
+                            @rawFields.each do |f|
+                                if @fields[f.nameWithID.name]
+                                    Log.error "#{f.location}: error: field names must be unique within a group ('#{f.nameWithID.name}' first appears at #{@fields[f.nameWithID.name].location})"
+                                    error = true
+                                else
+                                    if f.link(schema, @ns, stack.dup << self)                                    
+                                        @fields[f.nameWithID.name] = f
+                                    else
+                                        error = true
+                                    end
+                                end
+                            end
                         end
                     else
-                        puts "#{@superGroup.location}: error: superGroup '#{@superGroup.qname}' must resolve to a group definition"
+                        Log.error "#{@superGroup.location}: error: reference to supergroup must resolve to group definition"
+                        error = true
                     end
+                else
+                    error = true
+                end
+
+                if !error
+                    @schema = schema
                 end
+                
             end
-            @schema            
+            
+            @schema
         end
 
         # @param name [String] name of field
@@ -104,8 +142,7 @@ module SlowBlink
             @fields[name]
         end
 
-        # Is this group a sub group of the super group?
-        #
+        # @api private
         # @param superGroup [Group]
         # @return [true,false]
         def group_kind_of?(superGroup)

data/lib/slow_blink/incremental_annotation.rb

@@ -22,14 +22,17 @@ module SlowBlink
     # Blink Specification 7.3
     class IncrementalAnnotation
 
+        # @return [SchemaRef, DefinitionRef, DefinitionTypeRef, FieldRef, FieldTypeRef]
         attr_reader :componentReference
+
+        # @return [Array<Integer,Annotation>]
         attr_reader :annotes
+
+        # @macro location
         attr_reader :location
 
-        # @private
-        #
         # @param componentReference [SchemaRef, DefinitionRef, DefinitionTypeRef, FieldRef, FieldTypeRef] annotation target
-        # @param annotations [Array<Integer,Annotation>]
+        # @param annotes [Array<Integer,Annotation>]
         # @param location [String]    
         def initialize(componentReference, annotes, location)
             @componentReference = componentReference
@@ -38,7 +41,7 @@ module SlowBlink
             @schema = nil
         end
 
-        # @private
+        # @api private
         #
         # Apply annotes to targets
         #

data/lib/slow_blink/integer.rb

@@ -22,7 +22,7 @@ module SlowBlink
     class INTEGER < Type
     end
 
-        # Blink Specification 3.1
+    # Blink Specification 3.1
     class I8 < INTEGER
         RANGE = Range.new(-128, 127)
     end

data/{test/tc_model.rb → lib/slow_blink/log.rb}

@@ -17,49 +17,32 @@
 # 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'
+module SlowBlink
 
-class TestModel < Test::Unit::TestCase
+    class Log
 
-    include SlowBlink
-
-    def test_think_blink
-        rawSchema = <<-eos
-        OrderExecuted/0x4c ->
-            string Symbol,
-            u64 OrderId,
-            u32 Price,
-            u32 Qty,
-            u8 MatchId
-        eos
-        schema = Schema.new(SchemaBuffer.new(rawSchema))        
-        model = Message::Model.new(schema)
-    end
-
-    def test_from_compact
-        rawSchema = <<-eos
-        OrderExecuted/0x4c ->
-            string Symbol,
-            u64 OrderId,
-            u32 Price,
-            u32 Qty,
-            u8 MatchId
-        eos
-        schema = Schema.new(SchemaBuffer.new(rawSchema))
+        @file = STDERR
+    
+        def self.file=(file)
+            @file = file
+        end
+
+        def self.file
+            @file
+        end
+
+        def self.error(msg)
+            if @file
+                @file.puts(msg)
+            end
+        end
+
+        def self.info(msg)
+            if @file
+                @file.puts(msg)
+            end
+        end
     
-        input = "\x0b\x4c\x05hello\x00\x01\x02\x03"
-        model = Message::Model.new(schema)
-        
-        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/lib/slow_blink/message/binary.rb

@@ -19,68 +19,62 @@
 
 module SlowBlink::Message
 
-    module BINARY
+    class BINARY
 
-        module CLASS
-
-            def opt?
-                @opt
-            end
+        def self.opt?
+            @opt
+        end
 
-            def from_compact!(input)
-                value = input.getBinary!
-                if value
-                    if !@size or value.size <= @size
-                        self.new(value)
-                    else
-                        raise Error.new "W8: Binary value exceeds maximum size"
-                    end
-                elsif @opt
-                    self.new(nil)
+        def self.from_compact!(input)
+            value = input.getBinary!
+            if value
+                if !@size or value.size <= @size
+                    self.new(value)
                 else
-                    raise Error.new "W5: Value cannot be null"
+                    raise Error.new "W8: Binary value exceeds maximum size"
                 end
+            elsif @opt
+                self.new(nil)
+            else
+                raise Error.new "W5: Value cannot be null"
             end
-
-            def size
-                @type.size
-            end
-
         end
 
-        module INSTANCE
+        def self.size
+            @type.size
+        end
 
-            def set(value)
-                if value
-                    if value.kind_of? String
-                        if !self.class.size or value.size <= self.class.size
-                            @value = value
-                        else
-                            raise Error.new "string cannot be larger than #{self.class.size} bytes"
-                        end
+        def set(value)
+            if value
+                if value.kind_of? String
+                    if !self.class.size or value.size <= self.class.size
+                        @value = value
                     else
-                        raise Error.new "expecting a string type"
+                        raise Error.new "string cannot be larger than #{self.class.size} bytes"
                     end
-                elsif self.class.opt?
-                    @value = nil
                 else
-                    raise Error.new "string cannot be null"
+                    raise Error.new "expecting a string type"
                 end
+            elsif self.class.opt?
+                @value = nil
+            else
+                raise Error.new "string cannot be null"
             end
+        end
 
-            def get
-                @value
-            end
-
-            def initialize(value)
-                set(value)                
-            end
+        def get
+            @value
+        end
 
-            def to_compact(out)
-                out.putBinary(@value)
-            end
+        def initialize(value)
+            set(value)                
+        end
 
+        def to_compact(out)
+            out.putBinary(@value)
         end
+
+        
         
     end
 

data/lib/slow_blink/message/boolean.rb

@@ -19,50 +19,42 @@
 
 module SlowBlink::Message
 
-    module BOOLEAN
-
-        module CLASS
-
-            def from_compact!(input)
-                self.new(input.getBool!)
-            end
+    class BOOLEAN
 
+        def self.from_compact!(input)
+            self.new(input.getBool!)
         end
 
-        module INSTANCE
-
-            def set(value)
-                if value
-                    if value.kind_of? TrueClass or value.kind_of? FalseClass
-                        @value = value
-                    else
-                        raise "expecting true/false"
-                    end
-                elsif self.class.opt?
-                    @value = nil
+        def set(value)
+            if value
+                if value.kind_of? TrueClass or value.kind_of? FalseClass
+                    @value = value
                 else
-                    raise Error.new "value unacceptable"
+                    raise "expecting true/false"
                 end
+            elsif self.class.opt?
+                @value = nil
+            else
+                raise Error.new "value unacceptable"
             end
+        end
 
-            def get
-                @value
-            end
-
-            def initialize(value)
-                if value
-                    set(value)
-                else
-                    @value = nil
-                end
-            end
+        def get
+            @value
+        end
 
-            def to_compact(out)
-                out.putBool(@value)
+        def initialize(value)
+            if value
+                set(value)
+            else
+                @value = nil
             end
-
         end
 
+        def to_compact(out)
+            out.putBool(@value)
+        end
+        
     end
 
 end

data/lib/slow_blink/message/date.rb

@@ -19,14 +19,9 @@
 
 module SlowBlink::Message
 
-    module DATE
+    class DATE
 
-        module CLASS
-        end
-
-        module INSTANCE
-        end
-    
+        
     end
 
 end