pg_tags_on 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38278962c9926471425367aa011dd85845ca992ae02cebc2dd1eca96fab08885
-  data.tar.gz: f4143b59a33dd87d899fad09b63b8b34d164e82be84f9680d79e47389ae4c45f
+  metadata.gz: aac909ac252ee49fd469857036866fb22fbc78db87e19f84f8448637a780af6c
+  data.tar.gz: 4ba45da54dc2782a11ce1cb67b5e61077447f544fcac29c0620c4e261d572ee0
 SHA512:
-  metadata.gz: 8d6976385d81cf2612a88ed66f75cf10e8fc4f5ec342e4d89d3505392e709d6dec50128de4ab19a8605a9e71a50ba462cc8215e1b5be166545d8c8c9cd56a179
-  data.tar.gz: d59946526b621f32030b563a0f6e3af90304e3c685e2c97da41ccc74498ea27583daf0de8a6adc0ecad15f063cbadec6df1efece2be553c1f304324fd9b681eb
+  metadata.gz: 19090081b0fe790204a5384bc85c9e90d29ea824eeb0ace2b103e6a68010379f65fd05e0deef79474a7bbfaa6fdb01b59aaf62d151af2f48317f502a70b43a4c
+  data.tar.gz: 0d2da6a30730fc639b915ceaf88a47bc6219d9ef111188a8f935f39aae936f6afbb36afbbef624ba6fb4b7f35eede5c89c3d0b3b917e526794c73cc16fa988a0

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-== 0.1.0 / 2020-03-11
+## 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

