aeonscope-acts_as_commentable 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= v1.0.0
+
+* Initial version.

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com]
+
+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,116 @@
+= Overview
+
+Allows for comments to be easily added to different models.
+
+= License
+
+Copyright (c) 2009 Brooke Kuhlmann of {Berserk Technologies}[http://www.berserktech.com].
+See the included LICENSE for more info.
+
+= History
+
+See the CHANGELOG file for more info.
+
+= Requirements
+
+1. {Ruby on Rails}[http://rubyonrails.org].
+
+= Installation
+
+Type the following from the command line to install:
+
+* *UNIX*: sudo gem install aeonscope-acts_as_commentable
+* *Windows*: gem install aeonscope-acts_as_commentable
+
+Update your environment.rb file to include the new gem:
+
+* config.gem "aeonscope-acts_as_commentable", :lib => "acts_as_commentable", :source => "http://gems.github.com"
+
+= Usage
+
+Assuming you have created Post and Comment migrations and models, for example, then you can modify your models as follows:
+
+  class Post < ActiveRecord::Base
+    # Behaviors
+    acts_as_commentable
+  end
+
+  class Comment < ActiveRecord::Base
+    # Behaviors
+    acts_as_comment 
+  end
+
+That's it, your done!
+
+As an added bonus, you can customize your comment behavior. For example, lets say you want your comment label to reflect
+your post label (assuming you have "label" columns for both your Post and Comment models). You could then specify the auto_label method
+to be called before you save a comment.  Like so:
+
+  class Comment < ActiveRecord::Base
+    # Behaviors
+    acts_as_comment
+
+    # Callbacks
+    before_save :auto_label
+   end
+
+So if you created a post with a "My Awesome Post" label, then your comment label would end up as "RE: My Awesome Post" label in order
+to preserve comment context.
+
+What's that you say? You don't use "label" columns for your Post and Comment models?  No problem, you can
+change the default behavior as follows:
+
+  class Comment < ActiveRecord::Base
+    # Behaviors
+    acts_as_comment :commentable_label => "title", :comment_label => "title"
+
+    # Callbacks
+    before_save :auto_label
+  end
+
+Now you are using "title" instead "label" columns. To be clear, the "commentable_label" defines the Post model setting, while the "comment_label" defines the Comment model setting.
+
+= Migrations
+
+Based on the Post and Comment models mentioned above, the following migration code might be of interest:
+
+  # Post Migration
+  class CreatePosts < ActiveRecord::Migration
+    def self.up
+      create_table :posts do |t|
+        t.string :name
+        t.string :label
+        t.text :content
+        t.string :visibility
+        t.datetime :published_at
+        t.timestamps
+      end
+    end
+
+    def self.down
+      drop_table :posts
+    end
+  end
+
+  # Comment Migration
+  class CreateComments < ActiveRecord::Migration
+    def self.up
+      create_table :comments do |t|
+        t.integer :commentable_id
+        t.string :commentable_type
+        t.string :label
+        t.text :content
+        t.timestamps
+      end
+    end
+
+    def self.down
+      drop_table :comments
+    end
+  end
+
+= Contact/Feedback/Issues
+
+* {Berserk Technologies}[http://www.berserktech.com] - Company web site.
+* Aeonscope[http://www.aeonscope.net] - Personal web site.
+* Twitter[http://www.twitter.com/Aeonscope] - Short bursts of insight and/or noise.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_commentable"
+    gem.summary = "Allows for comments to be easily added to different models."
+    gem.description = "Allows for comments to be easily added to different models."
+    gem.authors = ["Brooke Kuhlmann"]
+    gem.email = "aeonscope@gmail.com"
+    gem.homepage = "http://github.com/aeonscope/acts_as_commentable"
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "rails", ">= 2.3.2"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+		gem.files = FileList["[A-Z]*", "{bin,lib,generators,rails_generators,spec}/**/*"]
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_commentable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 1
+:minor: 0

data/lib/acts_as_commentable.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "class_methods.rb")
+require File.join(File.dirname(__FILE__), "instance_methods.rb")
+
+module ActsAsComment
+  def self.included base
+    base.extend ClassMethods
+  end
+  include InstanceMethods
+end
+
+module ActsAsCommentable
+  def self.included base
+    base.extend ClassMethods
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActsAsComment, ActsAsCommentable }

data/lib/class_methods.rb

@@ -0,0 +1,20 @@
+module ActsAsComment
+	module ClassMethods
+    # Allows one to customize the default settings. Accepts the following options hash:
+  	# * *commentable_label* - The commentable (parent object) label method. Optional. Defaults to: label.
+  	# * *comment_label* - The comment label method. Optional. Defaults to: label.
+		def acts_as_comment options = {}
+      write_inheritable_attribute :acts_as_comment_options, options
+      class_inheritable_reader :acts_as_comment_options
+			belongs_to :commentable, :polymorphic => true
+		end
+	end
+end
+
+module ActsAsCommentable
+	module ClassMethods
+    def acts_as_commentable
+      has_many :comments, :as => :commentable, :dependent => :destroy
+    end
+  end
+end

data/lib/instance_methods.rb

@@ -0,0 +1,15 @@
+module ActsAsComment
+  module InstanceMethods
+	  # Before saving, store the comment label as as reply of the commentable label. This especially useful
+	  # when representing context origin (i.e. a syndicated comment feed).
+	  def auto_label
+		  # Set up defaults and custom options (if any).
+			options = self.class.acts_as_comment_options || {}
+			options.reverse_merge! :commentable_label => "label", :comment_label => "label"
+			# Default the comment label to the commentable label.
+	    if self.instance_eval("self.#{options[:comment_label]}").blank? && commentable && commentable.respond_to?(options[:commentable_label])
+				instance_eval("self.#{options[:comment_label]} = "RE: " + commentable.#{options[:commentable_label]}")
+			end
+	  end
+  end 
+end

data/spec/acts_as_commentable_spec.rb

@@ -0,0 +1,7 @@
+#require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe "ActsAsCommentable" do
+  it "should be testable" do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_commentable'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: aeonscope-acts_as_commentable
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Allows for comments to be easily added to different models.
+email: aeonscope@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/acts_as_commentable.rb
+- lib/class_methods.rb
+- lib/instance_methods.rb
+- spec/acts_as_commentable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/aeonscope/acts_as_commentable
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- CHANGELOG.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows for comments to be easily added to different models.
+test_files: 
+- spec/acts_as_commentable_spec.rb
+- spec/spec_helper.rb