nandi 0.8.0

data/lib/nandi/formatting.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Formatting
+    class UnsupportedValueError < StandardError; end
+
+    module ClassMethods
+      # Define an accessor method that will retrieve a value
+      # from a cell's model and format it with the format_value
+      # method below.
+      # @param name [String] the attribute on model to retrieve
+      # @example formatting the foo property
+      #   class MyCell < Cells::ViewModel
+      #     include Nandi::Formatting
+      #
+      #     formatted_property :foo
+      #   end
+      def formatted_property(name)
+        define_method(name) do
+          format_value(model.send(name))
+        end
+      end
+    end
+
+    # Create a string representation of the value that is a valid
+    # and correct Ruby literal for that value. Please note that the
+    # exact representation is not guaranteed to be the same between
+    # different platforms and Ruby versions. The guarantee is merely
+    # that calling this method with any supported type will produce
+    # a string that produces an equal value when it is passed to
+    # Kernel::eval
+    # @param value [Hash, Array, String, Symbol, Integer, Float, NilClass]
+    #   value to format
+    def format_value(value, opts = {})
+      case value
+      when Hash
+        format_hash(value, opts)
+      when Array
+        "[#{value.map { |v| format_value(v, opts) }.join(', ')}]"
+      when String, Symbol, Integer, Float, NilClass, TrueClass, FalseClass
+        value.inspect
+      else
+        raise UnsupportedValueError,
+              "Cannot format value of type #{value.class.name}"
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    private
+
+    def format_hash(value, opts)
+      if opts[:as_argument]
+        hash_pairs(value).join(", ")
+      else
+        "{\n  #{hash_pairs(value).join(",\n  ")}\n}"
+      end
+    end
+
+    def hash_pairs(value)
+      value.map do |k, v|
+        key = if k.is_a?(Symbol)
+                symbol_key(k)
+              else
+                format_value(k) + " =>"
+              end
+        "#{key} #{format_value(v)}"
+      end
+    end
+
+    def symbol_key(key)
+      canonical = key.inspect
+
+      "#{canonical[1..-1]}:"
+    end
+  end
+end

data/lib/nandi/instructions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "nandi/instructions/add_index"
+require "nandi/instructions/remove_index"
+require "nandi/instructions/create_table"
+require "nandi/instructions/drop_table"
+require "nandi/instructions/add_column"
+require "nandi/instructions/add_reference"
+require "nandi/instructions/remove_reference"
+require "nandi/instructions/remove_column"
+require "nandi/instructions/add_foreign_key"
+require "nandi/instructions/drop_constraint"
+require "nandi/instructions/remove_not_null_constraint"
+require "nandi/instructions/change_column_default"
+require "nandi/instructions/validate_constraint"
+require "nandi/instructions/add_check_constraint"
+require "nandi/instructions/irreversible_migration"
+
+module Nandi
+  module Instructions; end
+end

data/lib/nandi/instructions/add_check_constraint.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class AddCheckConstraint
+      attr_reader :table, :name, :check
+
+      def initialize(table:, name:, check:)
+        @table = table
+        @name = name
+        @check = check
+      end
+
+      def procedure
+        :add_check_constraint
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/add_column.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class AddColumn
+      attr_reader :table, :name, :type, :extra_args
+
+      def initialize(table:, name:, type:, **kwargs)
+        @table = table
+        @name = name
+        @type = type
+        @extra_args = kwargs
+      end
+
+      def procedure
+        :add_column
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/add_foreign_key.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "active_support/inflector"
+
+module Nandi
+  module Instructions
+    class AddForeignKey
+      attr_reader :table, :target
+
+      def initialize(table:, target:, name: nil, **extra_args)
+        @table = table
+        @target = target
+        @extra_args = extra_args
+        @name = name
+      end
+
+      def procedure
+        :add_foreign_key
+      end
+
+      def extra_args
+        {
+          **@extra_args,
+          name: name,
+          validate: false,
+        }.compact
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+
+      private
+
+      def name
+        @name || :"#{table}_#{target}_fk"
+      end
+    end
+  end
+end

