acts-as-taggable-hstore 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.log
+*.sqlite3
+/pkg/*
+.bundle
+.rvmrc
+Gemfile.lock
+spec/database.yml
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gem  'activerecord-postgres-hstore-core', "~> 0.0.4"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jt Gleason
+
+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/README.rdoc

@@ -0,0 +1,61 @@
+= ActsAsTaggableHstore
+
+This plugin uses the semantics from ActsAsTaggableOn but uses Hstore to implement the tags. This limits this gem to Postgres databases.
+
+It has a generator for adding the tag column to an existing table. Then you can include the acts_as_taggable_hstore method on the class and 
+everything is added as you would expect.
+
+== Installation
+
+=== Rails 3.x
+
+To use it, add it to your Gemfile:
+  gem 'acts-as-taggable-hstore' , '~> 0.1.1'
+
+==== Post Installation
+
+Each table needs to be modified in order for this to work. Run
+
+1. rails generate acts_as_taggable_hstore:migration TABLENAME
+2. rake db:migrate
+
+== Testing
+
+Acts as Taggable Hstore uses Rspec tests. You can run the usual rake task to test it.
+
+  rake spec
+
+== Usage
+
+First, run the migration for the particular table you want to be taggable. Then
+
+    class Video < ActiveRecord::Base
+      acts_as_taggable
+    end
+
+    @video = Video.new()
+    @video.tag_list = "starcraft 2,gameplay,mlg"
+    @video.save
+
+    @video.tags # => [<Tag name:"starcraft 2">,<Tag name:"gameplay">,<Tag name:"mlg">]
+
+=== Finding Tagged Objects
+
+Acts as Taggable On uses scopes to create associations for tags. It should work with will_paginate as well:
+
+  Video.tagged_vith("starcraft 2")
+
+  #Find a video with all matching tags
+
+  Video.tagged_with(["starcraft 2","mlg"], :match_all => true)
+
+  #Find a video with any matching tags
+  Video.tagged_with(["starcraft 2","mlg"], :any => true)
+
+  #Find videos with no matching tags
+  Video.tagged_with(["starcraft 2","mlg"], :exclude => true)
+
+== Help
+
+== License
+  Copyright @ 2012 Jt Gleason MIT License

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :development
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/acts-as-taggable-hstore.gemspec

@@ -0,0 +1,28 @@
+$:.push File.dirname(__FILE__) + '/lib'
+require 'acts-as-taggable-hstore/version'
+
+Gem::Specification.new do |gem|
+  gem.name = %q{acts-as-taggable-hstore}
+  gem.authors = ["Jt Gleason"]
+  gem.date = %q{2012-02-29}
+  gem.description = %q{With ActsAsTaggableHstore, you can tag a single model that uses postgres hstore type}
+  gem.summary = "Basic postgres hstore tagging for Rails."
+  gem.email = %q{jt@twitch.tv}
+  gem.homepage      = ''
+
+  gem.add_runtime_dependency 'rails', '~> 3.0'
+  gem.add_runtime_dependency 'activerecord-postgres-hstore-core', "~> 0.0.4"
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'ammeter', '~> 0.1.3'
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "acts-as-taggable-hstore"
+  gem.require_paths = ['lib']
+  gem.version       = ActsAsTaggableHstore::VERSION
+end

data/lib/acts-as-taggable-hstore/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTaggableHstore
+  VERSION = '0.0.1'
+end

data/lib/acts-as-taggable-hstore.rb

@@ -0,0 +1,36 @@
+require "active_record"
+require "active_record/version"
+require "activerecord-postgres-hstore-core"
+
+require "action_view"
+require "digest/sha1"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module ActsAsTaggableHstore
+  mattr_accessor :delimiter
+  @@delimiter = ','
+
+  mattr_accessor :force_lowercase
+  @@force_lowercase = false
+
+  mattr_accessor :default_column
+  @@default_column = :tag_hstore
+
+  def self.glue
+    @@delimiter.ends_with?(" ") ? @@delimiter : "#{@@delimiter} "
+  end
+
+  def self.setup
+    yield self
+  end
+end
+
+require "acts_as_taggable_hstore/taggable"
+require "acts_as_taggable_hstore/acts_as_taggable_hstore/core"
+
+$LOAD_PATH.shift
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend ActsAsTaggableHstore::Taggable
+end

data/lib/acts_as_taggable_hstore/acts_as_taggable_hstore/core.rb

@@ -0,0 +1,65 @@
+module ActsAsTaggableHstore::Taggable
+  module Core
+    def self.included(base)
+      base.send :include, ActsAsTaggableHstore::Taggable::Core::InstanceMethods
+      base.extend ActsAsTaggableHstore::Taggable::Core::ClassMethods
+      
+#      base.class_eval do
+#         class_attribute :hstore_column
+#      end
+    end
+
+    module ClassMethods
+      #allow inheritence
+      def acts_as_taggable_hstore_by(*args)
+        super(*args)
+      end
+
+      def tagged_with(tag_list, options= {})
+        empty_result = scoped(:conditions => "1 = 0")
+        return empty_result if tag_list.blank?
+
+        if tag_list.is_a? String
+          tag_list = [tag_list]
+        end
+
+        connect_with = " AND "
+        if options.delete(:any)
+          connect_with = " OR "
+        end
+
+        conditions = []
+        tag_list.each do |tag_name|
+          conditions << self.tag_hstore_column.to_s + " ? '#{tag_name}' "
+        end
+
+        return where(conditions.join(connect_with))
+
+      end
+
+    end
+
+    module InstanceMethods
+
+      def tag_list
+        hstore_result = self.send(self.class.tag_hstore_column)
+
+        if hstore_result.nil?
+          return []
+        end
+
+        return hstore_result.keys.join(ActsAsTaggableHstore.glue)
+      end
+
+      def tag_list=(tags)
+        prep_hstore = tags.split(ActsAsTaggableHstore.delimiter).map(&:strip).inject({}) { |h,k| h[k] = nil; h }
+        self.send(self.class.tag_hstore_column.to_s + "=", prep_hstore)
+      end
+
+      def tags
+        tag_hstore.keys
+      end
+
+    end
+  end
+end

data/lib/acts_as_taggable_hstore/taggable.rb

@@ -0,0 +1,23 @@
+module ActsAsTaggableHstore
+  module Taggable
+    def taggable?
+      false
+    end
+    def acts_as_taggable_hstore
+      acts_as_taggable_hstore_by ActsAsTaggableHstore.default_column
+    end
+
+    def acts_as_taggable_hstore_by(*column_name)
+
+      class_attribute :tag_hstore_column
+      self.tag_hstore_column = column_name.first
+
+      class_eval do
+        def self.taggable?
+          true
+        end
+        include ActsAsTaggableHstore::Taggable::Core
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'acts-as-taggable-hstore'

data/spec/acts_as_taggable_hstore/acts_as_taggable_hstore_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Acts As Taggable Hstore" do
+  before(:each) do
+    clean_database!
+  end
+
+  it "should provide a class method 'taggable?' that is false for untaggable models" do
+    UntaggableModel.should_not be_taggable
+  end
+
+  describe "Taggable Method Generation" do
+    before(:each) do
+      clean_database!
+      @taggable = TaggableModel.new(:name => "Bob Jones")
+    end
+
+    it "should respond 'true' to taggable?" do
+      @taggable.class.should be_taggable
+    end
+
+    it "should generate a tag_list accessor/setter for each tag type" do
+      @taggable.should respond_to(:tag_list)
+      @taggable.should respond_to(:tag_list=)
+    end
+
+    it "should have a hstore sql type" do
+      @taggable.class.columns_hash[@taggable.class.tag_hstore_column.to_s].sql_type.should == "hstore"
+    end
+
+    it "should make strings have valid_hstore" do
+      "bob".valid_hstore?.should == false
+    end
+
+    it "should have a hstore column type" do
+      @taggable.class.columns_hash[@taggable.class.tag_hstore_column.to_s].type.should == :hstore
+    end
+
+  end
+
+  describe "Reloading" do
+    it "should save a model instantiated by Model.find" do
+      taggable = TaggableModel.create!(:name => "Taggable")
+      found_taggable = TaggableModel.find(taggable.id)
+      found_taggable.save
+    end
+  end
+end

data/spec/acts_as_taggable_hstore/taggable_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe "Taggable" do
+  before(:each) do
+    clean_database!
+    @taggable = TaggableModel.new(:name => "Bob Jones")
+    @taggables = [@taggable, TaggableModel.new(:name => "John Doe")]
+  end
+
+  it "should return [] right after new" do
+    blank_taggable = TaggableModel.new(:name => "Bob Jones")
+    blank_taggable.tag_list.should == []
+  end
+
+  it "should return [] right after create" do
+    blank_taggable = TaggableModel.create(:name => "Bob Jones")
+    blank_taggable.tag_list.should == []
+  end
+
+  it "should be able to remove tags through list alone" do
+    @taggable.tag_list = "ruby, rails, css"
+    @taggable.save
+
+    @taggable.reload
+    @taggable.should have(3).tags
+    @taggable.tag_list = "ruby, rails"
+    @taggable.save
+    @taggable.reload
+    @taggable.should have(2).tags
+  end
+
+  it "should be able to find by tag" do
+    @taggable.tag_list = "ruby, rails, css"
+    @taggable.save
+
+    TaggableModel.tagged_with("ruby").first.should == @taggable
+  end
+
+  it "should not return read-only records" do
+    TaggableModel.create(:name => "Bob", :tag_list => "ruby, rails, css")
+    TaggableModel.tagged_with("ruby").first.should_not be_readonly
+  end
+
+  it "should be able to find tagged with only the matching tags" do
+    bob = TaggableModel.create(:name => "Bob", :tag_list => "lazy, happier")
+    frank = TaggableModel.create(:name => "Frank", :tag_list => "fitter, happier, inefficient")
+    steve = TaggableModel.create(:name => 'Steve', :tag_list => "fitter, happier")
+
+    TaggableModel.tagged_with(["fitter", "happier"]).to_a.sort.should == [steve,frank].sort
+  end
+
+#  it "should be able to find tagged with some excluded tags" do
+#    bob = TaggableModel.create(:name => "Bob", :tag_list => "happier, lazy")
+#    frank = TaggableModel.create(:name => "Frank", :tag_list => "happier")
+#    steve = TaggableModel.create(:name => 'Steve', :tag_list => "happier")
+
+#    TaggableModel.tagged_with("lazy", :exclude => true).to_a.should == [frank, steve]
+#  end
+
+  it "should return an empty scope for empty tags" do
+    TaggableModel.tagged_with('').should == []
+    TaggableModel.tagged_with(' ').should == []
+    TaggableModel.tagged_with(nil).should == []
+    TaggableModel.tagged_with([]).should == []
+  end
+end  

data/spec/database.yml.sample

@@ -0,0 +1,7 @@
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: acts_as_taggable_hstore
+  encoding: utf8

data/spec/models.rb

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

data/spec/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define :version => 0 do
+
+  create_table :taggable_models, :force => true do |t|
+    t.column :name, :string
+    t.column :type, :string
+  end
+
+  add_column :taggable_models, :tag_hstore, :hstore
+
+  execute "create index concurrently idx_tag_model_tag_hstore on taggable_models using gist (tag_hstore)"
+
+  create_table :untaggable_models, :force => true do |t|
+    t.column :name, :string
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH << "." unless $LOAD_PATH.include?(".")
+require 'logger'
+
+begin
+  require "rubygems"
+  require "bundler"
+  if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("0.9.5")
+    raise RuntimeError, "Your bundler version is too old." +
+     "Run `gem install bundler` to upgrade."
+  end
+
+  # Set up load paths for all bundled gems
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems." +
+    "Did you run \`bundlee install\`?"
+end
+
+Bundler.require
+require File.expand_path('../../lib/acts-as-taggable-hstore', __FILE__)
+#require "activerecord-postgres-hstore-core"
+db_name = 'postgresql'
+database_yml = File.expand_path('../database.yml', __FILE__)
+
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)
+
+  ActiveRecord::Base.configurations = active_record_configuration
+  config = ActiveRecord::Base.configurations[db_name]
+  
+  begin
+    ActiveRecord::Base.establish_connection(db_name)
+    ActiveRecord::Base.connection
+  rescue
+    ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+    ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => 'utf8'))
+  end
+    
+  ActiveRecord::Base.establish_connection(config)
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  ActiveRecord::Base.default_timezone = :utc
+  
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+    
+    load(File.dirname(__FILE__) + '/schema.rb')
+    load(File.dirname(__FILE__) + '/models.rb')
+  end
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: #{database_yml}.sample"
+end
+
+def clean_database!
+  models = [TaggableModel, UntaggableModel]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+clean_database!

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification 
+name: acts-as-taggable-hstore
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jt Gleason
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-29 00:00:00 Z
+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: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord-postgres-hstore-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ammeter
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: With ActsAsTaggableHstore, you can tag a single model that uses postgres hstore type
+email: jt@twitch.tv
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- acts-as-taggable-hstore.gemspec
+- lib/acts-as-taggable-hstore.rb
+- lib/acts-as-taggable-hstore/version.rb
+- lib/acts_as_taggable_hstore/acts_as_taggable_hstore/core.rb
+- lib/acts_as_taggable_hstore/taggable.rb
+- rails/init.rb
+- spec/acts_as_taggable_hstore/acts_as_taggable_hstore_spec.rb
+- spec/acts_as_taggable_hstore/taggable_spec.rb
+- spec/database.yml.sample
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: ""
+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.8.6
+signing_key: 
+specification_version: 3
+summary: Basic postgres hstore tagging for Rails.
+test_files: 
+- spec/acts_as_taggable_hstore/acts_as_taggable_hstore_spec.rb
+- spec/acts_as_taggable_hstore/taggable_spec.rb
+- spec/database.yml.sample
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb