glib-web 5.1.0 → 5.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af6a7a8e8f3cd4b9a45446e58347ff9ecc2130d1ce4f715da68ead1c7646ab5
-  data.tar.gz: 3239c38d6b96f609eb961d5e427121bee47804430475bc0fe0be66a599dcf9ee
+  metadata.gz: 8e7848fb02064447620d8fca19a5f94b27c135b5e6c40dcd3c16974d19bb84e7
+  data.tar.gz: e187535507305543f7c5c9a5734393d60c89fd1167bf488489963b304dd92f44
 SHA512:
-  metadata.gz: 138e70c7c76dcb59f24715c31b6e322cd0bb8d3ee74ac4905f7e0d0ae7d206fc46481c5b47a76d970fc08a1f6a78aa17cb368ac43a79fe98c2251f29e1add74d
-  data.tar.gz: 8f92b011d2a6e1ee72547fcb8cba257accd972b2ff055eb88692c4701cdeabea00bf33bc4e0318e3cc9416078e587c1322911457c0f553ffde27f612bceb77c5
+  metadata.gz: 555954cb635653ad23d9af3da7810db47bf87b4ad6807d029a5294fcb1212eee02cefa64f96a97e819c11d1a5ed3134855329e722e18207df20c0f0153011e8e
+  data.tar.gz: fde96a7c67e9f8e718d0cb7c8de72dd882e49607965891040fadf6c5b71e20be4ef2f3f69cb810662d585434ad1e650174569c0ddc87959c601fd10cdeadb189

data/app/controllers/concerns/glib/params/allowlist.rb

@@ -0,0 +1,23 @@
+module Glib::Params
+  module Allowlist
+    extend ActiveSupport::Concern
+
+    # Resolve a stringly-typed request param (or any boundary string) to one
+    # symbol drawn from a closed allow-list (+allowed_symbols+), returning
+    # +default+ when the value is missing, blank, or not recognised.
+    #
+    # This is the symbol-DoS-safe replacement for `params[:x].to_sym`. A bare
+    # `.to_sym` on a raw value mints a symbol for every distinct string a client
+    # sends, including values you intend to reject on the next line, the classic
+    # symbol-DoS vector. This only ever returns a symbol already present in
+    # +allowed_symbols+ (or +default+), so attacker input can never create a new
+    # symbol regardless of what is sent.
+    #
+    # nil / "" fall through to +default+ implicitly (no symbol's string form is
+    # blank). Use it for any closed-vocabulary boundary input: interval
+    # selectors, status filters, UTM tags, feature-flag names.
+    def glib_allowlist_symbol_param(value, allowed_symbols, default:)
+      allowed_symbols.find { |symbol| symbol.to_s == value.to_s } || default
+    end
+  end
+end

data/lib/glib/last_resort_unit_test.rb

@@ -0,0 +1,28 @@
+module Glib
+  # The truthful base class for the rare, justified unit tests (see dev-doc's
+  # AvoidUnitTest / RequireUnitTestJustification). Every other test should be a
+  # controller test on Glib::IntegrationTest.
+  #
+  # The name is the policy: you may only be here after exhausting the
+  # controller-test route. Assume a controller test IS possible and look
+  # harder first — that conclusion is almost always premature (AvoidUnitTest's
+  # docs list the patterns that make "unit-only" behaviour reachable
+  # end-to-end). Subclassing this base is a confession, not a credential: it
+  # must sit in a unit-test directory under a justification header, both
+  # enforced by RequireUnitTestJustification.
+  #
+  # Deliberately NOT a descendant of ActionDispatch::IntegrationTest:
+  #
+  # - The declaration line states the test type honestly. A unit test
+  #   subclassing an "IntegrationTest" base is a lie that also defeats
+  #   base-class-keyed tooling.
+  # - HTTP verb helpers (`get`/`post`/...) don't exist here, so a unit test
+  #   structurally cannot drift into half-integration territory — the inverse
+  #   of the guarantee DevDoc::Test::Lints::HttpDrivenControllerTests provides
+  #   for test/controllers/.
+  #
+  # Project-wide helpers attached to ActiveSupport::TestCase (fixtures,
+  # glib_travel, coverage) are inherited as usual.
+  class LastResortUnitTest < ActiveSupport::TestCase
+  end
+end

data/lib/glib/non_http_integration_test.rb

@@ -0,0 +1,27 @@
+require 'active_job/test_helper'
+
+module Glib
+  # The truthful base for full-stack side-effect tests (jobs, mailers,
+  # channels): real DB, fixtures, deliveries and enqueued-job execution — but
+  # no HTTP verbs. Use it when the contract under test is a side effect (a
+  # job's record mutations, a mailer's body and links) rather than an HTTP
+  # response; tests that DO assert responses belong on Glib::IntegrationTest.
+  #
+  # Deliberately NOT a descendant of ActionDispatch::IntegrationTest, for the
+  # same reasons as Glib::LastResortUnitTest: the declaration line states the
+  # test type honestly, and the HTTP verb helpers are structurally absent, so
+  # a side-effect test cannot silently drift into half-integration territory.
+  # Unlike LastResortUnitTest this base is not a confession — jobs and mailers
+  # genuinely have no HTTP surface of their own — but it is confined all the
+  # same: DevDoc/Test/RequireUnitTestJustification only permits it inside the
+  # side-effect directories (test/jobs/, test/mailers/, test/channels/),
+  # because anywhere else it would evade that directory's enforcement.
+  #
+  # Project-wide helpers attached to ActiveSupport::TestCase (fixtures,
+  # glib_travel, coverage) are inherited as usual; ActiveJob::TestHelper is
+  # included here because running the very jobs under test
+  # (perform_enqueued_jobs) is this tier's bread and butter.
+  class NonHttpIntegrationTest < ActiveSupport::TestCase
+    include ActiveJob::TestHelper
+  end
+end

data/lib/glib/test/changed_files_rubocop.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'shellwords'
+
+module Glib
+  module Test
+    # Fast RuboCop guard for the subset-run workflow.
+    #
+    # Lives in glib-web's test helper so any project that includes
+    # `Glib::TestHelpers` into `ActiveSupport::TestCase` picks it up. Minitest
+    # runs all loaded test classes on every invocation, so this fires on every
+    # `rails test` — but it lints ONLY the files you have changed in the
+    # working tree (unstaged + staged + untracked). That keeps it fast and
+    # fails the run the moment an edited file has an offense.
+    #
+    # Skip with `SKIP_CHANGED_RUBOCOP=1` during tight debug loops. Auto-skips
+    # on CI because gem caches put thousands of vendored `.rb` files into the
+    # working tree (the "working-tree diff == your edits" premise breaks).
+    class ChangedFilesRubocop < ::ActiveSupport::TestCase
+      # Extensions RuboCop targets by default (see its AllCops/Include). We
+      # rely on `--force-exclusion` to honour the project's AllCops/Exclude.
+      RUBOCOP_EXTENSIONS = %w[.rb .rake .jbuilder .gemspec].freeze
+
+      def test_changed_files_are_rubocop_clean
+        skip 'opted out via SKIP_CHANGED_RUBOCOP' if ENV['SKIP_CHANGED_RUBOCOP'] == '1'
+        skip 'CI lints every file separately; this guard is for local working-tree edits' if ENV['CI']
+
+        files = changed_ruby_files
+        # IMPORTANT: never call rubocop with zero paths — it would lint the whole repo.
+        skip 'no changed Ruby files in the working tree' if files.empty?
+
+        output = `bundle exec rubocop --force-exclusion --format simple #{files.shelljoin} 2>&1`
+
+        assert(
+          $CHILD_STATUS.success?,
+          'RuboCop offenses in files you changed (fix them with `rubocop -a`):' \
+          "\n\n#{output}"
+        )
+      end
+
+      private
+        def changed_ruby_files
+          # `git status --porcelain` covers unstaged, staged, and untracked in
+          # one spawn. Each line is `XY PATH` (or `XY ORIG -> PATH` for
+          # renames); PATH starts at index 3. Deleted files are dropped by the
+          # File.file? check below (no on-disk entry to lint).
+          `git status --porcelain`
+            .split("\n")
+            .filter_map { |line| line[3..]&.split(' -> ')&.last }
+            .select { |path| RUBOCOP_EXTENSIONS.include?(File.extname(path)) && File.file?(path) }
+        end
+    end
+  end
+end

data/lib/glib/test_helpers.rb

@@ -4,6 +4,12 @@ module Glib
 
     included do
       extend ClassMethods
+
+      # Auto-load ChangedFilesRubocop only when this module is mixed into a
+      # test class. AllHelpers also includes Glib::TestHelpers into view
+      # helper modules in production controllers; in that context
+      # ActiveSupport::TestCase is not loaded, so we skip the require.
+      require 'glib/test/changed_files_rubocop' if defined?(::ActiveSupport::TestCase)
     end
 
     module ClassMethods
@@ -33,7 +39,17 @@ module Glib
     def response_assert_equal
       expected = __get_previous_result_from_git
       result = __log_controller_data(response.body)
-      assert_equal JSON.parse(expected), JSON.parse(result), "Result mismatch! #{__git_is_available? ? `git diff #{__controller_log_dir}/#{__controller_log_file}` : ''}"
+      # The message is a proc so the `git diff` subprocess only runs on FAILURE
+      # (a positional string message is built eagerly — one shell-out per
+      # passing assertion, and needless git-index contention under parallel
+      # workers). The path must be QUOTED: log filenames derive from test
+      # names, and an unquoted name containing `->` makes the shell treat `>`
+      # as a redirection, creating stray empty files in the app root.
+      failure_message = proc do
+        diff = __git_is_available? ? `git diff "#{File.join(__controller_log_dir, __controller_log_file)}"` : ''
+        "Result mismatch! #{diff}"
+      end
+      assert_equal JSON.parse(expected), JSON.parse(result), failure_message
     end
 
     def crawl_json_pages(user, log_file: nil, dump_actions: false, dump_path: nil, skip_similar_page: false, &block)

data/lib/glib-web.rb

@@ -1,4 +1,3 @@
-require 'glib/version'
 if defined?(::Rails)
   require 'glib/engine'
   require 'glib/snapshot'
@@ -10,6 +9,8 @@ require 'glib/dynamic_text'
 require 'glib/test_helpers'
 require 'glib/test/parallel_coverage'
 require 'glib/integration_test'
+require 'glib/last_resort_unit_test'
+require 'glib/non_http_integration_test'
 
 require 'glib/time_freezable_mailer'
 require 'glib/time_returning_mailer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.2
 platform: ruby
 authors:
 - ''
@@ -170,6 +170,7 @@ files:
 - app/controllers/concerns/glib/json/traversal.rb
 - app/controllers/concerns/glib/json/ui.rb
 - app/controllers/concerns/glib/json/validation.rb
+- app/controllers/concerns/glib/params/allowlist.rb
 - app/controllers/glib/blob_url_generators_controller.rb
 - app/controllers/glib/errors_controller.rb
 - app/controllers/glib/glib_direct_uploads_controller.rb
@@ -513,7 +514,9 @@ files:
 - lib/glib/json_crawler/coverage.rb
 - lib/glib/json_crawler/http.rb
 - lib/glib/json_crawler/router.rb
+- lib/glib/last_resort_unit_test.rb
 - lib/glib/mailer_tester.rb
+- lib/glib/non_http_integration_test.rb
 - lib/glib/rubocop.rb
 - lib/glib/rubocop/cops/json_ui/base_nested_parameter.rb
 - lib/glib/rubocop/cops/json_ui/nested_action_parameter.rb
@@ -522,12 +525,12 @@ files:
 - lib/glib/rubocop/cops/multiline_method_call_style.rb
 - lib/glib/rubocop/cops/test_name_parentheses.rb
 - lib/glib/snapshot.rb
+- lib/glib/test/changed_files_rubocop.rb
 - lib/glib/test/parallel_coverage.rb
 - lib/glib/test_helpers.rb
 - lib/glib/time_freezable_mailer.rb
 - lib/glib/time_returning_mailer.rb
 - lib/glib/value.rb
-- lib/glib/version.rb
 - lib/tasks/db.rake
 homepage:
 licenses: []

data/lib/glib/version.rb

@@ -1,5 +0,0 @@
-module Glib
-  module Web
-    VERSION = '0.0.1'
-  end
-end