parole 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcabaf06d28e44a6f2bdb705ff7cee1dec0dabc8
-  data.tar.gz: 1aa7738d85f9a1eca9e25c205d957c8a85390267
+  metadata.gz: 4ee674fa482c0e5bdac4920a45ebe3cf3b432d6e
+  data.tar.gz: 9ced8509fb977a20a4ae990dff8b6e508a65f489
 SHA512:
-  metadata.gz: 293a9952bb46794c66fd545adf8f9dc0b82c4b322d599e4ecc4ffb36119a8d3a4b4253fd5fd705b7fcd96f19c5204c00cb46be39e1bc9fbe3b37924cbb143e71
-  data.tar.gz: a3e07a743dc843ce00b475dd6e21b690f40ef2f342826aa9a3b563340e4ace9491edd048baa843357b743feeb5dd8c3e49baf29da1a7d1f259bf9ad9287acd21
+  metadata.gz: 8cbfe7a1ccfc90c130c331d195b545eb55b5bfb791c5b0d18d89c0253b180f082569abe3f7ca417d14c35a188a51e41b87cff0693ddc25e320b695e4e9ece3a5
+  data.tar.gz: 3ed9ae68d461e3f721023eee4030ad167c46c037880d31f7677f502a9c772c158b58fd20c4329ae2e2e76d2aa268adffb0fbc3792550b8ea5b8606e09c99e235

data/.rspec

@@ -0,0 +1 @@
+--colour

data/README.md

