kvom 6.8.3.174.51542603 → 6.9.0.3.197272233

data/lib/kvom/model/base.rb

@@ -1,4 +1,5 @@
 require 'kvom/model'
+
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/class/attribute'
@@ -17,8 +18,15 @@ class Base
 
   class << self
 
-    def has_all_ids
-      include Feature::AllIds
+    def key_prefix
+      to_s
+    end
+
+    # options:
+    # -  hotspot: true  # does not save an additional index document, but creates a hotspot
+    def has_all_ids(options = {})
+      self.kvom_uses_key_prefix_as_hash_value = options[:hotspot]
+      self.kvom_uses_all_index_document = !kvom_uses_key_prefix_as_hash_value?
     end
 
     def create(attributes = {})
@@ -47,27 +55,19 @@ class Base
       end
     end
 
-    # default implementation for the class_attribute
-    def key_prefix
-      to_s
-    end
-
     def adapter
       raise "must be overwritten in subclasses"
     end
 
-    def id_key_for(id)
-      key_for("id/#{id}", nil)
-    end
-
-    private
-
-    def find_document(id)
-      adapter.get(id_key_for(id))
-    end
-
-    def key_for(hash, range)
-      ["#{key_prefix}/#{hash}", range]
+    def all_ids
+      case
+      when kvom_uses_key_prefix_as_hash_value?
+        adapter.range_values_of_hash_value(key_prefix)
+      when kvom_uses_all_index_document?
+        adapter.range_values_of_hash_value("#{key_prefix}/all")
+      else
+        raise "#{name}.all_ids needs to be enabled via has_all_ids"
+      end
     end
 
   end
@@ -84,8 +84,7 @@ class Base
         else
           @new = true
           attrs = doc_or_attrs.stringify_keys
-          key = self.class.id_key_for(attrs["id"] ||= SecureRandom.hex(8))
-          self.class.adapter.new_document(key, attrs)
+          self.class.new_document(attrs)
         end
   end
 
@@ -94,8 +93,7 @@ class Base
   end
 
   def save
-    self.class.adapter.save(@document)
-    self.class.adapter.save_index(all_key) if @new && is_a?(Feature::AllIds)
+    self.class.save_document(@document, @new)
     @new = false
   end
 
@@ -108,8 +106,7 @@ class Base
   end
 
   def destroy
-    self.class.adapter.destroy_index(all_key) if is_a?(Feature::AllIds)
-    self.class.adapter.destroy(@document)
+    self.class.destroy_document(@document)
   end
 
   private
@@ -122,6 +119,57 @@ class Base
     @document[name] = value
   end
 
+  class_attribute :kvom_uses_key_prefix_as_hash_value
+  class_attribute :kvom_uses_all_index_document
+
+  class << self
+
+    # :nodoc:
+    def new_document(attrs)
+      id = attrs["id"] ||= SecureRandom.hex(8)
+      adapter.new_document(id_key_for(id), attrs)
+    end
+
+    # :nodoc:
+    def save_document(document, is_new)
+      adapter.save(document)
+      if is_new
+        if kvom_uses_all_index_document?
+          adapter.save_index(all_key_for(document))
+        end
+      end
+      true
+    end
+
+    # :nodoc:
+    def destroy_document(document)
+      if kvom_uses_all_index_document?
+        adapter.destroy_index(all_key_for(document))
+      end
+      adapter.destroy(document)
+    end
+
+    private
+
+    def find_document(id)
+      adapter.get(id_key_for(id))
+    end
+
+    def id_key_for(id)
+      case
+      when kvom_uses_key_prefix_as_hash_value?
+        [key_prefix, id]
+      else
+        ["#{key_prefix}/id/#{id}", nil]
+      end
+    end
+
+    def all_key_for(document)
+      ["#{key_prefix}/all", document["id"]]
+    end
+
+  end
+
 end
 
 end; end # module Kvom::Model

data/spec/adapter/dynamodb_adapter_spec.rb

@@ -4,7 +4,7 @@ describe Kvom::Adapter::DynamodbAdapter, "endpoint configuration", :adapter => "
 
   context "when no endpoint is specified" do
 
