pliny 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b6f9bac86953d6bef8858e6c4c1f6f94f06073fac8175b9572728ffed5a276
-  data.tar.gz: c20333f978e5f8e908b13f6eaf9d37a3dbdb0f10204c1db9a8b5f83b02fbac11
+  metadata.gz: 8de7550e51b73562d5fbf52d648945f5f07925cc5df89b5526faba9fc5b27075
+  data.tar.gz: 46f1ed81d71d0b9b70332085bc6dc61038a98d8f66ba2645db6651f355f85fd4
 SHA512:
-  metadata.gz: e851ccdd1fb0a3d548fa672d209829e9cd8ecf69023d1c7a2fb6ad0fb84ee1616d2d3b2a761d11ba9c13a989d2fb5176c31d3eb6acf9a02e20c6e7bc4b01386f
-  data.tar.gz: aefb3c02dc44ba282595bb9b2e85dc52e2891cb16ac6395693ab63bd79c603b7c68e9b93dea4c494c1b574e8be308b26a34e40040d4e71e0a74cb9a9f828a207
+  metadata.gz: 90130887007a82d06b841e6e4ca27f0f242f24eb782f273037a50a849d8a8a19ce73b7d4fb42ee75bc983b8cdfac57f02057e6322d11ab00678ef5c51b2d8d13
+  data.tar.gz: a77f028909da4a10a07db20f96e3fa872c351114395adbbbe500a1106bc0b3882676bdd94fbb52ec91a23676ba92cce2b84a76277a385321f29c16c64ede2fc1

data/lib/pliny/db_support.rb

@@ -62,6 +62,134 @@ module Pliny
       Integer(version)
     end
 
+    class MigrationStatus
+      attr_reader :filename
+      attr_accessor :present_on_disk, :present_in_database
+
+      def initialize(filename:)
+        @filename = filename
+        @present_on_disk = false
+        @present_in_database = false
+      end
+
+      def status
+        if present_on_disk
+          if present_in_database
+            :up
+          else
+            :down
+          end
+        else
+          if present_in_database
+            :file_missing
+          else
+            raise "error" # FIXME: better message
+          end
+        end
+      end
+    end
+
+    class MigrationStatusPresenter
+      PADDING = 2
+      UP = "UP".freeze
+      DOWN = "DOWN".freeze
+      FILE_MISSING = "FILE MISSING".freeze
+
+      STATUS_MAP = {
+        up: UP,
+        down: DOWN,
+        file_missing: FILE_MISSING
+      }.freeze
+
+      STATUS_OPTIONS = [
+        UP,
+        DOWN,
+        FILE_MISSING
+      ].freeze
+
+      attr_reader :migration_statuses
+
+      def initialize(migration_statuses:)
+        @migration_statuses = migration_statuses
+      end
+
+      def to_s
+        rows.join("\n")
+      end
+
+      def rows
+        header + statuses + footer
+      end
+
+      def header
+        [
+          barrier_row,
+          header_row,
+          barrier_row
+        ]
+      end
+
+      def statuses
+        migration_statuses.map { |status|
+          status_row(status)
+        }
+      end
+
+      def footer
+        [
+          barrier_row
+        ]
+      end
+
+      def barrier_row
+        "+#{'-' * (longest_status + PADDING)}+#{'-' * (longest_migration_name + PADDING)}+"
+      end
+
+      def header_row
+        "|#{'STATUS'.center(longest_status + PADDING)}|#{'MIGRATION'.center(longest_migration_name + PADDING)}|"
+      end
+
+      def status_row(migration_status)
+        "|#{STATUS_MAP[migration_status.status].center(longest_status + PADDING)}|#{' ' * (PADDING / 2)}#{migration_status.filename.ljust(longest_migration_name)}#{' ' * (PADDING / 2)}|"
+      end
+
+      private
+
+      def longest_migration_name
+        @longest_migration_name ||= migration_statuses.map(&:filename).max_by(&:length).length
+      end
+
+      def longest_status
+        STATUS_OPTIONS.max_by(&:length).length
+      end
+    end
+
+    def status
+      migrations_in_database = get_migrations_from_database
+      migrations_on_disk = Dir["#{MIGRATION_DIR}/*.rb"].map { |f| File.basename(f) }
+      total_set_of_migrations = (migrations_in_database | migrations_on_disk).sort_by(&:to_i)
+
+      migration_statuses = total_set_of_migrations.map { |filename|
+        status = MigrationStatus.new(filename: filename)
+        if migrations_on_disk.include?(filename)
+          status.present_on_disk = true
+        end
+
+        if migrations_in_database.include?(filename)
+          status.present_in_database = true
+        end
+        status
+      }
+
+      MigrationStatusPresenter.new(migration_statuses: migration_statuses).to_s
+    end
+
+    def get_migrations_from_database
+      return [] unless db.table_exists?(:schema_migrations)
+
+      db[:schema_migrations].order(Sequel.asc(:filename)).select_map(:filename)
+    end
+
     def rollback
       current_version = version
       return if current_version.zero?

data/lib/pliny/tasks/db.rake

@@ -15,6 +15,16 @@ begin
       end
     end
 
+    namespace :migrate do
+      desc "Get the status of migrations"
+      task :status do
+        # TODO: figure out how to handle multiple databases. Also why do we support multiple databases this way?
+        Pliny::DbSupport.run(database_urls.first, $stdout) do |helper|
+          puts helper.status
+        end
+      end
+    end
+
     desc "Run database migrations"
     task :migrate do
       next if Dir["./db/migrate/*.rb"].empty?

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.31.0"
+  VERSION = "0.32.0"
 end

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.4.0"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.31"
+gem "pliny", "~> 0.32"
 gem "pry"
 gem "puma", "~> 3"
 gem "rack-ssl"

data/spec/db_support_spec.rb

@@ -114,4 +114,243 @@ describe Pliny::DbSupport do
       end
     end
   end
+
+  describe "MigrationStatus" do
+    let(:filename) { "1630551344_latest_change.rb" }
+    let(:migration_status) { described_class::MigrationStatus.new(filename: filename) }
+
+    describe "#status" do
+      context "given a migration present on disk" do
+        before do
+          migration_status.present_on_disk = true
+        end
+
+        context "and present in the database" do
+          before do
+            migration_status.present_in_database = true
+          end
+
+          it "is :up" do
+            assert_equal :up, migration_status.status
+          end
+        end
+
+        context "and is absent from the database" do
+          before do
+            migration_status.present_in_database = false
+          end
+
+          it "is :down" do
+            assert_equal :down, migration_status.status
+          end
+        end
+      end
+
+      context "given a migration absent from disk" do
+        before do
+          migration_status.present_on_disk = false
+        end
+
+        context "and present in the database" do
+          before do
+            migration_status.present_in_database = true
+          end
+
+          it "is :file_missing" do
+            assert_equal :file_missing, migration_status.status
+          end
+        end
+
+        context "and is absent from the database" do
+          before do
+            migration_status.present_in_database = false
+          end
+
+          it "is an error case" do
+            assert_raises RuntimeError do
+              migration_status.status
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe 'MigrationStatusPresenter' do
+    let(:filename) { '1630551344_latest_change.rb' }
+    let(:up_migration) { described_class::MigrationStatus.new(filename: "00#{filename}") }
+    let(:down_migration) { described_class::MigrationStatus.new(filename: "0#{filename}") }
+    let(:file_missing_migration) { described_class::MigrationStatus.new(filename: "000#{filename}") }
+    let(:migration_statuses) { [up_migration, down_migration, file_missing_migration] }
+    let(:presenter) { described_class::MigrationStatusPresenter.new(migration_statuses: migration_statuses) }
+
+    before do
+      up_migration.present_in_database = true
+      up_migration.present_on_disk = true
+      down_migration.present_in_database = false
+      down_migration.present_on_disk = true
+      file_missing_migration.present_in_database = true
+      file_missing_migration.present_on_disk = false
+    end
+
+    describe '#barrier_row' do
+      it 'pads to the longest_migration name' do
+        expectation = '+--------------+--------------------------------+'
+        assert_equal expectation, presenter.barrier_row
+      end
+    end
+
+    describe '#header_row' do
+      it 'pads to the longest migration name' do
+        expectation = '|    STATUS    |           MIGRATION            |'
+        assert_equal expectation, presenter.header_row
+      end
+    end
+
+    describe '#header' do
+      let(:barrier) { '+--------------+--------------------------------+' }
+      let(:header)  { '|    STATUS    |           MIGRATION            |' }
+
+      it 'wraps the title in barriers' do
+        assert_equal [barrier, header, barrier], presenter.header
+      end
+    end
+
+    describe '#footer' do
+      let(:barrier) { '+--------------+--------------------------------+' }
+
+      it 'just a barrier' do
+        assert_equal [barrier], presenter.footer
+      end
+    end
+
+    describe '#status_row' do
+      context 'an up migration' do
+        it 'shows the correct details' do
+          expectation = '|      UP      | 001630551344_latest_change.rb  |'
+          assert_equal expectation, presenter.status_row(up_migration)
+        end
+      end
+
+      context 'a down migration' do
+        it 'shows the correct details' do
+          expectation = '|     DOWN     | 01630551344_latest_change.rb   |'
+          assert_equal expectation, presenter.status_row(down_migration)
+        end
+      end
+
+      context 'a file missing migration' do
+        it 'shows the correct details' do
+          expectation = '| FILE MISSING | 0001630551344_latest_change.rb |'
+          assert_equal expectation, presenter.status_row(file_missing_migration)
+        end
+      end
+    end
+
+    describe '#statuses' do
+      let(:up_expectation)           { '|      UP      | 001630551344_latest_change.rb  |' }
+      let(:down_expectation)         { '|     DOWN     | 01630551344_latest_change.rb   |' }
+      let(:file_missing_expectation) { '| FILE MISSING | 0001630551344_latest_change.rb |' }
+
+      it 'returns strings' do
+        assert_equal [up_expectation, down_expectation, file_missing_expectation], presenter.statuses
+      end
+    end
+
+    describe '#rows' do
+      let(:barrier)                  { '+--------------+--------------------------------+' }
+      let(:header)                   { '|    STATUS    |           MIGRATION            |' }
+      let(:up_expectation)           { '|      UP      | 001630551344_latest_change.rb  |' }
+      let(:down_expectation)         { '|     DOWN     | 01630551344_latest_change.rb   |' }
+      let(:file_missing_expectation) { '| FILE MISSING | 0001630551344_latest_change.rb |' }
+      let(:footer)                   { '+--------------+--------------------------------+' }
+
+      it 'is the table as an array' do
+        expectation = [
+          barrier,
+          header,
+          barrier,
+          up_expectation,
+          down_expectation,
+          file_missing_expectation,
+          footer
+        ]
+
+        assert_equal expectation, presenter.rows
+      end
+    end
+
+    describe '#to_s' do
+      it 'is the table as a string' do
+        expectation = <<~OUTPUT.chomp
+          +--------------+--------------------------------+
+          |    STATUS    |           MIGRATION            |
+          +--------------+--------------------------------+
+          |      UP      | 001630551344_latest_change.rb  |
+          |     DOWN     | 01630551344_latest_change.rb   |
+          | FILE MISSING | 0001630551344_latest_change.rb |
+          +--------------+--------------------------------+
+        OUTPUT
+
+        assert_equal expectation, presenter.to_s
+      end
+    end
+  end
+
+  describe '#status' do
+    let(:filename) { '1630551344_latest_change.rb' }
+    let(:up_migration) { "00#{filename}" }
+    let(:down_migration) { "0#{filename}" }
+    let(:file_missing_migration) { "000#{filename}" }
+
+    before do
+      DB.create_table(:schema_migrations) do
+        text :filename
+      end
+
+      migrations = DB[:schema_migrations]
+      migrations.insert(filename: up_migration)
+      migrations.insert(filename: file_missing_migration)
+
+      File.open("./db/migrate/#{up_migration}", "w") do |f|
+        f.puts "
+          Sequel.migration do
+            change do
+              create_table(:foo) do
+                primary_key :id
+                text        :bar
+              end
+            end
+          end
+        "
+      end
+
+      File.open("./db/migrate/#{down_migration}", "w") do |f|
+        f.puts "
+          Sequel.migration do
+            change do
+              create_table(:foo) do
+                primary_key :id
+                text        :bar
+              end
+            end
+          end
+        "
+      end
+    end
+
+    it 'returns a table string' do
+      expectation = <<~OUTPUT.chomp
+        +--------------+--------------------------------+
+        |    STATUS    |           MIGRATION            |
+        +--------------+--------------------------------+
+        | FILE MISSING | 0001630551344_latest_change.rb |
+        |      UP      | 001630551344_latest_change.rb  |
+        |     DOWN     | 01630551344_latest_change.rb   |
+        +--------------+--------------------------------+
+      OUTPUT
+
+      assert_equal expectation, support.status
+    end
+  end
 end

