commentable_on 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977c9733dc850169abece4df1029b7d41777b97138b2a2abbd9df4224118e81c
-  data.tar.gz: b0cbcf3f8ede3685d03dc4bf706bace452cbe8c95ee1ff58e141b66d4c451875
+  metadata.gz: 114f29fe05a7af6a7ab42c9a193244d31d8f2dc0df038dd9de3005fbe79009fd
+  data.tar.gz: 4516516f21e525daf05cd836aac4d728a046cb947452e92c113fb585a2e937e0
 SHA512:
-  metadata.gz: 2c1c4b801b7a65535a9e8595c15d94745d0cad32506264ba33647c5515d98b5bdee4fa81bea0c73861eaeeb6ca0b41f620b6facd26f2b8a033da36965c3a099e
-  data.tar.gz: 60dea80bd2cf24badd245fe637d3345837a26d7a9b7c8e0caadfbc9188a8396be82fd41ac9f51b6d32cf5a8a3a5d550df2aab5d23137d2e12467b9dd5d74c979
+  metadata.gz: 2ed87344389a6ebdea787203963b43802ce0bd0ec646bfbe85eb58b13e327af761f3f3d72f1b3302830586089ce7b2da581edef50b8c3da3dbd6876b83e83148
+  data.tar.gz: 58d8ce724fd9e0b3c5e846a650569fc466c5120250a696d37fc7359fdee779a8babd8c287d5cdf58d67e1e24d8a3dbad2e320306ca881046d3b520cb7b4065ab

data/Gemfile

@@ -7,7 +7,6 @@ gem "rake", "~> 12.0"
 gem "rspec", "~> 3.6"
 gem "sqlite3", "~> 1.5"
 gem "factory_bot", "~> 6.2"
-gem "activerecord", "~> 7.0", require: false
 gem "rubocop", "= 1.35.1", require: false
 gem "standard", "~> 1.16", ">= 1.16.1", require: false
 gem "rubocop-rspec", require: false

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    commentable_on (0.1.0)
+    commentable_on (1.0.0)
+      ancestry (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +17,8 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    ancestry (4.2.0)
+      activerecord (>= 5.2.6)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
@@ -31,7 +34,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -79,7 +82,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 7.0)
   commentable_on!
   factory_bot (~> 6.2)
   rake (~> 12.0)

data/README.md

@@ -1,8 +1,6 @@
-# _**Under active development**_
-
 # Commentable On Steroids 
 
