slow_blink 0.0.2 → 0.0.3

data/lib/slow_blink/message/model.rb

@@ -0,0 +1,202 @@
+# 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
+
+    module Message
+
+        class Error < Exception
+        end
+
+        class Model
+
+            # @param nameOrID [String,Integer] name or id of top-level group
+            # @return [Class] anonymous class extending {DynamicGroup::CLASS} and including {DynamicGroup::INSTANCE}            
+            def [](nameOrID)
+                if nameOrID.kind_of? Integer
+                    @top.new(@top.groups.values.detect{|g|g.name == nameOrID})
+                else
+                    @top.new(@top.groups[nameOrID])
+                end                    
+            end
+
+            attr_reader :top
+
+            # Initialise a message model from a schema
+            #
+            # @param schema [Schema]
+            # @param opts [Hash]
+            def initialize(schema, **opts)
+                @schema = schema
+                @groups = {}                
+                schema.tagged.each do |id, g|
+                    @groups[id] = _model_group(false, g)                    
+                end                
+                groups = @groups
+                @top = Class.new do
+                    @opt = false
+                    @groups = groups
+                    @permitted = groups.keys
+                    extend DynamicGroup::CLASS
+                    include DynamicGroup::INSTANCE
+                end                
+            end
+
+            def decode_compact(input)
+                @top.from_compact!(input.dup)
+            end
+
+            def encode_compact(input)
+                @top.from_compact!(input)
+            end
+
+            def group(name, &block)
+                group = @top.groups.values.detect{|g|g.name == name}
+                if group                    
+                    top = @top.new(group.new(nil))
+                    top.instance_exec(top, &block)
+                    top
+                else
+                    raise
+                end
+            end
+
+            def new(&block)
+                if block.nil?
+                    raise                    
+                end
+                result = self.instance_exec(&block)
+            end    
+
+            # @private
+            #
+            # Create a model for a Group
+            #
+            # @param opt [true,false] this group is allowed to be optional
+            # @param group [SlowBlink::Group] group definition
+            # @return [Class] anonymous class extending {StaticGroup::CLASS} and including {StaticGroup::INSTANCE}            
+            def _model_group(opt, group)
+                this = self
+                klass = Class.new do
+                    @name = group.nameWithID.name
+                    @id = group.nameWithID.id
+                    @opt = opt
+                    @fields = group.fields.inject([]) do |fields, f|
+                        fields << this._model_field(f)                        
+                    end
+                    extend StaticGroup::CLASS
+                    include StaticGroup::INSTANCE
+                end            
+            end
+
+
+            # @private
+            #
+            # Create a model for a Field
+            #
+            # @param field [SlowBlink::Field] field definition
+            # @return [Class] anonymous class extending {Field::CLASS} and including {Field::INSTANCE}            
+            def _model_field(field)
+                this = self
+                klass = Class.new do
+                    @opt = field.opt?
+                    @name = field.nameWithID.name
+                    @id = field.nameWithID.id
+                    @type = this._model_type(field)
+                    include Field::INSTANCE
+                    extend Field::CLASS
+                end                
+            end
+
+            # @private
+            #
+            # Create a model for a type
+            #
+            # @param field [SlowBlink::Field] field definition (containing type)
+            # @return [Class] anonymous class extending {Field::CLASS} and including {Field::INSTANCE}      
+            def _model_type(field)
+                type = field.type
+                name = field.nameWithID.name    
+                case type.class
+                when SlowBlink::OBJECT
+                    groups = @groups
+                    permitted = @schema.tagged.keys
+                    klass = Class.new do
+                        @opt = field.opt?
+                        
+                        @groups = groups
+                        @permitted = permitted
+                        extend DynamicGroup::CLASS
+                        include DynamicGroup::INSTANCE
+                    end                               
+                when SlowBlink::REF
+                    if type.ref.kind_of? Group
+                        if type.dynamic?
+                            groups = @groups
+                            permitted = @schema.tagged.keys
+                            @schema.tagged.each do |id, g|
+                                if g.group_kind_of?(type)
+                                    permitted << id
+                                end
+                            end
+                            klass = Class.new do
+                                @name = name
+                                @opt = field.opt?
+                                @groups = groups
+                                @permitted = permitted
+                                extend DynamicGroup::CLASS
+                                include DynamicGroup::INSTANCE
+                            end                               
+                        else
+                            _model_group(field.opt?, type.ref)
+                        end
+                    else
+                        _model_type(opt, type.ref)
+                    end
+                else                        
+                    return Class.new do
+                        @opt = field.opt?
+                        @name = name
+                        @type = type
+                        extend SlowBlink::Message.const_get(type.class.name.split('::').last + "::CLASS")
+                        include SlowBlink::Message.const_get(type.class.name.split('::').last + "::INSTANCE")
+                    end                    
+                end
+            end
+
+        end
+
+    end
+
+end
+
+require "slow_blink/message/field"
+require "slow_blink/message/integer"
+require "slow_blink/message/string"
+require "slow_blink/message/binary"
+require "slow_blink/message/fixed"
+require "slow_blink/message/boolean"
+require "slow_blink/message/enumeration"
+require "slow_blink/message/floating_point"
+require "slow_blink/message/sequence"
+require "slow_blink/message/group"
+require "slow_blink/message/time"
+require "slow_blink/message/time_of_day"
+require "slow_blink/message/date"
+

