slow_blink 0.0.1 → 0.0.2

data/lib/slow_blink/annotatable.rb

@@ -0,0 +1,46 @@
+# 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 Annotatable
+
+        # @return [Array<Annotation>]
+        attr_reader :annotes
+
+        # @private
+        #
+        # @param annotes [Array<Annotation,Integer>]
+        def annote(annotes)
+            annotes.each do |a|
+                if a.is_a? Annotation
+                    if @annotes[a.id]
+                        puts "#{a.location}: warning: overriding previous annotation for id '#{a.id}'"
+                    end
+                    @annotes[a.id] = a                    
+                else
+                    if @nameWithID.id
+                        puts "#{a.location}: warning: overriding previous id"
+                    end
+                    @nameWithID.id = a                    
+                end
+            end
+        end
+
+    end
+end

data/lib/slow_blink/annotation.rb

@@ -0,0 +1,38 @@
+# 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 Annotation
+
+        attr_reader :location
+        attr_reader :id
+        attr_reader :literal
+        
+        # @param id [String] any string
+        # @param literal [String] any string
+        # @param location [String]
+        def initialize(id,literal,location)
+            @id = id
+            @literal = literal
+            @location = location
+        end
+
+    end
+end
+

data/lib/slow_blink/compact_encoder.rb

@@ -0,0 +1,97 @@
+# 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.
+
+# SlowBlink
+module SlowBlink
+
+    module CompactEncoder
+
+        # @return [String]
+        def self.putNull
+            "\x40"
+        end
+        
+        # @return [String]
+        def self.putPresent
+            "\x01"
+        end
+
+        def self.putBool(value)
+            (value) ? "\x01" : "\x00"
+        end
+
+        # @param value [Float]
+        # @return [String]
+        def self.putF64(value)
+            putVLC([value].pack("G").unpack("Q<").first)
+        end
+
+        def self.putString(value)
+            putVLC(value.size) + value
+        end
+
+        def self.putBinary(value)
+            putVLC(value.size) + value.to_s
+        end
+
+        def self.putFixed(value)
+            value.to_s
+        end
+
+
+        
+
+            
+            # @private
+            #
+            # @param value [Integer] unsigned integer
+            # @return [Integer] bytes to encode as VLC
+            def self.getSizeUnsigned(value)                
+            end
+
+            # @private
+            #
+            # @param value [Integer] signed integer
+            # @return [Integer] bytes to encode as VLC
+            def self.getSizeSigned(value)                
+            end
+
+            # @private
+            #
+            # @param value [Integer] signed or unsigned integer
+            # @param opts [Hash] option
+            # @option opts [Symbol] :signed value is a signed integer
+            def self.putVLC(value, **opts)
+                bytes = opts[:signed] ? getSizeSigned(value) : getSizeUnsigned(value)
+                case bytes
+                when 1
+                    [value].pack("C")
+                when 2
+                    [0x80 | value].pack("S<")
+                else
+                    out = [0xc0 | bytes]
+                    while out.size < (bytes - 1) do
+                        out << (value >> 8)
+                    end
+                    out.pack("S<C#{bytes-2}")                                                        
+                end                    
+            end
+    end
+
+end

data/lib/slow_blink/component_reference.rb

@@ -0,0 +1,50 @@
+# 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
+
+    # SCHEMA
+    class SchemaRef
+    end
+
+    # qName
+    class DefinitionRef < SchemaRef
+        # @param qName [String] name of the definition to annotate
+        def initialize(qName)
+            @qName = qName
+        end
+    end
+
+    # qName.TYPE
+    class DefinitionTypeRef < DefinitionRef
+    end
+
+    # qName.name
+    class FieldRef < SchemaRef
+        def initialize(qName, name)
+            @qName = qName
+            @name = name
+        end
+    end
+
+    # qName.name.TYPE
+    class FieldTypeRef < FieldRef
+    end
+
+end

data/lib/slow_blink/definition.rb

@@ -0,0 +1,57 @@
+# 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 Definition
+
+        include Annotatable
+        extend CompactEncoder
+
+        # @return [String]
+        attr_reader :location
+
+        # @return [String]
+        attr_reader :nameWithID
+
+        # @return [Enumeration]
+        # @return [Type]
+        attr_reader :enumOrType
+
+        # @private
+        #
+        # @param nameWithID [NameWithID]
+        # @param enumOrType [Enumeration, Type]
+        # @param location [String]
+        def initialize(nameWithID, enumOrType, location)
+            @annotes = {}
+            @schema = nil
+            @enumOrType = enumOrType
+            @location = location
+            @nameWithID = nameWithID
+        end
+
+        # @private
+        #
+        # @!macro common_link
+        def link(schema, stack=[])
+            @schema = @enumOrType.link(schema, stack << self)
+        end
+
+    end
+end

data/lib/slow_blink/enumeration.rb

