periplus-map 0.2.1__py3-none-any.whl

periplus/packs/drupal@0.1.0/recommendations/recommendations.yaml

@@ -0,0 +1,14 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# drupal pack — the recommendations: section.
+
+# ======================================================================================
+# Advice a pack may carry. The map may not.
+# ======================================================================================
+recommendations:
+  - topic: exported_configuration
+    text: >
+      Use a configuration overlay to reduce what gets exported. Less exported
+      configuration means less to map, and the map's config layer shrinks with it.
+    # Not derivable from the code, so it belongs to the pack and joins the map at read
+    # time. The map holds the count; this holds the note.

periplus/packs/drupal@0.1.0/service/service.yaml

@@ -0,0 +1,19 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# drupal pack — declares the service and the edge that resolves one.
+
+node_types:
+
+  - name: drupal.service
+    id_namespace: drupal.service
+
+edge_kinds:
+
+  - kind: resolves_service
+    from: [php.callable, drupal.config_object]
+    to:   drupal.service
+    # The config_object endpoint was added after a real refusal. A block placement
+    # references a service at block.block.block_ways_4_context.yml:21:
+    #   user: '@user.current_user_context:current_user'
+    # With `from: php.callable` alone the endpoint check rejected that edge, which is the
+    # schema working — and the fix is to widen the endpoint, not to drop the edge.

periplus/packs/drupal@0.1.0/service/service_autowire.yaml

@@ -0,0 +1,28 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# drupal pack — a service injected by attribute, on a property. One rule.
+#
+# Written to test whether an attribute sitting on something other than a class needs
+# anything new. It does not.
+
+needs:
+  types: [drupal.service]
+
+rules:
+
+  - rule: autowired_property
+    reads: file
+    in: [custom_module, custom_theme]
+    match:
+      attribute: "Symfony\\Component\\DependencyInjection\\Attribute\\Autowire"
+      where:
+        - applies_to: property_declaration
+    id:
+      from: {attribute_argument: service}
+      must_be: string_literal
+      on_miss: unresolved
+    emits:
+      - edge: {kind: resolves_service, from: enclosing_class, to: this_node}
+    confidence: declared
+    # Same five keys as every other rule. The only difference from the block attribute rule
+    # is one `applies_to` value and which argument holds the id.

periplus/packs/drupal@0.1.0/service/service_definition.yaml

@@ -0,0 +1,24 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# drupal pack — services declared in a services file. One rule.
+
+needs:
+  types: [drupal.service]
+
+rules:
+
+  - rule: service_from_services_file
+    reads: file
+    in: [custom_module, custom_theme]
+    match:
+      file: "*.services"
+      filetype: yaml
+      each: "services.*"
+    id:
+      from: key
+    emits:
+      - node: {type: drupal.service}
+    confidence: declared
+    # `each` addresses inside a data file rather than treating the file as one thing. This
+    # and the menu links file are the two places the pack needs it, and how the expression
+    # is written is still open.

periplus/packs/drupal@0.1.0/service/service_use.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# drupal pack — code reaching a service. Two rules, and they differ in confidence for a
+# reason that only the author knows.
+
+needs:
+  types: [drupal.service]
+
+rules:
+
+  - rule: static_service_accessor
+    reads: file
+    in: [custom_module, custom_theme]
+    match:
+      static_call: "Drupal::service"
+    id:
+      from: {argument: 0}
+      must_be: string_literal
+      on_miss: unresolved
+    emits:
+      - edge: {kind: resolves_service, from: enclosing_callable, to: this_node}
+    confidence: declared
+    # The id is a literal at the call site, so nothing is inferred.
+
+  - rule: constructor_injection
+    reads: file
+    in: [custom_module, custom_theme]
+    match:
+      node_type: php.method
+      where:
+        - has_promoted_constructor_parameter: true
+    id:
+      from: parameter_type
+      on_miss: unresolved
+    emits:
+      - edge: {kind: resolves_service, from: enclosing_callable, to: this_node}
+    confidence: inferred
+    # Identified by the parameter's type, which is a claim about what the container will
+    # pass rather than an observation of it. Same edge kind, lower confidence, and the
+    # difference is a property of the rule, not of the file it runs on.
+    #
+    # A third accessor form exists and is not covered: $container->get('entity_type.manager'),
+    # at NodeTypeBlockDeriver.php:32. Named here rather than left as a silent miss.

