threadable_comments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e83c7e0fa3f4799b786f915c46241a4321c5bde
+  data.tar.gz: 6faa2940f9adba73c791febdb6a7990f09515473
+SHA512:
+  metadata.gz: 1190c7803b1d67de5961c6b8cf15a29d127ed788139693548ef583c94490287f3df2635f97c0443ef2ef04da18ba37f0cc13898d36a380557480b455c93f6c75
+  data.tar.gz: 2ecf93b1aaf627a5a8122ae5f62fc50a2da0fe176f38365afcede5430a413c26417b79ab45869b32ea87ce4484b4adf043c12de2bb31d3b8fa26a0b28435fba4

data/.gitignore

@@ -0,0 +1,7 @@
+.rvmrc
+.ruby-version
+gemfiles/*.lock
+pkg/*
+spec/debug.log
+Gemfile.lock
+.idea/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+v0.1.0
+------
+
+- Initial Release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Yves Riel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+Threadable Comments
+===================
+
+Allows for threaded comments to be added to different models while comment hierarchy is handled via the [ancestry gem](https://github.com/stefankroes/ancestry) (uses a materialised path pattern).
+
+Install
+-------
+In your Gemfile, add:
+
+    gem 'threadable_comments'
+
+and run `bundle install`.
+
+Migrations
+----------
+* To install:
+
+        rails generate threadable_comments:migration
+
+    This will generate the migration script necessary for the table
+
+Usage
+-----
+    class Article < ActiveRecord::Base
+      has_threadable_comments
+    end
+
+* Add a comment to a model instance, for example an Article:
+
+        @user_who_commented = @current_user
+        @article.add_comment "This is my comment!", @user_who_commented
+
+* To reply to a comment:
+
+        @comment.reply = "This is a reply!", @user_who_commented
+
+* To retrieve all comments for an article, including child comments:
+
+        @all_comments = @article.comments
+
+* To retrieve only the root comments without their child comments:
+
+        @root_comments = @article.root_comments
+
+* To check if a comment has children:
+
+        @comment.has_children?
+
+* To get a comment's parent:
+
+        @comment.parent
+
+* To verify the number of direct children a comment has:
+
+        @comment.children.count
+
+* To verify the number of children and grand-children a comment has:
+
+        @comment.descendants.count
+
+* To retrieve a comment's children:
+
+        @comment.children
+
+Tips
+----
+Once you have a comment in your hands, you can use all the methods and scope of the [ancestry gem](https://github.com/stefankroes/ancestry) to access children and parents of the comment.
+
+Credits
+-------
+* Inspired from [act_as_commentable_with_threading](https://github.com/elight/acts_as_commentable_with_threading)
+

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/init.rb

@@ -0,0 +1 @@
+require 'threadable_comments'

data/lib/generators/threadable_comments/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/active_record'
+
+module ThreadableComments
+  module Generators
+    # Migration generator that creates migration file from template
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :name, :type => :string, :default => 'create_comments'
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# Migration responsible for creating a table for comments
+class CreateComments < ActiveRecord::Migration
+  # Create table
+  def self.up
+    create_table :comments, force: true do |t|
+      t.belongs_to :commentable, :polymorphic => true, null: false
+      t.integer 'user_id', null: false
+      t.text 'text', default: ''
+      t.text 'parameters', default: ''
+      t.string 'ancestry'
+      t.timestamps null: false
+    end
+
+    add_index :comments, :user_id
+    add_index :comments, :ancestry
+    add_index :comments, :commentable_id
+  end
+
+  # Drop table
+  def self.down
+    drop_table :comments
+  end
+end

data/lib/threadable_comments.rb

@@ -0,0 +1,40 @@
+require 'active_record'
+require 'threadable_comments/version'
+require 'threadable_comments/comment'
+
+module ThreadableComments
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_threadable_comments
+      has_many :comments, class_name: '::ThreadableComments::Comment', as: :commentable, dependent: :destroy
+      include ThreadableComments::InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    # Scope comments to only root threads, no children/replies
+    def root_comments
+      comments.roots
+    end
+
+    # scope comments to specific user
+    def comments_by(user)
+      raise ArgumentError.new("User must have an ID property") unless user.respond_to? :id
+
+      comments.where(user_id: user.id)
+    end
+
+    def add_comment(text, user, parameters = {})
+      new_comment = ThreadableComments::Comment.create(commentable: self,
+                                                       text: text,
+                                                       user_id: user.id,
+                                                       parameters: parameters)
+      comments << new_comment
+      new_comment
+    end
+  end
+
+end
+
+ActiveRecord::Base.send(:include, ThreadableComments)

data/lib/threadable_comments/comment.rb

@@ -0,0 +1,31 @@
+require 'ancestry'
+
+module ThreadableComments
+  class Comment < ActiveRecord::Base
+    has_ancestry orphan_strategy: :destroy
+    default_scope { order(created_at: :desc) }
+
+    validates :commentable, presence: true
+    validates :user, presence: true
+
+    belongs_to :commentable, polymorphic: true
+    belongs_to :user
+    serialize :parameters
+
+    def reply(text, user)
+      Comment.create \
+      commentable: commentable,
+      text: text,
+      user_id: user.id,
+      parent: self
+    end
+
+    # Scope to find all comments for specific user
+    scope :by_user, lambda { |user|
+      raise ArgumentError.new("User must have an ID property") unless user.respond_to? :id
+
+      where(user_id: user.id)
+    }
+
+  end
+end

data/lib/threadable_comments/version.rb

@@ -0,0 +1,3 @@
+module ThreadableComments
+  VERSION = "0.1.0"
+end

data/spec/comment_spec.rb

@@ -0,0 +1,57 @@
+require 'rspec'
+
+describe ThreadableComments::Comment do
+
+  let(:user) {User.create!}
+  let(:commentable) {Commentable.create!}
+
+  let(:comment) {ThreadableComments::Comment.create(commentable: commentable, user: user, text: 'This is a comment')}
+
+  after(:example) do
+    ThreadableComments::Comment.destroy_all
+  end
+
+
+  it 'should validate a commentable' do
+    comment.commentable = nil
+
+    expect(comment.valid?).to be_falsey
+  end
+
+  it 'should validate the presence of user' do
+    comment.user = nil
+
+    expect(comment.valid?).to be_falsey
+  end
+
+  it 'can be replied to' do
+    new_comment = comment.reply('this is a reply!', user)
+    comment.reply('this is another reply!', user)
+
+    expect(new_comment.parent).to eq(comment)
+    expect(comment.children.count).to eq(2)
+  end
+
+  it 'can have reply to a reply' do
+    new_comment = comment.reply('this is a reply!', user).reply('this is a sub reply!', user)
+
+    expect(comment.descendants.count).to eq(2)
+  end
+
+  it 'destroys all of its children and their descendants' do
+    comment.reply('this is a reply!', user).reply('this is a sub reply!', user)
+
+    expect{comment.destroy}.to change{ThreadableComments::Comment.count}.by(-3)
+  end
+
+  it 'retrieves all comments for a particular user' do
+    other_user = User.create!
+    comment.reply('this is a reply!', user)
+    comment.reply('this is the other user reply!', other_user)
+
+    expect(ThreadableComments::Comment.count).to eq(3)
+    expect(ThreadableComments::Comment.by_user(other_user).count).to eq(1)
+    expect(ThreadableComments::Comment.by_user(user).count).to eq(2)
+  end
+
+end

data/spec/db/database.yml

@@ -0,0 +1,4 @@
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 500

data/spec/db/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define(version: 1) do
+  create_table 'users', force: true
+
+  create_table 'commentables', force: true
+
+  create_table 'comments', force: true do |t|
+    t.integer 'commentable_id', null: false
+    t.string 'commentable_type', null: false
+    t.text 'text', default: ''
+    t.integer 'user_id', null: false
+    t.string 'ancestry'
+    t.text 'parameters', default: ''
+    t.timestamps null: false
+  end
+
+  add_index 'comments', 'user_id'
+  add_index 'comments', 'ancestry'
+  add_index 'comments', 'commentable_id'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+Dir[File.expand_path('../support/**/*.rb',__FILE__)].each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+

data/spec/support/connection.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+
+ActiveRecord::Base.configurations = YAML.load_file(File.expand_path('../../db/database.yml',__FILE__))
+ActiveRecord::Base.establish_connection((ENV['DB'] || 'sqlite3').to_sym)
+load(File.expand_path('../../db/schema.rb',__FILE__))

data/spec/support/environment_setup.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+require 'threadable_comments'
+
+class User < ActiveRecord::Base
+  has_many :comments
+end
+
+class Commentable < ActiveRecord::Base
+  has_threadable_comments
+end

data/spec/threadable_comments_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+
+describe ThreadableComments do
+
+  describe 'A class that is commentable' do
+    let(:user) {User.create!}
+    let(:other_user) {User.create!}
+    let(:commentable) {Commentable.create!}
+    let(:other_commentable) {Commentable.create!}
+
+    before(:example) do
+      commentable.add_comment('This is my comment', user).reply('And this is the reply', user)
+      commentable.add_comment('This is another comment', user).reply('And this is its reply', user)
+      other_commentable.add_comment('Yet another comment', other_user)
+    end
+
+    after(:example) do
+      ThreadableComments::Comment.destroy_all
+    end
+
+    it 'can be commented upon' do
+      last_comment = commentable.comments.last
+      expect(last_comment.text).to eq('This is my comment')
+      expect(last_comment.commentable).to eq(commentable)
+      expect(last_comment.user_id).to eq(user.id)
+      expect(last_comment.parameters.empty?).to be_truthy
+    end
+
+    it 'accepts parameter hash' do
+      new_comment = commentable.add_comment('My Comment', user, param1: true, param2: 'My Param')
+
+      expect(new_comment.parameters[:param1]).to be_truthy
+      expect(new_comment.parameters[:param2]).to eq('My Param')
+    end
+
+    it 'lists the comments by creation date' do
+      expect(commentable.comments.first.text).to eq('And this is its reply')
+    end
+
+    it 'can retrieve root comments only' do
+      expect(commentable.root_comments.count).to eq(2)
+    end
+
+    it 'can retrieve comments made by a specific user' do
+      commentable.root_comments.first.reply('Other user reply', other_user)
+
+      expect(commentable.comments.count).to eq(5)
+      expect(commentable.comments_by(other_user).count).to eq(1)
+    end
+
+    describe 'when it is destroyed' do
+      it 'destroys its own root comments along with their children' do
+        expect{commentable.destroy}.to change{ThreadableComments::Comment.count}.by(-4)
+      end
+
+      it 'does not destroy other root comments' do
+        commentable.destroy
+        expect(ThreadableComments::Comment.count).to eq(1)
+      end
+    end
+  end
+end