@@ -0,0 +1,105 @@
+# 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 Enumeration
+
+        include Annotatable
+        extend CompactEncoder
+
+        # @private
+        #
+        # @param syms [Array<Sym>] symbol list
+        def initialize(syms)
+            @annotes = {}
+            @rawSyms = syms
+            @syms = {}
+            @schema = nil       
+        end
+
+        def ===(other)
+            self.class == other.class            
+        end
+
+        # @private
+        #
+        # @macro common_link
+        def link(schema, stack=[])
+            if @schema != schema
+                @schema = nil
+                value = 0
+                errors = 0
+                @syms = {}                        
+                @rawSyms.each do |s|
+                    if @syms[s.name]
+                        puts "#{s.location}: error: duplicate name"
+                        errors += 1
+                    else
+                        if s.val
+                            if @syms.values.include? s.val
+                                puts "#{s.location}: error: duplicate value"
+                                errors += 1
+                            else
+                                value = s.val + 1
+                            end                        
+                        else
+                            @syms[s.name] = value
+                            value += 1
+                        end
+                    end
+                end
+                if errors == 0
+                    @schema = schema
+                end
+            end
+            @schema            
+        end
+
+        # @param nameOrVal [String,Integer]
+        # @return [Sym]
+        # @return [nil]
+        def sym(nameOrVal)
+            if key.kind_of? String
+                @syms[key.to_s]
+            else
+                @syms.detect{|s|s.val == s.to_i}
+            end
+        end
+
+        # @private
+        def validate(input)
+            if sym(input)
+               true
+            else
+                raise
+            end
+        end
+
+        # @private
+        def encode_compact(value, **opts)
+            if opts[:opt]
+                putPresent + putVLC(value)
+            else
+                putVLC(value)
+            end
+        end
+
+    end
+end

data/lib/slow_blink/error.rb

@@ -0,0 +1,4 @@
+module SlowBlink
+    class Error < Exception
+    end
+end

data/lib/slow_blink/field.rb

@@ -0,0 +1,82 @@
+# 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 Field
+        
+        include Annotatable
+        extend CompactEncoder
+
+        # @return [String]
+        attr_reader :location
+
+        # @return [Type]
+        attr_reader :type
+
+        # @return [NameWithID]
+        attr_reader :nameWithID
+
+        # @return [true] field is optional
+        # @return [false] field is mandatory
+        def opt?
+            @opt
+        end
+
+        # @private
+        #
+        # @param nameWithID [NameWithID]
+        # @param type   [Type]
+        # @param opt    [true,false] field is optional?
+        # @param location [String]
+        def initialize(nameWithID, type, opt, location)
+            @annotes = {}
+            @schema = nil
+            @type = type
+            @opt = opt
+            @location = location
+            @nameWithID = nameWithID
+        end
+
+        # @private
+        #
+        # @!macro common_link
+        def link(schema,stack=[])
+            if @schema != schema
+                @schema = nil
+                if @type.link(schema, stack << self)
+                    @schema = schema
+                end
+            end
+            @schema
+        end
+
+        # @private
+        def encode_compact(value, **opts)
+            if value[name]
+                @type.encode_compact(value[:name], opt: @opt)
+            elsif @opt
+                putNull
+            else
+                raise
+            end
+        end
+        
+    end
+end

data/lib/slow_blink/group.rb

@@ -0,0 +1,129 @@
+# 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 Group
+
+        include Annotatable
+        extend CompactEncoder
+
+        # @return [String]
+        attr_reader :location
+
+        # @return [NameWithID]
+        attr_reader :nameWithID
+
+        # @private
+        #
+        # @param nameWithID [NameWithID]
+        # @param superGroup [REF, nil]
+        # @param fields [Array<Field>]
+        # @param location [String]
+        def initialize(nameWithID, superGroup, fields, location)
+            @annotes = {}
+            @schema = nil
+            @superGroup = superGroup
+            @rawFields = fields
+            @location = location
+            @fields = []
+            @nameWithID = nameWithID
+        end
+        
+        # @private
+        #
+        # @macro common_link
+        def link(schema,stack=[])
+            if @schema != schema
+                errors = 0
+                @schema = nil
+                @fields = {}
+                if !@superGroup or (@superGroup and @superGroup.link(schema, stack << self))                    
+                    if !@superGroup or @superGroup.value.is_a?(Group)
+                        if @superGroup
+                            @fields.merge(@superGroup.value.fields)
+                        end
+                        @rawFields.each do |f|
+                            if @fields[f.nameWithID.name]
+                                puts "#{f.location}: error: field with duplicate name '#{f.nameWithID.name}'"
+                                errors += 1
+                            else
+                                if f.link(schema, stack.dup << self)
+                                    @fields[f.nameWithID.name] = f
+                                else
+                                    errors += 1
+                                end
+                            end
+                        end
+                        if errors == 0
+                            @schema = schema
+                        end
+                    else
+                        puts "#{@superGroup.location}: error: superGroup must be a group"
+                    end
+                end
+            end
+            @schema            
+        end
+
+        # @param name [String] name of field
+        # @return [Field] field exists
+        # @return [nil] field does not exist
+        def field(name)
+            @fields[name]
+        end
+
+        def fields
+            @fields
+        end
+
+        # @private
+        def validate(value)
+            if value.kind_of? Hash
+                if value["$type"] == @nameWithID.name
+                    @fields.each do |name,f|
+                        f.validate(value[name])
+                    end
+                    true
+                else
+                    raise
+                end
+            end
+        end
+
+        # @private
+        #
+        # @param value [Hash] Blink JSON format
+        # @param opts [Hash] options
+        # @option opts [Symbol] :dynamic encode as dynamic group
+        # @return [String] compact format
+        def encode_compact(value, **opts)
+            out = ""
+            @fields.each do |name, f|
+                out << f.encode_compact(value)
+            end
+            if opts[:dynamic]
+                putVLC(@nameWithID.id) + putVLC(out.size) + out
+            else
+                out
+            end
+        end
+        
+    end
+end