Introduce edgestitch

.github/workflows/_ruby-package.yml

@@ -53,6 +53,7 @@ jobs:
             bundler: '1'
     env:
       RAILS_VERSION: '~> ${{ matrix.rails }}'
+      RAILS_ENV: test
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby

.github/workflows/edgestitch.yml

@@ -0,0 +1,14 @@
+name: edgestitch
+
+on:
+  push:
+
+jobs:
+  ruby:
+    uses: ./.github/workflows/_ruby-package.yml
+    with:
+      package: ${{ github.workflow }}
+      workdir: 'packages/${{ github.workflow }}'
+      before_build: sudo /etc/init.d/mysql start
+      rails: "['6.0','6.1','7.0']"
+    secrets: inherit

docs/README.md

@@ -42,6 +42,10 @@ Helping ruby developers implement easy patterns.
 
 A shared layout so that your suite of applications can have the same look and feel.
 
+[edgestitch](https://github.com/powerhome/power-tools/blob/main/packages/edgestitch/docs/README.md) 💎
+
+Edgestitch allows engines to define partial structure-self.sql files to be stitched into a single structure.sql file by the umbrella application.
+
 ## Installation 🛠
 
 These packages are all meant to install inside of an application and aren't intended to stand alone; currently, they are all published to [RubyGems](https://rubygems.org/) and you can use standard Bundler methods to install them.

packages/consent/mkdocs.yml

@@ -1,5 +1,6 @@
 site_name: Consent
 nav:
   - "Home": "README.md"
+  - "Changelog": "CHANGELOG.md"
 plugins:
   - techdocs-core

packages/edgestitch/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/structure.sql
+spec/dummy/log/*.log
+spec/dummy/storage/
+spec/dummy/tmp/
+coverage
+Gemfile.lock

packages/edgestitch/.rubocop.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-powerhome

packages/edgestitch/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+rails_version = ENV.fetch("RAILS_VERSION", ">= 5.2.8.1")
+
+gem "rails", rails_version

packages/edgestitch/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop)
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+task default: %i[rubocop app:db:prepare spec]

packages/edgestitch/doc/dependency_decisions.yml

@@ -0,0 +1,3 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml

packages/edgestitch/docs/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [1.0.0] - 2022-12-22
+
+- First release of Edgestitch, extracted from NitroMysql.
+- Supports all rails >= 6.0 and all ruby >= 2.7

packages/edgestitch/docs/README.md

@@ -0,0 +1,99 @@
+# Edgestitch
+
+Edgestitch allows engines to define partial structure-self.sql files to be stitched into a single structure.sql file by the umbrella application. This allows big teams to develop large [Cobra](https://cbra.info) [Applications](https://github.com/powerhome/cobra_commander) without much conflict happening in a single structure.sql file. Instead, each team will more likely update one component or two structure-self.sql files while other teams concerned with other areas of the application will be changing different files.
+
+## Installation
+
+### Umbrella App
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem "edgestitch", require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Then require the railtie in the umbrella's `config/application.rb`:
+
+```ruby
+# config/application.rb
+
+require "edgestitch/railtie"
+```
+
+If your umbrella app also has migrations or even models, you'll have to also install the engine task to your `Rakefile`:
+
+```ruby
+# Rakefile
+
+Edgestitch.define_engine(::My::Application)
+```
+
+### Engines
+
+Each internal engine will also have a development dependency on `edgestitch`, and can install it the same way:
+
+```ruby
+# crazy.gemspec
+
+spec.add_development_dependency "edgestitch"
+```
+
+And then execute:
+
+    $ bundle install
+
+And install the helper tasks:
+
+```ruby
+Edgestitch.define_engine(::Crazy::Engine)
+```
+
+You'll also have to add the `railtie` to the dummy app (as they're dummy umbrella apps), in case the engine has external database dependencies.
+
+```ruby
+# spec/dummy/config/application.rb
+
+require "edgestitch/railtie"
+```
+
+## Usage
+
+Edgestitch will enhance the default rails tasks, so using nothing special has to be done in order to use it. Once edgestitch is correctly installed things should Just Work™️ as explained in the rails manual, but it will be generating `structure-self.sql` along with `structure.sql` files. **Important**: It's recommended that `structure.sql` files are added to `.gitignore`.
+
+# How does it work
+
+Edgestitch works based on table and migrations ownership. Based on these ownerships, Edgestitch can export a `structure-self.sql` file defining the DDL owned by a specific engine.
+
+The stitching process then takes all loaded engines (assuming the dependency between engines is defined correctly) and assembles a structure.sql file.
+
+## Table and Migration Ownerships
+
+A model is owned by an engine when it inherits from the Engine's ApplicationModel, and thus the table is owned by that engine. A migration is owned by the engine if it is defined within its `db/migrate` directory.
+
+## Extra tables
+
+Sometimes an external dependency brings in extra tables that are not defined in any `structure-self.sql`. To be part of the ecosystem, the new tables should be owned by the engine adding them. That can be done by adding these tables to `<engine>/db/extra_tables`. It's a simple text file with a list of table names that do not inherit from `<Engine>::AplicationModel`, but are owned by that engine and should be included in its structure-self.sql.
+
+## External Gems
+
+An external gem can also define a `structure-self.sql` file to be adapted in this ecosystem. That can be done using the same approach specified in Installation / Engines.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/powerhome/power-tools.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

packages/edgestitch/edgestitch.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require "edgestitch/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "edgestitch"
+  spec.version     = Edgestitch::VERSION
+  spec.authors     = ["Carlos Palhares"]
+  spec.email       = ["chjunior@gmail.com"]
+
+  spec.description = spec.summary = "Edgestitch allows engines to define partial structure-self.sql files to be " \
+                                    "stitched into a single structure.sql file by the umbrella application"
+  spec.homepage = "https://github.com/powerhome/power-tools"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/packages/edgestitch/docs/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "license_finder", ">= 7.0"
+  spec.add_development_dependency "mysql2", "0.5.3"
+  spec.add_development_dependency "pry-byebug", "3.9.0"
+  spec.add_development_dependency "rails", ">= 5.2.8.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 5.1.2"
+  spec.add_development_dependency "rubocop-powerhome", "0.5.0"
+  spec.add_development_dependency "simplecov", "0.15.1"
+  spec.add_development_dependency "yard", "0.9.21"
+end

packages/edgestitch/lib/edgestitch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "edgestitch/exporter"
+require "edgestitch/stitcher"
+require "edgestitch/tasks"
+require "edgestitch/version"
+
+require "edgestitch/mysql/dump"
+
+# Facade module to access public Edgestitch functions
+#
+module Edgestitch
+module_function
+
+  # Define a db:stitch task
+  # @see Edgestitch::Tasks
+  def define_stitch(...)
+    ::Edgestitch::Tasks.define_stitch(...)
+  end
+
+  # Define a db:stitch:<engine_name> task
+  # @see Edgestitch::Tasks
+  def define_engine(...)
+    ::Edgestitch::Tasks.define_engine(...)
+  end
+end

packages/edgestitch/lib/edgestitch/exporter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Edgestitch
+  # @private
+  #
+  # This class is responsible for exporting an engine's owned tables and
+  # migrations to a SQL file.
+  #
+  class Exporter
+    # Exports an engine using a dump helper (@see Edgestitch::Mysql::Dump)
+    #
+    # @param engine [Class<Rails::Engine>] the engine to export
+    # @param dump [<#export_tables,#export_migrations>] the dump helper
+    #
+    def self.export(engine, dump)
+      new(engine).export(dump)
+    end
+
+    attr_reader :engine
+
+    def initialize(engine)
+      @engine = engine
+      @database_directory_path = engine.root.join("db")
+      @extra_tables_path = @database_directory_path.join("extra_tables")
+      @structure_file_path = @database_directory_path.join("structure-self.sql")
+    end
+
+    def export(dump, to: @structure_file_path)
+      StringIO.open do |buffer|
+        buffer.puts dump.export_tables(tables)
+        buffer.puts
+        buffer.puts dump.export_migrations(migrations)
+        File.write to, "#{buffer.string.strip}\n"
+      end
+    end
+
+    def migrations
+      @migrations ||= begin
+        migrations_glob = @database_directory_path.join("{migrate,migrate.archive}/*.rb")
+        Dir[migrations_glob]
+          .map { |filename| File.basename(filename).to_i }
+          .sort
+      end
+    end
+
+    def tables
+      component_tables + extra_tables
+    end
+
+  private
+
+    def extra_tables
+      @extra_tables ||= @extra_tables_path.exist? ? @extra_tables_path.readlines.map(&:strip) : []
+    end
+
+    def component_tables
+      @component_tables ||= models.each_with_object(Set.new) do |model, tables|
+        tables << model.table_name if model.table_exists?
+      end.sort
+    end
+
+    def models
+      @models ||= application_record&.descendants || []
+    end
+
+    def application_record
+      @application_record ||= engine.railtie_namespace&.const_get(:ApplicationRecord, false)
+    rescue LoadError, NameError
+      nil
+    end
+  end
+end