unique_by 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4839ad7e8c93eabad52a34ae43774c3a4fa31ead
-  data.tar.gz: d205bd87ab905c57bbc620df6400a36fe9c95fba
+  metadata.gz: 5403c00bf28bbe7858fa14d407bdbda99527de7e
+  data.tar.gz: e9e0dcd9a442febb74ffd046edda31edfc9f4f9d
 SHA512:
-  metadata.gz: afe1110aa03ea678e269655cbbd8d10ff7cbca5406b62a5193724f5617789db734d93e033a56d6077611e3ef9c54ead59dc5a1f80035c74a73ccbcf29cd5deba
-  data.tar.gz: fe7ac2951507f1b2a709f905469881f3e29b4c67d3c1a110b3bd8448d82d869932a13a3758c9de217121b296e989ee50366b17f2cea089ef35deeb1b5babefa4
+  metadata.gz: 2d4d75f32cde147d62e1c6e0a51580c0e4d339fa964d0675413562415ae58b49c650cf5752428d1d164d16e1576d88950b7d7e04d260ef0d2b6be16b8a9a1bce
+  data.tar.gz: ec47fa855292e7e207ada64eb92f54852c114578297a68adedf5895edb0b35d7f5b68171a6a2c94b1a894f77e70484e14af4ed5304d61dcb56b3e9cdf4dc1375

data/README.md

@@ -54,10 +54,6 @@ bill1.unique_id
 => 7873
 bill2.unique_id
 => 7874
-MedicalBill.find_by_unique_id(7873) # from DB shard for client_id = 1
-=> #<MedicalBill id: 123, client_id: 1>
-MedicalBill.find_by_unique_id(7874) # from DB shard for client_id = 2
-=> #<MedicalBill id: 123, client_id: 2>
 ```
 
 You can use the internal methods:
@@ -79,6 +75,21 @@ class MedicalBill < ActiveRecord::Base
 end
 ```
 
+It is recommended to create finder methods that will find records according to
+their id group, like so:
+
+```ruby
+class MedicallBill < ActiveRecord::Base
+  unique_by client_id: 50, client_part: 5 # total of 50 clients and 5 parts
+
+  def self.find_by_unique_id(unique_id)
+    withing_client_connection(id_group_from(unique_id)[:client_id]) do
+      find(id_from(unique_id))
+    end
+  end
+end
+```
+
 ### Multiple tables example
 
 You can supply a block to give a custom mechanism for determining the group:
@@ -103,6 +114,21 @@ class MedicalBill < ActiveRecord::Base
 end
 ```
 
+It is recommended to create finder methods that will find records according to
+their id group, like so:
+
+```ruby
+module Bill
+  module_function
+  def find_by_unique_id(unique_id)
+    case MedicalBill.id_group_from(unique_id)[:type]
+      when 1 then MedicalBill.find(MedicalBill.id_from(unique_id))
+      when 2 then UtilityBill.find(UtilityBill.id_from(unique_id))
+    end
+  end
+end
+```
+
 ## Not ActiveRecord
 
 The generator module is already included in `ActiveRecord::Base`, but if
@@ -127,14 +153,14 @@ fix that:
 ```ruby
 class MedicalBill < ActiveRecord::Base
   unique_by client_id: 500
-  rebase_attr :unique_id, to: 32, readable: true
+  rebase_attr :unique_id, to: 32, readable: true # digits and leters, without '0', 'o', '1' and 'l'
 end
 
-bill = MedicalBill.find(3528918) # from a DB shard for client_id = 1
+bill = MedicalBill.find(3528918) # from a DB shard for client_id = 78
 bill.unique_id
