acts_as_debatable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 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.md

@@ -0,0 +1,76 @@
+Acts\_as\_debatable
+===================
+
+This plugin is still on its pre-alpha stage, which means that you may use it on your own risk.
+
+## Install
+
+First of all you'll need to add some gems. Add this to your app's Gemfile **before** adding this gem:
+
+    gem 'devise'
+    gem 'ancestry'
+
+then add:
+
+    gem 'acts_as_debatable', :git => 'git://github.com/espresse/acts_as_debatable.git'
+
+Run
+
+    bundle install
+    rails g acts_as_debatable:migrations
+    rake db:migrate
+
+Now you're ready to rock your models.
+
+## Use
+
+To all models that you desired having comments add this line
+
+    acts_as_debatable
+
+additionaly, to your User model add
+
+    acts_as_debater
+
+So far so good. Next, let's show comments  on the page.
+
+In your show.html.erb file add these partials:
+
+   <%= render :partial => "comments/show", :locals => {:model => @article} %>
+   <%= render :partial => "comments/form", :locals => {:model => @article} %>
+Change @article according to your model variable.
+
+You can overwrite them in yours app/views/comments/.
+
+As there is no autoinstall yet, you have to copy all files from public/* to your app public folder. This will change in future versions.
+
+You can also use those methods:
+
+Your\_class.latest\_debate - this will give you 10 last comments on Model
+Your\_class.count\_comments - self-explaining; a number of all comments on Model
+
+@your\_class\_object.has\_comments? - returns true if there is at least one comment and false if not
+@your\_class\_object.latest\_debate - returns last 10 comments for this object
+
+## I18n
+
+Take a look at config/locales/en.yml in this gem. You'll need to translate the file to have it localized.
+
+## TODO
+
+- better db indexing
+- better validation
+- comments approval system
+- CSS/JS
+- better use of ancestry gem
+- ajax for creating/updating comments
+- akismet spam checking
+- recaptcha
+- User model should have a field username/login/full_name, now we are displaying user's email address, which is not so wise...
+- for approval there's a need to have an admin field in User's model?
+
+##Bugs? Features?
+
+Please post an issue on http://github.com/espresse/acts_as_debatable/issues
+
+Copyright © 2011 Michał Ostrowski, released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+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
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Acts_as_debatable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/acts_as_debatable/debate.rb

@@ -0,0 +1,41 @@
+module ActsAsDebatable
+  module Debate
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_debatable(options = {})
+        has_many :comments, :as => :commentable, :dependent => :destroy
+      end
+
+      def acts_as_debater
+	has_many :comments
+      end
+
+      def latest_debate
+	Comment.where(:commentable_type => self.name).order("created_at desc").limit(10)
+      end
+
+      def count_comments
+	Comment.where(:commentable_type => self.name).count
+      end
+    end
+
+    def has_comments?
+      if self.comments.count > 0
+	true
+      else
+	false
+      end
+    end
+
+    def latest_debate
+      self.comments.order("created_at desc").limit(10)
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsDebatable::Debate

data/lib/acts_as_debatable.rb

@@ -0,0 +1,23 @@
+require 'acts_as_debatable/debate'
+
+module ActsAsDebatable
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+
+    end
+
+    config.to_prepare do
+      ApplicationController.helper(CommentsHelper)
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+  end
+end
+

data/lib/generators/acts_as_debatable/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module ActsAsDebatable
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for Comment method"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/acts_as_debatable_migration'
+      end
+    end
+  end
+end

data/lib/generators/acts_as_debatable/templates/active_record/migration.rb

@@ -0,0 +1,38 @@
+class ActsAsDebatableMigration < ActiveRecord::Migration
+  def self.up
+
+    create_table :comments do |t|
+
+      t.references :commentable, :polymorphic => true
+
+      t.text :content
+      
+      #this is for anonymous users
+      t.string :author 
+      t.string :author_email
+      t.string :author_url
+      t.string :user_ip
+      t.string :user_agent
+      
+      #this is for logged users
+      t.integer :user_id
+      
+      #we use ancestry!
+      t.string :ancestry
+      t.integer :ancestry_depth, :default => 0
+
+      #for akismet
+      t.boolean :spam
+
+      #if user is not registered site owner has to approve the comment
+      t.boolean :approved
+
+      t.timestamps
+    end
+    add_index :comments, :ancestry
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_debatable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michal Ostrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Ruby on Rails gem to provide simple and easy commenting system for any model.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/acts_as_debatable/migration_generator.rb
+- lib/generators/acts_as_debatable/templates/active_record/migration.rb
+- lib/acts_as_debatable/debate.rb
+- lib/acts_as_debatable.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Comment system for Ruby On Rails
+test_files: []
+