perforated 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2188079862ccf0f34ad99dc8ef2575101f54f6a4
-  data.tar.gz: 1083c36661390745858282f788f483ac434fb7c2
+  metadata.gz: 76ef0f033815d6f9f08736cd6139bb8e068c3a26
+  data.tar.gz: f01094c162fa104f22388c4b2096484aba0e74f6
 SHA512:
-  metadata.gz: 850b58a8bea4aed87934f41e03f47fb3a459eeaa1dd513dad53eaf5e41efc7e268cfbf5ee7688e01eaf6573ca0c98477ea1683c11aa4e956eaabdcbec160f4b6
-  data.tar.gz: 55afde3e6a522aac92ce38cf4891b774065c7d69c59da9a3ff59f7fa5eb8d7cdc5854aa32c0b5e65b91abb4d2a3508db8ab2191250e644a1156d9d8e4db628a8
+  metadata.gz: 5dd441e560b300baf5b92b7e51a73a8e0371d0215b95fea05fb65909c8b43a64cc4b992f0b292d6ea45cc6da2bf6d12e35acce9fe2335143445af059d3c28eb3
+  data.tar.gz: 089d0af967d27c8632418adb021a8d9ab239a62e386325abadcba5df7dd9ddbaa792736185ecd30f77e1d4333521bbd1d64717d06509de0c759b5f2a1edbb705

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
   - 2.0.0
+  - 2.1.0
 services:
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Version 0.8.1
+
+* Force use of custom implementation of `fetch_multi`. This makes using the
+  default ActiveSupport stores (Memory, Null) possible in versions of Rails
+  between 4.0 and 4.1.
+* Use array extract option support in custom fetch.
+
+## Version 0.8.0
+
+* Support reconstructing collections of rooted objects and associations.
+
 ## Version 0.7.0
 
 * Alter the implementation of `fetch_multi` to return a hash rather than an

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in perforated-cache.gemspec
 gemspec
+
+gem 'dalli'
+gem 'redis'
+gem 'redis-activesupport'

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/sorentwo/perforated.png?branch=master)](https://travis-ci.org/sorentwo/perforated)
 [![Code Climate](https://codeclimate.com/github/sorentwo/perforated.png)](https://codeclimate.com/github/sorentwo/perforated)
+[![Gem Version](https://badge.fury.io/rb/perforated.png)](http://badge.fury.io/rb/perforated)
 
 # Perforated
 
@@ -20,7 +21,7 @@ if you are so inclined you can customize the backing cache. The default cache
 store is `ActiveSupport::Cache::MemoryStore`, which is fast but has no
 persistence.
 
-Within a Rails project the simplest option is to lock with the Rails cache.
+Within a Rails project the simplest option is to lock with the Rails cache:
 
 ```ruby
 Perforated.configure do |config|
@@ -36,9 +37,20 @@ Perforated.configure do |config|
 end
 ```
 
+The standard library's JSON parser is great for most usage, and thus it is the
+default. However, sometimes you may want a bit more control or performance:
+
+```ruby
+require 'oj'
+
+Perforated.configure do |config|
+  config.json = Oj
+end
+```
+
 ## Usage
 
-Wrap any collection that you want to serialize in an a cache instance and then
+Wrap any collection that you want to serialize in a cache instance and then
 call `as_json` or `to_json` on it. Not much to it!
 
 ```ruby
@@ -51,6 +63,35 @@ Any objects that have been cached will be retrieved unaltered. Any missing
 objects (cache misses) will be serialized, inserted back into the collection,
 and written into the cache.
 
+Perforated supports reconstructing rooted objects, the likes of which can be
+output by [ActiveModelSerializers][ams]. Serialized object collections may also
+have associations serialized within the same cache key. After the cached
+objects are fetched they will be merged together into flattened namespaces. For
+example, given a serialized representation like this:
+
+```json
+{ "posts":   { "id": 1, "author_id": 1, "title": "Greatness" },
+  "authors": [{ "id": 1, "name": "Myself" }] }
+
+{ "posts":   { "id": 2, "author_id": 2, "title": "Failure" },
+  "authors": [{ "id": 2, "name": "Somebody" }] }
+```
+
+The reconstructed and flattened represenation can be retrieved:
+
+```ruby
+perforated.to_json(rooted: true) #=> {
+  "posts": [
+    { "id": 1, "author_id": 1, "title": "Greatness" },
+    { "id": 2, "author_id": 2, "title": "Failure" }
+  ],
+  "authors": [
+    { "id": 1, "name": "Myself" },
+    { "id": 2, "name": "Somebody" }
+  ]
+}
+```
+
 ### Custom Key Strategy
 
 The default cache key strategy is to delegate back to each object to construct
@@ -88,7 +129,7 @@ perforated = Perforated::Cache.new(array, CustomStrategy)
 
 Add this line to your application's Gemfile:
 
-    gem 'perforated-cache'
+    gem 'perforated'
 
 And then execute:
 
@@ -96,7 +137,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install perforated-cache
+    $ gem install perforated
 
 ## Contributing
 
@@ -105,3 +146,5 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[ams]: https://github.com/rails-api/active_model_serializers

data/bench/giant.rb

@@ -0,0 +1,48 @@
+require 'bundler'
+
+Bundler.setup
+
+require 'benchmark'
+require 'dalli'
+require 'perforated'
+require 'active_support/core_ext/object'
+require 'active_support/cache/dalli_store'
+require 'redis'
+require 'redis-activesupport'
+
+Structure = Struct.new(:id) do
+  def to_json
+    { id: id, answers: %w[a b c d e f g], tags: [] }.to_json
+  end
+end
+
+module Strategy
+  def self.expand_cache_key(object, suffix)
+    "perf-#{object}"
+  end
+end
+
+perforated = Perforated::Cache.new((0..20_000).map { |i| Structure.new(i) }, Strategy)
+
+Benchmark.bm do |x|
+  x.report('memory-1') { perforated.to_json }
+  x.report('memory-2') { perforated.to_json }
+
+  Perforated.configure do |config|
+    config.cache = ActiveSupport::Cache::RedisStore.new(host: 'localhost', db: 5)
+  end
+
+  Perforated.cache.clear
+
+  x.report('redis-1') { perforated.to_json }
+  x.report('redis-2') { perforated.to_json }
+
+  Perforated.configure do |config|
+    config.cache = ActiveSupport::Cache::DalliStore.new('localhost')
+  end
+
+  Perforated.cache.clear
+
+  x.report('dalli-1') { perforated.to_json }
+  x.report('dalli-2') { perforated.to_json }
+end

data/lib/perforated/cache.rb

@@ -7,32 +7,45 @@ module Perforated
       @key_strategy = key_strategy
     end
 
-    def as_json(*)
-      keyed = keyed_enumerable('as-json')
-      keys  = keyed.keys.map(&:dup)
-
-      fetch_multi(keys) { |key| keyed[key].as_json }.values
+    def as_json(options = {})
+      keyed   = keyed_enumerable('as-json')
+      objects = fetch_multi(keyed) { |key| keyed[key].as_json }.values
+
+      if options[:rooted]
+        Perforated::Rooted.merge(objects)
+      else
+        objects
+      end
     end
 
-    def to_json(*)
+    def to_json(options = {})
       keyed   = keyed_enumerable('to-json')
-      keys    = keyed.keys.map(&:dup)
-      objects = fetch_multi(keys) { |key| keyed[key].to_json }
+      objects = fetch_multi(keyed) { |key| keyed[key].to_json }
+      concat  = concatenate(objects)
 
-      "[#{objects.values.join(',')}]"
+      if options[:rooted]
+        Perforated::Rooted.reconstruct(concat)
+      else
+        concat
+      end
     end
 
     private
 
     def keyed_enumerable(suffix = '')
-      enumerable.inject({}) do |memo, object|
+      enumerable.each_with_object({}) do |object, memo|
         memo[key_strategy.expand_cache_key(object, suffix)] = object
-        memo
       end
     end
 
-    def fetch_multi(keys, &block)
-      Perforated::Compatibility.fetch_multi *keys, &block
+    def fetch_multi(keyed, &block)
+      keys = keyed.keys.map(&:dup)
+
+      Perforated::Compatibility.fetch_multi(*keys, &block)
+    end
+
+    def concatenate(objects)
+      "[#{objects.values.join(',')}]"
     end
   end
 end

data/lib/perforated/compatibility/fetch_multi.rb

@@ -1,27 +1,31 @@
+require 'active_support/core_ext/array/extract_options'
+
 module Perforated
   module Compatibility
     def self.fetch_multi(*names, &block)
-      if Perforated.cache.respond_to?(:fetch_multi)
+      if supports_fetch_multi?
         Perforated.cache.fetch_multi(*names, &block)
       else
         custom_fetch_multi(*names, &block)
       end
     end
 
-    # Backward compatible implementation of fetch multi.
     def self.custom_fetch_multi(*names)
-      options = {}
+      options = names.extract_options!
       results = Perforated.cache.read_multi(*names, options)
 
-      names.inject({}) do |memo, (name, _)|
+      names.each_with_object({}) do |(name, _), memo|
         memo[name] = results.fetch(name) do
           value = yield name
           Perforated.cache.write(name, value, options)
           value
         end
-
-        memo
       end
     end
+
+    def self.supports_fetch_multi?
+      Perforated.cache.respond_to?(:fetch_multi) &&
+      !Perforated.cache.instance_of?(ActiveSupport::Cache::MemoryStore)
+    end
   end
 end

data/lib/perforated/rooted.rb

@@ -0,0 +1,33 @@
+require 'set'
+
+module Perforated
+  module Rooted
+    def self.merge(objects)
+      merged = objects.each_with_object({}) do |object, memo|
+        object.each do |key, value|
+          memo[key] ||= Set.new
+
+          if value.is_a?(Array)
+            memo[key].merge(value)
+          else
+            memo[key].add(value)
+          end
+        end
+      end
+
+      sets_to_arrays(merged)
+    end
+
+    def self.reconstruct(objects, parser = Perforated.json)
+      parser.dump(merge(parser.load(objects)))
+    end
+
+    def self.sets_to_arrays(object)
+      object.each do |key, value|
+        object[key] = value.to_a
+      end
+
+      object
+    end
+  end
+end

data/lib/perforated/version.rb

@@ -1,3 +1,3 @@
 module Perforated
-  VERSION = '0.7.0'
+  VERSION = '0.8.1'
 end

data/lib/perforated.rb

@@ -2,6 +2,7 @@ require 'active_support/cache'
 require 'json'
 require 'perforated/cache'
 require 'perforated/compatibility/fetch_multi'
+require 'perforated/rooted'
 require 'perforated/strategy/default'
 require 'perforated/version'
 
@@ -14,7 +15,20 @@ module Perforated
     @cache ||= ActiveSupport::Cache::MemoryStore.new
   end
 
+  def self.json=(new_json)
+    @json = new_json
+  end
+
+  def self.json
+    @json ||= JSON
+  end
+
   def self.configure
     yield self
   end
+
+  def self.reset!
+    @cache = nil
+    @json  = nil
+  end
 end

data/perforated.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '> 3.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake',    '~> 10.1.0'
-  spec.add_development_dependency 'rspec',   '~> 2.14.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
 end

data/spec/perforated/cache_spec.rb

@@ -17,12 +17,25 @@ describe Perforated::Cache do
     end
   end
 
+  Family = Struct.new(:name, :languages) do
+    def as_json
+      { languages: languages }
+    end
+
+    def to_json
+      as_json.to_json
+    end
+
+    def cache_key
+      ['Family', name]
+    end
+  end
+
   describe '#as_json' do
     it 'constructs an automatically cached serialized' do
       ruby   = Language.new('Ruby')
       elixir = Language.new('Elixir')
-      array  = [ruby, elixir]
-      cache  = Perforated::Cache.new(array)
+      cache  = Perforated::Cache.new([ruby, elixir])
 
       expect(cache.as_json).to eq([{ name: 'Ruby' }, { name: 'Elixir' }])
 
@@ -38,6 +51,16 @@ describe Perforated::Cache do
 
       expect(Perforated.cache.read('Language/Erlang/as-json')).to eq(name: 'Elixir')
     end
+
+    it 'merges objects comprised of rooted arrays' do
+      lisps   = Family.new('Lisp', ['scheme', 'clojure'])
+      scripts = Family.new('Script', ['perl', 'ruby'])
+      cache   = Perforated::Cache.new([lisps, scripts])
+
+      expect(cache.as_json(rooted: true)).to eq(
+        languages: %w[scheme clojure perl ruby]
+      )
+    end
   end
 
   describe '#to_json' do
@@ -45,8 +68,18 @@ describe Perforated::Cache do
       cache = Perforated::Cache.new([Language.new('Ruby'), Language.new('Elixir')])
 
       expect(cache.to_json).to eq(%([{"name":"Ruby"},{"name":"Elixir"}]))
-      expect(Perforated.cache.exist?('Language/Ruby/to-json')).to   be_true
-      expect(Perforated.cache.exist?('Language/Elixir/to-json')).to be_true
+      expect(Perforated.cache.exist?('Language/Ruby/to-json')).to   be_truthy
+      expect(Perforated.cache.exist?('Language/Elixir/to-json')).to be_truthy
+    end
+
+    it 'reconstructs rooted objects into a single merged object' do
+      lisps   = Family.new('Lisp', ['scheme', 'clojure'])
+      scripts = Family.new('Script', ['perl', 'ruby'])
+      cache   = Perforated::Cache.new([lisps, scripts])
+
+      expect(cache.to_json(rooted: true)).to eq(
+        '{"languages":["scheme","clojure","perl","ruby"]}'
+      )
     end
   end
 end

data/spec/perforated/compatibility/fetch_multi_spec.rb

@@ -5,11 +5,11 @@ describe Perforated::Compatibility do
 
   describe '.fetch_multi' do
     it 'uses the fetch_multi method on the configured cache if present' do
-      cache = Perforated.cache = double(:cache, fetch_multi: true)
+      Perforated.cache = double(:store)
 
-      Perforated::Compatibility.fetch_multi(:one, :two)
+      expect(Perforated.cache).to receive(:fetch_multi).with(:one, :two)
 
-      expect(cache).to have_received(:fetch_multi).with(:one, :two)
+      Perforated::Compatibility.fetch_multi(:one, :two) { |key| key }
     end
 
     it 'falls back to the custom backfill if the cache does not support it' do

data/spec/perforated/rooted_spec.rb

@@ -0,0 +1,26 @@
+require 'perforated'
+
+describe Perforated::Rooted do
+  describe '.merge' do
+    it 'merges all nested objects' do
+      obj_a = { languages: [{ name: 'scheme' }] }
+      obj_b = { languages: [{ name: 'clojure' }] }
+
+      expect(Perforated::Rooted.merge([obj_a, obj_b])).to eq(
+        languages: [{ name: 'scheme' }, { name: 'clojure' }]
+      )
+    end
+  end
+
+  describe '.reconstruct' do
+    it 'merges stringified json' do
+      obj_a  = JSON.dump({ languages: [{ name: 'scheme' }] })
+      obj_b  = JSON.dump({ languages: [{ name: 'clojure' }] })
+      concat = "[#{obj_a},#{obj_b}]"
+
+      expect(Perforated::Rooted.reconstruct(concat)).to eq(
+        '{"languages":[{"name":"scheme"},{"name":"clojure"}]}'
+      )
+    end
+  end
+end

data/spec/perforated_spec.rb

@@ -1,23 +1,32 @@
 require 'perforated'
 
 describe Perforated do
-  after { Perforated.cache = nil }
+  after { Perforated.reset! }
 
   describe '#configuration' do
     it 'stores an injected cache object' do
       custom_cache = Object.new
+      custom_parse = Object.new
 
       Perforated.configure do |config|
         config.cache = custom_cache
+        config.json  = custom_parse
       end
 
-      Perforated.cache.should be(custom_cache)
+      expect(Perforated.cache).to be(custom_cache)
+      expect(Perforated.json).to be(custom_parse)
+    end
+  end
+
+  describe '#json' do
+    it 'falls back to core library json' do
+      expect(Perforated.json).to eq(JSON)
     end
   end
 
   describe '#cache' do
     it 'falls back to ActiveSupport::Cache::MemoryStore' do
-      Perforated.cache.should be_instance_of(ActiveSupport::Cache::MemoryStore)
+      expect(Perforated.cache).to be_instance_of(ActiveSupport::Cache::MemoryStore)
     end
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: perforated
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '2.14'
 description: Intellgent json collection caching
 email:
 - parker@sorentwo.com
@@ -73,22 +73,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/giant.rb
 - lib/perforated.rb
 - lib/perforated/cache.rb
 - lib/perforated/compatibility/fetch_multi.rb
+- lib/perforated/rooted.rb
 - lib/perforated/strategy/default.rb
 - lib/perforated/version.rb
 - perforated.gemspec
 - spec/perforated/cache_spec.rb
 - spec/perforated/compatibility/fetch_multi_spec.rb
+- spec/perforated/rooted_spec.rb
 - spec/perforated_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sorentwo/perforated
@@ -101,17 +104,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: 'The most expensive part of serving a JSON request is converting the serialized
@@ -121,5 +124,6 @@ summary: 'The most expensive part of serving a JSON request is converting the se
 test_files:
 - spec/perforated/cache_spec.rb
 - spec/perforated/compatibility/fetch_multi_spec.rb
+- spec/perforated/rooted_spec.rb
 - spec/perforated_spec.rb
 - spec/spec_helper.rb