acts_as_taggable_simple 0.0.2

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.5'
+gem 'rspec'
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,21 @@
+Gemfile
+MIT-LICENSE
+README.rdoc
+Rakefile
+acts_as_taggable_simple.gemspec
+init.rb
+lib/active_record/acts/taggable.rb
+lib/acts_as_taggable_simple.rb
+lib/generators/acts_as_taggable_simple/migration/migration_generator.rb
+lib/generators/acts_as_taggable_simple/migration/templates/active_record/migration.rb
+lib/tag.rb
+lib/tag_list.rb
+lib/tagging.rb
+spec/acts_as_taggable_simple/acts_as_taggable_simple_spec.rb
+spec/acts_as_taggable_simple/spec_helper.rb
+spec/acts_as_taggable_simple/taggable_spec.rb
+spec/database.yml
+spec/models.rb
+spec/schema.rb
+spec/spec_helper.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,118 @@
+= ActsAsTaggableSimple
+
+=== Overview
+
+ActsAsTaggableSimple provides an +acts_as+ style method to
+ActiveRecord::Base for taggable records. It also provides
+the following methods to a taggable model:
+
+* tag_list - returns an Array of tag String objects
+* tag_list= - takes either a String of tags or an array of tag String objects and sets the tags for the object
+
+acts_as_taggable provides two new attributes for a model:
+
+* tags - the ActsAsTaggable::Tag objects associated with the taggable item
+* taggings - the ActsAsTaggable::Tagging join objects associated with the taggable item
+
+
+=== Installation
+
+For Rails 3 applications you should add the following
+line to your Gemfile:
+    gem 'acts_as_taggable_simple'
+Then run:
+    bundle install
+
+You then need to run the migration generator to generate
+the necessary migration for acts_as_taggable_simple to
+work properly.
+    rails generate acts_as_taggable_simple:migration
+
+Next, run the migration. NOTE: you cannot have a table
+named +tags+ or *taggings*, as these names are used by
+acts_as_taggable_simple.
+    rake db:migrate
+
+That's it, you are ready to start using the gem.
+
+
+=== Getting Started
+
+This is a walkthrough for setting up and using a
+taggable model. We will be creating an application
+for taking notes that we want to tag for easy searching
+later on.
+
+The first step is to make our ActiveRecord model
+taggable.
+    class Note < ActiveRecord::Base
+        attr_accessible :content
+        acts_as_taggable
+    end
+
+We can then create a new note in the usual manner.
+    note = Note.new :content => "acts_as_taggable_simple is so simple!"
+
+We can give the note tags.
+    note.tag_list = "rails tags gem"
+
+We can also give the note tags by passing an Array of String's.
+    note.tag_list = %w{rails tags gem}
+
+We can retrieve an Array of tag String's for our note.
+    note.tag_list  # returns ["rails", "tags", "gem"]
+
+Note that our note will not be tagged until we save it.
+    note.save
+
+Now when we retrieve our note from active record,
+it will retain the tags we have given it.
+
+If necessary we can directly manipulate a note's tag objects.
+This should not be necessary though, and for normal use we can
+do all of our tag editing through tag_list.
+    note.tags << ActsAsTaggableSimple::Tag.new :name => 'why_did_we_do_this?'
+
+We can also manipulate the join objects by accessing taggings on a note.
+Again, there is usually never a need to do this.
+    note.taggings  # returns all of the ActsAsTaggableSimple::Tagging objects for our note
+
+This is all we can do with this gem. Things like searching are left to
+the user or solutions like:
+http://github.com/ernie/meta_search
+
+If you want to do cloud calculations on tags, this task is left to you.
+
+
+=== Example
+
+app/models/taggable_model.rb
+
+    class TaggableModel < ActiveRecord::Base
+        acts_as_taggable
+    end
+
+
+rails console
+
+    t = TaggableModel.new :tag_list => "rails css javascript"
+    t.save
+    t.tag_list # returns ["rails", "css", "javascript"]
+    t.tag_list = "rails html js"
+    t.save
+    t.tag_list # returns ["rails", "html", "js"]
+    # note that tag_list is updated immediately after setting
+    # it, while tags and taggings are only updated after
+    # saving the model
+
+
+=== Credits/Thanks
+
+Many thank you's to the creators of the acts-as-taggable-on gem, which
+if it was not obvious, this gem borrows quite heavily
+from. This gem is in fact meant to be a stripped down
+version of acts-as-taggable-on.
+
+=== Copyright
+
+Copyright (c) 2011 Hollin R. Wilkins, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'echoe'
+require 'rubygems'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  pattern = "spec/**/*_spec.rb"
+end
+
+desc 'Test the acts_as_taggable_simple plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_taggable_simple plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsTaggableSimple'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Echoe.new('acts_as_taggable_simple', '0.0.2') do |p|
+  p.description     = "Adds acts_as_taggable to ActiveRecord::Model to easily tag objects, no extra fluff"
+  p.url             = "http://github.com/chromaticbum/acts_as_taggable_simple"
+  p.author          = "Hollin R. Wilkins"
+  p.email           = "chromaticbum @nospam@ gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/acts_as_taggable_simple.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_taggable_simple}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hollin R. Wilkins"]
+  s.date = %q{2011-04-10}
+  s.description = %q{Adds acts_as_taggable to ActiveRecord::Model to easily tag objects, no extra fluff}
+  s.email = %q{chromaticbum @nospam@ gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/active_record/acts/taggable.rb", "lib/acts_as_taggable_simple.rb", "lib/generators/acts_as_taggable_simple/migration/migration_generator.rb", "lib/generators/acts_as_taggable_simple/migration/templates/active_record/migration.rb", "lib/tag.rb", "lib/tag_list.rb", "lib/tagging.rb"]
+  s.files = ["Gemfile", "MIT-LICENSE", "README.rdoc", "Rakefile", "acts_as_taggable_simple.gemspec", "init.rb", "lib/active_record/acts/taggable.rb", "lib/acts_as_taggable_simple.rb", "lib/generators/acts_as_taggable_simple/migration/migration_generator.rb", "lib/generators/acts_as_taggable_simple/migration/templates/active_record/migration.rb", "lib/tag.rb", "lib/tag_list.rb", "lib/tagging.rb", "spec/acts_as_taggable_simple/acts_as_taggable_simple_spec.rb", "spec/acts_as_taggable_simple/spec_helper.rb", "spec/acts_as_taggable_simple/taggable_spec.rb", "spec/database.yml", "spec/models.rb", "spec/schema.rb", "spec/spec_helper.rb", "Manifest"]
+  s.homepage = %q{http://github.com/chromaticbum/acts_as_taggable_simple}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_taggable_simple", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_taggable_simple}
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Adds acts_as_taggable to ActiveRecord::Model to easily tag objects, no extra fluff}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+require 'acts_as_taggable_simple'

data/lib/active_record/acts/taggable.rb

@@ -0,0 +1,66 @@
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    
+    # This +acts_as+ extension provides capabilities for adding and removing tags to ActiveRecord objects.
+    #
+    # Basic note example:
+    #
+    #   class Note < ActiveRecord::Base
+    #     acts_as_taggable
+    #   end
+    # 
+    #   note.tag_list = "rails css javascript"
+    #   note.tag_list  # returns ["rails", "css", "javascript"]
+    module Taggable 
+      def self.included(base) #:nodoc:
+        base.send :extend, ClassMethods
+      end
+
+      # Provides one method: ActiveRecord::Base#acts_as_taggable.
+      module ClassMethods
+
+        # Call this method to make one of your models taggable.
+        #
+        # Future support for a :delimeter option for specifying the tag delimeter
+        def acts_as_taggable(options = {})
+          has_many :taggings, :as => :taggable, :class_name => "ActsAsTaggableSimple::Tagging"
+          has_many :tags, :through => :taggings, :as => :taggable, :class_name => "ActsAsTaggableSimple::Tag"
+          after_save :save_tags
+
+          class_eval <<-EOV
+            include ActiveRecord::Acts::Taggable::InstanceMethods
+          EOV
+        end
+      end
+
+      # Provides methods to manage tags for a taggable model:
+      # * tag_list - returns an Array of tag String's
+      # * tag_list= - takes and Array of tag Strings or a String of tags separated by spaces
+      # * save_tags - updates the ActsAsTaggableSimple::Tag objects after saving a taggable model
+      module InstanceMethods
+
+        # Returns a TagList containing the String names of all tags for this object
+        def tag_list
+          self.instance_variable_get('@tag_list') || self.instance_variable_set('@tag_list', TagList.new(tags.map(&:name)))
+        end
+
+        # Sets the list of tags for this object
+        # 
+        # +list+ can be either a String of tags separated by spaces or an Array of String's
+        def tag_list=(list)
+          self.instance_variable_set('@tag_list', list.is_a?(String) ? TagList.new(list.split(" ")) : list)
+        end
+
+        # Called right before saving the model to update the associated ActsAsTaggableSimple::Tag objects
+        # Once saved this also necessarily updates the ActsAsTaggableSimple::Tagging objects for this record
+        def save_tags
+          self.tags = ActsAsTaggableSimple::Tag.find_or_create_all_tags(self.tag_list)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Acts::Taggable
+end

data/lib/acts_as_taggable_simple.rb

@@ -0,0 +1,6 @@
+# ActsAsTaggableSimple
+
+require 'tag_list'
+require 'tag'
+require 'tagging'
+require 'active_record/acts/taggable'

data/lib/generators/acts_as_taggable_simple/migration/migration_generator.rb

@@ -0,0 +1,35 @@
+module ActsAsTaggableSimple #:nodoc:
+  module Generators #:nodoc:
+
+    # Generates a migration file for migrating two tables into the database for acts_as_taggable_simple to function:
+    # * tags
+    # * taggings
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Generates migration for Tag and Tagging models"
+
+      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_taggable_simple_migration'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+class ActsAsTaggableSimpleMigration < ActiveRecord::Migration
+  def self.up
+    create_table :tags do |t|
+      t.string :name
+    end
+
+    add_index :tags, :name, :unique => true
+
+    create_table :taggings do |t|
+      t.references :taggable, :polymorphic => true
+      t.references :tag
+    end
+  end
+
+  def self.down
+    drop_table :tagging
+
+    drop_table :tags
+  end
+end

data/lib/tag.rb

@@ -0,0 +1,34 @@
+module ActsAsTaggableSimple #:nodoc:
+
+  # ActiveRecord model for storing a tag in the database.
+  #
+  # Tags have only one attribute: +name+, which is just the text representation of the tag.
+  # +name+ must be unique for each instance.
+  class Tag < ::ActiveRecord::Base
+    attr_accessible :name
+
+    validates_uniqueness_of :name
+
+    # Finds or creates all of the tags contained in +list+ and returns them.
+    #
+    # +list+ is an Array of String's containing the +name+'s of the desired tags.
+    # If an ActsAsTaggableSimple::Tag does not yet exist for a tag, then it is created, otherwise the already existing tag is used.
+    #
+    # Empty database example:
+    #   tags = ActsAsTaggableSimple::Tag.find_or_create_all_tags(%w{rails css html})
+    # Will create 3 new ActsAsTaggableSimple::Tag objects and save them to the database.
+    #
+    # If +rails+, +css+, and +html+ tags already exist in the database, then the following example will only create 1 new tag.
+    #   tags = ActsAsTaggableSimple::Tag.find_or_create_all_tags(%w{rails css html javascript})
+    def self.find_or_create_all_tags(list)
+      existing_tags = Tag.where(:name => list)
+      create_tags_list = list - existing_tags.map(&:name)
+
+      create_tags = create_tags_list.collect do |tag|
+        Tag.create!(:name => tag)
+      end
+
+      create_tags + existing_tags.all
+    end
+  end
+end

data/lib/tag_list.rb

@@ -0,0 +1,5 @@
+class TagList < Array
+  def to_s
+    self.join " "
+  end
+end

data/lib/tagging.rb

@@ -0,0 +1,8 @@
+module ActsAsTaggableSimple #:nodoc:
+
+  # ActiveRecord model for storing a join between a taggable object and an ActsAsTaggableSimple::Tag object.
+  class Tagging < ::ActiveRecord::Base
+    belongs_to :taggable, :polymorphic => true
+    belongs_to :tag, :class_name => "ActsAsTaggableSimple::Tag"
+  end
+end

data/spec/acts_as_taggable_simple/acts_as_taggable_simple_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "Acts As Taggable Simple" do
+  describe "Taggable Method Generation" do
+    before :each do
+      clean_database!
+      @taggable = TaggableModel.new
+    end
+
+    it "should generate a tag_list and tag_list= method" do
+      @taggable.should respond_to(:tag_list, :tag_list=)
+    end
+  end
+end

data/spec/acts_as_taggable_simple/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path("../../spec_helper", __FILE__) 

data/spec/acts_as_taggable_simple/taggable_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe "Taggable" do
+  before :each do
+    clean_database!
+    @taggable = TaggableModel.new
+  end
+
+  it "should be able to create tags" do
+    @taggable.tag_list = "tag2 tag3 tag1"
+    @taggable.tag_list.should be_kind_of(Array)
+
+    lambda {
+      @taggable.save
+    }.should change(ActsAsTaggableSimple::Tag, :count).by(3)
+
+    @taggable.tag_list.sort.should == %w(tag2 tag3 tag1).sort
+  end
+
+  it "should not create tags that already exist and create tags that do not yet exist when saving" do
+    @taggable.tag_list = "tag2 tag3 tag1"
+    @taggable.save
+
+    taggable1 = TaggableModel.new(:tag_list => "tag2 tag1 rails css")
+    taggable2 = TaggableModel.new(:tag_list => "tag2 tag1 rails css")
+
+    lambda {
+      taggable1.save
+    }.should change(ActsAsTaggableSimple::Tag, :count).by(2)
+
+    lambda {
+      taggable2.save
+    }.should change(ActsAsTaggableSimple::Tag, :count).by(0)
+  end
+
+  it "should delete old taggings when saving" do
+    @taggable.tag_list = "ruby rails css"
+    @taggable.save
+
+    @taggable.tag_list = "ruby rails"
+
+    lambda {
+      @taggable.save
+    }.should change(@taggable.taggings, :count).by(-1)
+  end
+
+  it "should retain unchanged taggings when saving" do
+    @taggable.tag_list = "ruby rails css"
+    @taggable.save
+    old_taggings = @taggable.taggings
+
+    @taggable.tag_list = "ruby rails"
+    @taggable.save
+
+    @taggable.taggings.should == old_taggings
+  end
+
+  it "should reload tags whenever tag list is changed and then model is saved" do
+    @taggable.tag_list = "ruby rails css"
+    @taggable.tags.empty?.should be_true
+
+    @taggable.save
+    @taggable.tags.empty?.should be_false
+  end
+end

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/models.rb

@@ -0,0 +1,6 @@
+class TaggableModel < ActiveRecord::Base
+  acts_as_taggable
+end
+
+class UntaggableModel <  ActiveRecord::Base
+end

data/spec/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :tags do |t|
+    t.string :name
+  end
+
+  add_index :tags, :name, :unique => true
+
+  create_table :taggings do |t|
+    t.references :taggable, :polymorphic => true
+    t.references :tag
+  end
+
+  create_table :taggable_models do |t|
+  end
+
+  create_table :untaggable_models do |t|
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+require 'test/unit'
+
+require 'active_support'
+require 'active_record'
+require 'logger'
+
+require 'acts_as_taggable_simple'
+
+ENV["DB"] ||= "sqlite3"
+
+database_yml = File.expand_path(File.join(File.dirname(__FILE__), "database.yml"))
+raise "Please create test/database.yml file" if not File.exists? database_yml
+
+active_record_configuration = YAML.load_file(database_yml)[ENV["DB"]]
+
+ActiveRecord::Base.establish_connection(active_record_configuration)
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  
+  load(File.dirname(__FILE__) + "/schema.rb")
+  load(File.dirname(__FILE__) + "/models.rb")
+end
+
+def clean_database!
+  models = [ActsAsTaggableSimple::Tag, ActsAsTaggableSimple::Tagging, TaggableModel, UntaggableModel]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_taggable_simple
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Hollin R. Wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-10 00:00:00.000000000 +03:00
+default_executable: 
+dependencies: []
+description: Adds acts_as_taggable to ActiveRecord::Model to easily tag objects, no
+  extra fluff
+email: chromaticbum @nospam@ gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- lib/active_record/acts/taggable.rb
+- lib/acts_as_taggable_simple.rb
+- lib/generators/acts_as_taggable_simple/migration/migration_generator.rb
+- lib/generators/acts_as_taggable_simple/migration/templates/active_record/migration.rb
+- lib/tag.rb
+- lib/tag_list.rb
+- lib/tagging.rb
+files:
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- acts_as_taggable_simple.gemspec
+- init.rb
+- lib/active_record/acts/taggable.rb
+- lib/acts_as_taggable_simple.rb
+- lib/generators/acts_as_taggable_simple/migration/migration_generator.rb
+- lib/generators/acts_as_taggable_simple/migration/templates/active_record/migration.rb
+- lib/tag.rb
+- lib/tag_list.rb
+- lib/tagging.rb
+- spec/acts_as_taggable_simple/acts_as_taggable_simple_spec.rb
+- spec/acts_as_taggable_simple/spec_helper.rb
+- spec/acts_as_taggable_simple/taggable_spec.rb
+- spec/database.yml
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- Manifest
+has_rdoc: true
+homepage: http://github.com/chromaticbum/acts_as_taggable_simple
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_taggable_simple
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: acts_as_taggable_simple
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Adds acts_as_taggable to ActiveRecord::Model to easily tag objects, no extra
+  fluff
+test_files: []