slow_blink 0.0.2 → 0.0.3

data/lib/slow_blink/incremental_annotation.rb

@@ -22,17 +22,17 @@ module SlowBlink
     # Blink Specification 7.3
     class IncrementalAnnotation
 
-        attr_reader :ref
+        attr_reader :componentReference
         attr_reader :annotes
         attr_reader :location
 
         # @private
         #
-        # @param ref [SchemaRef, DefinitionRef, DefinitionTypeRef, FieldRef, FieldTypeRef] annotation target
+        # @param componentReference [SchemaRef, DefinitionRef, DefinitionTypeRef, FieldRef, FieldTypeRef] annotation target
         # @param annotations [Array<Integer,Annotation>]
         # @param location [String]    
-        def initialize(ref, annotes, location)
-            @ref = ref
+        def initialize(componentReference, annotes, location)
+            @componentReference = componentReference
             @annotes = annotes
             @location = location
             @schema = nil
@@ -42,50 +42,104 @@ module SlowBlink
         #
         # Apply annotes to targets
         #
-        # @macro common_link
-        def link(schema, stack=[])
-            if @schema != schema
-                @schema = nil
-                case @ref.class
-                when SchemaRef
-                    schema.annote(@annotes)
+        # @param schema [Schema]
+        # @param namespace [Namespace] the namespace this annotation was defined in
+        #
+        def apply(schema, namespace)
+            if @schema.nil?
+                case @componentReference.class
+                when SchemaRef # this actually refers to the Namespace
+                    namespace.annote(@annotes)
                     @schema = schema
                 when DefinitionRef
-                    object = schema.symbol(ref.qName)
+                    object = schema.resolve(@componentReference.namespace, @componentReference.name)
                     if object
-                        object.nameWithID.annote(@annotes)
+                        object.annote(@annotes)
                         @schema = schema
                     end
                 when DefinitionTypeRef
-                    object = schema.symbol(ref.qName)
+                    object = schema.resolve(@componentReference.namespace, @componentReference.name)
                     if object
-                        object.enumOrType.annote(@annotes)
+                        object.type.annote(@annotes)
                         @schema = schema
                     end
                 when FieldRef
-                    object = schema.symbol(ref.qName)
+                    object = schema.resolve(@componentReference.namespace, @componentReference.name)
                     if object
-                        field = object.field(ref.name)
+                        field = object.field(@componentReference.subname)
                         if field
-                            field.nameWithID.annote(@annotes)
+                            field.annote(@annotes)
                             @schema = schema
                         end                    
                     end                
                 when FieldTypeRef
-                    object = schema.symbol(ref.qName)
+                    object = schema.resolve(@componentReference.namespace, @componentReference.name)
                     if object
-                        field = object.field(ref.name)
+                        field = object.field(@componentReference.subname)
                         if field
                             field.type.annote(@annotes)
                             @schema = schema
                         end                    
                     end                
                 else
-                    raise "unknown component reference".freeze
+                    raise "unknown component reference #{@componentReference.class}".freeze
                 end                    
             end
             @schema                
         end        
         
     end
+
+    # SCHEMA
+    class SchemaRef
+        def self.===(other)
+            self == other
+        end
+    end
+
+    # qName
+    class DefinitionRef < SchemaRef
+        attr_reader :namespace
+        attr_reader :name
+        attr_reader :qname
+        # @param qName [String] name of the definition to annotate
+        def initialize(qname)
+            @qname = qname
+            if qname.split(":").size == 1
+                @namespace = nil
+                @name = qname                
+            else                
+                @namespace = qname.split(":").first
+                @name = qName.split(":").last
+            end
+        end
+    end
+
+    # qName.TYPE
+    class DefinitionTypeRef < DefinitionRef
+    end
+
+    # qName.name
+    class FieldRef < SchemaRef
+        attr_reader :namespace
+        attr_reader :name
+        attr_reader :qname
+        attr_reader :subname
+        def initialize(qname, name)
+            @qname = qname
+            if qname.split(":").size == 1
+                @namespace = nil
+                @name = qname                
+            else                
+                @namespace = qname.split(":").first
+                @name = qName.split(":").last
+            end
+            @subname = name
+        end
+    end
+
+    # qName.name.TYPE
+    class FieldTypeRef < FieldRef
+    end
+    
 end

data/lib/slow_blink/integer.rb

