izolenta 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32fc530e0234650b1d5d368bdcdfb790d9802ea3fb4f5274680385d54c662e9
-  data.tar.gz: f4d6e2639d3181cc83b1d07a828102e5497f4da45a8d72326e4200e968eac048
+  metadata.gz: 7209aebff713c525a2b8e8d5c2f501d9759f32407b3cb42a2f6b14422279d8d8
+  data.tar.gz: d19e4c2ca5203587e7d1786a3137dc71cf6a715b9f32ea81529f3c4fc3d9ca1c
 SHA512:
-  metadata.gz: 353b26d474b46ab384e358adcbfec74c3951564858ca7becd858e1c42328589fc76d11b484a7303b0f52e2517ad9d25b87aa97464bd3082c33244afbefbebcac
-  data.tar.gz: 54ddcaf0cfdbad2c298f9207e1e5f783441434d95e4325e1fd4e9a1c2147fdf4ec4fef0f11ad61caa57e0ec19d1b5b88ce8b2e474366c58b18a13d786ce2e1b9
+  metadata.gz: 868873584c72ff2fa9e03028916303a2de9d3f29223f2cfd33cf8b03147ece4a8d3fcb38c3befad464cad32175d39436b60dcd8428ffd0c3e1f19d9d257ffac1
+  data.tar.gz: a1f6ac0f5758d250a87e026df7ef41d09d78cdc5f50a0c017205f1c079b34fcdd46bdb6280b2fe5d5b99571c29c5ce4fac366e0a060b7aa2b0ea6835b7ca9584

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+#0.0.2
+- delegate_uniqueness helper is available as a migration method
+- functionality worked and tested 

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.7.5-bullseye
+
+WORKDIR /app
+RUN  apt-get update && apt-get -y install lsb-release
+#
+RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    apt-get update && apt-get -y install postgresql postgresql-client-12
+
+RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+    service postgresql start && \
+    psql -U postgres -c 'CREATE DATABASE "izolenta-test"'
+
+RUN  gem install bundler
+
+COPY lib/izolenta/version.rb /app/lib/izolenta/version.rb
+COPY izolenta.gemspec /app/
+COPY Gemfil* /app/
+#
+RUN bundle install

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    izolenta (0.0.2)
+      pg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    ruby_jard (0.3.1)
+      byebug (>= 9.1, < 12.0)
+      pry (~> 0.13.0)
+      tty-screen (~> 0.8.1)
+    tty-screen (0.8.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5)
+  izolenta!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  ruby_jard
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,8 +1,19 @@
 # Izolenta
