docquet 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49e0d74225773f2f104a4f3c1a34cf72438cf27d1d244d2bc1dc69e968cf7e69
+  data.tar.gz: fcf9b6ad2fbe9de0768d8127e9022360c16a4d19f2106ba79a01519ab56f7b42
+SHA512:
+  metadata.gz: 0f626d2c9ad3a80235268319c90e548e5291f1ace35b9038efba5c24299de804d1436c8e86df9218ebc2f2a65ad885e092b72c1c0d945231311e2e5fb7c4ca4a
+  data.tar.gz: 6c3b5b0d0a5f55aa5703d3992cace6b1418469d6790575a8826d436312ab5859565153160721f9bc7870f007d5d5b32b8767944f9bae5e6415d755f2fc0264e7

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-11-02
+
+### Added
+- CLI tool with `install-config` and `regenerate-todo` commands
+- Automatic RuboCop plugin detection using gem metadata
+- Configuration generator for 18 RuboCop departments and plugins
+- Support for core RuboCop departments (Style, Layout, Lint, Metrics, Security, Gemspec, Bundler, Naming)
+- Support for RuboCop plugin extensions (Performance, RSpec, Capybara, I18n, Rake, Sequel, ThreadSafety, Migration)
+- ERB-based configuration template system
+- Ruby 3.2+ compatibility with Zeitwerk autoloading
+- Dry::CLI framework integration for command-line interface
+
+### Features
+- Smart plugin detection based on installed gems
+- Automatic `.rubocop_todo.yml` generation for gradual adoption
+- Project-specific RuboCop configuration inheritance
+- Force option for overwriting existing configuration files
+- Ruby version detection from `.ruby-version` file or current Ruby version

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 OZAWA Sakuro
+
+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,205 @@
+# Docquet
+
+A standardized RuboCop configuration gem that automatically detects available RuboCop plugins and generates appropriate configurations with CLI tools for easy setup and maintenance.
+
+## Features
+
+- **Automatic Plugin Detection**: Automatically detects installed RuboCop plugins and includes their configurations
+- **CLI Tools**: Easy-to-use commands for initialization and maintenance
+- **Comprehensive Coverage**: Supports all major RuboCop plugins out of the box
+- **Documentation Links**: Generated configurations include links to official documentation
+- **Smart Detection**: Uses gem metadata to automatically detect installed RuboCop plugins
+- **Incremental Setup**: Generates `.rubocop_todo.yml` for gradual adoption
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+group :development do
+  gem "docquet", require: false
+end
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install it as a standalone gem:
+
+```bash
+gem install docquet
+```
+
+## Usage
+
+### Install RuboCop Configuration
+
+Run the installation command in your project root:
+
+```bash
+docquet install-config
+```
+
+This command will:
+1. Generate `.rubocop.yml` with configurations for detected plugins
+2. Create an initial `.rubocop_todo.yml` with existing violations
+3. Display next steps for gradual adoption
+
+To overwrite existing files:
+
+```bash
+docquet install-config --force
+```
+
+### Update TODO File
+
+When you've fixed some violations and want to regenerate the TODO file:
+
+```bash
+docquet regenerate-todo
+```
+
+This command will:
+- Regenerate `.rubocop_todo.yml` with current violations
+- Show whether the TODO file changed
+- Provide feedback on progress
+
+## Supported RuboCop Plugins
+
+The gem automatically detects and configures the following plugins when installed:
+
+### Core RuboCop
+- **Bundler**: Bundler-related rules
+- **Gemspec**: Gemspec file rules  
+- **Layout**: Code formatting and layout rules
+- **Lint**: Rules for catching potential bugs
+- **Metrics**: Code complexity and size metrics
+- **Naming**: Naming convention rules
+- **Security**: Security-related rules
+- **Style**: General code style rules
+
+### Plugin Extensions (Auto-detected)
+- **rubocop-capybara**: Capybara testing framework rules
+- **rubocop-i18n**: Internationalization rules (GetText, Rails I18n)
+- **rubocop-migration**: Database migration rules (for Rails applications)
+- **rubocop-performance**: Performance optimization rules
+- **rubocop-rake**: Rake task rules
+- **rubocop-rspec**: RSpec testing framework rules (including Capybara integration)
+- **rubocop-sequel**: Sequel ORM rules
+- **rubocop-thread_safety**: Thread safety rules
+
+## Generated Configuration Structure
+
+The generated `.rubocop.yml` file includes:
+
+```yaml
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  EnabledByDefault: true
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+  ExtraDetails: true
+  NewCops: enable
+  TargetRubyVersion: 3.2  # Detected from .ruby-version or current Ruby
+  UseCache: true
+
+plugins:
+  - rubocop-performance  # Auto-detected plugins
+  - rubocop-rspec
+  # ... other detected plugins
+
+inherit_gem:
+  docquet:
+    - config/cops/style.yml        # Core style rules
+    - config/cops/layout.yml       # Core layout rules
+    - config/cops/performance.yml  # Performance rules (if plugin detected)
+    - config/cops/rspec.yml        # RSpec rules (if plugin detected)
+    # ... other detected plugins
+
+inherit_from: .rubocop_todo.yml
+```
+
+Each configuration file includes:
+- Department-specific rules
+- Links to official RuboCop documentation
+- Carefully curated cop configurations
+- Optimized settings for practical use
+
+The configuration uses `EnabledByDefault: true` for strict code quality enforcement with TODO file for gradual adoption.
+
+## Configuration Philosophy
+
+This configuration aims to:
+
+1. **Enforce Consistency**: Standardize code style across projects
+2. **Promote Best Practices**: Enable rules that catch common issues
+3. **Provide Documentation**: Include links to understand each rule
+4. **Enable Gradual Adoption**: Use TODO files for incremental improvements
+5. **Stay Current**: Automatically adapt to installed plugin versions
+
+## Development
+
+### Setup
+
+```bash
+bundle install
+```
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Running RuboCop
+
+```bash
+bundle exec rubocop
+```
+
+### Testing CLI Commands
+
+```bash
+# Test installation command
+./exe/docquet install-config
+
+# Test TODO regeneration
+./exe/docquet regenerate-todo
+```
+
+## Documentation Links
+
+### Core RuboCop
+- [Bundler Cops](https://docs.rubocop.org/rubocop/cops_bundler.html)
+- [Gemspec Cops](https://docs.rubocop.org/rubocop/cops_gemspec.html)  
+- [Layout Cops](https://docs.rubocop.org/rubocop/cops_layout.html)
+- [Lint Cops](https://docs.rubocop.org/rubocop/cops_lint.html)
+- [Metrics Cops](https://docs.rubocop.org/rubocop/cops_metrics.html)
+- [Naming Cops](https://docs.rubocop.org/rubocop/cops_naming.html)
+- [Security Cops](https://docs.rubocop.org/rubocop/cops_security.html)
+- [Style Cops](https://docs.rubocop.org/rubocop/cops_style.html)
+
+### Plugin Extensions  
+- [Performance Cops](https://docs.rubocop.org/rubocop-performance/cops_performance.html)
+- [RSpec Cops](https://docs.rubocop.org/rubocop-rspec/cops_rspec.html)
+- [RSpec Capybara Cops](https://docs.rubocop.org/rubocop-rspec/cops_rspec_capybara.html)
+- [RSpec FactoryBot Cops](https://docs.rubocop.org/rubocop-rspec/cops_rspec_factorybot.html)  
+- [RSpec Rails Cops](https://docs.rubocop.org/rubocop-rspec/cops_rspec_rails.html)
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes with tests
+4. Run the test suite: `bundle exec rspec`  
+5. Run RuboCop: `bundle exec rubocop`
+6. Submit a pull request
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](LICENSE).

data/config/cops/bundler.yml

@@ -0,0 +1,19 @@
+inherit_from: ../defaults/bundler.yml
+
+Bundler/GemComment:
+  OnlyFor:
+  - restrictive_version_specifiers
+  - bitbucket
+  - gist
+  - git
+  - github
+  - source
+
+Bundler/GemVersion:
+  Enabled: false
+
+Bundler/InsecureProtocolSource:
+ AllowHttpProtocol: false
+
+Bundler/OrderedGems:
+  ConsiderPunctuation: true

data/config/cops/capybara.yml

@@ -0,0 +1 @@
+inherit_from: ../defaults/capybara.yml

data/config/cops/capybara_rspec.yml

@@ -0,0 +1 @@
+inherit_from: ../defaults/capybara_rspec.yml

data/config/cops/gemspec.yml

@@ -0,0 +1,4 @@
+inherit_from: ../defaults/gemspec.yml
+
+Gemspec/OrderedDependencies:
+  ConsiderPunctuation: true

data/config/cops/i18n_gettext.yml

@@ -0,0 +1,2 @@
+inherit_from: ../defaults/i18n_gettext.yml
+

data/config/cops/i18n_railsi18n.yml

@@ -0,0 +1 @@
+inherit_from: ../defaults/i18n_railsi18n.yml

data/config/cops/layout.yml

@@ -0,0 +1,79 @@
+inherit_from: ../defaults/layout.yml
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ClassStructure:
+  ExpectedOrder:
+  - module_inclusion
+  - constants
+  - association
+  - public_attribute_macros
+  - public_delegate
+  - macros
+  - public_class_methods
+  - initializer
+  - public_methods
+  - protected_attribute_macros
+  - protected_methods
+  - private_attribute_macros
+  - private_delegate
+  - private_methods
+
+Layout/FirstArrayElementLineBreak:
+  AllowMultilineFinalElement: true
+
+Layout/FirstMethodArgumentLineBreak:
+  AllowMultilineFinalElement: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  AllowMultilineFinalElement: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  AllowedPatterns:
+  - expect
+  - (?:all|any|none|one)\?
+  - \bdef [A-Z]?[a-z0-9_]+[!?]?(?:\(.*\))? = .*(?!end)$
+
+Layout/MultilineArrayLineBreaks:
+  AllowMultilineFinalElement: true
+
+Layout/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/RedundantLineBreak:
+  Enabled: false
+
+Layout/SingleLineBlockChain:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceAroundOperators:
+  AllowForAlignment: false
+
+Layout/SpaceBeforeFirstArg:
+  AllowForAlignment: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBrackets: no_space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space

data/config/cops/lint.yml

@@ -0,0 +1,7 @@
+inherit_from: ../defaults/lint.yml
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  IgnoreEmptyBlocks: false

data/config/cops/metrics.yml

@@ -0,0 +1,14 @@
+inherit_from: ../defaults/metrics.yml
+
+Metrics/BlockLength:
+  AllowedMethods:
+  - context
+  - describe
+  - file
+  - namespace
+  - refine
+  - shared_context
+  - shared_examples
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false

data/config/cops/migration.yml

@@ -0,0 +1,2 @@
+inherit_from: ../defaults/migration.yml
+

data/config/cops/naming.yml

@@ -0,0 +1,4 @@
+inherit_from: ../defaults/naming.yml
+
+Naming/InclusiveLanguage:
+  Enabled: false

data/config/cops/performance.yml

@@ -0,0 +1,7 @@
+inherit_from: ../defaults/performance.yml
+
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: false
+
+Performance/MethodObjectAsBlock:
+  Enabled: false

data/config/cops/rake.yml

@@ -0,0 +1,5 @@
+inherit_from: ../defaults/rake.yml
+
+Rake/MethodDefinitionInTask:
+  Enabled: false
+

data/config/cops/rspec.yml

@@ -0,0 +1,41 @@
+inherit_from: ../defaults/rspec.yml
+
+RSpec/AlignLeftLetBrace:
+  Enabled: false
+
+RSpec/AlignRightLetBrace:
+  Enabled: false
+
+RSpec/ContextWording:
+  Prefixes:
+  - "on"
+  - when
+  - with
+  - without
+
+RSpec/DescribedClass:
+  Enabled: true
+  EnforcedStyle: explicit
+
+RSpec/Dialect:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: true
+  CountAsOne:
+  - array
+  - hash
+  - heredoc
+  - method_call
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/Pending:
+  Enabled: false

data/config/cops/security.yml

@@ -0,0 +1 @@
+inherit_from: ../defaults/security.yml

data/config/cops/sequel.yml

@@ -0,0 +1,2 @@
+inherit_from: ../defaults/sequel.yml
+

data/config/cops/style.yml

@@ -0,0 +1,153 @@
+inherit_from: ../defaults/style.yml
+
+Style/AccessorGrouping:
+  EnforcedStyle: separated
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/ArrayFirstLast:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowBracesOnProceduralOneLiners: true
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/ConstantVisibility:
+  IgnoreModules: true
+
+Style/Copyright:
+  Enabled: false
+
+Style/DisableCopsWithinSourceCodeDirective:
+  AllowedCops:
+  - Metrics/AbcSize
+  - Metrics/CyclomaticComplexity
+  - Naming/AccessorMethodName
+  - RSpec/ExampleLength
+  - RSpec/InstanceVariable
+  - RSpec/MultipleExpectations
+  - RSpec/RepeatedExampleGroupBody
+  - Style/HashEachMethods
+  - Style/RedandantEach
+  - Style/RedundantFetchBlock
+  - ThreadSafety/NewThread
+
+Style/EndlessMethod:
+  EnforcedStyle: allow_single_line
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/FetchEnvVar:
+  AllowedVars: []
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always_true
+
+Style/HashConversion:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: always
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ImplicitRuntimeError:
+  Enabled: true
+
+Style/InlineComment:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Style/MissingElse:
+  EnforcedStyle: case
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: true
+
+Style/Not:
+  Enabled: false
+
+Style/NumericLiteralPrefix:
+  EnforcedOctalStyle: zero_only
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/NumericPredicate:
+ Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RedundantException:
+  Enabled: false
+
+Style/ReturnNil:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringConcatenation:
+  Mode: conservative
+
+Style/StringHashKeys:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: percent
+
+Style/YodaCondition:
+  EnforcedStyle: forbid_for_equality_operators_only
+
+Style/YodaExpression:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false

data/config/cops/thread_safety.yml

@@ -0,0 +1,5 @@
+inherit_from: ../defaults/thread_safety.yml
+
+ThreadSafety/DirChdir:
+  AllowCallWithBlock: true
+