pg_taggable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec57f99287e3bb16b29e459e42c0f3c5a24d6f967917906d88dadfe491d133e3
+  data.tar.gz: 525995c96c17957ba46a5025d250c1703efec6da6841277864befd0278072449
+SHA512:
+  metadata.gz: caa213bb0b77a0c5f71922337563d9bf3222cf98a17571e90f700b5fabf5b345c1c4494c71c45889e8e081b1c0c44c200fa4c228638408d39d2039d26b5bca73
+  data.tar.gz: b4760ae519a53f6b414e5578ac6ec241b30b3342acdc82057a9a437599c65ce71bd473ef2be8ccd8c6ee99bff393fc775e647fee75ed5333f519b1ddb8617eda

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Yi-Cyuan Chen
+
+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,217 @@
+# PgTaggable
+A simple tagging gem for Rails using PostgreSQL array.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pg_taggable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install pg_taggable
+```
+
+## Usage
+### Setup
+Add array columns and index to your table. For example:
+```Ruby
+class CreatePosts < ActiveRecord::Migration[8.0]
+  def change
+    create_table :posts do |t|
+      t.string :tags, array: true, default: []
+
+      t.timestamps
+
+      t.index :tags, using: 'gin'
+    end
+  end
+end
+```
+
+Indicate that attribute is "taggable" in a Rails model, like this:
+```Ruby
+class Post < ActiveRecord::Base
+  taggable :tags
+end
+```
+
+### Modify
+You can modify it like normal array
+```Ruby
+#set
+post.tags = ['food', 'travel']
+
+#add
+post.tags += ['food']
+post.tags += ['food', 'travel']
+post.tags << 'food'
+
+#remove
+post.tags -= ['food']
+```
+
+### Queries
+#### any_#{tag_name}
+Find records with any of the tags.
+```Ruby
+Post.where(any_tags: ['food', 'travel'])
+```
+
+You can use with `not`
+```Ruby
+Post.where.not(any_tags: ['food', 'travel'])
+```
+
+#### all_#{tag_name}
+Find records with all of the tags
+```Ruby
+Post.where(all_tags: ['food', 'travel'])
+```
+
+#### #{tag_name}_in
+Find records that have all the tags included in the list
+```Ruby
+Post.where(tags_in: ['food', 'travel'])
+```
+
+#### #{tag_name}_eq
+Find records that have exact same tags as the list, order is not important
+```Ruby
+Post.where(tags_eq: ['food', 'travel'])
+```
+
+#### #{tag_name}
+Find records that have exact same tags as the list, order is important. This is the default behavior.
+```Ruby
+Post.where(tags: ['food', 'travel'])
+```
+
+Assume a post has tags: 'A', 'B'
+|Method|Query|Matched|
+|-|-|-|
+|any_tags|A|True|
+|any_tags|A, B|True|
+|any_tags|B, A|True|
+|any_tags|A, B, C|True|
+|all_tags|A|True|
+|all_tags|A, B|True|
+|all_tags|B, A|True|
+|all_tags|A, B, C|False|
+|tags_in|A|False|
+|tags_in|A, B|True|
+|tags_in|B, A|True|
+|tags_in|A, B, C|True|
+|tags_eq|A|False|
+|tags_eq|A, B|True|
+|tags_eq|B, A|True|
+|tags_eq|A, B, C|False|
+|tags|A|False|
+|tags|A, B|True|
+|tags|B, A|False|
+|tags|A, B, C|False|
+
+### Class Methods
+#### taggable(name, unique: true)
+Indicate that attribute is "taggable".
+
+#### unique: true
+You can use `unique` option to ensure that tags are unique. It will be deduplicated before saving. The default is `true`.
+
+```Ruby
+# taggable :tags, unique: true
+post = Post.create(tags: ['food', 'travel', 'food'])
+post.tags
+# => ['food', 'travel']
+
+# taggable :tags, unique: false
+post = Post.create(tags: ['food', 'travel', 'food'])
+post.tags
+# => ['food', 'travel', 'food']
+```
+
+#### #{tag_name}
+Return unnested tags. The column name will be `tag`, For example:
+```Ruby
+Post.tags
+# => #<ActiveRecord::Relation [#<Post tag: "food", id: nil>, #<Post tag: "travel", id: nil>, #<Post tag: "travel", id: nil>, #<Post tag: "technology", id: nil>]>
+
+Post.tags.size
+# => 4
+
+Post.tags.distinct.size
+# => 3
+
+Post.tags.distinct.pluck(:tag)
+# => ["food", "travel", "technology"]
+
+Post.tags.group(:tag).count
+# => {"food"=>1, "travel"=>2, "technology"=>1}
+```
+
+#### uniq_#{tag_name}
+Return an array of unique tag strings.
+```Ruby
+Post.uniq_tags
+# => ["food", "travel", "technology"]
+
+# equal to
+Post.tags.distinct.pluck(:tag)
+```
+
+#### count_#{tag_name}
+Calculates the number of occurrences of each tag.
+```Ruby
+Post.count_tags
+# => {"food"=>1, "travel"=>2, "technology"=>1}
+
+# equal to
+Post.tags.group(:tag).count
+```
+
+### Case Insensitive
+If you use `string` type, it is case sensitive.
+```Ruby
+# tags is string[]
+post = Post.create(tags: ['food', 'travel', 'Food'])
+post.tags
+# => ['food', 'travel', 'Food']
+```
+
+If you want case insensitive, you need to use `citext`
+```Ruby
+class CreatePosts < ActiveRecord::Migration[8.0]
+  enable_extension('citext') unless extensions.include?('citext')
+
+  def change
+    create_table :posts do |t|
+      t.citext :tags, array: true, default: []
+
+      t.timestamps
+
+      t.index :tags, using: 'gin'
+    end
+  end
+end
+```
+
+You will get the diffent result
+```Ruby
+# tags is citext[]
+post = Post.create(tags: ['food', 'travel', 'Food'])
+post.tags
+# => ['food', 'travel']
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/pg_taggable  
+Author: Chen, Yi-Cyuan (emn178@gmail.com)

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/pg_taggable/predicate_handler.rb