data/spec/integration_spec.rb

@@ -1,30 +1,46 @@
 require "spec_helper"
+require "open3"
+require 'active_support/core_ext/object/blank'
 
 describe "Pliny integration test" do
-  before(:all) do
-    @original_dir = Dir.pwd
-
-    test_dir = Dir.mktmpdir("plinytest-")
-    Dir.chdir(test_dir)
-
-    bash "pliny-new myapp"
+  describe "bin/setup" do
+    around do |example|
+      original_dir = Dir.pwd
+      test_dir = Dir.mktmpdir("plinytest-")
+      Dir.chdir(test_dir)
 
-    Dir.chdir("myapp")
-    bash "bin/setup"
-  end
+      bash "pliny-new myapp"
 
-  after(:all) do
-    Dir.chdir(@original_dir)
-  end
+      Dir.chdir("myapp")
+      example.run
+      Dir.chdir(original_dir)
+    end
 
-  describe "bin/setup" do
     it "generates .env" do
+      bash "bin/setup"
+
       assert File.exist?("./.env")
     end
   end
 
   describe "pliny-generate scaffold" do
-    before(:all) do
+    around do |example|
+      DB.tables.each { |t| DB.drop_table(t) }
+
+      original_dir = Dir.pwd
+      test_dir = Dir.mktmpdir("plinytest-")
+      Dir.chdir(test_dir)
+
+      bash "pliny-new myapp"
+
+      Dir.chdir("myapp")
+      bash "bin/setup"
+
+      example.run
+      Dir.chdir(original_dir)
+    end
+
+    before do
       bash "pliny-generate scaffold artist"
     end
 
