voltaire 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ce67879a2722aed80afbab466884e3980224948
-  data.tar.gz: 758e40e64ab0c7bb1f6cee51b14067b0a3dd32c4
+  metadata.gz: c28cec632b79a5fcac75a29d2fbec19aaa9fd51e
+  data.tar.gz: 29e6a75c640ac2e8134a54608486a4f2033fe510
 SHA512:
-  metadata.gz: 1f0bf5163ea394906d53c4c1abef8f80ed7c4be6dba01b9f23c5d208ae367b5a787d1619056cc2a51de461c2730c50384072e0c88cb826784fd6f138781f6a75
-  data.tar.gz: ecec57a8f5f5444e49b2da1097358dd76100ce1ddef736c2e0dac1b51891ac96b0ff18d8e840d059759606d52abc7f0ef9c1777512f5422746f857652c09756e
+  metadata.gz: 93fdff51da9b305f2a5bf4b7c1516c653535b9b8caf0c82c6270cba87d0438a56f36f5bb169a344d04012d339de846c8ac4085973a7eabbf800629c6a45add1d
+  data.tar.gz: 2049b6be8ac30566be38d6c77e27adb1e7f7c66e2af8bf0277a03a9513fc9b8b74adc90673e5c29427dcd0a56f9a8b267d77ecb2ac900397c805f628c3a30228

data/README.md

@@ -2,7 +2,8 @@
 > A witty quote proves nothing. - Voltaire
 
 Voltaire provides a very simple way to manage user reputation points. It lets you increase or decrease reputation 
-(points, level, whatever you want to call it in your app) as needed, whenever.
+(points, level, whatever you want to call it in your app) as needed, whenever. It is intended to be extremely light-weight,
+when all you want to track is some kind of points system and nothing else. 
 
 All you have to do is add a column for reputation in your users table and let Voltaire do the rest.
 
@@ -11,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.2.0'
+gem 'voltaire', '~> 0.3.0'
 ```
 
 And then execute:
@@ -43,8 +44,11 @@ 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 three arguments: amount (the amount you want to increase or decrease by), reputation (the database column 
-you want to alter), and user (the user whose reputation will be increased).
+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).
+
+_Note: if you are using any model other than users, you will need to use the_ ```voltaire_up_other``` and ```voltaire_down_other``` _methods_ 
+_(instructions farther down)._
 
 The two methods are
 
@@ -135,6 +139,38 @@ def create
 end
 ```
 
+## 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:
+
+```ruby
+voltaire_up_other(amount, reputation, user, other)
+  
+voltaire_down_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._
+
+```ruby
+  def create
+    @city = City.new(city_params)
+    @city.user = current_user
+
+    respond_to do |format|
+      if @city.save
+        voltaire_up_other(1, :score, @city.world_id, World)
+        format.html { redirect_to @city, notice: 'City was successfully created.' }
+      else
+        format.html { render :new }
+      end
+    end
+  end
+```
+
+Now, the author can easily see which of their worlds (characters, locations, etc.) are more developed, vs. ones that may need more work.
+(Maybe they also compete with other authors to get their creations more points.)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/voltaire.rb

@@ -12,6 +12,18 @@ module Voltaire
       User.decrement_counter(reputation, user)
     end
   end
+  
+  def voltaire_up_other(amount, reputation, user, other)
+    amount.times.collect do
+      other.increment_counter(reputation, user)
+    end
+  end
+    
+  def voltaire_down_other(amount, reputation, user, other)
+    amount.times.collect do
+      other.decrement_counter(reputation, user)
+    end
+  end
 end
 
 if defined? ActionController::Base

data/lib/voltaire/version.rb

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

metadata

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