talkie 0.1.0

data/bin/setup

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+set -e
+
+# Install required gems
+gem install bundler --conservative
+bundle check || bundle install
+
+# Set up database for the application that Talkie tests against
+cd spec/dummy && RAILS_ENV=test bundle exec rails db:create db:migrate

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+---
+en:
+  talkie:
+    comments:
+      form:
+        submit: "Publish"
+        body_placeholder: "Write your comment..."
+      count:
+        plural: "comments"
+        singular: "comment"
+    comment:
+      reply: "Reply"
+      delete: "DELETE"
+      form:
+        reply: "Reply"
+        body_placeholder: "Write your deply..."

data/config/locales/es.yml

@@ -0,0 +1,16 @@
+---
+es:
+  talkie:
+    comments:
+      form:
+        submit: "Publicar"
+        body_placeholder: "Escribe tu comentario..."
+      count:
+        plural: "comentarios"
+        singular: "comentario"
+    comment:
+      reply: "Responder"
+      delete: "BORRAR"
+      form:
+        reply: "Responder"
+        body_placeholder: "Escribe tu respuesta..."

data/config/routes.rb

@@ -0,0 +1,3 @@
+Talkie::Engine.routes.draw do
+  resources :comments, only: [:create, :destroy]
+end

data/lib/generators/talkie/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Talkie
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_talkie_initializer
+        copy_file 'talkie.rb', 'config/initializers/talkie.rb'
+      end
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_talkie_migration
+        migration_template "create_talkie_comments.rb", "db/migrate/create_talkie_comments.rb"
+      end
+    end
+  end
+end

data/lib/generators/talkie/templates/create_talkie_comments.rb

@@ -0,0 +1,27 @@
+class CreateTalkieComments < ActiveRecord::Migration[5.0]
+  def self.up
+    create_table :talkie_comments do |t|
+      t.string   :creator_type
+      t.integer  :creator_id
+      t.integer  :commentable_id
+      t.string   :commentable_type
+      t.text     :body, null: false
+      t.integer  :parent_id
+      t.integer  :lft
+      t.integer  :rgt
+      t.integer  :children_count, default: 0
+      t.datetime :deleted_at
+
+      t.timestamps null: false
+    end
+
+    add_index :talkie_comments, :commentable_id
+    add_index :talkie_comments, :commentable_type
+    add_index :talkie_comments, [:creator_id, :creator_type],
+              name: 'index_talkie_comments_on_creator_id_and_creator_type'
+  end
+
+  def self.down
+    drop_table :talkie_comments
+  end
+end

data/lib/generators/talkie/templates/talkie.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Use this hook to configure talkie options for comments scope, creator info and so forth.
+# Some configurations are set on the view, check https://github.com/kurenn/talkie for more
+# information
+Talkie.configure do |config|
+  # ==> Default comments scope configuration
+  # Configure the default_scope to use by Talkie::Comment class
+  # Notice you need to set it to a lambda function
+  # config.default_comments_scope = -> { order(created_at: :desc) }
+
+
+  # ==> Comment creator handler
+  # Configure the text to display on the creator for each comment
+  # By default it will use the email
+  # You can set this to a method on your model, or a simple attribute
+  # config.comment_creator_handler = :email
+
+  # ==> Creator path
+  # Configure the path to redirect to on the creator link for each comment
+  # By default it will use a '#'
+  # Notice you need to set it to a lambda function, which receives:
+  # a user and the router, both arguments are necessary
+  # Here is a quick example on how you may want to configure it
+  # config.creator_path = lambda { |user, router| router.user_path(user) }
+  # or
+  # config.creator_path = lambda { |user, router| router.profile_path(user) }
+  #
+  # The default looks like:
+  # config.creator_path = lambda { |user, router| "#" }
+
+
+  # ==> Creator avatar url
+  # Configure the avatar url for the comment creator
+  # By default it will use a http:////api.adorable.io/avatars/40/abott@adorable.png
+  # Notice you need to set it to a lambda function, which receives:
+  # a user which is mandatory
+  # Here is a quick example on how you may want to configure it
+  # config.creator_avatar_url = lambda { |user| user.profile_image_url(:thumb) }
+  # or
+  # config.creator_avatar_url = lambda { |user| user.avatar(:thumb) }
+  # Make sure you return a string
+  #
+  # The default looks like:
+  # config.creator_avatar_url = lambda { |user| "//api.adorable.io/avatars/40/abott@adorable.png" }
+end

data/lib/talkie.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "talkie/version"
+require "talkie/engine"
+require "awesome_nested_set"
+
+module Talkie
+
+  @@default_comments_scope = -> { order(created_at: :desc) }
+  mattr_accessor :default_comments_scope
+
+  @@comment_creator_handler = :email
+  mattr_accessor :comment_creator_handler
+
+  @@creator_path = lambda { |_user, _router| "#" }
+  mattr_accessor :creator_path
+
+  @@creator_avatar_url = lambda { |_user| "//api.adorable.io/avatars/40/abott@adorable.png" }
+  mattr_accessor :creator_avatar_url
+
+  def self.configure
+    yield self
+  end
+end
+
+require "talkie/acts_as_talker"
+require "talkie/acts_as_commentable"
+require "talkie/permission"
+require "talkie/controller"
+require "talkie/renderer_helper"

data/lib/talkie/acts_as_commentable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Talkie
+  module ActsAsCommentable
+    extend ActiveSupport::Concern
+
+    module InstanceMethods
+      def root_parents
+        comments.where(parent_id: nil)
+      end
+    end
+
+    module ClassMethods
+      def acts_as_commentable
+        has_many :comments, as: :commentable,
+                            class_name: "Talkie::Comment",
+                            inverse_of: :commentable
+
+        include Talkie::ActsAsCommentable::InstanceMethods
+      end
+
+      alias_method :is_commentable, :acts_as_commentable
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Talkie::ActsAsCommentable

data/lib/talkie/acts_as_talker.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Talkie
+  module ActsAsTalker
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def acts_as_talker
+        class_eval do
+          has_many :comments, as: :creator,
+                              class_name: 'Talkie::Comment',
+                              inverse_of: :creator
+
+          def owns_comment?(comment)
+            self == comment.creator
+          end
+        end
+      end
+
+      alias_method :acts_as_commentator, :acts_as_talker
+      alias_method :acts_as_speaker, :acts_as_talker
+      alias_method :acts_as_commenter, :acts_as_talker
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Talkie::ActsAsTalker

data/lib/talkie/comments_renderer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Talkie
+  class CommentsRenderer
+    attr_reader :commentable
+
+    def initialize(view_context, commentable, options = {})
+      @view_context = view_context
+      @commentable = commentable
+      @options = options
+    end
+
+    def render
+      @view_context.render "talkie/comments/template"
+    end
+
+    def nested_enabled?
+      @options[:nested] || false
+    end
+
+    def display_user_avatar?
+      @options[:display_user_avatar].present?
+    end
+
+    def display_user_handler?
+      @options[:display_user_handler] || false
+    end
+
+    def root_comments
+      comments = @commentable.root_parents
+      comments = comments.includes(:creator) if display_user_info?
+      comments = comments.includes(:children) if nested_enabled?
+
+      comments
+    end
+
+    private
+
+    def display_user_info?
+      display_user_handler? || display_user_avatar?
+    end
+  end
+end

data/lib/talkie/controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Talkie
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :allow?, to: :current_permission
+      helper_method :allow?
+    end
+
+    protected
+
+    def current_permission
+      @current_permission ||= Talkie::Permission.new(current_user)
+    end
+  end
+end

data/lib/talkie/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Talkie
+  class Engine < ::Rails::Engine
+    isolate_namespace Talkie
+
+    initializer 'talkie_helpers.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        helper Talkie::ApplicationHelper
+        include Talkie::RendererHelper
+        include Talkie::Controller
+      end
+    end
+  end
+end

data/lib/talkie/permission.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Talkie
+  class Permission < Struct.new(:user)
+    def allow?(action, comment)
+      action = action.to_s
+
+      if user
+        return true if action.in? %w[create]
+        return true if user.owns_comment?(comment) && action.in?(%w[destroy])
+      end
+
+      false
+    end
+  end
+end

data/lib/talkie/renderer_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "talkie/comments_renderer"
+
+module Talkie
+  module RendererHelper
+    extend ActiveSupport::Concern
+
+    DELEGATED_METHODS_TO_COMMENTS_RENDERER = %i[commentable
+                                                root_comments
+                                                nested_enabled?
+                                                display_user_handler?
+                                                display_user_avatar?].freeze
+
+    HELPER_METHODS = %i[talkie_on
+                        nested_enabled?
+                        display_user_handler?
+                        display_user_avatar?
+                        root_comments
+                        commentable].freeze
+
+    included do
+      delegate *DELEGATED_METHODS_TO_COMMENTS_RENDERER, to: :comments_renderer
+      helper_method *HELPER_METHODS
+    end
+
+    protected
+
+    def talkie_on(*args)
+      options = args.extract_options!
+      commentable = args[0]
+
+      @comments_renderer ||= Talkie::CommentsRenderer.new(view_context, commentable, options)
+
+      @comments_renderer.render
+    end
+
+    def comments_renderer
+      @comments_renderer
+    end
+  end
+end

data/lib/talkie/version.rb

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

data/talkie.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "talkie/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "talkie"
+  spec.version       = Talkie::VERSION
+  spec.authors       = ["Abraham Kuri"]
+  spec.email         = ["kurenn@icalialabs.com"]
+
+  spec.summary       = %q{A Rails Engine to easily integrate comments}
+  spec.description   = %q{A Rails Engine to easily integrate comments to any model. Provides views and helpful generators}
+  spec.homepage      = "https://github.com/kurenn/talkie"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "ammeter", "~> 1.1"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "jquery-rails", "~> 4.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails-controller-testing", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.8"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "rails-i18n", "~> 5.1"
+
+  spec.add_dependency "rails", "~> 5.0"
+  spec.add_dependency "sassc-rails", "~> 2.1"
+  spec.add_dependency "awesome_nested_set", "~> 3.1"
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: talkie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abraham Kuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_nested_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A Rails Engine to easily integrate comments to any model. Provides views
+  and helpful generators
+email:
+- kurenn@icalialabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/talkie/application.js
+- app/assets/stylesheets/talkie/_comment.scss
+- app/assets/stylesheets/talkie/_form.scss
+- app/assets/stylesheets/talkie/_variables.scss
+- app/assets/stylesheets/talkie/application.scss
+- app/controllers/talkie/comments_controller.rb
+- app/controllers/talkie_controller.rb
+- app/helpers/talkie/application_helper.rb
+- app/models/talkie/comment.rb
+- app/views/talkie/comments/_comment.html.erb
+- app/views/talkie/comments/_form.html.erb
+- app/views/talkie/comments/_template.html.erb
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- config/locales/es.yml
+- config/routes.rb
+- lib/generators/talkie/install_generator.rb
+- lib/generators/talkie/templates/create_talkie_comments.rb
+- lib/generators/talkie/templates/talkie.rb
+- lib/talkie.rb
+- lib/talkie/acts_as_commentable.rb
+- lib/talkie/acts_as_talker.rb
+- lib/talkie/comments_renderer.rb
+- lib/talkie/controller.rb
+- lib/talkie/engine.rb
+- lib/talkie/permission.rb
+- lib/talkie/renderer_helper.rb
+- lib/talkie/version.rb
+- talkie.gemspec
+homepage: https://github.com/kurenn/talkie
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Rails Engine to easily integrate comments
+test_files: []