@@ -45,6 +61,71 @@ describe "Pliny integration test" do
     end
   end
 
+  describe "rake db:migrate:status" do
+    around do |example|
+      DB.tables.each { |t| DB.drop_table(t) }
+
+      original_dir = Dir.pwd
+      test_dir = Dir.mktmpdir("plinytest-")
+      Dir.chdir(test_dir)
+
+      bash "pliny-new myapp"
+
+      Dir.chdir("myapp")
+      bash "bin/setup"
+
+      example.run
+      Dir.chdir(original_dir)
+    end
+
+    it "returns a migration in the DOWN state when not migrated" do
+      bash "pliny-generate model artist"
+      migration_file = Dir.glob('db/migrate/*').first
+
+      stdout, stderr = bash_with_output("rake db:migrate:status")
+
+      statuses = Hash[stdout.to_s.split(/\+[-]+\+[-]+\+/)[2..-1].map { |s| s.tr("\n", "") }.select(&:present?).map { |s| s.split("|").map { |s| s.tr(" ", "") }.select(&:present?).reverse }]
+      assert statuses[migration_file.split("/").last] == "DOWN"
+    end
+
+    it "returns a migration in the UP state when not migrated" do
+      bash "pliny-generate model artist"
+      migration_file = Dir.glob('db/migrate/*').first
+      bash "rake db:migrate"
+
+      stdout, stderr = bash_with_output("rake db:migrate:status")
+
+      statuses = Hash[stdout.to_s.split(/\+[-]+\+[-]+\+/)[2..-1].map { |s| s.tr("\n", "") }.select(&:present?).map { |s| s.split("|").map { |s| s.tr(" ", "") }.select(&:present?).reverse }]
+      assert statuses[migration_file.split("/").last] == "UP"
+    end
+
+    it "returns a migration in the FILE MISSING state when the file is missing" do
+      bash "pliny-generate model artist"
+      migration_file = Dir.glob('db/migrate/*').first
+      bash "rake db:migrate"
+
+      FileUtils.rm_f(migration_file)
+
+      stdout, stderr = bash_with_output("rake db:migrate:status")
+
+      statuses = Hash[stdout.to_s.split(/\+[-]+\+[-]+\+/)[2..-1].map { |s| s.tr("\n", "") }.select(&:present?).map { |s| s.split("|").map { |s| s.gsub(/(^[ ]+|[ ]+$)/, "") }.select(&:present?).reverse }]
+      assert statuses[migration_file.split("/").last] == "FILE MISSING"
+    end
+  end
+
+  def bash_with_output(cmd)
+    bin  = File.expand_path('../bin', File.dirname(__FILE__))
+    path = "#{bin}:#{ENV["PATH"]}"
+    env = { "PATH" => path }
+    stdout, stderr, status = Open3.capture3(env, cmd)
+
+    unless status.success?
+      raise "Failed to run #{cmd}, error was #{stderr}"
+    end
+
+    return stdout, stderr
+  end
+
   def bash(cmd)
     bin  = File.expand_path('../bin', File.dirname(__FILE__))
     path = "#{bin}:#{ENV["PATH"]}"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Brandur Leach
 - Pedro Belo
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -497,7 +497,7 @@ homepage: https://github.com/interagent/pliny
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -512,8 +512,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra
 test_files: []