slow_blink 0.0.1 → 0.0.2

data/lib/slow_blink/incremental_annotation.rb

@@ -0,0 +1,91 @@
+# 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
+
+    # Blink Specification 7.3
+    class IncrementalAnnotation
+
+        attr_reader :ref
+        attr_reader :annotes
+        attr_reader :location
+
+        # @private
+        #
+        # @param ref [SchemaRef, DefinitionRef, DefinitionTypeRef, FieldRef, FieldTypeRef] annotation target
+        # @param annotations [Array<Integer,Annotation>]
+        # @param location [String]    
+        def initialize(ref, annotes, location)
+            @ref = ref
+            @annotes = annotes
+            @location = location
+            @schema = nil
+        end
+
+        # @private
+        #
+        # Apply annotes to targets
+        #
+        # @macro common_link
+        def link(schema, stack=[])
+            if @schema != schema
+                @schema = nil
+                case @ref.class
+                when SchemaRef
+                    schema.annote(@annotes)
+                    @schema = schema
+                when DefinitionRef
+                    object = schema.symbol(ref.qName)
+                    if object
+                        object.nameWithID.annote(@annotes)
+                        @schema = schema
+                    end
+                when DefinitionTypeRef
+                    object = schema.symbol(ref.qName)
+                    if object
+                        object.enumOrType.annote(@annotes)
+                        @schema = schema
+                    end
+                when FieldRef
+                    object = schema.symbol(ref.qName)
+                    if object
+                        field = object.field(ref.name)
+                        if field
+                            field.nameWithID.annote(@annotes)
+                            @schema = schema
+                        end                    
+                    end                
+                when FieldTypeRef
+                    object = schema.symbol(ref.qName)
+                    if object
+                        field = object.field(ref.name)
+                        if field
+                            field.type.annote(@annotes)
+                            @schema = schema
+                        end                    
+                    end                
+                else
+                    raise "unknown component reference".freeze
+                end                    
+            end
+            @schema                
+        end        
+        
+    end
+end

data/lib/slow_blink/message.rb

@@ -0,0 +1,43 @@
+module SlowBlink
+
+    class Message
+
+        # Create Message
+        #
+        # @param schema [Schema]
+        # @param input [Hash] Blink JSON Format
+        # @param **opts [Hash] options
+        def initialize(schema, input, **opts)
+            @schema = schema
+            @input = input
+            @input.each do |i|
+                @schema.group(type).validate(i)
+            end            
+        end
+
+        # Convert compact form encoding to a message according to schema
+        #
+        # @param schema [Schema]
+        # @param input [String] compact form encoding
+        # @return [Message]
+        def self.from_compact(schema, input)
+            raise
+        end
+
+        # Convert message to compact form encoding
+        #
+        # @return [String] compact form encoding
+        def to_compact
+            @schema.group(@input["$group"]).encode_compact(@input)
+        end
+
+        # Convert message to Blink JSON format
+        #
+        # @return [String] Blink JSON format
+        def to_json
+            @input
+        end
+            
+    end
+
+end

data/lib/slow_blink/name_with_id.rb

@@ -0,0 +1,49 @@
+# 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 NameWithID
+
+        include Annotatable
+
+        # @return [String]
+        attr_reader :name
+
+        # @return [Integer]
+        # @return [nil]
+        attr_reader :id
+
+        # @private
+        #
+        # @param name [String]
+        # @param id [nil,Integer]
+        def initialize(name, id)
+            @name = name
+            @id = id
+        end
+
+        # @private
+        #
+        # @param value [Integer]        
+        def id=(value)
+            @id = id
+        end
+        
+    end
+end

data/lib/slow_blink/schema.rb

@@ -0,0 +1,135 @@
+# 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.
+
+require 'slow_blink/annotatable'
+
+# @!macro [new] common_link
+#   
+#   Resolve symbols to definitions in schema
+#
+#   @param schema [Schema] schema to link
+#   @param stack [Array]
+#
+#   @return [Schema] linked
+#   @return [nil] not linked
+#
+
+module SlowBlink
+
+    class Schema
+
+        include Annotatable
+
+        # @!method self.parse(input, **opts)
+        #
+        #   Initialise a Schema object from Blink Schema input string
+        #
+        #   @param input [String] Blink Schema
+        #   @param opts [Hash] options
+        #   @option opts [String] :fileName file input originated from (for error messages)
+        #   @return [Schema]
+
+        # @param namespace [nil,String]
+        # @param defs [Array<Definition>]
+        def initialize(namespace, defs)
+            @nameWithID = NameWithID.new(nil,nil)
+            @annotes = []
+            @groups = {}
+            errors = 0
+            
+            if namespace
+                @namespace = namespace
+            else
+                @namespace = nil
+            end
+
+            @defs = {}
+
+            # populate table of definitions
+            defs.each do |d|
+                if !d.is_a? IncrementalAnnotation
+                    if @defs[d.nameWithID.name]
+                        puts "#{d.location}: error: duplicate definition name"
+                        errors += 1
+                    else
+                        @defs[d.nameWithID.name] = d
+                    end
+                end
+            end
+
+            # now apply incremental annotation
+            defs.each do |d|
+                if d === IncrementalAnnotation
+                    d.link(schema)
+                end
+            end
+
+            # now link the definitions
+            @defs.each do |name, d|
+                if !d.link(self)
+                    errors += 1
+                end
+            end
+            
+            if errors > 0
+                raise Error.new "#{errors} errors"
+            end
+            
+        end
+
+        # @param name [String] definition or group name
+        # @return [Definition]
+        # @return [Group]
+        def symbol(name)
+            @defs[name]            
+        end
+
+        # @param nameOrID [String,Integer] group name or id
+        # @return [Group] group exists
+        # @return [nil] group does not exist
+        def group(nameOrID)
+            if nameOrID.kind_of? String
+                @groups[nameOrID]
+            else
+                @groups.values.detect{|g|g.nameWithID.id == nameOrID}
+            end
+        end
+
+    end    
+
+end
+
+require 'slow_blink/compact_encoder'
+require 'slow_blink/error'
+require 'slow_blink/version'
+require 'slow_blink/annotation'
+require 'slow_blink/incremental_annotation'
+require 'slow_blink/group'
+require 'slow_blink/field'
+require 'slow_blink/component_reference'
+require 'slow_blink/definition'
+require 'slow_blink/type'
+require 'slow_blink/enumeration'
+require 'slow_blink/sym'
+require 'slow_blink/name_with_id'
+require 'slow_blink/ext_schema_parser'
+require 'slow_blink/message'
+
+
+

data/lib/slow_blink/sym.rb

@@ -0,0 +1,54 @@
+# 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 Sym
+
+        include Annotatable
+
+        # @return [String]
+        attr_reader :location
+
+        # @return [String]
+        attr_reader :name
+
+        # @return [Integer]
+        attr_reader :val
+
+        # @private
+        #
+        # @param name [String]
+        # @param val [nil,Integer] explicit value
+        # @param location [String]
+        def initialize(name, val, location)
+            @name = name
+            @val = val
+            @annotes = {}
+            @location = location
+        end
+
+        # @private
+        #
+        # @macro common_link
+        def link(schema, stack=[])
+            @schema = schema
+        end
+        
+    end
+end