son_jay 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjdiYTdiZjkxOWE3ZDg0ZjkxNzY0ZjNkYzEwYzg1ZWM1ZWQ3NTM5Yg==
+  data.tar.gz: !binary |-
+    MjA4ZmQ1NDRkZDgwN2JmZDU1YmU4ZmFmMDM0NzhkZjAyZjczMzBiOQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZDkzNGQ4ZTk1ZjZhNjYyYTg0MDU0NzMwNTM2ZTM0MzJhNWQwNmY1OGIyMDY0
+    YjY2NThhMDJhNmMwODc2NjYyNGM4NDg5NzM3OTllZmJhMjVlMzdhMmMzY2Qw
+    ZjU5YzcwNTY3MTdhMWY1NTI0NDU2NGJiMGZkODZiMmVkOWVkYzk=
+  data.tar.gz: !binary |-
+    ZjI0N2FiMTE0MWNiYjVjM2IwZDQ2MGZkN2Y5MWUzNjg2NmVjYWRkZDQzMjU5
+    M2FlMzdjMzM3NmVmZWQxZWVlNzJkM2M1N2VmZGE5OTlhOTBmNzg2ZDI5MmJl
+    MjZmMjdmNTBmNGRiZDNjYTMwZWQ2YjRlZDUxZDFkMDkyNWQ0YzM=

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Steve Jorgensen
+
+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,42 @@
+# SonJay
+
+Symmetrical transformation between structured data and JSON
+
+Allows concrete object/array data model classes to be defined,
+and then allows JSON serialization/parsing from/to an instance
+of one of those classes.
+
+This allows a single body of code to be used to define a JSON
+API structure for a provider and its clients.
+
+Instances of these models can also be used to help keep
+automated tests simple and reliable. Attempts by test setup
+code or code under test to produce incorrectly structured
+data will generally fail in a fast, informative way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'son_jay'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install son_jay
+
+## Usage
+
+- [Serialization](features/json_serialization.feature)
+- [Parsing](features/json_parsing.feature)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/son_jay/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 new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+desc "Run all specs and features"
+task all_tests: %w[spec cucumber cucumber:wip]
+
+task :default => :all_tests
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+
+require "cucumber"
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new :wip do |t|
+    t.profile = 'wip'
+  end
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --tags ~@wip
+wip: --wip --tags @wip

data/features/json_parsing.feature

@@ -0,0 +1,227 @@
+Feature: Parsing data from JSON
+
+  Scenario: Simple object data
+    Given an object model defined as:
+      """
+      class SimpleObjectModel < SonJay::ObjectModel
+        properties do
+          property :id
+          property :name
+          property :published
+          property :featured
+          property :owner
+        end
+      end
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+        {
+            "id"        :  55 ,
+            "name"      : "Polygon" ,
+            "published" :  true ,
+            "featured"  :  false ,
+            "owner"     :  null
+        }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = SimpleObjectModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | id  | name       | published | featured | owner |
+      |  55 |  "Polygon" |  true     |  false   |  nil  |
+
+  Scenario: Composite object data
+    Given an object model defined as:
+      """
+      class ThingModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :details, :model => DetailModel
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class DetailModel < SonJay::ObjectModel
+        properties do
+          property :color
+          property :size
+        end
+      end
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+        {
+            "name" :  "Cherry" ,
+            "details" :
+              {
+                "color" : "red" ,
+                "size"  : "small"
+              }
+        }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = ThingModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | name      | details.color | details.size |
+      |  "Cherry" |  "red"        |  "small"     |
+
+  Scenario: Object data with a value-array property
+    Given an object model defined as:
+      """
+      class ContestantModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :scores, model: []
+        end
+      end
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+        {
+            "name"   : "Pat" ,
+            "scores" : [ 9, 5, 7 ]
+        }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = ContestantModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | name   | scores[0] | scores[1] | scores[2] |
+      |  "Pat" |  9        |  5        |  7        |
+
+  Scenario: Object data with a nested value-array property
+    Given an object model defined as:
+      """
+      class TicTacToeModel < SonJay::ObjectModel
+        properties do
+          property :rows, model: [[]]
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = TicTacToeModel.new
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+        {
+          "rows" : [
+            [ "X", "O", "X" ] ,
+            [ "O", "X", "X" ] ,
+            [ "X", "O", "O" ]
+          ]
+        }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = TicTacToeModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | rows[0][0]   | rows[0][1] | rows[0][2] |
+      |  'X'         |  'O'       |  'X'       |
+      | rows[1][0]   | rows[1][1] | rows[1][2] |
+      |  'O'         |  'X'       |  'X'       |
+      | rows[2][0]   | rows[2][1] | rows[2][2] |
+      |  'X'         |  'O'       |  'O'       |
+
+  Scenario: Object data with an object-array property
+    Given an object model defined as:
+      """
+      class ListModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :items, :model => [ ItemModel ]
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class ItemModel < SonJay::ObjectModel
+        properties do
+          property :description
+          property :priority
+        end
+      end
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+        {
+          "name" :  "Shopping" ,
+          "items" :
+            [
+              {
+                "description" : "Potato Chips" ,
+                "priority"    : "Low"
+              } ,
+              {
+                "description" : "Ice Cream" ,
+                "priority"    : "High"
+              }
+            ]
+        }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = ListModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | name        | items[0].description | items[0].priority | items[1].description | items[1].priority |
+      |  "Shopping" |  "Potato Chips"      |  "Low"            |  "Ice Cream"         |  "High"           |
+
+  Scenario: Object data with a nested object-array property
+    Given an object model defined as:
+      """
+      class TableModel < SonJay::ObjectModel
+        properties do
+          property :rows, :model => [[ CellModel ]]
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class CellModel < SonJay::ObjectModel
+        properties do
+          property :is_head
+          property :value
+        end
+      end
+      """
+    And JSON data defined as:
+      """
+      json = <<-JSON
+      {
+        "rows" :
+          [
+            [ {"is_head": 1, "value": "Date"}  , {"is_head": 1, "value": "Sightings"} ] ,
+            [ {"is_head": 1, "value": "Jan 1"} , {"is_head": 0, "value": 3}           ] ,
+            [ {"is_head": 1, "value": "Jan 3"} , {"is_head": 0, "value": 2}           ]
+          ]
+      }
+      JSON
+      """
+    When the JSON is parsed to a model instance as:
+      """
+      instance = TableModel.json_create( json )
+      """
+    Then the instance attributes are as follows:
+      | rows[0][0].is_head | rows[0][0].value | rows[0][1].is_head | rows[0][1].value |
+      |  1                 |  "Date"          |  1                 |  "Sightings"     |
+      | rows[1][0].is_head | rows[1][0].value | rows[1][1].is_head | rows[1][1].value |
+      |  1                 |  "Jan 1"         |  0                 |  3               |
+      | rows[2][0].is_head | rows[2][0].value | rows[2][1].is_head | rows[2][1].value |
+      |  1                 |  "Jan 3"         |  0                 |  2               |

data/features/json_serialization.feature

@@ -0,0 +1,260 @@
+Feature: Serializing data to JSON
+
+  Scenario: Simple object data
+    Given an object model defined as:
+      """
+      class SimpleObjectModel < SonJay::ObjectModel
+        properties do
+          property :id
+          property :name
+          property :published
+          property :featured
+          property :owner
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = SimpleObjectModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      instance.id        =  55
+      instance.name      = "Polygon"
+      instance.published =  true
+      instance.featured  =  false
+      instance.owner     =  nil
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+          "id"        :  55 ,
+          "name"      : "Polygon" ,
+          "published" :  true ,
+          "featured"  :  false ,
+          "owner"     :  null
+      }
+      """
+
+  Scenario: Composite object data
+    Given an object model defined as:
+      """
+      class ThingModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :details, :model => DetailModel
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class DetailModel < SonJay::ObjectModel
+        properties do
+          property :color
+          property :size
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = ThingModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      instance.name = "Cherry"
+      instance.details.color = "red"
+      instance.details.size  = "small"
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+          "name" :  "Cherry" ,
+          "details" :
+            {
+              "color" : "red" ,
+              "size"  : "small"
+            }
+      }
+      """
+
+  Scenario: Object data with a value-array property
+    Given an object model defined as:
+      """
+      class ContestantModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :scores, model: []
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = ContestantModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      instance.name   = "Pat"
+      instance.scores = [ 9, 5, 7 ]
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+          "name"   : "Pat" ,
+          "scores" : [ 9, 5, 7 ]
+      }
+      """
+
+  Scenario: Object data with a nested value-array property
+    Given an object model defined as:
+      """
+      class TicTacToeModel < SonJay::ObjectModel
+        properties do
+          property :rows, model: [[]]
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = TicTacToeModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      instance.rows.additional.concat %w[ X O X ]
+      instance.rows.additional.concat %w[ O X X ]
+      instance.rows.additional.concat %w[ X O O ]
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+        "rows" : [
+          [ "X", "O", "X" ] ,
+          [ "O", "X", "X" ] ,
+          [ "X", "O", "O" ]
+        ]
+      }
+      """
+
+  Scenario: Object data with an object-array property
+    Given an object model defined as:
+      """
+      class ListModel < SonJay::ObjectModel
+        properties do
+          property :name
+          property :items, :model => [ ItemModel ]
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class ItemModel < SonJay::ObjectModel
+        properties do
+          property :description
+          property :priority
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = ListModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      instance.name = "Shopping"
+
+      item = instance.items.additional
+      item.description = 'Potato Chips'
+      item.priority    = 'Low'
+
+      item = instance.items.additional
+      item.description = 'Ice Cream'
+      item.priority    = 'High'
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+        "name" :  "Shopping" ,
+        "items" :
+          [
+            {
+              "description" : "Potato Chips" ,
+              "priority"    : "Low"
+            } ,
+            {
+              "description" : "Ice Cream" ,
+              "priority"    : "High"
+            }
+          ]
+      }
+      """
+
+  Scenario: Object data with a nested object-array property
+    Given an object model defined as:
+      """
+      class TableModel < SonJay::ObjectModel
+        properties do
+          property :rows, :model => [[ CellModel ]]
+        end
+      end
+      """
+    And an object model defined as:
+      """
+      class CellModel < SonJay::ObjectModel
+        properties do
+          property :is_head
+          property :value
+        end
+      end
+      """
+    And a model instance defined as:
+      """
+      instance = TableModel.new
+      """
+    When the instance's property values are assigned as:
+      """
+      row_cells = instance.rows.additional
+      row_cells.additional.tap{ |c| c.is_head=1 ; c.value='Date'      }
+      row_cells.additional.tap{ |c| c.is_head=1 ; c.value='Sightings' }
+
+      row_cells = instance.rows.additional
+      row_cells.additional.tap{ |c| c.is_head=1 ; c.value='Jan 1' }
+      row_cells.additional.tap{ |c| c.is_head=0 ; c.value=3       }
+
+      row_cells = instance.rows.additional
+      row_cells.additional.tap{ |c| c.is_head=1 ; c.value='Jan 3' }
+      row_cells.additional.tap{ |c| c.is_head=0 ; c.value=2       }
+      """
+    And the model is serialized to JSON as:
+      """
+      json = instance.to_json
+      """
+    Then the resulting JSON is equivalent to:
+      """
+      {
+        "rows" :
+          [
+            [ {"is_head": 1, "value": "Date"}  , {"is_head": 1, "value": "Sightings"} ] ,
+            [ {"is_head": 1, "value": "Jan 1"} , {"is_head": 0, "value": 3}           ] ,
+            [ {"is_head": 1, "value": "Jan 3"} , {"is_head": 0, "value": 2}           ]
+          ]
+      }
+      """

data/features/step_definitions/json_parsing_steps.rb

@@ -0,0 +1,26 @@
+Given(/^JSON data defined as:$/) do |code|
+  json = nil
+  context_module.module_eval code
+  context_data[:json] = json
+end
+
+When(/^the JSON is parsed to a model instance as:$/) do |code|
+  json = context_data[:json]
+  instance = nil
+  context_module.module_eval code
+  context_data[:instance] = instance
+end
+
+Then(/^the instance attributes are as follows:$/) do |table|
+  row_pairs = table.raw.each_slice(2)
+  attribute_exprs = row_pairs.map( &:first ).reduce( :+ )
+  expected_exprs  = row_pairs.map( &:last  ).reduce( :+ )
+
+  instance = context_data[:instance]
+  actuals   = attribute_exprs .map{ |expr| eval( "instance.#{expr}" ) }
+  expecteds = expected_exprs  .map{ |expr| eval(  expr              ) }
+
+  actual_hash   = Hash[ attribute_exprs.zip( actuals   ) ]
+  expected_hash = Hash[ attribute_exprs.zip( expecteds ) ]
+  expect( actual_hash ).to eq( expected_hash )
+end

data/features/step_definitions/json_serialization_steps.rb

@@ -0,0 +1,23 @@
+Given(/^a model instance defined as:$/) do |code|
+  instance = nil
+  context_module.module_eval code
+  context_data[:instance] = instance
+end
+
+When(/^the instance's property values are assigned as:$/) do |code|
+  instance = context_data[:instance]
+  context_module.module_eval code
+end
+
+When(/^the model is serialized to JSON as:$/) do |code|
+  instance = context_data[:instance]
+  json = nil
+  context_module.module_eval code
+  context_data[:json] = json
+end
+
+Then(/^the resulting JSON is equivalent to:$/) do |expected_json_equivalent|
+  expected_data = JSON.parse( expected_json_equivalent )
+  actual_data = JSON.parse( context_data[:json] )
+  expect( actual_data ).to eq( expected_data )
+end

data/features/step_definitions/model_steps.rb

@@ -0,0 +1,3 @@
+Given(/^an object model defined as:$/) do |code|
+  context_module.module_eval code
+end