@@ -0,0 +1,92 @@
+# Parole
+
+[![Gem Version](https://badge.fury.io/rb/parole.png)](https://rubygems.org/gems/parole)
+
+Parole adds the ability to comment on ActiveRecord records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'parole'
+```
+
+Then run the task to generate the migration:
+
+```bash
+$ rails generate parole:install
+```
+
+## Usage
+
+You should now be able to mark models as *commentable*:
+
+```ruby
+class Article < ActiveRecord::Base
+  acts_as_commentable
+end
+```
+
+You’re pretty much done after that. You’re now able to do this:
+
+```ruby
+user = User.find(1)
+article = Article.find(1)
+
+article.comments.create(commenter: user, comment: 'Hello world!')
+article.comments.count # => 1
+```
+
+You can also provide roles for comments, so you can have multiple type of comments per record.
+
+```ruby
+class Article < ActiveRecord::Base
+  acts_as_commentable roles: [:photos, :videos]
+end
+
+user = User.find(1)
+article = Article.find(1)
+
+article.photos_comments.create(commenter: user, comment: 'Hello world!')
+article.photos_comments.count # => 1
+article.comments.count # => 1
+```
+
+### Cache counters
+
+Whenever a comment is created or destroyed, Parole looks into the commentable record and check
+if there’s a `<role>_comments_count` column and/or a `comments_count` column. If so, it updates
+them so they reflect the total number of comments and the number of comments of this role for
+the record.
+
+So let’s say the `Article` model has the following columns: `photos_comments_count`, `videos_comments_count` and `comments_count`.
+
+```ruby
+class Article < ActiveRecord::Base
+  acts_as_commentable roles: [:photos, :videos]
+end
+
+user = User.find(1)
+article = Article.find(1)
+
+article.photos_comments.create(commenter: user, comment: 'Hello world!')
+article.photos_comments_count # => 1
+article.videos_comments_count # => 0
+article.comments_count # => 1
+
+article.videos_comments.create(commenter: user, comment: 'Hello world again!')
+article.photos_comments_count # => 1
+article.videos_comments_count # => 1
+article.comments_count # => 2
+```
+
+## License
+
+`Parole` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/parole/blob/master/LICENSE.md) file.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly build mobile applications for [iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"), [iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"), [Android](http://mirego.com/en/android-app-development/ "Android application development"), [Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"), [Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and [Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development") in beautiful Quebec City.
+
+We also love [open-source software](http://open.mirego.com/) and we try to extract as much code as possible from our projects to give back to the community.

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/lib/generators/parole/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Copies comment.rb to app/models/.
+    Copies create_comment.rb to db/migrate
+
+Examples:
+    `rails generate comment`

data/lib/generators/parole/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Parole
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        else
+         '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/add_parole.rb'
+      end
+
+      def create_model_file
+        template "model.rb", "app/models/comment.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+class AddParole < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.references :commentable, polymorphic: true
+      t.references :commenter, polymorphic: true
+      t.string :role, default: 'comment'
+      t.text :comment
+
+      t.timestamps
+    end
+
+    add_index :comments, [:commentable_type, :commentable_id, :role]
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

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

@@ -0,0 +1,3 @@
+class Comment < ActiveRecord::Base
+  acts_as_comment
+end

data/lib/parole/comment.rb

@@ -0,0 +1,53 @@
+module Parole
+  module Comment
+    extend ActiveSupport::Concern
+
+    included do
+      # Associations
+      belongs_to :commentable, polymorphic: true
+      belongs_to :commenter, polymorphic: true
+
+      # Callbacks
+      after_create :update_cache_counters
+      after_destroy :update_cache_counters
+
+      # Validations
+      validate :ensure_valid_role_for_commentable
+      validate :ensure_valid_commentable
+      validate :commenter, presence: true
+      validate :commentable, presence: true
+      validate :comment, presence: true
+    end
+
+  protected
+
+    def update_cache_counters
+      role_method = :"#{self.role}_comments_count="
+      if commentable.respond_to?(role_method)
+        commentable.send role_method, commentable.comments.where(role: self.role).count
+      end
+
+      total_method = :comments_count=
+      if commentable.respond_to?(total_method)
+        commentable.send total_method, commentable.comments.count
+      end
+
+      commentable.save(validate: false)
+    end
+
+    def ensure_valid_role_for_commentable
+      allowed_roles = commentable.class.commentable_options[:roles]
+
+      if allowed_roles.any?
+        errors.add(:role, :invalid) unless allowed_roles.include?(self.role)
+      else
+        errors.add(:role, :invalid) unless self.role.blank?
+      end
+    end
+
+    def ensure_valid_commentable
+      klass = commentable.class
+      errors.add(:commentable, :invalid) unless klass.respond_to?(:acts_as_commentable?) && klass.acts_as_commentable?
+    end
+  end
+end

data/lib/parole/commentable.rb

@@ -0,0 +1,19 @@
+module Parole
+  module Commentable
+    extend ActiveSupport::Concern
+
+    included do
+      # Default options for all comments associations
+      association_options = { class_name: 'Comment', as: :commentable, dependent: :destroy }
+
+      # All comments for the record
+      has_many :comments, association_options
+
+      # Role-specific comments for the record
+      commentable_options.fetch(:roles).each do |role|
+        options = association_options.merge before_add: lambda { |_, comment| comment.role = role }
+        has_many :"#{role}_comments", lambda { where(role: role) }, options
+      end
+    end
+  end
+end

data/lib/parole/version.rb

@@ -1,3 +1,3 @@
 module Parole
-  VERSION = '0.0.1'
+  VERSION = '0.1'
 end

data/lib/parole.rb

@@ -1,4 +1,26 @@
 require 'parole/version'
 
-module Parole
+require 'active_record'
+require 'active_support'
+
+require 'parole/commentable'
+require 'parole/comment'
+
+class ActiveRecord::Base
+  def self.acts_as_commentable(options = {})
+    class_attribute :commentable_options, :acts_as_commentable
+    self.acts_as_commentable = true
+    self.commentable_options = options.reverse_merge(roles: [])
+    self.commentable_options[:roles] = commentable_options[:roles].map(&:to_s)
+
+    include Parole::Commentable
+  end
+
+  def self.acts_as_commentable?
+    !!self.acts_as_commentable
+  end
+
+  def self.acts_as_comment(*args)
+    include Parole::Comment
+  end
 end

data/parole.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Parole::VERSION
   spec.authors       = ['Rémi Prévost']
   spec.email         = ['rprevost@mirego.com']
-  spec.description   = ''
-  spec.summary       = ''
-  spec.homepage      = ''
+  spec.description   = 'Parole adds the ability to comment on ActiveRecord models.'
+  spec.summary       = spec.description
+  spec.homepage      = 'http://open.mirego.com/parole'
   spec.license       = 'BSD 3-Clause'
 
   spec.files         = `git ls-files`.split($/)
@@ -20,4 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
 end

data/spec/parole/comment_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Parole::Comment do
+end

data/spec/parole/commentable_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Parole::Commentable do
+  describe :comments 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
+
+  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
+
+    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
+
+  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
+
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+
+require 'parole'
+
+# Require our macros and extensions
+Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
+
+RSpec.configure do |config|
+  # Include our macros
+  config.include DatabaseMacros
+  config.include ModelMacros
+
+  config.before(:each) do
+    # Create the SQLite database
+    setup_database
+
+    # Run our migration
+    run_default_migration
+  end
+
+  config.after(:each) do
+    # Make sure we remove our test database file
+    cleanup_database
+
+    # Remove our models
+    flush_models!
+  end
+end

data/spec/support/macros/database_macros.rb

@@ -0,0 +1,39 @@
+module DatabaseMacros
+  # Run migrations in the test database
+  def run_migration(&block)
+    # Create a new migration class
+    klass = Class.new(ActiveRecord::Migration)
+
+    # Create a new `up` that executes the argument
+    klass.send(:define_method, :up) { self.instance_exec(&block) }
+
+    # Create a new instance of it and execute its `up` method
+    klass.new.up
+  end
+
+  def self.database_file
+    @database_file || File.expand_path('../test.db', __FILE__)
+  end
+
+  def setup_database
+    # Make sure the test database file is gone
+    cleanup_database
+
+    # Establish the connection
+    SQLite3::Database.new FileUtils.touch(DatabaseMacros.database_file).first
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: DatabaseMacros.database_file)
+
+    # Silence everything
+    ActiveRecord::Base.logger = ActiveRecord::Migration.verbose = false
+  end
+
+  def cleanup_database
+    FileUtils.rm(DatabaseMacros.database_file) if File.exists?(DatabaseMacros.database_file)
+  end
+
+  # Run the built-in migration
+  def run_default_migration
+    load File.expand_path('../../../../lib/generators/parole/templates/migration.rb', __FILE__)
+    AddParole.new.up
+  end
+end

data/spec/support/macros/model_macros.rb

@@ -0,0 +1,39 @@
+module ModelMacros
+  # Create a new commentable model
+  def spawn_commentable_model(klass_name = 'Article', &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      acts_as_commentable unless block
+      instance_exec(&block) if block
+    end
+  end
+
+  # Create a new comment model
+  def spawn_comment_model(klass_name = 'Comment', &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      acts_as_comment unless block
+      instance_exec(&block) if block
+    end
+  end
+
+  # Create a new commenter model
+  def spawn_commenter_model(klass_name = 'User', &block)
+    spawn_model klass_name, ActiveRecord::Base do
+      has_many :comments unless block
+      instance_exec(&block) if block
+    end
+  end
+
+  protected
+
+  # Create a new model class
+  def spawn_model(klass_name, parent_klass, &block)
+    @spawned_models ||= []
+    Object.instance_eval { remove_const klass_name } if Object.const_defined?(klass_name)
+    @spawned_models << Object.const_set(klass_name, Class.new(parent_klass))
+    Object.const_get(klass_name).class_eval(&block) if block_given?
+  end
+
+  def flush_models!
+    @spawned_models.each { |model| Object.instance_eval { remove_const model.name.to_sym } }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parole
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -38,7 +38,63 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Parole adds the ability to comment on ActiveRecord models.
 email:
 - rprevost@mirego.com
 executables: []
@@ -46,12 +102,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- README.md
 - Rakefile
+- lib/generators/parole/USAGE
+- lib/generators/parole/install_generator.rb
+- lib/generators/parole/templates/migration.rb
+- lib/generators/parole/templates/model.rb
 - lib/parole.rb
+- lib/parole/comment.rb
+- lib/parole/commentable.rb
 - lib/parole/version.rb
 - parole.gemspec
-homepage: ''
+- spec/parole/comment_spec.rb
+- spec/parole/commentable_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb
+homepage: http://open.mirego.com/parole
 licenses:
 - BSD 3-Clause
 metadata: {}
@@ -74,5 +143,10 @@ rubyforge_project:
 rubygems_version: 2.1.0
 signing_key: 
 specification_version: 4
-summary: ''
-test_files: []
+summary: Parole adds the ability to comment on ActiveRecord models.
+test_files:
+- spec/parole/comment_spec.rb
+- spec/parole/commentable_spec.rb
+- spec/spec_helper.rb
+- spec/support/macros/database_macros.rb
+- spec/support/macros/model_macros.rb