voting 0.1.0

data/spec/models/vote/vote_for_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Vote, ':vote_for' do
+  let!(:author)  { create :author }
+  let!(:comment) { create :comment }
+
+  context 'with no scopeable' do
+    context 'when vote does not exist' do
+      specify { expect(described_class.vote_for(author: author, resource: comment)).to eq nil }
+    end
+
+    context 'when vote does not exist' do
+      before { create :voting_vote, author: author, resource: comment, positive: 1 }
+
+      it 'returns the record' do
+        expect(described_class.vote_for(author: author, resource: comment)).to eq described_class.last
+      end
+    end
+  end
+
+  context 'with scopeable' do
+    let!(:category) { create :category }
+
+    context 'when vote does not exist' do
+      specify { expect(described_class.vote_for(author: author, resource: comment, scopeable: category)).to eq nil }
+    end
+
+    context 'when vote does not exist' do
+      before { create :voting_vote, author: author, resource: comment, scopeable: category, positive: 1 }
+
+      it 'returns the record' do
+        query = described_class.vote_for(author: author, resource: comment, scopeable: category)
+
+        expect(query).to eq described_class.last
+      end
+    end
+  end
+end

data/spec/models/vote_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Vote do
+  let!(:object) { build :voting_vote }
+
+  it { expect(object).to be_valid }
+
+  it { is_expected.to belong_to :author }
+  it { is_expected.to belong_to :resource }
+  it { is_expected.to belong_to :scopeable }
+
+  it { is_expected.to validate_presence_of :author }
+  it { is_expected.to validate_presence_of :negative }
+  it { is_expected.to validate_presence_of :positive }
+  it { is_expected.to validate_presence_of :resource }
+
+  it { is_expected.to validate_inclusion_of(:negative).in_array [0, 1] }
+  it { is_expected.to validate_inclusion_of(:positive).in_array [0, 1] }
+
+  it do
+    expect(object).to validate_uniqueness_of(:author_id)
+      .scoped_to(%i[author_type resource_id resource_type scopeable_id scopeable_type])
+      .case_insensitive
+  end
+end

data/spec/models/voting/update_voting_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'support/shared_context/with_database_records'
+
+RSpec.describe Voting::Voting, ':update_voting' do
+  include_context 'with_database_records'
+
+  context 'with no scopeable' do
+    it 'updates the voting data of the given resource' do
+      record = described_class.find_by(resource: comment_1)
+
+      expect(record.estimate).to eq 0.2923292797006548
+      expect(record.negative).to eq 1
+      expect(record.positive).to eq 2
+    end
+  end
+
+  context 'with scopeable' do
+    it 'updates the voting data of the given resource respecting the scope' do
+      record = described_class.find_by(resource: comment_1, scopeable: category)
+
+      expect(record.estimate).to eq 0.1711859764448097
+      expect(record.negative).to eq 1
+      expect(record.positive).to eq 1
+    end
+  end
+end

data/spec/models/voting/values_data_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'support/shared_context/with_database_records'
+
+RSpec.describe Voting::Voting, ':values_data' do
+  include_context 'with_database_records'
+
+  context 'with no scopeable' do
+    subject(:voting) { described_class.values_data comment_1, nil }
+
+    it { expect(voting.as_json['voting_positive']).to eq 2 }
+
+    it { expect(voting.as_json['voting_negative']).to eq 1 }
+  end
+
+  context 'with scopeable' do
+    subject(:voting) { described_class.values_data comment_1, category }
+
+    it { expect(voting.as_json['voting_positive']).to eq 1 }
+
+    it { expect(voting.as_json['voting_negative']).to eq 1 }
+  end
+end

