rackson 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dylan Griffin
+
+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,100 @@
+# Rackson
+
+Rackson serves to turn JSON into ruby objects. Where Rackson differs from other
+libraries is that the classes are expected to be already defined so that if you
+use the wrong input or try to call a method that doesn't exist it will raise an
+exception as soon as possible
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rackson'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rackson
+
+## Usage
+
+Let's just start with a very simple example
+
+
+```ruby
+class Foo
+  include Rackson
+  json_property :bar, String
+end
+
+mapper = Rackson::ObjectMapper.new
+foo = mapper.deserialize('{ "bar": "value" }', Foo)
+foo.bar
+# 'value'
+```
+
+As you can see after including `Rackson` the class now has access to a
+`json_property` method which defines a new property. The first argument is the
+key, the second is the type. This way if you pass something *not* a string you
+will get an exception when trying to deserialize instead of later. The class can
+be whatever you want:
+
+```ruby
+class Inner
+  include Rackson
+  json_property :foo, String
+end
+
+class Outer
+  include Rackson
+  json_property :inner, Inner
+end
+
+mapper = Rackson::ObjectMapper.new
+outer = mapper.deserialize('{ "outer": { "foo": "bar" }}', Outer)
+outer.inner.foo
+# 'bar'
+```
+
+Unless specified otherwise, all properties are required:
+
+```ruby
+class Foo
+  include Rackson
+  json_property :foo, String
+  json_property :bar, String
+end
+
+mapper = Rackson::ObjectMapper.new
+outer = mapper.deserialize('{ "foo": "this is foo" }', Foo)
+# RuntimeError: missing required key bar
+```
+
+However, properties are easily marked as optional:
+
+```ruby
+class Foo
+  include Rackson
+  json_property :foo, String
+  json_property :bar, String, optional: true
+end
+
+mapper = Rackson::ObjectMapper.new
+outer = mapper.deserialize('{ "foo": "this is foo" }', Foo)
+outer.bar
+# nil
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/griffindy/rackson/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/rackson.rb

@@ -0,0 +1,19 @@
+require 'rackson/property'
+require 'rackson/version'
+
+module Rackson
+  def self.included(base)
+    base.instance_variable_set(:@json_properties, [])
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def json_property(name, klass, options = {})
+      property = Rackson::Property.new(name, klass, options)
+      @json_properties << property
+      define_method(property.name) do
+        instance_variable_get("@#{property.name}")
+      end
+    end
+  end
+end

data/lib/rackson/object_mapper.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module Rackson
+  class ObjectMapper
+    def deserialize(input, klass)
+      case input
+      when String
+        deserialize(JSON.parse(input), klass)
+      when Hash
+        deserialize_from_hash(input, klass)
+      when Array
+        deserialize_into_array(input, klass)
+      end
+    end
+
+    def deserialize_from_hash(hash, klass)
+      klass.new.tap do |instance|
+        klass.instance_variable_get(:@json_properties).each do |property|
+          value = generate_value property, hash
+          instance.instance_variable_set("@#{property.name}", value)
+        end
+      end
+    end
+
+    def deserialize_into_array(array, klass)
+      array.map do |value|
+        deserialize(value, klass)
+      end
+    end
+
+    private
+
+    def generate_value(property, json_hash)
+      value_from_json = json_hash.fetch(property.name.to_s) do |key|
+        if property.required?
+          raise "missing required key #{key}"
+        end
+      end
+
+      case value_from_json
+      # already cast to the appropriate class
+      when property.klass
+        value_from_json
+      # needs to be deserialized into its own object
+      when Hash
+        deserialize_from_hash(value_from_json, property.klass)
+      when NilClass
+        nil
+      else
+        raise "type mismatch between #{value_from_json.inspect} (a #{value_from_json.class}) and #{property.klass}"
+      end
+    end
+  end
+end

data/lib/rackson/property.rb

@@ -0,0 +1,15 @@
+module Rackson
+  class Property
+    attr_reader :name, :klass
+
+    def initialize(name, klass, options)
+      @name = name
+      @klass = klass
+      @options = options
+    end
+
+    def required?
+      !@options[:optional]
+    end
+  end
+end

data/lib/rackson/version.rb

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

data/rackson.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rackson/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rackson"
+  spec.version       = Rackson::VERSION
+  spec.authors       = ["Dylan Griffin"]
+  spec.email         = ["dgriffin@twitter.com"]
+  spec.summary       = %q{A library to turn JSON into POROs.}
+  spec.description   = %q{A library to turn JSON into POROs in a somewhat typesafe manner.}
+  spec.homepage      = "https://github.com/griffindy/rackson"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+end

data/spec/rackson/object_mapper_spec.rb

@@ -0,0 +1,64 @@
+require_relative '../../lib/rackson'
+require_relative '../../lib/rackson/object_mapper'
+
+describe Rackson::ObjectMapper do
+  let(:mapper) { Rackson::ObjectMapper.new }
+  class DifferentFakeObject
+    include Rackson
+    json_property :baz, String
+  end
+
+  class FakeObject
+    include Rackson
+    json_property :foo, String
+    json_property :bar, DifferentFakeObject
+    json_property :something_optional, String, optional: true
+  end
+
+  describe '#deserialize' do
+    let(:json_string) { '{"foo": "bar", "bar": {"baz":"another thing"}}' }
+    let(:deserialized) { mapper.deserialize(json_string, FakeObject) }
+
+    it 'returns an object of the given class' do
+      expect(deserialized).to be_a FakeObject
+    end
+
+    it 'sets the appropriate values' do
+      expect(deserialized.foo).to eq 'bar'
+    end
+
+    it 'understands non JSON POROs' do
+      expect(deserialized.bar.baz).to eq 'another thing'
+    end
+
+    it 'understands optional properties' do
+      expect(deserialized.something_optional).to be nil
+      with_optional = mapper.deserialize '{"foo": "bar", "bar": {"baz":"another thing"}, "something_optional": "this now exists"}', FakeObject
+      expect(with_optional.something_optional).to eq 'this now exists'
+    end
+
+    it 'exposes type mismatches' do
+      expect do
+        # DifferentFakeObject#baz is declared as a String above
+        mapper.deserialize '{ "baz": 1 }', DifferentFakeObject
+      end.to raise_error(/type mismatch between/)
+    end
+
+    it 'yells about missing keys' do
+      expect do
+        # FakeObject also requires `bar`
+        mapper.deserialize '{ "foo": "bar" }', FakeObject
+      end.to raise_error(/missing required key/)
+    end
+  end
+
+  describe '#deserialize_into_array' do
+    let(:json_string) { '[{ "baz": "foo" }]' }
+    it 'deserializes into an array with #deserialize' do
+      deserialized = mapper.deserialize(json_string, DifferentFakeObject)
+      expect(deserialized).to be_a Array
+      expect(deserialized.length).to eq 1
+      expect(deserialized.first.baz).to eq 'foo'
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rackson
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dylan Griffin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: A library to turn JSON into POROs in a somewhat typesafe manner.
+email:
+- dgriffin@twitter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rackson.rb
+- lib/rackson/object_mapper.rb
+- lib/rackson/property.rb
+- lib/rackson/version.rb
+- rackson.gemspec
+- spec/rackson/object_mapper_spec.rb
+homepage: https://github.com/griffindy/rackson
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: A library to turn JSON into POROs.
+test_files:
+- spec/rackson/object_mapper_spec.rb
+has_rdoc: