json_mapper 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/json_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{json_mapper}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   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.date = %q{2010-08-09}
   s.email = %q{tanordheim@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/json_mapper.rb",
      "lib/json_mapper/attribute.rb",
      "lib/json_mapper/attribute_list.rb",
+     "lib/json_mapper/parser.rb",
      "test.rb",
      "test/fixtures/complex.json",
      "test/fixtures/simple.json",

data/lib/json_mapper.rb

@@ -1,11 +1,13 @@
 require "json"
 
 class Boolean; end
+class DelimitedString; end
 
 module JSONMapper
 
   def self.included(base)
     base.instance_variable_set("@attributes", {})
+    base.instance_variable_set("@json_data", {})
     base.extend ClassMethods
   end
 
@@ -13,8 +15,8 @@ module JSONMapper
 
     def json_attribute(name, *args)
 
-      source_attributes, type = extract_attribute_data(name, *args)
-      attribute = Attribute.new(name, source_attributes, type)
+      source_attributes, type, options = extract_attribute_data(name, *args)
+      attribute = Attribute.new(name, source_attributes, type, options)
       @attributes[to_s] ||= []
       @attributes[to_s] << attribute
 
@@ -24,8 +26,8 @@ module JSONMapper
 
     def json_attributes(name, *args)
 
-      source_attributes, type = extract_attribute_data(name, *args)
-      attribute = AttributeList.new(name, source_attributes, type)
+      source_attributes, type, options = extract_attribute_data(name, *args)
+      attribute = AttributeList.new(name, source_attributes, type, options)
       @attributes[to_s] ||= []
       @attributes[to_s] << attribute
 
@@ -37,17 +39,30 @@ module JSONMapper
       @attributes[to_s] || []
     end
 
-    def parse(data)
+    def json_data
+      @json_data[to_s] || []
+    end
 
-      # Parse the data into a hash
-      json = JSON.parse(data, { :symbolize_names => true })
+    def parse(data, options = {})
 
-      # Parse the JSON data structure
+      return nil if data.nil? || data == ""
+      json = get_json_structure(data, options)
       parse_json(json)
 
     end
 
+    def parse_collection(data, options = {})
+
+      return [] if data.nil? || data == ""
+      json = get_json_structure(data, options)
+      parse_json_collection(json)
+
+    end
+
     def parse_json(json)
+
+      # Set the JSON data for this instance
+      @json_data[to_s] = json
       
       # Create a new instance of ourselves
       instance = new
@@ -67,7 +82,19 @@ module JSONMapper
           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)
+
+              list_attribute = build_attribute(attribute.name, attribute.type, attribute.options)
+              list_attribute_value = list_attribute.typecast(v)
+
+              # Some times typecasting a value for a list will produce another list, in the case of
+              # for instance DelimitedString. If this is the case, we concat that array to the list.
+              # Otherwise, we just append the value.
+              if list_attribute_value.is_a?(Array)
+                instance.send("#{attribute.name}").concat(list_attribute_value)
+              else
+                instance.send("#{attribute.name}") << list_attribute_value
+              end
+
             end
           else
             instance.send("#{attribute.name}=".to_sym, attribute.typecast(value))
@@ -79,10 +106,43 @@ module JSONMapper
 
     end
 
+    def parse_json_collection(json)
+
+      collection = []
+
+      if json.is_a?(Array)
+        json.each do |element|
+          collection << parse_json(element)
+        end
+      end
+
+      collection
+
+    end
+
     private
 
-    def build_attribute(name, type)
-      Attribute.new(name, name, type)
+    def get_json_structure(data, options = {})
+      
+      # Parse the data into a hash
+      json = Parser.parse(data)
+
+      # If we need to shift the structure, do that now
+      shift = options.delete(:shift)
+      unless shift.nil?
+        shift = [ shift ] unless shift.is_a?(Array)
+        shift.each do |s|
+          break unless json.key?(s) # Break out if we can't find the element we're looking for
+          json = json[s]
+        end
+      end
+
+      json
+
+    end
+
+    def build_attribute(name, type, options)
+      Attribute.new(name, name, type, options)
     end
 
     def extract_attribute_data(name, *args)
@@ -94,10 +154,10 @@ module JSONMapper
         raise ArgumentError.new("Type parameter is required")
       end
 
-      # If the first argument is a symbol or an array, that's
+      # If the first argument is a symbol, string 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)
+      if args[0].is_a?(Symbol) || args[0].is_a?(Array) || args[0].is_a?(String) || args[0].is_a?(Hash)
         source_attributes = args.delete_at(0)
       else
         source_attributes = name
@@ -105,19 +165,40 @@ module JSONMapper
 
       # The remaining first argument must be a valid data type
       if args[0].is_a?(Class)
-        type = args[0]
+        type = args.delete_at(0)
       else
         raise ArgumentError.new("Invalid type parameter specified")
       end
 
-      return source_attributes, type
+      # If we have anything remaining, and it's a hash, use it as our options
+      options = {}
+      if !args.empty? && args.first.is_a?(Hash)
+        options = args.delete_at(0)
+      end
+
+      return source_attributes, type, options
  
     end
 
     def is_mapped?(attribute, json)
 
+      # Just return true if this attribute is potentially self-referencing
+      return true if attribute.self_referential?
+
+      # Return false if our JSON isn't a hash or an array
+      return false unless json.is_a?(Hash) || json.is_a?(Array)
+
       attribute.source_attributes.each do |source_attribute|
-        if json.key?(source_attribute)
+
+        # If the source attribute is a hash, do a key/value lookup on the json data
+        if source_attribute.is_a?(Hash)
+
+          source_key = source_attribute.keys.first
+          if json.key?(source_key) && json[source_key].is_a?(Hash) && json[source_key].key?(source_attribute[source_key])
+            return true
+          end
+
+        elsif json.key?(source_attribute)
           return true
         end
       end
@@ -127,11 +208,29 @@ module JSONMapper
 
     def mapping_value(attribute, json)
       
+      # Return nil if our JSON isn't a hash or an array
+      return nil unless json.is_a?(Hash) || json.is_a?(Array)
+
       attribute.source_attributes.each do |source_attribute|
-        if json.key?(source_attribute)
+        
+        # If the source attribute is a hash, do a key/value lookup on the json data
+        if source_attribute.is_a?(Hash)
+
+          source_key = source_attribute.keys.first
+          if json.key?(source_key) && json[source_key].key?(source_attribute[source_key])
+            return json[source_key][source_attribute[source_key]]
+          end
+
+         elsif json.key?(source_attribute)
           return json[source_attribute]
         end
+
       end
+
+      # If no mapping could be found and this attribute is potentially
+      # self-referencing, return the current JSON data as the mapped value
+      return json_data if attribute.self_referential?
+
       return nil
 
     end
@@ -140,5 +239,6 @@ module JSONMapper
 
 end
 
+require "json_mapper/parser"
 require "json_mapper/attribute"
 require "json_mapper/attribute_list"

data/lib/json_mapper/attribute.rb

@@ -1,14 +1,13 @@
 class Attribute
 
-  attr_accessor :name, :source_attributes, :type
+  attr_accessor :name, :source_attributes, :type, :options
 
-  Types = [ String, Integer, Boolean ]
-
-  def initialize(name, source_attributes, type)
+  def initialize(name, source_attributes, type, options = {})
     
     self.name = name
     self.source_attributes = source_attributes.is_a?(Array) ? source_attributes : [ source_attributes ]
     self.type = type
+    self.options = options
 
   end
 
@@ -16,13 +15,32 @@ class Attribute
     @method_name ||= self.name.to_s.tr("-", "_")
   end
 
+  def self_referential?
+    self.source_attributes.include?("self")
+  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"
+    elsif self.type == DelimitedString
+      self.options[:delimiter] ||= ","
+      return value.split(self.options[:delimiter])
+    elsif self.type == Integer
+      begin
+        return value.to_i
+      rescue
+        return nil
+      end
+    elsif self.type == Float
+      begin
+        return value.to_f
+      rescue
+        return nil
+      end
+    elsif self.type == Boolean then return %w(true t 1).include?(value.to_s.downcase)
+    elsif self.type == DateTime then return Date.parse(value.to_s)
     else
 
       # If our type is a JSONMapper instance, delegate the

data/lib/json_mapper/attribute_list.rb

@@ -1,12 +1,13 @@
 class AttributeList < ::Array
 
-  attr_accessor :name, :source_attributes, :type
+  attr_accessor :name, :source_attributes, :type, :options
 
-  def initialize(name, source_attributes, type)
+  def initialize(name, source_attributes, type, options = {})
 
     self.name = name
     self.source_attributes = source_attributes.is_a?(Array) ? source_attributes : [ source_attributes ]
     self.type = type
+    self.options = options
 
   end
 
@@ -16,5 +17,9 @@ class AttributeList < ::Array
 
   def typecast
   end
+
+  def self_referential?
+    false # Attribute lists can't be self referential
+  end
   
 end

