actual_db_schema 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 116a62e0bbc1d2f43ad5e7654f732807bb6807520f26f33bfde84889601bb895
-  data.tar.gz: 63c36388ed0efa1d19b9daec936206b6580e22b1b04b25a0db3f058047c34b56
+  metadata.gz: eac7885f8774402bb8f0532caf66d4304df61be50ef0c22f1fd8f6ef325b8330
+  data.tar.gz: 8c90d4101e41941a4c247f6af2695e050f450a46435b659c99e1d5fe8fd71929
 SHA512:
-  metadata.gz: ef27b62051c6183b68a35018b0ed7f402f25f8de2f3d3da8f842b914c13516a49b00ab57687a513bca04b664fc682b40c93c75929e414dfea514c2e0065a68b9
-  data.tar.gz: 7a7f0ce3ef0ce09a5a0ecf90ff0aec292ae6f9ab58050ce946dd849123b36162398592a9249ea9ec4acecbe9cfe2031737cbe16c5c0b5ef89989ebb48237fee9
+  metadata.gz: 794038e111d31a3e99b1a48c3c3a0603498e6492e8b2a8f050d4e9e481debe047d908ff5cae5940789c96c3d76da13a10a841c55834275392e0d08076b4b6b52
+  data.tar.gz: 342ba459e1705c42a64d0f476c50054724a48b212bbba79a82f85a1a4118ac342bac7d0ebab3158bcab58f5d6068c1e4f344f813a6464091e20545815ff09dc3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.7.1] - 2024-03-19
+
+- add csv as a dependency since Ruby 3.3 has removed it from the standard library
+
+## [0.7.0] - 2024-01-18
+
+- db:phantom_migrations displays the branch in which the phantion migration was run
+
 ## [0.6.0] - 2024-01-03
 
 - Added db:phantom_migrations task to display phantom migrations

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    actual_db_schema (0.6.0)
+    actual_db_schema (0.7.1)
       activerecord (>= 6.0.0)
       activesupport (>= 6.0.0)
+      csv
 
 GEM
   remote: https://rubygems.org/
@@ -92,6 +93,7 @@ GEM
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
     crass (1.0.6)
+    csv (3.2.8)
     date (3.3.3)
     debug (1.8.0)
       irb (>= 1.5.0)

data/README.md

@@ -4,7 +4,7 @@
 
 Does switching between branches in your Rails app mess up the DB schema?
 
-Keep the DB schema actual across branches in your Rails project. Just install `actual_db_schema` gem and run `db:migrate` in branches as usual. It automatically rolls back the *phantom migrations* (non-relevant to the current branch). No additional steps are needed.
+Keep the DB schema actual across branches in your Rails project. Just install `actual_db_schema` gem and run `db:migrate` in branches as usual. It automatically rolls back the *phantom migrations* (non-relevant to the current branch). No additional steps are needed. It works with both `schema.rb` and `structure.sql`.
 
 ## Why ActualDbSchema
 
@@ -28,9 +28,9 @@ With `actual_db_schema` gem you don't need to care about that anymore. It saves
 
 ### How it solves the issue
 
-This gem stores all run migrations with their code in the `tmp/migrations` folder. Whenever you perform a schema dump, it rolls back the *phantom migrations*.
+This gem stores all run migrations with their code in the `tmp/migrated` folder. Whenever you perform a schema dump, it rolls back the *phantom migrations*.
 
-The *phantom migrations* list is the difference between the migrations you've executed (in the `tmp/migrations` folder) and the current ones (in the `db/migrate` folder).
+The *phantom migrations* list is the difference between the migrations you've executed (in the `tmp/migrated` folder) and the current ones (in the `db/migrate` folder).
 
 Therefore, all you do is run rails `db:migrate` in your current branch. `actual_db_schema` will ensure the DB schema is up-to-date. You'll never have an inaccurate `schema.rb` file again.
 
@@ -63,7 +63,15 @@ The gem offers the following rake tasks that can be manually run according to yo
 
 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.
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version do the following in the order:
+
+- update the version number in `version.rb`;
+- update the CHANGELOG;
+- `bundle install` to update `Gemfile.lock`;
+- make the commit and push;
+- run `bundle exec rake release`. This 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
 

data/actual_db_schema.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_runtime_dependency "activerecord", ">= 6.0.0"
   spec.add_runtime_dependency "activesupport", ">= 6.0.0"
+  spec.add_runtime_dependency "csv"
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "debug"

data/lib/actual_db_schema/commands/list.rb

@@ -20,18 +20,59 @@ module ActualDbSchema
         puts "Below is a list of irrelevant migrations executed in unmerged branches."
         puts "To bring your database schema up to date, the migrations marked as \"up\" should be rolled back."
         puts "\ndatabase: #{ActiveRecord::Base.connection_db_config.database}\n\n"
-        puts %(#{"Status".center(8)}  #{"Migration ID".ljust(14)}  Migration File)
-        puts "-" * 50
+        puts header.join("  ")
+        puts "-" * separator_width
+      end
+
+      def separator_width
+        header.map(&:length).sum + (header.size - 1) * 2
+      end
+
+      def header
+        @header ||=
+          [
+            "Status".center(8),
+            "Migration ID".ljust(14),
+            "Branch".ljust(branch_column_width),
+            "Migration File".ljust(16)
+          ]
       end
 
       def table
         context.migrations_status.each do |status, version|
-          migration = indexed_phantom_migrations[version]
-          next unless migration
-
-          puts %(#{status.center(8)}  #{version.to_s.ljust(14)}  #{migration.filename.gsub("#{Rails.root}/", "")})
+          line = line_for(status, version)
+          puts line if line
         end
       end
+
+      def line_for(status, version)
+        migration = indexed_phantom_migrations[version]
+        return unless migration
+
+        [
+          status.center(8),
+          version.to_s.ljust(14),
+          branch_for(version).ljust(branch_column_width),
+          migration.filename.gsub("#{Rails.root}/", "")
+        ].join("  ")
+      end
+
+      def branch_for(version)
+        metadata.fetch(version, {})[:branch] || "unknown"
+      end
+
+      def metadata
+        @metadata ||= ActualDbSchema::Store.instance.read
+      end
+
+      def longest_branch_name
+        @longest_branch_name ||=
+          metadata.values.map { |v| v[:branch] }.compact.max_by(&:length) || "unknown"
+      end
+
+      def branch_column_width
+        longest_branch_name.length
+      end
     end
   end
 end

data/lib/actual_db_schema/git.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Git helper
+  class Git
+    def self.current_branch
+      `git rev-parse --abbrev-ref HEAD`.strip
+    rescue Errno::ENOENT
+      "unknown"
+    end
+  end
+end

data/lib/actual_db_schema/patches/migration_proxy.rb

@@ -6,7 +6,7 @@ module ActualDbSchema
     module MigrationProxy
       def migrate(direction)
         super(direction)
-        FileUtils.copy(filename, ActualDbSchema.migrated_folder.join(basename)) if direction == :up
+        ActualDbSchema::Store.instance.write(filename) if direction == :up
       end
     end
   end

data/lib/actual_db_schema/store.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActualDbSchema
+  # Stores the migrated files into the tmp folder
+  class Store
+    include Singleton
+
+    Item = Struct.new(:version, :timestamp, :branch)
+
+    def write(filename)
+      basename = File.basename(filename)
+      FileUtils.copy(filename, folder.join(basename))
+      record_metadata(filename)
+    end
+
+    def read
+      return {} unless File.exist?(store_file)
+
+      CSV.read(store_file).map { |line| Item.new(*line) }.index_by(&:version)
+    end
+
+    private
+
+    def record_metadata(filename)
+      version = File.basename(filename).scan(/(\d+)_.*\.rb/).first.first
+      CSV.open(store_file, "a") do |csv|
+        csv << [
+          version,
+          Time.current.iso8601,
+          Git.current_branch
+        ]
+      end
+    end
+
+    def folder
+      ActualDbSchema.migrated_folder
+    end
+
+    def store_file
+      folder.join("metadata.csv")
+    end
+  end
+end

data/lib/actual_db_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActualDbSchema
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

data/lib/actual_db_schema.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "active_record/migration"
+require "csv"
+require_relative "actual_db_schema/git"
+require_relative "actual_db_schema/store"
 require_relative "actual_db_schema/version"
 require_relative "actual_db_schema/patches/migration_proxy"
 require_relative "actual_db_schema/patches/migrator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actual_db_schema
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Andrei Kaleshka
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -122,9 +136,11 @@ files:
 - lib/actual_db_schema/commands/base.rb
 - lib/actual_db_schema/commands/list.rb
 - lib/actual_db_schema/commands/rollback.rb
+- lib/actual_db_schema/git.rb
 - lib/actual_db_schema/patches/migration_context.rb
 - lib/actual_db_schema/patches/migration_proxy.rb
 - lib/actual_db_schema/patches/migrator.rb
+- lib/actual_db_schema/store.rb
 - lib/actual_db_schema/version.rb
 - lib/railtie.rb
 - lib/tasks/db.rake