json_record 1.0.1 → 1.0.2

data/README.rdoc

@@ -17,7 +17,7 @@ This will define for you accessors on your model for name and value and serializ
 
 == Embedded Documents
 
-To make you flexible schema really powerful, add some embedded documents to it. Embedded documents are Ruby classes that inherit from JsonRecord::EmbeddedDocument. They work very much like traditional ActiveRecord objects, except that instead of being serialized in a separate table, they are embedded right in the JSON field of their parent record. They can be used to replace has_many and has_one associations and can be far easier to work with.
+To make you flexible schema really powerful, add some embedded documents to it. Embedded documents are Ruby classes that include JsonRecord::EmbeddedDocument. They work very much like traditional ActiveRecord objects, except that instead of being serialized in a separate table, they are embedded right in the JSON field of their parent record. They can be used to replace has_many and has_one associations and can be far easier to work with.
 
 Embedded documents have their own schema that is serialized to JSON. This schema can also contain embedded documents allowing you to easily create very rich data structures all with only one database table. And because there is only one table, you don't need to worry at all about ensuring your changes to embedded documents are saved along with the parent record.
 
@@ -32,12 +32,14 @@ Embedded documents have their own schema that is serialized to JSON. This schema
     end
   end
 
-  class Person < JsonRecord::EmbeddedDocument
+  class Person
+    include JsonRecord::EmbeddedDocument
     schema.key :first_name, :required => true
     schema.key :last_name
   end
 
-  class Comment < JsonRecord::EmbeddedDocument
+  class Comment
+    include JsonRecord::EmbeddedDocument
     schema.key :author, Person, :required => true
     schema.key :body, :required => true
     schema.many :replies, Comment

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/json_record.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{json_record}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Durand"]

data/lib/json_record/embedded_document.rb

@@ -37,29 +37,19 @@ module JsonRecord
     def new_record?; false; end;
   end
   
-  # Subclasses of EmbeddedDocument can be used as the type for keys or many field definitions
+  # Classes that include EmbeddedDocument can be used as the type for keys or many field definitions
   # in Schema. Embedded documents are then extensions of the schema. In this way, complex
   # documents represented in JSON can be deserialized as complex objects.
-  class EmbeddedDocument
-    include ActiveRecordStub
-    include ActiveRecord::Validations
-    include AttributeMethods
-    
-    write_inheritable_attribute(:schema, Schema.new(self, nil))
-    class_inheritable_reader :schema
-    
-    class << self
-      # Define a field for the schema. This is a shortcut for calling schema.key.
-      # See Schema#key for details. 
-      def key (name, *args)
-        schema.key(name, *args)
-      end
-      
-      # Define a multivalued field for the schema. This is a shortcut for calling schema.many.
-      # See Schema#many for details. 
-      def many (name, *args)
-        schema.many(name, *args)
-      end
+  #
+  # To define the schema for an embedded document, call schema.key or schema.many from the class definition.
+  module EmbeddedDocument
+    def self.included (base)
+      base.send :include, ActiveRecordStub
+      base.send :include, ActiveRecord::Validations
+      base.send :include, AttributeMethods
+    
+      base.write_inheritable_attribute(:schema, Schema.new(base, nil))
+      base.class_inheritable_reader :schema
     end
     
     # The parent object of the document.

data/lib/json_record/serialized.rb

@@ -2,18 +2,21 @@ module JsonRecord
   # Adds the serialized JSON behavior to ActiveRecord.
   module Serialized
     def self.included (base)
-      base.class_inheritable_accessor :json_serialized_fields
-      base.extend(ClassMethods)
+      base.extend(ActsMethods)
     end
     
-    module ClassMethods
+    module ActsMethods
       # Specify a field name that contains serialized JSON. The block will be yielded to with a
       # Schema object that can then be used to define the fields in the JSON document. A class
       # can have multiple fields that store JSON documents if necessary.
       def serialize_to_json (field_name, &block)
+        unless include?(InstanceMethods)
+          class_inheritable_accessor :json_serialized_fields
+          extend ClassMethods
+          include InstanceMethods
+        end
         field_name = field_name.to_s
         self.json_serialized_fields ||= {}
-        include InstanceMethods unless include?(InstanceMethods)
         schema = Schema.new(self, field_name)
         field_schemas = json_serialized_fields[field_name]
         if field_schemas
@@ -25,7 +28,9 @@ module JsonRecord
         field_schemas << schema
         block.call(schema) if block
       end
-      
+    end
+    
+    module ClassMethods
       # Get the field definition of the JSON field from the schema it is defined in.
       def json_field_definition (name)
         field = nil

data/lib/json_record.rb

@@ -18,3 +18,5 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'json_record', 'embed
 require File.expand_path(File.join(File.dirname(__FILE__), 'json_record', 'field_definition'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'json_record', 'json_field'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'json_record', 'serialized'))
+
+ActiveRecord::Base.send(:include, JsonRecord::Serialized)

data/spec/serialized_spec.rb

@@ -151,7 +151,8 @@ describe JsonRecord::Serialized do
       "map"=>{},
       "verified"=>nil,
       "when"=>nil,
-      "primary_trait"=>nil
+      "primary_trait"=>nil,
+      "dimension"=>nil
     }
     JsonRecord::Test::Model.new.attributes["traits"].should be_a(JsonRecord::EmbeddedDocumentArray)
   end

data/spec/test_models.rb

@@ -27,15 +27,21 @@ module JsonRecord
       Dir.delete(db_dir) if File.exist?(db_dir) and Dir.entries(db_dir).reject{|f| f.match(/^\.+$/)}.empty?
     end
 
-    class Trait < JsonRecord::EmbeddedDocument
-      key :name, :required => true
-      key :value
-      key :count, Integer
-      many :sub_traits, Trait, :unique => [:name, :value]
+    class Trait
+      include JsonRecord::EmbeddedDocument
+      schema.key :name, :required => true
+      schema.key :value
+      schema.key :count, Integer
+      schema.many :sub_traits, Trait, :unique => [:name, :value]
+    end
+    
+    class Dimension
+      include JsonRecord::EmbeddedDocument
+      schema.key :height, Integer, :required => true
+      schema.key :width, Integer, :required => true
     end
     
     class Model < ActiveRecord::Base
-      include JsonRecord::Serialized
       serialize_to_json(:json) do |schema|
         schema.key :name, String, :required => true, :length => 15
         schema.key :value, Integer, :default => 0
@@ -48,6 +54,7 @@ module JsonRecord
         schema.key :map, Hash
         schema.key :primary_trait, Trait
         schema.many :traits, Trait, :unique => :name
+        schema.key :dimension, Dimension
       end
 
       serialize_to_json(:compressed_json) do |schema|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: json_record
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Brian Durand