pg_tags_on 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcce5c8d438aa1e92aa724d7ba14275a8f8a40e7515c33cb341eb8270a7b9f57
-  data.tar.gz: 7a61cf5537c72678f82692a999c67b0d5392b675bc5db24593b47341b42a9d74
+  metadata.gz: c61bd469e5458dd169e871a3af323806c36380beba46a575506d33cd18c730dd
+  data.tar.gz: c88ad1665a25c7e9ec406de248bdd0e845c5a1fe20d8fffd93e7e979a5a227fd
 SHA512:
-  metadata.gz: 7330d881597fd28e77bd43ea44054eb9d3fe1f88e48afa00e61820d972afcf6255bbbd4bbb3af1b5061ab38adefa379bdf28a2f913456382907cfdaf8b806ed5
-  data.tar.gz: 25cffbb4603b83da2812e890a1b2ccd4d8c5cf4c0293009b6b4d91075ddc592dca8b9706f8ce73f7fcf30b57a1c6e68807da637571edde8fc2e99131c6d079bb
+  metadata.gz: 05c51681cf87704fb8363f147470e5d4ce85a1c7390f064c055f7da19cdb79a419d046eed1432992ca0e002afe50685fff0d1f84f14b472f8ebc4bf6e7df5d44
+  data.tar.gz: 7481b613c53054dd15ba0cef620dd25ba3f1d09d8b10b5d5a69d03ddc1f02c5c3cedca1f9787bc68fdbb925dd612ff0bc18ca6b1b7413fce70aebb81e50bb887

data/CHANGELOG.md

@@ -1,3 +1,24 @@
-== 0.1.0 / 2020-03-11
+# Changelog
+
+## [0.4.0] - 2020-06-02
+- bump gems versions
+- ISSUE_TEMPLATE.md
+
+## [0.3.0] - 2020-04-15
+- apply PR for gem versions
+- fixed Arel deprecation warning
+- changed validation param names
+
+## [0.2.0] - 2020-09-02
+- Added support for multiple tags creation and deletion
+- Optimizations
+- Updated specs and documentation
+
+## [0.1.4] - 2020-04-12
+- Added support for returning columns after create,update or delete tags operations
+- Updated specs
+- Updated documentation
+
+## [0.1.0] - 2020-03-11
+- First release
 
-First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Catalin Marinescu
+Copyright (c) 2019-2020 Catalin Marinescu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # PgTagsOn
 
-```pg_tags_on``` is a gem that makes working with tags stored in a Postgresql column easy. Supported column types are: ```character varying[]```, ```text[]```, ```integer[]``` and ```jsonb[]```.
+```pg_tags_on``` - keep tags in a column. Supported column types are: ```character varying[]```, ```text[]```, ```integer[]``` and ```jsonb[]```.
 
 
 Requirements:
@@ -15,7 +15,7 @@ Note: this gem is in early stage of development.
 - [Installation](#installation)
 - [Usage](#usage)
   - [ActiveRecord model setup](#activerecord-model-setup)
-  - [Records queries](#records-queries)
+  - [Records queries](#queries)
   - [Tags](#tags)
   - [Set record's tags](#set-records-tags)
   - [Configuration](#configuration)
@@ -42,7 +42,7 @@ Or install it yourself as:
 ## Usage
 ### ActiveRecord model setup
 
-One or multiple columns from a model can be specified:
+One or multiple columns that store tags can be specified:
 
 ```ruby
 class Entity < ActiveRecord::Base
@@ -51,26 +51,26 @@ class Entity < ActiveRecord::Base
 end
 ```
 
-Validations for max. number of tags and max. tag length can be added and errors will be injected into model's ```errors``` object.
-
+In ```jsonb[]``` columns, by default each tag is stored as an object with a single key. For example ```{"tag": "rubygems"}```. If you store multiple attributes in the objects, then you must set also ```has_attributes: true```.
 
 ```ruby
 class Entity < ActiveRecord::Base
-  pg_tags_on :tags, limit: 10, tag_length: 50 # limit to 10 tags and 50 chars. per tag.
+  pg_tags_on :tags, key: :tag                             # => [{tag: 'alpha'}, {tag: 'beta'}]
+  pg_tags_on :other_tags, key: :tag, has_attributes: true # => [{tag: 'alpha', created_by: 'mike', ...}, {tag: 'beta', created_by: 'john', ...}]
 end
 ```
 
-For ```jsonb[]``` you'll have to specify the key for the tag value. If you store multiple attributes in the objects then you must set also ```has_attributes: true```.
+##### Validations
+Maximum number of tags and maximum tag length can be validated. Errors will be injected into model's ```errors``` object.
 
 ```ruby
 class Entity < ActiveRecord::Base
-  pg_tags_on :tags, key: :tag                             # => [{tag: 'alpha'}, {tag: 'beta'}]
-  pg_tags_on :other_tags, key: :tag, has_attributes: true # => [{tag: 'alpha', created_by: 'mike', ...}, {tag: 'beta', created_by: 'john', ...}]
+  pg_tags_on :tags, limit: 10, length: 50 # limit to 10 tags and 50 chars. per tag.
 end
 ```
 
-### Records Queries
-```pg_tags_on``` registers ```Tags``` class in model's predicate builder, so you can filter the records by tags as you are usually doing in Rails. Class name can be changed if you have conflicts or you don't like it, see the [configuration](#configuration) section.
+### Queries
+```pg_tags_on``` registers ```Tags``` class in model's predicate builder, so records can be filtered using ActiveRecord's DSL. Class name can be changed if you have conflicts or you don't like it, see the [configuration](#configuration) section.
 
 * Find records by tag:
 
@@ -81,25 +81,25 @@ Entity.where(tags: Tags.one('alpha'))
 * Find records that have exact same tags as the list, order is not important:
 
 ```ruby
-Entity.where(tags: Tags.eq('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+Entity.where(tags: Tags.eq('alpha', 'beta', 'gamma')) # Array argument is allowed too for every method.
 ```
 
 * Find records that includes all the tags from the list:
 
 ```ruby
-Entity.where(tags: Tags.all('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+Entity.where(tags: Tags.all('alpha', 'beta', 'gamma'))
 ```
 
 * Find records that includes any tag from the list:
 
 ```ruby
-Entity.where(tags: Tags.any('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+Entity.where(tags: Tags.any('alpha', 'beta', 'gamma'))
 ```
 
 * Find records that have all the tags included in the list:
 
 ```ruby
-Entity.where(tags: Tags.in('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+Entity.where(tags: Tags.in('alpha', 'beta', 'gamma'))
 ```
 
 All the above queries supports negation operator. Example:
@@ -140,24 +140,32 @@ Entity.tags.taggings
   => [#<PgTagsOn::Tag name: "alpha", entity_id: 1>, #<PgTagsOn::Tag name: "beta", entity_id: 1>, #<PgTagsOn::Tag name: "alpha", entity_id: 2>, ... ]
 ```
 
-Create, update and delete methods are using, for performance reasons, Postgresql functions to manipulate the arrays, so ActiveRecord models are not instantiated. A frequent problem is to ensure uniqueness of the tags for a record, and this can be achieved at the database level with a before create/update row trigger.
+Create, update and delete methods are using, for performance reasons, Postgresql functions to manipulate the arrays, so ActiveRecord models are not instantiated. A frequent problem is to ensure uniqueness of the tags for a record, and this can be achieved at the database level by creating a before create/update row trigger.
 
 ```ruby
 # create
-Entity.tags.create('alpha')             # add tag to all records
-Entity.where(...).tags.create('alpha')  # add tag to filtered records
+Entity.tags.create('alpha')              # add tag to all records
+Entity.tags.create(%w[alpha beta gamma]) # add many tags to all records
+Entity.where(...).tags.create('alpha')   # add tag to filtered records
 
 # update
 Entity.tags.update('alpha', 'a')             # rename tag for all records
 Entity.where(...).tags.update('alpha', 'a')  # rename tag for filtered records
 
 # delete
-Entity.tags.delete('alpha')             # delete tag from all records
-Entity.where(...).tags.delete('alpha')  # delete tag from filtered records
+Entity.tags.delete('alpha')              # delete tag from all records
+Entity.tags.delete(%w[alpha beta gamma]) # delete many tags from all records
+Entity.where(...).tags.delete('alpha')   # delete tag from filtered records
+
+# any of these methods accepts :returning option
+Entity.tags.update('alpha', 'a', returning: %w[id tags])
+=> [[1, '{a}'], ...]
 ```
 
+
+
 ### Set record's tags
-By default ```pg_tags_on``` does not add any logic in the way that the tags are set and saved in database. It'll let all the transformations, like lowercase, strip spaces, unique etc..., at the programmer choice.
+By default ```pg_tags_on``` does not add any logic in the way that the tags are set for the model and saved in database. It'll let all the transformations, like lowercase, strip spaces, unique etc..., at the programmer choice. Specific setters can be implemented.
 
 
 ### Configuration
@@ -181,7 +189,7 @@ rake pg_tags_on:benchmark
 1. Fork it ( http://github.com/cata-m/pg_tags_on/fork )
 2. Install gem dependencies: ```bundle install```
 3. Create a new feature or fix branch like: 'feature/new-feature' or 'fix/fix-some-issues'
-4. Make sure all tests pass: ```bundle exec rake spec```
+4. Write your modifications and make sure all tests pass: ```bundle exec rake spec```
 5. Commit your changes: git commit -am 'your changes'
 6. Push to the branch
 7. Create new pull request

data/lib/pg_tags_on/active_record/base.rb

@@ -12,7 +12,7 @@ module PgTagsOn
 
           pg_tags_on_init_model unless @pg_tags_on_init_model
           pg_tags_on_settings[name] = options.deep_symbolize_keys
-          validates(name, 'pg_tags_on/tags': true) if %i[limit tag_length].any? { |k| options[k] }
+          validates(name, 'pg_tags_on/tags': true) if %i[limit length].any? { |k| options[k] }
           instance_eval <<-RUBY, __FILE__, __LINE__ + 1
             scope :#{name}, -> { PgTagsOn::Repository.new(self, "#{name}") }
           RUBY

data/lib/pg_tags_on/repositories/array_jsonb_repository.rb

@@ -4,40 +4,59 @@ module PgTagsOn
   module Repositories
     # Operatons for 'jsonb[]' column type
     class ArrayJsonbRepository < ArrayRepository
-      def create(tag)
-        with_normalized_tags(tag) do |n_tag|
-          super(n_tag)
-        end
+      def create(tag_or_tags, returning: nil)
+        tags = normalize_tags(tag_or_tags)
+
+        super(tags, returning: returning)
       end
 
-      def update(tag, new_tag)
-        with_normalized_tags(tag, new_tag) do |n_tag, n_new_tag|
-          sql_set = <<-SQL.strip
-            #{column_name}[index] = #{column_name}[index] || $2
-          SQL
+      def update(tag, new_tag, returning: nil)
+        n_tag, n_new_tag = normalize_tags([tag, new_tag])
 
-          update_tag(n_tag, sql_set, [query_attribute(n_new_tag.to_json)])
-        end
+        sql_set = <<-SQL.strip
+          #{column_name}[index] = #{column_name}[index] || $2
+        SQL
+
+        update_tag(n_tag,
+                   sql_set,
+                   bindings: [query_attribute(n_new_tag.to_json)],
+                   returning: returning)
       end
 
-      def delete(tag)
-        with_normalized_tags(tag) do |n_tag|
-          sql_set = <<-SQL.strip
-            #{column_name} = #{column_name}[1:index-1] || #{column_name}[index+1:2147483647]
-          SQL
+      def delete(tag_or_tags, returning: nil)
+        tags = normalize_tags(tag_or_tags)
+        sm = build_tags_select_manager
 
-          update_tag(n_tag, sql_set)
+        tags.each do |tag|
+          sm.where(arel_infix_operation('@>', Arel.sql('tag'), bind_for(tag.to_json, nil)).not)
         end
+
+        rel = klass.where(column_name => PgTagsOn.query_class.any(tag_or_tags))
+        value = arel_function('array', sm)
+
+        perform_update(rel, { column_name => value }, returning: returning)
       end
 
       private
 
-      def with_normalized_tags(*tags, &block)
-        normalized_tags = Array.wrap(tags).flatten.map do |tag|
-          key? && Array.wrap(key).reverse.inject(tag) { |a, n| { n => a } } || tag
-        end
+      # Returns SelectManager for unnested tags.
+      # sql: select tag from ( select unnest(tags_jsonb) as tag ) as _tags
+      def build_tags_select_manager
+        Arel::SelectManager.new
+                           .project('tag')
+                           .from(Arel::SelectManager.new
+                  .project(unnest.as('tag'))
+                  .as('_tags'))
+      end
+
+      def normalize_tags(tag_or_tags)
+        tags = Array.wrap(tag_or_tags)
+
+        return tags unless key?
 
-        block.call(*normalized_tags)
+        tags.map do |tag|
+          Array.wrap(key).reverse.inject(tag) { |a, n| { n => a } }
+        end
       end
 
       def array_to_recordset
@@ -68,7 +87,7 @@ module PgTagsOn
           .where(arel_infix_operation('@>', column, value))
       end
 
-      def update_tag(tag, set_sql, bindings = [])
+      def update_tag(tag, set_sql, bindings: [], returning: nil)
         subquery = taggings_with_ordinality_query(tag)
                    .where(arel_table[:id].in(arel_sql(klass.reselect('id').to_sql)))
 
@@ -80,8 +99,12 @@ module PgTagsOn
           WHERE #{table_name}.id = records.id
         SQL
 
+        sql += " RETURNING #{Array.wrap(returning).join(', ')}" if returning.present?
+
         bindings = [query_attribute(tag.to_json)] + Array.wrap(bindings)
-        klass.connection.exec_query(sql, 'SQL', bindings)
+        result = klass.connection.exec_query(sql, 'SQL', bindings).rows
+
+        returning ? result : true
       end
     end
   end

data/lib/pg_tags_on/repositories/array_repository.rb

@@ -42,30 +42,43 @@ module PgTagsOn
         all.count
       end
 
-      def create(tag)
-        return true if tag.blank?
+      def create(tag_or_tags, returning: nil)
+        value = arel_array_cat(arel_column, bind_for(Array.wrap(tag_or_tags)))
 
-        klass.update_all(column_name => arel_array_cat(arel_column, bind_for(Array.wrap(tag))))
+        perform_update(klass, { column_name => value }, returning: returning)
       end
 
-      def update(tag, new_tag)
-        return true if tag.blank? || new_tag.blank? || tag == new_tag
+      def update(tag, new_tag, returning: nil)
+        rel = klass.where(column_name => PgTagsOn.query_class.one(tag))
+        value = arel_array_replace(arel_column, bind_for(tag), bind_for(new_tag))
 
-        klass
-          .where(column_name => PgTagsOn.query_class.one(tag))
-          .update_all(column_name => arel_array_replace(arel_column, bind_for(tag), bind_for(new_tag)))
+        perform_update(rel, { column_name => value }, returning: returning)
       end
 
-      def delete(tag)
-        klass
-          .where(column_name => PgTagsOn.query_class.one(tag))
-          .update_all(column_name => arel_array_remove(arel_column, bind_for(tag)))
+      def delete(tag_or_tags, returning: nil)
+        tags = Array.wrap(tag_or_tags)
+        rel = klass.where(column_name => PgTagsOn.query_class.any(tags))
+        sm = Arel::SelectManager.new
+                                .project(unnest)
+                                .except(
+                                  Arel::SelectManager.new
+                                    .project(arel_unnest(arel_cast(bind_for(tags), native_column_type)))
+                                )
+        value = arel_function('array', sm)
+
+        perform_update(rel, { column_name => value }, returning: returning)
       end
 
       private
 
-      def array_to_recordset
-        unnest
+      def perform_update(rel, updates, returning: nil)
+        update_manager = get_update_manager(rel, updates)
+        sql, binds = klass.connection.send :to_sql_and_binds, update_manager
+        sql += " RETURNING #{Array.wrap(returning).join(', ')}" if returning.present?
+
+        result = klass.connection.exec_query(sql, 'SQL', binds).rows
+
+        returning ? result : true
       end
 
       def taggings_query
@@ -78,14 +91,14 @@ module PgTagsOn
           .as('taggings')
       end
 
-      def ref
-        "#{table_name}.#{column_name}"
-      end
-
       def unnest
         arel_unnest(arel_column)
       end
 
+      def array_to_recordset
+        unnest
+      end
+
       def unnest_with_ordinality(alias_table: 't')
         "#{unnest.to_sql} WITH ORDINALITY #{alias_table}(name, index)"
       end

data/lib/pg_tags_on/repositories/base_repository.rb

@@ -28,10 +28,6 @@ module PgTagsOn
         @table_name ||= klass.table_name
       end
 
-      def cast_type
-        @cast_type ||= klass.type_for_attribute(column_name)
-      end
-
       def arel_table
         klass.arel_table
       end
@@ -39,6 +35,45 @@ module PgTagsOn
       def arel_column
         arel_table[column_name]
       end
+
+      # Returns ActiveRecord Column instance
+      def ar_column
+        @ar_column ||= klass.columns_hash[column_name.to_s]
+      end
+
+      def ref
+        "#{table_name}.#{column_name}"
+      end
+
+      # Returns Type instance
+      def cast_type
+        @cast_type ||= klass.type_for_attribute(column_name)
+      end
+
+      # Returns db type as string.
+      # Ex: character varying[], integer[]
+      def native_column_type
+        type = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::NATIVE_DATABASE_TYPES.fetch(cast_type.type)[:name]
+        type += '[]' if ar_column.array?
+
+        type
+      end
+
+      # Method copied from ActiveRecord as there is no way to inject sql into update manager.
+      def get_update_manager(rel, updates)
+        raise ArgumentError, 'Empty list of attributes to change' if updates.blank?
+
+        stmt = ::Arel::UpdateManager.new
+        stmt.table(arel_table)
+        stmt.key = arel_table[klass.primary_key]
+        stmt.take(rel.arel.limit)
+        stmt.offset(rel.arel.offset)
+        stmt.order(*rel.arel.orders)
+        stmt.wheres = rel.arel.constraints
+        stmt.set rel.send(:_substitute_values, updates)
+
+        stmt
+      end
     end
   end
 end

data/lib/pg_tags_on/validations/validator.rb

@@ -4,7 +4,7 @@ module PgTagsOn
   # Validator for max. number of tags and max. tag length.
   #
   #   class Entity
-  #     pg_tags_on :tags, limit: 20, tag_length: 64
+  #     pg_tags_on :tags, limit: 20, length: 64
   #   end
   #
   class TagsValidator < ActiveModel::EachValidator
@@ -15,7 +15,7 @@ module PgTagsOn
 
     def validate_each(record, attribute, value)
       validate_limit(record, attribute, value)
-      validate_tag_length(record, attribute, value)
+      validate_length(record, attribute, value)
 
       record.errors.present?
     end
@@ -31,8 +31,8 @@ module PgTagsOn
       record.errors.add(attr, "size exceeded #{limit} tags") if value.size > limit.to_i
     end
 
-    def validate_tag_length(record, attr, value)
-      limit, key = klass.pg_tags_on_options_for(attr).values_at(:tag_length, :key)
+    def validate_length(record, attr, value)
+      limit, key = klass.pg_tags_on_options_for(attr).values_at(:length, :key)
       return true unless limit && value
 
       value.map! { |tag| tag.with_indifferent_access.dig(*key) } if key