@@ -0,0 +1,29 @@
+module PgTaggable
+  class PredicateHandler < ActiveRecord::PredicateBuilder::ArrayHandler
+    attr_reader :taggable_attributes
+
+    def initialize(predicate_builder, taggable_attributes)
+      @taggable_attributes = taggable_attributes
+      super(predicate_builder)
+    end
+
+    def call(attribute, query)
+      taggable_attribute = taggable_attributes[attribute.name]
+      if taggable_attribute
+        attribute.name, type, operator = taggable_attribute
+        query_attribute = ActiveRecord::Relation::QueryAttribute.new(attribute.name, query, type)
+        bind_param = Arel::Nodes::BindParam.new(query_attribute)
+        if operator == '='
+          operator = '@>'
+          Arel::Nodes::NamedFunction.new('ARRAY_LENGTH', [attribute, 1]).eq(query.size).and(
+            Arel::Nodes::InfixOperation.new(operator, attribute, bind_param)
+          )
+        else
+          Arel::Nodes::InfixOperation.new(operator, attribute, bind_param)
+        end
+      else
+        super(attribute, query)
+      end
+    end
+  end
+end

data/lib/pg_taggable/taggable.rb

@@ -0,0 +1,40 @@
+module PgTaggable
+  module Taggable
+    @@taggable_attributes = nil
+
+    def predicate_builder
+      register_taggable_handler
+      super
+    end
+
+    def register_taggable_handler
+      return if @register_taggable_handler || !@@taggable_attributes
+
+      @register_taggable_handler = true
+      predicate_builder.register_handler(Array, PgTaggable::PredicateHandler.new(predicate_builder, @@taggable_attributes))
+    end
+
+    def taggable(name, unique: true)
+      type = type_for_attribute(name)
+      @@taggable_attributes ||= {}
+      @@taggable_attributes = @@taggable_attributes.merge(
+        "any_#{name}" => [ name, type, '&&' ],
+        "all_#{name}" => [ name, type, '@>' ],
+        "#{name}_in" => [ name, type, '<@' ],
+        "#{name}_eq" => [ name, type, '=' ]
+      )
+
+      if unique
+        if type.type == :citext
+          before_save { assign_attributes(name => read_attribute(name).uniq { |t| t.downcase }) }
+        else
+          before_save { assign_attributes(name => read_attribute(name).uniq) }
+        end
+      end
+
+      scope name, -> { unscope(:where).from(select("UNNEST(#{table_name}.#{name}) AS tag"), table_name) }
+      scope "uniq_#{name}", -> { public_send(name).distinct.pluck(:tag) }
+      scope "count_#{name}", -> { public_send(name).group(:tag).count }
+    end
+  end
+end

data/lib/pg_taggable/version.rb

@@ -0,0 +1,3 @@
+module PgTaggable
+  VERSION = '0.1.0'
+end

data/lib/pg_taggable.rb

@@ -0,0 +1,10 @@
+require 'pg_taggable/version'
+require 'pg_taggable/predicate_handler'
+require 'pg_taggable/taggable'
+
+module PgTaggable
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend PgTaggable::Taggable
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: pg_taggable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yi-Cyuan Chen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+description: A simple tagging gem for Rails using PostgreSQL array.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/pg_taggable.rb
+- lib/pg_taggable/predicate_handler.rb
+- lib/pg_taggable/taggable.rb
+- lib/pg_taggable/version.rb
+homepage: https://github.com/emn178/pg_taggable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/emn178/pg_taggable
+  source_code_uri: https://github.com/emn178/pg_taggable
+  changelog_uri: https://github.com/emn178/pg_taggable/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A simple tagging gem for Rails using PostgreSQL array.
+test_files: []