ohm-identity_map 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZThmYTc5ODlhMDVkOTVjNGUwOWE0NTJmNDhjZGVjZWI1ZjM5ZDBiZQ==
+  data.tar.gz: !binary |-
+    MDMxZjc2YjAyOTE0YzE3YzhiNjA3NTA0ODE5ODc4OWI5NTE5NzJhMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDFmNDA4ZWM1N2I4ODM1NTlkY2U5MTNlMjQ3MDEyYzFlZDVjYzYwZmZjNTkx
+    YWQ2NjA3NGIyNDc2MWY1MjhiNjRkNWZmYmJmYzE0NGUwMzAwZDhiZTRmM2Zj
+    OTYzYmNjNmM5NjYxMDczMTBjOWZiNzFhNzA5NjNhYTU4ZWJiMzQ=
+  data.tar.gz: !binary |-
+    YjMxMWFiMjRjZWMwNzRhNGUzOGJmNWNiZGQxMWY2MzlmNzYwMzdhNTFmNTMy
+    NzYyZjJhMzNiYTNmMzVhN2I5ZGFmNDhlY2QzNDdhNzBlZWRlZWEzN2M5ZWRj
+    MmYzMmNhZGQxYjgxZTc5Yjk2ZTM5YWU2YTU0Y2MyZDU0Zjc4NTU=

data/.gitignore

@@ -0,0 +1 @@
+/.gs

data/README.md

@@ -0,0 +1,53 @@
+Ohm::IdentityMap
+================
+
+Provides a basic identity map for [Ohm][1].
+
+Usage
+-----
+
+    require "ohm/identity_map"
+
+    # By default, no identity map is used.
+
+    Post[1].object_id == Post[1].object_id
+    # => false
+
+    # Enable the identity map for the duration of a block.
+
+    Ohm::Model.identity_map do
+      Post[1].object_id == Post[1].object_id
+    end
+    # => true
+
+Web
+---
+
+It's easy to create a Rack middleware to enable the identity map for the
+duration of the request/response cycle. (Such middleware may be included in
+this library in the future, once we test this behavior in production.)
+
+    class OhmIdentityMapMiddleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Ohm::Model.identity_map { @app.call(env) }
+      end
+    end
+
+    # config.ru or any Rack::Builder
+    use OhmIdentityMapMiddleware
+
+Known issues
+------------
+
+Currently not handling updates and deletes.
+
+License
+-------
+
+See `UNLICENSE`. With love, from [Educabilia](http://educabilia.com).
+
+[1]: https://github.com/soveran/ohm

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/ohm/identity_map.rb

@@ -0,0 +1,57 @@
+require "ohm"
+
+module Ohm::IdentityMap
+  VERSION = "0.1.0"
+
+  def self.included(model)
+    model.extend(Macros)
+
+    class << model
+      alias original_loader []
+
+      def [](id)
+        if map = Thread.current[:_ohm_identity_map]
+          map.fetch(id) { map[id] = original_loader(id) }
+        else
+          original_loader(id)
+        end
+      end
+
+      alias original_fetch fetch
+
+      def fetch(ids)
+        if map = Thread.current[:_ohm_identity_map]
+          missing_ids, missing_indices = [], []
+
+          mapped = ids.map.with_index do |id, index|
+            map.fetch(id) do
+              missing_ids << id
+              missing_indices << index
+              nil
+            end
+          end
+
+          original_fetch(missing_ids).each.with_index do |instance, index|
+            mapped[missing_indices[index]] = instance
+            map.store(missing_ids[index], instance)
+          end
+
+          mapped
+        else
+          original_fetch(ids)
+        end
+      end
+    end
+  end
+
+  module Macros
+    def identity_map
+      Thread.current[:_ohm_identity_map] = {}
+      yield
+    ensure
+      Thread.current[:_ohm_identity_map] = nil
+    end
+  end
+end
+
+Ohm::Model.send(:include, Ohm::IdentityMap)

data/ohm-identity_map.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path("lib/ohm/identity_map", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name              = "ohm-identity_map"
+  s.version           = Ohm::IdentityMap::VERSION
+  s.summary           = "Basic identity map for Ohm."
+  s.authors           = ["Educabilia", "Damian Janowski"]
+  s.email             = ["opensource@educabilia.com", "djanowski@dimaion.com"]
+  s.homepage          = "https://github.com/educabilia/ohm-identity_map"
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test}/*`.split("\n")
+
+  s.add_development_dependency "ohm"
+  s.add_development_dependency "cutest"
+end

data/rakefile

@@ -0,0 +1,7 @@
+task :test do
+  require "cutest"
+
+  Cutest.run(Dir["test/**/*_test.rb"])
+end
+
+task :default => :test

data/test/identity_map_test.rb

@@ -0,0 +1,54 @@
+require_relative "prelude"
+
+class Post < Ohm::Model
+  attribute :title
+end
+
+class Comment < Ohm::Model
+  attribute :body
+
+  reference :post, :Post
+end
+
+scope do
+  setup do
+    post = Post.create(title: "How to create an Identity Map in Ruby")
+
+    Comment.create(post_id: post.id, body: "Great article!")
+    Comment.create(post_id: post.id, body: "Not so great...")
+  end
+
+  test "Model#[] - identity map disabled" do
+    assert Comment[1].object_id != Comment[1].object_id
+  end
+
+  test "Model#[] - identity map enabled" do
+    comments = Ohm::Model.identity_map do
+      [Comment[1], Comment[1]]
+    end
+
+    assert_equal 1, comments.map(&:object_id).uniq.size
+
+    assert Comment[1].object_id != Comment[1].object_id
+  end
+
+  test "Model#fetch - identity map disabled" do
+    comments = Comment.fetch([1, 2])
+
+    assert_equal 2, comments.map(&:object_id).uniq.size
+  end
+
+  test "Model#fetch - identity map enabled" do
+    comments = Ohm::Model.identity_map { Comment.fetch([1]) + Comment.fetch([1]) }
+
+    assert_equal 1, comments.map(&:object_id).uniq.size
+
+    comments = Ohm::Model.identity_map { Comment.fetch([1]) + Comment.fetch([2]) }
+
+    assert_equal 2, comments.map(&:object_id).uniq.size
+
+    comments = Ohm::Model.identity_map { Comment.fetch([1]) + Comment.fetch([1, 2]) }
+
+    assert_equal 2, comments.map(&:object_id).uniq.size
+  end
+end

data/test/prelude.rb

@@ -0,0 +1,11 @@
+ENV["REDIS_URL"] = "redis://localhost:6379/15"
+
+require "cutest"
+
+$VERBOSE = 1
+
+require_relative "../lib/ohm/identity_map"
+
+prepare do
+  Ohm.flush
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ohm-identity_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Educabilia
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- opensource@educabilia.com
+- djanowski@dimaion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- UNLICENSE
+- lib/ohm/identity_map.rb
+- ohm-identity_map.gemspec
+- rakefile
+- test/identity_map_test.rb
+- test/prelude.rb
+homepage: https://github.com/educabilia/ohm-identity_map
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Basic identity map for Ohm.
+test_files: []