oxidized 0.29.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f60756df10959016092e920b8d30c1752a54c902c25dd5753f73cf9982dbbe
-  data.tar.gz: 32e8b6918df95cc21e0a7cdcfb2934385f362a70f5035c70a2271390254826d7
+  metadata.gz: 59eeea5dc9024b545f633379b4ab663cf5ea26fe478a4dafffe0e0b80909d2b7
+  data.tar.gz: 26363d11d322e4f797db86050dce16532b8cf2e0e5419de0b92b0dae0b8076df
 SHA512:
-  metadata.gz: 299463a15d5fdbdea8f6e67859eb9c2c9d8ea9c1fe6bf4506a1bc3fb7de9e6ed9f01887e3d999460d67ecfd8eb7994ebd193a0bca33d1cc6fe39e30b8f34293a
-  data.tar.gz: '095c7d26e35534fac3c3c1fe2615eb31e5d6b6302910c66e3d07ba23f698f9b13b8bbab9e70f84f5a627bf560a6e636e7d8dea7a85158f31012c50c845edf0cd'
+  metadata.gz: 3b47b07aaa4528bfa49559ae27785f64da5de07e00305878b840cad7f00068e83c84951350494b37765e0a2499a59881d15979360a8c911702f81531613dd674
+  data.tar.gz: e103734e361736470524ea88f650fa0007a498273c2b54597a0d6fe3d0e768013f2a13f9edea755b72955ce57684614b7a824a745b81c41f0f2fe539b3d13b4d

data/.coderabbit.yaml

@@ -0,0 +1,21 @@
+reviews:
+  auto_review:
+    enabled: false
+    auto_incremental_review: false
+
+  commit_status: false
+  review_status: false
+  high_level_summary: false
+  suggested_labels: false
+  suggested_reviewers: false
+  changed_files_summary: false
+  poem: false
+  sequence_diagrams: false
+  estimate_code_review_effort: false
+  assess_linked_issues: false
+  related_issues: false
+  in_progress_fortune: false
+
+
+chat:
+  auto_reply: false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve oxidized
+title: ''
+labels: bug
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Configure '...'
+2. Use model '....'
+3. Run '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed.
+Always test the latest version of oxidized -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+- Manufacturer model an software version:
+- oxidized model name:
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context  about the feature request here.

data/.github/ISSUE_TEMPLATE/support-request.md

@@ -0,0 +1,39 @@
+---
+name: Support request
+about: Ask for help
+title: ''
+labels: question
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the problem**
+A clear and concise description of what your problem is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed.
+Always test the latest version of oxidized -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+- Manufacturer model an software version:
+- oxidized model name:
+
+**Additional context**
+Add any other context about the problem here.
+

data/.github/workflows/codeql.yml

@@ -40,11 +40,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v6
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v4
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -71,6 +71,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v4
       with:
         category: "/language:${{matrix.language}}"

data/.github/workflows/publishdocker.yml

@@ -2,21 +2,116 @@ name: Publish Docker
 on:
   push:
     branches: [ "master" ]
+    tags: [ "[0-9]+.[0-9]+.[0-9]+" ]
+env:
+  REGISTRY_IMAGE: oxidized/oxidized
+
 jobs:
   build:
     if: github.repository_owner == 'ytti'
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-latest
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+
+    steps:
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v6
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}
+            type=sha,prefix=master-
+          flavor: |
+            latest=true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v7
+        with:
+          platforms: ${{ matrix.platform }}
+          tags: ${{ env.REGISTRY_IMAGE }}
+          labels: |
+            ${{ steps.meta.outputs.labels }}
+            org.opencontainers.image.ref.name=${{ steps.meta.outputs.version }}
+          build-args: |
+            BUILDKIT_CONTEXT_KEEP_GIT_DIR=true
+          outputs: type=image,push-by-digest=true,name-canonical=true,push=true
+
+      - name: Export digest
+        run: |
+          mkdir -p ${{ runner.temp }}/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "${{ runner.temp }}/digests/${digest#sha256:}"
+
+      - name: Upload digest
+        uses: actions/upload-artifact@v7
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: ${{ runner.temp }}/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
     runs-on: ubuntu-latest
+    needs:
+      - build
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 0
-    - name: Get Release Version
-      id: get_version
-      run: echo "release-version=$(git describe --tags)" >> $GITHUB_OUTPUT
-    - name: Publish to Registry
-      uses: elgohr/Publish-Docker-Github-Action@v5
-      with:
-        name: oxidized/oxidized
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-        tags: "latest,${{ steps.get_version.outputs.release-version }}"
+      - name: Download digests
+        uses: actions/download-artifact@v8
+        with:
+          path: ${{ runner.temp }}/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v4
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v6
+        with:
+          images: ${{ env.REGISTRY_IMAGE }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}
+            type=sha,prefix=master-
+          flavor: |
+            latest=true
+
+      - name: Create manifest list and push
+        working-directory: ${{ runner.temp }}/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *)
+
+      - name: Inspect image
+        run: |
+          docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.meta.outputs.version }}

data/.github/workflows/ruby.yml

@@ -19,24 +19,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4', 'ruby-head']
+    continue-on-error: ${{ matrix.ruby-version == 'ruby-head' }}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v6
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: rubocop
-      uses: reviewdog/action-rubocop@v2
-      with:
-        rubocop_version: gemfile
-        rubocop_extensions: rubocop-minitest:gemfile rubocop-rake:gemfile
-        reporter: github-pr-review
     - name: Run tests
       run: bundle exec rake
-    - uses: codecov/codecov-action@v3
-      if: ${{ always() }}

data/.github/workflows/stale.yml

@@ -1,3 +1,4 @@
+---
 name: "Stale Issue/PR cleanup"
 on:
   schedule:
@@ -11,6 +12,10 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v8
+      - uses: actions/stale@v10
         with:
+          stale-issue-message: 'This issue is stale because it has been open 90 days with no activity.'
+          stale-pr-message: 'This PR is stale because it has been open 90 days with no activity.'
           operations-per-run: 500
+          days-before-stale: 90
+          days-before-close: -1

data/.gitignore

@@ -13,6 +13,7 @@
 Gemfile.lock
 .ruby-version
 .sass-cache/
+.vscode/
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -52,3 +53,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/.rake_tasks~

data/.rubocop.yml

@@ -1,12 +1,25 @@
 inherit_from: .rubocop_todo.yml
 
-# Do not attempt to police vendored code
+inherit_mode:
+  merge:
+    - Exclude
+
+plugins:
+  - rubocop-rake
+  - rubocop-minitest
+  - rubocop-sequel
+
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.0
+  # Do not attempt to police vendored code
   Exclude:
     - 'vendor/**/*'
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+# We prefer to use ”” by default and use ’’ to signal that interpolation is
+# intentionally turned off, but we don't enforce it.
 Style/StringLiterals:
   Enabled: false
 
@@ -14,10 +27,19 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 Layout/LineLength:
-  Enabled: false
+  Enabled: true
+  Max: 120
+  # Too much models have long lines, which is unsafe to reduce without
+  # having an existing model unit test.
+  Exclude:
+   - lib/oxidized/model/*.rb
 
+# We do not enforce the cop in the models as it would not work with the
+# DSL style of the models
 Lint/AmbiguousRegexpLiteral:
-  Enabled: false
+  Enabled: true
+  Exclude:
+   - lib/oxidized/model/*.rb
 
 Lint/RaiseException:
   Enabled: true
@@ -33,6 +55,7 @@ Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 
+# Explicitly allow the use of "not"
 Style/Not:
   Enabled: false
 
@@ -40,24 +63,45 @@ Style/Not:
 Style/CommandLiteral:
   EnforcedStyle: percent_x
 
+Style/ConditionalAssignment:
+  Enabled: false
+
 Style/FormatString:
   EnforcedStyle: percent
 
+Style/FileOpen:
+  Exclude:
+   - lib/oxidized/input/*.rb
+
 Style/FormatStringToken:
   EnforcedStyle: unannotated
+  AllowedMethods: ['metadata']
 
 Style/HashEachMethods:
   Enabled: true
 
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+
 Style/HashTransformKeys:
   Enabled: true
 
 Style/HashTransformValues:
   Enabled: true
 
+Style/OneClassPerFile:
+  Exclude:
+   - spec/**/*.rb
+
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  AllowInnerSlashes: true
+
+# Explicitly allow the use of rescue as a Modifier
 Style/RescueModifier:
   Enabled: false
 
+# Intentionally left deactivated as used in the models
 Style/SymbolProc:
   Enabled: false
 
@@ -65,29 +109,41 @@ Style/Documentation:
   Enabled: false
 
 Style/ParallelAssignment:
-  Enabled: false
+  Enabled: true
 
 Metrics/MethodLength:
-  Max: 45
+  Max: 50
 
-## Metrics/AbcSize:
-##   Max: 28
+Metrics/AbcSize:
+  Enabled: false
 
 Metrics/ClassLength:
   Max: 200
 
-## Metrics/CyclomaticComplexity:
-##   Max: 7
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
 
+# The BlockLength metric does not apply to unit tests. They are in nature
+# long and not very pretty
 Metrics/BlockLength:
   Max: 150
+  Exclude:
+   - spec/**/*_spec.rb
 
 Metrics/ParameterLists:
   Max: 6
 
+# Used in the models
 Lint/EmptyBlock:
   Enabled: false
 
-require:
-  - rubocop-rake
-  - rubocop-minitest
+# Disable the cop as string concatenation is widely used in oxidized
+Style/StringConcatenation:
+  Enabled: false
+