schema_linter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '005249a95eec766cfdaf1d61ef1e1214785bbaf2045d7c065cad8dbe4d866638'
+  data.tar.gz: 7547d762dcec8b45af32f6640250a070f6948457fef87ceadb8edef0594121da
+SHA512:
+  metadata.gz: dc45dfbb4ce44a8bc388d5e8ae48ef61f66ee063020c9201fce6595c7a568b5317182a5942b5b9cdf832c93504632d23109f14067bb817d1fb1cd0938d08ee7c
+  data.tar.gz: 708b8ebaa63b850071300b141c3440fd930a41fe7d8f12320244f71d60da4f988855c0c23dcda28c27e9c9b33a3c469d3a70e5b5908b89f86e31f20cec22c564

data/.circleci/config.yml

@@ -0,0 +1,52 @@
+version: 2.1
+
+executors:
+  default:
+    working_directory: ~/app
+    docker:
+      - image: cimg/ruby:3.2.2
+        environment:
+          DB_USER: 'root'
+          DB_PASS: 'root'
+          DB_HOST: '127.0.0.1'
+      - image: circleci/mysql:8-ram
+        environment:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: schema_linter_test
+        command: [--default-authentication-plugin=mysql_native_password]
+
+commands:
+  setup_bundle:
+    steps:
+      - restore_cache:
+          key: bundle-{{ checksum "schema_linter.gemspec" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          key: bundle-{{ checksum "schema_linter.gemspec" }}
+          paths:
+          - vendor/bundle
+
+  wait_for_db:
+    steps:
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://127.0.0.1:3306 -timeout 1m
+
+jobs:
+  test:
+    executor: default
+    steps:
+      - checkout
+      - setup_bundle
+      - wait_for_db
+      - run: bundle exec rspec ./spec
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schema_linter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Akira Kusumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# schema_linter
+
+This tool inspects whether the database schema contains any reserved words from MySQL or PostgreSQL, or any table names and column names that should not be used in Rails. Furthermore, 
+it allows for the definition of custom settings using custom definition rules in the YAML configuration file.
+
+## Installation
+
+Add this line to your Gemfile:
+```
+gem 'schema_linter'
+```
+
+Then run:
+```
+% bundle
+```
+
+## Usage
+
+Simply execute the following command in your Rails app directory.
+
+```
+% rake schema_linter
+```
+
+If you want the rake task to fail when it encounters errors, use:
+
+```
+% FAIL_ON_ERROR=1 rake schema_linter
+```
+
+## Configuration
+
+Create a `.schema_linter.yaml` or `.schema_linter.yml` file in your root directory.
+
+To flag specific tables as errors, list them with regular expressions under `error_table_names`.
+To flag specific columns as errors, list them with regular expressions under `error_column_names`.
+
+```yaml
+error_table_names:
+  - .*histories$
+  - .*info$
+
+error_column_names:
+  - .*data$
+```
+
+To exclude specific tables from the checks, list them with regular expressions under ignore_table_names.
+To exclude specific columns from the checks, list them with regular expressions under ignore_column_names.
+
+```yaml
+ignore_table_names:
+  - ^user$
+
+ignore_column_names:
+  - ^role$
+```
+
+## Copyright
+
+Copyright (c) 2023 Akira Kusumoto. See MIT-LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec