mongoid-cached-json 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e18f9babf5b55e3d785541737870a25b29ca0c0
-  data.tar.gz: 20d28efe0aa10fe48518bfff03015033fa9199ce
+  metadata.gz: 11dccfcc261da8a4c6b4027696ab55b327070041
+  data.tar.gz: e32ddf96914f8e82bbda3a1ea07c9852f6a80c30
 SHA512:
-  metadata.gz: 750a96034f2430ade4c8ff7ce27f18b36fb17a2c1173f3bb583f0c82dbd54cb1bdfee27872876291b9dd3106d453dd4dad445eb6d9081177aa4ae5bcdeb9bbcc
-  data.tar.gz: d06238d96ef027691d0de888dc76f205964d9b8434511a8c521a09a3ec7a7aac6411f4bb05a765d0652e28a2f0de0699f44b8d83cd191889e12326d3b048caaf
+  metadata.gz: a2f59a4a67f3ba6707b74bd1bba88a34208414b11cff5252994f7e680d4d70f7b135fe5945931473f7aaf420a511eeda6ef7ec7409738b693ac0e4cf56ec83f7
+  data.tar.gz: ebec52181980a9b345bcfb10fbfd78aa3f839d65f4f693813a46da608b4dfe0c9db49e0ff4508bd28386b5788db9c544f1ad52b690e8c50dff1cf67439e0b017

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-29 16:04:26 -0500 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-17 10:10:32 -0400 using RuboCop version 0.33.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,15 +9,19 @@
 # Offense count: 1
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/cached_json.rb'
 
 # Offense count: 1
 Lint/UnderscorePrefixedVariableName:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/cached_json.rb'
 
 # Offense count: 2
 Lint/UselessAssignment:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/cached_json.rb'
+    - 'spec/cached_json_spec.rb'
 
 # Offense count: 5
 Metrics/AbcSize:
@@ -30,7 +35,7 @@ Metrics/BlockNesting:
 Metrics/CyclomaticComplexity:
   Max: 15
 
-# Offense count: 201
+# Offense count: 200
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 202
@@ -40,6 +45,11 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 36
 
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 119
+
 # Offense count: 4
 Metrics/PerceivedComplexity:
   Max: 16
@@ -50,24 +60,34 @@ Style/Documentation:
 
 # Offense count: 2
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/cached_json.rb'
 
 # Offense count: 1
 Style/EachWithObject:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/hash.rb'
 
 # Offense count: 1
 # Configuration parameters: Exclude.
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json.rb'
 
 # Offense count: 5
+# Cop supports --auto-correct.
 Style/Lambda:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/cached_json.rb'
+    - 'spec/support/json_foobar.rb'
+    - 'spec/support/poly_company.rb'
+    - 'spec/support/poly_person.rb'
+    - 'spec/support/sometimes_secret.rb'
 
 # Offense count: 1
 Style/ModuleFunction:
-  Enabled: false
+  Exclude:
+    - 'lib/mongoid-cached-json/config.rb'
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -77,4 +97,5 @@ Style/RaiseArgs:
 # Offense count: 2
 # Configuration parameters: Methods.
 Style/SingleLineBlockParams:
-  Enabled: false
+  Exclude:
+    - 'spec/benchmark_spec.rb'

data/.travis.yml

@@ -12,5 +12,6 @@ rvm:
 env:
   - MONGOID_VERSION=3
   - MONGOID_VERSION=4
