ts_vector_tags 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ts_vector_tags.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# TsVectorTags
+
+A simple tagging library that uses the (fairly exotic) `ts_vector` type in PostgreSQL on top of ActiveRecord.
+
+## Requirements
+
+* ActiveRecord
+* a field `tags_vector` of type `tsvector` on the underlying table
+
+## Usage
+
+Tags can be set using either an array, or a comma separated list.
+
+    class Post < ActiveRecord::Base
+      include TsVectorTags
+
+      # ...
+    end
+
+    post = Post.new
+
+    post.tags = "bing, bong"
+    post.tags
+    => ['bing', 'bong']
+
+    post.tags = ['bing', 'bong']
+    post.tags
+    => ['bing', 'bong']
+
+The including class has a scope:
+
+    Post.with_tags('Paris, Texas')
+    Post.with_tags('Paris', 'Texas')
+
+Tags are normalized:
+
+    post.tags = ['  wtf#$%^   &*??!']
+    post.tags
+    => ['wtf']

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ts_vector_tags.rb

@@ -0,0 +1,42 @@
+require "ts_vector_tags/version"
+
+module TsVectorTags
+  class MissingAttributeError < Exception; end
+
+  module Standardizer
+    class << self
+      def tagify(tags)
+        tags = tags.split(/\s*,\s*/) if tags.is_a?(String)
+        tags.map!{ |tag| self.normalize(tag) }
+      end
+
+      def normalize(tag)
+        tag.downcase.gsub(/[^[:alnum:]]/, "")
+      end
+    end
+  end
+
+  def self.included(base)
+    unless base.instance_methods.include?(:tags_vector) && base.instance_methods.include?(:tags_vector=)
+      msg = "The TsVectorTags mixin assumes that the underlying PostgreSQL table has a field `tags_vector` of type tsvector"
+      raise TsVectorTags::MissingAttributeError.new(msg)
+    end
+
+    base.class_eval do
+      scope :with_tags, lambda { |tags|
+        where("tags_vector @@ to_tsquery('simple', ?) ", TsVectorTags::Standardizer.tagify(tags).join(' & '))
+      }
+    end
+  end
+
+  def tags=(value)
+    return self.tags_vector = "" if value.nil?
+    self.tags_vector = TsVectorTags::Standardizer.tagify(value).map{ |tag| "'#{tag}'" }.join(' ')
+  end
+
+  def tags
+    return [] unless self.tags_vector
+    self.tags_vector.scan(/'(.+?)'/).flatten
+  end
+
+end

data/lib/ts_vector_tags/version.rb

@@ -0,0 +1,3 @@
+module TsVectorTags
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

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

data/spec/ts_vector_tags_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe TsVectorTags::Standardizer do
+  it "normalizes" do
+    TsVectorTags::Standardizer.normalize('abc-!@ #$    %^&*()123').should eq('abc123')
+  end
+
+  it "splits and normalizes a string" do
+    TsVectorTags::Standardizer.tagify('abc-!@ #$  ,  %^&*()123').should eq(['abc', '123'])
+  end
+
+  it "normalizes tags in an arrayarray" do
+    TsVectorTags::Standardizer.tagify(['abc-!@ #$  ', '  %^&*()123']).should eq(['abc', '123'])
+  end
+end
+
+class Thing
+  def self.scope(name, options = {}); end
+
+  attr_accessor :tags_vector
+  include TsVectorTags
+
+end
+
+describe TsVectorTags do
+  describe "accessors" do
+    let(:thing) { Thing.new }
+
+    describe "deleting tags" do
+      before :each do
+        thing.tags_vector = "'bing' 'bong'"
+      end
+
+      it "uses nil" do
+        thing.tags = nil
+        thing.tags.should eq([])
+      end
+
+      it "removes tags with an empty array" do
+        thing.tags = []
+        thing.tags.should eq([])
+      end
+
+      it "removes tags with an empty string" do
+        thing.tags = ""
+        thing.tags.should eq([])
+      end
+    end
+
+    it "assigns comma-separated strings" do
+      thing.tags = "bing, bong"
+      thing.tags_vector.should eq("'bing' 'bong'")
+    end
+
+    it "assigns arrays" do
+      thing.tags = ["bing", "bong"]
+      thing.tags_vector.should eq("'bing' 'bong'")
+    end
+
+    it "reads tag vectors" do
+      thing.tags_vector = "'bing' 'bong'"
+      thing.tags.should eq(['bing', 'bong'])
+    end
+  end
+
+  context "with the required attributes" do
+    it "does not raise an exception" do
+      lambda {
+        class GoodThing
+          def self.scope(name, options = {}); end
+          attr_accessor :tags_vector
+          include TsVectorTags
+        end
+      }.should_not raise_error
+    end
+  end
+
+  context "without a tags_vector attribute" do
+    it "raises a helpful exception when no tags_vector writer is present" do
+      lambda {
+        class OneBadThing
+          def self.scope(name, options = {}); end
+
+          attr_reader :tags_vector
+          include TsVectorTags
+        end
+      }.should raise_error(TsVectorTags::MissingAttributeError)
+    end
+
+    it "raises a helpful exception when no tags_vector reader is pressent" do
+      lambda {
+        class AnotherBadThing
+          def self.scope(name, options = {}); end
+
+          attr_writer :tags_vector
+          include TsVectorTags
+        end
+      }.should raise_error(TsVectorTags::MissingAttributeError)
+    end
+  end
+end

data/ts_vector_tags.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ts_vector_tags/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ts_vector_tags"
+  s.version     = TsVectorTags::VERSION
+  s.authors     = ["Simen Svale Skogsrud", "Katrina Owen"]
+  s.email       = ["simen@bengler.no", "katrina@bengler.no"]
+  s.homepage    = ""
+  s.summary     = %q{Super simple tag mixin for postgresql and activerecord}
+  s.description = %q{Extremely simple, if somewhat exotic, mixin that uses the tsvector feature in postgresql to add tags to an ActiveRecord model.}
+
+  s.rubyforge_project = "ts_vector_tags"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ts_vector_tags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simen Svale Skogsrud
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161651360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161651360
+description: Extremely simple, if somewhat exotic, mixin that uses the tsvector feature
+  in postgresql to add tags to an ActiveRecord model.
+email:
+- simen@bengler.no
+- katrina@bengler.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/ts_vector_tags.rb
+- lib/ts_vector_tags/version.rb
+- spec/spec_helper.rb
+- spec/ts_vector_tags_spec.rb
+- ts_vector_tags.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: ts_vector_tags
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Super simple tag mixin for postgresql and activerecord
+test_files: []