data/lib/json_mapper/parser.rb

@@ -0,0 +1,11 @@
+module JSONMapper
+  class Parser
+
+    # Parse the JSON string into a Hash
+    def self.parse(data)
+      return nil if data.nil? || data == ""
+      JSON.parse(data, { :symbolize_names => true })
+    end
+
+  end
+end

data/test/fixtures/complex.json

@@ -6,6 +6,9 @@
     "title": "Simple JSON title",
     "boolean": true
   },
+  "nested": {
+    "test": "foo bar"
+  },
   "simples": [
     {
       "id": 1,

data/test/fixtures/simple.json

@@ -1,5 +1,7 @@
 {
   "id": 1,
+  "money": 125.50,
   "title": "Simple JSON title",
-  "boolean": true
+  "boolean": true,
+  "datetime": "2010-10-08 17:59:46"
 }

data/test/json_mapper_test.rb

@@ -42,8 +42,10 @@ class JSONMapperTest < Test::Unit::TestCase
     should "parse simple json structure into a ruby object" do
       model = SimpleModel.parse(fixture_file("simple.json"))
       model.id.should == 1
+      model.money.should == 125.50
       model.title.should == "Simple JSON title"
       model.boolean.should == true
+      model.datetime.should == Date.parse("2010-10-08 17:59:46")
     end
 
     should "assign value from different sources into an attribute" do
@@ -92,6 +94,7 @@ class JSONMapperTest < Test::Unit::TestCase
       model.model_title.should == "Complex JSON title"
       model.simple.id.should == 1
       model.simple.title.should == "Simple JSON title"
+      model.nested_test.should == "foo bar"
       model.simples.size.should == 2
       model.simples.first.id.should == 1
       model.simples.first.title.should == "Simple JSON title #1"
@@ -99,6 +102,53 @@ class JSONMapperTest < Test::Unit::TestCase
       model.simples.last.title.should == "Simple JSON title #2"
     end
 
+    should "be able to shift into a data structure to find the root element" do
+
+      json = '{ "foo": { "id": 1 } }'
+      model = SimpleModel.parse(json, :shift => :foo)
+      model.id.should == 1
+
+    end
+
+    should "be able to shift deep into a data structure to find the root element" do
+
+      json = '{ "foo": { "bar": { "id": 1 } } }'
+      model = SimpleModel.parse(json, :shift => [ :foo, :bar ])
+      model.id.should == 1
+
+    end
+
+    should "generate a collection of objects from an array" do
+
+      json = '[ { "id": 1 }, { "id": 2 } ]'
+      models = SimpleModel.parse_collection(json)
+      models.size.should == 2
+      
+      models.first.id.should == 1
+      models.last.id.should == 2
+
+    end
+
+    should "be able to use a delimited string as an array" do
+
+      json = '{ "delimited": "foo,bar,baz" }'
+      model = ComplexModel.parse(json)
+      model.delimited.size.should == 3
+      model.delimited[0].should == "foo"
+      model.delimited[1].should == "bar"
+      model.delimited[2].should == "baz"
+
+    end
+
+    should "be able to map an object to self" do
+
+      json = '{ "id": 1 }'
+      model = ComplexModel.parse(json)
+      model.id.should == 1
+      model.self_referential.id.should == 1
+
+    end
+
   end
 
 end

data/test/support/models.rb

@@ -3,8 +3,10 @@ class SimpleModel
   include JSONMapper
 
   json_attribute :id, Integer
+  json_attribute :money, Float
   json_attribute :title, String
   json_attribute :boolean, Boolean
+  json_attribute :datetime, DateTime
 
 end
 
@@ -14,8 +16,13 @@ class ComplexModel
 
   json_attribute :id, [ :id, :attribute_id ], Integer
   json_attribute :model_title, :title, String
+  json_attribute :datetime, DateTime
   json_attribute :simple, SimpleModel
+  json_attribute :nested_test, { :nested => :test }, String
   json_attributes :simples, SimpleModel
   json_attributes :integers, Integer
+  json_attributes :delimited, DelimitedString, :delimiter => ","
+
+  json_attribute :self_referential, "self", SimpleModel
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: json_mapper
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Trond Arve Nordheim
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-08 00:00:00 +02:00
+date: 2010-08-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -104,6 +104,7 @@ files:
 - lib/json_mapper.rb
 - lib/json_mapper/attribute.rb
 - lib/json_mapper/attribute_list.rb
+- lib/json_mapper/parser.rb
 - test.rb
 - test/fixtures/complex.json
 - test/fixtures/simple.json