data/lib/slow_blink/message/sequence.rb

@@ -0,0 +1,85 @@
+# 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 SEQUENCE
+
+        module CLASS
+        
+            def from_compact!(input)
+                value = []
+                size = input.getU32!
+                if size
+                    while out.size < size do
+                        value << @type.from_compact!(input)
+                    end
+                    self.new(value)
+                else
+                    self.new
+                end
+            end
+
+        end
+
+        module INSTANCE
+
+            # @param v [Array,nil]
+            def set(value)
+                if value
+                    if value.kind_of? Array
+                        @value = v
+                    else
+                        raise Error.new "bad type"
+                    end
+                elsif self.class.opt?
+                    @value = nil
+                else
+                    raise Error.new "value unacceptable"
+                end
+            end
+
+            def get
+                @value
+            end
+
+            # @param value [Array]
+            def initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+
+            def to_compact(out)
+                if @value                
+                    @value.inject(out.putU32(@value.size)) do |out, v|
+                        out << v.to_compact
+                    end
+                else
+                    out.putU32(nil)
+                end                
+            end
+
+        end
+
+    end
+
+end

data/lib/slow_blink/message/string.rb

@@ -0,0 +1,95 @@
+# 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 STRING
+
+        module CLASS
+
+            def name
+                @name
+            end
+
+            def opt?
+                @opt
+            end
+
+            def from_compact!(input)
+                value = input.getString!
+                if value
+                    if !@type.size or value.size <= @type.size
+                        self.new(value)
+                    else
+                        raise Error.new "W7: String 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 get
+                @value
+            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
+                    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 initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+
+            def to_compact(out)
+                out.putString(@value)
+            end
+
+        end
+        
+    end
+
+end

data/lib/slow_blink/message/time.rb

@@ -0,0 +1,78 @@
+# 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 MILLI_TIME
+
+        module CLASS
+
+            def from_compact!(input)
+                self.new(input.getI64!)
+            end
+
+        end
+
+        module INSTANCE
+
+            def set(value)
+                if value
+                    raise
+                elsif self.class.opt?
+                    @value = nil
+                else
+                    raise 
+                end
+            end
+
+            def get
+                @value
+            end
+
+            def initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+
+            def to_compact(out)
+                out.putI64(@value)
+            end
+
+        end
+    
+    end
+
+    module NANO_TIME
+        
+        module CLASS
+            
+            include SlowBlink::Message::MILLI_TIME::CLASS
+        end
+
+        module INSTANCE
+            
+            include SlowBlink::Message::MILLI_TIME::INSTANCE
+        end
+    
+    end
+
+end

data/lib/slow_blink/message/time_of_day.rb

@@ -0,0 +1,132 @@
+# 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 TIME_OF_DAY_MILLI
+
+        module CLASS
+
+            def from_compact!(input)
+                self.new(input.get32!)
+            end
+        
+        end
+
+        module INSTANCE
+
+            def set(value)
+                if value
+                    if value.kind_of? Integer
+                        if value < 86400000
+                            @value = value                            
+                        else
+                            raise Error.new "input out of range"
+                        end
+                    elsif value.kind_of? Time
+                        @value = value.to_i
+                    else
+                        raise "what is this?"                        
+                    end         
+                elsif self.class.opt?
+                    @value = nil
+                else
+                    raise
+                end
+            end
+
+            def get
+                @value
+            end
+
+            def initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+
+            # @private
+            def to_compact(out)
+                out.putU32(@value)
+                
+            
+       
+            end        
+        
+        end
+    
+    end
+
+    module TIME_OF_DAY_NANO
+    
+        module CLASS
+            
+            def from_compact!(input)
+                self.new(input.getU64!)
+            end
+            
+        end
+
+        module INSTANCE
+
+        
+            def set(value)
+                if value
+                    if value.kind_of? Integer
+                        if value < 86400000000000
+                            @value = value                            
+                        else
+                            raise Error.new "input out of range"
+                        end
+                    elsif value.kind_of? Time
+                        @value = value.to_i
+                    else
+                        raise "what is this?"                        
+                    end         
+                elsif self.class.opt?
+                    @value = nil
+                else
+                    raise
+                end
+            end
+
+            def get
+                @value
+            end
+        
+            def initialize(value)
+                if value
+                    set(value)
+                else
+                    @value = nil
+                end
+            end
+
+            # @private
+            def to_compact(out)
+                out.putU64(@value) 
+            end        
+        
+        end
+        
+    end
+
+end

data/lib/slow_blink/name_with_id.rb

@@ -34,8 +34,9 @@ module SlowBlink
         # @param name [String]
         # @param id [nil,Integer]
         def initialize(name, id)
+            @annotes = {}
             @name = name
-            @id = id
+            @id = id            
         end
 
         # @private