@@ -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 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.
-
+For ```jsonb[]``` columns 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```.
 
 ```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, tag_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,7 +140,7 @@ 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, but this can be achieved at the database level by creating a before create/update row trigger.
 
 ```ruby
 # create
@@ -154,10 +154,16 @@ 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
+
+# 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 +187,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/repositories/array_jsonb_repository.rb

@@ -4,29 +4,32 @@ module PgTagsOn
   module Repositories
     # Operatons for 'jsonb[]' column type
     class ArrayJsonbRepository < ArrayRepository
-      def create(tag)
+      def create(tag, returning: nil)
         with_normalized_tags(tag) do |n_tag|
-          super(n_tag)
+          super(n_tag, returning: returning)
         end
       end
 
-      def update(tag, new_tag)
+      def update(tag, new_tag, returning: nil)
         with_normalized_tags(tag, new_tag) do |n_tag, n_new_tag|
           sql_set = <<-SQL.strip
             #{column_name}[index] = #{column_name}[index] || $2
           SQL
 
-          update_tag(n_tag, sql_set, [query_attribute(n_new_tag.to_json)])
+          update_tag(n_tag,
+                     sql_set,
+                     bindings: [query_attribute(n_new_tag.to_json)],
+                     returning: returning)
         end
       end
 
-      def delete(tag)
+      def delete(tag, returning: nil)
         with_normalized_tags(tag) do |n_tag|
           sql_set = <<-SQL.strip
             #{column_name} = #{column_name}[1:index-1] || #{column_name}[index+1:2147483647]
           SQL
 
-          update_tag(n_tag, sql_set)
+          update_tag(n_tag, sql_set, returning: returning)
         end
       end
 
@@ -68,7 +71,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)))
 
@@ -79,9 +82,12 @@ module PgTagsOn
           FROM records
           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,28 +42,60 @@ module PgTagsOn
         all.count
       end
 
-      def create(tag)
-        return true if tag.blank?
+      def create(tag, returning: nil)
+        raise 'Tag cannot be blank' if tag.blank?
 
-        klass.update_all(column_name => arel_array_cat(arel_column, bind_for(Array.wrap(tag))))
+        perform_update(klass,
+                       { column_name => arel_array_cat(arel_column, bind_for(Array.wrap(tag))) },
+                       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)
+        raise 'Tag cannot be blank' if tag.blank? || new_tag.blank?
 
-        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)))
+        rel = klass.where(column_name => PgTagsOn.query_class.one(tag))
+
+        perform_update(rel,
+                       { column_name => arel_array_replace(arel_column, bind_for(tag), bind_for(new_tag)) },
+                       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, returning: nil)
+        raise 'Tag cannot be blank' if tag.blank?
+
+        rel = klass.where(column_name => PgTagsOn.query_class.one(tag))
+
+        perform_update(rel, { column_name => arel_array_remove(arel_column, bind_for(tag)) }, returning: returning)
       end
 
       private
 
+      def perform_update(rel, updates, returning: nil)
+        updater = update_manager(rel, updates)
+        sql, binds = klass.connection.send :to_sql_and_binds, updater
+        sql += " RETURNING #{Array.wrap(returning).join(', ')}" if returning.present?
+
+        result = klass.connection.exec_query(sql, 'SQL', binds).rows
+
+        returning ? result : true
+      end
+
+      # Method copied from ActiveRecord as there is no way to inject sql into update manager.
+      def 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 = klass.arel_attribute(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
+
       def array_to_recordset
         unnest
       end

data/lib/pg_tags_on/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgTagsOn
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_tags_on
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Catalin Marinescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,56 +80,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.80'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.80'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-description: A gem that makes working with tags stored in a Postgresql column easy.Support
-  for array of string, integer and jsonb values.
+description: |-
+  A gem that makes working with tags stored in a Postgresql column easy.
+                          Support for array of string, integer and jsonb values.
 email:
-- catalin.marinescu@gmail.com
-executables:
-- console
-- setup
+- cata.marinesq@gmail.com
+executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/pg_tags_on.rb
 - lib/pg_tags_on/active_record/arel.rb
 - lib/pg_tags_on/active_record/base.rb
@@ -191,34 +114,14 @@ files:
 - lib/pg_tags_on/tags_query.rb
 - lib/pg_tags_on/validations/validator.rb
 - lib/pg_tags_on/version.rb
-- pg_tags_on.gemspec
-- spec/array_integers/records_spec.rb
-- spec/array_integers/tag_ops_spec.rb
-- spec/array_integers/taggings_spec.rb
-- spec/array_integers/tags_spec.rb
-- spec/array_jsonb/records_spec.rb
-- spec/array_jsonb/tag_ops_spec.rb
-- spec/array_jsonb/taggings_spec.rb
-- spec/array_jsonb/tags_spec.rb
-- spec/array_strings/records_spec.rb
-- spec/array_strings/tag_ops_spec.rb
-- spec/array_strings/taggings_spec.rb
-- spec/array_strings/tags_spec.rb
-- spec/config/database.yml
-- spec/configuration_spec.rb
-- spec/helpers/database_helpers.rb
-- spec/spec_helper.rb
-- spec/support/factory.rb
-- spec/tags_query_spec.rb
-- spec/validator_spec.rb
-- tasks/benchmark.rake
 homepage: http://github.com/cata-m/pg_tags_on
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/cata-m/pg_tags_on/issues
+  changelog_uri: https://github.com/cata-m/pg_tags_on/blob/master/CHANGELOG.md
   homepage_uri: http://github.com/cata-m/pg_tags_on
-  source_code_uri: http://github.com/cata-m/pg_tags_on
-  changelog_uri: http://github.com/cata-m/pg_tags_on/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/cata-m/pg_tags_on
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -227,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -237,24 +140,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Manage tags stored in Postgresql column.
-test_files:
-- spec/array_integers/records_spec.rb
-- spec/array_integers/tag_ops_spec.rb
-- spec/array_integers/taggings_spec.rb
-- spec/array_integers/tags_spec.rb
-- spec/array_jsonb/records_spec.rb
-- spec/array_jsonb/tag_ops_spec.rb
-- spec/array_jsonb/taggings_spec.rb
-- spec/array_jsonb/tags_spec.rb
-- spec/array_strings/records_spec.rb
-- spec/array_strings/tag_ops_spec.rb
-- spec/array_strings/taggings_spec.rb
-- spec/array_strings/tags_spec.rb
-- spec/config/database.yml
-- spec/configuration_spec.rb
-- spec/helpers/database_helpers.rb
-- spec/spec_helper.rb
-- spec/support/factory.rb
-- spec/tags_query_spec.rb
-- spec/validator_spec.rb
+summary: Query and manage tags stored in a Postgresql column.
+test_files: []

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-*.gem

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,9 +0,0 @@
-AllCops:
-  Exclude:
-    - '**/benchmark.rb'
-Layout/LineLength:
-  Max: 120
-Metrics/BlockLength:
-  Max: 120
-Metrics/MethodLength:
-  Max: 20

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at catalin.marinescu@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in pg_tags_on.gemspec
-gemspec