mongoid-cached-json 1.2.1 → 1.2.2

data/README.md

@@ -1,11 +1,11 @@
 Mongoid::CachedJson [![Build Status](https://secure.travis-ci.org/dblock/mongoid-cached-json.png)](http://travis-ci.org/dblock/mongoid-cached-json)
 ===================
 
-Typical *as_json* definitions may involve lots of database point queries and method calls. When returning collections of objects, a single call may yield hundreds of database queries that can take seconds. This library mitigates the problem by implementing a module called *CachedJson*.
+Typical `as_json` definitions may involve lots of database point queries and method calls. When returning collections of objects, a single call may yield hundreds of database queries that can take seconds. This library mitigates the problem by implementing a module called `CachedJson`.
 
-CachedJson enables returning multiple JSON formats and versions from a single class and provides some rules for returning embedded or referenced data. It then uses a scheme where fragments of JSON are cached for a particular (class, id) pair containing only the data that doesn't involve references/embedded documents. To get the full JSON for an instance, CachedJson will combine fragments of JSON from the instance with fragments representing the JSON for its references. In the best case, when all of these fragments are cached, this falls through to a few cache lookups followed by a couple Ruby hash merges to create the JSON.
+`CachedJson` enables returning multiple JSON formats and versions from a single class and provides some rules for yielding embedded or referenced data. It then uses a scheme where fragments of JSON are cached for a particular (class, id) pair containing only the data that doesn't involve references/embedded documents. To get the full JSON for an instance, `CachedJson` will combine fragments of JSON from the instance with fragments representing the JSON for its references. In the best case, when all of these fragments are cached, this falls through to a few cache lookups followed by a couple Ruby hash merges to create the JSON.
 
-Using Mongoid::CachedJson we were able to cut our JSON API average response time by about a factor of 10.
+Using `Mongoid::CachedJson` we were able to cut our JSON API average response time by about a factor of 10.
 
 Resources
 ---------
@@ -54,17 +54,19 @@ end
 Invoke `as_json`.
 
 ``` ruby
+widget = Widget.first
+
 # the `:short` version of the JSON, `gadgets` not included
-Widget.first.as_json
+widget.as_json
 
 # equivalent to the above
-Widget.first.as_json({ :properties => :short })
+widget.as_json({ :properties => :short })
 
 # `:public` version of the JSON, `gadgets` returned with `:short` JSON, no `:extras`
-Widget.first.as_json({ :properties => :public })
+widget.as_json({ :properties => :public })
 
 # `:all` version of the JSON, `gadgets` returned with `:all` JSON, including `:extras`
-Widget.first.as_json({ :properties => :all })
+widget.as_json({ :properties => :all })
 ```
 
 Configuration
@@ -89,11 +91,11 @@ end
 Defining Fields
 ---------------
 
-Mongoid::CachedJson supports the following options.
+`Mongoid::CachedJson` supports the following options:
 
 * `:hide_as_child_json_when` is an optional function that hides the child JSON from `as_json` parent objects, eg. `cached_json :hide_as_child_json_when => lambda { |instance| ! instance.is_secret? }`
 
-Mongoid::CachedJson field definitions support the following options.
+`Mongoid::CachedJson` field definitions support the following options:
 
 * `:definition` can be a symbol or an anonymous function, eg. `:description => { :definition => :name }` or `:description => { :definition => lambda { |instance| instance.name } }`
 * `:type` can be `:reference`, required for referenced objects
@@ -156,14 +158,15 @@ end
 
 ``` ruby
   Mongoid::CachedJson.config.transform do |field, definition, value|
-    (!! definition[:trusted]) ? value : CGI.escapeHTML(value)
+    trusted = !! definition[:trusted]
+    trusted ? value : CGI.escapeHTML(value)
   end
 ```
 
 Mixing with Standard as_json
 ----------------------------
 
-Taking part in the Mongoid::CachedJson `json_fields` scheme is optional: you can still write *as_json* methods where it makes sense.
+Taking part in the `Mongoid::CachedJson` `json_fields` scheme is optional: you can still write `as_json` methods where it makes sense.
 
 Turning Caching Off
 -------------------
@@ -181,7 +184,7 @@ describe "as_json" do
     @person = Person.create!({ :first => "John", :last => "Doe" })
   end
   it "returns name" do
-    @person.as_json({ :properties => :public })[:name].should== "John Doe"
+    @person.as_json({ :properties => :public })[:name].should == "John Doe"
   end
 end
 ```
@@ -239,3 +242,4 @@ Copyright and License
 MIT License, see [LICENSE](https://github.com/dblock/mongoid-cached-json/blob/master/LICENSE.md) for details.
 
 (c) 2012 [Art.sy Inc.](http://artsy.github.com) and [Contributors](https://github.com/dblock/mongoid-cached-json/blob/master/HISTORY.md)
+

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

@@ -104,20 +104,22 @@ module Mongoid
       def resolve_json_reference(options, object, field, reference_def)
         reference_json = nil
         if reference_def[:metadata]
-          clazz = reference_def[:metadata].class_name.constantize
           key = reference_def[:metadata].key.to_sym
           if reference_def[:metadata].relation == Mongoid::Relations::Referenced::ManyToMany
+            clazz = reference_def[:metadata].class_name.constantize
             reference_json = object.send(key).map do |id|
               materialize_json(options, { :clazz => clazz, :id => id })
             end.compact
           elsif reference_def[:metadata].relation == Mongoid::Relations::Referenced::In
+            clazz = reference_def[:metadata].inverse_class_name.constantize
             reference_json = materialize_json(options, { :clazz => clazz, :id => object.send(key) })
           end
         end
         # If we get to this point and reference_json is still nil, there's no chance we can
         # load the JSON from cache so we go ahead and call as_json on the object.
-        if !reference_json
-          reference = reference_def[:definition].is_a?(Symbol) ? object.send(reference_def[:definition]) : reference_def[:definition].call(object)
+        if ! reference_json
+          reference_def_definition = reference_def[:definition]
+          reference = reference_def_definition.is_a?(Symbol) ? object.send(reference_def_definition) : reference_def_definition.call(object)
           reference_json = reference.as_json(options) if reference
         end
         reference_json

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

@@ -65,7 +65,7 @@ module Mongoid
         settings[:default_version] = default_version
       end
       
-      # Returns the default cache store, which is either a Rails logger of stdout logger
+      # Returns the default cache store, for example Rails cache or an instance of ActiveSupport::Cache::MemoryStore.
       #
       # @example Get the default cache store
       #   config.default_cache
@@ -75,7 +75,7 @@ module Mongoid
         defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ::ActiveSupport::Cache::MemoryStore.new
       end
   
-      # Returns the cache, or defaults to Rails cache or ActiveSupport::Cache::MemoryStore logger.
+      # Returns the cache, or defaults to Rails cache when running under Rails or ActiveSupport::Cache::MemoryStore.
       #
       # @example Get the cache.
       #   config.cache

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Mongoid
   module CachedJson
-    VERSION = '1.2.1'
+    VERSION = '1.2.2'
   end
 end
 

metadata

@@ -1,114 +1,150 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mongoid-cached-json
-version: !ruby/object:Gem::Version
-  version: 1.2.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 2
+  version: 1.2.2
 platform: ruby
-authors:
+authors: 
 - Aaron Windsor
 - Daniel Doubrovkine
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70288576783800 !ruby/object:Gem::Requirement
+
+date: 2012-07-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: activesupport
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70288576783800
-- !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70288576799380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70288576799380
-- !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70288576798740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *70288576798740
-- !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &70288576798260 !ruby/object:Gem::Requirement
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
   prerelease: false
-  version_requirements: *70288576798260
-- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70288576797660 !ruby/object:Gem::Requirement
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   prerelease: false
-  version_requirements: *70288576797660
-- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70288576797160 !ruby/object:Gem::Requirement
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   prerelease: false
-  version_requirements: *70288576797160
-- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70288576796680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  version_requirements: *70288576796680
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70288576796140 !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
   prerelease: false
-  version_requirements: *70288576796140
+  name: yard
+  version_requirements: *id008
 description: Cached-json is a DSL for describing JSON representations of Mongoid models.
 email: dblock@dblock.org
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.md
 - README.md
-files:
+files: 
 - lib/mongoid-cached-json.rb
 - lib/mongoid-cached-json/cached_json.rb
 - lib/mongoid-cached-json/config.rb
@@ -116,31 +152,37 @@ files:
 - LICENSE.md
 - README.md
 homepage: http://github.com/dblock/mongoid-cached-json
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 3411124763805078163
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Effective model-level JSON caching for the Mongoid ODM.
 test_files: []
+