database_schema_ownership 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5e756e987e34d6afc6217586393241faf93bf362adf8dac06ddcda94ac20b85
+  data.tar.gz: 57a76af1486dcb2e317451be4f7ba9be6d940ab0ec1a23d471181041ce0698ad
+SHA512:
+  metadata.gz: 1939d8886af6269f2ee40d1ceb10c5c0e10652fe44a308a62eb8b55be227727fdb45701251b77918eb554a13d8c23319bc557e61d37db152341c821ba4131b7c
+  data.tar.gz: 39a9a193151dd8f4213af72870aa133058ee75dcb960850a8adf7826d9f71332da4362a73693d6cccb8e453887dcfbc84eb593631f75ad16fc68dd1c176872a6

data/lib/database_schema_ownership/database_schema_ownership.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :database_schema_ownership do
+  desc "Generate ownership files for database schema"
+  task dump: "db:schema:dump" do
+    DatabaseSchemaOwnership::Runner.new.run
+  end
+end
+
+Rake::Task["db:schema:dump"].enhance do
+  Rake::Task["database_schema_ownership:dump"].invoke
+end

data/lib/database_schema_ownership/entity.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  class Entity # :nodoc:
+    attr_reader :name, :metadata
+
+    def initialize(name, metadata)
+      @name = name
+      @metadata = metadata
+    end
+  end
+end

data/lib/database_schema_ownership/parser/ruby_parser.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  class Parser
+    class RubyParser < Parser # :nodoc:
+      def parse
+        parse_tables + parse_foreign_keys
+      end
+
+      def parse_tables
+        schema.scan(/\n*(\s+create_table "([^"]*)".*?end)/m).map do |s|
+          DatabaseSchemaOwnership::Entity.new(s[1], s[0])
+        end
+      end
+
+      def parse_foreign_keys
+        schema.scan(/\n*(\s+add_foreign_key "([^"]*)", "([^"]*)")/).map do |s|
+          DatabaseSchemaOwnership::Entity.new(s[1], s[0])
+        end
+      end
+    end
+  end
+end

data/lib/database_schema_ownership/parser/sql_parser.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  class Parser
+    class SqlParser < Parser # :nodoc:
+      def parse
+        parse_tables + parse_indexes
+      end
+
+      def parse_tables
+        schema.scan(/(CREATE TABLE IF NOT EXISTS "([^"]*)"[^;]*;)/m).map do |s|
+          DatabaseSchemaOwnership::Entity.new(s[1], s[0])
+        end
+      end
+
+      def parse_indexes
+        schema.scan(/(CREATE INDEX .* ON "([^"]*)"[^;]*;)/).map do |s|
+          DatabaseSchemaOwnership::Entity.new(s[1], s[0])
+        end
+      end
+    end
+  end
+end

data/lib/database_schema_ownership/parser.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  class Parser # :nodoc:
+    def self.for(extension)
+      case extension
+      when ".rb" then RubyParser
+      when ".sql" then SqlParser
+      else
+        raise ArgumentError, "Unsupported schema extension: #{extension}"
+      end
+    end
+
+    attr_accessor :schema_path
+
+    def initialize(schema_path)
+      @schema_path = schema_path
+    end
+
+    def schema
+      File.read(schema_path)
+    end
+  end
+end

data/lib/database_schema_ownership/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "../database_schema_ownership"
+
+module DatabaseSchemaOwnership
+  class Railtie < Rails::Railtie # :nodoc:
+    rake_tasks do
+      load "#{__dir__}/database_schema_ownership.rake"
+    end
+  end
+end

data/lib/database_schema_ownership/runner.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  # :nodoc
+  class Runner
+    RUBY_SCHEMA_PATH = "db/schema.rb"
+    SQL_SCHEMA_PATH = "db/structure.sql"
+    OWNERSHIP_PATH = "db/database_schema_ownership"
+
+    attr_reader :schema_path, :folder_path, :schema_extension
+
+    def initialize(schema_path = nil, folder_path = OWNERSHIP_PATH)
+      @schema_path = schema_path || find_schema_path
+      @folder_path = folder_path
+      @schema_extension = File.extname(@schema_path)
+    end
+
+    def run
+      entities = parser.parse
+
+      FileUtils.mkdir_p(folder_path) if entities.any?
+
+      grouped = group_entities(entities)
+
+      grouped.each do |name, metadata|
+        File.write(file_name(name), metadata)
+      end
+    end
+
+    private
+
+    def group_entities(entities)
+      entities.each_with_object({}) do |entity, hash|
+        if hash[entity.name]
+          hash[entity.name] += "\n#{entity.metadata}"
+        else
+          hash[entity.name] = entity.metadata
+        end
+      end
+    end
+
+    def parser
+      DatabaseSchemaOwnership::Parser.for(schema_extension).new(schema_path)
+    end
+
+    def file_name(name)
+      "#{folder_path}/#{name}#{schema_extension}"
+    end
+
+    def find_schema_path
+      if File.exist?(RUBY_SCHEMA_PATH)
+        RUBY_SCHEMA_PATH
+      elsif File.exist?(SQL_SCHEMA_PATH)
+        SQL_SCHEMA_PATH
+      else
+        raise "Schema file not found"
+      end
+    end
+  end
+end

data/lib/database_schema_ownership/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DatabaseSchemaOwnership
+  VERSION = "1.0.0"
+end

data/lib/database_schema_ownership.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "database_schema_ownership/version"
+require_relative "database_schema_ownership/entity"
+require_relative "database_schema_ownership/parser/ruby_parser"
+require_relative "database_schema_ownership/parser/sql_parser"
+require_relative "database_schema_ownership/parser"
+require_relative "database_schema_ownership/runner"
+
+module DatabaseSchemaOwnership # :nodoc:
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: database_schema_ownership
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Evgeniy Demin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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:
+email:
+- lawliet.djez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/database_schema_ownership.rb
+- lib/database_schema_ownership/database_schema_ownership.rake
+- lib/database_schema_ownership/entity.rb
+- lib/database_schema_ownership/parser.rb
+- lib/database_schema_ownership/parser/ruby_parser.rb
+- lib/database_schema_ownership/parser/sql_parser.rb
+- lib/database_schema_ownership/railtie.rb
+- lib/database_schema_ownership/runner.rb
+- lib/database_schema_ownership/version.rb
+homepage: https://github.com/djezzzl/database_schema_ownership
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/djezzzl/database_schema_ownership
+  source_code_uri: https://github.com/djezzzl/database_schema_ownership
+  changelog_uri: https://github.com/djezzzl/database_schema_ownership/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Provide an easy way to manage code ownership over a database schema.
+test_files: []