pg_tags_on 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7309e077c88514299fcd0166407bae538e99f6cf6308893957376ee2f7ff2959
+  data.tar.gz: 893119a8b6487ba8bb7acbe5a82cca67ac4dc7bc14bf760416024b98c2359381
+SHA512:
+  metadata.gz: 1ba49f001365da7e716585d062f653dfe356b8c7355e1d7e99ba0a14926f4187e6ecb1217eb7b818684d7d29772fba7abc68722eeefb63847be1fea031eb4908
+  data.tar.gz: cf84932b3a0b46ec17e1dbbb2cc07b1f807940b7bea8a3aa2ac10af96b38a58774266ae93ebc9571d64f5b79f21c4ffb4243c5654bde412800c144be2b997065

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+== 0.1.0 / 2020-03-11
+
+First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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

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

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    pg_tags_on (0.1.0)
+      activerecord (~> 6.0)
+      activesupport (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    faker (2.10.2)
+      i18n (>= 1.6, < 2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pg (1.2.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  faker (~> 2.10)
+  pg (~> 1.2)
+  pg_tags_on!
+  pry (~> 0.12)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 0.80)
+  simplecov (~> 0.18)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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
+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,195 @@
+# 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[]```.
+
+
+Requirements:
+* Postgresql >= 12
+* Rails >= 6
+
+
+Note: this gem is in early stage of development.
+
+## Table of contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [ActiveRecord model setup](#activerecord-model-setup)
+  - [Records queries](#records-queries)
+  - [Tags](#tags)
+  - [Set record's tags](#set-records-tags)
+  - [Configuration](#configuration)
+- [Benchmarks](#benchmarks)
+- [Contributing](#contributing)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_tags_on'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_tags_on
+
+## Usage
+### ActiveRecord model setup
+
+One or multiple columns from a model can be specified:
+
+```ruby
+class Entity < ActiveRecord::Base
+  pg_tags_on :tags
+  pg_tags_on :other_tags
+end
+```
+
+Validations for max. number of tags and max. tag length can be added and errors will be injected into model's ```errors``` object.
+
+
+```ruby
+class Entity < ActiveRecord::Base
+  pg_tags_on :tags, limit: 10, tag_length: 50 # limit to 10 tags and 50 chars. per tag.
+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```.
+
+```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', ...}]
+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.
+
+* Find records by tag:
+
+```ruby
+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
+```
+
+* Find records that includes all the tags from the list:
+
+```ruby
+Entity.where(tags: Tags.all('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+```
+
+* Find records that includes any tag from the list:
+
+```ruby
+Entity.where(tags: Tags.any('alpha', 'beta', 'gamma')) # Array argument is allowed, too
+```
+
+* 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
+```
+
+All the above queries supports negation operator. Example:
+
+```ruby
+Entity.where.not(tags: Tags.one('alpha'))
+```
+
+### Tags
+```pg_tags_on``` creates a proxy at the class level, with the same name as the column, that can be used to query or do operations on tags.
+
+Tags queries:
+
+```ruby
+Entity.tags.all
+  => [#<PgTagsOn::Tag name: "alpha">, #<PgTagsOn::Tag name: "beta">, ... ]
+
+Entity.tags.all_with_counts
+=> [#<PgTagsOn::Tag name: "alpha", count: 10>, #<PgTagsOn::Tag name: "beta", count: 20>, ... ]
+
+Entity.tags.count
+=> 123
+
+# filters can be applied
+
+Entity.where(...).tags.all.where('name ilike ?', 'alp%')
+=> [#<PgTagsOn::Tag name: "alpha">, #<PgTagsOn::Tag name: "alpine">, ... ]
+
+Entity.where(...).tags.all_with_counts.where('name ilike ?', 'alp%')
+=> [#<PgTagsOn::Tag name: "alpha", count: 10>, #<PgTagsOn::Tag name: "alpine", count: 20>, ... ]
+
+```
+
+Taggings:
+
+```ruby
+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.
+
+```ruby
+# create
+Entity.tags.create('alpha')             # add tag 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
+```
+
+### 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.
+
+
+### Configuration
+
+You can configure ```pg_tags_on``` in an initializer ```config/initializers/pg_tags_on.rb```:
+
+```ruby
+PgTagsOn.configure do |c|
+  c.query_class = 'Tagz'
+end
+```
+
+### Benchmarks
+
+```ruby
+rake pg_tags_on:benchmark
+```
+
+## Contributing
+
+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```
+5. Commit your changes: git commit -am 'your changes'
+6. Push to the branch
+7. Create new pull request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PgTagsOn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cata-m/pg_tags_on/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'active_record'
+require 'active_support/all'
+require 'faker'
+require './lib/pg_tags_on'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'active_record'
+require 'bundler/setup'
+require 'pg_tags_on'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pg_tags_on/active_record/arel.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module PgTagsOn
+  module ActiveRecord
+    # Arel extension
+    module Arel
+      def arel_function(name, *args)
+        ::Arel::Nodes::NamedFunction.new(name, args)
+      end
+
+      # unnest function
+      # +attr+ Arel attribute
+      def arel_unnest(attr)
+        arel_function('unnest', attr)
+      end
+
+      # distinct function
+      def arel_distinct(node)
+        arel_function('distinct', node)
+      end
+
+      # array_cat function
+      def arel_array_cat(attr, value)
+        arel_function('array_cat', attr, value)
+      end
+
+      # array_replace function
+      def arel_array_replace(attr, value1, value2)
+        arel_function('array_replace', attr, value1, value2)
+      end
+
+      # array_remove function
+      def arel_array_remove(attr, value)
+        arel_function('array_remove', attr, value)
+      end
+
+      def arel_jsonb_extract_path(attr, *args)
+        arel_function('jsonb_extract_path', [attr, *args])
+      end
+
+      def arel_query_attribute(attr, value, cast_type)
+        ::ActiveRecord::Relation::QueryAttribute.new(attr, value, cast_type)
+      end
+
+      def arel_bind(query_attr)
+        ::Arel::Nodes::BindParam.new(query_attr)
+      end
+
+      def arel_infix_operation(operator, left, right)
+        ::Arel::Nodes::InfixOperation.new(operator, left, right)
+      end
+
+      def arel_cast(attr, type)
+        ::Arel::Nodes::InfixOperation.new('::', attr, arel_sql(type))
+      end
+
+      def arel_sql(expr)
+        ::Arel.sql(expr)
+      end
+
+      def arel_build_quoted(expr)
+        ::Arel::Nodes.build_quoted(expr)
+      end
+    end
+  end
+end

data/lib/pg_tags_on/active_record/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PgTagsOn
+  module ActiveRecord
+    # ActiveRecord::Base extension
+    module Base
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def pg_tags_on(name, options = {})
+          raise PgTagsOn::ColumnNotFoundError, "#{name} column not found" unless column_names.include?(name.to_s)
+
+          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] }
+          instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+            scope :#{name}, -> { PgTagsOn::Repository.new(self, "#{name}") }
+          RUBY
+        end
+
+        def pg_tags_on_init_model
+          @pg_tags_on_init_model ||= begin
+            PgTagsOn.register_query_class
+            predicate_builder.register_handler(PgTagsOn.query_class, PgTagsOn::PredicateHandler.new(predicate_builder))
+            cattr_accessor :pg_tags_on_settings
+            self.pg_tags_on_settings ||= {}.with_indifferent_access
+          end
+        end
+
+        def pg_tags_on_options_for(name)
+          self.pg_tags_on_settings[name.to_sym]
+        end
+
+        def pg_tags_on_reset
+          @pg_tags_on_init_model = false
+          self.pg_tags_on_settings = nil
+        end
+      end
+    end
+  end
+end

data/lib/pg_tags_on/benchmark/benchmark.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module PgTagsOn
+  # Performs benchmarking for a field, on an existing set of data.
+  class Benchmark
+    def initialize(klass, field)
+      @klass = klass
+      @field = field
+    end
+
+    def call
+      tags = Entity.send(field).all.limit(5).pluck(:name)
+
+      ::Benchmark.bmbm do |b|
+        b.report('Tags.one') do
+          Entity.where(field => Tags.one(tags.first)).all.to_a
+        end
+        b.report('Tags.eq') do
+          Entity.where(field => Tags.eq(tags[0..1])).all.to_a
+        end
+        b.report('Tags.any') do
+          Entity.where(field => Tags.any(tags)).all.to_a
+        end
+        b.report('Tags.all') do
+          Entity.where(field => Tags.all(tags)).all.to_a
+        end
+        b.report('Tags.in') do
+          Entity.where(field => Tags.in(tags)).all.to_a
+        end
+        b.report('Entity.tags.all') do
+          Entity.send(field).all.to_a
+        end
+        b.report('Entity.tags.taggings') do
+          Entity.send(field).taggings.all.to_a
+        end
+        b.report('Entity.tags.create') do
+          Entity.send(field).create('new-tag')
+        end
+        b.report("Entity.tags.update") do
+          Entity.send(field).update(tags.pop, tags[0]+tags[1])
+        end
+        b.report("Entity.tags.delete") do
+          Entity.send(field).delete(tags.pop)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :klass, :field
+  end
+end

data/lib/pg_tags_on/predicate_handler/array_integer_handler.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PgTagsOn
+  class PredicateHandler
+    # Predicate handler for character varying[] column type
+    class ArrayIntegerHandler < BaseHandler
+    end
+  end
+end

data/lib/pg_tags_on/predicate_handler/array_jsonb_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PgTagsOn
+  class PredicateHandler
+    # Predicate handler for jsonb[] column type
+    class ArrayJsonbHandler < BaseHandler
+      # Transforms value in Hash if :key option is set
+      def value
+        @value ||= begin
+          return query_value unless key?
+
+          query_value.each.map do |val|
+            key.reverse.inject(val) { |a, n| { n => a } }
+          end
+        end
+      end
+
+      def query_value
+        @query_value ||= Array.wrap(query.value)
+      end
+
+      def key
+        @key ||= Array.wrap(settings[:key])
+      end
+
+      def key?
+        key.present?
+      end
+    end
+  end
+end