opinions 0.0.1

data/lib/opinions/version.rb

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

data/opinions.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/opinions/version', __FILE__)
+
+Gem::Specification.new do |gem|
+
+  gem.authors       = ["Lee Hambley"]
+  gem.email         = ["lee.hambley@gmail.com"]
+  gem.description   = %q{A toolkit for storing user votes/opinions in Redis}
+  gem.summary       = %q{Opinions allows the storage of opinions in Redis, a fast and atomic structured data store. If one's users hate, love, appreciate, despise or just-don-t-care, one can store that easily via a simple API.}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "opinions"
+  gem.require_paths = ["lib"]
+  gem.version       = Opinions::VERSION
+
+  gem.add_dependency('redis')
+
+  gem.add_development_dependency('minitest', ['>= 2.11.3', '< 2.12.0'])
+  gem.add_development_dependency('autotest')
+  gem.add_development_dependency('turn')
+
+  gem.add_development_dependency('daemon_controller')
+
+end

data/test/acceptance_test_key_loader.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module Opinions
+
+  class AcceptanceTestOpinionsKeyLoader < MiniTest::Acceptance::TestCase
+
+    def test_it_should_call_find_for_both_keys
+
+      example_object = ExampleObject.new(123)
+      example_target = ExampleTarget.new(456)
+
+      kl = KeyLoader.new("ExampleTarget:opinion:123")
+
+      assert_equal example_object, kl.object
+
+    end
+
+  end
+
+end

data/test/acceptance_test_opinions_opinion.rb

@@ -0,0 +1,110 @@
+require 'test_helper'
+
+module Opinions
+
+  class AcceptanceTestOpinionsOpinion < MiniTest::Acceptance::TestCase
+
+    def test_checking_if_an_opinion_exists_checks_both_sides_of_the_relationship
+
+      example_target = ::ExampleTarget.new
+      example_object = ::ExampleObject.new
+
+      example_object.id = 123
+      example_target.id = 456
+
+      opinion = Opinion.new({ target:  example_target,
+                              object:  example_object,
+                              opinion: :example })
+
+      Opinions.backend = ::MiniTest::Mock.new
+
+      Opinions.backend.expect(:read_sub_key, false, [opinion.target_key, example_object.id.to_s])
+      Opinions.backend.expect(:read_sub_key, false, [opinion.object_key, example_target.id.to_s])
+
+      refute opinion.exists?
+
+      Opinions.backend.verify
+
+    end
+
+    def test_creating_an_opinion_creates_both_sides_of_the_relationship
+
+      t = Time.now.utc
+
+      example_target = ::ExampleTarget.new
+      example_object = ::ExampleObject.new
+
+      example_target.id = 123
+      example_object.id = 456
+
+      opinion = Opinion.new({ target:  example_target,
+                              object:  example_object,
+                              opinion: :example })
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:write_keys, true, [{ opinion.target_key => {example_object.id.to_s => t},
+                                                    opinion.object_key => {example_target.id.to_s => t}}])
+
+      opinion.persist(time: t)
+
+      Opinions.backend.verify
+
+    end
+
+    def test_removing_an_opinion_removes_both_sides_of_the_relationship
+
+      t = Time.now.utc
+
+      example_target = ::ExampleTarget.new
+      example_object = ::ExampleObject.new
+
+      example_target.id = 123
+      example_object.id = 456
+
+      opinion = Opinion.new({ target:  example_target,
+                              object:  example_object,
+                              opinion: :example })
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:remove_sub_keys, true, [[ [opinion.target_key, example_object.id.to_s],
+                                                         [opinion.object_key, example_target.id.to_s] ]])
+
+      opinion.remove
+
+      Opinions.backend.verify
+
+    end
+
+    def test_removing_one_opinion_without_removing_other_opinions
+
+      t = Time.now.utc
+
+      example_target     = ::ExampleTarget.new
+      example_object_one = ::ExampleObject.new
+      example_object_two = ::ExampleObject.new
+
+      example_target.id     = 123
+      example_object_one.id = 456
+      example_object_two.id = 789
+
+      opinion_one = Opinion.new({ target:  example_target,
+                                  object:  example_object_one,
+                                  opinion: :example })
+
+      opinion_two = Opinion.new({ target:  example_target,
+                                  object:  example_object_two,
+                                  opinion: :example })
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:remove_sub_keys, true, [[ [opinion_one.target_key, example_object_one.id.to_s],
+                                                         [opinion_one.object_key, example_target.id.to_s] ]])
+
+      opinion_one.remove
+
+      Opinions.backend.verify
+
+    end
+
+  end
+
+end

data/test/acceptance_test_opinions_opinionated_mixin.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+module Opinions
+
+  class AcceptanceTestOpinionsOpinionated < MiniTest::Acceptance::TestCase
+
+    def test_mixing_in_opinionated_makes_the_opinions_method_available
+
+      refute ExampleObject.respond_to?(:opinions)
+      ExampleObject.send(:include, Opinionated)
+      assert ExampleObject.respond_to?(:opinions)
+
+    end
+
+    def test_using_the_pollable_opinions_method_registers_them_as_supported_opinions
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_one, :example_two, :example_three)
+
+      assert_equal [:example_one, :example_two, :example_three], ExampleObject.registered_opinions
+
+    end
+
+    def test_the_registered_opinions_have_their_instance_methods_created
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_opinion)
+
+      assert ExampleObject.new.respond_to?(:example_opinion)
+      assert ExampleObject.new.respond_to?(:cancel_example_opinion)
+      assert ExampleObject.new.respond_to?(:example_opinion_opinions)
+      assert ExampleObject.new.respond_to?(:have_example_opinion_on)
+
+    end
+
+    def test_creating_an_opinion_persits_it_to_the_backend
+
+      t = Time.now.utc
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_opinion)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:write_keys, true, [{ 'ExampleObject:example_opinion:123:ExampleTarget' => {'456' => t},
+                                                    'ExampleTarget:example_opinion:456:ExampleObject' => {'123' => t} }])
+
+      assert_equal true, example_object.example_opinion(example_target, t)
+
+      Opinions.backend.verify
+
+    end
+
+    def test_calcelling_an_opinion_removes_both_sides_of_the_relationship_from_the_backend
+
+      t = Time.now.utc
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_opinion)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:remove_sub_keys, true, [[["ExampleTarget:example_opinion:456:ExampleObject", "123"],
+                                                        ["ExampleObject:example_opinion:123:ExampleTarget", "456"]]])
+
+      assert_equal true, example_object.cancel_example_opinion(example_target)
+
+      Opinions.backend.verify
+
+    end
+
+    def test_opinions_retrieved_from_the_backend_en_masse
+
+      t = Time.now.utc
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_opinion)
+
+      example_target = ExampleTarget.new
+      example_target.id = '456'
+
+      example_object = ExampleObject.new
+      example_object.id = '123'
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:keys_matching, ["ExampleObject:example_opinion:123:ExampleTarget"], ["ExampleObject:example_opinion:123*"])
+      Opinions.backend.expect(:read_key, {"456" => t}, ["ExampleObject:example_opinion:123:ExampleTarget"])
+
+      expected_opinion = Opinion.new(target: example_target,
+                                     object: example_object,
+                                     opinion: :example_opinion,
+                                     created_at: t)
+
+      assert_equal expected_opinion, example_object.example_opinion_opinions.first
+
+      Opinions.backend.verify
+
+    end
+
+    def test_opinions_checking_if_an_object_has_a_vote_for_a_target
+
+      t = Time.now.utc
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example_opinion)
+
+      example_target = ExampleTarget.new
+      example_target.id = '456'
+
+      example_object = ExampleObject.new
+      example_object.id = '123'
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:keys_matching, ["ExampleObject:example_opinion:123:ExampleTarget"], ["ExampleObject:example_opinion:123*"])
+      Opinions.backend.expect(:read_key, {"456" => t}, ["ExampleObject:example_opinion:123:ExampleTarget"])
+
+      expected_opinion = Opinion.new(target: example_target,
+                                     object: example_object,
+                                     opinion: :example_opinion,
+                                     created_at: t)
+
+      assert example_object.have_example_opinion_on(example_target)
+
+      Opinions.backend.verify
+
+    end
+
+  end
+
+end

data/test/acceptance_test_opinions_pollable_mixin.rb

@@ -0,0 +1,111 @@
+require 'test_helper'
+
+module Opinions
+
+  class AcceptanceTestOpinionsPollable < MiniTest::Acceptance::TestCase
+
+    def test_mixing_in_pollable_makes_the_opinions_method_available
+
+      refute ExampleTarget.respond_to?(:opinions)
+      ExampleTarget.send(:include, Pollable)
+      assert ExampleTarget.respond_to?(:opinions)
+
+    end
+
+    def test_using_the_pollable_opinions_method_registers_them_as_supported_opinions
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example_one, :example_two, :example_three)
+
+      assert_equal [:example_one, :example_two, :example_three], ExampleTarget.registered_opinions
+
+    end
+
+    def test_the_registered_opinions_have_their_instance_methods_created
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example_opinion)
+
+      assert ExampleTarget.new.respond_to?(:example_opinion_by)
+      assert ExampleTarget.new.respond_to?(:cancel_example_opinion_by)
+      assert ExampleTarget.new.respond_to?(:example_opinion_votes)
+
+    end
+
+    def test_creating_an_opinion_persits_it_to_the_backend
+
+      t = Time.now.utc
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example_opinion)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:write_keys, true, [{ 'ExampleObject:example_opinion:123:ExampleTarget' => {'456' => t},
+                                                    'ExampleTarget:example_opinion:456:ExampleObject' => {'123' => t} }])
+
+      assert_equal true, example_target.example_opinion_by(example_object, t)
+
+      Opinions.backend.verify
+
+    end
+
+    def test_calcelling_an_opinion_removes_both_sides_of_the_relationship_from_the_backend
+
+      t = Time.now.utc
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example_opinion)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:remove_sub_keys, true, [[["ExampleTarget:example_opinion:456:ExampleObject", "123"],
+                                                        ["ExampleObject:example_opinion:123:ExampleTarget", "456"]]])
+
+      assert_equal true, example_target.cancel_example_opinion_by(example_object)
+
+      Opinions.backend.verify
+
+    end
+
+    def test_opinions_retrieved_from_the_backend_en_masse
+
+      t = Time.now.utc
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example_opinion)
+
+      example_target = ExampleTarget.new
+      example_target.id = '456'
+
+      example_object = ExampleObject.new
+      example_object.id = '123'
+
+      Opinions.backend = ::MiniTest::Mock.new
+      Opinions.backend.expect(:keys_matching, ["ExampleTarget:example_opinion:456:ExampleObject"], ["ExampleTarget:example_opinion:456*"])
+      Opinions.backend.expect(:read_key, {"123" => t}, ["ExampleTarget:example_opinion:456:ExampleObject"])
+
+      expected_opinion = Opinion.new(target: example_target,
+                                     object: example_object,
+                                     opinion: :example_opinion,
+                                     created_at: t)
+
+      assert_equal expected_opinion, example_target.example_opinion_votes.first
+
+      Opinions.backend.verify
+
+    end
+
+  end
+
+end

data/test/integration_test_opinions_opinion.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+module Opinions
+
+  class IntegrationTestOpinionsOpinion < MiniTest::Integration::TestCase
+
+    def test_opinions_do_not_exist_until_persisted
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      opinion = Opinion.new(object: example_object, target: example_target, opinion: :example)
+
+      refute opinion.exists?
+
+    end
+
+    def test_opinions_exist_once_persisted
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      opinion_one = Opinion.new(object: example_object, target: example_target, opinion: :example)
+
+      refute opinion_one.exists?
+      assert opinion_one.persist
+      assert opinion_one.exists?
+
+    end
+
+    def test_opinions_that_are_the_same_can_be_treated_as_equal
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      opinion_one = Opinion.new(object: example_object, target: example_target, opinion: :example)
+      opinion_two = Opinion.new(object: example_object, target: example_target, opinion: :example)
+
+      refute opinion_one.exists?
+      refute opinion_two.exists?
+
+      [opinion_one, opinion_two].sample.persist
+
+      assert opinion_one.exists?
+      assert opinion_two.exists?
+
+    end
+
+  end
+
+end