@@ -0,0 +1,65 @@
+# 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
+
+    class INTEGER < Type
+    end
+
+        # Blink Specification 3.1
+    class I8 < INTEGER
+        RANGE = Range.new(-128, 127)
+    end
+
+    # Blink Specification 3.1
+    class I16 < INTEGER
+        RANGE = Range.new(-32768, 32767)
+    end
+
+    # Blink Specification 3.1
+    class I32 < INTEGER
+        RANGE = Range.new(-2147483648, 2147483647)
+    end
+
+    # Blink Specification 3.1
+    class I64 < INTEGER
+        RANGE = Range.new(-9223372036854775808, 9223372036854775807)
+    end
+
+    # Blink Specification 3.1
+    class U8 < INTEGER
+        RANGE = Range.new(0, 0xff)
+    end
+
+    # Blink Specification 3.1
+    class U16 < INTEGER
+        RANGE = Range.new(0, 0xffff)
+    end
+
+    # Blink Specification 3.1
+    class U32 < INTEGER
+        RANGE = Range.new(0, 0xffffffff)
+    end
+
+    # Blink Specification 3.1
+    class U64 < INTEGER
+        RANGE = Range.new(0, 0xffffffffffffffff)
+    end
+
+end

data/lib/slow_blink/message/binary.rb

@@ -0,0 +1,87 @@
+# 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
+
+    module BINARY
+
+        module CLASS
+
+            def 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)
+                else
+                    raise Error.new "W5: Value cannot be null"
+                end
+            end
+
+            def size
+                @type.size
+            end
+
+        end
+
+        module INSTANCE
+
+            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
+                    else
+                        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 to_compact(out)
+                out.putBinary(@value)
+            end
+
+        end
+        
+    end
+
+end

data/lib/slow_blink/message/boolean.rb

@@ -0,0 +1,68 @@
+# 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
+
+    module BOOLEAN
+
+        module CLASS
+
+            def from_compact!(input)
+                self.new(input.getBool!)
+            end
+
+        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
+                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 to_compact(out)
+                out.putBool(@value)
+            end
+
+        end
+
+    end
+
+end

data/lib/slow_blink/message/date.rb

@@ -0,0 +1,33 @@
+# 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
+
+    module DATE
+
+        module CLASS
+        end
+
+        module INSTANCE
+        end
+    
+    end
+
+end
+    

data/lib/slow_blink/message/decimal.rb

@@ -0,0 +1,25 @@
+# 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
+
+    module DECIMAL
+    end
+
+end

data/lib/slow_blink/message/enumeration.rb

@@ -0,0 +1,69 @@
+# 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
+
+    module ENUMERATION
+
+        module CLASS
+
+            def from_compact!(input)
+                self.new(input.getU32!)
+            end
+
+        end
+
+        module INSTANCE
+
+            # @param v [String]
+            def set(value)
+                if value
+                    if self.symbols[value]
+                        @value = self.class.symbols[value]
+                    else
+                        raise Error.new "symbol '#{value}' not defined in enumeration"
+                    end                    
+                elsif self.class.opt?
+                    @value = nil
+                else
+                    raise Error.new "field may not be null"
+                end
+            end
+
+            def get
+                @value
+            end
+
+            def initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+            
+            def to_compact(out)
+                out.putU32(@value ? self.class.symbols[@value] : nil)
+            end
+
+        end
+    
+    end
+
+end

data/lib/slow_blink/message/field.rb

@@ -0,0 +1,73 @@
+# 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
+
+    module Field
+
+        module CLASS
+        
+            # @return [true,false] field is optional?
+            def opt?
+                @opt
+            end
+
+            # @return [String] field name
+            def name
+                @name
+            end
+
+            # @return [Integer,nil] field ID
+            def id
+                @id
+            end
+
+            def type
+                @type
+            end
+
+            def from_compact!(input)
+                @type.from_compact!(input)
+            end
+
+        end
+
+        module INSTANCE
+
+            def initialize(value)
+                @value = self.class.type.new(value)            
+            end
+
+            def set(value)
+                @value.set(value)            
+            end
+
+            def get
+                @value.get
+            end
+
+            def to_compact(out)
+                @value.to_compact(out)
+            end
+
+        end
+
+    end
+
+end

data/lib/slow_blink/message/fixed.rb

@@ -0,0 +1,84 @@
+# 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
+
+    module FIXED
+
+        module CLASS
+
+            def from_compact!(input)
+                if opt?
+                    self.new(input.getFixedOptional!)
+                else                    
+                    self.new(input.getFixed!)
+                end
+            end
+
+            def size
+                @type.size
+            end
+
+        end
+
+        module INSTANCE
+
+            def set(value)
+                if value
+                    if value.kind_of? String
+                        if value.size == self.class.size
+                            @value = value
+                        else
+                            raise Error.new "must be #{@size} bytes"
+                        end
+                    else
+                        raise "expecting string"
+                    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 to_compact(out)
+                if self.opt?
+                    out.putFixedOptional(@value)
+                else
+                    out.putFixed(@value)
+                end
+            end
+
+        end
+        
+    end
+
+end