periplus/packs/drupal_basic@0.3.0/action/action.yaml

@@ -0,0 +1,9 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# An action plugin, named by its plugin id; plugin_class joins it to its class. It ends at the same
+# type and id namespace whichever way it is declared.
+
+node_types:
+- name: drupal.action_plugin
+  parent: drupal.plugin
+  id_namespace: drupal.plugin.action

periplus/packs/drupal_basic@0.3.0/action/action_annotation.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# An action plugin declared by the Action docblock annotation on its class. Two rules because a rule
+# that emits an edge emits no node. An id that is not text in double quotes makes no plugin and is
+# listed under skipped in the map report.
+
+rules:
+- rule: action_from_annotation
+  reads: file
+  in:
+  - action_classes
+  match:
+    annotation: Action
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.action_plugin
+  confidence: declared
+- rule: action_from_annotation_edges
+  reads: file
+  in:
+  - action_classes
+  match:
+    annotation: Action
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/action/action_attribute.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# An action plugin declared by the Action attribute on its class. Two rules because a rule that
+# emits an edge emits no node. An id that is not a text literal makes no plugin and is listed under
+# skipped in the map report.
+
+rules:
+- rule: action_from_attribute
+  reads: file
+  in:
+  - action_classes
+  match:
+    attribute: Drupal\Core\Action\Attribute\Action
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      attribute_argument: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.action_plugin
+  confidence: declared
+- rule: action_from_attribute_edges
+  reads: file
+  in:
+  - action_classes
+  match:
+    attribute: Drupal\Core\Action\Attribute\Action
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      attribute_argument: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/block/block_placement.yaml

@@ -0,0 +1,16 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A placement is one instance of a block, in a theme, in a region. It is a config entity, so it
+# refines drupal.config_object. The plugin it places is declared in block_plugin/.
+
+node_types:
+- name: drupal.block_placement
+  parent: drupal.config_object
+- name: drupal.plugin
+  abstract: true
+  id_namespace: drupal.plugin
+
+edge_kinds:
+- kind: places_plugin
+  from: drupal.block_placement
+  to: drupal.block_plugin

periplus/packs/drupal_basic@0.3.0/block/block_placement_config.yaml

@@ -0,0 +1,51 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block placement read from its config file: its theme, region and weight, and the plugin it
+# places. Two rules because a rule that emits an edge emits no node.
+
+rules:
+- rule: block_placement_from_config
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: block.block.*
+    filetype: yaml
+  id:
+    from: file_stem
+  emits:
+  - node:
+      type: drupal.block_placement
+  - attribute:
+      name: theme
+      from:
+        key: theme
+  - attribute:
+      name: region
+      from:
+        key: region
+  - attribute:
+      name: weight
+      from:
+        key: weight
+  confidence: declared
+- rule: block_placement_from_config_edges
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: block.block.*
+    filetype: yaml
+  id:
+    from: file_stem
+  emits:
+  - edge:
+      kind: places_plugin
+      from: this_node
+      to:
+        from:
+          key: plugin
+        template: drupal.plugin.block::{plugin}
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin.yaml

@@ -0,0 +1,14 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block plugin, named by its plugin id, and the PHP class that implements it. The plugin_class
+# kind starts at drupal.plugin, so every plugin type below it, in this pack or in another, has it.
+
+node_types:
+- name: drupal.block_plugin
+  parent: drupal.plugin
+  id_namespace: drupal.plugin.block
+
+edge_kinds:
+- kind: plugin_class
+  from: drupal.plugin
+  to: php.class

periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_annotation.yaml

@@ -0,0 +1,47 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block plugin declared by the Block docblock annotation on its class. It ends at the same type
+# and id namespace as the attribute rule, so one plugin declared either way is the same node. An id
+# that is not text in double quotes makes no plugin and is listed under skipped in the map report.
+
+rules:
+- rule: block_plugin_from_annotation
+  reads: file
+  in:
+  - block_plugin_classes
+  match:
+    annotation: Block
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.block_plugin
+  - attribute:
+      name: admin_label
+      from:
+        annotation_key: admin_label
+  confidence: declared
+- rule: block_plugin_from_annotation_edges
+  reads: file
+  in:
+  - block_plugin_classes
+  match:
+    annotation: Block
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_attribute.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block plugin declared by the Block attribute on its class. Two rules because a rule that emits
+# an edge emits no node. An id that is not a text literal, such as a constant, makes no plugin and
+# is listed under skipped in the map report.
+
+rules:
+- rule: block_plugin_from_attribute
+  reads: file
+  in:
+  - block_plugin_classes
+  match:
+    attribute: Drupal\Core\Block\Attribute\Block
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      attribute_argument: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.block_plugin
+  confidence: declared
+- rule: block_plugin_from_attribute_edges
+  reads: file
+  in:
+  - block_plugin_classes
+  match:
+    attribute: Drupal\Core\Block\Attribute\Block
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      attribute_argument: id
+    must_be: string_literal
+  emits:
+  - edge:
+      kind: plugin_class
+      from: this_node
+      to: enclosing_class
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/block_type/block_type.yaml

@@ -0,0 +1,8 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block type is a bundle: it says what fields a content block has. It refines drupal.bundle and
+# shares its id, block_content.<id>.
+
+node_types:
+- name: drupal.block_type
+  parent: drupal.bundle

periplus/packs/drupal_basic@0.3.0/block_type/block_type_config.yaml

@@ -0,0 +1,54 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A block type read from its config file, as the bundle rules read theirs: block_content.type.basic
+# is the bundle block_content.basic.
+
+rules:
+- rule: block_type_from_config
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: block_content.type.*
+    filetype: yaml
+  id:
+    from: file_stem
+    normalize:
+    - {replace: '^block_content\.type\.', with: 'block_content.'}
+  emits:
+  - node:
+      type: drupal.block_type
+  - attribute:
+      name: label
+      from:
+        key: label
+  confidence: declared
+- rule: block_type_from_config_edges
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: block_content.type.*
+    filetype: yaml
+  id:
+    from: file_stem
+    normalize:
+    - {replace: '^block_content\.type\.', with: 'block_content.'}
+  emits:
+  - edge:
+      kind: configured_by
+      from: this_node
+      to:
+        from:
+          key: id
+        template: 'block_content.type.{id}'
+  - edge:
+      kind: bundle_of
+      from: this_node
+      to:
+        from:
+          key: id
+        template: 'block_content'
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/boundary/boundary_types.yaml

@@ -0,0 +1,19 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# The roles a first-party class takes from the core base or interface it descends from, which the
+# boundary block in pack.yaml names. Each keeps php.type, so the class keeps its id and every edge
+# that ends on it.
+
+node_types:
+- name: drupal.controller_class
+  parent: php.class
+  id_namespace: php.type
+- name: drupal.form_class
+  parent: php.class
+  id_namespace: php.type
+- name: drupal.config_form_class
+  parent: drupal.form_class
+  id_namespace: php.type
+- name: drupal.event_subscriber_class
+  parent: php.class
+  id_namespace: php.type

periplus/packs/drupal_basic@0.3.0/bundle/bundle.yaml

@@ -0,0 +1,20 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A bundle: a content type, a vocabulary, a media type and the like; a block type refines it. Its
+# id is the entity type and the bundle's machine name, as node.article, the two keys a field
+# instance and a display state. So a bundle that a config file declares and one that only a field
+# names are one node, whatever module's config prefix declares it: a pack for a contributed module
+# maps its bundle config onto the same id. A bundle no rule declares is referenced, and a bundle
+# config file stays a config object, the end of its bundle's configured_by edge.
+
+node_types:
+- name: drupal.bundle
+  id_namespace: drupal.bundle
+
+edge_kinds:
+- kind: configured_by
+  from: drupal.bundle
+  to: drupal.config_object
+- kind: bundle_of
+  from: drupal.bundle
+  to: drupal.entity_type