json_mapper 0.1.1

data/.gitignore

@@ -0,0 +1,3 @@
+.document
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem "json", ">= 1.4.3"
+
+group :development do
+  gem "shoulda", ">= 2.10.3"
+  gem "mcmire-matchy", ">= 0.5.2"
+  gem "mocha", ">= 0.9.8"
+end
+ 

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Trond Arve Nordheim
+
+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.rdoc

@@ -0,0 +1,95 @@
+= JSON Mapper
+by Trond Arve Nordheim -
+{Binary Marbles}[http://www.binarymarbles.com/]
+
+== NOTICE
+
+This is a project under heavy development. The API is far from stable yet, and
+the code is very unclean in some places. The API won't be considered stable
+until full tests are available verifying that all functionality is working as
+expected.
+
+== Description
+
+A Ruby gem for mapping data from JSON data structures into Ruby class representations.
+
+== Features
+
+* Simple one to one mappings
+* Complex mappings (many to one)
+* Associations
+* Type checking
+
+== Usage
+
+=== Simple one to one mapping
+  class Model
+
+    include JSONMapper
+
+    # Map the "id" attribute from the JSON data structure to the id attribute of the class,
+    # using Integer as the data type
+    json_attribute :id, Integer
+
+    # Map the "model_title" attribute from the JSON data structure to the title attribute of
+    # the class, using String as the data type
+    json_attribute :title, :model_title, String
+  
+  end
+
+=== Complex many to one mapping
+  class Model
+
+    include JSONMapper
+
+    # Map the "id", "model_id" or "modelid" attribute (whatever is located first) from the
+    # JSON data structure to the id attribute of the class, using Integer as the data type
+    json_attribute :id, [ :id, :model_id, :modelid ], Integer
+
+  end
+
+=== Associations
+  class AssociatedClass
+
+    include JSONMapper
+
+    # Map the "id" of the JSON data structure to the id attribute of the class, using
+    # Integer as the data type
+    json_attribute :id, Integer
+
+  end
+
+  class Model
+
+    include JSONMapper
+
+    # Map the "association" attribute from the JSON data structure to an instance of
+    # the AssociatedClass class, mapping it to the association attribute of the class.
+    json_attribute :association, AssociatedClass 
+
+    # Map all entries in the "associations" array from the JSON data structure to
+    # an array of AssociatedClass instances, mapping them to the associations attribute
+    # of the class
+    json_attributes :associations, AssociatedClass 
+
+  end
+
+== Requirements
+
+* {json}[http://rubygems.org/gems/json]
+
+== Installation
+
+ $ gem install json_mapper
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Trond Arve Nordheim. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,33 @@
+require "rake"
+require "jeweler"
+require "bundler"
+require "rake/testtask"
+
+# Gemcutter/Jeweler configuration
+# ----------------------------------------------------------------------------
+Jeweler::Tasks.new do |gem|
+  
+  gem.name = "json_mapper"
+  gem.summary = "Ruby gem for mapping JSON data structures to Ruby classes"
+  gem.email = "tanordheim@gmail.com"
+  gem.homepage = "http://github.com/tanordheim/json_mapper"
+  gem.authors = [ "Trond Arve Nordheim" ]
+
+  gem.add_bundler_dependencies
+
+end
+Jeweler::GemcutterTasks.new
+
+# Test setup
+# ----------------------------------------------------------------------------
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.ruby_opts << "-rubygems"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+# Task setups
+# ----------------------------------------------------------------------------
+task :test => :check_dependencies
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/init.rb

@@ -0,0 +1,2 @@
+directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, "lib", "json_mapper")

data/json_mapper.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{json_mapper}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Trond Arve Nordheim"]
+  s.date = %q{2010-08-08}
+  s.email = %q{tanordheim@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "json_mapper.gemspec",
+     "lib/json_mapper.rb",
+     "lib/json_mapper/attribute.rb",
+     "lib/json_mapper/attribute_list.rb",
+     "test.rb",
+     "test/fixtures/complex.json",
+     "test/fixtures/simple.json",
+     "test/json_mapper_test.rb",
+     "test/support/models.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tanordheim/json_mapper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby gem for mapping JSON data structures to Ruby classes}
+  s.test_files = [
+    "test/support/models.rb",
+     "test/test_helper.rb",
+     "test/json_mapper_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 1.4.3"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.3"])
+      s.add_development_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<json>, [">= 1.4.3"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.3"])
+      s.add_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.4.3"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.3"])
+    s.add_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

data/lib/json_mapper.rb

@@ -0,0 +1,144 @@
+require "json"
+
+class Boolean; end
+
+module JSONMapper
+
+  def self.included(base)
+    base.instance_variable_set("@attributes", {})
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def json_attribute(name, *args)
+
+      source_attributes, type = extract_attribute_data(name, *args)
+      attribute = Attribute.new(name, source_attributes, type)
+      @attributes[to_s] ||= []
+      @attributes[to_s] << attribute
+
+      attr_accessor attribute.method_name.to_sym
+
+    end
+
+    def json_attributes(name, *args)
+
+      source_attributes, type = extract_attribute_data(name, *args)
+      attribute = AttributeList.new(name, source_attributes, type)
+      @attributes[to_s] ||= []
+      @attributes[to_s] << attribute
+
+      attr_accessor attribute.method_name.to_sym
+
+    end
+
+    def attributes
+      @attributes[to_s] || []
+    end
+
+    def parse(data)
+
+      # Parse the data into a hash
+      json = JSON.parse(data, { :symbolize_names => true })
+
+      # Parse the JSON data structure
+      parse_json(json)
+
+    end
+
+    def parse_json(json)
+      
+      # Create a new instance of ourselves
+      instance = new
+
+      # Instantiate all AttributeList instances
+      attributes.each do |attribute|
+        if attribute.is_a?(AttributeList)
+          instance.send("#{attribute.name}=", attribute.dup)
+        end
+      end
+
+      # Traverse all defined attributes and assign data from the
+      # JSON data structure
+      attributes.each do |attribute|
+        if is_mapped?(attribute, json)
+          value = mapping_value(attribute, json)
+          if attribute.is_a?(AttributeList)
+            value = [ value ] unless value.is_a?(Array)
+            value.each do |v|
+              instance.send("#{attribute.name}") << build_attribute(attribute.name, attribute.type).typecast(v)
+            end
+          else
+            instance.send("#{attribute.name}=".to_sym, attribute.typecast(value))
+          end
+        end
+      end
+
+      instance
+
+    end
+
+    private
+
+    def build_attribute(name, type)
+      Attribute.new(name, name, type)
+    end
+
+    def extract_attribute_data(name, *args)
+
+      # If args is not an array, or it contains 0 elements,
+      # throw an argument error as we at least need the data
+      # type for the mapping specified.
+      if !args.is_a?(Array) || args.empty?
+        raise ArgumentError.new("Type parameter is required")
+      end
+
+      # If the first argument is a symbol or an array, that's
+      # a specific source attribute mapping. If not, use the
+      # specified name as the source attribute name.
+      if args[0].is_a?(Symbol) || args[0].is_a?(Array)
+        source_attributes = args.delete_at(0)
+      else
+        source_attributes = name
+      end
+
+      # The remaining first argument must be a valid data type
+      if args[0].is_a?(Class)
+        type = args[0]
+      else
+        raise ArgumentError.new("Invalid type parameter specified")
+      end
+
+      return source_attributes, type
+ 
+    end
+
+    def is_mapped?(attribute, json)
+
+      attribute.source_attributes.each do |source_attribute|
+        if json.key?(source_attribute)
+          return true
+        end
+      end
+      return false
+
+    end
+
+    def mapping_value(attribute, json)
+      
+      attribute.source_attributes.each do |source_attribute|
+        if json.key?(source_attribute)
+          return json[source_attribute]
+        end
+      end
+      return nil
+
+    end
+
+  end
+
+end
+
+require "json_mapper/attribute"
+require "json_mapper/attribute_list"

data/lib/json_mapper/attribute.rb

@@ -0,0 +1,40 @@
+class Attribute
+
+  attr_accessor :name, :source_attributes, :type
+
+  Types = [ String, Integer, Boolean ]
+
+  def initialize(name, source_attributes, type)
+    
+    self.name = name
+    self.source_attributes = source_attributes.is_a?(Array) ? source_attributes : [ source_attributes ]
+    self.type = type
+
+  end
+
+  def method_name
+    @method_name ||= self.name.to_s.tr("-", "_")
+  end
+
+  def typecast(value)
+
+    return value if value.nil?
+
+    if self.type == String then return value.to_s
+    elsif self.type == Integer then return value.to_i
+    elsif self.type == Boolean then return value.to_s == "true"
+    else
+
+      # If our type is a JSONMapper instance, delegate the
+      # mapping to that class
+      if self.type.new.is_a?(JSONMapper)
+        return self.type.parse_json(value)
+      else
+        return value
+      end
+
+    end
+
+  end
+
+end

data/lib/json_mapper/attribute_list.rb

@@ -0,0 +1,20 @@
+class AttributeList < ::Array
+
+  attr_accessor :name, :source_attributes, :type
+
+  def initialize(name, source_attributes, type)
+
+    self.name = name
+    self.source_attributes = source_attributes.is_a?(Array) ? source_attributes : [ source_attributes ]
+    self.type = type
+
+  end
+
+  def method_name
+    @method_name ||= self.name.to_s.tr("-", "_")
+  end
+
+  def typecast
+  end
+  
+end

data/test.rb

@@ -0,0 +1,28 @@
+module TestModule
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def foo
+      attr_accessor :test
+    end
+  end
+end
+
+class TestClass
+  include TestModule
+  foo
+end
+
+t = TestClass.new
+t.test = "test"
+puts "Test is #{t.test}"
+
+t2 = Class.new do
+  include TestModule
+  foo
+end
+
+t2.test = "foo"
+puts "Test is #{t2.test}"

data/test/fixtures/complex.json

@@ -0,0 +1,21 @@
+{
+  "id": 1,
+  "title": "Complex JSON title",
+  "simple": {
+    "id": 1,
+    "title": "Simple JSON title",
+    "boolean": true
+  },
+  "simples": [
+    {
+      "id": 1,
+      "title": "Simple JSON title #1",
+      "boolean": true
+    },
+    {
+      "id": 2,
+      "title": "Simple JSON title #2",
+      "boolean": true
+    }
+  ]
+}

data/test/fixtures/simple.json

@@ -0,0 +1,5 @@
+{
+  "id": 1,
+  "title": "Simple JSON title",
+  "boolean": true
+}

data/test/json_mapper_test.rb

@@ -0,0 +1,104 @@
+require "test_helper"
+require "support/models"
+
+class JSONMapperTest < Test::Unit::TestCase
+
+  context "included in a model class" do
+
+    setup do
+      @klass = Class.new do
+        include JSONMapper
+        def to_s
+          "TestUnitClass"
+        end
+      end
+    end
+
+    should "initialize empty attributes array" do
+      @klass.attributes.should == []
+    end
+
+    should "allow adding a simple attribute mapping" do
+
+      @klass.json_attribute :id, Integer
+
+      @klass.attributes.size.should == 1
+      @klass.attributes.first.name.should == :id
+      @klass.attributes.first.source_attributes.should == [ :id ]
+      @klass.attributes.first.type.should == Integer
+      @klass.attributes.first.method_name.should == "id"
+
+    end
+
+    should "allow adding a complex attribute mapping" do
+      @klass.json_attribute :id, [ :id, :attribute_id, :foo_id ], Integer
+      @klass.attributes.size.should == 1
+      @klass.attributes.first.name.should == :id
+      @klass.attributes.first.source_attributes.should == [ :id, :attribute_id, :foo_id ]
+      @klass.attributes.first.type.should == Integer
+      @klass.attributes.first.method_name.should == "id"
+    end
+
+    should "parse simple json structure into a ruby object" do
+      model = SimpleModel.parse(fixture_file("simple.json"))
+      model.id.should == 1
+      model.title.should == "Simple JSON title"
+      model.boolean.should == true
+    end
+
+    should "assign value from different sources into an attribute" do
+
+      model = ComplexModel.parse('{ "id": 1 }')
+      model.id.should == 1
+
+      model = ComplexModel.parse('{ "attribute_id": 1 }')
+      model.id.should == 1
+
+    end
+
+    should "not overwrite initial value when assigning values from different sources into an attribute" do
+
+      model = ComplexModel.parse('{ "id": 1, "attribute_id": 2 }')
+      model.id.should == 1
+
+    end
+    
+    should "assign another model into an attribute" do
+
+      model = ComplexModel.parse('{ "simple": { "id": 1 } }')
+      model.simple.id.should == 1
+
+    end
+
+    should "assign an array into an attribute" do
+
+      model = ComplexModel.parse('{ "integers": [ 1, 2, 3 ] }')
+      model.integers.should == [ 1, 2, 3 ]
+
+    end
+
+    should "assign an array of models into an attribute" do
+
+      model = ComplexModel.parse('{ "simples": [{ "id": 1 }, { "id": 2 }] }')
+      model.simples.size.should == 2
+      model.simples.first.id.should == 1
+      model.simples.last.id.should == 2
+
+    end
+
+    should "parse complex json structure into a ruby object" do
+      model = ComplexModel.parse(fixture_file("complex.json"))
+      model.id.should == 1
+      model.model_title.should == "Complex JSON title"
+      model.simple.id.should == 1
+      model.simple.title.should == "Simple JSON title"
+      model.simples.size.should == 2
+      model.simples.first.id.should == 1
+      model.simples.first.title.should == "Simple JSON title #1"
+      model.simples.last.id.should == 2
+      model.simples.last.title.should == "Simple JSON title #2"
+    end
+
+  end
+
+end

data/test/support/models.rb

@@ -0,0 +1,21 @@
+class SimpleModel
+
+  include JSONMapper
+
+  json_attribute :id, Integer
+  json_attribute :title, String
+  json_attribute :boolean, Boolean
+
+end
+
+class ComplexModel
+
+  include JSONMapper
+
+  json_attribute :id, [ :id, :attribute_id ], Integer
+  json_attribute :model_title, :title, String
+  json_attribute :simple, SimpleModel
+  json_attributes :simples, SimpleModel
+  json_attributes :integers, Integer
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "test/unit"
+require "shoulda"
+require "matchy"
+require "mocha"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "json_mapper"
+
+class Test::Unit::TestCase
+end
+
+# Load a fixture file and return the contents
+def fixture_file(filename)
+  
+  return "" if filename == ""
+  file_path = File.expand_path(File.dirname(__FILE__) + "/fixtures/" + filename)
+  File.read(file_path)
+
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: json_mapper
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Trond Arve Nordheim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: mcmire-matchy
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: mocha
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  requirement: *id004
+  type: :development
+description: 
+email: tanordheim@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- json_mapper.gemspec
+- lib/json_mapper.rb
+- lib/json_mapper/attribute.rb
+- lib/json_mapper/attribute_list.rb
+- test.rb
+- test/fixtures/complex.json
+- test/fixtures/simple.json
+- test/json_mapper_test.rb
+- test/support/models.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/tanordheim/json_mapper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby gem for mapping JSON data structures to Ruby classes
+test_files: 
+- test/support/models.rb
+- test/test_helper.rb
+- test/json_mapper_test.rb