better_translate 0.5.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.env.example +14 -0
- data/.rspec +3 -0
- data/.rubocop.yml +8 -0
- data/.yardopts +10 -0
- data/CHANGELOG.md +125 -114
- data/CLAUDE.md +385 -0
- data/README.md +629 -244
- data/Rakefile +7 -1
- data/Steepfile +29 -0
- data/docs/implementation/00-overview.md +220 -0
- data/docs/implementation/01-setup_dependencies.md +668 -0
- data/docs/implementation/02-error_handling.md +65 -0
- data/docs/implementation/03-core_components.md +457 -0
- data/docs/implementation/03.5-variable_preservation.md +509 -0
- data/docs/implementation/04-provider_architecture.md +571 -0
- data/docs/implementation/05-translation_logic.md +1065 -0
- data/docs/implementation/06-main_module_api.md +122 -0
- data/docs/implementation/07-direct_translation_helpers.md +582 -0
- data/docs/implementation/08-rails_integration.md +323 -0
- data/docs/implementation/09-testing_suite.md +228 -0
- data/docs/implementation/10-documentation_examples.md +150 -0
- data/docs/implementation/11-quality_security.md +65 -0
- data/docs/implementation/12-cli_standalone.md +698 -0
- data/exe/better_translate +9 -0
- data/lib/better_translate/cache.rb +125 -0
- data/lib/better_translate/cli.rb +304 -0
- data/lib/better_translate/configuration.rb +201 -0
- data/lib/better_translate/direct_translator.rb +131 -0
- data/lib/better_translate/errors.rb +101 -0
- data/lib/better_translate/progress_tracker.rb +157 -0
- data/lib/better_translate/provider_factory.rb +45 -0
- data/lib/better_translate/providers/anthropic_provider.rb +154 -0
- data/lib/better_translate/providers/base_http_provider.rb +239 -0
- data/lib/better_translate/providers/chatgpt_provider.rb +138 -44
- data/lib/better_translate/providers/gemini_provider.rb +123 -61
- data/lib/better_translate/railtie.rb +18 -0
- data/lib/better_translate/rate_limiter.rb +90 -0
- data/lib/better_translate/strategies/base_strategy.rb +58 -0
- data/lib/better_translate/strategies/batch_strategy.rb +56 -0
- data/lib/better_translate/strategies/deep_strategy.rb +45 -0
- data/lib/better_translate/strategies/strategy_selector.rb +43 -0
- data/lib/better_translate/translator.rb +115 -284
- data/lib/better_translate/utils/hash_flattener.rb +104 -0
- data/lib/better_translate/validator.rb +105 -0
- data/lib/better_translate/variable_extractor.rb +259 -0
- data/lib/better_translate/version.rb +2 -9
- data/lib/better_translate/yaml_handler.rb +168 -0
- data/lib/better_translate.rb +97 -73
- data/lib/generators/better_translate/analyze/USAGE +12 -0
- data/lib/generators/better_translate/analyze/analyze_generator.rb +94 -0
- data/lib/generators/better_translate/install/USAGE +13 -0
- data/lib/generators/better_translate/install/install_generator.rb +71 -0
- data/lib/generators/better_translate/install/templates/README +20 -0
- data/lib/generators/better_translate/install/templates/initializer.rb.tt +47 -0
- data/lib/generators/better_translate/translate/USAGE +13 -0
- data/lib/generators/better_translate/translate/translate_generator.rb +114 -0
- data/lib/tasks/better_translate.rake +136 -0
- data/sig/better_translate/cache.rbs +28 -0
- data/sig/better_translate/cli.rbs +24 -0
- data/sig/better_translate/configuration.rbs +78 -0
- data/sig/better_translate/direct_translator.rbs +18 -0
- data/sig/better_translate/errors.rbs +46 -0
- data/sig/better_translate/progress_tracker.rbs +29 -0
- data/sig/better_translate/provider_factory.rbs +8 -0
- data/sig/better_translate/providers/anthropic_provider.rbs +27 -0
- data/sig/better_translate/providers/base_http_provider.rbs +44 -0
- data/sig/better_translate/providers/chatgpt_provider.rbs +25 -0
- data/sig/better_translate/providers/gemini_provider.rbs +22 -0
- data/sig/better_translate/railtie.rbs +7 -0
- data/sig/better_translate/rate_limiter.rbs +20 -0
- data/sig/better_translate/strategies/base_strategy.rbs +19 -0
- data/sig/better_translate/strategies/batch_strategy.rbs +13 -0
- data/sig/better_translate/strategies/deep_strategy.rbs +11 -0
- data/sig/better_translate/strategies/strategy_selector.rbs +10 -0
- data/sig/better_translate/translator.rbs +24 -0
- data/sig/better_translate/utils/hash_flattener.rbs +14 -0
- data/sig/better_translate/validator.rbs +14 -0
- data/sig/better_translate/variable_extractor.rbs +40 -0
- data/sig/better_translate/version.rbs +4 -0
- data/sig/better_translate/yaml_handler.rbs +29 -0
- data/sig/better_translate.rbs +32 -2
- data/sig/faraday.rbs +22 -0
- data/sig/generators/better_translate/analyze/analyze_generator.rbs +18 -0
- data/sig/generators/better_translate/install/install_generator.rbs +14 -0
- data/sig/generators/better_translate/translate/translate_generator.rbs +10 -0
- data/sig/optparse.rbs +9 -0
- data/sig/psych.rbs +5 -0
- data/sig/rails.rbs +34 -0
- metadata +89 -203
- data/lib/better_translate/helper.rb +0 -83
- data/lib/better_translate/providers/base_provider.rb +0 -102
- data/lib/better_translate/service.rb +0 -144
- data/lib/better_translate/similarity_analyzer.rb +0 -218
- data/lib/better_translate/utils.rb +0 -55
- data/lib/better_translate/writer.rb +0 -75
- data/lib/generators/better_translate/analyze_generator.rb +0 -57
- data/lib/generators/better_translate/install_generator.rb +0 -14
- data/lib/generators/better_translate/templates/better_translate.rb +0 -56
- data/lib/generators/better_translate/translate_generator.rb +0 -84
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# 11 - Quality & Security
|
|
2
|
+
|
|
3
|
+
[← Previous: 10-Documentation Examples](./10-documentation_examples.md) | [Back to Index](../../IMPLEMENTATION_PLAN.md) | [Next: Implementation Plan →](../../IMPLEMENTATION_PLAN.md)
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Quality & Security
|
|
8
|
+
|
|
9
|
+
### 10.1 Checklist Finale
|
|
10
|
+
|
|
11
|
+
Prima del rilascio, verificare:
|
|
12
|
+
|
|
13
|
+
**RuboCop:**
|
|
14
|
+
```bash
|
|
15
|
+
bundle exec rubocop
|
|
16
|
+
bundle exec rubocop -a # Auto-fix violations
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**Tests:**
|
|
20
|
+
```bash
|
|
21
|
+
bundle exec rspec
|
|
22
|
+
# Target: 100% code coverage for core components
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Documentation:**
|
|
26
|
+
```bash
|
|
27
|
+
bundle exec yard doc
|
|
28
|
+
bundle exec yard stats
|
|
29
|
+
# Target: 100% documentation coverage
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Security:**
|
|
33
|
+
```bash
|
|
34
|
+
bundle exec bundler-audit check --update
|
|
35
|
+
# No known vulnerabilities
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Manual Checks:**
|
|
39
|
+
- [ ] All API keys read from environment variables
|
|
40
|
+
- [ ] No hardcoded secrets in code
|
|
41
|
+
- [ ] Error messages don't leak sensitive information
|
|
42
|
+
- [ ] Input validation present for all user inputs
|
|
43
|
+
- [ ] YARD docs complete for all public APIs
|
|
44
|
+
- [ ] README updated with current features
|
|
45
|
+
- [ ] CHANGELOG updated
|
|
46
|
+
- [ ] Examples working and tested
|
|
47
|
+
- [ ] Rails generators tested in a real Rails app
|
|
48
|
+
- [ ] VCR cassettes recorded for all providers
|
|
49
|
+
- [ ] All providers tested (ChatGPT, Gemini, Anthropic)
|
|
50
|
+
|
|
51
|
+
### 10.2 CI/CD Setup (`.github/workflows/main.yml`)
|
|
52
|
+
|
|
53
|
+
Il file già esiste ma dovrebbe essere aggiornato per includere:
|
|
54
|
+
- Ruby version matrix (3.0, 3.1, 3.2, 3.3)
|
|
55
|
+
- RSpec tests
|
|
56
|
+
- RuboCop linting
|
|
57
|
+
- Bundler Audit security checks
|
|
58
|
+
- YARD documentation generation
|
|
59
|
+
- Code coverage reporting
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
[← Previous: 10-Documentation Examples](./10-documentation_examples.md) | [Back to Index](../../IMPLEMENTATION_PLAN.md) | [Next: Implementation Plan →](../../IMPLEMENTATION_PLAN.md)
|