schema_linter 0.0.1

data/lib/schema_linter.rb

@@ -0,0 +1,83 @@
+class SchemaLinter
+  VERSION = Gem.loaded_specs['schema_linter'].version.to_s
+
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), "tasks/schema_linter.rake")
+    end
+  end
+
+  def initialize
+    @error_table_names            = (config["error_table_names"] || []).map { |v| Regexp.new(v) }
+    @error_column_names           = (config["error_column_names"] || []).map { |v| Regexp.new(v) }
+    @ignore_table_names           = (config["ignore_table_names"] || []).map { |v| Regexp.new(v) }
+    @ignore_column_names          = (config["ignore_column_names"] || []).map { |v| Regexp.new(v) }
+    @rails_reserved_table_names   = load_keywords("#{root_dir}/lib/rails_avoid_tables.txt")
+    @rails_reserved_column_names  = load_keywords("#{root_dir}/lib/rails_avoid_columns.txt")
+    @postgresql_reserved_keywords = load_keywords("#{root_dir}/lib/postgresql_keywords.txt")
+    @mysql_reserved_keywords      = load_keywords("#{root_dir}/lib/mysql_keywords.txt")
+  end
+
+  def error_table_names
+    table_names = models.map(&:table_name)
+    table_names.filter do |table_name|
+      table_name_has_errors?(table_name)
+    end
+  end
+
+  def error_column_names
+    models.each.with_object([]) do |model, error_columns|
+      column_names = model.columns.map(&:name)
+
+      column_names.each do |column_name|
+        if column_name_has_errors?(column_name)
+          error_columns << "#{model.table_name}.#{column_name}"
+        end
+      end
+    end
+  end
+
+  private
+
+  def root_dir
+    File.expand_path('..', File.dirname(__FILE__))
+  end
+
+  def config_filename
+    %w[.schema_linter.yaml .schema_linter.yml].detect { |f| File.exist?(f) }
+  end
+
+  def config
+    @config ||= config_filename ? YAML.load_file(config_filename) : {}
+  end
+
+  def models
+    return @models if @models
+
+    @models ||= ActiveRecord::Base.descendants.reject(&:abstract_class)
+  end
+
+  def table_name_has_errors?(table_name)
+    name = table_name.downcase
+    return false if @ignore_table_names.any? { |regexp| name.match?(regexp) }
+
+    @error_table_names.any? { |regexp| name.match?(regexp) } ||
+      @mysql_reserved_keywords.include?(name) ||
+      @postgresql_reserved_keywords.include?(name) ||
+      @rails_reserved_table_names.include?(name)
+  end
+
+  def column_name_has_errors?(column_name)
+    name = column_name.downcase
+    return false if @ignore_column_names.any? { |regexp| name.match?(regexp) }
+
+    @error_column_names.any? { |regexp| name.match?(regexp) } ||
+      @mysql_reserved_keywords.include?(name) ||
+      @postgresql_reserved_keywords.include?(name) ||
+      @rails_reserved_column_names.include?(name)
+  end
+
+  def load_keywords(file_path)
+    File.readlines(file_path).map(&:strip).map(&:downcase)
+  end
+end

data/lib/tasks/schema_linter.rake

@@ -0,0 +1,20 @@
+desc 'Perform schema linting and output error table and column names. Raise an error if FAIL_ON_ERROR is set and there are errors.'
+task schema_linter: :environment do
+  schema_linter = SchemaLinter.new
+
+  error_table_names = schema_linter.error_table_names
+  if error_table_names.present?
+    puts "Error table names (#{error_table_names.size}):"
+    error_table_names.each { |table_name| puts "  #{table_name}" }
+  end
+
+  error_column_names = schema_linter.error_column_names
+  if error_column_names.present?
+    puts "Error column names (#{error_column_names.size}):"
+    error_column_names.each { |column_name| puts "  #{column_name}" }
+  end
+
+  if ENV['FAIL_ON_ERROR'] && (error_table_names.present? || error_column_names.present?)
+    raise 'Error detected.'
+  end
+end

data/schema_linter.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path('lib', __dir__)
+
+Gem::Specification.new do |s|
+  s.name        = 'schema_linter'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Akira Kusumoto']
+  s.email       = ['akirakusumo10@gmail.com']
+  s.homepage    = 'https://github.com/bluerabbit/schema_linter'
+  s.summary     = 'A linter for database schema naming conventions'
+  s.description = "The SchemaLinter gem ensures your database schema naming conventions are adhered to by checking both table names and column names against custom-defined rules in a YAML configuration file."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 6.0.0']
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rspec', '~> 3.9'
+end

data/spec/app.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails/all'
+require 'action_controller/railtie'
+
+require 'schema_linter'
+
+module DummyApp
+  class Application < Rails::Application
+    config.root = File.expand_path(__dir__)
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  YAML.safe_load(ERB.new(File.read('spec/database.yml')).result, aliases: true)['test']
+)
+
+ActiveRecord::Schema.define version: 0 do
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :role # This column is a reserved word in MySQL.
+  end
+
+  # This table name conflicts with a Rails class.
+  create_table :configurations, force: true do |t|
+    t.string :service_name
+  end
+end
+
+class User < ActiveRecord::Base
+end
+
+class Configuration < ActiveRecord::Base
+end

data/spec/database.yml

@@ -0,0 +1,18 @@
+default: &default
+  adapter:   mysql2
+  encoding:  utf8mb4
+  charset:   utf8mb4
+  collation: utf8mb4_general_ci
+  pool:      5
+  username:  <%= ENV.fetch("DB_USER") { 'root' } %>
+  password:  <%= ENV.fetch("DB_PASS") { '' } %>
+  host:      <%= ENV.fetch("DB_HOST") { '127.0.0.1' } %>
+  socket:    /tmp/mysql.sock
+
+development:
+  <<: *default
+  database: schema_linter_development
+
+test:
+  <<: *default
+  database: schema_linter_test

data/spec/schema_linter_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SchemaLinter do
+  it 'has a version number' do
+    expect(SchemaLinter::VERSION).not_to be nil
+  end
+
+  let(:schema_linter) { SchemaLinter.new }
+
+  after { File.delete '.schema_linter.yml' if File.exist? '.schema_linter.yml' }
+
+  describe '#error_table_names' do
+    it do
+      expect(schema_linter.error_table_names).to match_array(["configurations"])
+    end
+
+    context 'When a configuration file is present' do
+      before do
+        File.open '.schema_linter.yml', 'w' do |file|
+          file.puts 'error_table_names:'
+          file.puts '  - ^users$' # Treat the users table as an error
+          file.puts 'ignore_table_names:'
+          file.puts '  - ^configurations$' # Ignore the configurations table
+        end
+      end
+
+      it 'finds error table names.' do
+        expect(schema_linter.error_table_names).to match_array(%w[users])
+      end
+    end
+  end
+
+  describe '#error_column_names' do
+    it 'Database columns that use reserved keywords will result in errors.' do
+      expect(schema_linter.error_column_names).to match_array(["users.role"])
+    end
+
+    context 'When a configuration file is present' do
+      before do
+        File.open '.schema_linter.yml', 'w' do |file|
+          file.puts 'error_column_names:'
+          file.puts '  - ^name$' # Treat the name column as an error
+          file.puts 'ignore_column_names:'
+          file.puts '  - ^role$' # Ignore the role column
+        end
+      end
+
+      it 'finds error column names.' do
+        expect(schema_linter.error_column_names).to match_array(%w[users.name])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'pry'
+require 'rails'
+require 'schema_linter'
+require_relative 'app'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+
+      raise ActiveRecord::Rollback
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: schema_linter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Kusumoto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: The SchemaLinter gem ensures your database schema naming conventions
+  are adhered to by checking both table names and column names against custom-defined
+  rules in a YAML configuration file.
+email:
+- akirakusumo10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mysql_keywords.txt
+- lib/postgresql_keywords.txt
+- lib/rails_avoid_columns.txt
+- lib/rails_avoid_tables.txt
+- lib/schema_linter.rb
+- lib/tasks/schema_linter.rake
+- schema_linter.gemspec
+- spec/app.rb
+- spec/database.yml
+- spec/schema_linter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluerabbit/schema_linter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: A linter for database schema naming conventions
+test_files:
+- spec/app.rb
+- spec/database.yml
+- spec/schema_linter_spec.rb
+- spec/spec_helper.rb