ricordami 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog #
 
+## 0.0.5 (March 14th, 2011) ##
+
+  - allow to have unique and value indices on the same column so we can
+    query fields that have a unique scoped index
+
 ## 0.0.4 (March 13th, 2011) ##
 
   - add a scope option to validates_uniqueness_of validation macro

data/TODO.md

@@ -10,6 +10,8 @@
 
   - add support for booleans and datetimes
   - add support for native types (list, hash, set, sorted set)
+  - add better exception descriptions (i.e.: missing value index when
+    querying, etc...)
 
 ## Maybe ##
 

data/lib/ricordami/can_be_queried.rb

@@ -61,7 +61,7 @@ module Ricordami
       private
 
       def run_expressions(expressions)
-        key_all_ids = indices[:id].uidx_key_name
+        key_all_ids = indices[:u_id].uidx_key_name
         result_key = expressions.reduce(key_all_ids) do |key, expression|
           type, conditions = expression
           condition_keys = get_keys_for_each_condition(conditions)
@@ -74,8 +74,9 @@ module Ricordami
 
       def get_keys_for_each_condition(conditions)
         conditions.map do |field, value|
-          index = indices[field]
-          raise MissingIndex.new("class: #{self}, attribute: #{field.inspect}") if index.nil?
+          index_name = "v_#{field}".to_sym
+          index = indices[index_name]
+          raise MissingIndex.new("class: #{self}, attribute: #{index_name.inspect}") if index.nil?
           index.key_name_for_value(value)
         end
       end

data/lib/ricordami/is_retrievable.rb

@@ -23,12 +23,12 @@ module Ricordami
       alias :[] :get
 
       def all(expressions = nil)
-        ids = indices[:id].all
+        ids = indices[:u_id].all
         ids.map { |id| get(id) }
       end
 
       def count
-        indices[:id].count
+        indices[:u_id].count
       end
     end
   end

data/lib/ricordami/unique_index.rb

@@ -9,7 +9,7 @@ module Ricordami
     def initialize(model, fields, options = {})
       @model = model
       @fields = normalize_array(fields)
-      @name = @fields.join("_").to_sym
+      @name = ("u_" + @fields.join("_")).to_sym
       @need_get_by = options[:get_by] && @fields != [:id]
       if options.has_key?(:scope)
         @scope = normalize_array(options[:scope])

data/lib/ricordami/unique_validator.rb

@@ -4,7 +4,7 @@ module Ricordami
   class UniqueValidator < ActiveModel::EachValidator
     def validate_each(record, attribute, value)
       return true unless record.new_record? || record.send(:attribute_changed?, attribute)
-      index_name = attribute.to_sym
+      index_name = "u_#{attribute}".to_sym
       index = record.class.indices[index_name]
       if index.scope
         scope_values = index.scope.map { |field| record.send(field) }

data/lib/ricordami/value_index.rb

@@ -7,7 +7,7 @@ module Ricordami
     def initialize(model, field)
       @model = model
       @field = field.to_sym
-      @name = @field
+      @name = "v_#{@field}".to_sym
     end
 
     def key_name_for_value(value)

data/lib/ricordami/version.rb

@@ -1,3 +1,3 @@
 module Ricordami
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/ricordami/can_be_queried_spec.rb

@@ -10,7 +10,9 @@ describe Ricordami::CanBeQueried do
     Customer.attribute :sex,     :indexed => :value
     Customer.attribute :name,    :indexed => :value
     Customer.attribute :kind,    :indexed => :value
+    Customer.attribute :age,     :indexed => :value
     Customer.attribute :no_index
+    Customer.index :unique => :age, :scope => :kind
   end
 
   describe "building queries" do
@@ -71,10 +73,10 @@ describe Ricordami::CanBeQueried do
 
   describe "running queries" do
     before(:each) do
-      Customer.create(:name => "Zhanna", :sex => "F", :country => "Latvia", :kind => "human")
-      Customer.create(:name => "Mathieu", :sex => "M", :country => "France", :kind => "human")
-      Customer.create(:name => "Sophie", :sex => "F", :country => "USA", :kind => "human")
-      Customer.create(:name => "Brioche", :sex => "F", :country => "USA", :kind => "dog")
+      Customer.create(:name => "Zhanna", :sex => "F", :country => "Latvia", :kind => "human", :age => "29")
+      Customer.create(:name => "Mathieu", :sex => "M", :country => "France", :kind => "human", :age => "40")
+      Customer.create(:name => "Sophie", :sex => "F", :country => "USA", :kind => "human", :age => "1")
+      Customer.create(:name => "Brioche", :sex => "F", :country => "USA", :kind => "dog", :age => "3")
     end
 
     describe ":and" do
