izolenta 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7209aebff713c525a2b8e8d5c2f501d9759f32407b3cb42a2f6b14422279d8d8
-  data.tar.gz: d19e4c2ca5203587e7d1786a3137dc71cf6a715b9f32ea81529f3c4fc3d9ca1c
+  metadata.gz: c88c2f580d9d1d4e4f8fba35e5a865a18520c63aee5c24d6457aaa32fb6a2da8
+  data.tar.gz: 8b5315fb79d1dfc3a5a1186190f296848c81876a8bfeb5f29e897ce814b6e45d
 SHA512:
-  metadata.gz: 868873584c72ff2fa9e03028916303a2de9d3f29223f2cfd33cf8b03147ece4a8d3fcb38c3befad464cad32175d39436b60dcd8428ffd0c3e1f19d9d257ffac1
-  data.tar.gz: a1f6ac0f5758d250a87e026df7ef41d09d78cdc5f50a0c017205f1c079b34fcdd46bdb6280b2fe5d5b99571c29c5ce4fac366e0a060b7aa2b0ea6835b7ca9584
+  metadata.gz: 6394a0583ce73f68e0bd50f1d35feb8c2dd5a74f4f6ae729d5e446291b7495098b4772d84039eb185254cbbc7f153e90910f0dc9d20edfe3057223bea1040f2e
+  data.tar.gz: 560940e4fa253be7315f351e9c757d73d995eafe7d8584ad08ffb6ec9b235aa8c8386f09b01f6d5a4244c499be2fae5e814580a920391abb20c3352df13a21eb

data/.rubocop.yml

@@ -0,0 +1,92 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+#
+#Style/SingleLineMethods:
+#  Description: 'Avoid single-line methods.'
+#  StyleGuide: '#no-single-line-methods'
+#  Enabled: false
+#  VersionAdded: '0.9'
+#  VersionChanged: '1.8'
+#  AllowIfMethodIsEmpty: true
+#
+#Style/AsciiComments:
+#  Description: 'Use only ascii symbols in comments.'
+#  StyleGuide: '#english-comments'
+#  Enabled: false
+#  VersionAdded: '0.9'
+#  VersionChanged: '1.21'
+#  AllowedChars:
+#    - ©
+#
+#Layout/LineLength:
+#  Description: 'Checks that line length does not exceed the configured limit.'
+#  StyleGuide: '#max-line-length'
+#  Enabled: true
+#  VersionAdded: '0.25'
+#  VersionChanged: '1.4'
+#  Max: 120
+#  # To make it possible to copy or click on URIs in the code, we allow lines
+#  # containing a URI to be longer than Max.
+#  AllowHeredoc: true
+#  AllowURI: true
+#  URISchemes:
+#    - http
+#    - https
+#  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+#  # directives like '# rubocop: enable ...' when calculating a line's length.
+#  IgnoreCopDirectives: true
+#  # The AllowedPatterns option is a list of !ruby/regexp and/or string
+#  # elements. Strings will be converted to Regexp objects. A line that matches
+#  # any regular expression listed in this option will be ignored by LineLength.
+#  AllowedPatterns: []
+#  IgnoredPatterns: [] # deprecated
+#  Exclude:
+#    - "./test/**/**/*"
+#
+#Metrics/ClassLength:
+#  Description: 'Avoid classes longer than 100 lines of code.'
+#  Enabled: false
+#  VersionAdded: '0.25'
+#  VersionChanged: '0.87'
+#  CountComments: false  # count full line comments?
+#  Max: 100
+#  CountAsOne: []
+#
+#Lint/MissingCopEnableDirective:
+#  Description: 'Checks for a `# rubocop:enable` after `# rubocop:disable`.'
+#  Enabled: true
+#  VersionAdded: '0.52'
+#  # Maximum number of consecutive lines the cop can be disabled for.
+#  # 0 allows only single-line disables
+#  # 1 would mean the maximum allowed is the following:
+#  #   # rubocop:disable SomeCop
+#  #   a = 1
+#  #   # rubocop:enable SomeCop
+#  # .inf for any size
+#  MaximumRangeSize: .inf
+#
+#Style/MethodCallWithArgsParentheses:
+#  Enabled: true
+#  IgnoredMethods:
+#    - require
+#    - require_relative
+#    - require_dependency
+#    - yield
+#    - raise
+#    - puts
+#  Exclude:
+#    - "/**/Gemfile"
+#    - "./db/**/*"
+#
+#Layout/EmptyLinesAroundBlockBody:
+#  # its more documentation than code, so it should be readable and
+#  # there are huge amount of multiline description, looks nasty without spaces
+#  Exclude:
+#    - "./app_doc/**/*"
+#
+#Style/ClassAndModuleChildren:
+#  Enabled: false
+#
+#Lint/UnderscorePrefixedVariableName:
+#  Exclude:
+#    - "./test/**/**/*"

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+#0.0.5
+- rubocop-shopify added to dev dependencies
+- fixed ruby 3.0 incompatibility in delegate_uniqueness, now gem could be used with ruby 3+
+
+#0.0.4
+- removed 'OR REPLACE' in trigger definition, lowering Postgres version constraint 
+- trigger_condition added ( could replace partial uniq index ) 
+ 
+#0.0.3
+- wrapper_function options added, you can define function to convert to uniquely sortable types, for instance array to string 
+- moved all helper functions to internal module, just to keep things clear on the migrations
+
 #0.0.2
 - delegate_uniqueness helper is available as a migration method
 - functionality worked and tested 

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in izolenta.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    izolenta (0.0.2)
+    izolenta (0.0.5)
       pg
 
 GEM