+This is a set of migration helpers delivering delegated uniqueness in Postgres ( A fine approach to solve 'optimistic' singleton record creation problem over data-set with a noticeable not-HOT UPDATEs amount present in corresponding object lifecycle. Read more: https://leshchuk.medium.com/delegated-uniqueness-in-postgres-d0fa103f749c )
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/izolenta`. To experiment with that code, run `bin/console` for an interactive prompt.
+The idea of the gem and article originated from two things: 
+- first I wanted to replace uniq index for optimistic objects creation with something less burdensome for DB.
+- second I realised that trigger based solution for dialogs uniqueness I was using will fail to serve its purpose on a default PG isolaiton level.
 
-TODO: Delete this and the text above, and describe your gem
+The first thought was to use redis mutex approach, but it lacks the simplicity and is NOT hard solid as index solution. 
+Its better than done without, but still a lot could happened to fail it eventually.  
+
+So I ended up delegating UNIQUE constraint to a helper table whenever I really can win something from skipping uniq index over data set.
+
+**What's up with the naming?** In russian 'izolenta' means electrical tape (or insulating tape) 
+serving purpose of isolation ( electrical ) on some monkey patching fixing. 
+
+As the idea of the gem: patching the data circuit with a 100% isolation. 
 
 ## Installation
 
@@ -22,17 +33,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class YourMigration < ActiveRecord::Migration[5.0]
+  def change
+    delegate_uniqueness( :your_table_name, :column_name )
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+docker-compose build
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+docker-compose run test /bin/bash
+> service postgresql start && rake test
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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).
+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).
 
 
 ## License

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "izolenta"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/docker-compose.yml

@@ -0,0 +1,10 @@
+version: "3.7"
+
+services:
+  test:
+    build: .
+    image: izolenta
+    command: service postgresql start && rake test
+    volumes:
+      - '.:/app'
+

data/izolenta.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alekseyl"]
   spec.email         = ["leshchuk@gmail.com"]
 
-  spec.summary       = %q{cybersquatting the izolenta name for later creation of short term uniqueness/isolation records with redis mutex}
-  spec.description   = %q{cybersquatting the izolenta name for later creation of short term uniqueness/isolation records with redis mutex}
+  spec.summary       = %q{Migration helpers for delegated uniqueness in Postgres}
+  spec.description   = %q{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")
@@ -26,4 +26,8 @@ Gem::Specification.new do |spec|
   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"
 end

data/lib/izolenta/active_record_migration.rb

@@ -0,0 +1,54 @@
+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
+
+  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
+
+    add_index( helper_table, column_name, unique: true )
+  end
+
+  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
+
+  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_column_type(origin_table, column)
+    ActiveRecord::Base.connection.schema_cache.columns_hash(origin_table.to_s)[column.to_s]&.sql_type
+  end
+
+end if defined? ActiveRecord
+
+ActiveRecord::Migration.include(Izolenta::ActiveRecordMigration) if defined? ActiveRecord

data/lib/izolenta/version.rb

@@ -1,3 +1,3 @@
 module Izolenta
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/izolenta.rb

@@ -1,6 +1,6 @@
 require "izolenta/version"
+require 'izolenta/active_record_migration'
 
 module Izolenta
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,17 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: izolenta
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
-dependencies: []
-description: cybersquatting the izolenta name for later creation of short term uniqueness/isolation
-  records with redis mutex
+date: 2021-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: ruby_jard
+  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'
+description: Migration helpers for delegated uniqueness in Postgres
 email:
 - leshchuk@gmail.com
 executables: []
@@ -19,20 +60,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/inspectionProfiles/profiles_settings.xml"
-- ".idea/workspace.xml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - izolenta.gemspec
 - lib/izolenta.rb
+- lib/izolenta/active_record_migration.rb
 - lib/izolenta/version.rb
 homepage: https://github.com/alekseyl/izolenta
 licenses:
@@ -60,6 +103,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: cybersquatting the izolenta name for later creation of short term uniqueness/isolation
-  records with redis mutex
+summary: Migration helpers for delegated uniqueness in Postgres
 test_files: []

data/.idea/inspectionProfiles/profiles_settings.xml

@@ -1,5 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="PROJECT_PROFILE" />
-  </settings>
-</component>

data/.idea/workspace.xml

@@ -1,61 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ChangeListManager">
-    <list default="true" id="e09058d8-36f0-45ad-a8b0-398c410f2a78" name="Changes" comment="">
-      <change afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.idea/inspectionProfiles/profiles_settings.xml" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.ruby-gemset" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.ruby-version" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/.travis.yml" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/CODE_OF_CONDUCT.md" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/Gemfile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/LICENSE.txt" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/Rakefile" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/bin/console" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/bin/setup" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/izolenta.gemspec" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/izolenta.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/lib/izolenta/version.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/test/izolenta_test.rb" afterDir="false" />
-      <change afterPath="$PROJECT_DIR$/test/test_helper.rb" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectId" id="21KEQNtyETxN1YRFZmdsghXrmFy" />
-  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">
-    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
-    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="WebServerToolWindowFactoryState" value="false" />
-    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
-    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
-    <property name="settings.editor.selected.configurable" value="org.jetbrains.plugins.ruby.settings.RubyActiveModuleSdkConfigurable" />
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="e09058d8-36f0-45ad-a8b0-398c410f2a78" name="Changes" comment="" />
-      <created>1637681361150</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1637681361150</updated>
-      <workItem from="1637681363057" duration="114000" />
-    </task>
-    <servers />
-  </component>
-  <component name="TypeScriptGeneratedFilesManager">
-    <option name="version" value="3" />
-  </component>
-</project>