-=> "ywr3bxx"
-MedicalBill.find_by_unique_id(MedicalBill.decode_unique_id("ywr3bxx"))
-=> #<MedicalBill id: 3528918, client_id: 1>
+=> "ywr3b2e"
+bill.unique_id_without_rebase
+=> 1806806094
 ```
 
 ## Contributing

data/lib/unique_by/version.rb

@@ -1,3 +1,3 @@
 module UniqueBy
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/unique_by.rb

@@ -1,4 +1,5 @@
 require "unique_by/version"
+require "generate_method"
 
 module UniqueBy
   module Generator
@@ -20,56 +21,52 @@ module UniqueBy
 
       pk = primary_key # converting to a local variable
 
-      define_singleton_method :"#{pk}_group_value_from" do |**group|
-        raise ArgumentError, "unknown #{pk} group keys: #{group.keys - group_totals.keys}" if (group.keys - group_totals.keys).any?
-        raise ArgumentError, "missing #{pk} group keys: #{group_totals.keys - group.keys}" if (group_totals.keys - group.keys).any?
-        group_totals.keys.reduce(0) do |group_value, group_name|
-          g = group[group_name]
-          raise TypeError, "#{pk} group #{group_name} must not be nil" if g.nil?
-          raise TypeError, "#{pk} group #{group_name} must implement #to_i, #{g.inspect} given" unless g.respond_to?(:to_i)
-          (group_value << bits[group_name]) + (g.to_i % totals[group_name])
+      generate_singleton_methods do
+        define_method :"#{pk}_group_value_from" do |**group|
+          raise ArgumentError, "unknown #{pk} group keys: #{group.keys - group_totals.keys}" if (group.keys - group_totals.keys).any?
+          raise ArgumentError, "missing #{pk} group keys: #{group_totals.keys - group.keys}" if (group_totals.keys - group.keys).any?
+          group_totals.keys.reduce(0) do |group_value, group_name|
+            g = group[group_name]
+            raise TypeError, "#{pk} group #{group_name} must not be nil" if g.nil?
+            raise TypeError, "#{pk} group #{group_name} must implement #to_i, #{g.inspect} given" unless g.respond_to?(:to_i)
+            (group_value << bits[group_name]) + (g.to_i % totals[group_name])
+          end
         end
-      end
-
-      define_singleton_method :"unique_#{pk}_from" do |id, **group|
-        break nil if id.nil?
-        raise TypeError, "#{pk} must implement #to_i, #{id.inspect} given" unless id.respond_to?(:to_i)
-        (id.to_i << bits.values.inject(&:+)) + send(:"#{pk}_group_value_from", **group)
-      end
 
-      define_singleton_method :"#{pk}_from" do |unique_id|
-        break nil if unique_id.nil?
-        raise TypeError, "unique_#{pk} must implement #to_i, #{unique_id.inspect} given" unless unique_id.respond_to?(:to_i)
-        unique_id.to_i >> bits.values.inject(&:+)
-      end
-
-      define_singleton_method :"#{pk}_group_from" do |unique_id|
-        break nil if unique_id.nil?
-        raise TypeError, "unique_#{pk} must implement #to_i, #{unique_id.inspect} given" unless unique_id.respond_to?(:to_i)
-        Hash[group_totals.keys.reverse.map do |group_name|
-          g = unique_id & (totals[group_name] - 1)
-          unique_id >>= bits[group_name]
-          [group_name, g]
-        end.reverse]
-      end
+        define_method :"unique_#{pk}_from" do |id, **group|
+          break nil if id.nil?
+          raise TypeError, "#{pk} must implement #to_i, #{id.inspect} given" unless id.respond_to?(:to_i)
+          (id.to_i << bits.values.inject(&:+)) + send(:"#{pk}_group_value_from", **group)
+        end
 
-      define_method :"#{pk}_group" do
-        group_from_block = group_block ? instance_eval(&group_block) : {}
-        raise TypeError, "#{pk} group block must return a Hash with any of the following keys: #{group_totals.keys}, #{group_from_block.inspect} given" unless group_from_block.is_a?(Hash)
-        raise ArgumentError, "unknown #{pk} group passed to block: #{group_from_block.keys - group_totals.keys}" if (group_from_block.keys - group_totals.keys).any?
-        Hash[(group_totals.keys - group_from_block.keys).map { |group_name| [group_name, send(group_name)] }].merge(group_from_block)
-      end
+        define_method :"#{pk}_from" do |unique_id|
+          break nil if unique_id.nil?
+          raise TypeError, "unique_#{pk} must implement #to_i, #{unique_id.inspect} given" unless unique_id.respond_to?(:to_i)
+          unique_id.to_i >> bits.values.inject(&:+)
+        end
 
-      define_method :"unique_#{pk}" do
-        self.class.send(:"unique_#{pk}_from", send(pk), **send(:"#{pk}_group"))
+        define_method :"#{pk}_group_from" do |unique_id|
+          break nil if unique_id.nil?
+          raise TypeError, "unique_#{pk} must implement #to_i, #{unique_id.inspect} given" unless unique_id.respond_to?(:to_i)
+          Hash[group_totals.keys.reverse.map do |group_name|
+            g = unique_id & (totals[group_name] - 1)
+            unique_id >>= bits[group_name]
+            [group_name, g]
+          end.reverse]
+        end
       end
 
-      define_singleton_method :"find_by_unique_#{pk}" do |unique_id|
-        send(:"find_by_#{pk}", send(:"#{pk}_from", unique_id))
-      end
+      generate_methods do
+        define_method :"#{pk}_group" do
+          group_from_block = group_block ? instance_eval(&group_block) : {}
+          raise TypeError, "#{pk} group block must return a Hash with any of the following keys: #{group_totals.keys}, #{group_from_block.inspect} given" unless group_from_block.is_a?(Hash)
+          raise ArgumentError, "unknown #{pk} group passed to block: #{group_from_block.keys - group_totals.keys}" if (group_from_block.keys - group_totals.keys).any?
+          Hash[(group_totals.keys - group_from_block.keys).map { |group_name| [group_name, send(group_name)] }].merge(group_from_block)
+        end
 
-      define_singleton_method :"find_by_unique_#{pk}!" do |unique_id|
-        send(:"find_by_#{pk}!", send(:"#{pk}_from", unique_id))
+        define_method :"unique_#{pk}" do
+          self.class.send(:"unique_#{pk}_from", send(pk), **send(:"#{pk}_group"))
+        end
       end
     end
   end

data/spec/unique_by_spec.rb

@@ -11,12 +11,6 @@ module BaseBill
     def primary_key
       :bill_id
     end
-
-    def find_by_bill_id(bill_id)
-    end
-
-    def find_by_bill_id!(bill_id)
-    end
   end
 end
 
@@ -29,17 +23,6 @@ class ShardedTablesBase < Struct.new(:bill_id, :client_id, :x)
 end
 
 describe UniqueBy::Generator do
-  shared_context "finder methods" do
-    specify "find_by_bill_id" do
-      expect(klass).to receive(:find_by_bill_id).with(id)
-      klass.find_by_unique_bill_id(unique_id)
-    end
-    specify "find_by_bill_id!" do
-      expect(klass).to receive(:find_by_bill_id!).with(id)
-      klass.find_by_unique_bill_id!(unique_id)
-    end
-  end
-
   context "shards" do
     let(:klass) do
       Class.new(Struct.new(:bill_id, :client_id)) do
@@ -67,8 +50,6 @@ describe UniqueBy::Generator do
           specify { expect(klass.bill_id_from(nil)).to be_nil }
           specify { expect(klass.bill_id_group_from(nil)).to be_nil }
         end
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do
@@ -91,8 +72,6 @@ describe UniqueBy::Generator do
         specify { expect(klass.unique_bill_id_from(431, client_id: 7)).to eq(unique_id) }
         specify { expect(klass.bill_id_from(unique_id)).to eq(431) }
         specify { expect(klass.bill_id_group_from(unique_id)).to eq(client_id: 7 % 16) }
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do
@@ -128,8 +107,6 @@ describe UniqueBy::Generator do
         specify { expect(medical_klass.unique_bill_id_from(839, type: 10)).to eq(unique_id) }
         specify { expect(medical_klass.bill_id_from(unique_id)).to eq(839) }
         specify { expect(medical_klass.bill_id_group_from(unique_id)).to eq(type: 10 % 2) }
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do
@@ -148,8 +125,6 @@ describe UniqueBy::Generator do
         specify { expect(utility_klass.unique_bill_id_from(839, type: 11)).to eq(unique_id) }
         specify { expect(utility_klass.bill_id_from(unique_id)).to eq(839) }
         specify { expect(utility_klass.bill_id_group_from(unique_id)).to eq(type: 11 % 2) }
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do
@@ -201,8 +176,6 @@ describe UniqueBy::Generator do
         specify { expect(medical_klass.unique_bill_id_from(9428, client_id: 5, x: 53, type: 10, y: 20)).to eq(unique_id) }
         specify { expect(medical_klass.bill_id_from(unique_id)).to eq(9428) }
         specify { expect(medical_klass.bill_id_group_from(unique_id)).to eq(tempered_group) }
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do
@@ -224,8 +197,6 @@ describe UniqueBy::Generator do
         specify { expect(utility_klass.unique_bill_id_from(9428, client_id: 8, x: 853, type: 11, y: 40)).to eq(unique_id) }
         specify { expect(utility_klass.bill_id_from(unique_id)).to eq(9428) }
         specify { expect(utility_klass.bill_id_group_from(unique_id)).to eq(tempered_group) }
-
-        include_context "finder methods"
       end
 
       describe "instance methods" do

data/unique_by.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "generate_method", "~> 1.0"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "rspec-its", "~> 1.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: unique_by
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Oded Niv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: generate_method
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement