hecks 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1a1eacc3bae3f940928e23269c95e0306f291ec5a2b6d62268e254f12f1902e
-  data.tar.gz: e4168d9e617dbad8912a65dbe10be8a3a32a6a08b18fd84542a05fa9803aeaef
+  metadata.gz: 52208049da300a9004b163c5e48cfe5587711ad45a3cb4d17a5bd1aa4eca8567
+  data.tar.gz: 1788cde0c4a89814395a4be9b3396cc8b5fd823aa408da88534aae617afbd0f1
 SHA512:
-  metadata.gz: a49c8992b247138d92232d00123dd73986be81040bb1356fc912f97905644bbb35a38af431a1d81475b9ce07c644ab8c2aab3370c3fabaf685c0f8a93a16bd70
-  data.tar.gz: 48ccea615a818989da2a01babb5c9d344a5a7c94fbe2eea47301a1437f29aa671134011a626f317c128bcaf1aaa912a21f056e30c8b133643123df129aa7a470
+  metadata.gz: 5ad958aea6cbf148bf0164808eae59179ec03743f1591f193f85e196c9aa7c5a25376d9857ad3d42d57303c7af721811cddf11f776c88f48914f46c4522edc87
+  data.tar.gz: d1148d6aa2ced591c069816c3f17047d08d0aa902e03340dbd4b7c35c20be8eb0907bda11f00c746fdc8955ae0a9225aafe43e3b92715efb42df0f0d73c3b0a8

data/examples/pizzas/bluebook/pizzas.bluebook

@@ -14,7 +14,7 @@ Hecks.bluebook "Pizzas" do
     identified_by :name
 
     value_object "PizzaName" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a pizza is named") { !value.to_s.empty? }
     end
@@ -26,13 +26,13 @@ Hecks.bluebook "Pizzas" do
     end
 
     value_object "CustomerName" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a customer is named") { !value.to_s.empty? }
     end
 
     value_object "ToppingName" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a topping is named") { !value.to_s.empty? }
       # The pattern lets a form feed through; `.strip` is what sees past it.
@@ -46,7 +46,7 @@ Hecks.bluebook "Pizzas" do
     end
 
     value_object "Topping" do
-      attribute :name,   String, pattern: '[^ \t\n\r]'
+      attribute :name,   String, matches: :present
       attribute :amount, Integer
     end
 

data/lib/hecks/bluebook/dsl/attribute_collector.rb

@@ -17,7 +17,7 @@ module Hecks
         private_constant :UNSET
 
         ATTRIBUTE_FIELD_OPTIONS = %i[default optional pattern admits].freeze
-        ATTRIBUTE_OPTIONS = [*ATTRIBUTE_FIELD_OPTIONS, :one_of].freeze
+        ATTRIBUTE_OPTIONS = [*ATTRIBUTE_FIELD_OPTIONS, :one_of, :matches].freeze
         private_constant :ATTRIBUTE_FIELD_OPTIONS, :ATTRIBUTE_OPTIONS
 
         # Returns the attributes declared so far, minting the accumulating list on first use.
@@ -34,12 +34,12 @@ module Hecks
         # Declares one field on the owning construct; the type is a bare constant (ADR 0025).
         #
         #   attribute :op, String, admits: "Vocabulary::QueryComparator"
-        # `admits:` names an already-declared closed set as qualified text, checked on read.
-        # `one_of:` declares an inline closed set, meaningful only inside a `value_object`.
+        # `admits:` names a declared closed set as qualified text. `one_of:` declares an inline one.
         #
         # @param name [Symbol] the field's name
         # @param type [Module, ListOf, OneOf] a bare constant or a wrapper
-        # @param options [Hash] `default:`, `optional:`, `pattern:`, `admits:` or `one_of:`
+        # @param options [Hash] `default:`, `optional:`, `pattern:`, `matches:` (a `NamedPattern`),
+        #   `admits:` or `one_of:`
         # @return [void]
         # @raise [Malformed] on a duplicate name, a missing or quoted type, a disallowed pattern
         # @raise [ArgumentError] on any other keyword
@@ -86,7 +86,17 @@ module Hecks
             raise ArgumentError, "unknown keyword#{"s" if unknown.size > 1}: #{unknown.map(&:inspect).join(", ")}"
           end
 
-          { default: nil, optional: false, pattern: nil, admits: nil, one_of: nil }.merge(options)
+          given = { default: nil, optional: false, pattern: nil, admits: nil, one_of: nil }.merge(options)
+          expand_matches(given)
+        end
+
+        # `matches: :name` stands for the pattern the language gives that name.
+        def expand_matches(given)
+          matches = given.delete(:matches)
+          return given unless matches
+          raise ArgumentError, "matches: and pattern: both state the pattern" if given[:pattern]
+
+          given.merge(pattern: NamedPattern.source(matches))
         end
 
         def typed_attribute(name, type, field_options)

data/lib/hecks/bluebook/named_pattern.rb

@@ -0,0 +1,33 @@
+module Hecks
+  module Bluebook
+    # The patterns a bluebook names instead of spelling: `matches: :snake_name` says what
+    # `pattern: '^[a-z][a-z0-9_]*$'` does. A name stands for exactly its regex, so the IR, the
+    # generated Rust and the runtime check see the pattern and never the name.
+    #
+    # `rust/parser/src/build/named_pattern.rs` holds the same table; spec/named_pattern_spec.rb
+    # holds the two to each other.
+    module NamedPattern
+      # Name => the regex source it stands for, each the exact source the corpus spelled by hand.
+      TABLE = {
+        present:       '[^ \t\n\r]',
+        not_empty:     '[^\t\n\r]',
+        no_whitespace: '^[^ \t\n\r]+$',
+        snake_name:    "^[a-z][a-z0-9_]*$",
+        git_sha:       "^[0-9a-fA-F]{7,40}$",
+        digits:        "^[0-9]+$"
+      }.freeze
+
+      module_function
+
+      # @param name [Symbol, String] a name in `TABLE`
+      # @return [String] the regex source it stands for
+      # @raise [ArgumentError] when the name is not one the language gives
+      def source(name)
+        TABLE.fetch(name.to_sym) do
+          raise ArgumentError, "matches: #{name.inspect} is not a named pattern — " \
+                               "the names are #{TABLE.keys.map(&:inspect).join(", ")}"
+        end
+      end
+    end
+  end
+end

data/lib/hecks/bluebook.rb

@@ -44,6 +44,7 @@ require_relative "bluebook/project_loader"
 
 require_relative "bluebook/dsl"
 require_relative "bluebook/pattern_subset"
+require_relative "bluebook/named_pattern"
 
 require_relative "bluebook/meta_validator"
 require_relative "bluebook/meta_validator/plan"

data/lib/hecks/cli/domain_stub.rb

@@ -96,7 +96,7 @@ module Hecks
               attribute :name, ExampleName
 
               value_object "ExampleName" do
-                attribute :value, String, pattern: '[^ \\t\\n\\r]'
+                attribute :value, String, matches: :present
               end
 
               # TODO: replace Create with the first thing that happens to an Example.

data/lib/hecks/cli/interview_aggregate.rb

@@ -6,8 +6,8 @@ module Hecks
     # The bluebook text of one accepted thing: its aggregate, with its value objects, commands and
     # lifecycle. `InterviewDraft` extends it, and supplies the naming and citing helpers it calls.
     module InterviewAggregate
-      # The pattern every generated string field carries: it refuses a blank value.
-      PATTERN = %q('[^ \t\n\r]').freeze
+      # The option every generated string field carries: it refuses a blank value.
+      PRESENT = "matches: :present".freeze
 
       # What stands in for a creating command nothing in the interview named.
       STUB_NOTE = "    # TODO: no action that creates was accepted; replace Create with the real one.".freeze
@@ -15,7 +15,7 @@ module Hecks
       # One accepted thing: what it is called and identified by, its fields, its transitions, the
       # actions that create it and the others.
       Shape = Struct.new(:name, :identifier, :type, :fields, :steps, :creating, :rest, keyword_init: true)
-      private_constant :PATTERN, :STUB_NOTE, :Shape
+      private_constant :PRESENT, :STUB_NOTE, :Shape
 
       # @api private
       def aggregate(interview, thing, actions)
@@ -66,7 +66,7 @@ module Hecks
       # @api private
       def type_lines(shape)
         ["    value_object #{shape.type.inspect} do",
-         "      attribute :value, String, pattern: #{PATTERN}", "    end",
+         "      attribute :value, String, #{PRESENT}", "    end",
          *InterviewShape.value_objects(shape.fields)]
       end
 

data/lib/hecks/deploy/bluebook/deploy.bluebook

@@ -451,7 +451,7 @@ Hecks.bluebook "Deploy" do
 
     # The domain's own directory on disk, where `environments/<slug>.world` is written.
     value_object "DirectoryPath" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
     end
 
     value_object "Report" do
@@ -581,14 +581,14 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     # A domain directory, whose `bluebook/` holds the `.world` that declares `deployed_to`.
     value_object "DomainPath" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a domain is named by its path") { !value.to_s.empty? }
     end
@@ -604,7 +604,7 @@ Hecks.bluebook "Deploy" do
 
     # Where the recipe is written, for a domain that lives in a client's repository.
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
     end
 
     # An `environments/<name>.world` overlay of the domain, which must exist.
@@ -707,14 +707,14 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     # A domain directory, whose `bluebook/` holds the `.world` that declares `deployed_to`.
     value_object "DomainPath" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a domain is named by its path") { !value.to_s.empty? }
     end
@@ -722,7 +722,7 @@ Hecks.bluebook "Deploy" do
     # A directory the cleared worlds are written to, at their paths below `bluebook/`, instead of
     # over the originals.
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
     end
 
     value_object "Report" do
@@ -813,14 +813,14 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     # Makefile paths, comma separated; three generated fixture domains when absent.
     value_object "PathList" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
     end
 
     value_object "Report" do
@@ -909,7 +909,7 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
@@ -1020,13 +1020,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -1159,13 +1159,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -1187,7 +1187,7 @@ Hecks.bluebook "Deploy" do
 
     # A local image reference to push, as the script's LOCAL_IMAGE takes it.
     value_object "ImageName" do
-      attribute :value, String, pattern: '^[^ \t\n\r]+$'
+      attribute :value, String, matches: :no_whitespace
     end
 
     value_object "Switch" do
@@ -1352,13 +1352,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -1538,13 +1538,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -1560,7 +1560,7 @@ Hecks.bluebook "Deploy" do
 
     # A Secrets Manager id or ARN; the script reads the password from it, so no value travels here.
     value_object "Secret" do
-      attribute :value, String, pattern: '^[^ \t\n\r]+$'
+      attribute :value, String, matches: :no_whitespace
     end
 
     # A database's name; empty leaves it to the generated script's own default.
@@ -1826,13 +1826,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -1846,7 +1846,7 @@ Hecks.bluebook "Deploy" do
     end
 
     value_object "Secret" do
-      attribute :value, String, pattern: '^[^ \t\n\r]+$'
+      attribute :value, String, matches: :no_whitespace
     end
 
     # A database's name; empty leaves it to the generated script's own default.
@@ -1984,13 +1984,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project, script or file is named by its path") { !value.to_s.empty? }
     end
@@ -2134,13 +2134,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -2152,7 +2152,7 @@ Hecks.bluebook "Deploy" do
 
     # A git branch name. A preview is never of a production branch.
     value_object "Branch" do
-      attribute :value, String, pattern: '^[^ \t\n\r]+$'
+      attribute :value, String, matches: :no_whitespace
 
       invariant("a preview is never of main or master") { value != "main" && value != "master" }
     end
@@ -2510,13 +2510,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a project or script is named by its path") { !value.to_s.empty? }
     end
@@ -2656,13 +2656,13 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     value_object "Location" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
 
       invariant("a template is named by its path") { !value.to_s.empty? }
     end
@@ -2785,14 +2785,14 @@ Hecks.bluebook "Deploy" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a run is named") { !value.to_s.empty? }
     end
 
     # Domain directories, comma separated; every domain of the checkout when absent.
     value_object "DomainList" do
-      attribute :value, String, pattern: '[^\t\n\r]'
+      attribute :value, String, matches: :not_empty
     end
 
     value_object "Report" do

data/lib/hecks/framework/bluebook/change.bluebook

@@ -18,14 +18,14 @@ Hecks.bluebook "Change" do
     identified_by :run
 
     value_object "RunKey" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a change is named") { !value.to_s.empty? }
     end
 
     # The name the script is registered under with the adapter.
     value_object "ScriptName" do
-      attribute :value, String, pattern: '[^ \t\n\r]'
+      attribute :value, String, matches: :present
 
       invariant("a change names its script") { !value.to_s.empty? }
     end

data/lib/hecks/fuzzing/domain_generator/block_rendering.rb

@@ -19,7 +19,7 @@ module Hecks
         end
 
         def string_body(name)
-          ["attribute :value, String, pattern: '[^ \\t\\n\\r]'",
+          ["attribute :value, String, matches: :present",
            "invariant(#{"a #{name} is not blank".inspect}) { !value.to_s.empty? }"]
         end