mongoid-cached-json 1.5.1 → 1.5.2

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,21 @@
+# don't commit Gemfile.lock
+Gemfile.lock
+
+# rvm
+.rvmrc
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# redcar
+.redcar

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,80 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-12-29 16:04:26 -0500 using RuboCop version 0.28.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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# Offense count: 1
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 54
+
+# Offense count: 2
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 201
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 202
+
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 36
+
+# Offense count: 4
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 34
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 1
+Style/EachWithObject:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 5
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 1
+Style/ModuleFunction:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/RaiseArgs:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: Methods.
+Style/SingleLineBlockParams:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+
+services:
+  - mongodb
+  - memcache
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.0
+
+env:
+  - MONGOID_VERSION=3
+  - MONGOID_VERSION=4
+
+cache: bundler

data/CHANGELOG.md

@@ -0,0 +1,85 @@
+1.5.2 (29/12/2014)
+------------------
+
+* Fixed support for Ruby 2.2.0 - [@dblock](http://github.com/dblock).
+* Implemented RuboCop, Ruby-style linter - [@dblock](http://github.com/dblock).
+* Upgraded to RSpec 3.1 - [@dblock](http://github.com/dblock).
+* Removed Jeweler - [@dblock](http://github.com/dblock).
+
+1.5.1 (05/07/2013)
+--------------------
+
+* 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)
+----------------
+
+* 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)
+------------------
+
+* 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)
+------------------
+
+* 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)
+------------------
+
+* 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)
+---------------
+
+* 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)
+----------------
+
+* Removed requirement for `bson_ext`, support for Mongoid 3.0 - [@dblock](http://github.com/dblock).
+
+1.2.3 (7/3/2012)
+----------------
+
+* 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)
+----------------
+
+* 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)
+-----------------
+
+* Allow `nil` parameter in as_json - [@dblock](http://github.com/dblock).
+
+1.2.0 (5/28/2012)
+------------------
+
+* Fix: cache key generation bug when using Mongoid 3 - [@marbemac](http://github.com/marbemac).
+
+1.1.1 (3/21/2012)
+-----------------
+
+* Fix: caching/invalidating referenced polymorphic documents - [@macreery](http://github.com/macreery).
+
+1.1 (2/29/2012)
+---------------
+
+* Added support for versioning - [@dblock](http://github.com/dblock).
+
+1.0 (2/20/2012)
+---------------
+
+* Initial release - [@aaw](http://github.com/aaw).
+* Retired support for `:markdown` in favor of `Mongoid::CachedJson::transform` - [@dblock](http://github.com/dblock).
+* Added `Mongoid::CachedJson::configure` - [@dblock](http://github.com/dblock).
+* Added support for `:markdown` - [@macreery](http://github.com/macreery).
+

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+Contributing to Mongoid::CachedJson
+===================================
+
+Mongoid::CachedJson is work of [many of contributors](https://github.com/dblock/mongoid-cached-json/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/dblock/mongoid-cached-json/pulls), [propose features and discuss issues](https://github.com/dblock/mongoid-cached-json/issues). When in doubt, ask a question in the [Google Group](http://groups.google.com/group/mongoid-cached-json).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/mongoid-cached-json) and check out your copy.
+
+```
+git clone https://github.com/contributor/mongoid-cached-json.git
+cd mongoid-cached-json
+git remote add upstream https://github.com/dblock/mongoid-cached-json.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/mongoid-cached-json and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/mongoid-cached-json/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+
+gemspec
+
+case version = ENV['MONGOID_VERSION'] || '~> 4.0'
+when /4/
+  gem 'mongoid', '~> 4.0'
+when /3/
+  gem 'mongoid', '~> 3.1'
+else
+  gem 'mongoid', version
+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'
+end

data/README.md

@@ -18,7 +18,7 @@ Quickstart
 
 Add `mongoid-cached-json` to your Gemfile.
 
-    gem "mongoid-cached-json"
+    gem 'mongoid-cached-json'
 
 Include `Mongoid::CachedJson` in your models.
 
@@ -32,8 +32,8 @@ class Gadget
   belongs_to :widget
 
   json_fields \
-    :name => { },
-    :extras => { :properties => :public }
+    name: {},
+    extras: { properties: :public }
 
 end
 
@@ -44,8 +44,8 @@ class Widget
   has_many :gadgets
 
   json_fields \
-    :name => { },
-    :gadgets => { :type => :reference, :properties => :public }
+    name: {},
+    gadgets: { type: :reference, properties: :public }
 
 end
 ```
@@ -59,13 +59,13 @@ widget = Widget.first
 widget.as_json
 
 # equivalent to the above
-widget.as_json({ :properties => :short })
+widget.as_json(properties: :short)
 
 # `:public` version of the JSON, `gadgets` returned with `:short` JSON, no `:extras`
-widget.as_json({ :properties => :public })
+widget.as_json(properties: :public)
 
 # `:all` version of the JSON, `gadgets` returned with `:all` JSON, including `:extras`
-widget.as_json({ :properties => :all })
+widget.as_json(properties: :all)
 ```
 
 Configuration
@@ -92,11 +92,11 @@ Defining Fields
 
 `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? }`
+* `: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.secret? }`
 
 `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 } }`
+* `: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
 * `:properties` can be one of `:short`, `:public`, `:all`, in this order
 * `:version` can be a single version for this field to appear in
@@ -115,7 +115,7 @@ When calling `as_json` on a model that contains references to other models the v
 
 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.
+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
@@ -124,12 +124,12 @@ class Person
 
   field :name
   field :ssn
-  has_and_belongs_to_many :friends, :class_name => "Person"
+  has_and_belongs_to_many :friends, class_name: 'Person'
 
   json_fields \
-    :name => {},
-    :ssn => { :properties => :all }
-    friends: { :properties => :public, :reference_properties => :short }
+    name: {},
+    ssn: { properties: :all },
+    friends: { properties: :public, reference_properties: :short }
 
 end
 ```
@@ -148,24 +148,24 @@ class Person
   field :last
 
   def name
-    [ first, middle, last ].compact.join(" ")
+    [ first, middle, last ].compact.join(' ')
   end
 
   json_fields \
-    :first => { :versions => [ :v2, :v3 ] },
-    :last => { :versions => [ :v2, :v3 ] },
-    :middle => { :versions => [ :v2, :v3 ] },
-    :born => { :versions => :v3 },
-    :name => { :definition => :name }
+    first: { versions: [ :v2, :v3 ] },
+    last: { versions: [ :v2, :v3 ] },
+    middle: { versions: [ :v2, :v3 ] },
+    born: { versions: :v3 },
+    name: { definition: :name }
 
 end
 ```
 
 ``` ruby
-person = Person.create({ :first => "John", :middle => "F.", :last => "Kennedy", :born => "May 29, 1917" })
-person.as_json # { :name => "John F. Kennedy" }
-person.as_json({ :version => :v2 }) # { :first => "John", :middle => "F.", :last => "Kennedy", :name => "John F. Kennedy" }
-person.as_json({ :version => :v3 }) # { :first => "John", :middle => "F.", :last => "Kennedy", :name => "John F. Kennedy", :born => "May 29, 1917" }
+person = Person.create(first: 'John', middle: 'F.', last: 'Kennedy', born: 'May 29, 1917')
+person.as_json # { name: 'John F. Kennedy' }
+person.as_json(version: :v2) # { first: 'John', middle: 'F.', last: 'Kennedy', name: 'John F. Kennedy' }
+person.as_json(version: :v3) # { first: 'John', middle: 'F.', last: 'Kennedy', name: 'John F. Kennedy', born: 'May 29, 1917' }
 ```
 
 Transformations
@@ -182,14 +182,14 @@ class Widget
   field :description
 
   json_fields \
-    :name => { :trusted => true },
-    :description => { }
+    name: { trusted: true },
+    description: {}
 end
 ```
 
 ``` ruby
   Mongoid::CachedJson.config.transform do |field, definition, value|
-    trusted = !! definition[:trusted]
+    trusted = !!definition[:trusted]
     trusted ? value : CGI.escapeHTML(value)
   end
 ```
@@ -210,12 +210,12 @@ Testing JSON
 This library overrides `as_json`, hence testing JSON results can be done at model level.
 
 ``` ruby
-describe "as_json" do
+describe 'as_json' do
   before :each do
-    @person = Person.create!({ :first => "John", :last => "Doe" })
+    @person = Person.create!(first: 'John', last: 'Doe')
   end
-  it "returns name" do
-    @person.as_json({ :properties => :public })[:name].should == "John Doe"
+  it 'returns name' do
+    expect(@person.as_json(properties: :public)[:name]).to eql 'John Doe'
   end
 end
 ```
@@ -223,13 +223,13 @@ end
 It's also common to test the results of the API using the [Pathy](https://github.com/twoism/pathy) library.
 
 ``` ruby
-describe "as_json" do
+describe 'as_json' do
   before :each do
-    person = Person.create!({ :first => "John", :last => "Doe" })
+    person = Person.create!(first: 'John', last: 'Doe')
   end
-  it "returns name" do
+  it 'returns name' do
     get "/api/person/#{person.id}"
-    response.body.at_json_path("name").should == "John Doe"
+    expect(response.body.at_json_path('name')).to eql 'John Doe'
   end
 end
 ```
@@ -240,24 +240,24 @@ Testing Cache Invalidation
 Cache is invalidated by calling `:expire_cached_json` on an instance.
 
 ``` ruby
-describe "updating a person" do
+describe 'updating a person' do
   before :each
-    @person = Person.create!({ :name => "John Doe" })
+    @person = Person.create!(name: 'John Doe')
   end
-  it "invalidates cache" do
-    @person.should_receive :expire_cached_json
-    @person.update_attributes!({ :name => "updated" }
+  it 'invalidates cache' do
+    expect(@person).to receive(:expire_cached_json)
+    @person.update_attributes!(name: 'updated')
   end
 end
 ```
-You may also want to use [this RSpec matcher](https://github.com/dblock/mongoid-cached-json/blob/master/spec/support/matchers/invalidate.rb).
+You may also want to use [this RSpec matcher](spec/support/matchers/invalidate.rb).
 
 ```ruby
-describe "updating a person" do
-  it "invalidates cache" do
-    lambda {
-      @person.update_attributes!({ :name => "updated" }
-    }.should invalidate @person
+describe 'updating a person' do
+  it 'invalidates cache' do
+    expect do
+      @person.update_attributes!(name: 'updated')
+    end.to invalidate @person
   end
 end
 ```
@@ -278,14 +278,11 @@ Various cache stores, including Memcached, support bulk read operations. The [Da
 Contributing
 ------------
 
-* Fork the project.
-* Make your feature addition or bug fix with tests.
-* Don't forget to update `CHANGELOG.md`.
-* Send a pull request. Bonus points for topic branches.
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 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/CHANGELOG.md)
+(c) 2012-2014 [Artsy](https://artsy.net) and [Contributors](CHANGELOG.md)