acts-as-taggable-array-on 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 639451573fc58e8ea095163c65dfe35caa3d7992
+  data.tar.gz: bc74321efd697736996fbbc64037b94d6c0aa440
+SHA512:
+  metadata.gz: 3332d1a58d337ed088ae59668752c8eb5464fcf8fbe7598680e89ef1cadba9a7cea114fe6ce047821f65da3830440a8d09a38ddd10e18e56e6f7631a8f8c3e41
+  data.tar.gz: 80a1c4c05c8372a2ea98b86fb641b30d4b657bbc8e77d3febc52039c5969d1f61544e329014ceb17c9078137ad9611c6aaa12cfcbab05e792f5548261bf4e3ae

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+addons:
+  postgresql: 9.3
+gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+before_script:
+  - createuser -d acts-as-taggable-array-on -U postgres
+  - createdb --username=acts-as-taggable-array-on acts-as-taggable-array-on_test
+script:
+  - bundle
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts-as-pgarray-taggable-on.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', cmd: 'rspec --drb --color' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 tmiyamon
+
+MIT License
+
+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.md

@@ -0,0 +1,134 @@
+# ActsAsTaggableArrayOn
+[![Build Status](https://travis-ci.org/tmiyamon/acts-as-taggable-array-on.svg?branch=master)](https://travis-ci.org/tmiyamon/acts-as-taggable-array-on)
+
+A simple implementation for tagging sysytem with postgres array.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts-as-taggable-array-on'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+
+## Setup
+
+To use it, you need to have an array column to act as taggable.
+
+```ruby
+class CreateUser < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.text :tags, array: true, default: '{}'
+      t.timestamps
+    end
+    add_index :users, :tags, using: 'gin'
+  end
+end
+```
+
+and bundle:
+
+```shell
+rake db:migrate
+```
+
+then
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_taggable_array_on :tags
+end
+@user = User.new(:name => "Bobby")
+```
+
+acts_as_taggable_array_on defines 4 scope and 2 class methods as below.
+
+### scopes
+
+- with_any_#{tag_name}
+- with_all_#{tag_name}
+- without_any_#{tag_name}
+- without_all_#{tag_name}
+
+### class methods
+
+- all_#{tag_name}
+- #{tag_name}_cloud
+
+
+## Usage
+
+Set, add and remove
+
+```ruby
+#set
+@user.tags = ["awesome", "slick"]
+@user.tags = '{awesome,slick}'
+
+#add
+@user.tags += ["awesome"]
+@user.tags += ["awesome", "slick"]
+
+#remove
+@user.tags -= ["awesome"]
+@user.tags -= ["awesome", "slick"]
+```
+
+### Finding Tagged Objects
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_taggable_array_on :tags
+  scope :by_join_date, ->{order("created_at DESC")}
+end
+
+# Find a user with all of the tags
+User.with_all_tags("awesome")
+
+# Find a user with any of the tags
+User.with_any_tags("awesome")
+
+# Find a user without all of the tags
+User.without_all_tags("awesome")
+
+# Find a user without any of the tags
+User.without_any_tags("awesome")
+
+# Chain with the other scopes
+User.with_any_tags("awesome").without_any_tags("slick").by_join_date.paginate(:page => params[:page], :per_page => 20)
+```
+
+### Tag cloud calculations
+
+Calculation to count for each tags is supported. Currently, it does not care its order.
+
+```ruby
+User.tags_cloud
+# [['awesome' => 1], ['slick' => 2]]
+```
+
+### All Tags
+
+Can get all tags easily.
+
+```ruby
+User.all_tags
+# ['awesome', 'slick']
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/acts-as-taggable-array-on/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/acts-as-taggable-array-on.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts-as-taggable-array-on/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts-as-taggable-array-on"
+  spec.version       = ActsAsTagPgarray::VERSION
+  spec.authors       = ["Takuya Miyamoto"]
+  spec.email         = ["miyamototakuya@gmail.com"]
+  spec.summary       = %q{Simple tagging gem for Rails using postgres array.}
+  spec.description   = %q{Simple tagging gem for Rails using postgres array.}
+  spec.homepage      = "https://github.com/tmiyamon/acts-as-taggable-array-on"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord',  ['>= 4', '< 5']
+  spec.add_runtime_dependency 'activesupport', ['>= 4', '< 5']
+
+  spec.add_development_dependency 'pg'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/acts-as-taggable-array-on/taggable.rb

@@ -0,0 +1,28 @@
+module ActsAsTaggableArrayOn
+  module Taggable
+    def self.included(base)
+      base.extend(ClassMethod)
+    end
+
+    module ClassMethod
+      def acts_as_taggable_array_on(*tag_def)
+        tag_name = tag_def.first
+
+        scope :"with_any_#{tag_name}", ->(* tags){where("#{tag_name} && ARRAY[?]", tags)}
+        scope :"with_all_#{tag_name}", ->(* tags){where("#{tag_name} @> ARRAY[?]", tags)}
+        scope :"without_any_#{tag_name}", ->(* tags){where.not("#{tag_name} && ARRAY[?]", tags)}
+        scope :"without_all_#{tag_name}", ->(* tags){where.not("#{tag_name} @> ARRAY[?]", tags)}
+
+        self.class.class_eval do
+          define_method :"all_#{tag_name}" do
+            all.uniq.pluck("unnest(#{tag_name})")
+          end
+
+          define_method :"#{tag_name}_cloud" do
+            from(select("unnest(#{tag_name}) as tag")).group('tag').order('tag').pluck('tag, count(*) as count')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts-as-taggable-array-on/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTagPgarray
+  VERSION = "0.1.0"
+end

data/lib/acts_as_taggable_array_on.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+require "acts-as-taggable-array-on/version"
+require "acts-as-taggable-array-on/taggable"
+
+ActiveSupport.on_load(:active_record) do
+  include ActsAsTaggableArrayOn::Taggable
+end

data/spec/acts_as_tag_pgarray/taggable_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ActsAsTaggableArrayOn::Taggable do
+  before do 
+    @user1 = User.create colors: ['red', 'blue']
+    @user2 = User.create colors: ['black', 'white', 'red']
+    @user3 = User.create colors: ['black', 'blue']
+
+    User.acts_as_taggable_array_on :colors
+  end
+
+  describe "#acts_as_taggable_array_on" do
+    it "defines named scope to match any tags" do
+      expect(User).to respond_to(:with_any_colors)
+    end
+    it "defines named scope to match all tags" do
+      expect(User).to respond_to(:with_all_colors)
+    end
+    it "defines named scope not to match any tags" do
+      expect(User).to respond_to(:without_any_colors)
+    end
+    it "defines named scope not to match all tags" do
+      expect(User).to respond_to(:without_all_colors)
+    end
+  end
+
+  describe "#with_any_tags" do
+    it "returns users having any tags of args" do
+      expect(User.with_any_colors('red', 'blue')).to match_array([@user1,@user2,@user3])
+    end
+  end
+
+  describe "#with_all_tags" do
+    it "returns users having all tags of args" do
+      expect(User.with_all_colors('red', 'blue')).to match_array([@user1])
+    end
+  end
+  
+  describe "#without_any_tags" do
+    it "returns users having any tags of args" do
+      expect(User.without_any_colors('red', 'blue')).to match_array([])
+    end
+  end
+
+  describe "#without_all_tags" do
+    it "returns users having all tags of args" do
+      expect(User.without_all_colors('red', 'blue')).to match_array([@user2,@user3])
+    end
+  end
+
+  describe "#all_colors" do
+    it "returns all of tag_name" do
+      expect(User.all_colors).to match_array([@user1,@user2,@user3].map(&:colors).flatten.uniq)
+    end
+  end
+
+  describe "#colors_cloud" do
+    it "returns tag cloud for tag_name" do
+      expect(User.colors_cloud).to match_array(
+        [@user1,@user2,@user3].map(&:colors).flatten.group_by(&:to_s).map{|k,v| [k,v.count]}
+      )
+    end
+  end
+
+  describe "with complex scope" do
+    it "works properly" do
+      expect(User.without_any_colors('white').with_any_colors('blue').order(:created_at).limit(10)).to eq [@user1, @user3]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record/railtie'
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = 3
+
+require 'acts_as_taggable_array_on'
+
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+ActiveRecord::Migration.verbose = false
+
+class User < ActiveRecord::Base; end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    ActiveRecord::Base.establish_connection(
+      adapter: "postgresql", 
+      encoding: 'unicode',
+      database: "acts-as-taggable-array-on_test",
+      username: "acts-as-taggable-array-on"
+    )
+    create_database
+  end
+
+  config.after(:all) do
+    drop_database
+  end
+
+  config.after(:each) do
+    User.delete_all
+  end
+end
+
+def create_database
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.text :colors, array: true, defualt: '{}'
+      t.timestamps
+    end
+  end
+end
+
+def drop_database
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

data/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+RSpec::Matchers.define :my_matcher do |expected|
+  match do |actual|
+    true
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: acts-as-taggable-array-on
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuya Miyamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple tagging gem for Rails using postgres array.
+email:
+- miyamototakuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts-as-taggable-array-on.gemspec
+- lib/acts-as-taggable-array-on/taggable.rb
+- lib/acts-as-taggable-array-on/version.rb
+- lib/acts_as_taggable_array_on.rb
+- spec/acts_as_tag_pgarray/taggable_spec.rb
+- spec/spec_helper.rb
+- spec_helper.rb
+homepage: https://github.com/tmiyamon/acts-as-taggable-array-on
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple tagging gem for Rails using postgres array.
+test_files:
+- spec/acts_as_tag_pgarray/taggable_spec.rb
+- spec/spec_helper.rb