data/spec/models/voting_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Voting::Voting do
+  let!(:object) { build :voting_voting }
+
+  it { expect(object).to be_valid }
+
+  it { is_expected.to belong_to :resource }
+  it { is_expected.to belong_to :scopeable }
+
+  it { is_expected.to validate_presence_of :estimate }
+  it { is_expected.to validate_presence_of :negative }
+  it { is_expected.to validate_presence_of :positive }
+  it { is_expected.to validate_presence_of :resource }
+
+  it { is_expected.to validate_numericality_of(:negative).is_greater_than_or_equal_to(0).only_integer }
+  it { is_expected.to validate_numericality_of(:positive).is_greater_than_or_equal_to(0).only_integer }
+
+  it do
+    expect(object).to validate_uniqueness_of(:resource_id)
+      .scoped_to(%i[resource_type scopeable_id scopeable_type])
+      .case_insensitive
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'active_record/railtie'
+require 'pry-byebug'
+require 'voting'
+
+ActiveRecord::Base.establish_connection adapter: :sqlite3, database: ':memory:'
+
+Dir[File.expand_path('support/**/*.rb', __dir__)].each { |file| require file }

data/spec/support/common.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.filter_run_when_matching :focus
+
+  config.disable_monkey_patching!
+  config.infer_spec_type_from_file_location!
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order                                      = :random
+  config.profile_examples                           = true
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before { DatabaseCleaner.start }
+
+  config.around do |spec|
+    DatabaseCleaner.cleaning do
+      spec.run
+    end
+  end
+end

data/spec/support/db/migrate/create_articles_table.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CreateArticlesTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :articles
+  end
+end

data/spec/support/db/migrate/create_authors_table.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CreateAuthorsTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :authors
+  end
+end

data/spec/support/db/migrate/create_categories_table.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class CreateCategoriesTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :categories do |t|
+      t.references :article, foreign_key: true, index: true
+    end
+  end
+end

data/spec/support/db/migrate/create_comments_table.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CreateCommentsTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :comments
+  end
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+Dir[File.expand_path('../factories/**/*.rb', __dir__)].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/spec/support/migrate.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../lib/generators/voting/templates/db/migrate/create_voting_tables.rb', __dir__)
+
+Dir[File.expand_path('db/migrate/*.rb', __dir__)].each { |file| require file }
+
+CreateArticlesTable.new.change
+CreateAuthorsTable.new.change
+CreateCategoriesTable.new.change
+CreateCommentsTable.new.change
+CreateVotingTables.new.change

data/spec/support/models/article.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Article < ::ActiveRecord::Base
+  voting scoping: :categories
+
+  has_many :categories
+end

data/spec/support/models/author.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Author < ::ActiveRecord::Base
+  voting as: :author
+end

data/spec/support/models/category.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Category < ::ActiveRecord::Base
+  belongs_to :article
+end

data/spec/support/models/comment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Comment < ::ActiveRecord::Base
+  voting
+end

data/spec/support/shared_context/with_database_records.rb

@@ -0,0 +1,22 @@
+RSpec.shared_context 'with_database_records' do
+  let!(:category) { create :category }
+
+  let!(:author_1) { create :author }
+  let!(:author_2) { create :author }
+  let!(:author_3) { create :author }
+
+  let!(:comment_1) { create :comment }
+  let!(:comment_2) { create :comment }
+  let!(:comment_3) { create :comment }
+
+  let!(:vote_1) { create :voting_vote, author: author_1, positive: 1, resource: comment_1 }
+  let!(:vote_2) { create :voting_vote, author: author_2, negative: 1, resource: comment_1 }
+  let!(:vote_3) { create :voting_vote, author: author_3, positive: 1, resource: comment_1 }
+
+  let!(:vote_4) { create :voting_vote, author: author_1, negative: 1, resource: comment_2 }
+  let!(:vote_5) { create :voting_vote, author: author_2, positive: 1, resource: comment_2 }
+  let!(:vote_6) { create :voting_vote, author: author_3, negative: 1, resource: comment_2 }
+
+  let!(:vote_7) { create :voting_vote, author: author_1, resource: comment_1, positive: 1, scopeable: category }
+  let!(:vote_8) { create :voting_vote, author: author_2, resource: comment_1, negative: 1, scopeable: category }
+end

