motion-json-decoder 0.0.1

data/README.md

@@ -0,0 +1,82 @@
+motion-json-decoder
+===================
+
+Turn JSON nodes into proper Ruby objects.
+
+Installation
+------------
+* Add `motion-json-decoder` to your Gemfile and run `bundle`.
+* Add `require 'motion-json-decoder` to your Rakefile.
+
+Basic Example
+-------------
+
+Let's say you have a RubyMotion app which parses this response from the server:
+
+    {
+      "people":
+        [
+          {
+            "first_name": "John",
+            "last_name": "Smith",
+            "date_of_birth": "1980-01-03"
+          },
+          {
+            "first_name": "Joe",
+            "last_name": "Bloggs",
+            "date_of_birth": "1967-10-11"
+          }
+        ]
+    }
+
+So that's a *people* collection which contains two *person* nodes.
+
+There may be a number of place in your app where you want to display a person's full name:
+
+    names = []
+    json['people'].each do |person|
+      full_name = person['first_name'] + ' ' + person['last_name']
+      names << full_name
+    end
+
+But doing this in multiply places isn't DRY. You could write a helper method, but it's hard to think where
+that should live.
+
+*motion-json-decoder* allows the creating of a mapping between your JSON nodes and simple objects. Just include the module in your class:
+
+    class Person
+      include JSONDecoder::Node
+
+      field :first_name
+      field :last_name
+
+      def full_name
+        first_name + ' ' + last_name
+      end
+    end
+
+You can then treat person as a proper object:
+
+    names = []
+    json['people'].each do |person_node|
+      person = Person.new person_node
+      names << person.full_name
+    end
+
+Typo Catching
+-------------
+
+Under the hood, motion-json-decoder uses Hash#fetch rather than Hash#[], so if you call a field which doesn't exist, you'll get an exception right away, rather than a potentially difficult-to-debug nil return value.
+
+Collections
+------------
+
+You can specify that a nodes contains a collection of other 'resources' rather than a simple literals:
+
+    collection :organisations, :class_name -> { Organisation }
+
+class_name parameter should be another class which includes the `JSONDecoder::Node` module.
+
+When you call json.people, rather than array of hashes, you'll get an array of Organisation objects.
+
+The use of the lambda (->) is to avoid dependency resolution problems at compile time.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/motion-json-decoder.rb

@@ -0,0 +1,15 @@
+unless ENV['SKIP_RM_CHECK']
+  unless defined?(Motion::Project::Config)
+    raise "This file must be required within a RubyMotion project Rakefile."
+  end
+
+  Motion::Project::App.setup do |app|
+    Dir.glob(File.join(File.dirname(__FILE__), 'motion_json_decoder/*.rb')).each do |file|
+      app.files.unshift(file)
+    end
+  end
+end
+
+require 'motion_json_decoder/version'
+require 'motion_json_decoder/node'
+require 'motion_json_decoder/date_parser'

data/lib/motion_json_decoder/date_parser.rb

@@ -0,0 +1,14 @@
+module JSONDecoder
+  class DateParser
+    def initialize(format = "yyyy-MM-dd")
+      @format = format
+    end
+
+    def parse(date_string)
+      date_formatter = NSDateFormatter.alloc.init
+      date_formatter.setDateFormat @format
+      result = date_formatter.dateFromString date_string
+      result or raise "Failed to parse date '#{date_string}' using format '#{format}'"
+    end
+  end
+end

data/lib/motion_json_decoder/node.rb

@@ -0,0 +1,49 @@
+
+module JSONDecoder
+  module Node
+    def initialize(json)
+      self.json = json
+    end
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def field(field_name, opts = {})
+        type = opts[:type]
+        klass = opts[:using]
+        raise "Cannot use :type and :using together" if type && klass
+        method_name = opts[:as] || field_name
+        define_method method_name do
+          result = json[field_name.to_s]
+          if type == :date
+            JSONDecoder::DateParser.new.parse(result) # TODO move this into lib if gemifying
+          elsif klass
+            klass.new result
+          else
+            result
+          end
+        end
+      end
+
+      def collection(name, opts = {})
+        klass = opts.fetch(:class_name)
+        define_method name do
+          # Using a block to avoid dependency reolutions problems.
+          lambda do
+            json.fetch(name.to_s).map { |element| klass.call.new(element) }
+          end.call
+        end
+      end
+    end
+
+    def links
+      json[:_links]
+    end
+
+    private
+
+    attr_accessor :json
+  end
+end

data/lib/motion_json_decoder/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module JSONDecoder
+    VERSION = "0.0.1"
+  end
+end

data/motion-json-decoder.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/motion_json_decoder/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "motion-json-decoder"
+  gem.authors       = ["Andy Waite"]
+  gem.email         = ["andy@andywaite.com"]
+  gem.description   = "Turn JSON nodes into rich Ruby objects"
+  gem.summary       = "JSON decoder for RubyMotion"
+  gem.homepage      = "https://github.com/andyw8/motion-json-decoder"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.version       = Motion::JSONDecoder::VERSION
+  gem.add_development_dependency 'rspec'
+end

data/spec/motion_json_decoder/node_spec.rb

@@ -0,0 +1,47 @@
+require 'motion_json_decoder'
+
+describe "JSONDecoder::Node" do
+  it "exposes fields" do
+    class Foo
+      include JSONDecoder::Node
+      field :first_name
+    end
+
+    json_hash = {'first_name' => 'Andy'}
+    node = Foo.new json_hash
+    node.first_name.should == 'Andy'
+  end
+
+  it "allows fields to be aliased" do
+    class Foo
+      include JSONDecoder::Node
+      field :first_name, as: 'forename'
+    end
+
+    json_hash = {'first_name' => 'Andy'}
+    node = Foo.new json_hash
+    node.forename.should == 'Andy'
+  end
+
+  it "handles collections" do
+    class Organisation
+      include JSONDecoder::Node
+      field :name
+    end
+
+    class Foo
+      include JSONDecoder::Node
+      collection :organisations, class_name: -> { Organisation }
+    end
+
+    json_hash = {
+      'organisations' =>
+        [
+          {'name' => 'Reddit'},
+          {'name' => 'Hacker News'}
+        ]
+    }
+    node = Foo.new json_hash
+    node.organisations.map(&:name).should == ['Reddit', 'Hacker News']
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: motion-json-decoder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andy Waite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Turn JSON nodes into rich Ruby objects
+email:
+- andy@andywaite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/motion-json-decoder.rb
+- lib/motion_json_decoder/date_parser.rb
+- lib/motion_json_decoder/node.rb
+- lib/motion_json_decoder/version.rb
+- motion-json-decoder.gemspec
+- spec/motion_json_decoder/node_spec.rb
+homepage: https://github.com/andyw8/motion-json-decoder
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: JSON decoder for RubyMotion
+test_files:
+- spec/motion_json_decoder/node_spec.rb