slow_blink 0.0.7 → 0.0.8

data/lib/slow_blink/message/dynamic_group.rb

@@ -0,0 +1,132 @@
+# @license
+#   
+#   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.
+
+module SlowBlink::Message
+
+    class DynamicGroup
+
+        def self.taggedGroups
+            @taggedGroups
+        end
+
+        def self.permittedID
+            @permittedID
+        end
+
+        def self.from_compact(input, depth)
+
+            group = nil
+
+            if depth > 0
+                depth = depth - 1
+            else
+                raise RecursionLimit
+            end
+
+            if input.kind_of? String
+                input = StringIO.new(input)
+            end
+
+            buf = input.getBinary
+
+            if buf.nil?
+
+                group = nil
+
+            elsif buf.size == 0
+
+                raise WeakError5.new "W5: Value cannot be null"                
+        
+            else
+
+                buf = StringIO.new(buf)
+                id = buf.getU64
+
+                if klass = @taggedGroups[id]
+
+                    if @permittedID.include? id
+
+                        group = klass.from_compact(buf, depth)
+
+                        if !buf.eof?                
+                            size = buf.getU32
+                            while group.extension.size < size do
+                                group.extension << @anyTaggedGroup.from_compact(buf, depth).get
+                            end
+                        end
+
+                        if !buf.eof?
+                            raise ExtensionPadding
+                        end
+                        
+                    else
+                        raise WeakError15.new "W15: Group is known but unexpected"
+                    end
+                else
+                    raise WeakError2.new "W2: Group id #{id} is unknown"
+                end                   
+                
+            end
+
+            depth = depth + 1
+            self.new(group)
+
+        end
+
+        def set(value)
+            if value.kind_of? Group
+                if self.class.permittedID.include? value.class.id        
+                    @value = value
+                else                        
+                    raise TypeError.new "incompatible group"
+                end
+            else
+                raise ArgumentError.new "argument must be kind_of Group"
+            end
+        end
+
+        # @return [Group] contained group
+        def get
+            @value.get
+        end
+
+        # @note calls {#set}(value)
+        def initialize(value)
+            set(value)
+        end
+
+        # @private
+        def to_compact(out)
+            @value.encode_compact(out)        
+        end
+
+        def extension
+            @value.extension
+        end
+
+        def to_tag
+            "@#{@value.class.name}#{@value.to_tag_value}#{@value.to_tag_extension}"                    
+        end
+
+    end
+
+end
+

data/lib/slow_blink/message/enum.rb

@@ -29,7 +29,7 @@ module SlowBlink::Message
         end
 
         # @private
-        def self.from_compact(input, stack)
+        def self.from_compact(input, depth)
             if value = input.getI32
                 if symbol = type.symbol(value)
                     self.new(symbol.name)
@@ -68,7 +68,11 @@ module SlowBlink::Message
 
         # @private
         def to_compact(out)
-            out.putI32(self.class.type.symbol(@value).value)
+            out.putI32(self.class.type.symbol(@value).value)            
+        end
+
+        def to_tag
+            @value
         end
     
     end

data/lib/slow_blink/message/field.rb

@@ -51,70 +51,84 @@ module SlowBlink::Message
 
         # @private
         # @param input [String] Blink compact form
-        # @param stack [Array]
+        # @param depth [Array]
         # @return [Field] instance of anonymous subclass of Field
-        def self.from_compact(input, stack)
-            if sequence?
-                if size = input.getU32
-                    value = []
-                    while value.size < size do
-                        value << @type.from_compact(input, stack).get
-                    end
-                    self.new(value)
-                else
-                    nil
-                end
-            elsif optional? and (type.kind_of? StaticGroup or type.kind_of? FIXED)
-                if input.get_present(input)
-                    self.new(@type.from_compact(input, stack).get)
-                else
-                    nil
-                end
-            else
-                self.new(@type.from_compact(input, stack).get)
-            end
+        def self.from_compact(input, depth)
+            self.new(input, depth)         
         end
 
-        # @note calls {#set}(value)
-        def initialize(value)
+        attr_reader :type
+        
+        def sequence?
+            @sequence
+        end
+        def optional?
+            @optional
+        end
+
+        def initialize(input=nil, depth=nil)
 
             @optional = self.class.optional?
             @sequence = self.class.sequence?
             @type = self.class.type
-
-            if value
-                set(value)
-            else
-                @value = nil
+            @value = nil
+
+            if input and depth
+                if @sequence
+                    if size = input.getU32
+                        @value = []
+                        size.times do
+                            value = @type.from_compact(input, depth)
+                            if value
+                                @value << value
+                            end
+                        end
+                    end
+                elsif @optional and (@type.kind_of? StaticGroup or @type.kind_of? FIXED)
+                    if input.get_present
+                        @value = @type.from_compact(input, depth)
+                    end
+                else
+                    @value = @type.from_compact(input, depth)
+                end
+                
             end
-                        
+            
         end
         
-        def set(value)
-            if value.nil?
-                if optional?
+        def set(value)            
+            if value.kind_of? Field
+                self.set(value.get)
+            elsif value.nil?
+                if @optional
                     @value = nil
+                    self
                 else
-                    raise ArgumentError.new "field is not optional, value cannot be nil"
+                    raise ArgumentError.new "field '#{self.class.name}'is not optional, value cannot be nil (sequence: #{@sequence})"
                 end                
-            elsif self.class.sequence?                
+            elsif @sequence                
                 if value.kind_of? Array
                     @value = []
                     value.each do |v|
+                        if v.nil?
+                            next
+                        end
                         @value << @type.new(v)
                     end
+                    self
                 else
                     raise ArgumentError.new "field value must be an array of type"
                 end
             else
                 @value = @type.new(value)
-            end
+                self
+            end    
         end
 
         # @return field value or nil
         def get
             if @value
-                if self.class.sequence?
+                if @sequence
                     @value.map{|v|v.get}                
                 else
                     @value.get
@@ -129,7 +143,7 @@ module SlowBlink::Message
         # @return [StringIO]
         def to_compact(out)
             if @value
-                if self.class.sequence?
+                if @sequence
                     out.putU32(@value.size)
                     @value.each do |v|
                         v.to_compact(out)
@@ -143,16 +157,26 @@ module SlowBlink::Message
             elsif @optional
                 out.putNull
             else
-                raise IncompleteGroup.new "'#{self.name}' must not be null"
+                raise IncompleteGroup.new "'#{self.class.name}' must not be null"
             end
         end
 
-        private
-
-            def sequenceOfSameType(value)
-                value.each do ||
-                end
+        def to_tag
+            if @value
+                if @value.is_a? Array
+                    @value.inject("|#{self.class.name}=[") do |out,v|
+                        if @value.first != v
+                            out << ";"
+                        end
+                        out << v.to_tag
+                    end << "]"
+                else
+                    "|#{self.class.name}=#{@value.to_tag}"
+                end                
+            else
+                ""
             end
+        end
 
     end
 

data/lib/slow_blink/message/fixed.rb

@@ -24,8 +24,12 @@ module SlowBlink::Message
     # @abstract
     class FIXED
 
+        def self.type
+            @type
+        end
+
         # @private
-        def self.from_compact(input, stack)
+        def self.from_compact(input, depth)
             if value = input.getFixed(size)
                 self.new(value)
             else                    

data/lib/slow_blink/message/floating_point.rb

@@ -24,8 +24,12 @@ module SlowBlink::Message
     # @abstract
     class FLOATING_POINT
 
+        def self.type
+            @type
+        end
+
         # @private
-        def self.from_compact(input, stack)
+        def self.from_compact(input, depth)
             if value = input.getF64
                 self.new(value)
             else
@@ -58,6 +62,10 @@ module SlowBlink::Message
             out.putF64(@value)
         end
 
+        def to_tag
+            @value.to_s
+        end
+
     end
 
 end

data/lib/slow_blink/message/group.rb

@@ -21,7 +21,9 @@
 
 module SlowBlink::Message
 
-    class StaticGroup
+    class Group
+
+        attr_reader :extension
 
         # @private
         # @return [Array<Field>] group fields
@@ -41,30 +43,37 @@ module SlowBlink::Message
             @name
         end
 
+        def self.ancestorID
+            @ancestorID
+        end
+
         # @private
-        # @param input [StringIO, String] Blink compact form
-        # @param stack [Array] used to measure depth of recursion 
-        # @return [Group, nil]
-        # @raise [Error] recursion depth limit
-        def self.from_compact(input, stack)            
+        def self.from_compact(input, depth)            
 
-            fields = {}
+            value = {}
 
-            if stack.size < @maxRecursion
-                stack << self
+            if depth > 0
+                depth = depth - 1
             else
                 raise RecursionLimit
             end
 
             @fields.each do |f|
-                fields[f.name] = f.from_compact(input, stack)
+                value[f.name] = f.from_compact(input, depth)
             end
 
-            stack.pop
-            
-            self.new(fields)
+            depth = depth + 1
+
+            self.new(value)
                
         end
+        
+        def initialize(fields={}, *extension)
+            @value = {}
+            self.class.fields.each{|f|@value[f.name] = f.new}
+            set(fields)
+            @extension = extension
+        end
 
         # @api user
         # Finds Field by name and calls {Field#set}(value) 
@@ -74,7 +83,7 @@ module SlowBlink::Message
         # @raise [IndexError, TypeError]
         def []=(name, value)
             if field = @value[name]
-                field.set(value)
+                @value[name] = field.set(value)
             else
                 raise IndexError.new "field #{name} is not defined in this group"            
             end
@@ -95,219 +104,67 @@ module SlowBlink::Message
             end            
         end
 
-        # Get this group
-        # @return [self]
-        def get
-            self
-        end
-
-        # Set the contents of this group
-        #
-        # @overload set(value)
-        #   @param value [Hash{String=>Field,Numeric,String,Time,nil}] Hash of {Field} objects or literal values
-        # @overload set(value)
-        #   @param value [Group] a Hash of {Field} objects will be extracted from a Group object by calling {Group#fields}
-        # @return [self]
-        # @raise [IndexError, TypeError]
         def set(value)
-        
             if value.kind_of? Hash
                 value.each do |fn, fv|
                     if @value[fn]
-                        # replace entire field
-                        if fv.is_a? @value[fn].class
-                            @value[fn] = fv
-                        # set value of field
-                        else
-                            @value[fn].set(fv)
-                        end
+                        @value[fn] = @value[fn].set(fv)
                     else
                         raise IndexError.new "field '#{fn}' is unknown"
                     end
-                end
-            # replace @value with value from another instance of self.class
-            elsif value.kind_of? self.class
-                @value = value.fields.to_h
+                end    
             else
-                raise TypeError.new "expecting a Hash or a StaticGroup instance"
+                raise TypeError.new "expecting a Hash instance"
             end
             self
         end
 
-        # @api user
-        # Create a Group
-        #
-        # @note calls {#set}(fields)
-        # @param fields [Hash]
-        def initialize(fields={})
-            @value = {}
-            self.class.fields.each do |f|
-                @value[f.name] = f.new(nil)
-            end            
-            set(fields)        
-        end
-
-        # @return [String] Blink Protocol compact form
-        def encode_compact            
-            if self.class.id
-                to_compact("")
-            else
-                raise UntaggedGroup.new "cannot encode a group without an ID"
-            end
+        def get
+            self
         end
 
         # @private
         def to_compact(out)
-            @value.each do |fn, fv|
-                fv.to_compact(out)
-            end        
+            @value.values.each{|f|f.to_compact(out)}            
         end
 
