spraypaint 1.0.0

data/test/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/config/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000

data/test/config/environment.rb

@@ -0,0 +1,27 @@
+# Simplified environment file, only meant for testing spraypaint
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.4' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+# This plugin locator will only find the plugin we wish to test
+
+class SinglePluginLocator < Rails::Plugin::FileSystemLocator
+  def plugins
+    if plugin = create_plugin(File.expand_path(File.join(File.dirname(__FILE__), '..', '..')))
+      [plugin]
+    else
+      raise "Plugin to be tested couldn't be found"
+    end
+  end
+end
+
+Rails::Initializer.run do |config|
+  # Change the plugin path to the grandparent folder, where the plugin to be tested actually resides  
+  config.plugin_locators = [SinglePluginLocator]
+
+  # Spraypaint only touches ActiveRecord, so don't bother loading any other frameworks
+  config.frameworks = [:active_record]
+end

data/test/db/schema.rb

@@ -0,0 +1,40 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20090323171649) do
+  create_table 'spraypaint_tags', :force => true do |t|
+    t.string 'name', :null => false
+  end
+  
+  create_table 'spraypaint_taggings', :force => true do |t|
+    t.integer 'tag_id', :null => false
+    t.integer 'target_id', :null => false
+    t.string  'target_type', :null => false
+    t.integer 'owner_id'
+    t.string 'owner_type'
+  end
+  
+  create_table 'books', :force => true do |t|
+    t.string 'name', :null => false
+    t.string 'author'
+    t.string 'type'
+  end
+  
+  create_table 'films', :force => true do |t|
+    t.string 'name', :null => false
+    t.string 'director'
+    t.string 'tag_string'
+  end
+  
+  create_table 'accounts', :force => true do |t|
+    t.string 'login', :null => false
+  end
+end

data/test/spec/default_sanitizer_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Spraypaint::DefaultSanitizer do
+  describe '(with no arguments passed to constructor)' do
+    before(:each) do
+      @it = Spraypaint::DefaultSanitizer.new
+    end
+    
+    it "should strip surrounding whitespace from tag" do
+      @it.sanitize_tag("    hello     ").should == "hello"
+    end
+
+    it "should convert accented characters to their non-accented forms" do
+      @it.sanitize_tag("fåçêtîous").should == "facetious"
+    end
+    
+    it "should remove all non-allowed characters" do
+      @it.sanitize_tag("a*b^c@d!e%f$g").should == "abcdefg"
+    end
+
+    it "should leave passed in tag unaltered" do
+      @it.sanitize_tag(value = "    hello     ")
+      value.should == "    hello     "
+    end
+  end
+end

data/test/spec/models/tag_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Spraypaint::Model::Tag do
+  before(:each) do
+    @class = Spraypaint::Model::Tag
+    @it = Spraypaint::Model::Tag.new
+  end
+  
+  describe "(in general)" do
+    it "should be valid with a name" do
+      @it.name = 'name'
+      @it.should be_valid
+    end
+    
+    it "should not be valid without a name" do
+      @it.name = nil
+      @it.should_not be_valid
+    end
+  end
+end

data/test/spec/models/tagging_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Spraypaint::Model::Tagging do
+  before(:each) do
+    @class = Spraypaint::Model::Tagging
+    @it = Spraypaint::Model::Tagging.new
+  end
+  
+  describe "(in general)" do
+    before(:each) do
+      build_model :books do
+        string :name
+      end
+      
+      @it.tag = Spraypaint::Model::Tag.create :name => 'a'
+      @it.target = Book.create :name => 'b'
+    end
+    
+    it "should be valid with a tag and a target" do
+      @it.should be_valid
+    end
+    
+    it "should not be valid without a tag" do
+      @it.tag = nil
+      @it.should_not be_valid
+    end
+    
+    it "should not be valid without a target" do
+      @it.target = nil
+      @it.should_not be_valid
+    end
+    
+    it "should allow an association with a tag" do
+      @tag = Spraypaint::Model::Tag.create! :name => 'tag'
+      @it.tag = @tag
+      @it.save!
+      @reloaded = @class.find(@it.id)
+      @reloaded.tag.should == @tag
+    end
+    
+    it "should allow an association with a target" do
+      @target = Book.create! :name => 'tag'
+      @it.target = @target
+      @it.save!
+      @reloaded = @class.find(@it.id)
+      @reloaded.target.should == @target
+    end
+  end
+end

data/test/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+ENV["RAILS_ENV"] = "test"
+RAILS_ENV = "test"
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../config/environment.rb'))
+require File.expand_path(File.dirname(__FILE__) + '/../db/schema')
+
+module ActsAsFu
+  def build_model(name, options={}, &block)
+    klass_name  = name.to_s.classify
+    super_class = options[:superclass] || ActiveRecord::Base
+    contained   = options[:contained]  || Object
+ 
+    contained.send(:remove_const, klass_name) rescue nil
+    klass = Class.new(super_class)
+    contained.const_set(klass_name, klass)
+ 
+    # table_name isn't available until after the class is created.
+    if super_class == ActiveRecord::Base
+      ActiveRecord::Base.connection.create_table(klass.table_name, :force => true) { }
+    end
+ 
+    model_eval(klass, &block)
+    klass
+  end
+ 
+  private
+ 
+  def model_eval(klass, &block)
+    class << klass
+      def method_missing_with_columns(sym, *args, &block)
+        ActiveRecord::Base.connection.change_table(table_name) do |t|
+          t.send(sym, *args)
+        end
+      end
+ 
+      alias_method_chain :method_missing, :columns
+    end
+ 
+    klass.class_eval(&block) if block_given?
+ 
+    class << klass
+      alias_method :method_missing, :method_missing_without_columns
+    end
+  end
+
+end
+
+Spec::Runner.configure do |config|
+  include ActsAsFu
+end

data/test/spec/spraypaint_spec.rb

@@ -0,0 +1,284 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Spraypaint::Behaviour do
+  before(:each) do
+    build_model :books do
+      string :name
+      string :type
+      
+      tag_with_spraypaint
+    end
+    
+    build_model :non_fiction_books, :superclass => Book
+    build_model :novel, :superclass => Book
+    
+    build_model :films do
+      string :name
+      string :director
+      
+      tag_with_spraypaint
+    end
+  end
+
+  describe "(records initialized with no tags)" do
+    before(:each) do
+      @it = Film.new :name => 'No Country For Old Men'
+    end
+    
+    it "should return an empty array for tags" do
+      @it.tags.should == []
+    end
+    
+    it "should return false for tags_changed?" do
+      @it.tags_changed?.should be_false
+    end
+  end
+  
+  describe "(records initialized with tags passed into constructor)" do
+    before(:each) do
+      @tags = ['some', 'tags', 'to', 'set']
+      @it = Film.new(:tags => @tags)
+    end
+    
+    it "should return tags passed to constructor" do
+      @it.tags.should == @tags
+    end
+    
+    it "should return true for tags_changed?" do
+      @it.tags_changed?.should be_true
+    end
+  end
+  
+  describe "(records with no tags)" do
+    before(:each) do
+      @it = Film.new :name => 'No Country For Old Men'
+    end
+    
+    it "should save successfully" do
+      @it.save
+      @it.id.should_not be_nil
+    end
+    
+    it "should return an empty array of tags after reloading" do
+      @it.save!
+      @it = @it.class.find(@it.id)
+      @it.tags.should == []
+    end
+  end
+  
+  describe "(records with tags)" do
+    before(:each) do
+      @tags = ['mccarthy', 'coen brothers']
+      @it = Film.new :name => 'No Country For Old Men', :tags => @tags
+    end
+
+    it "should save successfully" do
+      @it.save
+      @it.id.should_not be_nil
+    end
+
+    it "should return original tags after reloading" do
+      @it.save!
+      @it = @it.class.find(@it.id)
+      @it.tags.should == @tags
+    end
+    
+    it "should retain tag order after saving and reloading" do
+      Film.create! :name => 'Dummy Film', :tags => ['a', 'b', 'c', 'd']
+      @it.tags = ['z', 'a', 'd', 'b']
+      @it.save!
+      @it = @it.class.find(@it.id)
+      @it.tags.should == ['z', 'a', 'd', 'b']
+    end
+  end
+  
+  describe "(setting tags using #tags=)" do
+    before(:each) do
+      @tags = ['some', 'tags', 'to', 'set']
+      @it = Film.new
+    end
+      
+    it "should set tags to empty array if set to nil" do
+      @it.tags = @tags
+      @it.tags = nil
+      @it.tags.should == []
+    end
+    
+    it "should remove duplicate tags" do
+      @it.tags = ['duplicate', 'duplicate', 'original']
+      @it.tags.should == ['duplicate', 'original']
+    end
+    
+    it "should remove nil tags" do
+      @it.tags = [nil, 'by', 'mouth']
+      @it.tags.should == ['by', 'mouth']
+    end
+    
+    it "should remove zero-length tags" do
+      @it.tags = ['', 'clean', '']
+      @it.tags.should == ['clean']
+    end
+    
+    it "should sanitize tags" do
+      @it.class.tag_sanitizer.should_receive(:sanitize_tag).with('unsanitized').and_return('sanitized')
+      @it.tags = ['unsanitized']
+      @it.tags.should == ['sanitized']
+    end
+    
+    it "should remove duplicates that result from sanitization" do
+      @it.class.tag_sanitizer.stub!(:sanitize_tag).and_return('clean')
+      @it.tags = ['unclean', 'dirty', 'filthy']
+      @it.tags.should == ['clean']
+    end
+    
+    it "should remove zero-length tags that result from sanitization" do
+      @it.class.tag_sanitizer.stub!(:sanitize_tag).and_return(nil)
+      @it.tags = ['unclean', 'dirty', 'filthy']
+      @it.tags.should == []
+    end
+    
+    it "should remove nil tags that result from sanitization" do
+      @it.class.tag_sanitizer.stub!(:sanitize_tag).and_return(nil)
+      @it.tags = ['unclean', 'dirty', 'filthy']
+      @it.tags.should == []
+    end
+  end
+  
+  describe "(setting tags using #tag_string=)" do
+    before(:each) do
+      @it = Film.new :name => 'Film 5'
+    end
+    
+    it "should split string up by commas" do
+      @it.tag_string = "some, tags, go, here"
+      @it.tags.should == ['some', 'tags', 'go', 'here']
+    end
+  
+    it "should remove superfluous whitespace surrounding tags" do
+      @it.tag_string = "some   , tags, go  ,  here"
+      @it.tags.should == ['some', 'tags', 'go', 'here']  
+    end
+  
+    it "should set tags to empty array if set to nil" do
+      @it.tag_string = nil
+      @it.tags.should == []
+    end
+  end
+  
+  describe "(reading tag_string on records with a tag_string db column)" do  
+    before(:each) do
+      @it = Film.new :name => 'Film 5'
+    end
+    
+    it "should read tag_string direct from db" do
+      @it.tag_string = "some   , tags, go  ,  here"
+      @it.save!
+      @it = Film.find(@it.id)
+      @it.tag_string = "some   , tags, go  ,  here"
+    end
+  end
+  
+  
+  describe "(reading tag_string on records where there is no tag_string db column)" do  
+    before(:each) do
+      @it = Book.new :name => 'Book 5'
+    end
+    
+    it "should reconstitue tag string from tags" do
+      @it.tag_string = "some   , tags, go  ,  here"
+      @it.save!
+      @it = Book.find(@it.id)
+      @it.tag_string = "some, tags, go, here"
+    end
+  end
+  
+  describe "(finding tags associated with a class of records)" do
+    before(:each) do
+    end
+    
+    it "should return set of tags associated with individual records" do
+      Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'josh brolin']
+      Film.create! :name => 'W', :tags => ['oliver stone', 'josh brolin']
+      Film.tags.sort.should == ['coen brothers', 'josh brolin', 'oliver stone']
+    end
+    
+    it "should limit found tags by class of record" do
+      Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'mccarthy']
+      Book.create! :name => 'No Country For Old Men', :tags => ['mccarthy', 'novel']
+      Film.tags.should == ['coen brothers', 'mccarthy']
+    end
+    
+    it "should limit tags found using STI subclasses" do
+      NonFictionBook.create! :name => 'The Wealth Of Nations', :tags => ['economics', 'adam smith']
+      Novel.create! :name => 'The Road', :tags => ['post apocalyptic', 'mccarthy']
+      Book.tags.should == ['adam smith', 'economics', 'mccarthy', 'post apocalyptic']
+      Novel.tags.should == ['mccarthy', 'post apocalyptic']
+    end
+    
+    it "should respect scoped queries" do
+      Film.named_scope 'directed_by', lambda {|director|
+        {:conditions => {:director => director}}
+      }
+      
+      Film.create! :name => 'Goodfellas', :director => 'Scorcese', :tags => ['mafia', 'gangster']
+      Film.create! :name => 'The Great Dictator', :director => 'Chaplin', :tags => ['hitler', 'satire']
+      Film.create! :name => 'Raging Bull', :director => 'Scorcese', :tags => ['boxing']
+      
+      Film.directed_by('Scorcese').tags.sort.should == ['boxing', 'gangster', 'mafia']
+      Film.directed_by('Chaplin').tags.sort.should == ['hitler', 'satire']
+    end
+    
+    it "should return tags in decending order of frequency" do
+      Film.create! :name => 'Superman', :tags => ['first']
+      Film.create! :name => 'Superman 2', :tags => ['second']
+      Film.create! :name => 'Police Academy 2', :tags => ['second']
+      Film.create! :name => 'Rocky 3', :tags => ['third']
+      Film.create! :name => 'Naked Gun 33 1/3', :tags => ['third']
+      Film.create! :name => 'Spiderman 3', :tags => ['third']
+      
+      Film.tags.should == ['third', 'second', 'first']
+    end
+    
+    it "should return tags alphabetically if frequency is the same" do
+      Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers']
+      Film.create! :name => 'W', :tags => ['oliver stone']
+      Film.create! :name => 'The Great Dictator', :tags => ['charlie chaplin']
+      Film.tags.should == ['charlie chaplin', 'coen brothers', 'oliver stone']
+      
+    end
+    
+    it "should respect limit and offset on the returned tags" do
+      Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'josh brolin']
+      Film.create! :name => 'W', :tags => ['oliver stone', 'josh brolin']
+      Film.tags(:limit => 1).should == ['josh brolin']
+      Film.tags(:limit => 1, :offset => 1).should == ['coen brothers']
+    end
+    
+    it "should include the frequency as an attribute on returned tags" do
+      Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'josh brolin']
+      Film.create! :name => 'W', :tags => ['oliver stone', 'josh brolin']
+      Film.tags.first.frequency.should == 2
+    end
+  end
+  
+  describe "(finding records via their tags)" do
+    it "should return records matching given tag" do
+      no_country = Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'josh brolin']
+      w = Film.create! :name => 'W', :tags => ['oliver stone', 'josh brolin']
+      Film.tagged_with('oliver stone').should == [w]
+    end
+    
+    it "should return records matching all given tags" do
+      no_country = Film.create! :name => 'No Country For Old Men', :tags => ['coen brothers', 'josh brolin']
+      w = Film.create! :name => 'W', :tags => ['oliver stone', 'josh brolin']
+      Film.tagged_with('oliver stone', 'josh brolin').should == [w]
+      Film.tagged_with('oliver stone', 'coen brothers').should == []
+    end
+    
+    it "should sanitize tags before searching" do
+      Film.tag_sanitizer.stub!(:sanitize_tag).and_return('clean')
+      Film.create! :name => 'No Country For Old Men', :tags => ['unclean']
+      Film.tagged_with('dirty').size.should == 1
+    end
+  end
+end