strong_json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87d564cb26c5d9ed754f678b8457500a559bdc59
+  data.tar.gz: 9295697d16ad7e6bae591d2fba87c8faac18032e
+SHA512:
+  metadata.gz: af91e4213775d941fdaba00e8eaedc6b00794505b02ae9d1b1f43d9d1ae0e52931adc7a1a7b5c041052a6bcd09bd409c6397e6257734ef6006a634f3c9daeaf6
+  data.tar.gz: 223485b1b051ee4651840797e064607160858b25223472a5b4fafc1be063ca329ab343b9d9224fc7d2306cf1d38ae1cf32aa28b63252c59eb603aae541ba7865

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.1.1"
+  - "2.1.2"
+  - "2.1.3"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Soutaro Matsumoto
+
+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,76 @@
+# StrongJSON
+
+This library allows you to test the structure of JSON objects.
+
+This is similar to Strong Parameters, which is introduced by Rails 4, but expected to work with more complex structures.
+It may help you to understand what this is as: Strong Parameter is for simple structures, like HTML forms, and StrongJSON is for complex structures, like JSON objects posted to API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strong_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install strong_json
+
+## Usage
+
+```ruby
+s = StrongJSON.new do
+  let :item, object(id: prohibited, name: string, count: numeric)
+  let :custoemr, object(name: string, address: string, phone: string, email: optional(string))
+  let :order, object(customer: customer, items: array(item))
+end
+
+json = s.order.coerce(JSON.parse(input))
+```
+
+If the input JSON data is conformant with `order`'s structure, the `json` will be that value.
+
+If the input JSON contains attributes which is not white-listed in the definition, the fields will be droped.
+
+If an attribute has a value which does not match with given type, the `coerce` method call will raise an exception `StrongJSON::Type::Error`.
+If the input JSON contains `prohibited` attributes, `id` of `item` in the example, it also will result in an exception.
+
+## Catalogue of Types
+
+### object(f1: type1, f2: type2, ...)
+
+* The value must be an object
+* Fields, `f1`, `f2`, and ..., must be present and its values must be of `type1`, `type2`, ..., respectively
+* Other fields will be ignored
+
+### array(type)
+
+* The value must be an array
+* All elements in the array must be value of given `type`
+
+### optional(type)
+
+* The value can be `nil` (or not contained in an object)
+* If an value exists, it must be of given `type`
+
+### Base types
+
+* `number` The value must be an instance of `Numeric`
+* `string` The value must be an instance of `String`
+* `boolean` The value must be `true` or `false`
+* `numeric` The value must be an instance of `Numeric` or a string which represents a number
+* `any` Any value except `nil` is accepted
+* `prohibited` Any value will be rejected
+
+## Contributing
+
+1. Fork it ( https://github.com/soutaro/strong_json/fork )
+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 a 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/strong_json.rb

@@ -0,0 +1,15 @@
+require "strong_json/version"
+require "strong_json/type"
+require "strong_json/types"
+
+class StrongJSON
+  def initialize(&block)
+    instance_eval(&block)
+  end
+
+  def let(name, type)
+    define_method(name) { type }
+  end
+
+  include StrongJSON::Types
+end

data/lib/strong_json/type.rb

@@ -0,0 +1,128 @@
+class StrongJSON
+  module Type
+    class Base
+      def initialize(type)
+        @type = type
+      end
+
+      def test(value)
+        case @type
+        when :prohibited
+          false
+        when :any
+          true
+        when :number
+          value.is_a?(Numeric)
+        when :string
+          value.is_a?(String)
+        when :boolean
+          value == true || value == false
+        when :numeric
+          value.is_a?(Numeric) || value.is_a?(String) && /\A[\d.]+\Z/ =~ value
+        else
+          false
+        end
+      end
+
+      def coerce(value, path: [])
+        raise Error.new(value: value, type: self, path: path) unless test(value)
+        value
+      end
+
+      def to_s
+        @type.to_s
+      end
+    end
+
+    class Optional
+      def initialize(type)
+        @type = type
+      end
+
+      def coerce(value, path: [])
+        if value != nil
+          @type.coerce(value, path: path)
+        else
+          nil
+        end
+      end
+
+      def to_s
+        "optinal(#{@type})"
+      end
+    end
+
+    class Array
+      def initialize(type)
+        @type = type
+      end
+
+      def coerce(value, path: [])
+        if value.is_a?(::Array)
+          value.map.with_index do |v, i|
+            @type.coerce(v, path: path+[i])
+          end
+        else
+          raise Error.new(path: path, type: self, value: value)
+        end
+      end
+
+      def to_s
+        "array(#{@type})"
+      end
+    end
+
+    class Object
+      def initialize(fields)
+        @fields = fields
+      end
+
+      def coerce(object, path: [])
+        unless object.is_a?(Hash)
+          raise Error.new(path: path, type: self, value: object)
+        end
+
+        result = {}
+
+        @fields.each do |name, ty|
+          value = ty.coerce(object[name], path: path + [name])
+          result[name] = value if object.has_key?(name)
+        end
+
+        result
+      end
+
+      def merge(fields)
+        if fields.is_a?(Object)
+          fields = Object.instance_variable_get("@fields")
+        end
+
+        Object.new(@fields.merge(fields))
+      end
+
+      def to_s
+        fields = []
+
+        @fields.each do |name, type|
+          fields << "#{name}: #{type}"
+        end
+
+        "object(#{fields.join(', ')})"
+      end
+    end
+
+    class Error < StandardError
+      attr_reader :path, :type, :value
+
+      def initialize(path:, type:, value:)
+        @path = path
+        @type = type
+        @value = value
+      end
+
+      def to_s
+        "Expected type of value at #{path.join('.')} (#{value}) is #{type}"
+      end
+    end
+  end
+end

data/lib/strong_json/types.rb

@@ -0,0 +1,39 @@
+class StrongJSON
+  module Types
+    def object(fields = {})
+      Type::Object.new(fields)
+    end
+
+    def array(type = any)
+      Type::Array.new(type)
+    end
+
+    def optional(type = any)
+      Type::Optional.new(type)
+    end
+
+    def string
+      StrongJSON::Type::Base.new(:string)
+    end
+
+    def numeric
+      StrongJSON::Type::Base.new(:numeric)
+    end
+
+    def number
+      StrongJSON::Type::Base.new(:number)
+    end
+
+    def boolean
+      StrongJSON::Type::Base.new(:boolean)
+    end
+
+    def any
+      StrongJSON::Type::Base.new(:any)
+    end
+
+    def prohibited
+      StrongJSON::Type::Base.new(:prohibited)
+    end
+  end
+end

data/lib/strong_json/version.rb

@@ -0,0 +1,3 @@
+class StrongJSON
+  VERSION = "0.0.1"
+end

data/spec/array_spec.rb

@@ -0,0 +1,38 @@
+require "strong_json"
+
+describe StrongJSON::Type::Array, "#coerce" do
+  it "returns empty" do
+    type = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:any))
+
+    expect(type.coerce([])).to eq([])
+  end
+
+  it "test array of number" do
+    type = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:number))
+    expect(type.coerce([1])).to eq([1])
+  end
+
+  it "test array of array of number" do
+    a = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:number))
+    type = StrongJSON::Type::Array.new(a)
+    expect(type.coerce([[1]])).to eq([[1]])
+  end
+
+  it "reject non array" do
+    type = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:number))
+
+    expect { type.coerce({}) }.to raise_error(StrongJSON::Type::Error)
+  end
+
+  it "reject membership" do
+    type = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:number))
+
+    expect { type.coerce(["a"]) }.to raise_error(StrongJSON::Type::Error)
+  end
+
+  it "rejects nil" do
+    type = StrongJSON::Type::Array.new(StrongJSON::Type::Base.new(:number))
+
+    expect { type.coerce(nil) }.to raise_error(StrongJSON::Type::Error)
+  end
+end