-    let(:adapter) {TestModel.adapter}
+    let(:adapter) {AdapterForSpec.adapter}
 
     it "is configured to use Ireland" do
       adapter.__send__(:table).config.dynamo_db_endpoint.should == "dynamodb.eu-west-1.amazonaws.com"

data/spec/model/all_ids_spec.rb

@@ -1,76 +1,91 @@
 require 'spec_helper'
 
 describe Kvom::Model::Base, "with all-index enabled" do
-  describe ".all_ids" do
-    before(:all) do
-      TestModelWithIndex.create(:id => volatile_id("0815-list"))
-      TestModelWithIndex.create(:id => volatile_id("007"))
-      OtherModelWithIndex.create(:id => volatile_id("other"))
-    end
+  shared_examples_for "an all_ids supporting model" do |model_class, other_class|
+    describe ".all_ids" do
+      before(:all) do
+        model_class.create(:id => volatile_id("0815-list"))
+        model_class.create(:id => volatile_id("007"))
+        other_class.create(:id => volatile_id("other"))
+      end
 
-    it "returns the ids of all persisted models" do
-      all_ids = TestModelWithIndex.all_ids
-      expected_ids = [volatile_id("0815-list"), volatile_id("007")]
-      (expected_ids & all_ids).should eq(expected_ids)
-    end
+      let(:all_ids) {model_class.all_ids}
+      let(:other_ids) {other_class.all_ids}
 
-    it "returns only ids of the model" do
-      all_ids = TestModelWithIndex.all_ids
-      all_ids.should_not include(volatile_id("other"))
-    end
+      it "returns the ids of all persisted models" do
+        expected_ids = [volatile_id("0815-list"), volatile_id("007")]
+        (expected_ids & all_ids).should eq(expected_ids)
+      end
 
-    it "returns ids for which a model can be fetched" do
-      all_ids = TestModelWithIndex.all_ids
-      erroneous_ids = {}
-      all_ids.each do |model_id|
-        TestModelWithIndex.find(model_id).tap do |model|
-          model.should be
-          model.should be_kind_of(TestModelWithIndex)
+      it "returns only ids of the model" do
+        other_ids.should_not be_empty
+        (all_ids & other_ids).should be_empty
+      end
+
+      it "returns ids for which a model can be fetched" do
+        all_ids.each do |model_id|
+          model_class.find(model_id).tap do |model|
+            model.should be
+            model.should be_instance_of(model_class)
+          end
         end
       end
     end
-  end
 
-  describe ".create" do
-    it "adds the instance's id to the ids returned by .all_ids" do
-      new_id = volatile_id("neu")
-      expect {
-        TestModelWithIndex.create(:id => new_id)
-      }.to change {
-        TestModelWithIndex.all_ids.include?(new_id)
-      }.to(true)
+    describe ".create" do
+      it "adds the instance's id to the ids returned by .all_ids" do
+        new_id = volatile_id("neu")
+        expect {
+          model_class.create(:id => new_id)
+        }.to change {
+          model_class.all_ids.include?(new_id)
+        }.to(true)
+      end
     end
-  end
 
-  describe "#destroy" do
-    let(:model) {TestModelWithIndex.create(:id => volatile_id("weg"))}
+    describe "#destroy" do
+      let(:model_id) {volatile_id("weg")}
+      let(:model) {model_class.create(:id => model_id)}
 
-    before do
-      model
-    end
+      before do
+        model
+      end
 
-    it "removes the instance's id from the ids returned by .all_ids" do
-      expect {
-        model.destroy
-      }.to change {
-        TestModelWithIndex.all_ids.include?(volatile_id("weg"))
-      }.to(false)
+      it "removes the instance's id from the ids returned by .all_ids" do
+        expect {
+          model.destroy
+        }.to change {
+          model_class.all_ids.include?(model_id)
+        }.to(false)
+      end
     end
   end
 
-  describe ".save" do
-    it "does not write the index doc for an existing model" do
-      new_model = TestModelWithIndex.new(:id => volatile_id("counting"))
-      counter_before = TestModelWithIndex.adapter.request_counter
-      new_model.save
-      counter_new_saved = TestModelWithIndex.adapter.request_counter
-      requests_for_new_model = counter_new_saved - counter_before
-      new_model.something = "changed"
-      new_model.save
-      counter_existing_saved = TestModelWithIndex.adapter.request_counter
-      requests_for_existing_model = counter_existing_saved - counter_new_saved
+  context "for a hotspot kvom model" do
+    it_should_behave_like "an all_ids supporting model",
+        ExampleModelWithHotspotIndexForAllIds, ExampleModelWithHotspotIndex
+  end
+
+  context "for a standard kvom model with all_ids enabled" do
+    it_should_behave_like "an all_ids supporting model", ExampleModelWithIndex, OtherModelWithIndex
 
-      requests_for_existing_model.should < requests_for_new_model
+    describe ".save" do
+      let(:adapter) {ExampleModelWithIndex.adapter}
+
+      def count_requests
+        counter_before = adapter.request_counter
+        yield
+        adapter.request_counter - counter_before
+      end
+
+      it "does not write the index doc for an existing model" do
+        model = ExampleModelWithIndex.new(:id => volatile_id("counting"))
+        request_count_for_model_create = count_requests {model.save}
+        request_count_for_model_update = count_requests {model.something = "changed"; model.save}
+
+        request_count_for_model_update.should be < request_count_for_model_create
+        request_count_for_model_update.should eq(request_count_for_model_create - 1)
+      end
     end
   end
 end

data/spec/model/base_spec.rb

@@ -235,13 +235,36 @@ describe Kvom::Model::Base do
     ExampleModel.find(second_id)
   end
 
-  describe "model's id" do
-    it "should use a custom prefix when given" do
-      CustomKeyPrefixModel.new.__send__(:document).key.first.should =~ /^spam_prefix\/id\/.+/
-    end
+  describe "model's database key" do
+    let(:model_class) {ExampleModel}
+    let(:instance) {model_class.new}
+    let(:database_key) {instance.document.key}
 
     it "should use a default prefix" do
-      ExampleModel.new.__send__(:document).key.first.should =~ /^ExampleModel\/id\/.+/
+      database_key.should == ["ExampleModel/id/#{instance.id}", nil]
+    end
+
+    context "when a custom prefix is provided" do
+      let(:model_class) {CustomKeyPrefixModel}
+
+      it "should use the configured prefix" do
+        database_key.should == ["spam_prefix/id/#{instance.id}", nil]
+      end
+    end
+
+    context "when the model class is configured as hotspot model" do
+      let(:model_class) {ExampleModelWithHotspotIndex}
+
+      it "should use a default prefix" do
+        database_key.should == ["ExampleModelWithHotspotIndex", instance.id]
+      end
+
+    context "when a custom prefix is provided" do
+      let(:model_class) {CustomKeyPrefixWithHotspotIndex}
+
+      it "should use a default prefix" do
+        database_key.should == ["hotspot", instance.id]
+      end
     end
   end
 
@@ -250,17 +273,44 @@ describe Kvom::Model::Base do
       expect { ExampleModel.find("") }.to raise_error /no id given/
     end
 
-    it "should find model instances" do
-      model = ExampleModel.create(:spam => "foo")
-      ExampleModel.find(model.id).id.should == model.id
-      ExampleModel.find(model.id).spam.should == "foo"
+    shared_examples_for "a kvom model find" do
+      context "when the instance exists in database" do
+        let(:instance) {model_class.create(:spam => "foo")}
+        let(:instance_id) {instance.id}
+
+        before do
+          instance
+        end
+
+        it "should find existing model instances" do
+          model_class.find(instance_id).should be_instance_of(model_class)
+          model_class.find(instance_id).id.should == instance_id
+          model_class.find(instance_id).spam.should == "foo"
+        end
+      end
+
+      context "when the instance does not exist in the database"
+        let(:bad_id) {random_id}
+
+        it "should raise #{Kvom::NotFound}" do
+          expect {
+            ExampleModel.find(bad_id)
+          }.to raise_error(Kvom::NotFound, %r(document.* key "#{key_for_bad_id}"))
+        end
+      end
+
     end
 