-        protected
-
-            # Get the value hash directly
-            # @return [Hash{String => Field}]
-            def fields
-                @value
+        def encode_compact(out="".force_encoding("ASCII-8BIT"))       
+            if self.class.id
+                groupOut = String.new.putU64(self.class.id)
+                to_compact(groupOut)
+                if @extension.size > 0
+                    groupOut.putU32(@extension.size)
+                    @extension.each{|e|e.encode_compact(groupOut)}                    
+                end
+                
+                out.putU32(groupOut.size)                
+                out << groupOut                
+            else
+                raise UntaggedGroup.new "cannot encode a group without an ID"
             end
-
-    end
-    
-    class Group < StaticGroup
-
-        attr_reader :extension
-
-        def self.ancestorID
-            @ancestorID
         end
 
-        def initialize(fields={}, *extension)
-            super(fields)
-            @extension = extension
+        def to_tag_value
+            @value.values.inject(""){|out,f|out << f.to_tag}            
         end
 
-        # @private
-        def to_compact(out)
-
-            groupOut = String.new.putU64(self.class.id)
-            super(groupOut)
+        def to_tag_extension
             if @extension.size > 0
-                groupOut.putU32(@extension.size)
+                out = "|["
                 @extension.each do |e|
-                    e.to_compact(groupOut)                    
-                end
-            end
-
-            out.putU32(groupOut.size)
-            out << groupOut
-    
-        end
-        
-    end
-
-    class DynamicGroup
-
-        def self.taggedGroups
-            @taggedGroups
-        end
-
-        def self.permittedID
-            @permittedID
-        end
-
-        # @private
-        # @param input [StringIO] Blink compact form
-        # @param stack [Array] used to measure depth of recursion 
-        # @return [Group, nil]
-        # @raise [Error] recursion depth limit
-        def self.from_compact(input, stack)
-
-            group = nil
-
-            if stack.size < @maxRecursion
-                stack << self
-            else
-                raise RecursionLimit
-            end
-        
-            if input.kind_of? String
-                input = StringIO.new(input)
-            end
-
-            buf = input.getBinary
-            
-            if buf.size > 0
-
-                buf = StringIO.new(buf)
-                id = buf.getU64
-
-                if klass = @taggedGroups[id]
-
-                    if @permittedID.include? id
-
-                        group = klass.from_compact(buf, stack)
-
-                        if !buf.eof?                
-                            size = buf.getU32
-                            while group.extension.size < size do
-                                group.extension << @anyTaggedGroup.from_compact(buf, stack)
-                            end
-                        end
-
-                        if !buf.eof?
-                            raise ExtensionPadding
-                        end
-                        
-                    else
-                        raise WeakError15.new "W15: Group is known but unexpected"
+                    if e != @extension.first
+                        out << ";"
                     end
-                else
-                    raise WeakError2.new "W2: Group id #{id} is unknown"
-                end
-                
-            elsif stack.size == 1
-                raise WeakError5.new "W??: top level cannot be null"
-            else                
-                raise WeakError5.new "W5: Value cannot be null"                
-            end
-
-            stack.pop
-            group
-
-        end
-
-        def set(value)
-            if value.kind_of? Group
-                if self.class.permittedID.include? value.class.id        
-                    @value = value
-                else                        
-                    raise TypeError.new "incompatible group"
+                    out << e.to_tag
                 end
-            # native values
-            elsif value.kind_of? Hash
-                @value.set(value)
+                out << "]"
             else
-                raise
-            end
-        end
-
-        # @return [Group] contained group
-        def get
-            @value.get
-        end
-
-        # @note calls {#set}(value)
-        def initialize(value)
-            set(value)
-        end
-
-        # @private
-        def to_compact(out)
-            @value.to_compact(out)    
+                out = ""
+            end            
         end
 
-        def extension
-            @value.extension
+        def to_tag
+            "@#{self.class.name}#{to_tag_value}#{to_tag_extension}"
         end
 
     end