@@ -18,18 +18,41 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
+    json (2.6.2)
     method_source (1.0.0)
     minitest (5.14.4)
-    pg (1.2.3)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pg (1.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rainbow (3.1.1)
     rake (12.3.3)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.31.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-shopify (2.8.0)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
     ruby_jard (0.3.1)
       byebug (>= 9.1, < 12.0)
       pry (~> 0.13.0)
@@ -37,6 +60,7 @@ GEM
     tty-screen (0.8.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
     zeitwerk (2.5.1)
 
 PLATFORMS
@@ -47,6 +71,8 @@ DEPENDENCIES
   izolenta!
   minitest (~> 5.0)
   rake (~> 12.0)
+  rubocop
+  rubocop-shopify
   ruby_jard
 
 BUNDLED WITH

data/README.md

@@ -39,6 +39,22 @@ class YourMigration < ActiveRecord::Migration[5.0]
     delegate_uniqueness( :your_table_name, :column_name )
   end
 end
+
+class WithWrapperFunctionMigration < ActiveRecord::Migration[5.0]
+  # define some where before 'type_conversion_function' to use it later 
+  def change
+    delegate_uniqueness( :your_table_name, :column_name, wrapper_function: 'type_conversion_function' )
+  end
+end
+
+
+class WithWrapperFunctionMigration < ActiveRecord::Migration[5.0]
+  # apply trigger condition for partial uniqueness
+  def change
+    delegate_uniqueness( :your_table_name, :column_name, trigger_condition: 'NEW.type IS NOT NULL' )
+  end
+end
+
 ```
 
 ## Development
@@ -50,6 +66,10 @@ docker-compose run test /bin/bash
 > service postgresql start && rake test
 ```
 
+## Future Features
+- Sequel migration helpers 
+- Existing data sync 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/izolenta. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/izolenta/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/izolenta.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/izolenta/version'
+# frozen_string_literal: true
+
+require_relative "lib/izolenta/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "izolenta"
@@ -6,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alekseyl"]
   spec.email         = ["leshchuk@gmail.com"]
 
-  spec.summary       = %q{Migration helpers for delegated uniqueness in Postgres}
-  spec.description   = %q{Migration helpers for delegated uniqueness in Postgres}
+  spec.summary       = "Migration helpers for delegated uniqueness in Postgres"
+  spec.description   = "Migration helpers for delegated uniqueness in Postgres"
   spec.homepage      = "https://github.com/alekseyl/izolenta"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -20,14 +22,15 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "pg"
-  spec.add_development_dependency "activerecord", ">= 5"
-  spec.add_development_dependency "ruby_jard"
+  spec.add_dependency("pg")
+  spec.add_development_dependency("activerecord", ">= 5")
+  spec.add_development_dependency("rubocop-shopify")
+  spec.add_development_dependency("ruby_jard")
 end

data/lib/izolenta/active_record_migration.rb

@@ -1,54 +1,86 @@
-module Izolenta::ActiveRecordMigration
-
-  def delegate_uniqueness(origin_table, column, options = {})
-    helper_table_name = "#{column}_#{origin_table}_uniqs"
-    reversible do |dir|
-      dir.up {
-        create_helper_table(helper_table_name, column, get_column_type(origin_table, column ) )
-        create_sync_trigger( origin_table, column, helper_table_name )
-      }
-
-      dir.down {
-        drop_table( helper_table_name )
-        drop_sync_trigger( origin_table, column )
-      }
-    end
-  end
+# frozen_string_literal: true
 
-  def create_helper_table(helper_table, column_name, column_type )
-    ActiveRecord::Base.connection.execute <<~CREATE_TABLE
-      CREATE TABLE #{helper_table} ( #{column_name} #{column_type} );
-    CREATE_TABLE
+if defined? ActiveRecord
+  module Izolenta
+    module ActiveRecordMigration
+      # options:
+      #   wrapper_function: 'some_func' # some_func should be defined prior
+      def delegate_uniqueness(origin_table, column, **options)
+        helper_table_name = "#{column}_#{origin_table}_uniqs"
 
-    add_index( helper_table, column_name, unique: true )
-  end
+        reversible do |dir|
+          dir.up do
+            Helpers.create_helper_table(helper_table_name, column,
+              Helpers.get_new_column_type(origin_table, column, options))
+            add_index(helper_table_name, column, unique: true)
 
-  def create_sync_trigger(table, column_name, helper_table_name)
-    trg_name = "#{table}_#{column_name}_trg"
-    ActiveRecord::Base.connection.execute <<~SYNC_TRIGGER
-       CREATE OR REPLACE FUNCTION #{trg_name}() RETURNS trigger AS $$
-       BEGIN 
-         INSERT INTO #{helper_table_name} VALUES ( NEW.#{column_name} );
-         RETURN NEW;
-       END $$ LANGUAGE plpgSQL;
-
-       CREATE OR REPLACE TRIGGER #{trg_name} BEFORE INSERT ON #{table} FOR EACH ROW
-       EXECUTE FUNCTION #{trg_name}();
-    SYNC_TRIGGER
-  end
+            Helpers.create_sync_trigger(origin_table, column, helper_table_name, options)
+          end
 
-  def drop_sync_trigger(table, column_name)
-    trg_name = "#{table}_#{column_name}_trg"
+          dir.down do
+            drop_table(helper_table_name)
+            Helpers.drop_sync_trigger(origin_table, column)
+          end
+        end
+      end
 
-    ActiveRecord::Base.connection.execute <<~SYNC_TRIGGER
-       DROP TRIGGER IF EXISTS #{trg_name} ON #{table};
-    SYNC_TRIGGER
-  end
+      # helpers na
+      module Helpers
+        class << self
+          def create_helper_table(helper_table, column_name, column_type)
+            ActiveRecord::Base.connection.execute("CREATE TABLE #{helper_table} ( #{column_name} #{column_type} );")
+          end
 
-  def get_column_type(origin_table, column)
-    ActiveRecord::Base.connection.schema_cache.columns_hash(origin_table.to_s)[column.to_s]&.sql_type
-  end
+          def create_sync_trigger(table, column_name, helper_table_name, options)
+            trg_name = "#{table}_#{column_name}_trg"
+            insert_value = if options[:wrapper_function]
+              "#{options[:wrapper_function]}(NEW.#{column_name})"
+            else
+              "NEW.#{column_name}"
+            end
+
+            trigger_condition = "WHEN( #{options[:trigger_condition]} )" if options[:trigger_condition]
+
+            ActiveRecord::Base.connection.execute(<<~SYNC_TRIGGER)
+              CREATE OR REPLACE FUNCTION #{trg_name}() RETURNS trigger AS $$
+              BEGIN#{" "}
+                INSERT INTO #{helper_table_name} VALUES ( #{insert_value} );
+                RETURN NEW;
+              END $$ LANGUAGE plpgSQL;
 
-end if defined? ActiveRecord
+              CREATE TRIGGER #{trg_name} BEFORE INSERT ON #{table}#{" "}
+              FOR EACH ROW
+              #{trigger_condition}
+              EXECUTE FUNCTION #{trg_name}();
+            SYNC_TRIGGER
+          end
+
+          def drop_sync_trigger(table, column_name)
+            trg_name = "#{table}_#{column_name}_trg"
+
+            ActiveRecord::Base.connection.execute(<<~SYNC_TRIGGER)
+              DROP TRIGGER IF EXISTS #{trg_name} ON #{table};
+            SYNC_TRIGGER
+          end
+
+          def get_new_column_type(origin_table, column, wrapper_function: nil, **)
+            wrapper_function ? get_function_type(wrapper_function) : get_column_type(origin_table, column)
+          end
+
+          def get_column_type(origin_table, column)
+            ActiveRecord::Base.connection.schema_cache.columns_hash(origin_table.to_s)[column.to_s]&.sql_type
+          end
+
+          def get_function_type(wrapper_function)
+            ActiveRecord::Base
+              .connection
+              .execute("SELECT typname FROM pg_type WHERE oid=(SELECT prorettype FROM pg_proc WHERE proname ='#{wrapper_function}')") # rubocop:disable Layout/LineLength
+              .first["typname"]
+          end
+        end
+      end
+    end
+  end
+end
 
-ActiveRecord::Migration.include(Izolenta::ActiveRecordMigration) if defined? ActiveRecord
+ActiveRecord::Migration.include(Izolenta::ActiveRecordMigration) if defined? ActiveRecord

data/lib/izolenta/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Izolenta
-  VERSION = "0.0.2"
+  VERSION = "0.0.5"
 end

data/lib/izolenta.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "izolenta/version"
-require 'izolenta/active_record_migration'
+require "izolenta/active_record_migration"
 
 module Izolenta
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: izolenta
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_jard
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"