data/spec/basetype_spec.rb

@@ -0,0 +1,85 @@
+require "strong_json"
+
+describe StrongJSON::Type::Base do
+  describe "#test" do
+    context ":prohibited" do
+      let (:type) { StrongJSON::Type::Base.new(:prohibited) }
+
+      it "rejects number" do
+        expect(type.test(123)).to be_falsey
+      end
+    end
+
+    context ":number" do
+      let (:type) { StrongJSON::Type::Base.new(:number) }
+      
+      it "accepts integer" do
+        expect(type.test(123)).to be_truthy
+      end
+
+      it "accepts float" do
+        expect(type.test(3.14)).to be_truthy
+      end
+
+      it "rejects string" do
+        expect(type.test("string")).to be_falsey
+      end
+    end
+
+    context ":string" do
+      let (:type) { StrongJSON::Type::Base.new(:string) }
+
+      it "accepts string" do
+        expect(type.test("string")).to be_truthy
+      end
+    end
+
+    context ":any" do
+      let (:type) { StrongJSON::Type::Base.new(:any) }
+
+      it "accepts string" do
+        expect(type.test("string")).to be_truthy
+      end
+
+      it "accepts number" do
+        expect(type.test(2.71828)).to be_truthy
+      end
+    end
+
+    context ":boolean" do
+      let (:type) { StrongJSON::Type::Base.new(:boolean) }
+
+      it "accepts true" do
+        expect(type.test(true)).to be_truthy
+      end
+
+      it "accepts false" do
+        expect(type.test(false)).to be_truthy
+      end
+
+      it "rejects nil" do
+        expect(type.test(nil)).to be_falsey
+      end
+    end
+
+    context ":numeric" do
+      let (:type) { StrongJSON::Type::Base.new(:numeric) }
+
+      it "accepts number" do
+        expect(type.test(123)).to be_truthy
+      end
+
+      it "accepts number format string" do
+        expect(type.test("123")).to be_truthy
+      end
+
+      it "rejects non numeric format string" do
+        expect(type.test("test")).to be_falsey
+      end
+
+      it "rejects boolean" do
+        expect(type.test(true)).to be_falsey
+      end
+    end
+  end
+end

