easy_style 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c116adcb355436046656f2a169867b2a0db4869838fbbe4141cc90599b0396
-  data.tar.gz: 63750783ce4cf5f0eb67b6e6cfad65e1d4c80a2ab3826b1ccecacd8bacf0974a
+  metadata.gz: e0dd3123aa196dff1db3cf3b9598c3ab481c6f5be7f7c9a947e919a54b1286f1
+  data.tar.gz: 92642e2816cc648141ff825cfe1717109567498bed3a30f81f12c8b5e50afccb
 SHA512:
-  metadata.gz: 86f161cc36d7afd3a2b91f39428ea4338174403051faefc045e8ed614adc09a4b46109fc1885f6996232fff7831d3ab9b60bbf460c692fa2a3cdc315330f7ccf
-  data.tar.gz: 5bbc6dcea342ab72c518c7c231e2863c1f45e0da000500726fac0d79245c98b125ea70eae6e8ff85cb3499ab3a9263a11aa68a588763aeefaeb37d8d6e604a55
+  metadata.gz: 93d225ecc6e8a4bfd748ae66e52469533c0ffd87b19ee084afcce5bf6166a110bfa3e491209b41bec270557ec312e7e00050e7bacc0eac4fe673e0bad32567f4
+  data.tar.gz: cf8d26139911cc4d2f585a396841918751edb3f36dc5e258e75570c277cbda7e0f632119b73aea53afb71ec313beba63039bb5f9877fec30f2d45f7176ba9b0d

data/README.md

@@ -0,0 +1,219 @@
+# EasyStyle
+
+Default RuboCop configuration for Easy.
+
+https://docs.rubocop.org/rubocop/
+
+https://docs.easy8.com
+
+Since February 2026 we decided move close to Omakase style, but still want to keep our individual used rules, so we are using Omakase as base and then add our own rules on top of it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "easy_style", group: %i[development], require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install easy_style
+
+## Usage
+
+In your `.rubocop.yml` file:
+```yaml
+inherit_gem:
+  easy_style: default.yml
+```
+
+Generate "todo" file is recommended:
+```bash
+bundle exec rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000
+```
+
+# GitLab CI/CD Component
+
+This repository provides a reusable GitLab CI/CD component for running RuboCop in your pipelines.
+
+## Component Usage
+
+Include the component in your project's `.gitlab-ci.yml`:
+
+```yaml
+include:
+  - component: git.easy.cz/internal/easy_style/rubocop@v1.0.0
+    inputs:
+      version: "v1.0.0"  # Match with ruby gem tag - specify which docker image of easy_style to use (default: latest)
+```
+
+### Component Inputs
+
+| Input | Type | Default | Description |
+|-------|------|---------|-------------|
+| `job_name` | `string` | `rubocop` | Name of the CI job |
+| `stage` | `string` | `linter` | Pipeline stage where the job runs |
+| `allow_failure` | `boolean` | `false` | Whether to allow the job to fail |
+| `version` | `string` | `latest` | Docker image version (should match git tag: v1.0.0, v1.1.0, etc.) |
+| `changes_paths` | `array` | See below | Array of paths to check for changes |
+
+**Important Notes:**
+- `allow_failure` is typed as `boolean` and works correctly as an entire YAML value
+
+**Default `changes_paths`:**
+```yaml
+- "plugins/**/*.rb"
+- "easy_engines/**/*.rb"
+- "easy_lib/**/*.rb"
+- "easy_plugins/**/*.rb"
+```
+
+### Examples
+
+**Basic usage with specific version:**
+```yaml
+include:
+  - component: git.easy.cz/internal/easy_style/rubocop@v1.0.0
+```
+
+**Custom job name and stage:**
+```yaml
+include:
+  - component: git.easy.cz/internal/easy_style/rubocop@v1.0.0
+    inputs:
+      job_name: code-quality
+      stage: test
+      version: "v1.0.0"
+      allow_failure: true
+```
+
+**Disable changes detection (run on all commits):**
+```yaml
+include:
+  - component: git.easy.cz/internal/easy_style/rubocop@v1.0.0
+    inputs:
+      version: "v1.0.0"
+      changes_paths:
+        - "**/*.rb"
+```
+
+**Custom paths for changes detection:**
+```yaml
+include:
+  - component: git.easy.cz/internal/easy_style/rubocop@v1.0.0
+    inputs:
+      version: "v1.0.0"
+      changes_paths:
+        - "app/**/*.rb"
+        - "lib/**/*.rb"
+```
+
+### How It Works
+
+The component automatically:
+- Uses the RuboCop Docker image from this project's registry (`${CI_REGISTRY}/internal/easy_style`)
+- Creates a temporary `.rubocop_ci.yml` if it doesn't exist (inherits from `.rubocop.yml` and `.rubocop_todo.yml`)
+- By default, runs RuboCop only when files in specified paths change (compared to `master` branch)
+- Runs with shallow clone (GIT_DEPTH=1) for faster checkout
+
+# Docker Image (Legacy Usage)
+
+Rubocop standalone Docker image for CI/CD pipelines linting RoR applications.
+
+Image is inspired by https://gitlab.com/pipeline-components/rubocop/-/blob/main/Dockerfile.
+
+**Note:** We recommend using the GitLab CI/CD component (documented above) instead of directly using the Docker image. The component provides better integration and configuration options.
+
+## Highlights
+
+* Ruby version matches platform ruby version (4.0.1)
+* Multi-stage build for smaller image size
+* Runs as non-root user for security
+* CI automatically builds Docker images only for git tags
+* Docker image version matches gem version 1:1
+
+## Direct Docker Usage
+
+If you need to use the Docker image directly in `.gitlab-ci.yml`:
+```yaml
+rubocop linter:
+  stage: lint
+  image: registry.git.easy.cz/internal/easy_style:v1.0.0  # Or :latest
+  before_script:
+    - "[ ! -f '.rubocop_ci.yml' ] && ((echo 'inherit_from:'; echo '  - .rubocop.yml') > .rubocop_ci.yml;  echo '  - .rubocop_todo.yml' >> .rubocop_ci.yml)"
+  script:
+    - rubocop -c .rubocop_ci.yml
+```
+
+Or use standalone via Docker CLI:
+```bash
+# Using latest version - mounts your code to /code (working directory is /app)
+docker run --rm -v $(pwd):/code -w /code registry.git.easy.cz/internal/easy_style:latest
+
+# Alternative: mount to /app (image's default WORKDIR)
+docker run --rm -v $(pwd):/app registry.git.easy.cz/internal/easy_style:latest
+```
+
+**How config resolution works:**
+1. If your project has `.rubocop.yml`, RuboCop uses it
+2. If not, RuboCop automatically falls back to `~/.rubocop.yml` (the built-in easy_style config)
+3. This means you get easy_style's rules by default, but can override them per-project
+
+## Contributing
+
+### Release Workflow
+
+This project uses a coordinated release workflow where the gem and Docker image are released together:
+
+1. **Develop and Test**
+   - Make changes to RuboCop configuration (`default.yml`) or gem code
+   - Test locally with `bundle exec rubocop`
+   - Commit and push to `master` branch
+
+2. **Release Gem to RubyGems** (Manual with 2FA)
+   ```bash
+   # Update version in easy_style.gemspec if needed
+   gem build easy_style.gemspec
+   gem push easy_style-1.0.0.gem  # Requires 2FA authentication
+   ```
+
+3. **Create Git Tag** (Triggers Docker Build)
+   ```bash
+   # Tag with 'v' prefix matching the gem version
+   git tag v1.0.0
+   git push origin v1.0.0
+   ```
+
+4. **Automated Docker Release**
+   - GitLab CI automatically triggers on tag push (not on regular commits)
+   - Builds Docker image with multi-stage optimization
+   - Tags image as `registry.git.easy.cz/internal/easy_style:v1.0.0`
+   - Also tags as `:latest` for convenience
+   - Creates GitLab release with tag information
+
+### Version Numbering
+
+- Use semantic versioning: `v1.0.0`, `v1.1.0`, `v2.0.0`, etc.
+- **Always include the `v` prefix** in git tags
+- Gem version (in gemspec) and git tag should match (e.g., gem `1.0.0` → tag `v1.0.0`)
+- Docker images are tagged with the full git tag including `v` prefix
+
+### Release Checklist
+
+- [ ] Update `easy_style.gemspec` version if needed
+- [ ] Update `CHANGELOG.md` (if exists)
+- [ ] Test locally: `gem build && gem install easy_style-*.gem`
+- [ ] Push gem to RubyGems with 2FA
+- [ ] Create and push git tag with `v` prefix
+- [ ] Verify Docker build in GitLab CI completes successfully
+- [ ] Test Docker image: `docker pull registry.git.easy.cz/internal/easy_style:v1.0.0`
+- [ ] Verify GitLab component works in a test project
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/default.yml

@@ -25,6 +25,8 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_special
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: keyword
 Layout/LineLength:
   Enabled: false
 
@@ -61,8 +63,6 @@ Naming/BlockForwarding:
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 
-Rails/ApplicationRecord:
-  Enabled: false
 Rails/RedundantPresenceValidationOnBelongsTo:
   Enabled: false
 Rails/SkipsModelValidations:

data/lib/easy_style.rb

@@ -0,0 +1,3 @@
+module EasyStyle
+  # Just stub
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_style
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Easy8
@@ -30,7 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - default.yml
+- lib/easy_style.rb
 homepage: https://git.easy8.com/internal/easy_style
 licenses:
 - MIT