parole 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa7a50452389b800759094aa18ff625260946c25
-  data.tar.gz: 4afa76b5ba285edae56a3715cf470fbdd6a57c47
+  metadata.gz: b6ee830289243ba04c8d108f5d7f5735be8306e9
+  data.tar.gz: 8faf15de5fceaaa33ce9098bfe68a4e8c32c6a99
 SHA512:
-  metadata.gz: 874411296ab97a6e4e148e2c057f247ee4ba504c02072976d337c4c0cf93b66a94c036445bd70d1d28ee61d3c06878f377426bf65fb44f0c50a08b18cd69cfbf
-  data.tar.gz: 43c3227696e550314dad9f94627dba9b648b988468994a21b3c15493802d7dd48cff9bc12c6388b66b400cce7ae0a54f8caa736f7ca80d396aa2a3d6c922ca2a
+  metadata.gz: 57bba72cecc135f0aaa16e5830761cef234ba6b81b30d5a69bab063523f4043642e7f501c444b6031b00175d84c7b458d52dbf00b14105af5dc4e54cf00c2a45
+  data.tar.gz: 0fc0fc9d30fce89c01a0fbb04a961ce79e715c172a2b80b8b89a0f80102472623a665d5f6bb488796982ee61d400a6fbf8799e0f94512c631112d82f808daa49

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-4.0
+
+script: "echo 'DO IT' && bundle exec rake spec"

data/README.md

