ballot 1.0

data/lib/sequel/plugins/ballot_voter.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Sequel #:nodoc:
+  module Plugins #:nodoc:
+    # The BallotVoter plugin marks the model as containing objects that can
+    # vote. It creates a polymorphic one-to-many relationship from the
+    # BallotVoter model to Ballot::Sequel::Vote.
+    module BallotVoter
+      def self.apply(model) #:nodoc:
+        require 'ballot/sequel/vote'
+        require 'ballot/words'
+        require 'ballot/voter'
+
+        model.instance_eval do
+          # Create a polymorphic one-to-many relationship for voters. Based
+          # heavily on the one_to_many implementation from sequel_polymorphic,
+          # but customized to sequel-voting's needs.
+          one_to_many :ballots_by,
+            key: :voter_id,
+            reciprocal: :voter,
+            reciprocal_type: :one_to_many,
+            conditions: { voter_type: Ballot::Sequel.type_name(model) },
+            adder: ->(many_of_instance) {
+              many_of_instance.update(
+                voter_id: pk,
+                voter_type: Ballot::Sequel.type_name(model)
+              )
+            },
+            remover: ->(many_of_instance) { many_of_instance.delete },
+            clearer: -> { ballots_by_dataset.delete },
+            class: '::Ballot::Sequel::Vote'
+
+          include Ballot::Voter
+          extend Ballot::Voter::ClassMethods
+        end
+      end
+
+      module InstanceMethods #:nodoc:
+        def cast_ballot_for(votable = nil, kwargs = {}) #:nodoc:
+          kwargs = __ballot_voter_kwargs(votable, kwargs)
+          votable = Ballot::Sequel.votable_for(kwargs)
+          return false unless votable
+          votable.ballot_by(kwargs.merge(voter: self))
+        end
+        alias ballot_for cast_ballot_for
+
+        def remove_ballot_for(votable = nil, kwargs = {}) #:nodoc:
+          kwargs = __ballot_voter_kwargs(votable, kwargs)
+          votable = Ballot::Sequel.votable_for(kwargs)
+          return false unless votable
+          votable.remove_ballot_by voter: self, scope: kwargs[:scope]
+        end
+
+        def cast_ballot_for?(votable = nil, kwargs = {}) #:nodoc:
+          kwargs = __ballot_voter_kwargs(votable, kwargs)
+          votable_id, votable_type = Ballot::Sequel.votable_id_and_type_name_for(kwargs)
+          return false unless votable_id
+
+          cond = {
+            votable_id: votable_id,
+            votable_type: votable_type,
+            scope: kwargs[:scope]
+          }
+          cond[:vote] = Ballot::Words.truthy?(kwargs[:vote]) if kwargs.key?(:vote)
+
+          find_ballots_by(cond).any?
+        end
+        alias ballot_for? cast_ballot_for?
+
+        def ballot_as_cast_for(votable = nil, kwargs = {}) #:nodoc:
+          kwargs = __ballot_voter_kwargs(votable, kwargs)
+          votable = Ballot::Sequel.votable_for(kwargs)
+          return nil unless votable
+
+          cond = {
+            votable_id: votable.id,
+            votable_type: Ballot::Sequel.type_name(votable),
+            scope: kwargs[:scope]
+          }
+          cond[:vote] = Ballot::Words.truthy?(kwargs[:vote]) if kwargs.key?(:vote)
+
+          vote = find_ballots_by(cond).
+            order(Sequel.desc(:updated_at), Sequel.desc(:created_at)).
+            limit(1).first
+          vote && vote.vote
+        end
+
+        def ballots_for_class(klass, kwargs = {}) #:nodoc:
+          cond = {
+            votable_type: Ballot::Sequel.type_name(klass),
+            scope: kwargs[:scope]
+          }
+          cond[:vote] = Ballot::Words.truthy?(kwargs[:vote]) if kwargs.key?(:vote)
+
+          find_ballots_by(cond)
+        end
+
+        private
+
+        def find_ballots_by(*cond, &block)
+          ballots_by_dataset.where(*cond, &block)
+        end
+
+        def __eager_ballot_votables(ds)
+          ballots = ds.naked.select(:votable_type, :votable_id).all
+          partitioned = ballots.group_by { |e| e[:votable_type] }
+          partitioned.each_value do |value|
+            value.map! { |e| e[:votable_id] }
+          end
+          partitioned.each_key do |key|
+            votables = self.class.send(:constantize, key).
+              where(id: partitioned[key]).
+              map { |v| [ v.id, v ] }
+
+            partitioned[key] = Hash[votables]
+          end
+
+          ballots.map { |ballot|
+            partitioned[ballot[:votable_type]][ballot[:votable_id]]
+          }
+        end
+      end
+    end
+  end
+end

