glib-web 5.0.9 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66abe13aca7ef703ab65bcbaeded784ff74339b4dcfd3659658bdefc99f0ec30
-  data.tar.gz: a8c90ab7a9684a4eeed86c8d6e25d3676281157c856ed07cd582b5ccdebfa622
+  metadata.gz: 783a7ad2cc1fcb744c02e91df3185c7d455c6bef84d56fc0eff2503f3a39f826
+  data.tar.gz: 960797098836ddd26a310b592f953f46284f986bde09f42deae1b889a5a85cd1
 SHA512:
-  metadata.gz: ef265df7cd0d8f0e3d951f384b574cf01e6c4039f774e0df286fb0617ce58be80551cb5e1ccbf05996af4b9127aaa8cfdccbac7f146d22b0816acc6690400814
-  data.tar.gz: e5ba874af4579d1310671a292404a2cb27b8ff89b609ff2a2c0f0ff3609a301a8566d8e3a86099d4a41c9ca6249a19cd00ce78a4cef30c8642e85efed260f07a
+  metadata.gz: e5a23a583b69403fd8a65db92b658fb2aab0b7ca6e2946ba4da0e39d194504b2ed9694c638167d68828b92c97d7c3851746eb189be75576ec777201e8ad570a1
+  data.tar.gz: 43ac55043ae8321c33aa4c662b5f4833be211cf0d95f6cc9f8ad5b16f4b7685a4a475e5e0c77d3c01c99292f1401577a8b600f2e863055274582c1a5d0997bfb

data/app/models/concerns/glib/enum_symbolization.rb

@@ -1,26 +1,80 @@
 module Glib
-  # Class-level helper that overrides one or more enum readers to return a
-  # symbol instead of Rails' default string form. Lets callers compare with
-  # `record.status == :active` without having to remember which form they're
-  # holding (see backend/01a_defensive_programming.md item 7).
+  # Class-level helper for declaring enums that read back as symbols, can never
+  # be persisted nil, and — crucially — know their attribute type even before
+  # the backing column exists.
   #
-  # Usage:
+  # Preferred form (declares everything in one call; use INSTEAD of a bare
+  # `enum`). Because it calls `attribute` before `enum`, the enum's type comes
+  # from the declared values rather than from column introspection, so a model
+  # loaded against a not-yet-migrated column (fresh deploy, eager-loaded CI, an
+  # un-migrated local DB) no longer raises "Undeclared attribute type for enum":
   #
   #   class Order < ApplicationRecord
-  #     enum :payment_status, { draft: 0, pending: 1, finalized: 2 }
-  #     enum :finalize_intent, { unknown: 0, charge: 1 }, prefix: true
+  #     include Glib::EnumSymbolization
   #
-  #     enum_symbolize :payment_status, :finalize_intent
+  #     enum_symbolize :payment_status, { draft: 0, pending: 1, finalized: 2 }
+  #     enum_symbolize :finalize_intent, { unknown: 0, charge: 1 }, prefix: true
   #   end
+  #
+  # The attribute type is inferred from the values: string values back a
+  # :string column, everything else (integer-keyed hashes, positional arrays)
+  # backs an :integer column. Pass the values as a *braced* hash — a bare
+  # `key: 0` list is parsed as keyword options, not values.
+  #
+  # Legacy form (attach presence + symbolized reader to enum(s) already declared
+  # above). Prefer the form above for new code:
+  #
+  #   enum :status, { draft: 0, published: 1 }
+  #   enum_symbolize :status
+  #
+  # Both forms add `validates :attr, presence: true` (a nil enum has no symbolic
+  # key and is almost always a bug) and override the reader to return a symbol,
+  # so callers can compare with `record.status == :active` without tracking
+  # which form they're holding (see backend/01a_defensive_programming.md item 7).
   module EnumSymbolization
     extend ActiveSupport::Concern
 
     class_methods do
-      def enum_symbolize(*attrs)
-        attrs.each do |attr|
-          define_method(attr) { super()&.to_sym }
+      def enum_symbolize(*attrs, **opts)
+        if attrs.size >= 2 && (attrs[1].is_a?(Hash) || attrs[1].is_a?(Array))
+          # Full form: enum_symbolize :name, { ... }[, **enum_opts]
+          name, values = attrs
+          # MUST precede `enum`, and is NOT redundant: `enum` resolves its type
+          # by introspecting the DB column, which raises "Undeclared attribute
+          # type for enum" (RuntimeError) when the column isn't there yet — a
+          # not-yet-migrated column loaded on deploy, eager-loaded CI, or an
+          # un-migrated local DB. Declaring the attribute first pins the type
+          # from the enum's own values, so it no longer needs the column. Do not
+          # remove or move below `enum`.
+          attribute name, Glib::EnumSymbolization.backing_type(values)
+          enum name, values, **opts
+          glib_symbolize_reader(name)
+        else
+          # Legacy form: enum_symbolize :a[, :b, ...] for enums already declared.
+          if opts.any?
+            raise ArgumentError,
+              "enum_symbolize: pass enum values as a braced hash, " \
+              "e.g. enum_symbolize :#{attrs.first}, { ... }"
+          end
+          attrs.each { |attr| glib_symbolize_reader(attr) }
         end
       end
+
+      private
+
+        def glib_symbolize_reader(attr)
+          validates attr, presence: true
+          define_method(attr) { super()&.to_sym }
+        end
+    end
+
+    # Infer the attribute type backing an enum from its declared values, so the
+    # type never depends on the (possibly not-yet-migrated) DB column. A hash
+    # whose values are strings backs a :string column; integer-keyed hashes and
+    # positional arrays back an :integer column.
+    def self.backing_type(values)
+      first = values.is_a?(Hash) ? values.values.first : nil
+      first.is_a?(String) ? :string : :integer
     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,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 5.0.9
+  version: 5.1.1
 platform: ruby
 authors:
 - ''
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-10-04 00:00:00.000000000 Z
@@ -149,6 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description:
 email: ''
 executables: []
 extensions: []
@@ -511,7 +513,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
@@ -520,15 +524,17 @@ 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: []
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -543,7 +549,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []

data/lib/glib/version.rb

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