jakewendt-simply_commentable 0.2.1

data/README.rdoc

@@ -0,0 +1,38 @@
+= Simply Commentable
+
+== Usage
+
+ config.gem 'jakewendt-simply_commentable',
+   :source => 'http://rubygems.org'
+
+ # Create generator to install the migrations, javascript, stylesheets, 
+ # Rakefile, autotest, initializers, factory initializer
+ #  config/initializer/simply_commentable_post
+ script/generate simply_commentable Post
+
+ #	Generator also creates factory initializer
+ #  config/initializer/simply_commentable_commenter_user
+ script/generate simply_commentable_commenter User
+
+== ToDo
+
+
+== Reference and Credits
+
+acts_as_commentable
+
+== Gemified with Jeweler
+
+ vi Rakefile
+ rake version:write
+
+ rake version:bump:patch
+ rake version:bump:minor
+ rake version:bump:major
+
+ rake gemspec
+
+ rake install
+ rake release
+
+Copyright (c) 2010 [Jake Wendt], released under the MIT license

data/app/models/comment.rb

@@ -0,0 +1,36 @@
+class Comment < ActiveRecord::Base
+	belongs_to :commenter,   :polymorphic => true, :counter_cache => true
+	belongs_to :commentable, :polymorphic => true, :counter_cache => true
+
+	validates_presence_of :body
+	validates_length_of :body, :in => 1..250
+	attr_accessible :body
+	
+	# Helper class method to lookup all comments assigned
+	# to all commentable types for a given commenter.
+	def self.find_comments_by_commenter(commenter)
+		find(:all,
+			:conditions => ["commenter_type = ? and commenter_id = ?", 
+				commenter.class.name, commenter.id],
+			:order => "created_at DESC"
+		)
+	end
+	
+	# Helper class method to look up all comments for 
+	# commentable class name and commentable id.
+#	def self.find_comments_for_commentable(commentable_str, commentable_id)
+	def self.find_comments_for_commentable(commentable)
+		find(:all,
+			:conditions => ["commentable_type = ? and commentable_id = ?", 
+				commentable.class.name, commentable.id],
+			:order => "created_at DESC"
+		)
+	end
+
+	# Helper class method to look up a commentable object
+	# given the commentable class name and id 
+#	def self.find_commentable(commentable_str, commentable_id)
+	def self.find_commentable(commentable)
+		commentable.class.name.constantize.find(commentable.id)
+	end
+end

data/generators/simply_commentable/simply_commentable_generator.rb

@@ -0,0 +1,72 @@
+class SimplyCommentableGenerator < Rails::Generator::Base
+
+	def manifest
+		#	See Rails::Generator::Commands::Create
+		#	rails-2.3.10/lib/rails_generator/commands.rb
+		#	for code methods for record (Manifest)
+		record do |m|
+			m.directory('config/autotest')
+			m.file('autotest_simply_commentable.rb', 'config/autotest/simply_commentable.rb')
+			m.directory('lib/tasks')
+			m.file('simply_commentable.rake', 'lib/tasks/simply_commentable.rake')
+
+			%w( create_comments ).each do |migration|
+				m.migration_template "migrations/#{migration}.rb",
+					'db/migrate', :migration_file_name => migration
+			end
+
+			m.directory('public/javascripts')
+			Dir["#{File.dirname(__FILE__)}/templates/javascripts/*js"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/javascripts/#{File.basename(file)}")
+			}
+
+			m.directory('public/stylesheets')
+			Dir["#{File.dirname(__FILE__)}/templates/stylesheets/*css"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/stylesheets/#{File.basename(file)}")
+			}
+
+#			m.directory('test/functional/pages')
+#			Dir["#{File.dirname(__FILE__)}/templates/functional/*rb"].each{|file| 
+#				f = file.split('/').slice(-2,2).join('/')
+#				m.file(f, "test/functional/pages/#{File.basename(file)}")
+#			}
+#			m.directory('test/unit/pages')
+#			Dir["#{File.dirname(__FILE__)}/templates/unit/*rb"].each{|file| 
+#				f = file.split('/').slice(-2,2).join('/')
+#				m.file(f, "test/unit/pages/#{File.basename(file)}")
+#			}
+		end
+	end
+
+end
+module Rails::Generator::Commands
+	class Create
+		def migration_template(relative_source, 
+				relative_destination, template_options = {})
+			migration_directory relative_destination
+			migration_file_name = template_options[
+				:migration_file_name] || file_name
+			if migration_exists?(migration_file_name)
+				puts "Another migration is already named #{migration_file_name}: #{existing_migrations(migration_file_name).first}: Skipping" 
+			else
+				template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", template_options)
+			end
+		end
+	end #	Create
+	class Base
+	protected
+		#	the loop through migrations happens so fast
+		#	that they all have the same timestamp which
+		#	won't work when you actually try to migrate.
+		#	All the timestamps MUST be unique.
+		def next_migration_string(padding = 3)
+			@s = (!@s.nil?)? @s.to_i + 1 : if ActiveRecord::Base.timestamped_migrations
+				Time.now.utc.strftime("%Y%m%d%H%M%S")
+			else
+				"%.#{padding}d" % next_migration_number
+			end
+		end
+	end	#	Base
+end

