mongoid-cached-json 1.4.3 → 1.5.0

data/README.md

@@ -101,6 +101,38 @@ Defining Fields
 * `:properties` can be one of `:short`, `:public`, `:all`, in this order
 * `:version` can be a single version for this field to appear in
 * `:versions` can be an array of versions for this field to appear in
+* `:reference_properties` can be one of `:short`, `:public`, `:all`, default will select the reference properties format dynamically (see below)
+
+Reference Properties
+--------------------
+
+When calling `as_json` on a model that contains references to other models the value of the `:properties` option passed into the `as_json` call will be chosen as follows:
+
+* Use the value of the `:reference_properties` option, if specified.
+* For `:short` JSON, use `:short`.
+* For `:public` JSON, use `:short`.
+* For `:all` JSON, use `:all`.
+
+The dynamic selection where `:public` generates `:short` references allows to return smaller embedded collections, while `:all` allows to fetch deep data. Another way of looking at this is to say that a field in a `:short` JSON appears in collections, a field declared in the `:public` JSON appears for all users and the field declared in the `:all` JSON appears for object owners only.
+
+To override this behavior and always return the `:short` JSON for a child reference, use `:reference_properties`. In the following example we would want `Person.as_json({ :properties => :all })` to return the social security number for that person, but not for all their friends.
+
+``` ruby
+class Person
+  include Mongoid::Document
+  include Mongoid::CachedJson
+
+  field :name
+  field :ssn
+  has_and_belongs_to_many :friends, :class_name => "Person"
+
+  json_fields \
+    :name => {},
+    :ssn => { :properties => :all }
+    friends: { :properties => :public, :reference_properties => :short }
+
+end
+```
 
 Versioning
 ----------

data/lib/mongoid-cached-json/cached_json.rb

@@ -20,7 +20,7 @@ module Mongoid
       # @since 1.0
       def json_fields(defs)
         self.hide_as_child_json_when = defs.delete(:hide_as_child_json_when) || lambda { |a| false }
-        self.all_json_properties = [:short, :public, :all]
+        self.all_json_properties = [ :short, :public, :all ]
         cached_json_defs = Hash[defs.map { |k,v| [k, { :type => :callable, :properties => :short, :definition => k }.merge(v)] }]
         self.cached_json_field_defs = {}
         self.cached_json_reference_defs = {}
@@ -30,10 +30,10 @@ module Mongoid
         end.flatten.compact.uniq
         self.all_json_properties.each_with_index do |property, i|
           self.cached_json_field_defs[property] = Hash[cached_json_defs.find_all do |field, definition|
-            self.all_json_properties.find_index(definition[:properties]) <= i and definition[:type] == :callable
+            self.all_json_properties.find_index(definition[:properties]) <= i && definition[:type] == :callable
           end]
           self.cached_json_reference_defs[property] = Hash[cached_json_defs.find_all do |field, definition|
-            self.all_json_properties.find_index(definition[:properties]) <= i and definition[:type] == :reference
+            self.all_json_properties.find_index(definition[:properties]) <= i && definition[:type] == :reference
           end]
           # If the field is a reference and is just specified as a symbol, reflect on it to get metadata
           self.cached_json_reference_defs[property].to_a.each do |field, definition|
@@ -89,9 +89,9 @@ module Mongoid
         reference_defs = clazz.cached_json_reference_defs[options[:properties]]
         if !reference_defs.empty?
           object_reference = clazz.where({ :_id => id }).first if !object_reference
-          if object_reference and (is_top_level_json or options[:properties] == :all or !clazz.hide_as_child_json_when.call(object_reference))
+          if object_reference && (is_top_level_json || options[:properties] == :all || !clazz.hide_as_child_json_when.call(object_reference))
             json.merge!(Hash[reference_defs.map do |field, definition|
-              json_properties_type = (options[:properties] == :all) ? :all : :short
+              json_properties_type = definition[:reference_properties] || ((options[:properties] == :all) ? :all : :short)
               reference_keys, reference = clazz.resolve_json_reference(options.merge({ :properties => json_properties_type, :is_top_level_json => false}), object_reference, field, definition)
               if (reference.is_a?(Hash) && ref = reference[:_ref])
                 ref[:_parent] = json

data/lib/mongoid-cached-json/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   module CachedJson
-    VERSION = '1.4.3'
+    VERSION = '1.5.0'
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-cached-json
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -174,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3669552343151646894
+      hash: 4082728450150957168
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Effective model-level JSON caching for the Mongoid ODM.