structured_reader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0621752b200561ae03415cd92ccbd8a9c65db9ff
+  data.tar.gz: c7af4b1c0273c3e44b87efc782eec2235a8bff21
+SHA512:
+  metadata.gz: 522146b8e92418a53a6047b675a4b1306f2d3b14a0fc8054f137051ca931080acbbb8c266de3e8e05271c06bdff8e8e5c9521dbe703ac3c7b8fe248df679a48c
+  data.tar.gz: 6750388513520282561be86f6779f2c74a08a4b7a226b1c473d179b893a4d061256a87f4f00728e7e6a6b777fe621fa3743177383ea5cb6a1d6f6b9c958a4b3c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/doc/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.*.sw?

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in structured_reader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matthew Boeh
+
+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,197 @@
+# StructuredReader
+
+[![Build Status](https://travis-ci.org/mboeh/structured_reader.svg?branch=master)](https://travis-ci.org/mboeh/structured_reader)
+
+This library allows you to create declarative rulesets (or schemas) for reading primitive data structures (hashes + arrays + strings + numbers) or JSON into validated data objects. Free yourself from `json.fetch(:widget).fetch(:box).fetch(:dimensions).fetch(:width)`. Get that good `widget.box.dimensions.width` without risking NoMethodErrors. Have confidence that if you're passed total unexpected nonsense, it won't be smoothed over by a convenient MagicHashyMash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'structured_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structured_reader
+
+## Usage
+
+StructuredReader allows you to declare the expected structure of a JSON document (or any other data structure built on Ruby primitives). Readers are created with a simple domain-specific language (DSL) and are immutable. The declaration is evaluated at the time you create the reader, not every time it's used to read, so it's a good idea to assign it to a constant.
+
+```ruby
+require 'structured_reader'
+
+READER = StructuredReader.json do |o|
+  o.collection :widgets do |w|
+    w.string :type, "widgetType"
+    w.number :price
+    w.string :description, nullable: true
+    w.array :tags, of: :string
+    w.object :dimensions, nullable: true do |dims|
+      dims.number :weight
+      dims.number :width
+      dims.number :height
+    end
+    w.time :last_updated_at, "lastUpdated"
+  end
+  o.object :pagination, strict: true do |pg|
+    pg.string :next_url, "nextUrl", nullable: true
+    pg.number :total_items, "totalItems"
+  end
+end
+```
+
+Readers provide a `read` method, which takes either a Hash or a JSON string (which will be parsed and is expected to result in a Hash).
+
+```ruby
+document = {
+  widgets: [
+    {
+      widgetType: "squorzit",
+      price: 99.99,
+      description: "who can even say?",
+      tags: ["mysterious", "magical"],
+      dimensions: {
+        weight: 10,
+        width: 5,
+        height: 9001
+      },
+      lastUpdated: "2017-12-24 01:01 AM PST"
+    },
+    {
+      widgetType: "frobulator",
+      price: 0.79,
+      tags: [],
+      comment: "a bonus text",
+      lastUpdated: "2017-12-24 01:05 AM PST"
+    }
+  ],
+  pagination: {
+    nextUrl: nil,
+    totalItems: 2
+  }
+}
+
+result = READER.read(document)
+```
+
+Hashes (objects) are parsed into Ruby Structs. Fields present in the object but not in the declaration are ignored. You can change this behavior by passing `strict: true` to `object`.
+
+```ruby
+p result.widgets.length # ==> 2
+p result.widgets[0].dimensions.height # ==> 9001
+p result.widgets[0].tags # ==> ["mysterious", "magical"]
+p result.widgets[1].last_updated_at # ==> #<DateTime: 2017-12-24T01:05:00-08:00 ((2458112j,32700s,0n),-28800s,2299161j)>
+p result.widgets[1].comment # ! ==> NoMethodError
+```
+
+## Reader Types
+
+* `string`: The classic.
+* `number`: Like in JSON, this can be an integer or a float.
+* `object`: Must define at least one field.
+* `array`: An array containing elements of a single type. Use `one_of` to support arrays of mixed types.
+* `collection`: Shorthand for an `array` of `objects`.
+* `one_of`: Takes several other reader types and tests them in order, returning the first one that succeeds.
+* `literal`: Validates an exact, literal value (e.g. the field must contain "foo" and nothing but "foo"). Can be used with `one_of` to implement discriminated unions; see below.
+* `null`: Shorthand for `literal nil`.
+* `time`: Expects a String and parses it using DateTime.parse. I am currently thinking about a clean way to declare subtypes of string along the lines of "parsable with a provided parser".
+* `raw`: Always validates and returns the unmodified value. May be useful if you have a "payload" or "attributes" structure that you want to pass along to somewhere else.
+* `custom`: Define your own personal pan parser.
+
+Reead the specs for more details.
+
+## Advanced Declarations
+
+### Discriminated Unions
+
+It is common to have JSON data structures that use a type field to distinguish between objects with different fields:
+
+```ruby
+document = [
+  {
+    type: "square",
+    length: 10,
+  },
+  {
+    type: "rectangle",
+    width: 5,
+    height: 10,
+  },
+  {
+    type: "circle",
+    diameter: 4,
+  },
+]
+```
+
+This can be typed as a _discriminated union_ (or _tagged union_). The `one_of` and `literal` methods can be combined to validate and read this data. (A shorthand method for doing this may be implemented in the future.)
+
+```ruby
+reader = StructuredReader.json(root: :array) do |a|
+  a.one_of do |shape|
+    shape.object do |sq|
+      sq.literal :type, value: "square"
+      sq.number :length
+    end
+    shape.object do |rc|
+      rc.literal :type, value: "rectangle"
+      rc.number :width
+      rc.number :height
+    end
+    shape.object do |cr|
+      cr.literal :type, value: "circle"
+      cr.number :diameter
+    end
+  end
+end
+```
+
+Each element of the array is tested against each option, and the one that succeeds is used. If none match, `StructuredReader::WrongTypeError` will be raised. (If you need a fallback, consider the `raw` type.)
+
+There are some performance implications here. In general, declarations are tested against the data in order. In this case, each element will be tested first to see if it is a square, then to see if it is a rectangle, then to see if it is a circle. It's a good idea when using `one_of` to ensure that the type field (or some other distinguishing field) is declared first, so the tests can fail as fast as possible.
+
+```ruby
+result = reader.read(document)
+
+p result.length # ==> 3
+p result[0].type # ==> "square"
+p result[0].length # ==> 10
+p result[2].diameter # ==> 4
+p result[0].diameter # ! ==> NoMethodError
+```
+
+## Defining Custom Types
+
+The API for this is somewhat experimental. The best reference at this time is the specs.
+
+## Caveats/Missing Features
+
+### Stack depth
+
+The depth of data structures you can read is limited by stack space, because the reading is done by mutual recursion. If you really have to parse a structure too deep for the stack, you can combine multiple layers of readers by using the `raw` type to pluck subdocuments out in unmodified form and then use a second reader to parse that.
+
+### Performance
+
+Unbenchmarked, unoptimized. It should be OK, though.
+
+## Out Of Scope/Unfeatures
+
+* Complex validation support. You can do a lot with `custom` fields, but I advise not pushing business logic into the serialization layer.
+* Exact feature compatibility with JSON Schema. Same reason, really. You can use this library to validate JSON, but that's not its purpose.
+* Inheritance/subtyping. Too much complexity for not much practical use. I might decide otherwise if I keep running into places it'd be useful.
+* Tuples/fixed-length arrays. I don't see these in the wild very frequently, and I'm not a fan. `array`/`one_of` should suffice, and `custom` is there if you need it.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mboeh/structured_reader.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "structured_reader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/example.rb

@@ -0,0 +1,56 @@
+require 'bundler/setup'
+
+require 'structured_reader'
+
+reader = StructuredReader.json do |o|
+  o.collection :widgets do |w|
+    w.string :type, "widgetType"
+    w.number :price
+    w.string :description, nullable: true
+    w.array :tags, of: :string
+    w.object :dimensions, nullable: true do |dims|
+      dims.number :weight
+      dims.number :width
+      dims.number :height
+    end
+    w.time :last_updated_at, "lastUpdated"
+  end
+  o.object :pagination do |pg|
+    pg.string :next_url, "nextUrl", nullable: true
+    pg.number :total_items, "totalItems"
+  end
+end
+
+document = {
+  widgets: [
+    {
+      widgetType: "squorzit",
+      price: 99.99,
+      description: "who can even say?",
+      tags: ["mysterious", "magical"],
+      dimensions: {
+        weight: 10,
+        width: 5,
+        height: 9001
+      },
+      lastUpdated: "2017-12-24 01:01 AM PST"
+    },
+    {
+      widgetType: "frobulator",
+      price: 0.79,
+      tags: [],
+      lastUpdated: "2017-12-24 01:05 AM PST"
+    }
+  ],
+  pagination: {
+    nextUrl: nil,
+    totalItems: 2
+  }
+}
+
+result = reader.read(document)
+
+p result.widgets.length # ==> 2
+p result.widgets[0].dimensions.height # ==> 9001
+p result.widgets[0].tags # ==> ["mysterious", "magical"]
+p result.widgets[1].last_updated_at # ==> #<DateTime: 2017-12-24T01:05:00-08:00 ((2458112j,32700s,0n),-28800s,2299161j)>

data/examples/selection.rb

@@ -0,0 +1,56 @@
+require 'bundler/setup'
+
+require 'structured_reader'
+
+reader = StructuredReader.json do |o|
+  o.collection :widgets do |w|
+    w.string :type, "widgetType"
+    w.number :price
+    w.string :description, nullable: true
+    w.array :tags, of: :string
+    w.object :dimensions, nullable: true do |dims|
+      dims.number :weight
+      dims.number :width
+      dims.number :height
+    end
+    w.time :last_updated_at, "lastUpdated"
+  end
+  o.object :pagination do |pg|
+    pg.string :next_url, "nextUrl", nullable: true
+    pg.number :total_items, "totalItems"
+  end
+end
+
+document = {
+  widgets: [
+    {
+      widgetType: "squorzit",
+      price: 99.99,
+      description: "who can even say?",
+      tags: ["mysterious", "magical"],
+      dimensions: {
+        weight: 10,
+        width: 5,
+        height: 9001
+      },
+      lastUpdated: "2017-12-24 01:01 AM PST"
+    },
+    {
+      widgetType: "frobulator",
+      price: 0.79,
+      tags: [],
+      lastUpdated: "2017-12-24 01:05 AM PST"
+    }
+  ],
+  pagination: {
+    nextUrl: nil,
+    totalItems: 2
+  }
+}
+
+# This uses filename globbing for now, not proper XPath-style wildcards
+context = StructuredReader::JSONReader::SelectionContext.new(".widgets\\[*\\].price")
+
+result = reader.read(document, context)
+
+p result

data/examples/union.rb

@@ -0,0 +1,44 @@
+require 'bundler/setup'
+
+require 'structured_reader'
+
+reader = StructuredReader.json(root: :array) do |a|
+  a.one_of do |shape|
+    shape.object do |sq|
+      sq.literal :type, value: "square"
+      sq.number :length
+    end
+    shape.object do |rc|
+      rc.literal :type, value: "rectangle"
+      rc.number :width
+      rc.number :height
+    end
+    shape.object do |cr|
+      cr.literal :type, value: "circle"
+      cr.number :diameter
+    end
+  end
+end
+
+document = [
+  {
+    type: "square",
+    length: 10,
+  },
+  {
+    type: "rectangle",
+    width: 5,
+    height: 10,
+  },
+  {
+    type: "circle",
+    diameter: 4,
+  },
+]
+
+result = reader.read(document)
+
+p result.length # ==> 3
+p result[0].type # ==> "square"
+p result[0].length # ==> 10
+p result[2].diameter # ==> 4

data/lib/structured_reader/version.rb

@@ -0,0 +1,3 @@
+module StructuredReader
+  VERSION = "1.0.0"
+end

data/lib/structured_reader.rb

@@ -0,0 +1,440 @@
+# frozen_string_literal: true
+
+require "structured_reader/version"
+require "json"
+require "date"
+
+module StructuredReader
+  Error = Class.new(StandardError)
+  WrongTypeError = Class.new(Error)
+  DeclarationError = Class.new(Error)
+
+  def self.json(*args, &blk)
+    JSONReader.new(*args, &blk)
+  end
+
+  def self.reader_set(&blk)
+    JSONReader::ReaderSet.new.tap(&blk)
+  end
+
+  class JSONReader
+
+    def initialize(root: :object, reader_set: ReaderSet.new, &blk)
+      @root_reader = reader_set.reader(root, &blk)
+    end
+
+    def read(document, context = Context.new)
+      if document.kind_of?(String)
+        document = JSON.parse document
+      end
+      @root_reader.read(document, context)
+    end
+
+    class ObjectReader
+
+      class ReaderBuilder
+
+        def initialize(base, reader_set:)
+          @base = base
+          @reader_set = reader_set
+        end
+
+        def method_missing(type, name, field_name = name.to_s, *args, **kwargs, &blk)
+          if @reader_set.has_reader?(type)
+            @base.field name, field_name, @reader_set.reader(type, *args, **kwargs, &blk)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(type)
+          @reader_set.has_reader?(type) || super
+        end
+
+      end
+
+      def initialize(strict: false, reader_set:)
+        @readers = {}
+        @strict = strict
+        yield ReaderBuilder.new(self, reader_set: reader_set)
+        if @readers.empty?
+          raise DeclarationError, "must define at least one field to read"
+        end
+        @object_klass = Struct.new(*@readers.keys)
+        freeze
+      end
+
+      def read(fragment, context)
+        if fragment.kind_of?(Hash)
+          result = @object_klass.new
+          @readers.each do |key, (field, reader)|
+            value = fragment[field] || fragment[field.to_sym]
+            context.push(".#{field}") do |sub_context|
+              result[key] = reader.read(value, sub_context)
+            end
+          end
+          if @strict && ((excess_keys = fragment.keys.map(&:to_sym) - @readers.keys)).any?
+            return context.flunk(fragment, "found strictly forbidden keys #{excess_keys.inspect}")
+          end
+          result.freeze
+
+          context.accept(result)
+        else
+          return context.flunk(fragment, "expected a Hash")
+        end
+      end
+
+      def field(key, field_name, reader)
+        @readers[key.to_sym] = [field_name, reader]
+      end
+
+    end
+
+    class ArrayReader
+
+      class ReaderBuilder
+
+        def initialize(base, reader_set:)
+          @base = base
+          @reader_set = reader_set
+        end
+
+        def method_missing(type, *args, **kwargs, &blk)
+          if @reader_set.has_reader?(type)
+            @base.member @reader_set.reader(type, *args, **kwargs, &blk)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(type)
+          @reader_set.has_reader?(type) || super
+        end
+
+      end
+
+      def initialize(of: nil, reader_set:, &blk)
+        if block_given?
+          yield ReaderBuilder.new(self, reader_set: reader_set)
+        elsif of
+          ReaderBuilder.new(self, reader_set: reader_set).send(of)
+        end
+
+        unless @member_reader
+          raise DeclarationError, "array must have a member type"
+        end
+      end
+
+      def member(reader)
+        @member_reader = reader
+      end
+
+      def read(fragment, context)
+        if fragment.kind_of?(Array)
+          context.accept(fragment.map.with_index do |member, idx|
+            context.push("[#{idx}]") do |sub_context|
+              @member_reader.read(member, sub_context)
+            end
+          end)
+        else
+          context.flunk(fragment, "expected an Array")
+        end
+      end
+
+    end
+
+    class CollectionReader < ArrayReader
+
+      def initialize(**args, &blk)
+        super do |a|
+          a.object(&blk)
+        end
+      end
+
+    end
+
+    class NumberReader
+
+      def initialize(**_)
+
+      end
+
+      def read(fragment, context)
+        if fragment.kind_of?(Numeric)
+          context.accept fragment
+        else
+          context.flunk(fragment, "expected a Numeric")
+        end
+      end
+
+    end
+
+    class StringReader
+
+      def initialize(**_)
+
+      end
+
+      def read(fragment, context)
+        if fragment.kind_of?(String)
+          context.accept maybe_parse(fragment, context)
+        else
+          context.flunk(fragment, "expected a String")
+        end
+      end
+
+      def maybe_parse(fragment, _context)
+        fragment
+      end
+
+    end
+
+    class TimeReader < StringReader
+
+      def maybe_parse(fragment, context)
+        begin
+          context.accept DateTime.parse(fragment)
+        rescue ArgumentError
+          context.flunk(fragment, "could not be converted to a DateTime")
+        end
+      end
+
+    end
+
+    class LiteralReader
+
+      def initialize(value:, **_)
+        @value = value
+      end
+
+      def read(fragment, context)
+        if fragment == @value
+          context.accept fragment
+        else
+          context.flunk(fragment, "expected #{@value.inspect}")
+        end
+      end
+
+    end
+
+    class NullReader < LiteralReader
+
+      def initialize(**_)
+        super value: nil
+      end
+
+    end
+
+    class RawReader
+
+      def initialize(**_)
+
+      end
+
+      def read(fragment, context)
+        context.accept fragment
+      end
+
+    end
+
+    class CustomReader
+
+      def initialize(**_, &blk)
+        @read_action = blk
+      end
+
+      def read(fragment, context)
+        @read_action.call(fragment, context)
+      end
+
+    end
+
+    class OneOfReader
+
+      class ReaderBuilder
+
+        def initialize(base, reader_set:)
+          @base = base
+          @reader_set = reader_set
+        end
+
+        def method_missing(type, *args, **kwargs, &blk)
+          if @reader_set.has_reader?(type)
+            @base.option @reader_set.reader(type, *args, **kwargs, &blk)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(type)
+          @reader_set.has_reader?(type) || super
+        end
+
+      end
+
+      def initialize(reader_set:, **_)
+        @readers = []
+        yield ReaderBuilder.new(self, reader_set: reader_set)
+        if @readers.empty?
+          raise DeclarationError, "must define at least one option"
+        end
+        freeze
+      end
+
+      def read(fragment, context)
+        @readers.each do |reader|
+          if reader.read(fragment, ValidatorContext.new).empty?
+            return context.accept(reader.read(fragment, context))
+          end
+        end
+
+        context.flunk(fragment, "was not any of the expected options")
+      end
+
+      def option(reader)
+        @readers << reader
+      end
+
+    end
+
+    class BuilderDeriver
+
+      def initialize(klass, &blk)
+        @klass = klass
+        @build_action = blk
+      end
+
+      def new(*args, **kwargs)
+        @klass.new(*args, **kwargs, &@build_action)
+      end
+
+    end
+
+    class Context
+
+      def initialize(where = "")
+        @where = where.dup.freeze
+      end
+
+      def accept(fragment)
+        fragment
+      end
+
+      def flunk(fragment, reason)
+        raise WrongTypeError, "#{reason}, got a #{fragment.class} (at #{@where})"
+      end
+
+      def push(path, &blk)
+        yield self.class.new(@where + path)
+      end
+
+    end
+
+    class ValidatorContext
+
+      def initialize(where = "", errors = [])
+        @where = where.dup.freeze
+        @errors = errors
+      end
+
+      def accept(fragment)
+        @errors
+      end
+
+      def flunk(fragment, reason)
+        @errors << [@where, reason]
+      end
+
+      def push(path)
+        yield self.class.new(@where + path, @errors)
+      end
+
+    end
+
+    class SelectionContext
+
+      def initialize(target, where = "", found = [])
+        @target = target
+        @where = where
+        @found = found
+      end
+
+      def accept(fragment)
+        if File.fnmatch(@target, @where)
+          @found << fragment
+          fragment
+        else
+          if @found.any?
+            @found.first
+          else
+            unless @where.empty?
+              fragment
+            end
+          end
+        end
+      end
+
+      def flunk(fragment, reason)
+        nil
+      end
+
+      def push(path)
+        if @found.empty?
+          yield self.class.new(@target, @where + path, @found)
+        end
+      end
+
+    end
+
+    class ReaderSet
+      READERS = {
+        array: ArrayReader,
+        collection: CollectionReader,
+        string: StringReader,
+        time: TimeReader,
+        object: ObjectReader,
+        number: NumberReader,
+        one_of: OneOfReader,
+        null: NullReader,
+        raw: RawReader,
+        literal: LiteralReader,
+        custom: CustomReader,
+      }
+
+      def initialize
+        @readers = READERS.dup
+      end
+
+      def add_reader(type, reader)
+        @readers[type.to_sym] = reader
+      end
+
+      def custom(type, &blk)
+        add_reader type, BuilderDeriver.new(CustomReader, &blk)
+      end
+
+      def object(type, &blk)
+        add_reader type, BuilderDeriver.new(ObjectReader, &blk)
+      end
+
+      def reader(type, *args, **kwargs, &blk)
+        if kwargs[:nullable]
+          kwargs = kwargs.dup
+          kwargs.delete :nullable
+          OneOfReader.new(reader_set: self) do |o|
+            o.null
+            o.send(type, *args, **kwargs, &blk)
+          end
+        else
+          @readers.fetch(type).new(*args, reader_set: self, **kwargs, &blk)
+        end
+      end
+
+      def has_reader?(type)
+        @readers.has_key?(type)
+      end
+    end
+
+  end
+
+end

data/structured_reader.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "structured_reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "structured_reader"
+  spec.version       = StructuredReader::VERSION
+  spec.authors       = ["Matthew Boeh"]
+  spec.email         = ["m@mboeh.com"]
+
+  spec.summary       = %q{Read primitive and JSON data structures into data objects}
+  spec.description   = %q{This library allows you to create declarative rulesets (or schemas) for reading primitive data structures (hashes + arrays + strings + numbers) or JSON into validated data objects.}
+  spec.homepage      = "https://github.com/mboeh/structured_reader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: structured_reader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Boeh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This library allows you to create declarative rulesets (or schemas) for
+  reading primitive data structures (hashes + arrays + strings + numbers) or JSON
+  into validated data objects.
+email:
+- m@mboeh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/example.rb
+- examples/selection.rb
+- examples/union.rb
+- lib/structured_reader.rb
+- lib/structured_reader/version.rb
+- structured_reader.gemspec
+homepage: https://github.com/mboeh/structured_reader
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Read primitive and JSON data structures into data objects
+test_files: []