data/generators/simply_commentable/templates/autotest_simply_commentable.rb

@@ -0,0 +1,2 @@
+#	From `script/generate simply_commentable` ...
+require 'simply_commentable/autotest'

data/generators/simply_commentable/templates/migrations/create_comments.rb

@@ -0,0 +1,17 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.integer :commenter_id
+      t.string :commenter_type
+      t.integer :commentable_id
+      t.string :commentable_type
+      t.text :body
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/generators/simply_commentable/templates/simply_commentable.rake

@@ -0,0 +1,5 @@
+#	From `script/generate simply_commentable` ...
+unless Gem.source_index.find_name('jakewendt-simply_commentable').empty?
+	gem 'jakewendt-simply_commentable'
+	require 'simply_commentable/test_tasks'
+end

data/lib/jakewendt-simply_commentable.rb

@@ -0,0 +1 @@
+require 'simply_commentable'

data/lib/simply_commentable.rb

@@ -0,0 +1,7 @@
+module SimplyCommentable
+#	predefine namespace
+end
+require 'simply_commentable/base'
+require 'simply_commentable/assertions'
+
+require 'active_support'

data/lib/simply_commentable/assertions.rb

@@ -0,0 +1,26 @@
+module SimplyCommentable::Assertions
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+	module ClassMethods
+		def assert_simply_commentable
+#			assert_should_have_many :comments, :polymorphic => true
+			test "should be simply commentable" do
+				assert model_name.constantize.new.respond_to?(:comments)
+#				self.class.assert_should_have_many :comments, :polymorphic => true
+			end
+		end
+		def assert_simply_commentable_commenter
+#			assert_should_have_many :comments, :polymorphic => true
+			test "should be simply commentable commenter" do
+				assert model_name.constantize.new.respond_to?(:comments)
+#				self.class.assert_should_have_many :comments, :polymorphic => true
+			end
+		end
+	end
+	module InstanceMethods
+	end
+end
+require 'active_support'
+require 'active_support/test_case'
+ActiveSupport::TestCase.send(:include,SimplyCommentable::Assertions)

data/lib/simply_commentable/base.rb

@@ -0,0 +1,29 @@
+module SimplyCommentable::Base
+
+	def self.included(base)
+		base.extend ClassMethods	
+	end
+
+	module ClassMethods
+		def simply_commentable_commenter
+
+			has_many :comments, 
+				:as => :commenter, 
+				:dependent => :destroy, 
+				:order => 'created_at ASC'
+
+		end
+		def simply_commentable
+
+			has_many :comments, 
+				:as => :commentable, 
+				:dependent => :destroy, 
+				:order => 'created_at ASC'
+
+		end
+	end
+			
+end	#	module SimplyCommentable::Base
+
+require 'active_record'
+ActiveRecord::Base.send(:include, SimplyCommentable::Base)

data/lib/simply_commentable/tasks.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/../tasks/**/*.rake"].sort.each { |ext| load ext }

data/lib/simply_commentable/test_tasks.rb

@@ -0,0 +1,38 @@
+module SimplyCommentable;end
+namespace :test do
+	namespace :units do
+		Rake::TestTask.new(:simply_commentable => "db:test:prepare") do |t|
+			t.pattern = File.expand_path(File.join(
+				File.dirname(__FILE__),'/../../test/unit/commentable/*_test.rb'))
+			t.libs << "test"
+			t.verbose = true
+		end
+	end
+	namespace :functionals do
+		Rake::TestTask.new(:simply_commentable => "db:test:prepare") do |t|
+			t.pattern = File.expand_path(File.join(
+				File.dirname(__FILE__),'/../../test/functional/commentable/*_test.rb'))
+			t.libs << "test"
+			t.verbose = true
+		end
+	end
+end
+Rake::Task['test:functionals'].prerequisites.unshift(
+	"test:functionals:simply_commentable" )
+Rake::Task['test:units'].prerequisites.unshift(
+	"test:units:simply_commentable" )
+
+#	I thought of possibly just including this file
+#	but that would make __FILE__ different.
+#	Hmmm
+
+#
+#	used in simply_helpful's rake test:coverage to run gem's 
+#		tests in the context of the application
+#
+@gem_test_dirs ||= []
+@gem_test_dirs << File.expand_path(File.join(File.dirname(__FILE__),
+	'/../../test/unit/commentable/'))
+@gem_test_dirs << File.expand_path(File.join(File.dirname(__FILE__),
+	'/../../test/functional/commentable/'))
+

data/lib/tasks/simply_commentable_tasks.rake

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

data/test/app/controllers/application_controller.rb

@@ -0,0 +1,11 @@
+class ApplicationController < ActionController::Base
+
+	def redirections
+		@redirections ||= HashWithIndifferentAccess.new({
+			:not_be_user => {
+				:redirect_to => user_path(current_user)
+			}
+		})
+	end
+
+end

data/test/app/models/post.rb

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

data/test/app/models/user.rb

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

data/test/factories.rb

@@ -0,0 +1,7 @@
+Factory.define :comment do |f|
+	f.body "My Comment"
+end
+Factory.define :post do |f|
+end
+Factory.define :user do |f|
+end

data/test/unit/commentable/comment_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class SimplyCommentable::CommentTest < ActiveSupport::TestCase
+
+	assert_should_belong_to :commenter, :polymorphic => true
+	assert_should_belong_to :commentable, :polymorphic => true
+	assert_should_require :body
+#	assert_should_require_attribute_length(:body,:in => 1..250)
+	assert_should_require_attribute_length(:body,:minimum => 1, :maximum => 250)
+	assert_should_not_protect_attribute :body
+	assert_should_protect_attribute :commenter_id
+	assert_should_protect_attribute :commenter_type
+	assert_should_protect_attribute :commentable_id
+	assert_should_protect_attribute :commentable_type
+
+	test "should find_comments_by_commenter" do
+pending
+	end
+
+	test "should find_comments_for_commentable" do
+pending
+	end
+
+	test "should find_commentable" do
+pending
+	end
+
+end

data/test/unit/post_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class PostTest < ActiveSupport::TestCase
+
+	assert_simply_commentable
+
+end

data/test/unit/user_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class UserTest < ActiveSupport::TestCase
+
+	assert_simply_commentable_commenter
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: jakewendt-simply_commentable
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- George 'Jake' Wendt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jakewendt-rails_extension
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: longer description of your gem
+email: github@jakewendt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- app/models/comment.rb
+- config/routes.rb
+- generators/simply_commentable/USAGE
+- generators/simply_commentable/simply_commentable_generator.rb
+- generators/simply_commentable/templates/autotest_simply_commentable.rb
+- generators/simply_commentable/templates/migrations/create_comments.rb
+- generators/simply_commentable/templates/simply_commentable.rake
+- lib/jakewendt-simply_commentable.rb
+- lib/simply_commentable.rb
+- lib/simply_commentable/assertions.rb
+- lib/simply_commentable/base.rb
+- lib/simply_commentable/tasks.rb
+- lib/simply_commentable/test_tasks.rb
+- lib/tasks/simply_commentable_tasks.rake
+- README.rdoc
+- test/app/controllers/application_controller.rb
+- test/app/models/post.rb
+- test/app/models/user.rb
+- test/factories.rb
+- test/unit/commentable/comment_test.rb
+- test/unit/post_test.rb
+- test/unit/user_test.rb
+has_rdoc: true
+homepage: http://github.com/jakewendt/simply_commentable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: one-line summary of your gem
+test_files: 
+- test/app/controllers/application_controller.rb
+- test/app/models/post.rb
+- test/app/models/user.rb
+- test/factories.rb
+- test/unit/commentable/comment_test.rb
+- test/unit/post_test.rb
+- test/unit/user_test.rb