@@ -112,6 +114,10 @@ describe Ricordami::CanBeQueried do
       it "doesn't require #all if another method call is chained" do
         Customer.where(:country => "USA").and(:sex => "F").map(&:name).should =~ ["Sophie", "Brioche"]
       end
+
+      it "can run a query on attributes with unique indices (if they also have a value index of course)" do
+        Customer.where(:country => "USA", :age => "1").map(&:name).should == ["Sophie"]
+      end
     end
 
     describe ":any" do

data/spec/ricordami/has_attributes_spec.rb

@@ -18,17 +18,17 @@ describe Ricordami::HasAttributes do
 
     it "creates an index if :indexed is set" do
       Boat.attribute :size, :indexed => :value
-      Boat.indices.should have_key(:size)
+      Boat.indices.should have_key(:v_size)
     end
 
     it "creates a unique index if :indexed is :unique" do
       Boat.attribute :size, :indexed => :unique
-      Boat.indices[:size].should be_a(Ricordami::UniqueIndex)
+      Boat.indices[:u_size].should be_a(Ricordami::UniqueIndex)
     end
 
     it "creates a value index if :indexed is :value" do
       Boat.attribute :size, :indexed => :value
-      Boat.indices[:size].should be_a(Ricordami::ValueIndex)
+      Boat.indices[:v_size].should be_a(Ricordami::ValueIndex)
     end
 
     it "replaces :initial value with a generator if it's a symbol" do

data/spec/ricordami/has_indices_spec.rb

@@ -15,54 +15,54 @@ describe Ricordami::HasIndices do
     describe "declaring a value index" do
       it "can declare a value index with #index" do
         index = Car.index :value => :model
-        Car.indices[:model].should be_a(Ricordami::ValueIndex)
-        Car.indices[:model].should == index
+        Car.indices[:v_model].should be_a(Ricordami::ValueIndex)
+        Car.indices[:v_model].should == index
       end
     end
 
     describe "declaring a unique index" do
       it "can declare a unique index with #index" do
         index = Car.index :unique => :model
-        Car.indices[:model].should be_a(Ricordami::UniqueIndex)
-        Car.indices[:model].should == index
+        Car.indices[:u_model].should be_a(Ricordami::UniqueIndex)
+        Car.indices[:u_model].should == index
       end
 
       it "can give a scope to a unique index with :scope option" do
         Car.attribute :brand
         index = Car.index :unique => :model, :scope => :brand
-        Car.indices[:model].scope.should == [:brand]
-        Car.indices[:model].fields.should == [:model, :brand]
+        Car.indices[:u_model].scope.should == [:brand]
+        Car.indices[:u_model].fields.should == [:model, :brand]
       end
 
       it "discards the subsequent declarations if the same index is created more than once" do
         Car.index :unique => :model, :get_by => true
-        Car.indices[:model].need_get_by.should be_true
+        Car.indices[:u_model].need_get_by.should be_true
         Car.index :unique => :model, :get_by => false
-        Car.indices[:model].need_get_by.should be_true
+        Car.indices[:u_model].need_get_by.should be_true
       end
 
       it "saves the values of the unique attributes into the indices" do
         Car.index :unique => :name
         car = Car.new(:name => "Prius")
         car.save
-        Car.indices[:name].all.should == ["Prius"]
+        Car.indices[:u_name].all.should == ["Prius"]
       end
 
       it "replaces old values with new ones into the indices" do
         Car.index :unique => :name
         car = Car.new(:name => "Prius")
         car.save
-        Car.indices[:name].all.should == ["Prius"]
+        Car.indices[:u_name].all.should == ["Prius"]
         car.name = "Rav4"
         car.save
-        Car.indices[:name].all.should == ["Rav4"]
+        Car.indices[:u_name].all.should == ["Rav4"]
       end
 
       it "deletes the values of the unique attributes from the indices" do
         Car.index :unique => :name
         car = Car.create(:name => "Prius")
         car.delete.should be_true
-        Car.indices[:name].all.should be_empty
+        Car.indices[:u_name].all.should be_empty
       end
 
       it "adds a get_by_xxx method for each unique index xxx declared if :get_by is true" do

data/spec/ricordami/is_retrievable_spec.rb

@@ -33,10 +33,10 @@ describe Ricordami::IsRetrievable do
       Tenant.attribute :name
       instance = Tenant.new(:id => "hi")
       instance.save
-      Tenant.indices[:id].all.should == ["hi"]
+      Tenant.indices[:u_id].all.should == ["hi"]
       instance.name = "john"
       instance.save
-      Tenant.indices[:id].all.should == ["hi"]
+      Tenant.indices[:u_id].all.should == ["hi"]
     end
 
     it "returns all the instances with #all" do

data/spec/ricordami/unique_index_spec.rb

@@ -13,7 +13,7 @@ describe Ricordami::UniqueIndex do
   it "is initialized with a model, a name and the fields to be unique" do
     @index.model.should == DataSource
     @index.fields.should == [:id]
-    @index.name.should == :id
+    @index.name.should == :u_id
   end
 
   it "can have a scope" do
@@ -23,7 +23,7 @@ describe Ricordami::UniqueIndex do
   end
 
   it "returns its internal index name with #uidx_key_name" do
-    @index.uidx_key_name.should == "DataSource:udx:id"
+    @index.uidx_key_name.should == "DataSource:udx:u_id"
   end
 
   it "returns its internal reference name with #ref_key_name" do
@@ -32,14 +32,14 @@ describe Ricordami::UniqueIndex do
 
   it "adds a string to the index with #add" do
     @index.add("ze-id", "allo")
-    Ricordami.redis.smembers("DataSource:udx:id").should == ["allo"]
+    Ricordami.redis.smembers("DataSource:udx:u_id").should == ["allo"]
   end
 
   it "also indices the hash index with #add if fields is not :id and :get_by is true" do
     DataSource.attribute :domain
     other = subject.new(DataSource, [:name, :domain], :get_by => true)
     other.add("ze-id", ["jobs", "apple.com"])
-    Ricordami.redis.smembers("DataSource:udx:name_domain").should == ["jobs_-::-_apple.com"]
+    Ricordami.redis.smembers("DataSource:udx:u_name_domain").should == ["jobs_-::-_apple.com"]
     Ricordami.redis.hget("DataSource:hsh:name_domain_to_id", "jobs_-::-_apple.com").should == "ze-id"
   end
 
@@ -68,12 +68,12 @@ describe Ricordami::UniqueIndex do
   it "removes a string from the index with #rem" do
     @index.add("ze-id", "allo")
     @index.rem("ze-id", "allo")
-    Ricordami.redis.smembers("DataSource:udx:id").should == []
+    Ricordami.redis.smembers("DataSource:udx:u_id").should == []
   end
 
   it "returns the redis command(s) to remove the value from the index when return_command is true" do
     command = @index.rem("ze-id", "allo", true)
-    command.should == [[:srem, ["DataSource:udx:id", "allo"]]]
+    command.should == [[:srem, ["DataSource:udx:u_id", "allo"]]]
   end
 
   it "returns the number of entries with #count" do

data/spec/ricordami/unique_validator_spec.rb

@@ -17,7 +17,7 @@ describe Ricordami::UniqueValidator do
 
   it "#setup adds a unique index" do
     validator.setup(Call)
-    Call.indices[:name].should be_a(Ricordami::UniqueIndex)
+    Call.indices[:u_name].should be_a(Ricordami::UniqueIndex)
   end
 
   it "#validate_each adds an error if the value is already used" do

data/spec/ricordami/value_index_spec.rb

@@ -14,7 +14,7 @@ describe Ricordami::ValueIndex do
   it "is initialized with a model, a name and a field" do
     index.model.should == Friend
     index.field.should == :first_name
-    index.name.should == :first_name
+    index.name.should == :v_first_name
   end
 
   it "has a key name for each distinct value with #key_name_for_value" do

metadata

@@ -2,7 +2,7 @@
 name: ricordami
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mathieu Lajugie
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 23:00:00 -08:00
+date: 2011-03-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency