fx-sequence 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48e0687b9cfd59028be9a254da0c216d94e9bf56299b3ace7447c43b345598d5
-  data.tar.gz: 3db24cfcdc2f2ee9b9f119a2a4669d9f1cb2f5778765bf67c542e4148daf6b7e
+  metadata.gz: 8915009a8dd736d970d79ef2be7ce1c7bb42afdc29e362ce0a7c9905312f3720
+  data.tar.gz: 055d2a72ecb446d0b24ad934c03111545122cdf1f27f360cceb1ba384ee5d962
 SHA512:
-  metadata.gz: ced25a9fd8d9936b34ec9492dccde512776b387c3973aa565ca7964a2d68e3d6e94d83d926980bbe029fbe64c2bfb9fa8c524ad11dccc39538f968b071536ebf
-  data.tar.gz: ad75dd0639222d689bfcc84fade05181343d4739a4aa03e7918e215dc2d1e66f3b2b6e87e69472f4155ea2989093eeb0e73276561f511ec6b95f063b7097cba9
+  metadata.gz: 2cb072169c9679e0f493188a613cdc7ed88798958fa8ec1c4235a2fece3ca055df25cade9b90cb0193a585761487bde9a4442b318d3cd3629b6b69c735f6aabe
+  data.tar.gz: caea3dd9dfb206fa18df1b0dc15faeba563127c50d6085620831604278cda441c22ecce55a45eee02c4765aa7e0cb2b86abcfcc48967b855346136632a2824a9

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.1.1]
+
+[0.1.1]: https://github.com/aevula/fx-sequence/compare/v0.1.0...v0.1.1
+
+- Added rails generators
+
+## [0.1.0]
+
+Extension for [fx](https://github.com/aevula/fx-sequence) gem to support creation, drop and dumping to `schema.rb` PostgreSQL sequences.

data/lib/fx/sequence/version.rb

@@ -2,7 +2,7 @@
 
 module Fx
   module Sequence
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
     public_constant :VERSION
   end
 end

data/lib/generators/fx/sequence/USAGE

@@ -0,0 +1,17 @@
+Description:
+  Create a new database sequence for your application. This will create a new
+  sequence definition file and the accompanying migration.
+
+  When --no-migration is passed, skips generating a migration.
+  When --exact-name is passed, uses exact name without "seq" suffix.
+
+Examples:
+    rails generate fx:sequence numbers
+
+      create: db/sequences/numbers_seq_v01.sql
+      create: db/migrate/[TIMESTAMP]_create_sequence_numbers_seq.rb
+
+    rails generate fx:sequence numbers --exact-name
+
+      create: db/sequences/numbers_v01.sql
+      create: db/migrate/[TIMESTAMP]_create_sequence_numbers.rb

data/lib/generators/fx/sequence/sequence_generator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Fx
+  module Generators
+    class SequenceGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :migration, type: :boolean
+      class_option :exact_name, type: :boolean, default: false, description: 'Use exact name without \'seq\' suffix'
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      def create_sequences_directory
+        return if sequence_definition_path.exist?
+
+        empty_directory(sequence_definition_path)
+      end
+
+      def create_sequence_definition
+        if creating_new_sequence?
+          create_file(definition.path, default_sql_definition)
+        else
+          copy_file(previous_definition.full_path, definition.full_path)
+        end
+      end
+
+      def create_migration_file
+        return if skip_migration_creation?
+
+        migration_template('db/migrate/create_sequence.erb', "db/migrate/create_sequence_#{sequence_name}.rb")
+      end
+
+      no_tasks do
+        def previous_version
+          @previous_version ||= Dir.entries(sequence_definition_path)
+                                   .map { |name| extract_version(name) }
+                                   .max
+        end
+
+        def version
+          @version ||= previous_version.next
+        end
+
+        def activerecord_migration_class
+          if ActiveRecord::Migration.respond_to?(:current_version)
+            "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+          else
+            'ActiveRecord::Migration'
+          end
+        end
+
+        def formatted_name
+          name = singular_name.include?('.') ? "\"#{singular_name}\"" : ":#{singular_name}"
+          sequence_name(name)
+        end
+      end
+
+      private
+
+      def sequence_definition_path
+        @sequence_definition_path ||= Rails.root.join(*%w[db sequences])
+      end
+
+      def version_regex; end
+
+      def extract_version(name)
+        Integer(/\A#{sequence_name}_v(?<version>\d+)\.sql\z/.match(name).try(:[], 'version'), 10)
+      rescue ArgumentError
+        0
+      end
+
+      def creating_new_sequence?
+        previous_version.zero?
+      end
+
+      def definition
+        Fx::Sequence::Definition.sequence(name: sequence_name, version: version)
+      end
+
+      def previous_definition
+        Fx::Sequence::Definition.sequence(name: sequence_name, version: previous_version)
+      end
+
+      def skip_migration_creation?
+        !migration
+      end
+
+      def migration
+        options[:migration] != false
+      end
+
+      def default_sql_definition
+        <<~SQL
+          CREATE SEQUENCE #{sequence_name};
+        SQL
+      end
+
+      def sequence_name(name = file_name)
+        options[:exact_name] ? name : "#{name}_seq"
+      end
+    end
+  end
+end

data/lib/generators/fx/sequence/templates/db/migrate/create_sequence.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= migration_class_name %> < <%= activerecord_migration_class %>
+  def change
+    create_sequence(<%= formatted_name %>)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fx-sequence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - "@aevula"
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fx
@@ -30,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - Rakefile
 - lib/fx/sequence.rb
@@ -43,6 +44,9 @@ files:
 - lib/fx/sequence/sequence.rb
 - lib/fx/sequence/statements.rb
 - lib/fx/sequence/version.rb
+- lib/generators/fx/sequence/USAGE
+- lib/generators/fx/sequence/sequence_generator.rb
+- lib/generators/fx/sequence/templates/db/migrate/create_sequence.erb
 homepage: https://github.com/aevula/fx-sequence
 licenses:
 - MIT