evt-schema 0.6.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c467a08693a41abecf0d00cece99cee5432a5c95
+  data.tar.gz: f8a24c5de56aa58868ccd13ee6719e089e9b7ce1
+SHA512:
+  metadata.gz: 1ed970585e37072610ba4a6d2dc17362faeb3d867344c025bdbe06eb7adf96f26a0b90860355c51504926c52f08c7e8f010f7b50e9bf1dbf8f68ada62153a8d9
+  data.tar.gz: 65811f0afcd628e9fcb44e189fc86ad6cf0e24c8f2a4245c0d05049cb10604624a285cdbf30bae66bcacb5c76108c1bea6a211df86981779b6a52c14aa1eeeaa

data/lib/schema/controls/data_structure.rb

@@ -0,0 +1,53 @@
+module Schema
+  module Controls
+    module DataStructure
+      def self.example
+        example = Example.new
+        example.some_attribute = 'some value'
+        example
+      end
+
+      def self.ancestors
+        example.class.ancestors
+      end
+
+      def self.attributes
+        example.attributes
+      end
+
+      def self.hash
+        example.to_h
+      end
+
+      class Example
+        include ::Schema::DataStructure
+        attribute :some_attribute
+      end
+
+      module ExtraAttributes
+        def self.data
+          {
+            :some_attribute => 'some value',
+            :some_other_attribute => 'some other value'
+          }
+        end
+      end
+
+      module ConfigureDependencies
+        def self.example
+          Example.build
+        end
+
+        class Example
+          include ::Schema::DataStructure
+
+          attr_accessor :some_dependency
+
+          def configure
+            self.some_dependency = :set
+          end
+        end
+      end
+    end
+  end
+end

data/lib/schema/controls/schema.rb

@@ -0,0 +1,126 @@
+module Schema
+  module Controls
+    module Schema
+      def self.example
+        example = Example.new
+        example.some_attribute = 'some value'
+        example.some_other_attribute = 'some other value'
+        example
+      end
+
+      def self.other_example
+        example = OtherExample.new
+        example.some_attribute = 'some value'
+        example.some_other_attribute = 'some other value'
+        example
+      end
+
+      def self.ancestors
+        example.class.ancestors
+      end
+
+      def self.attributes
+        example.attributes
+      end
+
+      def self.hash
+        example.to_h
+      end
+
+      class Example
+        include ::Schema
+        attribute :some_attribute
+        attribute :some_other_attribute
+      end
+
+      class OtherExample < Example
+      end
+
+      module Equivalent
+        def self.example
+          example = Example.new
+          example.some_attribute = 'some value'
+          example.yet_another_attribute = 'some other value'
+          example
+        end
+
+        class Example
+          include ::Schema
+          attribute :some_attribute
+          attribute :yet_another_attribute
+        end
+      end
+
+      module DefaultValue
+        class Example
+          include ::Schema
+          attribute :some_attribute, default: 'some default value'
+        end
+
+        module Proc
+          class Example
+            include ::Schema
+            attribute :some_attribute, default: proc { 'some default value' }
+          end
+        end
+      end
+
+      module Typed
+        class SomeType
+        end
+
+        class SomeSubtype < SomeType
+        end
+
+        class Example
+          include ::Schema
+          attribute :some_attribute, SomeType
+        end
+
+        module Strict
+          class Example
+            include ::Schema
+            attribute :some_attribute, SomeType, strict: true
+          end
+        end
+      end
+
+      module Duplicate
+        def self.example
+          Example.new
+        end
+
+        class Example
+          include ::Schema
+
+          attribute :some_attribute, Numeric
+          attribute :some_attribute, String
+        end
+      end
+
+      module Validation
+        def self.example
+          Example.new
+        end
+
+        def self.errors
+          [
+            "some_attribute can't be nil",
+            "some_other_attribute can't be nil"
+          ]
+        end
+
+        class Example
+          include ::Schema
+
+          attribute :some_attribute
+          attribute :some_other_attribute
+
+          module Validator
+            extend ::Schema::Validation::NilAttributes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/schema/controls.rb

@@ -0,0 +1,2 @@
+require 'schema/controls/schema'
+require 'schema/controls/data_structure'

data/lib/schema/data_structure.rb

@@ -0,0 +1,36 @@
+module Schema
+  module DataStructure
+    def self.included(cls)
+      cls.class_exec do
+        include Schema
+        extend Build
+        extend Virtual::Macro
+
+        virtual :configure
+        virtual :configure_dependencies do
+          configure
+        end
+      end
+    end
+
+    module Build
+      def build(data=nil, strict=nil)
+        data ||= {}
+        strict ||= false
+
+        new.tap do |instance|
+          set_attributes(instance, data, strict)
+          instance.configure_dependencies
+        end
+      end
+
+      def set_attributes(instance, data, strict)
+        begin
+          SetAttributes.(instance, data, strict: strict)
+        rescue SetAttributes::Attribute::Error => e
+          raise Schema::Error, e.message
+        end
+      end
+    end
+  end
+end

data/lib/schema/schema/assertions.rb

@@ -0,0 +1,26 @@
+module Schema
+  module Assertions
+    def attributes_equal?(other, attributes=nil, print: nil)
+      attributes ||= self.class.attribute_names
+
+      print = true if print.nil?
+      print ||= false
+
+      equal = self.eql?(other, attributes, ignore_class: true)
+
+      if !equal && print
+        attributes = Array(attributes)
+
+        require 'pp'
+        puts "self: #{self.class.name}"
+        pp self.attributes.select { |k, v| attributes.include? k }
+        puts "other #{other.class.name}:"
+        pp other.attributes.select { |k, v| attributes.include? k }
+        puts "attributes:"
+        attributes.each { |a| puts a.inspect}
+      end
+
+      equal
+    end
+  end
+end

data/lib/schema/schema/attribute.rb

@@ -0,0 +1,16 @@
+module Schema
+  class Attribute
+    class Error < Schema::Error; end
+    class TypeError < Schema::Attribute::Error; end
+
+    attr_reader :name
+    attr_reader :type
+    attr_reader :strict
+
+    def initialize(name, type, strict)
+      @name = name
+      @type = type
+      @strict = strict
+    end
+  end
+end

data/lib/schema/schema.rb

@@ -0,0 +1,138 @@
+module Schema
+  class Error < RuntimeError; end
+
+  def self.included(cls)
+    cls.class_exec do
+      extend AttributeMacro
+      extend AttributeList
+    end
+  end
+
+  module AttributeMacro
+    def attribute_macro(attr_name, type=nil, strict: nil, default: nil)
+      if type.nil? && !strict.nil?
+        raise Schema::Attribute::Error, "The \"#{attr_name}\" attribute is declared with the \"strict\" option but a type is not specified"
+      end
+
+      strict ||= false
+      check = nil
+
+      unless type.nil?
+        check = proc do |val|
+          unless val.nil?
+            if strict
+              raise Schema::Attribute::TypeError, "#{val.inspect} is not an instance of #{type.name}" unless val.instance_of? type
+            else
+              raise Schema::Attribute::TypeError, "#{val.inspect} is not a kind of #{type.name}" unless val.is_a? type
+            end
+          end
+        end
+      end
+
+      initialize_value = nil
+      if default.is_a? Proc
+        initialize_value = default
+      elsif !default.nil?
+        initialize_value = proc { default }
+      end
+
+      ::Attribute::Define.(self, attr_name, :accessor, check: check, &initialize_value)
+
+      attribute = attributes.register(attr_name, type, strict)
+      attribute
+    end
+    alias :attribute :attribute_macro
+  end
+
+  module AttributeList
+    def attributes
+      @attributes ||= AttributeRegistry.new
+    end
+
+    def attribute_names
+      attributes.map { |attribute| attribute.name }
+    end
+  end
+
+  class AttributeRegistry
+    def entries
+      @entries ||= []
+    end
+
+    def length
+      entries.length
+    end
+    alias :count :length
+
+    def [](index)
+      entries[index]
+    end
+
+    def map(&action)
+      entries.map(&action)
+    end
+
+    def each_with_object(obj, &action)
+      entries.each_with_object(obj, &action)
+    end
+
+    def add(name, type, strict=nil)
+      strict ||= false
+      attribute = Schema::Attribute.new(name, type, strict)
+      entries << attribute
+      attribute
+    end
+
+    def register(name, type, strict=nil)
+      remove(name)
+      add(name, type, strict)
+    end
+
+    def remove(name)
+      entries.delete_if { |entry| entry.name == name }
+    end
+
+    def attribute(name)
+      entries.find { |entry| entry.name == name }
+    end
+
+    def attribute?(name)
+      !attribute(name).nil?
+    end
+  end
+
+  def attributes
+    self.class.attributes.each_with_object({}) do |attribute, attributes|
+      attributes[attribute.name] = public_send(attribute.name)
+    end
+  end
+  alias :to_h :attributes
+
+  def ==(other, attributes=nil, ignore_class: nil)
+    attributes ||= self.class.attribute_names
+    attributes = Array(attributes)
+
+    ignore_class = false if ignore_class.nil?
+
+    if !ignore_class
+      return false if self.class != other.class
+    end
+
+    attributes.each do |attribute|
+      if attribute.is_a? Hash
+        this_attribute, other_attribute = attribute.keys.first, attribute.values.first
+      else
+        this_attribute, other_attribute = attribute, attribute
+      end
+
+      return false if public_send(this_attribute) != other.public_send(other_attribute)
+    end
+
+    true
+  end
+  alias :eql? :==
+
+  def ===(other)
+    self.eql?(other, ignore_class: true)
+  end
+end

data/lib/schema/validation/error.rb

@@ -0,0 +1,6 @@
+module Schema
+  module Validation
+    class Error < RuntimeError
+    end
+  end
+end

data/lib/schema/validation/nil_attributes.rb

@@ -0,0 +1,21 @@
+module Schema
+  module Validation
+    module NilAttributes
+      def nil_attributes
+        Validator
+      end
+
+      module Validator
+        def self.call(schema, errors=nil)
+          errors ||= []
+          schema.class.attribute_names.each do |attribute|
+            if schema.public_send(attribute).nil?
+              errors << "#{attribute} can't be nil"
+            end
+          end
+          errors.empty?
+        end
+      end
+    end
+  end
+end

data/lib/schema.rb

@@ -0,0 +1,11 @@
+require 'attribute'
+require 'set_attributes'
+require 'validate'
+require 'virtual'
+
+require 'schema/schema'
+require 'schema/schema/assertions'
+require 'schema/schema/attribute'
+require 'schema/data_structure'
+require 'schema/validation/nil_attributes'
+require 'schema/validation/error'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: evt-schema
+version: !ruby/object:Gem::Version
+  version: 0.6.0.2
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-attribute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-set_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-validate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-virtual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ntl-test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/schema.rb
+- lib/schema/controls.rb
+- lib/schema/controls/data_structure.rb
+- lib/schema/controls/schema.rb
+- lib/schema/data_structure.rb
+- lib/schema/schema.rb
+- lib/schema/schema/assertions.rb
+- lib/schema/schema/attribute.rb
+- lib/schema/validation/error.rb
+- lib/schema/validation/nil_attributes.rb
+homepage: https://github.com/eventide-project/schema
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Primitives for schema and structure
+test_files: []