data/threadable_comments.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/threadable_comments/version', __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "threadable_comments"
+  s.version     = ThreadableComments::VERSION
+  s.authors     = ["Yves Riel"]
+  s.email       = ["whyves@okapya.com"]
+  s.homepage    = "https://github.com/Whyves/threadable_comments"
+  s.summary     = "Allow then creation of comment thread"
+  s.description = "Create comments along with their threads on any commentable object. Use Ancestry gem."
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec`.split("\n")
+
+  s.add_development_dependency "rspec", "~> 3.4"
+  s.add_development_dependency "sqlite3"
+
+  s.add_dependency "rails", "~>  4.0"
+  s.add_dependency 'ancestry', '~>  2.1'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: threadable_comments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yves Riel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Create comments along with their threads on any commentable object. Use
+  Ancestry gem.
+email:
+- whyves@okapya.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/generators/threadable_comments/migration/migration_generator.rb
+- lib/generators/threadable_comments/migration/templates/migration.rb
+- lib/threadable_comments.rb
+- lib/threadable_comments/comment.rb
+- lib/threadable_comments/version.rb
+- spec/comment_spec.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- spec/support/connection.rb
+- spec/support/environment_setup.rb
+- spec/threadable_comments_spec.rb
+- threadable_comments.gemspec
+homepage: https://github.com/Whyves/threadable_comments
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allow then creation of comment thread
+test_files:
+- spec/comment_spec.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/spec_helper.rb
+- spec/support/connection.rb
+- spec/support/environment_setup.rb
+- spec/threadable_comments_spec.rb