data/lib/nandi/instructions/add_index.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class AddIndex
+      def initialize(fields:, table:, **kwargs)
+        @fields = Array(fields)
+        @fields = @fields.first if @fields.one?
+
+        @table = table
+        @extra_args = kwargs
+      end
+
+      def procedure
+        :add_index
+      end
+
+      def extra_args
+        {
+          # Overridable defaults
+          name: name,
+
+          # Overrides and extra options
+          **@extra_args,
+
+          # Mandatory values
+          algorithm: :concurrently,
+          using: :btree,
+        }
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::SHARE
+      end
+
+      attr_reader :table, :fields
+
+      private
+
+      def name
+        :"idx_#{table.to_s}_on_#{field_names}"
+      end
+
+      def field_names
+        field_names = fields.respond_to?(:map) ? fields.map(&:to_s).join("_") : fields
+        field_names.to_s.scan(/\w+/).join("_")
+      end
+    end
+  end
+end

data/lib/nandi/instructions/add_reference.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class AddReference
+      attr_reader :table, :ref_name, :extra_args
+
+      def initialize(table:, ref_name:, **kwargs)
+        @table = table
+        @ref_name = ref_name
+        @extra_args = kwargs
+      end
+
+      def procedure
+        :add_reference
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/change_column_default.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class ChangeColumnDefault
+      attr_reader :table, :column, :value
+
+      def initialize(table:, column:, value:)
+        @table = table
+        @column = column
+        @value = value
+      end
+
+      def procedure
+        :change_column_default
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/create_table.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Nandi
+  module Instructions
+    class CreateTable
+      attr_reader :table, :columns, :timestamps_args, :extra_args
+
+      def initialize(table:, columns_block:, **kwargs)
+        @table = table
+        columns_reader = ColumnsReader.new
+        columns_block.call(columns_reader)
+        @columns = columns_reader.columns
+        @extra_args = kwargs unless kwargs.empty?
+        @timestamps_args = columns_reader.timestamps_args
+      end
+
+      def procedure
+        :create_table
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+
+      class ColumnsReader
+        attr_reader :columns, :timestamps_args
+
+        TYPES = %i[
+          bigint
+          binary
+          boolean
+          date
+          datetime
+          decimal
+          float
+          integer
+          json
+          string
+          text
+          time
+          timestamp
+          virtual
+          bigserial bit bit_varying box
+          cidr circle citext
+          daterange
+          hstore
+          inet int4range int8range interval
+          jsonb
+          line lseg ltree
+          macaddr money
+          numrange
+          oid
+          path point polygon primary_key
+          serial
+          tsrange tstzrange tsvector
+          uuid
+          xml
+        ].freeze
+
+        def initialize
+          @columns = []
+          @timestamps_args = nil
+        end
+
+        def column(name, type, **args)
+          @columns << OpenStruct.new(name: name, type: type, args: args)
+        end
+
+        def timestamps(**args)
+          @timestamps_args = args
+        end
+
+        TYPES.each do |type|
+          define_method type do |name, **args|
+            column(name, type, **args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nandi/instructions/drop_constraint.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class DropConstraint
+      attr_reader :table, :name
+
+      def initialize(table:, name:)
+        @table = table
+        @name = name
+      end
+
+      def procedure
+        :drop_constraint
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/drop_table.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class DropTable
+      attr_reader :table
+
+      def initialize(table:)
+        @table = table
+      end
+
+      def procedure
+        :drop_table
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions/irreversible_migration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class IrreversibleMigration
+      def lock
+        Nandi::Migration::LockWeights::SHARE
+      end
+
+      def procedure
+        :irreversible_migration
+      end
+    end
+  end
+end

data/lib/nandi/instructions/remove_column.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class RemoveColumn
+      attr_reader :table, :name, :extra_args
+
+      def initialize(table:, name:, **extra_args)
+        @table = table
+        @name = name
+        @extra_args = extra_args if extra_args.any?
+      end
+
+      def procedure
+        :remove_column
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end