unique_by 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4360207db16c47e063005d3f50983411710de6f8
+  data.tar.gz: f2aa0cb2ff36558ca288fe4f8397645edd55a28a
+SHA512:
+  metadata.gz: 2e91b8a6f86e7b1fb936807adf396e63ccecba95f3b8ab9ae892e17f6671ecfaba7928b960a6e581a9a8455f4a3a0e48635033fa5d2dfcbad783fdf94d001daf
+  data.tar.gz: ad167e6e1778ed2d855144b1c548a330e2b293664d5234746119dc5026a84497448c9f937a475d8e42616c6fcf3d774563482bd8c124de433f4f9bb78f1f4829

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unique_by.gemspec
+gemspec

data/README.md

@@ -0,0 +1,116 @@
+# unique_by [![Gem Version](https://badge.fury.io/rb/unique_by.svg)](http://badge.fury.io/rb/unique_by)
+
+This simple gem allows specifying uniqueness groups for an attribute, giving
+you something to expose to the outside world.
+
+When do you need this?
+
+- If you're sharding your database.
+- If you have multiple tables that you want to expose a unique ID for.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'unique_by'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unique_by
+
+## Usage
+
+### Sharding example
+
+You first need to specify a unique group in your model:
+
+    # == Schema Info
+    #
+    # Table name: medical_bills
+    #
+    #  id                  :integer(11)    not null, primary key
+    #  client_id           :integer(11)
+    #
+
+    class MedicalBill < ActiveRecord::Base
+      unique_by :client_id, total: 50
+    end
+
+then, you can use these basic methods:
+
+    bill1 = MedicalBill.find(123) # from a DB shard for client_id = 1
+    bill2 = MedicalBill.find(123) # from a DB shard for client_id = 2
+
+    bill1.unique_id
+    => "62p"
+    bill2.unique_id
+    => "62q"
+    MedicalBill.find_by_unique_id("62p") # from DB shard for client_id = 1
+    => #<MedicalBill id: 123, client_id: 1>
+    MedicalBill.find_by_unique_id("62q") # from DB shard for client_id = 2
+    => #<MedicalBill id: 123, client_id: 2>
+
+You can use the internal methods:
+
+    MedicalBill.unique_id_from(1, 123) # gives the unique_id from client_id, id
+    => "62p"
+    MedicalBill.id_from("62p") # gives the id
+    => 123
+    MedicalBill.id_group_from("62q") # gives the client_id
+    => 2
+
+And use bits instead of total:
+
+    class MedicalBill < ActiveRecord::Base
+      unique_by :client_id, bits: 6 # equivalent to total: 64
+    end
+
+You can specify multiple unique group attributes:
+
+    class MedicalBill < ActiveRecord::Base
+      unique_by :client_id, :client_part, total: [50, 5]
+    end
+
+### Multiple tables example
+
+You can supply a block to give your own mechanism for determining the
+group:
+
+    class MedicalBill < ActiveRecord::Base
+      unique_by(total: 2) { 1 }
+    end
+    class UtilityBill < ActiveRecord::Base
+      unique_by(total: 2) { 2 }
+    end
+
+You can supply both group attributes and a block, and the block can also
+return an array:
+
+    class MedicalBill < ActiveRecord::Base
+      unique(:client_id, :client_part, total: [50, 5, 10, 20]) { [self.x * self.y, self.z / 2] }
+    end
+
+## Not ActiveRecord
+
+The generator module is already included in `ActiveRecord::Base`, but if
+you want the above methods in another class you can extend it:
+
+    class MyClass
+      extend UniqueBy::Generator
+
+      def self.primary_key
+        :id # or 'id'
+      end
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/odedniv/unique_by/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

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/unique_by.rb

@@ -0,0 +1,73 @@
+require "unique_by/version"
+
+module UniqueBy
+  module Generator
+    # For a primary_key 'id', generates:
+    #   ::unique_id_from(group, id) => unique_id
+    #   ::id_from(unique_id) => id
+    #   ::id_group_from(unique_id) => group
+    #   #id_group => group
+    #   #unique_id => unique_id
+    #   ::find_by_unique_id(unique_id) => find_by_id(id_from(unique_id))
+    #   ::find_by_unique_id!(unique_id) => find_by_id!(id_from(unique_id))
+    def unique_by(*group_block_names, total: nil, bits: nil, &group_block)
+      bits, total = Array(bits), Array(total)
+
+      raise ArgumentError, "must pass either bits or total to #unique_by" \
+        unless bits.any? or total.any?
+      raise ArgumentError, "both bits (#{bits.inspect}) and total (#{total.inspect}) passed to #unique_by" \
+        if bits.any? and total.any?
+      raise ArgumentError, "must pass a group generator block" \
+        unless group_block_names.any? or block_given?
+      raise ArgumentError, "amount of group names (#{group_block_names.length}) doesn't match amount of bits/total (#{bits.length + total.length})" \
+        if group_block_names.any? and not block_given? and group_block_names.length != bits.length + total.length
+
+      bits = total.map { |t| Math.log2(t).ceil } if bits.empty?
+      total = bits.map { |b| 2 ** b }
+
+      pk = primary_key # converting to a local variable
+
+      define_singleton_method :"unique_#{pk}_from" do |group_value, value|
+        (value.to_i << bits.sum) + group_value.to_i
+      end
+
+      define_singleton_method :"#{pk}_from" do |value|
+        value.to_i >> bits
+      end
+
+      define_singleton_method :"#{pk}_group_from" do |value|
+        value.to_i & ((2 ** bits.sum) - 1)
+      end
+
+      define_method :"#{pk}_group" do
+        group_values = group_block_names.map { |group_block_name| send(group_block_name) }
+        group_values.push(*Array(instance_eval(group_block))) if group_block
+        raise "amount of groups (#{group_values.length}) doesn't match amount of bits/total (#{bits.length})" if group_values.length != bits.length
+        group_values.each_with_index.reduce(0) do |group, (group_value, i)|
+          raise "group must implement #to_i, #{group_value} given" \
+            unless group_value.respond_to?(&:to_i)
+          (group << bits[i]) + (group_value.to_i % total[i])
+        end
+      end
+
+      define_method :"unique_#{pk}" do
+        primary_key = send(pk)
+        raise "#{pk} must implement #to_i, #{primary_key.inspect} given" \
+          unless primary_key.respond_to?(:to_i)
+        self.class.send(:"unique_#{pk}_from", send(:"#{pk}_group"), primary_key.to_i)
+      end
+
+      define_singleton_method :"find_by_unique_#{pk}" do |value|
+        send(:"find_by_#{pk}". send(:"#{pk}_from", value))
+      end
+
+      define_singleton_method :"find_by_unique_#{pk}!" do |value|
+        send(:"find_by_#{pk}!". send(:"#{pk}_from", value))
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend(UniqueBy::Generator)
+end

data/lib/unique_by/version.rb

@@ -0,0 +1,3 @@
+module UniqueBy
+  VERSION = "0.0.1"
+end

data/unique_by.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unique_by/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_by"
+  spec.version       = UniqueBy::VERSION
+  spec.authors       = ["Oded Niv"]
+  spec.email         = ["oded.niv@gmail.com"]
+  spec.summary       = %q{Specify uniqueness group for an attribute.}
+  spec.description   = %q{Allows uniqueness of a record when sharding (specifying the shard ID as the group) or span accross tables (receipts).}
+  spec.homepage      = ""
+  spec.license       = "UNLICENSE"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: unique_by
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oded Niv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Allows uniqueness of a record when sharding (specifying the shard ID
+  as the group) or span accross tables (receipts).
+email:
+- oded.niv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- lib/unique_by.rb
+- lib/unique_by/version.rb
+- unique_by.gemspec
+homepage: ''
+licenses:
+- UNLICENSE
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Specify uniqueness group for an attribute.
+test_files: []