-    it "should raise exception when instances cannot be found" do
-      model_id = random_id
-      expect {
-        ExampleModel.find(model_id)
-      }.to raise_error(Kvom::NotFound, %r(document.* key "ExampleModel/id/#{model_id}\|"))
+    let(:model_class) {ExampleModel}
+    let(:key_for_bad_id) {"ExampleModel/id/#{bad_id}\|"}
+
+    it_should_behave_like "a kvom model find"
+
+    context "when configured as hotspot model" do
+      let(:model_class) {ExampleModelWithHotspotIndex}
+      let(:key_for_bad_id) {"ExampleModel|#{bad_id}"}
+
+      it_should_behave_like "a kvom model find"
     end
   end
 
@@ -300,23 +350,27 @@ describe Kvom::Model::Base do
     end
 
     def create_document(hash, range)
+      adapter = AdapterForSpec.adapter
       document = adapter.new_document([volatile_id(hash), range], {})
       adapter.save(document)
       document
     end
 
-    let(:adapter) {TestModel.adapter}
-
-    let(:one_001) {create_document("one", "001")}
-    let(:one_002) {create_document("one", "002")}
-    let(:one_0021) {create_document("one", "0021")}
-    let(:one_0022) {create_document("one", "0022")}
-    let(:one_3) {create_document("one", "3")}
-    let(:two_two) {create_document("two", "two")}
-    let(:three_empty) {create_document("three", nil)}
+    let(:adapter) {AdapterForSpec.adapter}
 
     before(:all) do
-      [one_001, one_002, one_0021, one_0022, one_3, two_two, three_empty]
+      @documents = {}
+      @documents[:one_001] = create_document("one", "001")
+      @documents[:one_002] = create_document("one", "002")
+      @documents[:one_0021] = create_document("one", "0021")
+      @documents[:one_0022] = create_document("one", "0022")
+      @documents[:one_3] = create_document("one", "3")
+      @documents[:two_two] = create_document("two", "two")
+      @documents[:three_empty] = create_document("three", nil)
+    end
+
+    [:one_001, :one_002, :one_0021, :one_0022, :one_3, :two_two, :three_empty].each do |key|
+      let(key) {@documents[key]}
     end
 
     it 'should be able to limit results' do
@@ -447,36 +501,40 @@ describe Kvom::Model::Base do
 
       let(:model_from_attributes) {ExampleModel.new({})}
 
-      it "is new" do
-        model_from_attributes.should be_new
+      context "without an id" do
+        it "is new" do
+          model_from_attributes.should be_new
+        end
       end
 
-      context "and saved" do
+
+      context "including id" do
+
+        let(:model_id) {"not_a_default_#{random_id}"}
+        let(:model_from_attributes_including_id) {ExampleModel.new({"id" => model_id})}
 
         before do
-          model_from_attributes.save
+          model_from_attributes_including_id.id.should == model_id
         end
 
-        it "is not new" do
-          model_from_attributes.should_not be_new
+        it "is new" do
+          model_from_attributes_including_id.should be_new
         end
 
       end
 
-      context "including id" do
-
-        let(:model_id) {"not_a_default_#{random_id}"}
-        let(:model_from_attributes_including_id) {ExampleModel.new({"id" => model_id})}
+      context "and saved" do
 
         before do
-          model_from_attributes_including_id.id.should == model_id
+          model_from_attributes.save
         end
 
-        it "is new" do
-          model_from_attributes.should be_new
+        it "is not new" do
+          model_from_attributes.should_not be_new
         end
 
       end
+
     end
 
     context "when instantiated from database" do

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require File.expand_path("../../lib/kvom", __FILE__)
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f[0..-4]}
 
 RSpec.configure do |config|
-  adapter = TestModel.adapter.class.to_s.demodulize.sub("Adapter", "").sub("db", "").downcase
+  adapter = AdapterForSpec.adapter.class.to_s.demodulize.sub("Adapter", "").sub("db", "").downcase
   adapter_specified_and_different = lambda {|required_adapter|
     required_adapter && required_adapter.to_s != adapter
   }

data/spec/support/model.rb

@@ -1,6 +1,8 @@
+require File.join(File.dirname(__FILE__), 'test_ids')
+
 class TestModel < Kvom::Model::Base
   def self.adapter
-    @adapter ||= AdapterForSpec.adapter
+    AdapterForSpec.adapter
   end
 end
 
@@ -8,26 +10,36 @@ class ExampleModel < TestModel
   property :spam
 end
 
-class CustomKeyPrefixModel < TestModel
+class CustomKeyPrefixModel < ExampleModel
   self.key_prefix = "spam_prefix"
 end
 
 class ModelWithoutAdapter < Kvom::Model::Base
 end
 
-require 'securerandom'
-class TestModelWithIndex < TestModel
+class ExampleModelWithIndex < TestModel
   has_all_ids
-
   property :something
 
   # not required to be set, but keeps cleanup and test separated
-  $test_model_with_index_key_prefix ||= "#{key_prefix}-#{SecureRandom.hex(8)}"
-  self.key_prefix = $test_model_with_index_key_prefix
+  self.key_prefix = "#{key_prefix}-#{TestIds.discriminator}"
 end
 
-class OtherModelWithIndex < TestModel
+class OtherModelWithIndex < ExampleModel
   has_all_ids
 
   property :something
 end
+
+class ExampleModelWithHotspotIndex < ExampleModel
+  # property is inherited
+  has_all_ids(hotspot: true)
+end
+
+class CustomKeyPrefixWithHotspotIndex < ExampleModelWithHotspotIndex
+  self.key_prefix = "hotspot"
+end
+
+class ExampleModelWithHotspotIndexForAllIds < ExampleModelWithHotspotIndex
+  self.key_prefix = "#{key_prefix}-#{TestIds.discriminator}"
+end

data/spec/support/test_ids.rb

@@ -1,9 +1,16 @@
+require 'securerandom'
+
 module TestIds
   # - returns the same id for the whole test run
   # - returns a different id when running the specs again
   #   => no id collision when running the tests on a reused and not emptied database
+
+  def self.discriminator
+    @discriminator ||= Time.now.strftime("%Y%m%d%H%M%S-") + SecureRandom.hex(8)
+  end
+
   def self.volatile_id(id)
-    "#{@discriminator ||= Time.now.strftime("%Y%m%d%H%M%S-") + SecureRandom.hex(8)}#{id}"
+    "#{discriminator}#{id}"
   end
 
   def volatile_id(id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kvom
 version: !ruby/object:Gem::Version
-  version: 6.8.3.174.51542603
+  version: 6.9.0.3.197272233
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -148,8 +148,6 @@ files:
 - lib/kvom/lib/json_value.rb
 - lib/kvom/model.rb
 - lib/kvom/model/base.rb
-- lib/kvom/model/feature.rb
-- lib/kvom/model/feature/all_ids.rb
 - lib/kvom/model_identity.rb
 - lib/kvom/storage.rb
 - lib/kvom/storage/base.rb
@@ -187,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -968281363
+      hash: -799392035
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/kvom/model/feature.rb

@@ -1,5 +0,0 @@
-require 'kvom/model'
-
-module Kvom::Model::Feature
-  Kvom.setup_autoload(self, __FILE__)
-end

data/lib/kvom/model/feature/all_ids.rb

@@ -1,30 +0,0 @@
-require 'kvom/model/feature'
-
-module Kvom; module Model; module Feature
-
-module AllIds
-
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  module ClassMethods
-    def all_ids
-      adapter.range_values_of_hash_value("#{key_prefix}/all")
-    end
-
-    def all_key_for(id)
-      key_for("all", id)
-    end
-
-  end
-
-  private
-
-  def all_key
-    self.class.all_key_for(id)
-  end
-
-end
-
-end; end; end