fx-sequence 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48e0687b9cfd59028be9a254da0c216d94e9bf56299b3ace7447c43b345598d5
+  data.tar.gz: 3db24cfcdc2f2ee9b9f119a2a4669d9f1cb2f5778765bf67c542e4148daf6b7e
+SHA512:
+  metadata.gz: ced25a9fd8d9936b34ec9492dccde512776b387c3973aa565ca7964a2d68e3d6e94d83d926980bbe029fbe64c2bfb9fa8c524ad11dccc39538f968b071536ebf
+  data.tar.gz: ad75dd0639222d689bfcc84fade05181343d4739a4aa03e7918e215dc2d1e66f3b2b6e87e69472f4155ea2989093eeb0e73276561f511ec6b95f063b7097cba9

data/README.md

@@ -0,0 +1,21 @@
+# Fx::Sequence
+
+Extension for [fx](https://github.com/teoljungberg/fx) gem to support creation, drop and dumping to `schema.rb` PostgreSQL sequences.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add fx-sequence
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install fx-sequence
+```
+
+## 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 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %w[rubocop]

data/lib/fx/sequence/adapters/postgres/sequences.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'fx/sequence/sequence'
+
+module Fx
+  module Sequence
+    module Adapters
+      class Postgres < ::Fx::Adapters::Postgres
+        class Sequences
+          SEQUENCES_WITH_DEFINITIONS_QUERY = <<~SQL
+            SELECT ps.relname AS name,
+                'CREATE SEQUENCE IF NOT EXISTS ' || ps.relname AS definition
+            FROM pg_class ps
+                JOIN pg_namespace pn ON ps.relnamespace = pn.oid
+            WHERE pn.nspname = 'public'
+                AND ps.relkind = 'S';
+          SQL
+          private_constant :SEQUENCES_WITH_DEFINITIONS_QUERY
+
+          def self.all(...)
+            new(...).all
+          end
+
+          def initialize(connection)
+            @connection = connection
+          end
+
+          def all
+            sequences_from_postgres.map { |sequence| to_fx_sequence(sequence) }
+          end
+
+          private
+
+          attr_reader :connection
+
+          def sequences_from_postgres
+            connection.execute(SEQUENCES_WITH_DEFINITIONS_QUERY)
+          end
+
+          def to_fx_sequence(result)
+            Fx::Sequence::Sequence.new(result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fx/sequence/adapters/postgres.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'fx/sequence/adapters/postgres/sequences'
+
+module Fx
+  module Sequence
+    module Adapters
+      class Postgres < ::Fx::Adapters::Postgres
+        def sequences
+          Sequences.all(connection)
+        end
+
+        def create_sequence(sql_definition)
+          execute(sql_definition)
+        end
+
+        def drop_sequence(name)
+          execute("DROP SEQUENCE #{name};")
+        end
+      end
+    end
+  end
+end

data/lib/fx/sequence/command_recorder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    module CommandRecorder
+      def create_sequence(*args)
+        record(:create_sequence, args)
+      end
+
+      def drop_sequence(*args)
+        record(:drop_sequence, args)
+      end
+    end
+  end
+end

data/lib/fx/sequence/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    class Configuration < Fx::Configuration
+      def initialize
+        super
+        @database = Fx::Sequence::Adapters::Postgres.new
+      end
+    end
+  end
+end

data/lib/fx/sequence/definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    class Definition < Fx::Definition
+      SEQUENCE = 'sequence'
+      private_constant :SEQUENCE
+
+      def self.sequence(name:, version:)
+        new(name: name, version: version, type: SEQUENCE)
+      end
+    end
+  end
+end

data/lib/fx/sequence/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Fx
+  module Sequence
+    class Railtie < Rails::Railtie
+      initializer('fx-sequence.load') do
+        ActiveSupport.on_load(:active_record) do
+          Fx::Sequence.load
+        end
+      end
+    end
+  end
+end

data/lib/fx/sequence/schema_dumper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    module SchemaDumper
+      def tables(stream)
+        sequences(stream)
+        empty_line(stream)
+
+        super
+      end
+
+      private
+
+      def empty_line(stream)
+        stream.puts if dumpable_sequences_in_database.any?
+      end
+
+      def sequences(stream)
+        dumpable_sequences_in_database.each do |sequence|
+          stream.puts(sequence.to_schema)
+        end
+      end
+
+      def dumpable_sequences_in_database
+        @dumpable_sequences_in_database ||= Fx::Sequence.database.sequences
+      end
+    end
+  end
+end

data/lib/fx/sequence/sequence.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    class Sequence
+      include Comparable
+
+      attr_reader :name, :definition
+
+      delegate :<=>, to: :name
+
+      def initialize(row)
+        @name = row.fetch('name')
+        @definition = row.fetch('definition')
+      end
+
+      def ==(other)
+        name == other.name && definition == other.definition
+      end
+
+      def to_schema
+        <<-SCHEMA
+  create_sequence :#{name}, sql_definition: <<-\SQL
+      #{definition}
+  SQL
+        SCHEMA
+      end
+    end
+  end
+end

data/lib/fx/sequence/statements.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    module Statements
+      def create_sequence(name, **options)
+        version = options.fetch(:version, 1)
+        sql_definition = options[:sql_definition]
+
+        raise(ArgumentError, 'version or sql_definition must be specified') if version.nil? && sql_definition.nil?
+
+        sql_definition = sql_definition.strip_heredoc if sql_definition
+        sql_definition ||= Fx::Sequence::Definition.sequence(name: name, version: version).to_sql
+
+        Fx::Sequence.database.create_sequence(sql_definition)
+      end
+
+      def drop_sequence(name, _ = {})
+        Fx::Sequence.database.drop_sequence(name)
+      end
+    end
+  end
+end

data/lib/fx/sequence/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Fx
+  module Sequence
+    VERSION = '0.1.0'
+    public_constant :VERSION
+  end
+end

data/lib/fx/sequence.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+require 'fx'
+
+require 'fx/sequence/version'
+require 'fx/sequence/adapters/postgres'
+require 'fx/sequence/command_recorder'
+require 'fx/sequence/configuration'
+require 'fx/sequence/definition'
+require 'fx/sequence/sequence'
+require 'fx/sequence/statements'
+require 'fx/sequence/schema_dumper'
+require 'fx/sequence/railtie'
+
+module Fx
+  module Sequence
+    def self.load
+      ActiveRecord::Migration::CommandRecorder.include(Fx::Sequence::CommandRecorder)
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.include(Fx::Sequence::Statements)
+      ActiveRecord::SchemaDumper.prepend(Fx::Sequence::SchemaDumper)
+
+      true
+    end
+
+    def self.configuration
+      @configuration ||= Fx::Sequence::Configuration.new
+    end
+
+    def self.database
+      configuration.database
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: fx-sequence
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "@aevula"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fx
+  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'
+description: Extension for fx gem for creating, droping and dumping to schema.rb sequences
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/fx/sequence.rb
+- lib/fx/sequence/adapters/postgres.rb
+- lib/fx/sequence/adapters/postgres/sequences.rb
+- lib/fx/sequence/command_recorder.rb
+- lib/fx/sequence/configuration.rb
+- lib/fx/sequence/definition.rb
+- lib/fx/sequence/railtie.rb
+- lib/fx/sequence/schema_dumper.rb
+- lib/fx/sequence/sequence.rb
+- lib/fx/sequence/statements.rb
+- lib/fx/sequence/version.rb
+homepage: https://github.com/aevula/fx-sequence
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aevula/fx-sequence
+  source_code_uri: https://github.com/aevula/fx-sequence/tree/master
+  changelog_uri: https://github.com/aevula/fx-sequence/tree/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Extension for fx gem for sequence support
+test_files: []