pg_tags_on 0.1.3 → 0.1.4

data/spec/array_strings/records_spec.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'ArrayStrings::Records' do
-  before(:all) do
-    @column = :tags_str # defined as instance var as it is used in before_all callback
-    Entity.pg_tags_on @column
-    truncate && Factory.array_strings
-  end
-
-  let(:column) { @column }
-  let(:ref) { %("#{Entity.table_name}"."#{column}") }
-  let(:relation) { Entity.send(column) }
-
-  it 'find records by tag' do
-    rel = Entity.where(column => Tags.one('b'))
-
-    expect(rel.to_sql).to include(%(#{ref} @> '{b}'))
-    expect(rel.count).to be_eql(2)
-  end
-
-  it 'find records without tag' do
-    rel = Entity.where.not(column => Tags.one('b'))
-
-    expect(rel.to_sql).to include(%(NOT (#{ref} @> '{b}')))
-    expect(rel.count).to be_eql(1)
-  end
-
-  it 'find records with exact same tags' do
-    rel = Entity.where(column => Tags.eq(%w[c b]))
-
-    expect(rel.count).to be_eql(1)
-  end
-
-  it 'find records with all tags' do
-    rel = Entity.where(column => Tags.all(%w[a b c]))
-
-    expect(rel.to_sql).to include(%(#{ref} @> '{a,b,c}'))
-    expect(rel.count).to be_eql(1)
-  end
-
-  it 'find records without tags' do
-    rel = Entity.where.not(column => Tags.all(%w[a b]))
-
-    expect(rel.to_sql).to include(%(NOT (#{ref} @> '{a,b}')))
-    expect(rel.count).to be_eql(2)
-  end
-
-  it 'find records with any tag' do
-    rel = Entity.where(column => Tags.any(%w[a b c]))
-
-    expect(rel.to_sql).to include(%(#{ref} && '{a,b,c}'))
-    expect(rel.count).to be_eql(2)
-  end
-
-  it 'find records with tags included in tag list' do
-    rel = Entity.where(column => Tags.in(%w[a b c]))
-
-    expect(rel.to_sql).to include(%(#{ref} <@ '{a,b,c}'))
-    expect(rel.count).to be_eql(2)
-  end
-end

data/spec/array_strings/tag_ops_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'ArrayStrings::TagOps' do
-  before(:all) do
-    @column = :tags_str # defined as instance var as it is used in before_all callback
-    Entity.pg_tags_on @column
-  end
-
-  before do
-    truncate && Factory.array_strings
-  end
-
-  let(:column) { @column }
-  let(:ref) { %("#{Entity.table_name}"."#{column}") }
-  let(:relation) { Entity.send(column) }
-
-  context 'create' do
-    it 'create tag' do
-      relation.create('new-tag1')
-
-      Entity.all.each do |entity|
-        expect(entity.send(column)).to include('new-tag1')
-      end
-    end
-
-    it 'create tag for filtered records' do
-      Entity.where(attr: 'test2').send(column).create('new-tag2')
-
-      expect(Entity.find_by_attr('test1').send(column)).not_to include('new-tag2')
-      expect(Entity.find_by_attr('test2').send(column)).to include('new-tag2')
-    end
-  end
-
-  context 'update' do
-    it 'update tag' do
-      relation.update('b', 'updated-b')
-
-      count = Entity.where(column => Tags.all('updated-b')).count
-      expect(count).to be_eql(2)
-    end
-
-    it 'update tag for filtered records' do
-      Entity.where(attr: 'test2').send(column).update('c', 'updated-c')
-
-      count = Entity.where(column => Tags.all('updated-c')).count
-      expect(count).to be_eql(1)
-    end
-  end
-
-  context 'delete' do
-    it 'delete tag' do
-      relation.delete('b')
-
-      tags = relation.all.pluck(:name)
-      expect(tags).not_to include('b')
-    end
-
-    it 'delete tag for filtered records' do
-      Entity.where(attr: 'test2').send(column).delete('c')
-
-      expect(Entity.find_by_attr('test1').send(column)).to include('c')
-      expect(Entity.find_by_attr('test2').send(column)).not_to include('c')
-    end
-  end
-end

data/spec/array_strings/taggings_spec.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'ArrayStrings::Taggings' do
-  before(:all) do
-    @column = :tags_str # defined as instance var as it is used in before_all callback
-    Entity.pg_tags_on @column
-    truncate && Factory.array_strings
-  end
-
-  let(:column) { @column }
-  let(:ref) { %("#{Entity.table_name}"."#{column}") }
-  let(:relation) { Entity.send(column) }
-
-  it 'find all taggings' do
-    taggings = relation.taggings.order('name')
-
-    expect(taggings.size).to be_eql(6)
-    expect(taggings.map(&:name)).to be_eql(%w[a b b c c d])
-  end
-
-  it 'find all taggings for filtered records' do
-    taggings = Entity.where(attr: 'test2').send(column).taggings.order('name')
-
-    expect(taggings.size).to be_eql(2)
-    expect(taggings.map(&:name)).to be_eql(%w[b c])
-  end
-end

data/spec/array_strings/tags_spec.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'ArrayStrings::Tags' do
-  before(:all) do
-    @column = :tags_str # defined as instance var as it is used in before_all callback
-    Entity.pg_tags_on @column
-    truncate && Factory.array_strings
-  end
-
-  let(:column) { @column }
-  let(:ref) { %("#{Entity.table_name}"."#{column}") }
-  let(:relation) { Entity.send(column) }
-
-  it 'find all tags' do
-    tags = relation.all.order('name')
-
-    expect(tags.size).to be_eql(4)
-    expect(tags.map(&:name)).to be_eql(%w[a b c d])
-  end
-
-  it 'find all tags for filtered records' do
-    tags = Entity.where(attr: 'test2').send(column).all
-
-    expect(tags.size).to be_eql(2)
-    expect(tags.map(&:name)).to be_eql(%w[b c])
-  end
-
-  it 'find all tags with counts' do
-    tag = relation.all_with_counts.first
-
-    expect(tag.count).to be_eql(1)
-  end
-
-  it 'count tags' do
-    expect(relation.count).to be_eql(4)
-  end
-
-  it 'count tags for filtered records' do
-    expect(Entity.where(attr: 'test2').send(column).count).to be_eql(2)
-  end
-
-  context 'cast integers to strings' do
-    before do
-      Entity.create(attr: 'int1', column => [1])
-    end
-
-    it 'find tags in numeric format' do
-      tags = relation.all.where(name: 1)
-
-      expect(tags.size).to be_eql(1)
-      expect(tags.map(&:name)).to be_eql(['1'])
-    end
-  end
-end

data/spec/config/database.yml

@@ -1,6 +0,0 @@
-adapter: postgresql
-host: <%= ENV.fetch("PG_HOST") { "localhost" } %>
-port: <%= ENV.fetch("PG_PORT") { 5432 } %>
-username: <%= ENV.fetch("PG_USER") { raise "PG_USER env. not set" } %>
-password: <%= ENV.fetch("PG_PSWD") { raise "PG_PSWD env. not set" } %>
-database: <%= ENV.fetch("PG_TAGS_ON_DB") { raise "PG_TAGS_ON_DB env. not set" } %>

data/spec/configuration_spec.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'configuration' do
-  before do
-    Entity.pg_tags_on_reset
-  end
-
-  it 'should set query class' do
-    PgTagsOn.configure do |c|
-      c.query_class = 'Tagz'
-    end
-    Entity.pg_tags_on :tags_int
-
-    expect(Kernel.const_defined?('Tagz')).to be_truthy
-  end
-
-  it 'should set columns for multiple models' do
-    class Entity1 < ActiveRecord::Base
-      self.table_name = 'entities'
-      pg_tags_on :tags_int
-    end
-
-    class Entity2 < ActiveRecord::Base
-      self.table_name = 'entities'
-      pg_tags_on :tags_str
-    end
-
-    expect(Entity1.pg_tags_on_settings).to be_eql('tags_int' => {})
-    expect(Entity2.pg_tags_on_settings).to be_eql('tags_str' => {})
-  end
-
-  it 'should set multiple columns for the same model' do
-    Entity.pg_tags_on :tags_int
-    Entity.pg_tags_on :tags_str
-
-    expect(Entity.pg_tags_on_settings).to be_eql('tags_int' => {}, 'tags_str' => {})
-  end
-
-  it 'should raise error if column does not exists' do
-    expect { Entity.pg_tags_on(:dummy) }.to raise_error(PgTagsOn::ColumnNotFoundError)
-  end
-
-  it 'should create named scopes' do
-    Entity.pg_tags_on :tags_int
-
-    expect(Entity).to respond_to(:tags_int)
-  end
-end

data/spec/helpers/database_helpers.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module DatabaseHelpers
-  def establish_connection
-    ActiveRecord::Base.establish_connection(config)
-  end
-
-  def config
-    @config ||= begin
-      file = File.expand_path('../config/database.yml', File.dirname(__FILE__))
-      YAML.safe_load(ERB.new(File.read(file)).result)
-    end
-  end
-
-  def load_schema
-    @connection = ActiveRecord::Base.connection
-    @connection.drop_table :entities
-    @connection.transaction do
-      @connection.create_table :entities, force: true do |t|
-        t.integer :tags_int, array: true
-        t.string  :tags_str, array: true
-        t.text    :tags_text, array: true
-        t.jsonb   :tags_jsonb, array: true
-        t.string  :attr
-      end
-      @connection.add_index :entities, :tags_str, using: 'gin'
-    end
-  end
-
-  def truncate
-    ActiveRecord::Base.connection.truncate(Entity.table_name)
-  end
-
-  def encode_json(json)
-    case json
-    when String
-      ActiveSupport::JSON.encode(json)
-    when Hash
-      ActiveSupport::JSON.encode(json.to_json)
-    when Array
-      "'{" + json.map { |item| encode_json(item) }.join(',') + "}'"
-    end
-  end
-
-  module_function :config, :establish_connection, :load_schema, :truncate
-end

data/spec/spec_helper.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-WITH_COVERAGE = ENV['COVERAGE']
-
-if WITH_COVERAGE
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter %r{/benchmark/}
-  end
-end
-
-require 'pg'
-require 'active_record'
-require 'bundler/setup'
-require 'pg_tags_on'
-require 'helpers/database_helpers'
-require 'support/factory'
-require 'pry'
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = '.rspec_status'
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-
-  config.include DatabaseHelpers
-
-  config.before(:all) do
-    DatabaseHelpers.establish_connection
-    DatabaseHelpers.load_schema
-  end
-end
-
-Entity = Class.new(::ActiveRecord::Base)

data/spec/support/factory.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-class Factory
-  def self.array_strings
-    Entity.insert_all([
-                        { tags_str: %w[a b c], attr: 'test1' },
-                        { tags_str: %w[b c],   attr: 'test2' },
-                        { tags_str: ['d'],     attr: 'test3' }
-                      ])
-  end
-
-  def self.array_integers
-    Entity.insert_all([
-                        { tags_int: [1, 2, 3], attr: 'test1' },
-                        { tags_int: [2, 3],    attr: 'test2' },
-                        { tags_int: [4],       attr: 'test3' }
-                      ])
-  end
-
-  def self.array_jsonb
-    Entity.insert_all([
-                        { tags_jsonb: [{ name: 'a' },
-                                       { name: 'b' },
-                                       { name: 'c' }],
-                          attr: 'test1' },
-                        { tags_jsonb: [{ name: 'b' },
-                                       { name: 'c' }],
-                          attr: 'test2' },
-                        { tags_jsonb: [{ name: 'd' }],
-                          attr: 'test3' }
-                      ])
-  end
-
-  def self.array_jsonb_with_attrs
-    Entity.insert_all([
-                        { tags_jsonb: [{ name: 'a', meta: 'a' },
-                                       { name: 'b', meta: 'b' },
-                                       { name: 'c', meta: 'c' }],
-                          attr: 'test1' },
-                        { tags_jsonb: [{ name: 'b', meta: 'b' },
-                                       { name: 'c', meta: 'c' }],
-                          attr: 'test2' },
-                        { tags_jsonb: [{ name: 'd', meta: 'd' }],
-                          attr: 'test3' }
-                      ])
-  end
-end

data/spec/tags_query_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'TagsQuery' do
-  it 'accept String arguments' do
-    query = PgTagsOn::TagsQuery.all('a')
-
-    expect(query.value).to be_eql('a')
-    expect(query.predicate).to be_eql('all')
-  end
-
-  it 'accept Integer arguments' do
-    query = PgTagsOn::TagsQuery.all(1)
-
-    expect(query.value).to be_eql(1)
-    expect(query.predicate).to be_eql('all')
-  end
-
-  it 'accept Array arguments' do
-    query = PgTagsOn::TagsQuery.all(%w[a b c])
-
-    expect(query.value).to be_eql(%w[a b c])
-    expect(query.predicate).to be_eql('all')
-  end
-
-  it 'accept arguments list' do
-    query = PgTagsOn::TagsQuery.all('a', 'b', 'c')
-
-    expect(query.value).to be_eql(%w[a b c])
-    expect(query.predicate).to be_eql('all')
-  end
-end

data/spec/validator_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe 'Validator' do
-  before(:all) do
-    Entity.pg_tags_on :tags_str, limit: 2, tag_length: 3
-    Entity.pg_tags_on :tags_jsonb, key: :name, limit: 2, tag_length: 3
-  end
-
-  context 'string tags' do
-    it 'add errors if number of tags exceeds limit' do
-      entity = Entity.new(tags_str: %w[a b c])
-      entity.valid?
-
-      expect(entity.errors.full_messages.first).to include('size exceeded')
-    end
-
-    it 'add errors if tag length exceeds limit' do
-      entity = Entity.new(tags_str: %w[a x123])
-      entity.valid?
-
-      expect(entity.errors.full_messages.first).to include('length exceeded')
-    end
-  end
-
-  context 'jsonb tags' do
-    it 'add errors if number of tags exceeds limit' do
-      entity = Entity.new(tags_jsonb: [{ name: 'a' }, { name: 'b' }, { name: 'c' }])
-      entity.valid?
-
-      expect(entity.errors.full_messages.first).to include('size exceeded')
-    end
-
-    it 'add errors if tag length exceeds limit' do
-      entity = Entity.new(tags_jsonb: [{ name: 'x123' }])
-      entity.valid?
-
-      expect(entity.errors.full_messages.first).to include('length exceeded')
-    end
-  end
-end

data/tasks/benchmark.rake

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark'
-require './spec/helpers/database_helpers'
-require 'lib/pg_tags_on'
-require 'pry'
-
-namespace :pg_tags_on do
-  task :benchmark do
-    DatabaseHelpers.establish_connection
-    DatabaseHelpers.load_schema
-
-    Entity = Class.new(::ActiveRecord::Base)
-    Entity.pg_tags_on :tags_int
-    Entity.pg_tags_on :tags_str
-    Entity.pg_tags_on :tags_jsonb, key: :name
-
-    puts 'How many records to generate? (default 10_000)'
-    records = STDIN.gets.chomp.to_i
-    puts 'Minimum tags per record (default 1):'
-    min_tags = STDIN.gets.chomp.to_i
-    puts 'Maximum tags per record (default 10):'
-    max_tags = STDIN.gets.chomp.to_i
-
-    records = 10_000 if records.zero?
-    min_tags = 1 if min_tags.zero?
-    max_tags = 10 if max_tags.zero?
-
-    data = []
-    str_tags = Array.new(100) { Faker::Name.first_name }
-
-    puts "Generating #{records} records..."
-    records.times do
-      tags_count = rand(min_tags..max_tags)
-
-      data << {
-        tags_int: Array.new(tags_count) { rand(1..100) },
-        tags_str: str_tags.sample(tags_count),
-        tags_jsonb: Array.new(tags_count) { { name: str_tags.sample } }
-      }
-
-      if data.size == 5_000
-        Entity.insert_all data
-        data = []
-      end
-    end
-
-    Entity.insert_all(data) if data.present?
-    puts 'Done'
-
-    puts "\n\n* character varying[]\n\n"
-    PgTagsOn::Benchmark.new(Entity, :tags_str).call
-    puts "\n\n* integer[]\n\n"
-    PgTagsOn::Benchmark.new(Entity, :tags_int).call
-    puts "\n\n* jsonb[]\n\n"
-    PgTagsOn::Benchmark.new(Entity, :tags_jsonb).call
-  end
-end