@@ -1,8 +1,16 @@
-# Parole
-
-[![Gem Version](https://badge.fury.io/rb/parole.png)](https://rubygems.org/gems/parole)
-
-Parole adds the ability to comment on ActiveRecord records.
+<p align="center">
+  <a href="https://github.com/mirego/parole">
+    <img src="http://i.imgur.com/QQlNfGL.png" alt="Parole" />
+  </a>
+  <br />
+  Parole adds the ability to comment on ActiveRecord records.
+  <br /><br />
+  <a href="https://rubygems.org/gems/parole"><img src="https://badge.fury.io/rb/parole.png" /></a>
+  <a href="https://codeclimate.com/github/mirego/parole"><img src="https://codeclimate.com/github/mirego/parole.png" /></a>
+  <a href="https://travis-ci.org/mirego/parole"><img src="https://travis-ci.org/mirego/parole.png?branch=master" /></a>
+</p>
+
+---
 
 ## Installation
 

data/gemfiles/Gemfile.activerecord-4.0

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'

data/lib/generators/parole/templates/migration.rb

@@ -10,6 +10,7 @@ class AddParole < ActiveRecord::Migration
     end
 
     add_index :comments, [:commentable_type, :commentable_id, :role]
+    add_index :comments, [:commentable_type, :commentable_id]
   end
 
   def self.down

data/lib/parole/comment.rb

@@ -21,6 +21,10 @@ module Parole
 
   protected
 
+    # Update the commentable cache counter columns
+    #
+    # Look for a `<role>_comments_count` and a `comments_count` column
+    # in the commentable model and update their value with the count.
     def update_cache_counters
       role_method = :"#{self.role}_comments_count="
       if commentable.respond_to?(role_method)
@@ -35,6 +39,11 @@ module Parole
       commentable.save(validate: false)
     end
 
+    # Make sure that the value of the `role` attribute is a valid role
+    # for the commentable.
+    #
+    # If the commentable doesn't have any comment roles, we make sure
+    # that the value is blank.
     def ensure_valid_role_for_commentable
       allowed_roles = commentable.class.commentable_options[:roles]
 
@@ -45,6 +54,8 @@ module Parole
       end
     end
 
+    # Make sure that the record we're commenting on is an instance
+    # of a commentable model.
     def ensure_valid_commentable
       klass = commentable.class
       errors.add(:commentable, :invalid) unless klass.respond_to?(:acts_as_commentable?) && klass.acts_as_commentable?

data/lib/parole/version.rb

@@ -1,3 +1,3 @@
 module Parole
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/parole/comment_spec.rb

@@ -1,4 +1,113 @@
 require 'spec_helper'
 
 describe Parole::Comment do
+  describe :ClassMethods do
+    describe :create do
+      context 'through general `comments` association' do
+        before do
+          spawn_comment_model
+          spawn_commenter_model 'User'
+          spawn_commentable_model 'Article'
+
+          run_migration do
+            create_table(:articles, force: true)
+            create_table(:users, force: true)
+          end
+        end
+
+        let(:commenter) { User.create }
+        let(:commentable) { Article.create }
+
+        context 'without role attribute' do
+          let(:comment) { commentable.comments.create(commenter: commenter, comment: 'Booya') }
+
+          it { expect(comment).to be_persisted }
+          it { expect(comment.comment).to eql 'Booya' }
+          it { expect(comment.commenter).to eql commenter }
+          it { expect(comment.commentable).to eql commentable }
+        end
+
+        context 'with role attribute' do
+          let(:comment) { commentable.comments.create(role: 'YEP', commenter: commenter, comment: 'Booya') }
+          it { expect(comment).to_not be_persisted }
+          it { expect(comment.errors.full_messages).to eql ['Role is invalid'] }
+        end
+      end
+
+      context 'through a role-specific comments association' do
+        before do
+          spawn_comment_model
+          spawn_commenter_model 'User'
+          spawn_commentable_model 'Article' do
+            acts_as_commentable roles: [:photos, :videos]
+          end
+
+          run_migration do
+            create_table(:articles, force: true)
+            create_table(:users, force: true)
+          end
+        end
+
+        let(:commenter) { User.create }
+        let(:commentable) { Article.create }
+
+        context 'with commentable role association method' do
+          let(:comment) { commentable.photos_comments.create(commenter: commenter, comment: 'Booya') }
+
+          it { expect(comment).to be_persisted }
+          it { expect(comment.role).to eql 'photos' }
+          it { expect(comment.comment).to eql 'Booya' }
+          it { expect(comment.commenter).to eql commenter }
+          it { expect(comment.commentable).to eql commentable }
+        end
+
+        context 'with commentable main association method' do
+          context 'with valid role' do
+            let(:comment) { commentable.comments.create(role: 'photos', commenter: commenter, comment: 'Booya') }
+
+            it { expect(comment).to be_persisted }
+            it { expect(comment.role).to eql 'photos' }
+            it { expect(comment.comment).to eql 'Booya' }
+            it { expect(comment.commenter).to eql commenter }
+            it { expect(comment.commentable).to eql commentable }
+          end
+
+          context 'with invalid role' do
+            let(:comment) { commentable.comments.create(role: 'NOPE', commenter: commenter, comment: 'Booya') }
+            it { expect(comment).to_not be_persisted }
+            it { expect(comment.errors.full_messages).to eql ['Role is invalid'] }
+          end
+        end
+      end
+    end
+  end
+
+  describe :InstanceMethods do
+    describe :update_cache_counters do
+      before do
+        spawn_comment_model
+        spawn_commenter_model 'User'
+        spawn_commentable_model 'Article' do
+          acts_as_commentable roles: [:photos, :videos]
+        end
+
+        run_migration do
+          create_table(:users, force: true)
+          create_table(:articles, force: true) do |t|
+            t.integer :photos_comments_count, default: 0
+            t.integer :videos_comments_count, default: 0
+            t.integer :comments_count, default: 0
+          end
+        end
+      end
+
+      let(:commenter) { User.create }
+      let(:commentable) { Article.create }
+      let(:create_comment!) { commentable.photos_comments.create(commenter: commenter, comment: 'Booya') }
+
+      it { expect { create_comment! }.to change { commentable.reload.photos_comments_count }.from(0).to(1) }
+      it { expect { create_comment! }.to_not change { commentable.reload.videos_comments_count } }
+      it { expect { create_comment! }.to change { commentable.reload.comments_count }.from(0).to(1) }
+    end
+  end
 end

data/spec/parole/commentable_spec.rb

@@ -1,107 +1,41 @@
 require 'spec_helper'
 
 describe Parole::Commentable do
-  describe :comments do
-    before do
-      spawn_comment_model
-      spawn_commenter_model 'User'
-      spawn_commentable_model 'Article'
+  describe 'general `comments` relation' do
+    let(:relation_class) { ActiveRecord::Associations::CollectionProxy::ActiveRecord_Associations_CollectionProxy_Comment }
 
-      run_migration do
-        create_table(:articles, force: true)
-        create_table(:users, force: true)
-      end
-    end
-
-    let(:commenter) { User.create }
-    let(:commentable) { Article.create }
-
-    context 'without role attribute' do
-      let(:comment) { commentable.comments.create(commenter: commenter, comment: 'Booya') }
-
-      it { expect(comment).to be_persisted }
-      it { expect(comment.comment).to eql 'Booya' }
-      it { expect(comment.commenter).to eql commenter }
-      it { expect(comment.commentable).to eql commentable }
-    end
-
-    context 'with role attribute' do
-      let(:comment) { commentable.comments.create(role: 'YEP', commenter: commenter, comment: 'Booya') }
-      it { expect(comment).to_not be_persisted }
-      it { expect(comment.errors.full_messages).to eql ['Role is invalid'] }
-    end
-  end
-
-  describe 'role comments' do
-    before do
-      spawn_comment_model
-      spawn_commenter_model 'User'
-      spawn_commentable_model 'Article' do
-        acts_as_commentable roles: [:photos, :videos]
-      end
-
-      run_migration do
-        create_table(:articles, force: true)
-        create_table(:users, force: true)
-      end
-    end
+    context 'without defined roles' do
+      before do
+        spawn_comment_model
+        spawn_commentable_model 'Article'
 
-    let(:commenter) { User.create }
-    let(:commentable) { Article.create }
-
-    context 'with commentable role association method' do
-      let(:comment) { commentable.photos_comments.create(commenter: commenter, comment: 'Booya') }
-
-      it { expect(comment).to be_persisted }
-      it { expect(comment.role).to eql 'photos' }
-      it { expect(comment.comment).to eql 'Booya' }
-      it { expect(comment.commenter).to eql commenter }
-      it { expect(comment.commentable).to eql commentable }
-    end
-
-    context 'with commentable main association method' do
-      context 'with valid role' do
-        let(:comment) { commentable.comments.create(role: 'photos', commenter: commenter, comment: 'Booya') }
-
-        it { expect(comment).to be_persisted }
-        it { expect(comment.role).to eql 'photos' }
-        it { expect(comment.comment).to eql 'Booya' }
-        it { expect(comment.commenter).to eql commenter }
-        it { expect(comment.commentable).to eql commentable }
+        run_migration do
+          create_table(:articles, force: true)
+        end
       end
 
-      context 'with invalid role' do
-        let(:comment) { commentable.comments.create(role: 'NOPE', commenter: commenter, comment: 'Booya') }
-        it { expect(comment).to_not be_persisted }
-        it { expect(comment.errors.full_messages).to eql ['Role is invalid'] }
-      end
+      it { expect(Article.create.comments).to be_instance_of(ActiveRecord::Associations::CollectionProxy::ActiveRecord_Associations_CollectionProxy_Comment) }
+      it { expect(Article.create.comments.new.role).to be_blank }
     end
-  end
 
-  describe 'cache counters' do
-    before do
-      spawn_comment_model
-      spawn_commenter_model 'User'
-      spawn_commentable_model 'Article' do
-        acts_as_commentable roles: [:photos, :videos]
-      end
+    context 'with roles' do
+      before do
+        spawn_comment_model
+        spawn_commentable_model 'Article' do
+          acts_as_commentable roles: [:photos, :videos]
+        end
 
-      run_migration do
-        create_table(:users, force: true)
-        create_table(:articles, force: true) do |t|
-          t.integer :photos_comments_count, default: 0
-          t.integer :videos_comments_count, default: 0
-          t.integer :comments_count, default: 0
+        run_migration do
+          create_table(:articles, force: true)
         end
       end
-    end
-
-    let(:commenter) { User.create }
-    let(:commentable) { Article.create }
-    let(:create_comment!) { commentable.photos_comments.create(commenter: commenter, comment: 'Booya') }
 
-    it { expect { create_comment! }.to change { commentable.reload.photos_comments_count }.from(0).to(1) }
-    it { expect { create_comment! }.to_not change { commentable.reload.videos_comments_count } }
-    it { expect { create_comment! }.to change { commentable.reload.comments_count }.from(0).to(1) }
+      it { expect(Article.create.comments).to be_instance_of(relation_class) }
+      it { expect(Article.create.photos_comments).to be_instance_of(relation_class) }
+      it { expect(Article.create.videos_comments).to be_instance_of(relation_class) }
+      it { expect(Article.create.comments.new.role).to be_blank }
+      it { expect(Article.create.photos_comments.new.role).to eql 'photos' }
+      it { expect(Article.create.videos_comments.new.role).to eql 'videos' }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parole
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rémi Prévost
@@ -103,9 +103,11 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
+- gemfiles/Gemfile.activerecord-4.0
 - lib/generators/parole/USAGE
 - lib/generators/parole/install_generator.rb
 - lib/generators/parole/templates/migration.rb