opinions 0.0.1

data/test/integration_test_opinions_opinionated_mixin.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+module Opinions
+
+  class IntegrationTestOpinionsOpinionated < MiniTest::Integration::TestCase
+
+    def test_voting_on_any_confirming_object
+      
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      example_object.example(example_target)
+
+      assert Opinion.new(target: example_target, object: example_object, opinion: :example).exists?
+
+    end
+
+    def test_cancelling_a_vote_on_any_conforming_object
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+      
+      expected_opinion = Opinion.new(target: example_target, object: example_object, opinion: :example)
+      expected_opinion.persist
+
+      example_object.cancel_example(example_target)
+
+      refute Opinion.new(target: example_target, object: example_object, opinion: :example).exists?
+
+    end
+
+    def test_retrieving_votes_from_the_backend
+
+      example_target_one = ExampleTarget.new
+      example_target_one.id = 456
+
+      example_target_two = ExampleTarget.new
+      example_target_two.id = 789
+
+      ExampleObject.send(:include, Opinionated)
+      ExampleObject.send(:opinions, :example)
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      expected_opinion_one = Opinion.new(target: example_target_one, object: example_object, opinion: :example)
+      expected_opinion_one.persist
+
+      expected_opinion_two = Opinion.new(target: example_target_two, object: example_object, opinion: :example)
+      expected_opinion_two.persist
+
+      assert_equal 2, example_object.example_opinions.count
+
+    end
+
+  end
+
+end

data/test/integration_test_opinions_pollable_mixin.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+module Opinions
+
+  class IntegrationTestOpinionsPollable < MiniTest::Integration::TestCase
+
+    def test_being_voted_by_any_conforming_object
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example)
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      example_target.example_by(example_object)
+
+      assert Opinion.new(target: example_target, object: example_object, opinion: :example).exists?
+
+    end
+
+    def test_cancelling_a_vote_by_any_conforming_object
+
+      example_object = ExampleObject.new
+      example_object.id = 123
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example)
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      expected_opinion = Opinion.new(target: example_target, object: example_object, opinion: :example)
+      expected_opinion.persist
+
+      example_target.cancel_example_by(example_object)
+
+      refute Opinion.new(target: example_target, object: example_object, opinion: :example).exists?
+
+    end
+
+    def test_counting_the_number_of_votes
+
+      example_object_one = ExampleObject.new
+      example_object_one.id = 123
+
+      example_object_two = ExampleObject.new
+      example_object_two.id = 456
+
+      ExampleTarget.send(:include, Pollable)
+      ExampleTarget.send(:opinions, :example)
+
+      example_target = ExampleTarget.new
+      example_target.id = 456
+
+      expected_opinion_one = Opinion.new(target: example_target, object: example_object_one, opinion: :example)
+      expected_opinion_one.persist
+
+      expected_opinion_two = Opinion.new(target: example_target, object: example_object_two, opinion: :example)
+      expected_opinion_two.persist
+
+      assert_equal 2, example_target.example_votes.count
+
+    end
+
+
+  end
+
+end

data/test/opinions_integration_test_redis.conf

@@ -0,0 +1,6 @@
+daemonize yes
+bind 127.0.0.1
+port 9738
+pidfile /tmp/opinions_integration_test_redis.pid
+logfile /tmp/opinions_integration_test_redis.log
+dir /tmp

data/test/test_helper.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'bundler'
+
+require 'singleton'
+require 'tempfile'
+
+Bundler.setup
+
+require 'daemon_controller'
+
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'turn'
+
+require_relative '../lib/opinions'
+
+Turn.config do |tc|
+  tc.ansi   = true
+  tc.format = :dot
+end
+
+IntegrationTestRedis = DaemonController.new(
+  identifier:    "Opinions Ingration Test Redis Server",
+  start_command: "redis-server #{File.expand_path('./opinions_integration_test_redis.conf', 'test')}",
+  ping_command:  [:tcp, '127.0.0.1', 9738],
+  pid_file:      "/tmp/opinions_integration_test_redis.pid",
+  log_file:      "/tmp/opinions_integration_test_redis.log",
+  start_timeout: 2
+)
+
+module Opinions
+
+  module MiniTest
+
+    class Unit
+      TestCase = Class.new(::MiniTest::Unit::TestCase)
+    end
+
+    class Acceptance
+      TestCase = Class.new(Unit::TestCase)
+    end
+
+    class Integration
+      TestCase = Class.new(Acceptance::TestCase)
+    end
+
+  end
+
+end
+
+Opinions::MiniTest::Unit::TestCase.class_eval do
+
+  def setup_with_clean_objects
+    setup_without_clean_objects
+    instance_methods = Module.new do
+      def ==(other)
+        id == other.id
+      end
+      def initialize(id = nil)
+        @id = id
+      end
+    end
+    class_methods = Module.new do
+      def find(id)
+        new(id)
+      end
+    end
+    ::Object.const_set(:ExampleObject, Class.new)
+    ::Object.const_set(:ExampleTarget, Class.new)
+    ::ExampleObject.class_eval { attr_accessor :id }
+    ::ExampleTarget.class_eval { attr_accessor :id }
+    ::ExampleObject.send(:include, instance_methods)
+    ::ExampleTarget.send(:include, instance_methods)
+    ::ExampleObject.send(:extend, class_methods)
+    ::ExampleTarget.send(:extend, class_methods)
+  end
+  alias :setup_without_clean_objects :setup
+  alias :setup :setup_with_clean_objects
+
+  def teardown_with_clean_objects
+    teardown_without_clean_objects
+    Object.send(:remove_const, :ExampleObject)
+    Object.send(:remove_const, :ExampleTarget)
+  end
+  alias :teardown_without_clean_objects :teardown
+  alias :teardown :teardown_with_clean_objects
+
+end
+
+Opinions::MiniTest::Integration::TestCase.class_eval do
+
+  def setup_with_live_redis
+    setup_without_live_redis
+    ::IntegrationTestRedis.start
+    rb = Opinions::RedisBackend.new
+    rb.redis = ::Redis.new(port: 9738)
+    rb.redis.flushdb
+    Opinions.backend = rb
+  end
+  alias :setup_without_live_redis :setup
+  alias :setup :setup_with_live_redis
+
+  def teardown_with_live_redis
+    teardown_without_live_redis
+    ::IntegrationTestRedis.stop
+  end
+  alias :teardown_without_live_redis :teardown
+  alias :teardown :teardown_with_live_redis
+
+end

data/test/unit_test_opinions_key_builder.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module Opinions
+
+  class UnitTestKeyBuilder < MiniTest::Unit::TestCase
+
+    def test_an_argument_error_is_raised_when_instantiated_with_an_empty_hash
+      assert_raises KeyError do
+         KeyBuilder.new({})
+      end
+    end
+
+    def test_generating_a_simple_key
+      example_object = ::ExampleObject.new
+      example_object.id = 123
+      assert_equal 'ExampleObject:test:123', KeyBuilder.new(object: example_object, opinion: :test).key
+    end
+
+    def test_generating_a_key_with_a_non_numerical_id
+      example_instance = ::ExampleObject.new
+      example_instance.id = "digest"
+      assert_equal 'ExampleObject:test:digest', KeyBuilder.new(object: example_instance, opinion: :test).key
+    end
+
+    def test_generating_a_key_for_an_object_class_count
+      # Note: This slightly abuses the KeyBuilder (target vs. object)
+      example_target = ::ExampleTarget.new
+      example_target.id = 456
+      assert_equal 'ExampleTarget:like:456', KeyBuilder.new(object: example_target, opinion: :like).key
+    end
+
+    def test_generating_a_key_for_an_object_class
+      example_object = ::ExampleObject.new
+      example_object.id = 123
+      assert_equal 'ExampleObject:like:123:ExampleTarget', KeyBuilder.new(object: example_object, opinion: :like, target: ::ExampleTarget).key
+    end
+
+    def test_generating_a_key_for_a_simple_opinion
+      example_object = ::ExampleObject.new
+      example_object.id = 123
+      example_target = ::ExampleTarget.new
+      example_target.id = 456
+      assert_equal 'ExampleObject:like:123:ExampleTarget', KeyBuilder.new(object: example_object, opinion: :like, target: example_target).key
+    end
+
+    def test_generating_a_key_for_a_less_simple_opinion
+      example_object = ::ExampleObject.new
+      example_object.id = 123
+      example_target = ::ExampleTarget.new
+      example_target.id = 456
+      assert_equal 'ExampleObject:absolute_hate:123:ExampleTarget', KeyBuilder.new(object: example_object, opinion: :absolute_hate, target: example_target).key
+    end
+
+  end
+
+end

data/test/unit_test_opinions_opinion.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+module Opinions
+
+  class UnitTestOpinion < MiniTest::Unit::TestCase
+
+    def test_an_argument_error_is_raised_when_instantiated_without_a_target
+      assert_raises KeyError do
+        Opinion.new(object: true, opinion: true)
+      end
+    end
+
+    def test_an_argument_error_is_raised_when_instantiated_without_an_object
+      assert_raises KeyError do
+        Opinion.new(target: true, opinion: true)
+      end
+    end
+
+    def test_an_argument_error_is_raised_when_instantiated_without_an_opinion
+      assert_raises KeyError do
+        Opinion.new(object: true, target: true)
+      end
+    end
+
+    def test_opinions_with_the_same_properties_compare_equal
+      o, t = Class.new, Class.new
+      opinion_one = Opinion.new(opinion: :test, target: t, object: o)
+      opinion_two = Opinion.new(opinion: :test, target: t, object: o)
+      assert_equal opinion_one, opinion_two
+    end
+
+    def test_opinions_with_different_properties_do_not_compare_equal
+      opinion_one = Opinion.new(opinion: :test, target: Class.new, object: Class.new)
+      opinion_two = Opinion.new(opinion: :test, target: Class.new, object: Class.new)
+      refute_equal opinion_one, opinion_two
+    end
+
+    def test_the_creation_time_is_readable_via_an_accessor_default_nil
+      assert_nil Opinion.new(object: true, target: :example, opinion: true).created_at
+    end
+
+    def test_the_target_is_readable_via_an_accessor
+      assert_equal :example, Opinion.new(object: true, target: :example, opinion: true).target
+    end
+
+    def test_the_object_is_readable_via_an_accessor
+      assert_equal :example, Opinion.new(object: :example, target: true, opinion: true).object
+    end
+
+    def test_the_opinion_is_readable_via_an_accessor
+      assert_equal :example, Opinion.new(object: true, target: true, opinion: :example).opinion
+    end
+
+    def test_the_target_key_is_made_available_via_an_accessor
+      example_object = ::ExampleObject.new
+      example_target = ::ExampleTarget.new
+      example_target.id = 456
+      opinion = Opinion.new(object: example_object, target: example_target, opinion: :example)
+      assert_equal 'ExampleTarget:example:456:ExampleObject', opinion.target_key
+    end
+
+    def test_the_object_key_is_made_available_via_an_accessor
+      example_object = ::ExampleObject.new
+      example_object.id = 123
+      example_target = ::ExampleTarget.new
+      opinion = Opinion.new(object: example_object, target: example_target, opinion: :example)
+      assert_equal 'ExampleObject:example:123:ExampleTarget', opinion.object_key
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: opinions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lee Hambley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70143554472800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143554472800
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70143554471840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: *70143554471840
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &70143554470080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70143554470080
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70143554468980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70143554468980
+- !ruby/object:Gem::Dependency
+  name: daemon_controller
+  requirement: &70143554468440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70143554468440
+description: A toolkit for storing user votes/opinions in Redis
+email:
+- lee.hambley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/opinions.rb
+- lib/opinions/version.rb
+- opinions.gemspec
+- test/acceptance_test_key_loader.rb
+- test/acceptance_test_opinions_opinion.rb
+- test/acceptance_test_opinions_opinionated_mixin.rb
+- test/acceptance_test_opinions_pollable_mixin.rb
+- test/integration_test_opinions_opinion.rb
+- test/integration_test_opinions_opinionated_mixin.rb
+- test/integration_test_opinions_pollable_mixin.rb
+- test/opinions_integration_test_redis.conf
+- test/test_helper.rb
+- test/unit_test_opinions_key_builder.rb
+- test/unit_test_opinions_opinion.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: 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.
+test_files:
+- test/acceptance_test_key_loader.rb
+- test/acceptance_test_opinions_opinion.rb
+- test/acceptance_test_opinions_opinionated_mixin.rb
+- test/acceptance_test_opinions_pollable_mixin.rb
+- test/integration_test_opinions_opinion.rb
+- test/integration_test_opinions_opinionated_mixin.rb
+- test/integration_test_opinions_pollable_mixin.rb
+- test/opinions_integration_test_redis.conf
+- test/test_helper.rb
+- test/unit_test_opinions_key_builder.rb
+- test/unit_test_opinions_opinion.rb
+has_rdoc: