jakewendt-simply_taggable 0.3.2

data/README.rdoc

@@ -0,0 +1,53 @@
+= Simply Taggable
+
+Introduction goes here.
+
+== TODO
+
+Build generator to install migrations, javascript, stylesheets, tasks, autotest
+
+Generator also creates factory initializer
+
+Build complete tests
+
+Import existing model tests.
+
+Add namable type tags/taggings
+
+
+== Example
+
+Example goes here.
+
+
+
+== Usage
+
+ config.gem 'jakewendt-simply_taggable',
+   :source => 'http://rubygems.org'
+
+ script/generate simply_taggable
+ script/generate simply_taggable_tagger User    <- Maybe
+
+
+== 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
+
+
+== Credit and References
+
+Can't remember which one, but I'm sure that I got much of this from a
+Ryan Bates Railscast.
+
+Copyright (c) 2009 [George 'Jake' Wendt], released under the MIT license

data/app/models/tag.rb

@@ -0,0 +1,36 @@
+class Tag < ActiveRecord::Base
+#	belongs_to :user
+	belongs_to :tagger, :polymorphic => true	#, :counter_cache => true
+	has_many :taggings, :dependent => :destroy
+	has_many :taggables, :through => :taggings
+
+	validates_presence_of :tagger_id, :tagger_type
+	validates_presence_of :name
+	validates_length_of :name, :in => 1..250
+	validates_uniqueness_of :name, :scope => [:tagger_id, :tagger_type]
+
+	attr_accessible :name
+
+	class MultipleTagsFound < StandardError
+		attr_reader :message;
+		def initialize(message="Multiple tags found")
+			@message = message
+		end
+	end
+
+	def before_save
+		name.squish!
+	end
+
+	def self.find_or_create(conditions={})
+		tags = find(:all, :conditions => conditions)
+		case tags.length
+			when 0 
+				self.create!(conditions)
+			when 1 
+				tags[0]
+			else raise MultipleTagsFound.new("Multiple tags found matching #{conditions.inspect}.")
+		end
+	end
+
+end

data/app/models/tagging.rb

@@ -0,0 +1,4 @@
+class Tagging < ActiveRecord::Base
+	belongs_to :taggable, :polymorphic => true
+	belongs_to :tag, :counter_cache => :taggables_count
+end

data/generators/simply_taggable/simply_taggable_generator.rb

@@ -0,0 +1,71 @@
+class SimplyTaggableGenerator < 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_taggable.rb', 'config/autotest/simply_taggable.rb')
+			m.directory('lib/tasks')
+			m.file('simply_taggable.rake', 'lib/tasks/simply_taggable.rake')
+
+			%w( create_tags create_taggings ).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_taggable/templates/autotest_simply_taggable.rb

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

data/generators/simply_taggable/templates/migrations/create_taggings.rb

@@ -0,0 +1,15 @@
+class CreateTaggings < ActiveRecord::Migration
+	def self.up
+		create_table :taggings do |t|
+			t.references :taggable, :polymorphic => true
+			t.references :tag
+			t.timestamps
+		end
+		add_index :taggings, [:taggable_id,:taggable_type], :name => 'by_taggable'
+		add_index :taggings, :tag_id, :name => 'by_tag_id'
+	end
+
+	def self.down
+		drop_table :taggings
+	end
+end

data/generators/simply_taggable/templates/migrations/create_tags.rb

@@ -0,0 +1,15 @@
+class CreateTags < ActiveRecord::Migration
+	def self.up
+		create_table :tags do |t|
+			t.references :tagger, :polymorphic => true
+			t.string     :name
+			t.integer    :taggables_count, :null => false, :default => 0
+			t.timestamps
+		end
+		add_index :tags, [:name,:tagger_id,:tagger_type], :unique => true, :name => 'by_name'
+	end
+
+	def self.down
+		drop_table :tags
+	end
+end

data/generators/simply_taggable/templates/simply_taggable.rake

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

data/lib/jakewendt-simply_taggable.rb

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

data/lib/simply_taggable.rb

@@ -0,0 +1,7 @@
+module SimplyTaggable
+#	predefined namespace
+end
+require 'simply_taggable/base'
+require 'simply_taggable/assertions'
+
+require 'active_support'

data/lib/simply_taggable/assertions.rb

@@ -0,0 +1,33 @@
+module SimplyTaggable::Assertions
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+	module ClassMethods
+
+		def assert_simply_taggable
+
+			test "should be simply taggable" do
+				assert model_name.constantize.new.respond_to?(:tags)
+				assert model_name.constantize.new.respond_to?(:taggings)
+#				self.class.assert_should_have_many :taggings
+#				self.class.assert_should_have_many :tags, :polymorphic => true
+			end
+
+		end
+
+		def assert_simply_taggable_tagger
+
+			test "should be simply taggable tagger" do
+#				self.class.assert_should_have_many :tags, :polymorphic => true
+
+				assert model_name.constantize.new.respond_to?(:tags)
+#				assert model_name.constantize.new.respond_to?(:taggings)
+			end
+
+		end
+	end
+
+end
+require 'active_support'
+require 'active_support/test_case'
+ActiveSupport::TestCase.send(:include,SimplyTaggable::Assertions)

data/lib/simply_taggable/base.rb

@@ -0,0 +1,60 @@
+module SimplyTaggable::Base
+	def self.included(base)
+		base.extend(ClassMethods)
+	end
+
+	module ClassMethods
+
+		def simply_taggable_tagger
+	
+			has_many :tags, 
+				:as => :tagger, 
+				:dependent => :destroy
+
+		end
+
+		def simply_taggable
+
+#	add some options like :by => :user 
+#	in case User isn't the model of choice
+
+			include SimplyTaggable::Base::InstanceMethods
+
+			has_many :taggings, 
+				:as => :taggable, 
+				:dependent => :destroy
+
+			has_many :tags, 
+				:through => :taggings
+
+			attr_writer :tag_names
+			attr_accessible :tag_names
+			after_save :assign_tags
+
+		end
+	end
+
+	module InstanceMethods
+
+		def tag_names
+			@tag_names || tags.map(&:name).join(', ')
+		end
+
+	private
+	
+		def assign_tags
+			if @tag_names
+				self.tags = @tag_names.names_to_array.map do |name|
+					Tag.find_or_create({
+						:name   => name.squish,
+						:tagger => self.tagger
+#						:user_id => self.user_id
+					}) if !name.blank?
+				end
+			end
+		end
+
+	end 
+end
+require 'active_record'
+ActiveRecord::Base.send(:include, SimplyTaggable::Base)

data/lib/simply_taggable/tasks.rb

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

data/lib/simply_taggable/test_tasks.rb

@@ -0,0 +1,48 @@
+module SimplyTaggable;end
+namespace :test do
+	namespace :units do
+		Rake::TestTask.new(:simply_taggable => "db:test:prepare") do |t|
+			t.pattern = File.expand_path(File.join(
+				File.dirname(__FILE__),'/../../test/unit/taggable/*_test.rb'))
+			t.libs << "test"
+			t.verbose = true
+		end
+	end
+	namespace :functionals do
+		Rake::TestTask.new(:simply_taggable => "db:test:prepare") do |t|
+			t.pattern = File.expand_path(File.join(
+				File.dirname(__FILE__),'/../../test/functional/taggable/*_test.rb'))
+			t.libs << "test"
+			t.verbose = true
+		end
+	end
+end
+Rake::Task['test:functionals'].prerequisites.unshift(
+	"test:functionals:simply_taggable" )
+Rake::Task['test:units'].prerequisites.unshift(
+	"test:units:simply_taggable" )
+
+#	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/taggable/'))
+#@gem_test_dirs << File.expand_path(File.join(File.dirname(__FILE__),
+#	'/../../test/functional/taggable/'))
+
+#
+#	More flexible. Find all test files, pick out their dir, uniq 'em and add.
+#
+Dir.glob( File.expand_path(File.join(File.dirname(__FILE__),
+	'/../../test/*/taggable/*_test.rb'))
+).collect{|f|
+	File.dirname(f)
+}.uniq.each{ |dir|
+	@gem_test_dirs << dir
+}

data/lib/tasks/simply_taggable_tasks.rake

@@ -0,0 +1,54 @@
+desc "Explaining what the task does"
+namespace :simply_taggable do
+
+	desc "Install"
+	task :install => [:prep, :update] do
+puts "in install"
+	end
+
+	task :prep => :environment do
+puts "in prep"	#	just once
+#	append require 'simply_taggable/tasks' to Rakefile
+	end
+
+	desc "Update"
+	task :update => :environment do
+puts "in update"
+
+#		FileUtils.mkdir_p('db/migrate') unless File.directory?('db/migrate')
+#		rsync_command = <<-EOF.gsub(/\s+/,' ').squish!
+#			rsync -ruv 
+#			--exclude='*_test_only_*rb'
+#			--exclude='versions'
+#			vendor/plugins/ucb_ccls_engine/db/migrate db
+#		EOF
+#		system rsync_command
+#
+#		FileUtils.mkdir_p('public') unless File.directory?('public')
+#		rsync_command = <<-EOF.gsub(/\s+/,' ').squish!
+#			rsync -ruv 
+#			--exclude='versions'
+#			vendor/plugins/ucb_ccls_engine/public .
+#		EOF
+#		system rsync_command
+#
+#		rsync_command = <<-EOF.gsub(/\s+/,' ').squish!
+#			rsync -ruv 
+#			--exclude='app'
+#			--exclude='assets'
+#			--exclude='config'
+#			--exclude='db'
+#			--exclude='extensions'
+#			--exclude='fixtures'
+#			--exclude='helpers'
+#			--exclude='log'
+#			--exclude='versions'
+#			--exclude='test_helper.rb'
+#			--exclude='engine_\*_test.rb'
+#			vendor/plugins/ucb_ccls_engine/test .
+#		EOF
+#		system rsync_command
+
+	end
+
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'jakewendt-simply_taggable'

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,6 @@
+Factory.define :tag do |f|
+	f.name "Tag Name"
+	f.association :tagger
+end
+Factory.define :tagging do |f|
+end

data/test/unit/post_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PostTest < ActiveSupport::TestCase
+
+	assert_simply_taggable
+
+end

data/test/unit/taggable/tag_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class SimplyTaggable::TagTest < ActiveSupport::TestCase
+
+	assert_should_initially_belong_to :tagger, :polymorphic => true
+	assert_should_have_many :taggings
+
+	assert_should_require :name
+	assert_should_not_protect_attribute :name
+	assert_should_protect_attribute :tagger_id
+	assert_should_protect_attribute :tagger_type
+
+end

data/test/unit/taggable/tagging_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SimplyTaggable::TaggingTest < ActiveSupport::TestCase
+
+	assert_should_belong_to :tag
+	assert_should_belong_to :taggable, :polymorphic => true
+
+end

data/test/unit/user_test.rb

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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: jakewendt-simply_taggable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
+platform: ruby
+authors: 
+- George 'Jake' Wendt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-10 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@jake.otherinbox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- app/models/tag.rb
+- app/models/tagging.rb
+- config/routes.rb
+- generators/simply_taggable/USAGE
+- generators/simply_taggable/simply_taggable_generator.rb
+- generators/simply_taggable/templates/autotest_simply_taggable.rb
+- generators/simply_taggable/templates/migrations/create_taggings.rb
+- generators/simply_taggable/templates/migrations/create_tags.rb
+- generators/simply_taggable/templates/simply_taggable.rake
+- lib/jakewendt-simply_taggable.rb
+- lib/simply_taggable.rb
+- lib/simply_taggable/assertions.rb
+- lib/simply_taggable/base.rb
+- lib/simply_taggable/tasks.rb
+- lib/simply_taggable/test_tasks.rb
+- lib/tasks/simply_taggable_tasks.rake
+- rails/init.rb
+- README.rdoc
+- test/app/controllers/application_controller.rb
+- test/app/models/post.rb
+- test/app/models/user.rb
+- test/factories.rb
+- test/unit/post_test.rb
+- test/unit/taggable/tag_test.rb
+- test/unit/taggable/tagging_test.rb
+- test/unit/user_test.rb
+has_rdoc: true
+homepage: http://github.com/jakewendt/simply_taggable
+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/post_test.rb
+- test/unit/taggable/tag_test.rb
+- test/unit/taggable/tagging_test.rb
+- test/unit/user_test.rb