data/spec/support/shoulda.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'shoulda-matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.library :rails
+    with.test_framework :rspec
+  end
+end

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: voting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Washington Botelho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: factory_bot_rails
+  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: pry-byebug
+  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: rspec-rails
+  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: rubocop-rspec
+  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: shoulda-matchers
+  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: sqlite3
+  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: A Binomial proportion confidence interval voting system with scope and
+  cache enabled.
+email: wbotelhos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/generators/voting/install_generator.rb
+- lib/generators/voting/templates/db/migrate/create_voting_tables.rb
+- lib/voting.rb
+- lib/voting/models/voting/extension.rb
+- lib/voting/models/voting/vote.rb
+- lib/voting/models/voting/voting.rb
+- lib/voting/version.rb
+- spec/factories/article.rb
+- spec/factories/author.rb
+- spec/factories/category.rb
+- spec/factories/comment.rb
+- spec/factories/voting/vote.rb
+- spec/factories/voting/voting.rb
+- spec/models/extension/after_save_spec.rb
+- spec/models/extension/as_spec.rb
+- spec/models/extension/down_spec.rb
+- spec/models/extension/order_by_voting_spec.rb
+- spec/models/extension/up_spec.rb
+- spec/models/extension/vote_for_spec.rb
+- spec/models/extension/vote_spec.rb
+- spec/models/extension/voted_question_spec.rb
+- spec/models/extension/voted_records_spec.rb
+- spec/models/extension/voted_spec.rb
+- spec/models/extension/votes_records_spec.rb
+- spec/models/extension/votes_spec.rb
+- spec/models/extension/voting_records_spec.rb
+- spec/models/extension/voting_spec.rb
+- spec/models/extension/voting_warm_up_spec.rb
+- spec/models/vote/create_spec.rb
+- spec/models/vote/vote_for_spec.rb
+- spec/models/vote_spec.rb
+- spec/models/voting/update_voting_spec.rb
+- spec/models/voting/values_data_spec.rb
+- spec/models/voting_spec.rb
+- spec/rails_helper.rb
+- spec/support/common.rb
+- spec/support/database_cleaner.rb
+- spec/support/db/migrate/create_articles_table.rb
+- spec/support/db/migrate/create_authors_table.rb
+- spec/support/db/migrate/create_categories_table.rb
+- spec/support/db/migrate/create_comments_table.rb
+- spec/support/factory_bot.rb
+- spec/support/migrate.rb
+- spec/support/models/article.rb
+- spec/support/models/author.rb
+- spec/support/models/category.rb
+- spec/support/models/comment.rb
+- spec/support/shared_context/with_database_records.rb
+- spec/support/shoulda.rb
+homepage: https://github.com/wbotelhos/voting
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A Binomial proportion confidence interval voting system with scope and cache
+  enabled.
+test_files:
+- spec/models/vote/vote_for_spec.rb
+- spec/models/vote/create_spec.rb
+- spec/models/voting_spec.rb
+- spec/models/vote_spec.rb
+- spec/models/extension/voted_records_spec.rb
+- spec/models/extension/voting_spec.rb
+- spec/models/extension/vote_spec.rb
+- spec/models/extension/down_spec.rb
+- spec/models/extension/vote_for_spec.rb
+- spec/models/extension/voting_warm_up_spec.rb
+- spec/models/extension/voted_question_spec.rb
+- spec/models/extension/order_by_voting_spec.rb
+- spec/models/extension/voting_records_spec.rb
+- spec/models/extension/as_spec.rb
+- spec/models/extension/voted_spec.rb
+- spec/models/extension/votes_spec.rb
+- spec/models/extension/after_save_spec.rb
+- spec/models/extension/votes_records_spec.rb
+- spec/models/extension/up_spec.rb
+- spec/models/voting/update_voting_spec.rb
+- spec/models/voting/values_data_spec.rb
+- spec/support/migrate.rb
+- spec/support/shoulda.rb
+- spec/support/factory_bot.rb
+- spec/support/models/article.rb
+- spec/support/models/category.rb
+- spec/support/models/author.rb
+- spec/support/models/comment.rb
+- spec/support/common.rb
+- spec/support/db/migrate/create_categories_table.rb
+- spec/support/db/migrate/create_authors_table.rb
+- spec/support/db/migrate/create_articles_table.rb
+- spec/support/db/migrate/create_comments_table.rb
+- spec/support/database_cleaner.rb
+- spec/support/shared_context/with_database_records.rb
+- spec/factories/article.rb
+- spec/factories/category.rb
+- spec/factories/voting/vote.rb
+- spec/factories/voting/voting.rb
+- spec/factories/author.rb
+- spec/factories/comment.rb
+- spec/rails_helper.rb