thumbs_up 0.6.3 → 0.6.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eb255a6f08815057ab4a1896ed3e9d854c1c9c1
+  data.tar.gz: 8dc62bc7e179b16b6e2e307493f2a84b35445738
+SHA512:
+  metadata.gz: 708c9cf6c4b659a8d56d5cd56dafd785d6e05bfd0c9d85e177abe94b832f9e85cf7278482ae6149e52234f3ff085be80a27845975800a395e480e81839dbf7cb
+  data.tar.gz: 31d121f34fa8dd291fec0f33a7411842bb548f773f28d01434c5b07efd869a60b0d325acb848f743f0d0361eafd10df574ea3ea529e263c92152ebca7a7e3a6d

data/README.md

@@ -142,14 +142,32 @@ You can also use `--unique-voting false` when running the generator command:
 
 Testing is a bit more than trivial now as our #tally and #plusminus_tally queries don't function properly under SQLite. To set up for testing:
 
-```
-$ mysql -uroot # You may have set a password locally. Change as needed.
-  > GRANT ALL PRIVILEGES ON 'thumbs_up_test' to 'test'@'localhost' IDENTIFIED BY 'test';
-  > CREATE DATABASE 'thumbs_up_test';
-  > exit;
-
-$ rake # Runs the test suite.
-```
+* mysql
+
+    ```
+    $ mysql -uroot # You may have set a password locally. Change as needed.
+      > CREATE USER 'test'@'localhost' IDENTIFIED BY 'test';
+      > CREATE DATABASE thumbs_up_test;
+      > USE thumbs_up_test;
+      > GRANT ALL PRIVILEGES ON thumbs_up_test TO 'test'@'localhost' IDENTIFIED BY 'test';
+      > exit;
+    ```
+* Postgres
+
+    ```
+    $ psql # You may have set a password locally. Change as needed.
+      > CREATE ROLE test;
+      > ALTER ROLE test WITH SUPERUSER;
+      > ALTER ROLE test WITH LOGIN;
+      > CREATE DATABASE thumbs_up_test;
+      > GRANT ALL PRIVILEGES ON DATABASE thumbs_up_test to test;
+      > \q
+    ```
+* Run tests
+
+    ```
+    $ rake # Runs the test suite against all adapters.
+    ```
 
 Credits
 =======

data/Rakefile

@@ -40,4 +40,4 @@ task :test_all_databases do
   Rake::Task['test'].execute
 end
 
-task :default => :test_all_databases
+task :default => :test_all_databases

data/lib/acts_as_voteable.rb

@@ -8,7 +8,10 @@ module ThumbsUp
 
     module ClassMethods
       def acts_as_voteable
-        has_many :votes, :as => :voteable, :dependent => :destroy
+        has_many ThumbsUp.configuration[:voteable_relationship_name],
+                 :as => :voteable,
+                 :dependent => :destroy,
+                 :class_name => 'Vote'
 
         include ThumbsUp::ActsAsVoteable::InstanceMethods
         extend  ThumbsUp::ActsAsVoteable::SingletonMethods
@@ -61,20 +64,25 @@ module ThumbsUp
 
     module InstanceMethods
 
+      # wraps the dynamic, configured, relationship name
+      def _votes_by
+        self.send(ThumbsUp.configuration[:voteable_relationship_name])
+      end
+
       def votes_for
-        self.votes.where(:vote => true).count
+        self._votes_by.where(:vote => true).count
       end
 
       def votes_against
-        self.votes.where(:vote => false).count
+        self._votes_by.where(:vote => false).count
       end
 
       def percent_for
-        (votes_for.to_f * 100 / (self.votes.size + 0.0001)).round
+        (votes_for.to_f * 100 / (self._votes_by.size + 0.0001)).round
       end
 
       def percent_against
-        (votes_against.to_f * 100 / (self.votes.size + 0.0001)).round
+        (votes_against.to_f * 100 / (self._votes_by.size + 0.0001)).round
       end
 
       # You'll probably want to use this method to display how 'good' a particular voteable
@@ -113,7 +121,7 @@ module ThumbsUp
       def voters_who_voted_against
           votes.where(:vote => false).map(&:voter).uniq
       end
