nd-pg-enum-migrations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c152be4a4c0c1de0763ea9c4af1bb3a5ed73c95fad4b5c689c369ad080ab3718
+  data.tar.gz: 772f691fb69e01270ca54b2a7d31d4d8c1d4ef566c8e4dc50702af18aa95e8c8
+SHA512:
+  metadata.gz: 2ac6dc3304b56483d336638ad5fc7de055febebf60945c6763a9e717aaaf7b77d7fa1ff68c7fd05d3e8db870b162555bed38d407e6815384611dbcdc23d3e461
+  data.tar.gz: f0284f5004f8af1f0a8a01732e4a5e76e136025f891901d1cb8100e9e4ef25c3f705c1d079894cc87baa5dcb191517758b433cbf85ca5317b2fdcf79bd778945

data/.rspec

@@ -0,0 +1,6 @@
+--format documentation
+--color
+--require spec_helper
+--require mocha
+--require active_record
+--require pry

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-08-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nd-pg-enum-migrations.gemspec
+gemspec
+
+gem 'pg'
+gem 'rake',        '~> 13.0'
+gem 'rspec',       '~> 3.0'
+gem 'mocha',       '~> 1.13'
+gem 'pry',         '~> 0.13'
+gem 'guard',       '~> 2.18'
+gem 'guard-rspec', '~> 4.7', require: false
+gem 'database_cleaner-active_record'

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    nd-pg-enum-migrations (1.0.0)
+      activerecord (>= 6.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    mocha (1.14.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pg (1.4.3)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  database_cleaner-active_record
+  guard (~> 2.18)
+  guard-rspec (~> 4.7)
+  mocha (~> 1.13)
+  nd-pg-enum-migrations!
+  pg
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.12

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Romain Clavel
+
+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,159 @@
+# ND::PG::Enum::Migrations
+
+This gem allows you to create, update and destroy PG enums in your Rails project.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nd-pg-enum-migrations
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nd-pg-enum-migrations
+
+## Usage
+
+All migrations can be reverted.
+
+- [Create enum](#create-enum)
+- [Delete enum](#delete-enum)
+- [Add a value to enum](#add-a-value-to-enum)
+- [Remove a value from enum](#remove-a-value-from-enum)
+- [Change enum values](#change-enum-values)
+- [Rename enum](#rename-enum)
+- [List enum values](#list-enum-values)
+- [Get all columns using enum](#get-all-columns-using-enum)
+
+### Create enum
+
+```ruby
+class CreateUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    create_enum(:user_role, %w(admin owner user))
+  end
+end
+```
+
+### Delete enum
+
+The second attribute is optional, but is required if the migration is reverted.
+Otherwise, a `ActiveRecord::IrreversibleMigration` exception will be raised.
+
+```ruby
+class DropUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    drop_enum(:user_role, %w(admin owner user))
+  end
+end
+```
+
+### Add a value to enum
+
+#### Add one value
+
+```ruby
+class AddValueToUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    add_enum_value(:user_role, 'banned')
+  end
+end
+```
+
+#### Add several values
+
+```ruby
+class AddValuesToUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    add_enum_values(:user_role, 'banned', 'expired')
+  end
+end
+```
+
+### Remove a value from enum
+
+#### Add one value
+
+```ruby
+class RemoveValueFromUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    remove_enum_value(:user_role, 'banned')
+  end
+end
+```
+
+#### Add several values
+
+```ruby
+class RemoveValuesFromUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    remove_enum_values(:user_role, 'banned', 'expired')
+  end
+end
+```
+
+### Change enum values
+
+```ruby
+class ChangeValuesFromUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    change_enum_values(:user_role, add: %w(banned expired), remove: %w(admin))
+  end
+end
+```
+
+### Rename enum
+
+```ruby
+class RenameUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    rename_enum(:user_role, :user_kind)
+  end
+end
+```
+
+### List enum values
+
+```ruby
+class ListValuesFromUserRoleEnum < ActiveRecord::Migration[7.0]
+  def change
+    values = enum_values(:user_role)
+    # => ["admin", "owner", "user"]
+
+    # ...
+  end
+end
+```
+
+### Get all columns using enum
+
+```ruby
+class ListColumnsUsingEnum < ActiveRecord::Migration[7.0]
+  def up
+    values = columns_from_type(:user_role)
+    # => [
+    #   {:table_name=>"users", :column_name=>"role"},
+    #   {:table_name=>"users", :column_name=>"kind"},
+    #   {:table_name=>"profiles", :column_name=>"role"}
+    # ]
+
+    # ...
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Guard is also installed: `bundle exec guard`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `gem bump` (or manually 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rclavel/nd-pg-enum-migrations.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/database.yml

@@ -0,0 +1,8 @@
+production:
+  adapter: postgresql
+  pool: 5
+  host: localhost
+  username: nd-pg-enum-migrations
+  password: ""
+  prepared_statements: false
+  url: "postgres://nd-pg-enum-migrations:@localhost:5432/nd-pg-enum-migrations"

data/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3"
+services:
+  database:
+    container_name: nd-pg-enum-migrations
+    image: postgres:9.6.8
+    ports:
+      - "127.0.0.1:5432:5432"
+    environment:
+      POSTGRES_USER: nd-pg-enum-migrations
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+volumes:
+  pgdata:
+    name: nd-pg-enum-migrations-postgres

data/lib/nd/pg/enum/migrations/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ND
+  module PG
+    module Enum
+      module Migrations
+        VERSION = '1.0.0'
+      end
+    end
+  end
+end

data/lib/nd/pg/enum/migrations.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require_relative 'migrations/version'
+
+module ND::PG::Enum::Migrations::Concern
+  def create_enum(name, values)
+    reversible do |direction|
+      direction.up   { _create_enum(name, values) }
+      direction.down { _drop_enum(name) }
+    end
+  end
+
+  def drop_enum(name, values = nil)
+    if values
+      reversible do |direction|
+        direction.up   { _drop_enum(name) }
+        direction.down { _create_enum(name, values) }
+      end
+    else
+      # If reverted, an ActiveRecord::IrreversibleMigration error will be raised.
+      _drop_enum(name)
+    end
+  end
+
+  def add_enum_value(name, *values)
+    change_enum_values(name, add: values.flatten)
+  end
+  alias_method :add_enum_values, :add_enum_value
+
+  def remove_enum_value(name, *values)
+    change_enum_values(name, remove: values.flatten)
+  end
+  alias_method :remove_enum_values, :remove_enum_value
+
+  def change_enum_values(name, add: [], remove: [])
+    reversible do |direction|
+      direction.up   { _change_enum_values(name, add: add, remove: remove) }
+      direction.down { _change_enum_values(name, add: remove, remove: add) }
+    end
+  end
+
+  def rename_enum(from, to)
+    reversible do |direction|
+      direction.up   { _rename_enum(from, to) }
+      direction.down { _rename_enum(to, from) }
+    end
+  end
+
+  def enum_values(name)
+    values = ActiveRecord::Base.connection.execute(<<~SQL.squish)
+      SELECT unnest(enum_range(null, null::#{name})) AS value;
+    SQL
+
+    values.map { |value| value['value'] }
+  end
+
+  def columns_from_type(type)
+    values = ActiveRecord::Base.connection.execute(<<~SQL.squish)
+      SELECT table_name, column_name FROM information_schema.columns WHERE table_schema = 'public' AND udt_name = '#{type}';
+    SQL
+
+    values.to_a.map(&:symbolize_keys)
+  end
+
+  private
+
+  def _create_enum(name, values)
+    logger.debug("Create enum `#{name}` with values #{values.inspect}")
+    execute <<-SQL
+      CREATE TYPE #{name} AS ENUM (#{values.map { |value| "'#{value}'" }.join(', ')});
+    SQL
+  end
+
+  def _drop_enum(name)
+    logger.debug("Drop enum `#{name}`")
+    execute <<-SQL
+      DROP TYPE #{name};
+    SQL
+  end
+
+  def _change_enum_values(name, add: [], remove: [])
+    logger.debug("Change enum `#{name}` values: Add #{add.inspect}, remove #{remove.inspect}")
+    temporary_name = "new_#{name}".to_sym
+    existing_values = enum_values(name)
+    new_values = existing_values + add - remove
+
+    _create_enum(temporary_name, existing_values)
+    _change_enum_type(from: name, to: temporary_name)
+    _drop_enum(name)
+
+    _create_enum(name, new_values)
+    _change_enum_type(from: temporary_name, to: name)
+    _drop_enum(temporary_name)
+  end
+
+  def _rename_enum(old_name, new_name)
+    logger.debug("Rename enum from `#{old_name}` to `#{new_name}`")
+    values = enum_values(old_name)
+
+    _create_enum(new_name, values)
+    _change_enum_type(from: old_name, to: new_name)
+    _drop_enum(old_name)
+  end
+
+  def _change_enum_type(from:, to:)
+    logger.debug("Change enum type from `#{from}` to `#{to}`")
+    source_type = from
+    destination_type = to
+
+    columns_from_type(source_type).each do |data|
+      table, column = data.values_at(:table_name, :column_name)
+      change_column(table, column, "#{destination_type} USING #{column}::varchar::#{destination_type}")
+    end
+  end
+
+  def logger
+    @_logger ||= Logger.new(STDOUT)
+  end
+end
+
+class ActiveRecord::Migration
+  include ND::PG::Enum::Migrations::Concern
+end

data/nd-pg-enum-migrations.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/nd/pg/enum/migrations/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'nd-pg-enum-migrations'
+  spec.version = ND::PG::Enum::Migrations::VERSION
+  spec.authors = ['Romain Clavel']
+  spec.email = ['romain@clavel.io']
+
+  spec.summary = 'Helpers to create, update and delete PG Enum in your Rails project.'
+  spec.homepage = 'https://github.com/rclavel/nd-pg-enum-migrations'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rclavel/nd-pg-enum-migrations'
+  spec.metadata['changelog_uri'] = 'https://github.com/rclavel/nd-pg-enum-migrations/blob/master/CHANGELOG.md'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'activerecord', '>= 6.0.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/nd/pg/enum/migrations.rbs

@@ -0,0 +1,10 @@
+module Nd
+  module Pg
+    module Enum
+      module Migrations
+        VERSION: String
+        # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: nd-pg-enum-migrations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Romain Clavel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description:
+email:
+- romain@clavel.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/database.yml
+- docker-compose.yml
+- lib/nd/pg/enum/migrations.rb
+- lib/nd/pg/enum/migrations/version.rb
+- nd-pg-enum-migrations.gemspec
+- sig/nd/pg/enum/migrations.rbs
+homepage: https://github.com/rclavel/nd-pg-enum-migrations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rclavel/nd-pg-enum-migrations
+  source_code_uri: https://github.com/rclavel/nd-pg-enum-migrations
+  changelog_uri: https://github.com/rclavel/nd-pg-enum-migrations/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Helpers to create, update and delete PG Enum in your Rails project.
+test_files: []