data/test/active_record/ballot_votable_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe Ballot::ActiveRecord::Votable do
+  describe_votable_models [
+    ARVotable, ARVotableVoter, ARStiVotable, ARChildOfStiVotable,
+    ARVotableChildOfStiNotVotable, ARVotableCache
+  ]
+  describe_non_votable_models [
+    ARVoter, ARNotVoter, ARNotVotable, ARStiNotVotable
+  ]
+  describe_ballot_votable
+  describe_ballot_votable_sti_support
+  describe_cached_ballot_summary ARVotableCache
+end

data/test/active_record/ballot_voter_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe Ballot::ActiveRecord::Voter do
+  describe_non_voter_models [
+    ARChildOfStiVotable, ARNotVotable, ARNotVoter, ARStiNotVotable,
+    ARStiVotable, ARVotable, ARVotableCache, ARVotableChildOfStiNotVotable
+  ]
+  describe_voter_models [ ARVoter, ARVotableVoter ]
+  describe_ballot_voter
+  describe_ballot_voter_sti_votable_support
+end

data/test/active_record/rails_generator_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe 'RailsGenerator' do
+  describe 'for Active Record' do
+    let(:orm_name) { 'activerecord' }
+    let(:orm_version) { ActiveRecord::VERSION::STRING }
+    let(:rails_version) { orm_version }
+
+    test_ballot_install(
+      generate: %r{create\s+db/migrate/\d+_install_ballot_vote_migration},
+      migrate: %r{
+        InstallBallotVoteMigration.*
+        --\screate_table\(:ballot_votes(?:,\s{})?\).*
+        --\sadd_index\(:ballot_votes,\s\[:voter_id .*
+        --\sadd_index\(:ballot_votes,\s\[:votable_id
+      }mx,
+      contents: /InstallBallotVoteMigration < ActiveRecord::Migration/
+    )
+
+    test_ballot_summary_votable(
+      generate: %r{create\s+db/migrate/\d+_ballot_cache_for_votable},
+      migrate: /BallotCacheForVotable.*--\schange_table\(:votables(?:,\s{})?\)/mx,
+      contents: /BallotCacheForVotable < ActiveRecord::Migration/
+    )
+  end
+end

data/test/active_record/votable_voter_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe ARVotableVoter do
+  describe_ballot_voter do
+    let(:voter) { ARVotableVoter.create(name: 'I can vote!') }
+    let(:voter2) { ARVotableVoter.create(name: 'I, too, can vote!') }
+    let(:votable) { voter2 }
+    let(:votable2) { voter }
+  end
+
+  describe_ballot_votable do
+    let(:voter) { ARVotableVoter.create(name: 'I can vote!') }
+    let(:voter2) { ARVotableVoter.create(name: 'I, too, can vote!') }
+    let(:votable) { voter2 }
+    let(:votable2) { voter }
+  end
+end

data/test/generators/rails-activerecord/Rakefile

@@ -0,0 +1,2 @@
+require File.expand_path('../config/application', __FILE__)
+Rails.application.load_tasks

data/test/generators/rails-activerecord/bin/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/generators/rails-activerecord/config/application.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require File.expand_path('../boot', __FILE__)
+
+require 'rails'
+require 'active_model/railtie'
+require 'active_record/railtie'
+
+Bundler.require(*Rails.groups)
+
+module RailsActiverecord
+  class Application < Rails::Application
+    if Rails::VERSION::MAJOR < 5
+      config.active_record.raise_in_transactional_callbacks = true
+    end
+    config.eager_load = false
+  end
+end

data/test/generators/rails-activerecord/config/boot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup'

data/test/generators/rails-activerecord/config/database.yml

@@ -0,0 +1,12 @@
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+test:
+  <<: *default
+  database: db/test.sqlite3

data/test/generators/rails-activerecord/config/environment.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require File.expand_path('../application', __FILE__)
+Rails.application.initialize!

data/test/generators/rails-activerecord/config/routes.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+Rails.application.routes.draw do
+end

data/test/generators/rails-activerecord/config/secrets.yml

@@ -0,0 +1,5 @@
+development:
+  secret_key_base: 7dfa450af068027682b897d9cd0143c2bcc0b83001cd3b45088bfd1eb6fa999fe19aca0e535f7676977f5c168624877dcc21c41522af77ffee65ec5f59023937
+
+test:
+  secret_key_base: 9f4ff20b6abd84c56c2a59805baaf0ae6db6802013cdefa07e5c73dc89ee8b126e84b34ff443da47e2c26af526dcd53692fef60d2c6ae62cfa9332282f1d7c8a

data/test/generators/rails-activerecord/db/seeds.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/test/generators/rails-sequel/Rakefile

@@ -0,0 +1,2 @@
+require File.expand_path('../config/application', __FILE__)
+Rails.application.load_tasks

data/test/generators/rails-sequel/bin/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/generators/rails-sequel/config/application.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require File.expand_path('../boot', __FILE__)
+
+require 'rails'
+require 'active_model/railtie'
+
+Bundler.require(*Rails.groups)
+
+module RailsSequel
+  class Application < Rails::Application
+    config.eager_load = false
+    config.sequel.schema_dump = true
+  end
+end

data/test/generators/rails-sequel/config/boot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup'

data/test/generators/rails-sequel/config/database.yml

@@ -0,0 +1,12 @@
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+test:
+  <<: *default
+  database: db/test.sqlite3

data/test/generators/rails-sequel/config/environment.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require File.expand_path('../application', __FILE__)
+Rails.application.initialize!

data/test/generators/rails-sequel/config/routes.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+Rails.application.routes.draw do
+end

data/test/generators/rails-sequel/config/secrets.yml

@@ -0,0 +1,5 @@
+development:
+  secret_key_base: 7dfa450af068027682b897d9cd0143c2bcc0b83001cd3b45088bfd1eb6fa999fe19aca0e535f7676977f5c168624877dcc21c41522af77ffee65ec5f59023937
+
+test:
+  secret_key_base: 9f4ff20b6abd84c56c2a59805baaf0ae6db6802013cdefa07e5c73dc89ee8b126e84b34ff443da47e2c26af526dcd53692fef60d2c6ae62cfa9332282f1d7c8a

data/test/generators/rails-sequel/db/seeds.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/test/minitest_config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# -*- ruby encoding: utf-8 -*-
+
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/focus'
+require 'minitest/moar'
+require 'minitest/bisect'
+require 'minitest-bonus-assertions'
+require 'minitest/hooks/default'
+
+require 'pathname'
+
+Dir["#{__dir__}/support/**/*.rb"].sort.each do |f| require_relative f end

data/test/sequel/ballot_votable_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe Sequel::Plugins::BallotVotable do
+  describe_votable_models [
+    SequelVotable, SequelVotableVoter, SequelStiVotable,
+    SequelChildOfStiVotable, SequelVotableChildOfStiNotVotable,
+    SequelVotableCache
+  ]
+  describe_non_votable_models [
+    SequelVoter, SequelNotVoter, SequelNotVotable, SequelStiNotVotable
+  ]
+  describe_ballot_votable
+  describe_ballot_votable_sti_support
+  describe_cached_ballot_summary SequelVotableCache
+
+  describe 'association methods' do
+    it '#add_ballots_for adds a new instance' do
+      vote = Ballot::Sequel::Vote.new(voter: voter)
+      refute_predicate vote, :valid?
+      votable.add_ballots_for(vote)
+      assert_predicate vote, :valid?
+    end
+
+    it '#remove_ballots_for destroys the instance' do
+      votable.ballot_by voter
+      assert_true Ballot::Sequel::Vote.any?
+      votable.remove_ballots_for(votable_dataset(votable).first)
+      assert_true Ballot::Sequel::Vote.none?
+    end
+
+    it '#remove_all_ballots_for destroys all instances' do
+      votable.ballot_by voter
+      votable2.ballot_by voter
+      assert_true Ballot::Sequel::Vote.any?
+      votable.remove_all_ballots_for
+      assert_false Ballot::Sequel::Vote.none?
+      assert_true Ballot::Sequel::Vote.where(
+        votable_id: votable.id,
+        votable_type: ballot_type_name(votable)
+      ).none?
+    end
+  end
+end

data/test/sequel/ballot_voter_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'minitest_config'
+
+describe Sequel::Plugins::BallotVoter do
+  describe_non_voter_models [
+    SequelChildOfStiVotable, SequelNotVotable, SequelNotVoter,
+    SequelStiNotVotable, SequelStiVotable, SequelVotable, SequelVotableCache,
+    SequelVotableChildOfStiNotVotable
+  ]
+  describe_voter_models [ SequelVoter, SequelVotableVoter ]
+  describe_ballot_voter
+  describe_ballot_voter_sti_votable_support
+
+  describe 'association methods' do
+    it '#add_ballots_by adds a new instance' do
+      vote = Ballot::Sequel::Vote.new(votable: votable)
+      refute_predicate vote, :valid?
+      voter.add_ballots_by(vote)
+      assert_predicate vote, :valid?
+    end
+
+    it '#remove_ballots_by destroys the instance' do
+      voter.ballot_for votable
+      assert_true Ballot::Sequel::Vote.any?
+      voter.remove_ballots_by(voter_dataset(voter).first)
+      assert_true Ballot::Sequel::Vote.none?
+    end
+
+    it '#remove_all_ballots_by destroys all instances' do
+      voter.ballot_for votable
+      voter2.ballot_for votable
+      assert_true Ballot::Sequel::Vote.any?
+      voter.remove_all_ballots_by
+      assert_false Ballot::Sequel::Vote.none?
+      assert_true Ballot::Sequel::Vote.where(
+        voter_id: voter.id,
+        voter_type: ballot_type_name(voter)
+      ).none?
+    end
+  end
+end