voltaire 0.3.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c28cec632b79a5fcac75a29d2fbec19aaa9fd51e
-  data.tar.gz: 29e6a75c640ac2e8134a54608486a4f2033fe510
+  metadata.gz: edd5229303a45a052c3f1711d00a8fa4fed9af37
+  data.tar.gz: 49ca0737a96675267c8b45cc33b9ad1ade3ca32c
 SHA512:
-  metadata.gz: 93fdff51da9b305f2a5bf4b7c1516c653535b9b8caf0c82c6270cba87d0438a56f36f5bb169a344d04012d339de846c8ac4085973a7eabbf800629c6a45add1d
-  data.tar.gz: 2049b6be8ac30566be38d6c77e27adb1e7f7c66e2af8bf0277a03a9513fc9b8b74adc90673e5c29427dcd0a56f9a8b267d77ecb2ac900397c805f628c3a30228
+  metadata.gz: 2b7d9aae3f1568e5b16153ace6e81b9cbae25e8c8c066e36116e6330eb71d67866984b130a18f1c07c645f8ac083e7292de5f03f84d36ed22614ff46aa453988
+  data.tar.gz: 0ff7118f318fb22c6af52bb65afb84445544ac9b537c6864cf6246247f9698256d3ce6cb8789410e3c850c12243c9f0b980bec855f99a2be59446a5c1ee7cbf5

data/README.md

@@ -12,7 +12,7 @@ All you have to do is add a column for reputation in your users table and let Vo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'voltaire', '~> 0.3.0'
+gem 'voltaire', '~> 0.4.5'
 ```
 
 And then execute:
@@ -43,14 +43,28 @@ rails db:migrate
 
 ## Implementing Voltaire's Powerful Mechanism
 
-Now you're ready to roll. Voltaire has two methods you can call to increase or decrease the user's reputation score.
-It requires 3 arguments: amount (the amount you want to increase or decrease by), reputation (the database column 
-you want to alter), and user (the user or item whose points will be increased).
+Now you're ready to roll. Voltaire has a couple different ways you can increase or decrease the user's reputation score. One method 
+is incremental, and is intended for high-volume actions that increase scores by smaller amounts. 
 
-_Note: if you are using any model other than users, you will need to use the_ ```voltaire_up_other``` and ```voltaire_down_other``` _methods_ 
+_Note that with any of the minus/plus 
+methods, the record is updated by 1 for whatever amount you specify, so if you put that you want a user's score to increase by 100 for 
+something, the database will be hit 100 times. For larger amounts, use the up/down methods instead._
+
+To recap:
+- incrementing and decrementing by 1 or a small number, use the _plus_ or _minus_ methods below; _this way guards against concurrency_
+- increasing and decreasing by larger amounts for rarer actions or if you don't care about concurrency, user _up_ and _down_ methods below
+
+Whichever of the two ways you decide to use, the parameters are the same. Each method takes 3 arguments: 
+* _amount_ (the amount you want to increase or decrease by)
+* _reputation_ (the database column you want to alter)
+* _user_ (the user or item whose points will be increased)
+
+_Note: if you are using any model other than users, you will need to use the_ ```voltaire_plus_other``` , ```voltaire_minus_other```, ```voltaire_up_other``` and ```voltaire_down_other``` _methods_ 
 _(instructions farther down)._
 
-The two methods are
+
+## Larger Amounts
+Use ```voltaire_up``` and ```voltaire_down``` methods for larger amounts and if you don't worry about concurrency issues. 
 
 ```
 voltaire_up(amount, reputation, user)
@@ -60,6 +74,21 @@ and
 ```
 voltaire_down(amount, reputation, user)
 ```
+
+## Increments/Decrements of 1 or Smaller Amounts
+Use ```voltaire_plus``` and ```voltaire_minus``` methods for smaller amounts or if have concurrency issues. These will hit the database
+multiple times.
+
+```
+voltaire_plus(amount, reputation, user)
+```
+and
+
+```
+voltaire_minus(amount, reputation, user)
+```
+
+# Implementation and Examples
 To implement it, simply call the method you want in your controller and pass in the parameters. 
 
 ## Examples
@@ -67,20 +96,21 @@ To implement it, simply call the method you want in your controller and pass in
 Here is an implementation of the [acts_as_votable](https://github.com/ryanto/acts_as_votable) gem, which allows users to 
 upvote or downvote comments. In the comments_controller.rb file, we pass in our method where we want Voltaire to go to 
 town. In the example below, when a user upvotes a comment, the user who made the comment will have their _karma_ increase 
-by 1, as karma is the database column in this example. 
+by 1, as karma is the database column in this example. Because it is incrementing and decrementing by 1, and because lots of
+users can potentially upvote and downvote simultaneously, we are using the concurrent safe versions:
 
 _comments_controller.rb_
 
 ```ruby
 def upvote
   @comment.upvote_by current_user
-  voltaire_up(1, :karma, @comment.user_id)
+  voltaire_plus(1, :karma, @comment.user_id)
   redirect_to :back
 end
 
 def downvote
   @comment.downvote_by current_user
-  voltaire_down(1, :karma, @comment.user_id)
+  voltaire_minus(1, :karma, @comment.user_id)
   redirect_to :back
 end
 ```
@@ -102,7 +132,8 @@ _index.html.erb_
 
 ## More Examples
 Here we have set up an easy way to toggle an article and make it featured. Any time a user's article gets featured, we have
-Voltaire increase their _reputation_ by 20 points. 
+Voltaire increase their _reputation_ by 250 points. Because an article being featured is a rarer occasion, and because we don't
+feel like hitting our database 250 times for this, we use the up/down method.
 
 _articles_controller.rb_
 
@@ -139,7 +170,7 @@ def create
 end
 ```
 
-## Something Besides Users
+# Something Besides Users
 If you want to implement a score system on some other than users, you will need to pass that in to the method as a fourth parameter.
 In the example below, there is a World class for an app that helps writers create new worlds. If we implement a scoring 
 system on the world, we can easily see which ones are more fleshed out. The methods in this case will look like this:
@@ -148,6 +179,10 @@ system on the world, we can easily see which ones are more fleshed out. The meth
 voltaire_up_other(amount, reputation, user, other)
   
 voltaire_down_other(amount, reputation, user, other)
+
+voltaire_plus_other(amount, reputation, user, other)
+  
+voltaire_minus_other(amount, reputation, user, other)
 ```
 
 The fourth parameter, other, indicates the class. In this case, it would be ```World```. _This parameter needs to be uppercase._
@@ -159,7 +194,7 @@ The fourth parameter, other, indicates the class. In this case, it would be ```W
 
     respond_to do |format|
       if @city.save
-        voltaire_up_other(1, :score, @city.world_id, World)
+        voltaire_plus_other(1, :score, @city.world_id, World)
         format.html { redirect_to @city, notice: 'City was successfully created.' }
       else
         format.html { render :new }

data/lib/voltaire.rb

@@ -1,25 +1,51 @@
 require "voltaire/version"
 
 module Voltaire
+  # FOR MORE THAN INCREMENTING BY 1
   def voltaire_up(amount, reputation, user)
+    get_user = User.find_by(id: user)
+    get_user.reputation += amount
+    get_user.save
+  end
+  
+  def voltaire_down(amount, reputation, user)
+    get_user = User.find_by(id: user)
+    get_user.reputation -= amount
+    get_user.save
+  end
+  
+  def voltaire_up_other(amount, reputation, user, other)
+    get_other = other.find_by(id: user)
+    get_other.reputation += amount
+    get_other.save
+  end
+    
+  def voltaire_down_other(amount, reputation, user, other)
+    get_other = other.find_by(id: user)
+    get_other.reputation -= amount
+    get_other.save      
+  end
+  
+  # FOR INCREMENTING
+  def voltaire_plus(amount, reputation, user)
     amount.times.collect do
       User.increment_counter(reputation, user)
     end
   end
   
-  def voltaire_down(amount, reputation, user)
+  def voltaire_minus(amount, reputation, user)
     amount.times.collect do
       User.decrement_counter(reputation, user)
     end
   end
   
-  def voltaire_up_other(amount, reputation, user, other)
+  def voltaire_plus_other(amount, reputation, user, other)
     amount.times.collect do
       other.increment_counter(reputation, user)
     end
   end
     
-  def voltaire_down_other(amount, reputation, user, other)
+  def voltaire_minus_other(amount, reputation, user, other)
     amount.times.collect do
       other.decrement_counter(reputation, user)
     end

data/lib/voltaire/version.rb

@@ -1,3 +1,3 @@
 module Voltaire
-  VERSION = "0.3.0"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltaire
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.5
 platform: ruby
 authors:
 - Dan Donche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler