rails-crud-tools 0.6.7 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c020623ef97225f0c8bfd10752f7722fa426891fc8d9499d2602ba30a4d917
-  data.tar.gz: 38b6f4900271a0bcdd66dda44590b88ea081e9d22f0b8cabb6a01ed825fd43ec
+  metadata.gz: 9d60769342a2c4f14ca5185dac7446f06fb2ab137c2835f004da3994a97bad2d
+  data.tar.gz: d0f0ba569e37b04b0d5e5692b4ca60c05becc2ab3c91b0da2a315e12ca26f274
 SHA512:
-  metadata.gz: a254c83739d5eb816d13d427cf9a89aa97bb8442cedc3204a850860562b24443a914298ff1c6cfe8f8425c7aadb0b3a3ca85158f65fbdc533658745f9f135e0f
-  data.tar.gz: 425914bb4fdffeac8320f794a2c38d14f1bc3b55aac664bd22df61405a0d19eaf141af1cb424725106f887b9fb960e83e0049d524c0a227abba99ad409f859f3
+  metadata.gz: 3cfd62496d6616601689aa943fd6a4face9369249489dbb88d1be2c825b69118e28ac850cd9e91299930153a91b38ff7d9caa1413d1d5592d58ec58a9c8ce141
+  data.tar.gz: fcc34ae205587a64a795e07ad9d5111443a86d4913cfda3823a72358c53c0c0cca7290726b652b2a349990afb5c322402711d99ffaa544795252a448401db4e7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,269 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'ide/**/*'
+    - 'spec/**/*'
+    - 'lib/rails/crud/tools/cli.rb'
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/ModuleLength:
+  Max: 120
+Gemspec/AddRuntimeDependency:
+  Enabled: true
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+Layout/LineContinuationSpacing:
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/ConstantOverwrittenInRescue:
+  Enabled: true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateMagicComment:
+  Enabled: true
+Lint/DuplicateMatchPattern:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/DuplicateSetElement:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyInPattern:
+  Enabled: true
+Lint/HashNewWithKeywordArgumentsAsDefault:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/LiteralAssignmentInCondition:
+  Enabled: true
+Lint/MixedCaseRange:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NonAtomicFileOperation:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/NumericOperationWithConstantResult:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RedundantRegexpQuantifiers:
+  Enabled: true
+Lint/RefinementImportMethods:
+  Enabled: true
+Lint/RequireRangeParentheses:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/UnescapedBracketInRegexp:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UselessDefined:
+  Enabled: true
+Lint/UselessNumericOperation:
+  Enabled: true
+Lint/UselessRescue:
+  Enabled: true
+Lint/UselessRuby2Keywords:
+  Enabled: true
+Metrics/CollectionLiteralLength:
+  Enabled: true
+Naming/BlockForwarding:
+  Enabled: true
+Security/CompoundHash:
+  Enabled: true
+Security/IoMethods:
+  Enabled: true
+Style/AmbiguousEndlessMethodDefinition:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: true
+Style/ArrayIntersect:
+  Enabled: true
+Style/BitwisePredicate:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/CombinableDefined:
+  Enabled: true
+Style/ComparableClamp:
+  Enabled: true
+Style/ConcatArrayLiterals:
+  Enabled: true
+Style/DataInheritance:
+  Enabled: true
+Style/DigChain:
+  Enabled: true
+Style/DirEmpty:
+  Enabled: true
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+Style/EmptyHeredoc:
+  Enabled: true
+Style/EndlessMethod:
+  Enabled: true
+Style/EnvHome:
+  Enabled: true
+Style/ExactRegexpMatch:
+  Enabled: true
+Style/FetchEnvVar:
+  Enabled: true
+Style/FileEmpty:
+  Enabled: true
+Style/FileNull:
+  Enabled: true
+Style/FileRead:
+  Enabled: true
+Style/FileTouch:
+  Enabled: true
+Style/FileWrite:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/KeywordArgumentsMerging:
+  Enabled: true
+Style/MagicCommentFormat:
+  Enabled: true
+Style/MapCompactWithConditionalBlock:
+  Enabled: true
+Style/MapIntoArray:
+  Enabled: true
+Style/MapToHash:
+  Enabled: true
+Style/MapToSet:
+  Enabled: true
+Style/MinMaxComparison:
+  Enabled: true
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NestedFileDirname:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/ObjectThen:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/OperatorMethodCall:
+  Enabled: true
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantArrayConstructor:
+  Enabled: true
+Style/RedundantConstantBase:
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath:
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: true
+Style/RedundantEach:
+  Enabled: true
+Style/RedundantFilterChain:
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes:
+  Enabled: true
+Style/RedundantInitialize:
+  Enabled: true
+Style/RedundantInterpolationUnfreeze:
+  Enabled: true
+Style/RedundantLineContinuation:
+  Enabled: true
+Style/RedundantRegexpArgument:
+  Enabled: true
+Style/RedundantRegexpConstructor:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/RedundantStringEscape:
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: true
+Style/SafeNavigationChainLength:
+  Enabled: true
+Style/SelectByRegexp:
+  Enabled: true
+Style/SendWithLiteralMethodName:
+  Enabled: true
+Style/SingleLineDoEndBlock:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/SuperArguments:
+  Enabled: true
+Style/SuperWithArgsParentheses:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true
+Style/YAMLFileRead:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,75 @@
+## [0.6.3] - 2025-01-09
+- refactoring gem dependency
+
+## [0.6.2] - 2025-01-09
+- bug fix:uninitialized constant RubyXL::Cell
+
+## [0.6.1] - 2025-01-09
+- Rubocop support 
+- Change of configuration file name
+
+## [0.6.0] - 2025-01-08
+- Support for select insert, select update, and select delete
+
+## [0.5.0] - 2025-01-07
+- Multiple table support
+
+## [0.4.3] - 2025-01-07
+- Refactored `crud_notifications.rb`.
+- Modified to not execute the `setup` method in `tools.rb` when running commands.
+
+## [0.4.2] - 2025-01-06
+- Fixed to update the last modifier of the CRUD file
+- Changed CRUD file saving process to asynchronous processing
+
+## [0.4.1] - 2025-01-04
+- Create the base directory if it does not exist during initialization
+
+## [0.4.0] - 2025-01-04
+- Fixed to save only when cell values change
+- Added sheet name to configuration file
+- Added font name to configuration file
+- Created test code
+- Added initialization command
+- Added configuration file creation command
+
+## [0.3.2] - 2025-01-01
+- Multi-thread support
+
+## [0.3.1] - 2024-12-31
+- Changed to rails-crud-tools
+
+## [0.3.0] - 2024-12-30
+- Job support
+- Added command to generate CRUD diagrams
+
+## [0.2.2] - 2024-12-25
+- Added ON/OFF for SQL output
+- Improved summary log
+
+## [0.2.1] - 2024-12-25
+- Refactoring
+
+## [0.2.0] - 2024-12-25
+- API support
+
+## [0.1.6] - 2024-12-25
+- Improved logging
+
+## [0.1.5] - 2024-12-25
+- Improved multi-threading
+
+## [0.1.4] - 2024-12-24
+- Refactoring
+
+## [0.1.3] - 2024-12-24
+- Bug fix
+
+## [0.1.2] - 2024-12-24
+- Bug fix
+
+## [0.1.1] - 2024-12-24
+- Preview release
+
+## [0.1.0] - 2024-12-23
+- Initial release

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:3.1.4
+
+ARG IDEURL=https://download.jetbrains.com/ruby/RubyMine-2024.3.1.1.tar.gz
+
+RUN apt-get update -qq && apt-get install -y \
+  build-essential \
+  vim && \
+  rm -rf /var/lib/apt/lists/*
+
+ENV EDITOR=vim
+
+WORKDIR /root/app
+
+RUN curl -fsSL -o ide.tar.gz $IDEURL && \
+mkdir ide && \
+tar xfz ide.tar.gz --strip-components=1 -C ide && \
+rm ide.tar.gz
+
+CMD yes '' | ide/bin/remote-dev-server.sh run $APP_ROOT --listenOn 0.0.0.0 --port 5995
+
+EXPOSE 5995

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-crud-tools.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubyzip", "~> 2.4"
+
+gem "rails"
+
+gem "simplecov"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 yamabiko
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 yhijikata
+
+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,73 @@
+# Rails::Crud::Tools
+
+Welcome to Rails::Crud::Tools!   
+This gem provides a tool to automatically update CRUD diagrams as you interact with your application.   
+It simplifies logging and managing CRUD operations seamlessly within a Rails application.
+
+## Installation
+
+Add the gem to the `development` group in your application's Gemfile by including the following lines:
+
+```ruby
+gem 'rails-crud-tools'
+```
+
+Then execute:
+
+```sh
+$ bundle install
+```
+
+If you are not using Bundler, you can install the gem manually:
+
+```sh
+$ gem install rails-crud-tools
+```
+
+## Usage
+
+### Setup
+This command will generate the **doc/crud.xlsx** file and the **.crudconfig.yml** file.
+
+```sh
+$ bundle exec crud init
+```
+
+.crudconfig.yml
+```yaml
+enabled: true # Enables or disables the CRUD tools functionality
+base_dir: doc # The base directory where the CRUD files will be stored
+crud_file: crud.xlsx # The name of the CRUD Excel file
+sheet_name: CRUD # The name of the sheet in the CRUD Excel file
+method_col: Verb # Column indicating the HTTP method
+action_col: Controller#Action # Column indicating the controller and action
+table_start_col: your_first_table  # Column where the table starts
+header_bg_color: 00FFCC # The background color for the header in the CRUD Excel file
+sql_logging_enabled: true # Enables or disables SQL logging for CRUD operations
+font_name: Arial # The font name used in the CRUD Excel file
+```
+
+### How It Works
+
+Once integrated, the gem automatically tracks CRUD operations (Create, Read, Update, Delete) performed in your application.   
+The diagrams will update dynamically based on these operations, providing you with real-time insights into your application's data flow.
+
+## Logs
+
+Please refer to the log file at `log/crud.log`.
+
+## CRUD Macro Workbook
+
+The `tools/crud_macro.xlsm` file is a macro-enabled workbook used for manipulating CRUD diagrams.  
+This workbook contains macros that help in managing and visualizing CRUD operations within your application.
+
+### Excel Macro Download
+
+You can download the `crud_macro.xlsm` file from the following link:
+
+[Download crud_macro.xlsm](https://github.com/YamabikoLab/rails-crud-tools/raw/main/tools/crud_macro.xlsm)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.8'
+services:
+  app:
+    build: .
+    container_name: rails-crud-tools
+    volumes:
+      - .:/root/app
+      - ./ide:/root/app/ide
+    ports:
+      - '5995:5995'
+    tty: true

data/exe/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails/crud/tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/exe/crud

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV["SKIP_CRUD_SETUP"] = "true"
+require "rails/crud/tools/cli"
+
+def display_help
+  puts <<~HELP
+    Usage: crud [command]
+
+    Commands:
+      init    Initialize by generating CRUD and config files
+      gen crud    Generate CRUD file
+      gen config  Generate config file
+      help    Display this help message
+  HELP
+end
+
+if ARGV.empty? || ARGV.include?("help")
+  display_help
+elsif ARGV.include?("init")
+  RailsCrudTools::CLI.init
+elsif ARGV == %w[gen crud]
+  RailsCrudTools::CLI.generate_crud_file
+elsif ARGV == %w[gen config]
+  RailsCrudTools::CLI.generate_crud_config
+else
+  puts "Unknown command: #{ARGV.join(" ")}"
+  display_help
+end

data/exe/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here