acts_as_commentable_more 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1a78b63f0d3bf01af29ca0f946959b6254009d1
+  data.tar.gz: d6a5ac305abb6f3bb43091de280da094f14d0774
+SHA512:
+  metadata.gz: 2a93ba75df227b8cc5dc8e9988404b2d7830abe8a4c2cdf3702950ba06fed9c2e432d6eb4cbeee0d42242dcd91cae765f52a71f10c5134eef8a0d09b9e7a3563
+  data.tar.gz: a2b458ec39cd795fd46b69ad3e87739e0038c82e47b4854e370c3d3090b10c8522051054c770a3b72e35cd49a78e82327a2eae817c9df02659ef309ec626339e

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: UcUDq2TUR052ZfBRowsdMHTo1n4pF1uZ7

data/.gitignore

@@ -0,0 +1,48 @@
+
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+test/dummy/config/database.yml
+test/dummy/db/schema.rb
+
+test/dummy/coverage
+
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+test/dummy/config/initializers/secret_token.rb
+ctest/dummy/onfig/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# ignore coverage result file
+test/dummy/coverage/.resultset.json

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 2.0.0
+env: DB=postgres
+
+sudo: true
+
+gemfile: Gemfile
+
+env: DB=postgresql
+
+before_script:
+  - cd test/dummy
+  - cp config/database.travis.yml config/database.yml
+  - bundle install
+  - psql -c 'create database strano_test' -U postgres
+  - bundle exec rake db:create RAILS_ENV=test
+  - bundle exec rake db:migrate RAILS_ENV=test
+  - bundle exec rake db:test:prepare
+
+script: bundle exec rspec
+
+travis encrypt "happio:PFNa84fG9iz9hVr5Q22UNUMo" --add notifications.slack

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+=== Change Log
+
+* v.1.0.0
+- can set comment's types
+- can set association options

data/Gemfile

@@ -0,0 +1,40 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in acts_as_commentable_more.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+group :development do
+  gem 'bullet',         '4.13.2'
+  gem 'spring',         '1.1.3'
+  gem 'mina',           '0.3.0'
+  gem 'hirb',           '0.7.2'
+  gem 'better_errors',  '2.0.0'
+  # gem 'debugger'
+end
+
+group :development, :test do
+  gem 'rspec-rails',            '3.1.0'
+  gem 'capybara',               '2.4.3'
+  gem 'shoulda-matchers',       '2.7.0', require: false
+  gem 'guard-rspec',            '4.3.1'
+  gem 'simplecov',              '0.9.0', require: false
+  gem 'spring-commands-rspec',  '1.0.2'
+  gem 'factory_girl_rails',     '4.4.1'
+  gem 'coveralls', require: false
+end
+
+group :test do
+  # gem 'rspec-sidekiq'
+end

data/Gemfile.lock

@@ -0,0 +1,212 @@
+PATH
+  remote: .
+  specs:
+    acts_as_commentable_more (1.0.0)
+      rails (~> 4.1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.9)
+      actionpack (= 4.1.9)
+      actionview (= 4.1.9)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.9)
+      actionview (= 4.1.9)
+      activesupport (= 4.1.9)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.9)
+      activesupport (= 4.1.9)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.9)
+      activesupport (= 4.1.9)
+      builder (~> 3.1)
+    activerecord (4.1.9)
+      activemodel (= 4.1.9)
+      activesupport (= 4.1.9)
+      arel (~> 5.0.0)
+    activesupport (4.1.9)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    better_errors (2.0.0)
+      coderay (>= 1.0.0)
+      erubis (>= 2.6.6)
+      rack (>= 0.9.0)
+    builder (3.2.2)
+    bullet (4.13.2)
+      activesupport (>= 3.0.0)
+      uniform_notifier (>= 1.6.0)
+    capybara (2.4.3)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    codeclimate-test-reporter (0.4.5)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.4.1)
+      factory_girl (~> 4.4.0)
+      railties (>= 3.0.0)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.10.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hike (1.2.3)
+    hirb (0.7.2)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    listen (2.8.4)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    mina (0.3.0)
+      open4
+      rake
+    mini_portile (0.6.1)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    nenv (0.1.1)
+    netrc (0.10.2)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    open4 (1.3.4)
+    pg (0.18.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.9)
+      actionmailer (= 4.1.9)
+      actionpack (= 4.1.9)
+      actionview (= 4.1.9)
+      activemodel (= 4.1.9)
+      activerecord (= 4.1.9)
+      activesupport (= 4.1.9)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.9)
+      sprockets-rails (~> 2.0)
+    railties (4.1.9)
+      actionpack (= 4.1.9)
+      activesupport (= 4.1.9)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    spring (1.1.3)
+    spring-commands-rspec (1.0.2)
+      spring (>= 0.9.1)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tins (1.3.3)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uniform_notifier (1.6.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_commentable_more!
+  better_errors (= 2.0.0)
+  bullet (= 4.13.2)
+  capybara (= 2.4.3)
+  codeclimate-test-reporter
+  coveralls
+  factory_girl_rails (= 4.4.1)
+  guard-rspec (= 4.3.1)
+  hirb (= 0.7.2)
+  mina (= 0.3.0)
+  pg
+  rake
+  rspec
+  rspec-rails (= 3.1.0)
+  shoulda-matchers (= 2.7.0)
+  simplecov (= 0.9.0)
+  spring (= 1.1.3)
+  spring-commands-rspec (= 1.0.2)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 PiYa
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,16 @@
+= ActsAsCommentableMore
+
+{<img src="https://gemnasium.com/piya23300/acts_as_commentable_more.svg" alt="Dependency Status" />}[https://gemnasium.com/piya23300/acts_as_commentable_more]
+{<img src="https://coveralls.io/repos/piya23300/acts_as_commentable_more/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/piya23300/acts_as_commentable_more]
+
+---
+
+== Generate
+
+  rails generate commentable your_model_name
+or
+{read more about generate}[https://github.com/piya23300/acts_as_commentable_more/tree/develop/lib/generators/commentable/USAGE]
+
+---
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'ActsAsCommentableMore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/acts_as_commentable_more.gemspec

@@ -0,0 +1,36 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "acts_as_commentable_more/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "acts_as_commentable_more"
+  s.version     = ActsAsCommentableMore::VERSION
+  s.authors     = ["piya23300"]
+  s.email       = ["piya23300@gmail.com"]
+  s.homepage    = "https://github.com/piya23300/acts_as_commentable_more"
+  s.summary     = "gem that provides comment functionality."
+  s.description = "gem that provides comment functionality."
+  s.license     = "MIT"
+
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+  s.test_files = Dir["test/**/*"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.autorequire = %q{acts_as_commentable_more}
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+
+  s.add_dependency "rails", "~> 4.1.8"
+
+  s.add_development_dependency "pg"
+  # s.add_development_dependency "acts_as_commentable"
+
+end

data/lib/acts_as_commentable_more/version.rb

@@ -0,0 +1,3 @@
+module ActsAsCommentableMore
+  VERSION = "1.0.0"
+end

data/lib/acts_as_commentable_more.rb

@@ -0,0 +1,4 @@
+module ActsAsCommentableMore
+  require 'commentable_methods'
+  require 'comment_methods'
+end

data/lib/comment_methods.rb

@@ -0,0 +1,19 @@
+module ActsAsCommentableMore::Finders
+  extend ActiveSupport::Concern
+
+  def related_attributes
+    read_attribute(:related_attributes).symbolize_keys
+  end
+  
+  module ClassMethods
+
+    def find_comments_by_user(user, role = nil)
+      attr_finder = { user: user }
+      attr_finder.merge!(role: role.to_s) if role.present?
+      where(attr_finder).order("created_at DESC")
+    end
+    
+  end
+
+
+end 

data/lib/commentable_methods.rb

@@ -0,0 +1,68 @@
+# ActsAsCommentable
+module Happio
+  module Acts #:nodoc:
+    module Commentable #:nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        mattr_accessor :comment_roles
+      end
+
+      module HelperMethods
+        private
+        def define_role_based_inflection(role, join_options)
+          send("define_role_based_inflection_#{Rails.version.first}", role, join_options)
+        end
+
+        def define_role_based_inflection_3(role, options)
+          has_many "#{role.to_s}_comments".to_sym,
+                   has_many_options(role, join_options).merge(:conditions => { role: role.to_s })
+        end
+
+        def define_role_based_inflection_4(role, join_options)
+          has_many "#{role.to_s}_comments".to_sym,
+                   -> { where(role: role.to_s) },
+                   has_many_options(role, join_options)
+        end
+
+        def has_many_options(role, join_options)
+          { :before_add => Proc.new { |x, c| c.role = role.to_s } }.merge(join_options)
+        end
+      end
+
+      module ClassMethods
+        include HelperMethods
+
+        def acts_as_commentable(types: [], options: {})
+          default_options = {as: :commentable, dependent: :destroy, class_name: 'Comment'}
+          default_roles = [:comment]
+
+          association_options = default_options.merge(options.compact)
+          self.comment_roles = (default_roles + types.flatten.compact.map(&:to_sym)).uniq
+          
+          if comment_roles == [:comment]
+            has_many :comments, has_many_options(:comment, association_options)
+          else
+            comment_roles.each do |role|
+              define_role_based_inflection(role, association_options)
+            end
+            class_eval %{
+              def all_comments
+                #{association_options[:class_name].classify.constantize}
+                .where(
+                  #{association_options[:as].to_s + '_id'}: self.id,
+                  #{association_options[:as].to_s + '_type'}: self.class.base_class.name
+                ).order(created_at: :desc)
+              end
+            }
+          end
+          
+        end
+        
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Happio::Acts::Commentable)

data/lib/generators/commentable/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Create <model_name>.rb to app/models/ by using comment.rb template.
+    Create create_<model_name>s.rb to db/migrate by using create_comments.rb template.
+
+Example:
+    rails generate commentable <model_name>
+
+    This will create:
+        app/models/<model_name>.rb
+        db/migrate/<time_stamp>_create_<model_name>s.rb
+

data/lib/generators/commentable/commentable_generator.rb

@@ -0,0 +1,18 @@
+class CommentableGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_acts_as_commentable_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    template "comment.rb", "app/models/#{file_path}.rb"
+    migration_template "create_comments.rb", "db/migrate/create_#{plural_table_name}.rb"
+  end
+
+end

data/lib/generators/commentable/templates/comment.rb

@@ -0,0 +1,17 @@
+
+class <%= class_name %> < ActiveRecord::Base
+  ###################################################################
+  ### To implement commentable add the following line to your model
+  ### acts_as_commentable types: [:hide, :show], options: { class_name: '<%= class_name %>', as: :<%= class_name.demodulize.underscore + "able" %> }
+  
+  ### types is an array of possible comment type
+  ### for example if you have public and private comment
+  ### your types would be [:public, :private]
+
+  include ActsAsCommentableMore::Finders
+
+  belongs_to :<%= class_name.demodulize.underscore + "able" %>, :polymorphic => true
+  belongs_to :user, polymorphic: true
+
+  ###################################################################
+end

data/lib/generators/commentable/templates/create_comments.rb

@@ -0,0 +1,18 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    enable_extension 'hstore'
+
+    create_table :<%= table_name %> do |t|
+      # t.string :title, :limit => 50, :default => "" 
+      t.text :message
+      t.references :<%= class_name.demodulize.underscore + "able" %>, polymorphic: true
+      t.references :user, polymorphic: true, index: true
+      t.string :role, default: nil
+      t.hstore :related_attributes
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, [:<%= class_name.demodulize.underscore + "able" %>_type, :<%= class_name.demodulize.underscore + "able" %>_id],
+     name: :index_<%= plural_name %>_on_<%= class_name.demodulize.underscore %>able_type_and_<%= class_name.demodulize.underscore %>able_id
+  end
+end

data/lib/tasks/acts_as_commentable_more_tasks.rake

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

data/test/acts_as_commentable_more_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActsAsCommentableMoreTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ActsAsCommentableMore
+  end
+end