minimal_feedback 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,44 @@
-# MinimalFeedback
+# MinimalFeedback[![Build Status](https://secure.travis-ci.org/issuehunter/minimal_feedback.png)](http://travis-ci.org/issuehunter/minimal_feedback)
 
-TODO: Write a gem description
+Feedback functionalities for ActiveRecord models
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Add to Gemfile:
 
-    gem 'minimal_feedback'
+```ruby
+gem 'minimal_feedback'
+```
 
-And then execute:
+Run:
 
-    $ bundle
+```ruby
+bundle install
+rails generate minimal_state_machine
+rake db:migrate
+```
 
-Or install it yourself as:
+## Quick Start
 
-    $ gem install minimal_feedback
+Let's say we have an Issue ActiveRecord model and we want to be able to give it feedback
 
-## Usage
+```ruby
+class Issue < ActiveRecord::Base
+end
+```
+
+What would happen with this configuration:
+
+```ruby
+issue = Issue.create
+issue.give_feedback(:positive)
+issue.feedbacks.first.type
+=> :positive
 
-TODO: Write usage instructions here
+issue.give_feedback(:negative)
+issue.feedbacks.last.type
+=> :negative
+```
 
 ## Contributing
 

data/lib/minimal_feedback/version.rb

@@ -1,3 +1,3 @@
 module MinimalFeedback
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/minimal_feedback.rb

@@ -8,6 +8,8 @@ module MinimalFeedback
   included do
     has_many :feedbacks, :as => :rateable, :class_name => 'MinimalFeedback::Feedback'
 
+    class InvalidFeedbackError < StandardError; end
+
     def give_feedback(type)
       feedback_type = type.to_sym
       case feedback_type
@@ -15,6 +17,8 @@ module MinimalFeedback
         Feedback.create(:rating => 1) { |f| f.rateable = self }
       when :negative
         Feedback.create(:rating => -1) { |f| f.rateable = self }
+      else
+        raise InvalidFeedbackError
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimal_feedback
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4218162571524871835
+      hash: 4159579160644425485
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4218162571524871835
+      hash: 4159579160644425485
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24