merit 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781f4040bce17e9983ae237f54bf91c1538ce365
-  data.tar.gz: c7aeb303a7c9b4378e5b5ecd4ad10de6842d3e64
+  metadata.gz: 5d79f50b24ec0f6cf605b5b77fbd9d2b96c41f16
+  data.tar.gz: 862c1a7af32018b9344bdccb43d462b97d7339e0
 SHA512:
-  metadata.gz: 190bd669ef68c354cc322049f08a77bc68450a2762766be5f322cb84813a029bc74631f94ecbb7d2f1340281f10fb9a8fc5dcf6f243bc8f28adf76b8ce588c04
-  data.tar.gz: 15155d78b99d36ec84c7124b48e82cbcab1d877ff2d3e370a3aa8d899e09c0f1c99598c448226ff276427b5bf5072760c625831ef94ba391987a33299a17bf26
+  metadata.gz: 783a96fce0128b18e34eba63999a84675011576d8ca0031251d5c4fe5d967007488616b0afe07258b0df2ac1b5c3e853e95b10e712b35a3b93f2e943b94e7c65
+  data.tar.gz: 0453aa9d1395d6a6d1f86f11276d076ba1d07a2e13b4622b3e07e077cc445e5055c64e99103a5074af555ead4217d05c749f2fc2918d3c9f4e7b264ec1ff04dc

data/NEWS.md

@@ -2,6 +2,14 @@
 
 User-visible changes worth mentioning.
 
+## 2.3.3
+
+- [#215] Bug fix in API where a `BadgeSash` would be created without failures
+  with a nil `badge_id`.
+- Add validations to `BadgesSash`
+- Rename generated migration files to explicitly name merit
+- README improvements
+
 ## 2.3.2
 
 - [#218] Implement I18n for internationalization support

data/README.md

@@ -26,7 +26,9 @@ and Rankings.
     - [Defining Rules](#defining-rules-2)
         - [Examples](#examples-2)
     - [Displaying Rankings](#displaying-rankings)
+- [How merit finds the target object](#how-merit-finds-the-target-object)
 - [Getting Notifications](#getting-notifications)
+- [I18n](#i18n)
 - [Uninstalling Merit](#uninstalling-merit)
 
 
@@ -135,9 +137,9 @@ badges:
 
 ```erb
 <ul>
-<% current_user.badges.each do |badge| %>
-  <li><%= badge.name %></li>
-<% end %>
+  <% current_user.badges.each do |badge| %>
+    <li><%= badge.name %></li>
+  <% end %>
 </ul>
 ```
 
@@ -155,9 +157,9 @@ action user or to the method(s) defined in the `:to` option. Define rules on
 * `score`
   * `Integer`
   * `Proc`, or any object that accepts `call` which takes one argument, where
-    the target_object is passed in and the return value is used as the score.
+    the target object is passed in and the return value is used as the score.
 * `:on` action as string or array of strings (like `controller#action`, similar to Rails routes)
-* `:to` method(s) to send to the target_object (who should be scored?)
+* `:to` method(s) to send to the target object (who should be scored?)
 * `:model_name` (optional) to specify the model name if it cannot be guessed
   from the controller. (e.g. `model_name: 'User'` for `RegistrationsController`,
   or `model_name: 'Comment'` for `Api::CommentsController`)
@@ -258,6 +260,37 @@ end
 ```
 
 
+# How merit finds the target object
+
+Merit fetches the rule’s target object (the parameter it receives) from its
+`:model_name` option, or from the controller’s instance variable.
+
+To read it from the controller merit searches for the instance variable named
+after the singularized controller name. For example, a rule like:
+
+```ruby
+grant_on 'comments#update', badge_id: 1 do |target_object|
+  # target_object would be better named comment in this sample
+end
+```
+
+Would make merit try to find the `@comment` instance variable in the
+`CommentsController#update` action. If the rule had the `:model_name` option
+specified:
+
+```ruby
+grant_on 'comments#update', badge_id: 1, model_name: "Article" do |target_object|
+  # target_object would be better named article in this sample
+end
+```
+
+Merit would fetch the `Article` object from the database, found by the `:id`
+param sent in that `update` action.
+
+If none of these methods find the target, Merit will log a `no target_obj`
+warning, with a comment to check the configuration for the rule.
+
+
 # Getting Notifications
 
 You can get observers notified any time merit changes reputation in your

data/lib/generators/active_record/merit_generator.rb

@@ -13,8 +13,8 @@ module ActiveRecord
       end
 
       def copy_migrations_and_model
-        migration_template 'add_fields_to_model.rb',
-                           "db/migrate/add_fields_to_#{table_name}.rb"
+        migration_template 'add_merit_fields_to_model.rb',
+                           "db/migrate/add_merit_fields_to_#{table_name}.rb"
       end
     end
   end

data/lib/generators/active_record/remove_generator.rb

@@ -16,8 +16,10 @@ module ActiveRecord
         migration_template 'remove_merit_tables.rb',
                            'db/migrate/remove_merit_tables.rb'
 
-        migration_template 'remove_fields_from_model.rb',
-                           "db/migrate/remove_fields_from_#{table_name}.rb"
+        migration_template(
+          'remove_merit_fields_from_model.rb',
+          "db/migrate/remove_merit_fields_from_#{table_name}.rb"
+        )
       end
     end
   end

data/lib/generators/active_record/templates/{add_fields_to_model.rb → add_merit_fields_to_model.rb}

@@ -1,4 +1,4 @@
-class AddFieldsTo<%= table_name.camelize %> < ActiveRecord::Migration
+class AddMeritFieldsTo<%= table_name.camelize %> < ActiveRecord::Migration
   def change
     add_column :<%= table_name %>, :sash_id, :integer
     add_column :<%= table_name %>, :level,   :integer, :default => 0

data/lib/generators/active_record/templates/{remove_fields_from_model.rb → remove_merit_fields_from_model.rb}

@@ -1,4 +1,4 @@
-class RemoveFieldsFrom<%= table_name.camelize %> < ActiveRecord::Migration
+class RemoveMeritFieldsFrom<%= table_name.camelize %> < ActiveRecord::Migration
   def self.up
     remove_column :<%= table_name %>, :sash_id
     remove_column :<%= table_name %>, :level

data/lib/merit/models/active_record/merit/badges_sash.rb

@@ -1,10 +1,13 @@
 module Merit
   class BadgesSash < ActiveRecord::Base
     include Base::BadgesSash
+
     has_many :activity_logs,
              class_name: 'Merit::ActivityLog',
              as: :related_change
 
+    validates_presence_of :badge_id, :sash
+
     attr_accessible :badge_id if show_attr_accessible?
   end
 end

data/lib/merit/models/base/sash.rb

@@ -10,13 +10,13 @@ module Merit
       end
 
       def add_badge(badge_id)
-        bs = Merit::BadgesSash.new(badge_id: badge_id)
+        bs = Merit::BadgesSash.new(badge_id: badge_id.to_i)
         badges_sashes << bs
         bs
       end
 
       def rm_badge(badge_id)
-        badges_sashes.where(badge_id: badge_id).first.try(:destroy)
+        badges_sashes.where(badge_id: badge_id.to_i).first.try(:destroy)
       end
 
       # Retrieve the number of points from a category

data/merit.gemspec

@@ -1,11 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = "merit"
-  s.summary     = "General reputation Rails engine."
-  s.description = "Manage badges, points and rankings (reputation) of resources in a Rails application."
-  s.homepage    = "http://github.com/tute/merit"
+  s.summary     = "Reputation engine for Rails apps"
+  s.description = "Manage badges, points and rankings (reputation) in your Rails app."
+  s.homepage    = "https://github.com/merit-gem/merit"
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
+  s.test_files  = `git ls-files -- test/*`.split("\n")
   s.license     = 'MIT'
-  s.version     = '2.3.2'
+  s.version     = '2.3.3'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 

data/test/integration/navigation_test.rb

@@ -36,6 +36,14 @@ class NavigationTest < ActionDispatch::IntegrationTest
 
     user.rm_badge badge.id
     assert_equal [badge], user.reload.badges
+
+    assert_raise NoMethodError do
+      user.add_badge badge
+    end
+
+    assert_raise NoMethodError do
+      user.rm_badge badge
+    end
   end
 
   test 'Remove inexistent badge should do nothing' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Tute Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -108,8 +108,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.0
-description: Manage badges, points and rankings (reputation) of resources in a Rails
-  application.
+description: Manage badges, points and rankings (reputation) in your Rails app.
 email: tutecosta@gmail.com
 executables: []
 extensions: []
@@ -129,14 +128,14 @@ files:
 - lib/generators/active_record/install_generator.rb
 - lib/generators/active_record/merit_generator.rb
 - lib/generators/active_record/remove_generator.rb
-- lib/generators/active_record/templates/add_fields_to_model.rb
+- lib/generators/active_record/templates/add_merit_fields_to_model.rb
 - lib/generators/active_record/templates/add_target_data_to_merit_actions.rb
 - lib/generators/active_record/templates/create_badges_sashes.rb
 - lib/generators/active_record/templates/create_merit_actions.rb
 - lib/generators/active_record/templates/create_merit_activity_logs.rb
 - lib/generators/active_record/templates/create_sashes.rb
 - lib/generators/active_record/templates/create_scores_and_points.rb
-- lib/generators/active_record/templates/remove_fields_from_model.rb
+- lib/generators/active_record/templates/remove_merit_fields_from_model.rb
 - lib/generators/active_record/templates/remove_merit_tables.rb
 - lib/generators/active_record/upgrade_generator.rb
 - lib/generators/merit/install_generator.rb
@@ -262,7 +261,7 @@ files:
 - test/unit/sash_test.rb
 - test/unit/score_test.rb
 - test/unit/target_finder_test.rb
-homepage: http://github.com/tute/merit
+homepage: https://github.com/merit-gem/merit
 licenses:
 - MIT
 metadata: {}
@@ -282,9 +281,97 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: General reputation Rails engine.
-test_files: []
-has_rdoc: 
+summary: Reputation engine for Rails apps
+test_files:
+- test/dummy/Rakefile
+- test/dummy/app/controllers/admin/users_controller.rb
+- test/dummy/app/controllers/api/comments_controller.rb
+- test/dummy/app/controllers/api/users_controller.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/comments_controller.rb
+- test/dummy/app/controllers/registrations_controller.rb
+- test/dummy/app/controllers/users_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/address.rb
+- test/dummy/app/models/comment.rb
+- test/dummy/app/models/dummy_observer.rb
+- test/dummy/app/models/merit/badge_rules.rb
+- test/dummy/app/models/merit/point_rules.rb
+- test/dummy/app/models/merit/rank_rules.rb
+- test/dummy/app/models/user.rb
+- test/dummy/app/views/admin/users/index.html.erb
+- test/dummy/app/views/comments/_form.html.erb
+- test/dummy/app/views/comments/edit.html.erb
+- test/dummy/app/views/comments/index.html.erb
+- test/dummy/app/views/comments/new.html.erb
+- test/dummy/app/views/comments/show.html.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/users/_form.html.erb
+- test/dummy/app/views/users/edit.html.erb
+- test/dummy/app/views/users/index.html.erb
+- test/dummy/app/views/users/new.html.erb
+- test/dummy/app/views/users/show.html.erb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/merit.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/mongoid.yml
+- test/dummy/config/routes.rb
+- test/dummy/db/migrate/20110421191249_create_users.rb
+- test/dummy/db/migrate/20110421191250_create_comments.rb
+- test/dummy/db/migrate/20120318022220_add_fields_to_users.rb
+- test/dummy/db/migrate/20130321082817_add_fields_to_comments.rb
+- test/dummy/db/migrate/20130329224406_create_merit_actions.rb
+- test/dummy/db/migrate/20130329224407_create_merit_activity_logs.rb
+- test/dummy/db/migrate/20130329224408_create_sashes.rb
+- test/dummy/db/migrate/20130329224409_create_badges_sashes.rb
+- test/dummy/db/migrate/20130329224410_create_scores_and_points.rb
+- test/dummy/db/migrate/20140211144001_create_addresses.rb
+- test/dummy/db/migrate/20140819133931_add_target_data_to_merit_actions.rb
+- test/dummy/db/migrate/20140906225844_create_players.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/seeds.rb
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/public/javascripts/application.js
+- test/dummy/public/javascripts/controls.js
+- test/dummy/public/javascripts/dragdrop.js
+- test/dummy/public/javascripts/effects.js
+- test/dummy/public/javascripts/prototype.js
+- test/dummy/public/javascripts/rails.js
+- test/dummy/public/rails.js
+- test/dummy/public/stylesheets/.gitkeep
+- test/dummy/public/stylesheets/scaffold.css
+- test/dummy/script/rails
+- test/integration/navigation_test.rb
+- test/orm/active_record.rb
+- test/orm/mongoid.rb
+- test/orm_models/active_record.rb
+- test/orm_models/mongoid.rb
+- test/support/integration_case.rb
+- test/test_helper.rb
+- test/unit/action_test.rb
+- test/unit/base_target_finder_test.rb
+- test/unit/merit_unit_test.rb
+- test/unit/rule_unit_test.rb
+- test/unit/rules_matcher_test.rb
+- test/unit/sash_finder_test.rb
+- test/unit/sash_test.rb
+- test/unit/score_test.rb
+- test/unit/target_finder_test.rb