data/spec/error_spec.rb

@@ -0,0 +1,8 @@
+describe StrongJSON::Type::Error do
+  include StrongJSON::Types
+
+  it "hgoehoge" do
+    exn = StrongJSON::Type::Error.new(value: [], type: array(numeric), path: ["a",1,"b"])
+    expect(exn.to_s).to be_a(String)
+  end
+end

data/spec/object_spec.rb

@@ -0,0 +1,52 @@
+require "strong_json"
+
+describe StrongJSON::Type::Object do
+  describe "#coerce" do
+    it "accepts value" do
+      type = StrongJSON::Type::Object.new(a: StrongJSON::Type::Base.new(:numeric),
+                                          b: StrongJSON::Type::Base.new(:string))
+
+      expect(type.coerce(a: 123, b: "test")).to eq(a: 123, b: "test")
+    end
+
+    it "drops unspecified fields" do
+      type = StrongJSON::Type::Object.new(a: StrongJSON::Type::Base.new(:numeric))
+
+      expect(type.coerce(a: 123, b: true)).to eq(a: 123)
+    end
+
+    it "rejects prohibited fields" do
+      type = StrongJSON::Type::Object.new(a: StrongJSON::Type::Base.new(:prohibited))
+
+      expect{ type.coerce(a: 123, b: true) }.to raise_error(StrongJSON::Type::Error)
+    end
+
+    it "rejects objects with missing fields" do
+      type = StrongJSON::Type::Object.new(a: StrongJSON::Type::Base.new(:numeric))
+
+      expect{ type.coerce(b: "test") }.to raise_error(StrongJSON::Type::Error)
+    end
+
+    it "accepts missing field if optional" do
+      type = StrongJSON::Type::Object.new(a: StrongJSON::Type::Optional.new(StrongJSON::Type::Base.new(:numeric)))
+
+      expect(type.coerce(b: "test")).to eq({})
+    end
+  end
+
+  describe "#merge" do
+    let (:type) { StrongJSON::Type::Object.new(a: StrongJSON::Type::Base.new(:numeric)) }
+
+    it "adds field" do
+      ty2 = type.merge(b: StrongJSON::Type::Base.new(:string))
+
+      expect(ty2.coerce(a: 123, b: "test")).to eq(a: 123, b: "test")
+    end
+
+    it "overrides field" do
+      ty2 = type.merge(a: StrongJSON::Type::Base.new(:prohibited))
+
+      expect{ ty2.coerce(a: 123) }.to raise_error(StrongJSON::Type::Error)
+    end
+  end
+end

data/spec/optional_spec.rb

@@ -0,0 +1,19 @@
+require "strong_json"
+
+describe StrongJSON::Type::Optional, "#coerce" do
+  context "optional(:number)" do
+    let (:type) { StrongJSON::Type::Optional.new(StrongJSON::Type::Base.new(:number)) }
+
+    it "accepts nil" do
+      expect(type.coerce(nil)).to eq(nil)
+    end
+
+    it "accepts number" do
+      expect(type.coerce(3)).to eq(3)
+    end
+
+    it "rejects string" do
+      expect { type.coerce("a") }.to raise_error(StrongJSON::Type::Error)
+    end
+  end
+end

data/spec/spec.rb

@@ -0,0 +1,10 @@
+describe "StrongJSON.new" do
+  it "tests the structure of a JSON object" do
+    s = StrongJSON.new do
+      let :item, object(id: prohibited, name: string, count: numeric, price: numeric)
+      let :checkout, object(id: prohibited, items: array(item), change: optional(number))
+    end
+
+    expect(s.checkout.coerce(items: [ { name: "test", count: 1, price: "2.33", comment: "dummy" } ])).to eq(items: [ { name: "test", count: 1, price: "2.33" }])
+  end
+end

data/strong_json.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strong_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "strong_json"
+  spec.version       = StrongJSON::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+  spec.summary       = "Type check JSON objects"
+  spec.description   = "Type check JSON objects"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: strong_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Type check JSON objects
+email:
+- matsumoto@soutaro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/strong_json.rb
+- lib/strong_json/type.rb
+- lib/strong_json/types.rb
+- lib/strong_json/version.rb
+- spec/array_spec.rb
+- spec/basetype_spec.rb
+- spec/error_spec.rb
+- spec/object_spec.rb
+- spec/optional_spec.rb
+- spec/spec.rb
+- strong_json.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Type check JSON objects
+test_files:
+- spec/array_spec.rb
+- spec/basetype_spec.rb
+- spec/error_spec.rb
+- spec/object_spec.rb
+- spec/optional_spec.rb
+- spec/spec.rb