commentable_on 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 977c9733dc850169abece4df1029b7d41777b97138b2a2abbd9df4224118e81c
+  data.tar.gz: b0cbcf3f8ede3685d03dc4bf706bace452cbe8c95ee1ff58e141b66d4c451875
+SHA512:
+  metadata.gz: 2c1c4b801b7a65535a9e8595c15d94745d0cad32506264ba33647c5515d98b5bdee4fa81bea0c73861eaeeb6ca0b41f620b6facd26f2b8a033da36965c3a099e
+  data.tar.gz: 60dea80bd2cf24badd245fe637d3345837a26d7a9b7c8e0caadfbc9188a8396be82fd41ac9f51b6d32cf5a8a3a5d550df2aab5d23137d2e12467b9dd5d74c979

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE generated files
+.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - standard
+  - rubocop-rspec
+  - rubocop-rake
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - public/**/*
+    - vendor/**/*
+    - config/**/*
+    - db/schema.rb
+  TargetRubyVersion: 2.7.4
+
+RSpec:
+  Enabled: true # enable rubocop-rspec cops
+RSpec/DescribeClass:
+  Enabled: false # ignore missing comments on classes
+Bundler/DuplicatedGem:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thesamuelralak@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in commentable_on.gemspec
+gemspec
+
+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
+gem "rubocop-rake", "~> 0.6.0", require: false

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    commentable_on (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.5.3)
+      mini_portile2 (~> 2.8.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 7.0)
+  commentable_on!
+  factory_bot (~> 6.2)
+  rake (~> 12.0)
+  rspec (~> 3.6)
+  rubocop (= 1.35.1)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec
+  sqlite3 (~> 1.5)
+  standard (~> 1.16, >= 1.16.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Samuel Ralak
+
+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,84 @@
+# _**Under active development**_
+
+# Commentable On Steroids 
+
+Adds comments functionality to Rails/ActiveRecord modules
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'commentable_on'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install commentable_on
+
+## Database migrations
+
+Generate migration and run migrations
+
+```shell
+rails generate commentable_on:migration
+rails db:migrate
+```
+
+## Usage
+
+Make model commentable
+
+```ruby
+class Post < ActiveRecord::Base
+  acts_as_commentable
+end
+```
+
+Add a comment to model instance:
+  ```ruby
+  @post = Post.find(params[:post_id])
+  @post.add_comment(commenter: current_user, body: "Awesome")
+   ```
+
+The commenter, add `acts_as_commenter` to commenter models for reserve functionality
+```ruby
+class User < ActiveRecord::Base
+  acts_as_commenter
+end
+```
+
+Add comment as a commenter
+```ruby
+@post = Post.find(params[:post_id])
+current_user.comment(commentable: @post, body: "awesome")
+```
+  
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/commentable_on. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/commentable_on/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CommentableOn project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/commentable_on/blob/master/CODE_OF_CONDUCT.md).
+
+## TO DO
+
+- [ ] Add comment threading
+- [ ] Add migration generators 
+- [ ] Automate gem release 

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "commentable_on"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/commentable_on.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/commentable_on/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "commentable_on"
+  spec.version = CommentableOn::VERSION
+  spec.authors = ["Samuel Ralak"]
+  spec.email = ["thesamuelralak@gmail.com"]
+
+  spec.summary = "Provides comment functionality with replies"
+  spec.description = "Placeholder description text explaining how commentable on steroids will save the world in 5 words or less"
+  spec.homepage = "https://github.com/samuelralak/commentable-on"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/samuelralak/commentable-on"
+  spec.metadata["changelog_uri"] = "https://github.com/samuelralak/commentable-on"
+
+  # 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"]
+end

data/lib/commentable_on/comment.rb

@@ -0,0 +1,13 @@
+module CommentableOn
+  class Comment < ::ActiveRecord::Base
+    if defined?(ProtectedAttributes)
+      attr_accessible :commentable_id, :commentable_type, :commenter_id, :commenter_type, :commentable, :commenter, :body
+    end
+
+    belongs_to :commentable, polymorphic: true
+    belongs_to :commenter, polymorphic: true
+
+    validates_presence_of :commentable_id
+    validates_presence_of :commenter_id
+  end
+end

data/lib/commentable_on/commentable.rb

@@ -0,0 +1,18 @@
+module CommentableOn
+  module Commentable
+    def self.included(base)
+      base.class_eval do
+        has_many :comments, class_name: "CommentableOn::Comment", as: :commentable, dependent: :delete_all do
+          def commenters
+            includes(:commenter).map(&:commenter)
+          end
+        end
+      end
+    end
+
+    def add_comment(commenter:, body:)
+      comment = CommentableOn::Comment.new(commentable: self, commenter: commenter, body: body)
+      comment.save
+    end
+  end
+end

data/lib/commentable_on/commenter.rb

@@ -0,0 +1,17 @@
+module CommentableOn
+  module Commenter
+    def self.included(base)
+      base.class_eval do
+        has_many :comments, class_name: "CommentableOn::Comment", as: :commenter, dependent: :nullify do
+          def commentables
+            includes(:commentable).map(&:commentable)
+          end
+        end
+      end
+    end
+
+    def comment(commentable:, body:)
+      commentable.add_comment args.merge(commenter: self, body: body)
+    end
+  end
+end

data/lib/commentable_on/extenders/commentable.rb

@@ -0,0 +1,19 @@
+module CommentableOn
+  module Extenders
+    module Commentable
+      def commentable?
+        false
+      end
+
+      def acts_as_commentable(*_args)
+        include CommentableOn::Commentable
+
+        class_eval do
+          def self.commentable?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commentable_on/extenders/commenter.rb

@@ -0,0 +1,19 @@
+module CommentableOn
+  module Extenders
+    module Commenter
+      def commenter?
+        false
+      end
+
+      def acts_as_commenter(*_args)
+        include CommentableOn::Commenter
+
+        class_eval do
+          def self.commenter?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/commentable_on/extenders.rb

@@ -0,0 +1,8 @@
+module CommentableOn
+  module Extenders
+    extend ActiveSupport::Autoload
+
+    autoload :Commentable
+    autoload :Commenter
+  end
+end

data/lib/commentable_on/version.rb

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

data/lib/commentable_on.rb

@@ -0,0 +1,20 @@
+require "active_record"
+require "active_support/inflector"
+require "active_support/dependencies/autoload"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module CommentableOn
+  extend ActiveSupport::Autoload
+  class Error < StandardError; end
+
+  autoload :Commentable
+  autoload :Comment
+  autoload :Commenter
+  autoload :Extenders
+
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.extend CommentableOn::Extenders::Commentable
+    ActiveRecord::Base.extend CommentableOn::Extenders::Commenter
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: commentable_on
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Ralak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-16 00:00:00.000000000 Z
+dependencies: []
+description: Placeholder description text explaining how commentable on steroids will
+  save the world in 5 words or less
+email:
+- thesamuelralak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- commentable_on.gemspec
+- lib/commentable_on.rb
+- lib/commentable_on/comment.rb
+- lib/commentable_on/commentable.rb
+- lib/commentable_on/commenter.rb
+- lib/commentable_on/extenders.rb
+- lib/commentable_on/extenders/commentable.rb
+- lib/commentable_on/extenders/commenter.rb
+- lib/commentable_on/version.rb
+homepage: https://github.com/samuelralak/commentable-on
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/samuelralak/commentable-on
+  source_code_uri: https://github.com/samuelralak/commentable-on
+  changelog_uri: https://github.com/samuelralak/commentable-on
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Provides comment functionality with replies
+test_files: []