structor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 028ef9d7b64aa2cdc8bd3b0089dc1f065e7badac
+  data.tar.gz: 9c27fe9ffa1caa86d8093f7dd16974d4d91b07c7
+SHA512:
+  metadata.gz: 0b61bf5673a7dbd0026febc7aed61c814b5eda2d0d23035ffec238120c9ae9394bc14a3c69393e0d477309e053641ce23b827d1fafca5a347bc6589b1f1b230a
+  data.tar.gz: 62cb26bfa089c4e6cd9ea2983c82434a181a131139e97adfbe4184b32aaaa8bd78a3c7a4cf50df0d165c0214c3048df0a72eb0f6088fee0e7cd82d11065455ac

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Kuznietsov
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,29 @@
+# Structor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/structor.rb

@@ -0,0 +1,11 @@
+require "structor/version"
+
+require 'structor/type'
+require 'structor/builder'
+require 'structor/node'
+
+module Structor
+  def self.define(&block)
+    Node.new(:hash, true, &block)
+  end
+end

data/lib/structor/builder.rb

@@ -0,0 +1,18 @@
+module Structor
+  class Builder
+    attr_accessor :nodes
+
+    def initialize(&block)
+      @nodes = {}
+      instance_eval(&block)
+    end
+
+    def requires(name, type = :hash, &block)
+      @nodes[name] = Node.new(type, true, &block)
+    end
+
+    def optional(name, type = :hash, &block)
+      @nodes[name] = Node.new(type, false, &block)
+    end
+  end
+end

data/lib/structor/node.rb

@@ -0,0 +1,61 @@
+require 'set'
+
+module Structor
+  class Node
+    attr_reader :required
+
+    def initialize(type, required, &block)
+      @type = Type.new(type)
+      @required = required
+      @children = block_given? ? Builder.new(&block).nodes : []
+      @errors = []
+    end
+
+    def check(structure)
+      clear_errors
+
+      if @type.check(structure)
+        if @children.any? && structure.is_a?(Hash)
+          key_set = structure.keys.to_set
+
+          unless required_keys <= key_set
+            @errors << "missing keys: #{(required_keys - key_set).to_a}"
+          end
+
+          unless key_set <= permitted_keys
+            @errors << "excess keys: #{(key_set - permitted_keys).to_a}"
+          end
+
+          structure.each { |k, v| @children[k] && @children[k].check(v) }
+        end
+      else
+        @errors << "invalid type: expected #{@type.describe}, "\
+          "got #{structure.class.name}"
+      end
+
+      errors.empty?
+    end
+
+    def errors
+      @errors + @children.map do |key, node|
+        node.errors.map { |e| "#{key.inspect} => #{e}" }
+      end.flatten
+    end
+
+    def clear_errors
+      @errors.clear
+      @children.each { |k, v| v.clear_errors }
+    end
+
+    private
+
+    def permitted_keys
+      @permitted_keys ||= @children.keys.to_set
+    end
+
+    def required_keys
+      @required_keys ||=
+        @children.select { |k, v| v.required }.map(&:first).to_set
+    end
+  end
+end

data/lib/structor/type.rb

@@ -0,0 +1,25 @@
+module Structor
+  class Type
+    def initialize(specification)
+      @specification = Array(specification)
+        .map { |type| TYPE_MAP[type] || type }
+        .flatten
+    end
+
+    TYPE_MAP = {
+      string: String,
+      number: Numeric,
+      array: Array,
+      hash: Hash,
+      boolean: [TrueClass, FalseClass]
+    }
+
+    def check(value)
+      @specification.any? { |type| value.is_a?(type) }
+    end
+
+    def describe
+      @specification.map(&:name).join('|')
+    end
+  end
+end

data/lib/structor/version.rb

@@ -0,0 +1,3 @@
+module Structor
+  VERSION = "0.0.1"
+end

data/spec/builder_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Structor::Builder do
+  it 'provides DSL to define structure' do
+    builder = Structor::Builder.new do
+      requires :node_1, :boolean
+      optional :node_2, :string
+      requires :node_3 do
+        requires :node_4, :array
+        optional :node_5, :number
+      end
+    end
+    expect(builder.nodes.size).to eq 3
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'structor'

data/spec/structor_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Structor do
+  let(:structure) do
+    Structor.define do
+      requires :node_1, :boolean
+      requires 'node_2', :string
+      optional :node_3, :array
+      requires :node_4 do
+        requires :node_5 do
+          requires :node_6, [String, Fixnum]
+          optional 7, [Hash, Array]
+        end
+      end
+      optional :node_8, [:hash, Object] do
+        requires :node_9, :string
+      end
+    end
+  end
+
+  let(:valid_data_1) do
+    { node_1: false,
+      'node_2' => 'ok',
+      node_3: [1, 2, 3],
+      node_4: { node_5: {
+        node_6: 100,
+        7 => []
+      }},
+      node_8: { node_9: 'ok' }}
+  end
+
+  let(:valid_data_2) do
+    { node_1: true,
+      'node_2' => '',
+      node_4: { node_5: {
+        node_6: '' }},
+        node_8: :symbol }
+  end
+
+  let(:invalid_data_1) do
+    { node_1: 1,
+      node_2: 'ok',
+      node_3: {},
+      node_4: { node_5: 'str' },
+      node_8: { node_9: 'ok',
+                node_10: 'extra' }}
+  end
+
+  it 'check valid data structures' do
+    expect(structure.check(valid_data_1)).to be_true
+    expect(structure.check(valid_data_2)).to be_true
+  end
+
+  it 'returns errors for invalid data' do
+    expect(structure.check(invalid_data_1)).to be_false
+    expect(structure.errors).to eq([
+      'missing keys: ["node_2"]',
+      'excess keys: [:node_2]',
+      ':node_1 => invalid type: expected TrueClass|FalseClass, got Fixnum',
+      ':node_3 => invalid type: expected Array, got Hash',
+      ':node_4 => :node_5 => invalid type: expected Hash, got String',
+      ':node_8 => excess keys: [:node_10]'])
+  end
+
+  it 'clears errors from previous check' do
+    structure.check(invalid_data_1)
+    expect(structure.check(valid_data_1)).to be_true
+    expect(structure.errors).to be_empty
+  end
+end

data/spec/type_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Structor::Type do
+  it 'checks type' do
+    expect(Structor::Type.new(Array).check([])).to be_true
+    expect(Structor::Type.new(Fixnum).check(1)).to be_true
+    expect(Structor::Type.new(Hash).check([])).to be_false
+    expect(Structor::Type.new(TrueClass).check(false)).to be_false
+  end
+
+  it 'maps symbol to type' do
+    expect(Structor::Type.new(:string).check('test')).to be_true
+    expect(Structor::Type.new(:hash).check({})).to be_true
+    expect(Structor::Type.new(:array).check([])).to be_true
+    expect(Structor::Type.new(:number).check(42)).to be_true
+    expect(Structor::Type.new(:number).check(-1.01)).to be_true
+    expect(Structor::Type.new(:boolean).check(true)).to be_true
+    expect(Structor::Type.new(:boolean).check(false)).to be_true
+  end
+
+  it 'checks for multiple types' do
+    expect(Structor::Type.new([Array, :hash]).check([])).to be_true
+    expect(Structor::Type.new([Array, :hash]).check({})).to be_true
+    expect(Structor::Type.new([TrueClass, FalseClass]).check(true)).to be_true
+    expect(Structor::Type.new([TrueClass, FalseClass]).check(false)).to be_true
+  end
+end

data/structor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structor"
+  spec.version       = Structor::VERSION
+  spec.authors       = ["Roman Kuznietsov"]
+  spec.email         = ["roman.kuznietsov@gmail.com"]
+  spec.description   = %q{nested structure validator}
+  spec.summary       = %q{Provides a simple DSL to define nested data schemas
+and perform checks generating verbose error messages}
+  spec.homepage      = "https://github.com/romankuznietsov/structor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: structor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roman Kuznietsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: nested structure validator
+email:
+- roman.kuznietsov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structor.rb
+- lib/structor/builder.rb
+- lib/structor/node.rb
+- lib/structor/type.rb
+- lib/structor/version.rb
+- spec/builder_spec.rb
+- spec/spec_helper.rb
+- spec/structor_spec.rb
+- spec/type_spec.rb
+- structor.gemspec
+homepage: https://github.com/romankuznietsov/structor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a simple DSL to define nested data schemas and perform checks generating
+  verbose error messages
+test_files:
+- spec/builder_spec.rb
+- spec/spec_helper.rb
+- spec/structor_spec.rb
+- spec/type_spec.rb