traq_has_comments 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bcf9e646dee3d24e2ed4009447fc779f923f090
+  data.tar.gz: 3926f0ef4ca6076e2efb1b7299eff0b133f98009
+SHA512:
+  metadata.gz: 891ab329cebc6ee0624d96581d3789d5d8166c94715c2778ea4cd7f72c09c5fc78258c9c5881e02b8fbf909a84049d77824cdd45ef2a3fbfcb42d886d90a067c
+  data.tar.gz: 0983257ec631b7a780df474b437ba7ff6a75739caf6fee2c56b2e2e5a86152fbc6dac4b8b11d9b44d39fd9aeaaddd1d3f021378c7b55931365b65c7889b9a8c0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,5 @@
+
+source 'https://rubygems.org'
+
+# Specify dependencies in traq_has_comments.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,2 @@
+
+Copyright (c) 2014 Michael P. Martin

data/README.md

@@ -0,0 +1,51 @@
+
+# TraqHasComments
+
+Add commenting functionality to any application model.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'traq_has_comments'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traq_has_comments
+
+
+## Usage
+
+Add the comments migration:
+
+    $ rails generate traq_has_comments:install
+
+Then run:
+
+    $ rake db:migrate
+
+Add to each commentable model:
+
+    has_comments
+
+Add to each commenter model:
+
+    authors_comments
+
+Add to the comment owner (e.g., account) model:
+
+    owns_comments
+    
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/traq_has_comments/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+
+require 'bundler/gem_tasks'

data/db/migrate/commentable_migration.rb

@@ -0,0 +1,20 @@
+
+class CommentableMigration < ActiveRecord::Migration
+
+  def change
+    create_table :comments do |t|
+      t.string :title
+      t.text :body
+      t.integer :commentable_id, default: 0
+      t.string :commentable_type
+      t.integer :user_id, default: 0, null: false
+      t.integer :account_id, default: 0, null: false
+
+      t.timestamps
+    end
+
+    add_index :comments, [:commentable_id, :commentable_type]
+    add_index :comments, :user_id
+    add_index :comments, :account_id
+  end
+end

data/lib/generators/traq_has_comments/install_generator.rb

@@ -0,0 +1,20 @@
+
+require 'rails/generators/active_record'
+
+module TraqHasComments
+
+  class InstallGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../../../../db/migrate', __FILE__)
+
+    def create_migrations
+      migration_template 'commentable_migration.rb', 'db/migrate/commentable_migration.rb'
+    end
+
+    def self.next_migration_number(path)
+      @migration_number = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i.to_s
+    end
+  end
+end

data/lib/traq_has_comments.rb

@@ -0,0 +1,14 @@
+
+require 'traq_has_comments/version'
+require 'active_record'
+
+module TraqHasComments
+  require 'traq_has_comments/comment'
+  require 'traq_has_comments/commentable'
+  require 'traq_has_comments/author'
+  require 'traq_has_comments/owner'
+
+  ActiveRecord::Base.extend Commentable
+  ActiveRecord::Base.extend Author
+  ActiveRecord::Base.extend Owner
+end

data/lib/traq_has_comments/author.rb

@@ -0,0 +1,26 @@
+
+module TraqHasComments
+
+  module Author
+
+    extend ActiveSupport::Concern
+
+    def authors_comments
+
+      has_many :comments, class_name: 'TraqHasComments::Comment'
+
+      extend ClassMethods
+      extend SingletonMethods
+      include InstanceMethods
+    end
+
+    module ClassMethods
+    end
+
+    module SingletonMethods
+    end
+
+    module InstanceMethods
+    end
+  end
+end

data/lib/traq_has_comments/comment.rb

@@ -0,0 +1,25 @@
+
+module TraqHasComments
+
+  class Comment < ::ActiveRecord::Base
+
+    belongs_to :commentable, polymorphic: true
+    belongs_to :author, foreign_key: 'user_id', class_name: 'User'
+    belongs_to :owner, foreign_key: 'account_id', class_name: 'Account'
+
+    validates :body, presence: true
+    validates :author, presence: true
+    validates :owner, presence: true
+
+    # TODO: Define methods to check commenting permissions. Consider how to implement admin defined permissions through settings.
+
+    # def can_create_comment?(user)
+    # end
+
+    # def can_update_comment?(user)
+    # end
+
+    # def can_delete_comment?(user)
+    # end
+  end
+end

data/lib/traq_has_comments/commentable.rb

@@ -0,0 +1,38 @@
+
+module TraqHasComments
+
+  module Commentable
+
+    extend ActiveSupport::Concern
+
+    def has_comments
+
+      has_many :comments, as: :commentable, class_name: 'TraqHasComments::Comment'
+
+      extend ClassMethods
+      extend SingletonMethods
+      include InstanceMethods
+    end
+
+    module ClassMethods
+    end
+
+    module SingletonMethods
+
+      def find_comments_for_commentable(account, obj)
+        HasComments::Comment.where(account_id: account.id).where(commentable_id: obj.id, commentable_type: obj.class.base_class).order('created_at DESC')
+      end
+
+      def find_comments_by_user(account, user)
+        HasComments::Comment.where(account_id: account.id).where(user_id: user.id).order('created_at DESC')
+      end
+
+      def find_commentable(obj)
+        obj.class.base_class.find(obj.id)
+      end
+    end
+
+    module InstanceMethods
+    end
+  end
+end

data/lib/traq_has_comments/owner.rb

@@ -0,0 +1,26 @@
+
+module TraqHasComments
+
+  module Owner
+
+    extend ActiveSupport::Concern
+
+    def owns_comments
+
+      has_many :comments, class_name: 'TraqHasComments::Comment'
+
+      extend ClassMethods
+      extend SingletonMethods
+      include InstanceMethods
+    end
+
+    module ClassMethods
+    end
+
+    module SingletonMethods
+    end
+
+    module InstanceMethods
+    end
+  end
+end

data/lib/traq_has_comments/version.rb

@@ -0,0 +1,4 @@
+
+module TraqHasComments
+  VERSION = '0.0.12'
+end

data/spec/author_spec.rb

@@ -0,0 +1,7 @@
+
+require 'spec_helper'
+
+describe User do
+
+  it { should have_many :comments }
+end

data/spec/comment_spec.rb

@@ -0,0 +1,9 @@
+
+require 'spec_helper'
+
+describe TraqHasComments::Comment do
+
+  it { should belong_to :commentable }
+  it { should belong_to :author }
+  it { should belong_to :owner }
+end

data/spec/commentable_spec.rb

@@ -0,0 +1,7 @@
+
+require 'spec_helper'
+
+describe Post do
+
+  it { should have_many :comments }
+end

data/spec/owner_spec.rb

@@ -0,0 +1,7 @@
+
+require 'spec_helper'
+
+describe Account do
+
+  it { should have_many :comments }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+
+require 'traq_has_comments'
+require 'support/database_cleaner'
+require 'support/post'
+require 'support/user'
+require 'support/account'
+require 'database_cleaner'
+require 'shoulda/matchers'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :accounts, force: true do |t|
+    t.string :name
+  end
+
+  create_table :users, force: true do |t|
+    t.string :name
+  end
+
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.text :body
+    t.integer :user_id
+  end
+
+  create_table :comments, force: true do |t|
+    t.string :body
+    t.string :commentable_type
+    t.integer :commentable_id
+    t.integer :user_id
+    t.integer :account_id
+  end
+end

data/spec/support/account.rb

@@ -0,0 +1,5 @@
+
+class Account < ActiveRecord::Base
+
+  owns_comments
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,23 @@
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/post.rb

@@ -0,0 +1,5 @@
+
+class Post < ActiveRecord::Base
+
+  has_comments
+end

data/spec/support/user.rb

@@ -0,0 +1,5 @@
+
+class User < ActiveRecord::Base
+
+  authors_comments
+end

data/traq_has_comments.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'traq_has_comments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'traq_has_comments'
+  spec.version       = TraqHasComments::VERSION
+  spec.authors       = ['Michael P. Martin']
+  spec.email         = ['mmartin@levsrin.com']
+  spec.summary       = 'Add polymorphic comments.'
+  spec.description   = 'Add commenting functionality to any application model.'
+  spec.homepage      = ''
+  spec.license       = ''
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'database_cleaner'
+
+  spec.add_runtime_dependency 'activerecord'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: traq_has_comments
+version: !ruby/object:Gem::Version
+  version: 0.0.12
+platform: ruby
+authors:
+- Michael P. Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: sqlite3
+  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
+  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: database_cleaner
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add commenting functionality to any application model.
+email:
+- mmartin@levsrin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/migrate/commentable_migration.rb
+- lib/generators/traq_has_comments/install_generator.rb
+- lib/traq_has_comments.rb
+- lib/traq_has_comments/author.rb
+- lib/traq_has_comments/comment.rb
+- lib/traq_has_comments/commentable.rb
+- lib/traq_has_comments/owner.rb
+- lib/traq_has_comments/version.rb
+- spec/author_spec.rb
+- spec/comment_spec.rb
+- spec/commentable_spec.rb
+- spec/owner_spec.rb
+- spec/spec_helper.rb
+- spec/support/account.rb
+- spec/support/database_cleaner.rb
+- spec/support/post.rb
+- spec/support/user.rb
+- traq_has_comments.gemspec
+homepage: ''
+licenses:
+- ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Add polymorphic comments.
+test_files:
+- spec/author_spec.rb
+- spec/comment_spec.rb
+- spec/commentable_spec.rb
+- spec/owner_spec.rb
+- spec/spec_helper.rb
+- spec/support/account.rb
+- spec/support/database_cleaner.rb
+- spec/support/post.rb
+- spec/support/user.rb