-      
+
       def voted_by?(voter)
         0 < Vote.where(
               :voteable_id => self.id,

data/lib/acts_as_voter.rb

@@ -12,8 +12,11 @@ module ThumbsUp #:nodoc:
         # If you want to nullify (and keep the votes), you'll need to remove
         # the unique constraint on the [ voter, voteable ] index in the database.
         # has_many :votes, :as => :voter, :dependent => :nullify
-        # Destroy votes when a user is deleted.
-        has_many :votes, :as => :voter, :dependent => :destroy
+        # Destroy voter's votes when the voter is deleted.
+        has_many ThumbsUp.configuration[:voter_relationship_name],
+                 :as => :voter,
+                 :dependent => :destroy,
+                 :class_name => 'Vote'
 
         include ThumbsUp::ActsAsVoter::InstanceMethods
         extend  ThumbsUp::ActsAsVoter::SingletonMethods
@@ -27,6 +30,11 @@ module ThumbsUp #:nodoc:
     # This module contains instance methods
     module InstanceMethods
 
+      # wraps the dynamic, configured, relationship name
+      def _votes_on
+        self.send(ThumbsUp.configuration[:voteable_relationship_name])
+      end
+
       # Usage user.vote_count(:up)  # All +1 votes
       #       user.vote_count(:down) # All -1 votes
       #       user.vote_count()      # All votes

data/lib/thumbs_up/base.rb

@@ -0,0 +1,11 @@
+module ThumbsUp
+  module Base
+    def quoted_true
+      ActiveRecord::Base.connection.quoted_true
+    end
+
+    def quoted_false
+      ActiveRecord::Base.connection.quoted_false
+    end
+  end
+end

data/lib/thumbs_up/configuration.rb

@@ -0,0 +1,51 @@
+module ThumbsUp
+  class Configuration
+
+    OPTIONS = [:voteable_relationship_name, :voter_relationship_name].freeze
+
+    # Specify the name of the relationship from voted on things to voters.
+    # Default is votes
+    # In order to have a model that votes on itself,
+    #   e.g. Users vote on Users,
+    #   must change :voteable_relationship_name or :voter_relationship_name
+    #   to a non-default value
+    attr_accessor :voteable_relationship_name
+
+    # Specify the name of the relationship from voters to voted on things
+    # Default is votes
+    # In order to have a model that votes on itself,
+    #   e.g. Users vote on Users,
+    #   must change :voteable_relationship_name or :voter_relationship_name
+    #   to a non-default value
+    attr_accessor :voter_relationship_name
+
+    def initialize
+      # these defaults can be overridden in the ThumbsUp.config block
+      @voteable_relationship_name    = :votes
+      @voter_relationship_name       = :votes
+    end
+
+    # Allows config options to be read like a hash
+    #
+    # @param [Symbol] option Key for a given attribute
+    def [](option)
+      send(option)
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash[option.to_sym] = self.send(option)
+        hash
+      end
+    end
+
+    # Returns a hash of all configurable options merged with +hash+
+    #
+    # @param [Hash] hash A set of configuration options that will take precedence over the defaults
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+
+  end
+end

data/lib/thumbs_up/version.rb

@@ -1,3 +1,3 @@
 module ThumbsUp
-	VERSION = '0.6.3'
+	VERSION = '0.6.4'
 end

data/lib/thumbs_up.rb

@@ -1,17 +1,36 @@
 require 'acts_as_voteable'
 require 'acts_as_voter'
 require 'has_karma'
+require 'thumbs_up/configuration'
+require 'thumbs_up/base'
+require 'thumbs_up/version'
 
 module ThumbsUp
-  module Base
-    def quoted_true
-      ActiveRecord::Base.connection.quoted_true
+
+  class << self
+
+    # An ThumbsUp::Configuration object. Must act like a hash and return sensible
+    # values for all ThumbsUp::Configuration::OPTIONS. See ThumbsUp::Configuration.
+    attr_writer :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   ThumbsUp.configure do |config|
+    #     config.voteable_relationship_name = :votes_by
+    #     config.voter_relationship_name    = :votes_on
+    #   end
+    def configure
+      yield(configuration)
     end
 
-    def quoted_false
-      ActiveRecord::Base.connection.quoted_false
+    # The configuration object.
+    # @see I18::Airbrake.configure
+    def configuration
+      @configuration ||= Configuration.new
     end
   end
+
 end
 
 ActiveRecord::Base.send(:include, ThumbsUp::ActsAsVoteable)

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thumbs_up
 version: !ruby/object:Gem::Version
-  version: 0.6.3
-  prerelease: 
+  version: 0.6.4
 platform: ruby
 authors:
 - Brady Bouchard
@@ -14,134 +13,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: statistics2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ThumbsUp provides dead-simple voting capabilities to ActiveRecord models
@@ -158,6 +141,8 @@ files:
 - lib/generators/thumbs_up/templates/vote.rb
 - lib/generators/thumbs_up/thumbs_up_generator.rb
 - lib/has_karma.rb
+- lib/thumbs_up/base.rb
+- lib/thumbs_up/configuration.rb
 - lib/thumbs_up/version.rb
 - lib/thumbs_up.rb
 - rails/init.rb
@@ -170,32 +155,25 @@ files:
 - Rakefile
 homepage: http://github.com/bouchard/thumbs_up
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2682672596544266431
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2682672596544266431
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Voting for ActiveRecord with multiple vote sources and karma calculation.
 test_files: []