comment_me 0.1.0alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f5501f6b8825f7338a5427d4eb7f236d1b6ebee7ffd30fcec3da8ee44260f14
+  data.tar.gz: b36b31c3fb04311c0f43fbbf0f425b0f85d9a3379a3446424c002f838b6bbfc2
+SHA512:
+  metadata.gz: f007142bb33a78053df1c3e4dec214a1712f0c349e8109337c374568722bd1da00c7738322c978b0f50ae1ffb5f4ffdd82d5c2986fb504794a9d78b2591a1426
+  data.tar.gz: 4186378b2a18462b2e6a789a5d5dda512f26276cef300d2fbea9689ecc3bd4d9524dc72882135fecf6b605b2abe461b39ab29608d891d03a298c297b7f608f2d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 
+
+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,102 @@
+# CommentMe
+
+Attached comments for ActiveRecord models
+
+[![Build Status](https://travis-ci.org/Kinedu/comment_me.svg?branch=master)](https://travis-ci.org/Kinedu/comment_me)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comment_me'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+In the root directory:
+
+```bash
+$ rails generate comment_me
+```
+
+## Usage
+
+The plugin generates a comment structure mounted on ActiveRecord models. Comments can be associated with any model (any model can have the functionality).
+
+It also contains a control that can be used, or not, and that makes data persistence by inserting into the database.
+
+
+### Models
+
+Make a model commentable.
+
+```ruby
+class Article < ActiveRecord::Base
+  comment_me
+end
+```
+
+Then.
+
+```ruby
+# Create new record
+article = Article.create!
+
+# Create a comment for article
+article.comments.create emitter: "Armando Alejandre", message: "¡Hola mundo!"
+
+#  => #<Comment id: 29, emitter: "Armando Alejandre", message: "¡Hola mundo!", entity_type: "Article", entity_id: 2, comment_id: nil, created_at: "2019-10-11 06:37:13", updated_at: "2019-10-11 06:37:13"> 
+# 2.6.3 :004 >
+
+# See all comments
+article.comments
+
+# => #<ActiveRecord::Associations::CollectionProxy [#<Comment id: 32, emitter: "Armando Alejandre", message: "¡Hola mundo!", entity_type: "Article", entity_id: 2, comment_id: nil, created_at: "2019-10-11 06:40:58", updated_at: "2019-10-11 06:40:58">, #<Comment id: 31, emitter: "Armando Alejandre", message: "¡Hola mundo!", entity_type: "Article", entity_id: 2, comment_id: nil, created_at: "2019-10-11 06:40:57", updated_at: "2019-10-11 06:40:57">, #<Comment id: 30, emitter: "Armando Alejandre", message: "¡Hola mundo!", entity_type: "Article", entity_id: 2, comment_id: nil, created_at: "2019-10-11 06:40:56", updated_at: "2019-10-11 06:40:56">, #<Comment id: 29, emitter: "Armando Alejandre", message: "¡Hola mundo!", entity_type: "Article", entity_id: 2, comment_id: nil, created_at: "2019-10-11 06:37:13", updated_at: "2019-10-11 06:37:13">]>
+```
+
+### Controllers
+
+A control is available to record comments and works with any model to which you want to add a comment.
+
+To access the routes, call the #comment_me method into the route file.
+
+```ruby
+# call method #comment_me:
+# config/routes.rb
+    
+Rails.application.routes.draw do
+
+  comment_me
+end
+    
+```
+
+Check the routes.
+
+```bach
+rails routes
+```
+
+More information about the routes visit the [Postman](https://documenter.getpostman.com/view/2691667/SVtVU7zQ) documentation.
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+Make a pull request:
+
+- Clone the repo
+- Create your feature branch
+- Commit your changes
+- Push the branch
+- Create new Pull-Request
+
+Please write tests if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CommentMe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/comment_me/acts_as_commentable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CommentMe
+  module ActsAsCommentable
+    extend ActiveSupport::Concern
+
+    ModelCommentable = Module.new do
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :comments, -> { includes :comments }, as: :entity, dependent: :destroy
+      end
+    end
+
+    class_methods do
+      def comment_me
+        include ModelCommentable
+      end
+    end
+  end
+end
+
+# => including the method in ActiveRecord
+ActiveRecord::Base.include CommentMe::ActsAsCommentable

data/lib/comment_me/controllers/comment_me_base_controller.rb

@@ -0,0 +1,3 @@
+class CommentMeBaseController < ActionController::Base
+  protect_from_forgery with: :null_session
+end

data/lib/comment_me/controllers/comments_controller.rb

@@ -0,0 +1,55 @@
+require_relative 'comment_me_base_controller'
+
+class CommentsController < CommentMeBaseController
+  before_action :set_commet, only: %i(show update destroy)
+
+  def show
+    render json: @comment
+  end
+
+  def create
+    @comment = Comment.new(comment_params)
+
+    if @comment.valid?
+      @comment.save
+
+      render json: @comment
+    else
+      render_comment_errors
+    end
+  end
+
+  def update
+    if @comment.update(comment_params)
+      render json: @comment
+    else
+      render_comment_errors
+    end
+  end
+
+  def destroy
+    @comment.destroy
+  end
+
+  private
+
+  def set_commet
+    @comment = Comment.find(params[:id])
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
+  end
+
+  def comment_params
+    params.require(:comment).permit(
+      :entity_type,
+      :entity_id,
+      :emitter,
+      :message,
+      comments_attributes: [:emitter, :message]
+    )
+  end
+
+  def render_comment_errors
+    render json: @comment.errors, status: :unprocessable_entity
+  end
+end

data/lib/comment_me/initializer.rb

@@ -0,0 +1,2 @@
+require_relative 'models/comment'
+require_relative 'controllers/comments_controller'

data/lib/comment_me/models/comment.rb

@@ -0,0 +1,33 @@
+class Comment < ActiveRecord::Base
+
+  # => associations
+  belongs_to :entity, polymorphic: true, optional: false
+  belongs_to :comment, optional: true
+  has_many :comments, dependent: :destroy
+
+  # => Validations
+  validates_presence_of :emitter, :message
+  validate :entity_existence, if: :entity_type?
+
+  # => *
+  def entity_exist?
+    entity_instance&.respond_to?(self.class.name.tableize)
+  end
+
+  # => * 
+  def entity_instance
+    "#{entity_type}".constantize.find_by(id: entity_id)
+  end
+
+  private
+
+  # => *
+  def entity_existence
+    unless entity_exist?
+      errors.add(
+        :entity,
+        "#{entity_type} doesn't have association with Comment or there's no record in #{entity_type} witn id=#{entity_id}"
+      )
+    end
+  end
+end

data/lib/comment_me/railtie.rb

@@ -0,0 +1,4 @@
+module CommentMe
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/comment_me/routes.rb

@@ -0,0 +1,23 @@
+module ActionDispatch::Routing
+  class Mapper
+
+    # => Inserting routes for comments_controller
+    #
+    # Example: 
+    #
+    # Rails.application.routes.draw do
+    #
+    #   comment_me
+    # end
+    #
+    def comment_me
+      scope :operations, defaults: { format: :json } do
+        scope :comment_me do
+          scope :comments do
+            resources :comments, path: :/
+          end
+        end
+      end
+    end
+  end
+end

data/lib/comment_me/version.rb

@@ -0,0 +1,3 @@
+module CommentMe
+  VERSION = '0.1.0alpha'
+end

data/lib/comment_me.rb

@@ -0,0 +1,3 @@
+require 'comment_me/initializer'
+require 'comment_me/routes'
+require 'comment_me/acts_as_commentable'

data/lib/generators/comment_me/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate access_token_migration Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/comment_me/comment_me_generator.rb

@@ -0,0 +1,25 @@
+class CommentMeGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('templates', __dir__)
+
+  def migration
+    migration_template(
+      'migration.rb',
+      'db/migrate/create_comments.rb'
+    )
+  end
+
+  def rails5_and_up?
+    Rails::VERSION::MAJOR >= 5
+  end
+
+  def migration_version
+    if rails5_and_up?
+      "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+    end
+  end
+
+  def self.next_migration_number(dir)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+end

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

@@ -0,0 +1,11 @@
+class CreateComments < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :comments do |t|
+      t.string :emitter
+      t.text :message
+      t.references :entity, polymorphic: true, index: true
+      t.references :comment, foreign_key: true, index: true 
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/comment_me_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :comment_me do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: comment_me
+version: !ruby/object:Gem::Version
+  version: 0.1.0alpha
+platform: ruby
+authors:
+- Armando Alejandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.2.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rake
+  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: jbuilder
+  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-rails
+  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: shoulda-matchers
+  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: shoulda-callback-matchers
+  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: coveralls
+  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: pry
+  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'
+description: Attached comments for ActiveRecord models
+email:
+- armando1339@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/comment_me.rb
+- lib/comment_me/acts_as_commentable.rb
+- lib/comment_me/controllers/comment_me_base_controller.rb
+- lib/comment_me/controllers/comments_controller.rb
+- lib/comment_me/initializer.rb
+- lib/comment_me/models/comment.rb
+- lib/comment_me/railtie.rb
+- lib/comment_me/routes.rb
+- lib/comment_me/version.rb
+- lib/generators/comment_me/USAGE
+- lib/generators/comment_me/comment_me_generator.rb
+- lib/generators/comment_me/templates/migration.rb
+- lib/tasks/comment_me_tasks.rake
+homepage: https://www.kinedu.com/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Kinedu/comment_me
+  allowed_push_host: https://rubygems.org
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Attached comments for ActiveRecord models
+test_files: []