Merge pull request #9 from steeple-org/report-unspecified-columns

feat: Add ignored columns reporting

Author: morganjezequel

.github/workflows/ci.yml

@@ -21,10 +21,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ['2.7', '3.0', '3.1', '3.2']
+        ruby: ['3.2', '3.3']
         include:
           - os: ubuntu-latest
-            ruby: '3.2'
+            ruby: '3.3'
             coverage: true
     runs-on: ${{ matrix.os }}
     steps:
@@ -41,7 +41,7 @@ jobs:
           COVERAGE: ${{ matrix.coverage }}
       - name: Generate coverage artifact
         if: ${{ matrix.coverage }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: docs-coverage
           path: docs/coverage
@@ -50,7 +50,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -59,7 +59,7 @@ jobs:
       - name: Generate Ruby API documentation
         run : bundle exec yard doc
       - name: Generate Ruby API documentation artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: docs-ruby
           path: docs/ruby
@@ -80,12 +80,12 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Fetch Ruby API documentation artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: docs-ruby
           path: docs/ruby
       - name: Fetch coverage artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: docs-coverage
           path: docs/coverage

.rubocop.yml

@@ -6,7 +6,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - bin/rspec

Gemfile.lock

@@ -12,15 +12,17 @@ GEM
     docile (1.4.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    nokogiri (1.15.4-x86_64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.4-x86_64-linux)
+    nokogiri (1.18.8-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     regexp_parser (2.8.1)
     rexml (3.2.6)
@@ -77,6 +79,8 @@ GEM
     yard (0.9.34)
 
 PLATFORMS
+  arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin
   x86_64-linux
 

lib/sheetah/attribute.rb

@@ -31,12 +31,12 @@ def each_column(config)
         header, header_pattern = config.header(key, index)
 
         yield Column.new(
-          key: key,
+          key:,
           type: compiled_type,
-          index: index,
-          header: header,
-          header_pattern: header_pattern,
-          required: required
+          index:,
+          header:,
+          header_pattern:,
+          required:
         )
       end
     end

lib/sheetah/backends.rb

@@ -13,14 +13,14 @@ module Backends
     class << self
       attr_reader :registry
 
-      def open(*args, **opts, &block)
-        backend = opts.delete(:backend) || registry.get(*args, **opts)
+      def open(*, **opts, &)
+        backend = opts.delete(:backend) || registry.get(*, **opts)
 
         if backend.nil?
           return Utils::MonadicResult::Failure.new(SimpleError.new("no_applicable_backend"))
         end
 
-        backend.open(*args, **opts, &block)
+        backend.open(*, **opts, &)
       end
     end
   end

lib/sheetah/backends/csv.rb

@@ -59,7 +59,7 @@ def each_header
         @headers.each_with_index do |header, col_idx|
           col = Sheet.int2col(col_idx + 1)
 
-          yield Header.new(col: col, value: header)
+          yield Header.new(col:, value: header)
         end
 
         self
@@ -72,10 +72,10 @@ def each_row
           value = Array.new(@cols_count) do |col_idx|
             col = Sheet.int2col(col_idx + 1)
 
-            Cell.new(row: row, col: col, value: raw[col_idx])
+            Cell.new(row:, col:, value: raw[col_idx])
           end
 
-          yield Row.new(row: row, value: value)
+          yield Row.new(row:, value:)
         end
 
         self

lib/sheetah/backends/wrapper.rb

@@ -40,10 +40,10 @@ def each_row
           raw = @table[row]
 
           value = Array.new(@cols_count) do |col_idx|
-            Cell.new(row: row, col: Sheet.int2col(col_idx + 1), value: raw[col_idx])
+            Cell.new(row:, col: Sheet.int2col(col_idx + 1), value: raw[col_idx])
           end
 
-          yield Row.new(row: row, value: value)
+          yield Row.new(row:, value:)
         end
 
         self

lib/sheetah/backends/xlsx.rb

@@ -41,7 +41,7 @@ def each_header
         @headers.each_with_index do |header, col_idx|
           col = Sheet.int2col(col_idx + 1)
 
-          yield Header.new(col: col, value: header)
+          yield Header.new(col:, value: header)
         end
 
         self
@@ -63,10 +63,10 @@ def each_row
           value = Array.new(@cols_count) do |col_idx|
             col = Sheet.int2col(col_idx + 1)
 
-            Cell.new(row: row, col: col, value: raw[col_idx])
+            Cell.new(row:, col:, value: raw[col_idx])
           end
 
-          yield Row.new(row: row, value: value)
+          yield Row.new(row:, value:)
         end
 
         self

lib/sheetah/headers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 module Sheetah
   class Headers
     include Utils::MonadicResult
@@ -72,6 +70,8 @@ def add_ensure_column_is_specified(header, column)
         @messenger.error("invalid_header", header.value)
       end
 
+      @messenger.warn("ignored_column", header.value) if @specification.report_ignored_columns?
+
       false
     end
 

lib/sheetah/messaging.rb

@@ -107,7 +107,7 @@ def scoping(...)
         dup.scoping!(...)
       end
 
-      def scope_row!(row, &block)
+      def scope_row!(row, &)
         scope = case @scope
                 when SCOPES::COL, SCOPES::CELL
                   SCOPES::CELL
@@ -118,10 +118,10 @@ def scope_row!(row, &block)
         scope_data = @scope_data.dup || {}
         scope_data[:row] = row
 
-        scoping!(scope, scope_data, &block)
+        scoping!(scope, scope_data, &)
       end
 
-      def scope_col!(col, &block)
+      def scope_col!(col, &)
         scope = case @scope
                 when SCOPES::ROW, SCOPES::CELL
                   SCOPES::CELL
@@ -132,7 +132,7 @@ def scope_col!(col, &block)
         scope_data = @scope_data.dup || {}
         scope_data[:col] = col
 
-        scoping!(scope, scope_data, &block)
+        scoping!(scope, scope_data, &)
       end
 
       def scope_row(...)
@@ -159,11 +159,11 @@ def exception(error)
 
       def add(severity, code, data)
         messages << Message.new(
-          code: code,
+          code:,
           code_data: data,
           scope: @scope,
           scope_data: @scope_data,
-          severity: severity
+          severity:
         )
 
         self