+  - MONGOID_VERSION=5
 
 cache: bundler

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-1.5.2 (29/12/2014)
+1.5.3 (2015/09/17)
+------------------
+
+* Compatibility with Mongoid 5 - [@dblock](http://github.com/dblock).
+
+1.5.2 (2014/29/12)
 ------------------
 
 * Fixed support for Ruby 2.2.0 - [@dblock](http://github.com/dblock).
@@ -6,77 +11,77 @@
 * Upgraded to RSpec 3.1 - [@dblock](http://github.com/dblock).
 * Removed Jeweler - [@dblock](http://github.com/dblock).
 
-1.5.1 (05/07/2013)
+1.5.1 (2013/05/07)
 --------------------
 
 * Fixed `read_multi` calls so as to enable proper cache reading behavior in stores other than `ActiveSupport::Cache::DalliStore` - [@macreery](http://github.com/macreery).
 
-1.5 (04/13/2013)
+1.5 (2013/04/13)
 ----------------
 
 * Added `:reference_properties` that disables dynamic selection of the type of JSON to return for a reference - [@dblock](https://github.com/dblock).
 
-1.4.3 (01/25/2013)
+1.4.3 (2013/01/25)
 ------------------
 
 * For caches that support `read_multi`, do not attempt to fetch JSON a second time via `fetch`, write it directly to cache - [@dblock](https://github.com/dblock).
 
-1.4.2 (01/24/2013)
+1.4.2 (2013/01/24)
 ------------------
 
 * Fix: calling `as_json` on a destroyed Mongoid 3.1 object with a HABTM relationship raises `undefined method 'map' for nil:NilClass` - [@dblock](http://github.com/dblock).
 
-1.4.1 (01/22/2013)
+1.4.1 (2013/01/22)
 ------------------
 
 * Invalidate cache in `after_destroy` - [@dblock](http://github.com/dblock).
 * Do not invalidate cache when the document is created - [@dblock](http://github.com/dblock).
 * Invalidate cache in `after_update` instead of `before_update` - [@dblock](http://github.com/dblock).
 
-1.4 (01/20/2013)
+1.4 (2013/01/20)
 ---------------
 
 * Collect a JSON partial representation first, then fetch data from cache only once per-key - [@dblock](http://github.com/dblock), [@macreery](http://github.com/macreery).
 * Use `read_multi` if the cache store supports it to fetch data from cache in bulk - [@dblock](http://github.com/dblock), [@macreery](http://github.com/macreery).
 * Added a benchmark test suite - [@dblock](http://github.com/dblock), [@macreery](http://github.com/macreery).
 
-1.3 (11/12/2012)
+1.3 (2012/11/12)
 ----------------
 
 * Removed requirement for `bson_ext`, support for Mongoid 3.0 - [@dblock](http://github.com/dblock).
 
-1.2.3 (7/3/2012)
-----------------
+1.2.3 (2012/07/03)
+------------------
 
 * Fix: including a `referenced_in` field in `json_fields` within a child `embedded_in` a parent causes an "access to the collection is not allowed since it is an embedded document" error - [@dblock](http://github.com/dblock).
 
-1.2.2 (7/3/2012)
-----------------
+1.2.2 (2012/07/03)
+------------------
 
 * Fix [#6](https://github.com/dblock/mongoid-cached-json/issues/6): including parent in `json_fields` within a polymorphic reference fails with an "uninitialized constant" error - [@dblock](http://github.com/dblock).
 
-1.2.1 (6/12/2012)
------------------
+1.2.1 (2012/06/12)
+------------------
 
 * Allow `nil` parameter in as_json - [@dblock](http://github.com/dblock).
 
-1.2.0 (5/28/2012)
+1.2.0 (2012/05/28)
 ------------------
 
 * Fix: cache key generation bug when using Mongoid 3 - [@marbemac](http://github.com/marbemac).
 
-1.1.1 (3/21/2012)
------------------
+1.1.1 (2012/03/21)
+------------------
 
 * Fix: caching/invalidating referenced polymorphic documents - [@macreery](http://github.com/macreery).
 
-1.1 (2/29/2012)
----------------
+1.1 (2012/02/29)
+----------------
 
 * Added support for versioning - [@dblock](http://github.com/dblock).
 
-1.0 (2/20/2012)
----------------
+1.0 (2012/02/20)
+----------------
 
 * Initial release - [@aaw](http://github.com/aaw).
 * Retired support for `:markdown` in favor of `Mongoid::CachedJson::transform` - [@dblock](http://github.com/dblock).

data/CONTRIBUTING.md

@@ -23,6 +23,15 @@ git pull upstream master
 git checkout -b my-feature-branch
 ```
 
+#### Install Memcached and MongoDB
+
+MongoDB and Memcached are required, use your favorite OS installer.
+
+```
+brew install mongodb
+brew install memcached
+```
+
 #### Bundle Install and Test
 
 Ensure that you can build the project and run tests.

data/Gemfile

@@ -2,7 +2,9 @@ source 'http://rubygems.org'
 
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || '~> 4.0'
+case version = ENV['MONGOID_VERSION'] || '~> 5.0'
+when /5/
+  gem 'mongoid', '~> 5.0'
 when /4/
   gem 'mongoid', '~> 4.0'
 when /3/
@@ -13,9 +15,13 @@ end
 
 group :development do
   gem 'rake'
-  gem 'rspec', '~> 3.1'
   gem 'bundler', '~> 1.0'
   gem 'yard', '~> 0.6'
   gem 'dalli', '~> 2.6'
-  gem 'rubocop', '0.28.0'
+  gem 'rubocop', '0.33.0'
+end
+
+group :test do
+  gem 'mongoid-compatibility'
+  gem 'rspec', '~> 3.1'
 end

data/README.md

@@ -1,12 +1,22 @@
-Mongoid::CachedJson [![Build Status](https://secure.travis-ci.org/dblock/mongoid-cached-json.png)](http://travis-ci.org/dblock/mongoid-cached-json)
+Mongoid::CachedJson
 ===================
 
+[![Gem Version](https://badge.fury.io/rb/mongoid-cached-json.svg)](http://badge.fury.io/rb/mongoid-cached-json)
+[![Build Status](https://travis-ci.org/dblock/mongoid-cached-json.svg?branch=master)](https://travis-ci.org/dblock/mongoid-cached-json)
+[![Dependency Status](https://gemnasium.com/dblock/mongoid-cached-json.svg)](https://gemnasium.com/dblock/mongoid-cached-json)
+[![Code Climate](https://codeclimate.com/github/dblock/mongoid-cached-json.svg)](https://codeclimate.com/github/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`.
 
 `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.
 
+Compatibility
+-------------
+
+This gem is compatible with Mongoid 3, 4 and 5.
+
 Resources
 ---------
 

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

@@ -76,10 +76,12 @@ module Mongoid
         is_top_level_json = options[:is_top_level_json] || false
         if object_def[:object]
           object_reference = object_def[:object]
-          clazz, id = object_def[:object].class, object_def[:object].id
+          clazz = object_def[:object].class
+          id = object_def[:object].id
         else
           object_reference = nil
-          clazz, id = object_def[:clazz], object_def[:id]
+          clazz = object_def[:clazz]
+          id = object_def[:id]
         end
         key = cached_json_key(options, clazz, id)
         json = { _ref: { _clazz: self, _key: key, _materialize_cached_json: [clazz, id, object_reference, options] } }
@@ -128,7 +130,7 @@ module Mongoid
             object_ids = object.send(key)
             if object_ids
               reference_json = object_ids.map do |id|
-                materialize_keys, json = materialize_json(options,  clazz: clazz, id: id)
+                materialize_keys, json = materialize_json(options, clazz: clazz, id: id)
                 keys = keys ? keys.merge_set(materialize_keys) : materialize_keys
                 json
               end.compact
@@ -179,7 +181,7 @@ module Mongoid
               Mongoid::CachedJson.config.cache.write(key, fetched_json) unless Mongoid::CachedJson.config.disable_caching
             else
               # fetch/write from cache
-              fetched_json = (local_cache[key] = Mongoid::CachedJson.config.cache.fetch(key,  force: !!Mongoid::CachedJson.config.disable_caching) do
+              fetched_json = (local_cache[key] = Mongoid::CachedJson.config.cache.fetch(key, force: !!Mongoid::CachedJson.config.disable_caching) do
                 _ref[:_clazz].materialize_cached_json(* _ref[:_materialize_cached_json])
               end)
             end
@@ -203,7 +205,7 @@ module Mongoid
       # partial, unmaterialized JSON
       keys, partial_json = self.class.materialize_json({
         properties: :short, is_top_level_json: true, version: Mongoid::CachedJson.config.default_version
-      }.merge(options),  object: self)
+      }.merge(options), object: self)
       [keys, partial_json]
     end
 

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

@@ -42,7 +42,7 @@ module Mongoid
       end
 
       # Disable caching.
-      option :disable_caching,  default: false
+      option :disable_caching, default: false
 
       # Returns the default JSON version
       #

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

@@ -1,5 +1,5 @@
 module Mongoid
   module CachedJson
-    VERSION = '1.5.2'
+    VERSION = '1.5.3'
   end
 end

data/spec/cached_json_spec.rb

@@ -331,7 +331,7 @@ describe Mongoid::CachedJson do
             expect(JsonTransform.new(upcase: 'upcase', downcase: 'DOWNCASE', nochange: 'eLiTe').as_json).to eq(upcase: 'UPCASE', downcase: 'downcase', nochange: 'eLiTe')
           end
         end
-        context 'with mutliple transformations' do
+        context 'with multiple transformations' do
           before :each do
             Mongoid::CachedJson.config.transform do |_field, _definition, value|
               value.to_i + 1
@@ -354,7 +354,7 @@ describe Mongoid::CachedJson do
           key = "as_json/unspecified/JsonFoobar/#{example.id}/short/true"
           case cache_store
           when :memory_store then
-            expect(Mongoid::CachedJson.config.cache).to receive(:fetch).with(key,  force: true).twice
+            expect(Mongoid::CachedJson.config.cache).to receive(:fetch).with(key, force: true).twice
           when :dalli_store then
             expect(Mongoid::CachedJson.config.cache).not_to receive(:write)
           else
@@ -418,7 +418,7 @@ describe Mongoid::CachedJson do
           expect(@json_parent_foobar.as_json(properties: :all)[:json_polymorphic_referenced_foobar][:foo]).to eq('REFERENCED')
         end
       end
-      context 'polymorhphic relationships' do
+      context 'polymorphic relationships' do
         before :each do
           @company = PolyCompany.create!
           @company_post = PolyPost.create!(postable: @company)
@@ -448,7 +448,7 @@ describe Mongoid::CachedJson do
                                                           { nickname: 'Joe', person: { name: 'Joe' } },
                                                           { nickname: 'Bob', person: { name: 'Bob' } }
                                                         ]
-          )
+                                                       )
         end
       end
       context 'with repeated objects in the JSON' do
@@ -464,7 +464,7 @@ describe Mongoid::CachedJson do
                                                           { nickname: 'Joe', person: { name: 'Evil' } },
                                                           { nickname: 'Bob', person: { name: 'Evil' } }
                                                         ]
-          )
+                                                       )
         end
       end
       context 'belongs_to relationship' do

data/spec/mongoid_criteria_spec.rb

@@ -68,7 +68,7 @@ describe Mongoid::Criteria do
       )
       # read_multi returned only 2 of 3 things, don't call fetch, just store the third value
       expect(Mongoid::CachedJson.config.cache).not_to receive(:fetch)
-      expect(Mongoid::CachedJson.config.cache).to receive(:write).with("as_json/unspecified/Tool/#{tool2.id}/all/true",  name: 'screwdriver')
+      expect(Mongoid::CachedJson.config.cache).to receive(:write).with("as_json/unspecified/Tool/#{tool2.id}/all/true", name: 'screwdriver')
       expect(tool_box.tools.as_json(properties: :all)).to eq([
         { tool_box: { x: :y }, x: :y },
         { tool_box: { x: :y }, name: 'screwdriver' }

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
 require 'mongoid-cached-json'
+require 'mongoid-compatibility'
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |f|
   require f
@@ -17,4 +18,8 @@ RSpec.configure do |config|
   config.after :each do
     Mongoid::CachedJson.config.reset!
   end
+  config.before :all do
+    Mongoid.logger.level = Logger::INFO
+    Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-cached-json
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Aaron Windsor
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Cached-json is a DSL for describing JSON representations of Mongoid models.