ohm-composite 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGQwNWM5MWVhM2ZlZTA1MzQ2ZjFhZjQ3YzdhOWJjZDliNjc0MzZmNg==
+  data.tar.gz: !binary |-
+    NTI0YzA2ZjBmZDRiYjU2NGNjYzAxYTA5NGViNDI4MWM3MGNhYjNlNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDdjNGI1NTdjYjk1NWQ4NGRlOThmZDI3OTQxZThlY2ExMGNkZjlmZTI1NmJk
+    ZDg4ZjI0MWFjNDZhNjk0NTgwZGYyM2RkOGRjODNiMmM1OTNlM2FkMDZiOGM5
+    ZDFiMzU1OGY3ZWU3ZDFmNDkxNzZiNmNkMDEwNDRlNTFmZjg2ZGI=
+  data.tar.gz: !binary |-
+    NDc1NGQ1YTlkZjg4ZGZhNTZiOTcxYTYzMzAyZTM0Nzc5ZTJlNmY2ZjU0MDYw
+    NjcyMjE0N2IxNWE3NjExY2Y2MjZhODRhZjY3MWI3NTc4YmE3N2E1ZDRhNmY1
+    ODAzYzExNjE4ODQwZDY4NjAzZWY4Yzg4M2FkNGZmN2YwOTI1MjM=

data/README.md

@@ -0,0 +1,49 @@
+Ohm::Composite
+==============
+
+Provides composite regular and unique indices for [Ohm][1].
+
+Usage
+-----
+
+```ruby
+require "ohm/composite"
+
+class Post
+  include Ohm::Composite
+
+  attribute :user_id
+  attribute :date
+  attribute :slug
+
+  composite_index [:user_id, :date]
+  composite_unique [:user_id, :slug]
+end
+
+Post.composite_find(user_id: 1, date: Date.today)
+Post.composite_with(user_id: 1, slug: "lorem-ipsum")
+```
+
+"Find or create"
+----------------
+
+Often times you need to find an instance by its uniqueness, or create
+it if it's not found.
+
+For this purpose there's `composite_with_or_create`:
+
+```ruby
+Post.composite_with_or_create(user_id: 1, slug: "lorem-ipsum")
+```
+
+This is guaranteed to be contention-safe: if two competing threads or
+processes end up in the create branch, only one will win and the other
+will receive the created instance. None of them will raise exceptions
+nor receive nils.
+
+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/composite.rb

@@ -0,0 +1,66 @@
+require "ohm"
+
+module Ohm::Composite
+  VERSION = "0.1.0"
+
+  def self.included(model)
+    model.extend(Macros)
+  end
+
+  def self.method_name(attrs)
+    :"_composite_#{join(attrs, "_")}"
+  end
+
+  def self.values(values)
+    join(values, ":")
+  end
+
+  def self.join(elements, char)
+    replacement = char * 2
+
+    elements.map { |e| e.to_s.gsub(char, replacement) }.join(char)
+  end
+
+  module Macros
+    def composite_unique(attrs)
+      unique(_composite(attrs))
+    end
+
+    def composite_index(attrs)
+      index(_composite(attrs))
+    end
+
+    def composite_with(hash)
+      keys = hash.keys.sort
+      values = keys.map { |k| hash[k] }
+
+      with(Ohm::Composite.method_name(keys), Ohm::Composite.values(values))
+    end
+
+    def composite_find(hash)
+      keys = hash.keys.sort
+      values = keys.map { |k| hash[k] }
+
+      find(Ohm::Composite.method_name(keys) => Ohm::Composite.values(values))
+    end
+
+    def composite_with_or_create(hash)
+      composite_with(hash) ||
+        begin
+          create(hash)
+        rescue Ohm::UniqueIndexViolation
+          composite_with(hash)
+        end
+    end
+
+    def _composite(attrs)
+      attrs = attrs.sort
+
+      method_name = Ohm::Composite.method_name(attrs)
+
+      define_method(method_name) { Ohm::Composite.values(attrs.map { |att| send(att) }) }
+
+      method_name
+    end
+  end
+end

data/ohm-composite.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path("lib/ohm/composite", File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name              = "ohm-composite"
+  s.version           = Ohm::Composite::VERSION
+  s.summary           = "Composite (regular and unique) indices for Ohm."
+  s.authors           = ["Educabilia", "Damian Janowski"]
+  s.email             = ["opensource@educabilia.com", "djanowski@dimaion.com"]
+  s.homepage          = "https://github.com/educabilia/ohm-composite"
+
+  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/collisions_test.rb

@@ -0,0 +1,29 @@
+require_relative "prelude"
+
+class Post < Ohm::Model
+  include Ohm::Composite
+
+  attribute :foo
+  attribute :bar
+  attribute :baz
+
+  attribute :bar_baz
+  attribute :baz_foo
+
+  composite_unique [:foo, :bar_baz]
+  composite_unique [:bar, :baz_foo]
+end
+
+scope do
+  test "does not confuse names" do
+    post1 = Post.create(foo: "foo", bar_baz: "bar_baz")
+
+    assert_equal post1, Post.composite_with(foo: "foo", bar_baz: "bar_baz")
+    assert_equal nil, Post.composite_with(bar: "bar_baz", baz_foo: "foo")
+
+    post2 = Post.create(bar: "bar_baz", baz_foo: "foo")
+
+    assert_equal post1, Post.composite_with(foo: "foo", bar_baz: "bar_baz")
+    assert_equal post2, Post.composite_with(bar: "bar_baz", baz_foo: "foo")
+  end
+end

data/test/composite_test.rb

@@ -0,0 +1,99 @@
+require_relative "prelude"
+
+class Post < Ohm::Model
+  include Ohm::Composite
+
+  attribute :date
+  attribute :slug
+
+  composite_index [:date, :slug]
+end
+
+class Rating < Ohm::Model
+  include Ohm::Composite
+
+  attribute :user_id
+  attribute :post_id
+
+  composite_unique [:user_id, :post_id]
+end
+
+scope do
+  def assert_empty(value)
+    flunk("#{value} is not empty.") unless value.empty?
+    success
+  end
+
+  test "find" do
+    post = Post.create(date: "2013-03-23", slug: "lorem-ipsum")
+
+    assert_equal [post], Post.composite_find(date: "2013-03-23", slug: "lorem-ipsum").to_a
+    assert_empty Post.composite_find(date: "2013-03-23", slug: "dolor-sit").to_a
+  end
+
+  test "find with different hash order" do
+    post = Post.create(date: "2013-03-23", slug: "lorem-ipsum")
+
+    assert_equal [post], Post.composite_find(slug: "lorem-ipsum", date: "2013-03-23").to_a
+  end
+
+  test "fails with unknown indices" do
+    assert_raise { Post.composite_find(slug: "foo") }
+  end
+
+  test "does not confuse values when joining" do
+    post1 = Post.create(date: "2013-03-23:lorem", slug: "ipsum")
+    post2 = Post.create(date: "2013-03-23", slug: "lorem:ipsum")
+
+    assert_equal [post1], Post.composite_find(date: "2013-03-23:lorem", slug: "ipsum").to_a
+    assert_equal [post2], Post.composite_find(date: "2013-03-23", slug: "lorem:ipsum").to_a
+  end
+end
+
+scope do
+  test "unique" do
+    Rating.create(user_id: 1, post_id: 2)
+
+    assert_raise(Ohm::UniqueIndexViolation) do
+      Rating.create(user_id: 1, post_id: 2)
+    end
+
+    assert_raise(Ohm::UniqueIndexViolation) do
+      Rating.create(post_id: 2, user_id: 1)
+    end
+  end
+
+  test "find unique" do
+    rating = Rating.create(user_id: 1, post_id: 2)
+
+    assert_equal rating, Rating.composite_with(user_id: 1, post_id: 2)
+    assert_equal rating, Rating.composite_with(post_id: 2, user_id: 1)
+  end
+end
+
+scope do
+  test "with or create" do
+    rating = Rating.composite_with_or_create(user_id: 1, post_id: 2)
+
+    assert rating
+
+    assert_equal rating, Rating.composite_with_or_create(user_id: 1, post_id: 2)
+  end
+
+  test "contention" do
+    results = []
+
+    threads = Array.new(10) do
+      Thread.new do
+        10.times do |i|
+          results << Rating.composite_with_or_create(user_id: i, post_id: 2)
+        end
+      end
+    end
+
+    threads.each(&:join)
+
+    assert !results.include?(nil)
+    assert_equal 10, results.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/composite"
+
+setup do
+  Ohm.flush
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ohm-composite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Educabilia
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 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:
+- README.md
+- UNLICENSE
+- lib/ohm/composite.rb
+- ohm-composite.gemspec
+- rakefile
+- test/collisions_test.rb
+- test/composite_test.rb
+- test/prelude.rb
+homepage: https://github.com/educabilia/ohm-composite
+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: Composite (regular and unique) indices for Ohm.
+test_files: []