-Adds comments functionality to Rails/ActiveRecord modules
+Adds comments functionality to Rails/ActiveRecord models. It uses the [ancestry gem](https://github.com/stefankroes/ancestry) to add thread/reply support to comments.
 
 ## Installation
 
@@ -45,7 +43,31 @@ Add a comment to model instance:
   @post.add_comment(commenter: current_user, body: "Awesome")
    ```
 
-The commenter, add `acts_as_commenter` to commenter models for reserve functionality
+Create reply
+```ruby
+comment = commenter.first
+@post.create_reply(comment: comment, commenter: current_user, body: "awesome reply")
+```
+
+Get all root comments
+```ruby
+@post = Post.find(params[:post_id])
+@post.root_comments
+```
+
+Get all replies for a comment
+```ruby
+comment = @post.comments.first
+@post.replies_for(comment)
+```
+
+Get thread for a comment
+```ruby
+comment = @post.comments.first
+@post.thread_for(comment)
+```
+
+The commenter, add `acts_as_commenter` to commenter models
 ```ruby
 class User < ActiveRecord::Base
   acts_as_commenter
@@ -57,6 +79,12 @@ Add comment as a commenter
 @post = Post.find(params[:post_id])
 current_user.comment(commentable: @post, body: "awesome")
 ```
+
+Reply to comment as a commenter
+```ruby
+comment = commenter.comments.first
+current_user.reply_to(comment: comment, body: "awesome reply")
+```
   
 ## Development
 
@@ -81,4 +109,5 @@ Everyone interacting in the CommentableOn project's codebases, issue trackers, c
 
 - [ ] Add comment threading
 - [ ] Add migration generators 
-- [ ] Automate gem release 
+- [ ] Automate gem release
+- [ ] Add contribution guideline

data/commentable_on.gemspec

@@ -26,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  # Gem dependencies
+  spec.add_dependency "ancestry", "~> 4.2"
 end

data/lib/commentable_on/comment.rb

@@ -1,5 +1,9 @@
+require "ancestry"
+
 module CommentableOn
   class Comment < ::ActiveRecord::Base
+    has_ancestry(primary_key_format: /\A[\w\-]+(\/[\w\-]+)*\z/, ancestry_column: :thread)
+
     if defined?(ProtectedAttributes)
       attr_accessible :commentable_id, :commentable_type, :commenter_id, :commenter_type, :commentable, :commenter, :body
     end

data/lib/commentable_on/commentable.rb

@@ -14,5 +14,25 @@ module CommentableOn
       comment = CommentableOn::Comment.new(commentable: self, commenter: commenter, body: body)
       comment.save
     end
+
+    def create_reply(comment:, commenter:, body:)
+      unless comment.instance_of?(CommentableOn::Comment)
+        return CommentableOn::Comment.create(commentable: self, commenter: commenter, body: body, parent_id: comment)
+      end
+
+      comment.children.create(commentable: self, commenter: commenter, body: body)
+    end
+
+    def root_comments
+      comments.roots
+    end
+
+    def replies_for(comment)
+      comments.children_of(comment)
+    end
+
+    def thread_for(comment)
+      comments.descendents_of(comment)
+    end
   end
 end

data/lib/commentable_on/commenter.rb

@@ -10,8 +10,12 @@ module CommentableOn
       end
     end
 
-    def comment(commentable:, body:)
-      commentable.add_comment args.merge(commenter: self, body: body)
+    def comment_on(commentable:, body:)
+      commentable.add_comment commenter: self, body: body
+    end
+
+    def reply_to(comment:, body:)
+      comment.commentable.create_reply comment: comment, commenter: self, body: body
     end
   end
 end

data/lib/commentable_on/version.rb

@@ -1,3 +1,3 @@
 module CommentableOn
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

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

@@ -0,0 +1,55 @@
+require "rails/generators/migration"
+
+module CommentableOn
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for commentable (comments table)"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), "templates", (orm.to_s unless orm.instance_of?(String)))
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(_path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template "migration.erb", "db/migrate/commentable_on_migration.rb", migration_version: migration_version
+      end
+    end
+
+    private
+
+    def migration_version
+      if rails5?
+        "[4.2]"
+      elsif rails6?
+        "[6.0]"
+      elsif rails7?
+        "[7.0]"
+      end
+    end
+
+    def rails5?
+      Rails.version.start_with? "5"
+    end
+
+    def rails6?
+      Rails.version.start_with? "6"
+    end
+
+    def rails7?
+      Rails.version.start_with? "7"
+    end
+  end
+end

data/lib/generators/commentable_on/migration/templates/active_record/migration.erb

@@ -0,0 +1,20 @@
+class CommentableOnMigration < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :comments do |t|
+      t.references :commentable, polymorphic: true
+      t.references :commenter, polymorphic: true
+      t.text :body
+      t.string :thread
+
+      t.timestamps
+    end
+
+    add_index :comments, :thread
+    add_index :comments, [:commenter_id, :commenter_type]
+    add_index :comments, [:commentable_id, :commentable_type]
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: commentable_on
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Ralak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Placeholder description text explaining how commentable on steroids will
   save the world in 5 words or less
 email:
@@ -39,6 +53,8 @@ files:
 - lib/commentable_on/extenders/commentable.rb
 - lib/commentable_on/extenders/commenter.rb
 - lib/commentable_on/version.rb
+- lib/generators/commentable_on/migration/migration_generator.rb
+- lib/generators/commentable_on/migration/templates/active_record/migration.erb
 homepage: https://github.com/samuelralak/commentable-on
 licenses:
 - MIT