periplus-map 0.2.1__py3-none-any.whl

periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource_annotation.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A REST resource plugin declared by the RestResource 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: rest_resource_from_annotation
+  reads: file
+  in:
+  - rest_resource_classes
+  match:
+    annotation: RestResource
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      annotation_key: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.rest_resource
+  confidence: declared
+- rule: rest_resource_from_annotation_edges
+  reads: file
+  in:
+  - rest_resource_classes
+  match:
+    annotation: RestResource
+    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/rest_resource/rest_resource_attribute.yaml

@@ -0,0 +1,43 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A REST resource plugin declared by the RestResource attribute on its class, the twin of the
+# annotation rule. 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.
+
+rules:
+- rule: rest_resource_from_attribute
+  reads: file
+  in:
+  - rest_resource_classes
+  match:
+    attribute: Drupal\rest\Attribute\RestResource
+    filetype: php
+    where:
+    - applies_to: class_declaration
+  id:
+    from:
+      attribute_argument: id
+    must_be: string_literal
+  emits:
+  - node:
+      type: drupal.rest_resource
+  confidence: declared
+- rule: rest_resource_from_attribute_edges
+  reads: file
+  in:
+  - rest_resource_classes
+  match:
+    attribute: Drupal\rest\Attribute\RestResource
+    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/role/role.yaml

@@ -0,0 +1,14 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# The configuration of a user role, and each permission it grants. It refines
+# drupal.config_object, so it lands on the node the config-file rule finds. A permission no mapped
+# file declares, such as one from core or a contributed module, ends at a referenced node.
+
+node_types:
+- name: drupal.role
+  parent: drupal.config_object
+
+edge_kinds:
+- kind: grants_permission
+  from: drupal.role
+  to: drupal.permission

periplus/packs/drupal_basic@0.3.0/role/role_config.yaml

@@ -0,0 +1,44 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A role read from its config file, user.role.<role>, and one grants_permission edge per entry of
+# its permissions list, each cited at its entry's line. Two rules because a rule that emits an edge
+# emits no node.
+
+rules:
+- rule: role_from_config
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: user.role.*
+    filetype: yaml
+  id:
+    from: file_stem
+  emits:
+  - node:
+      type: drupal.role
+  - attribute:
+      name: is_admin
+      from:
+        key: is_admin
+  confidence: declared
+- rule: role_from_config_edges
+  reads: file
+  in:
+  - config
+  - module_config
+  match:
+    file: user.role.*
+    filetype: yaml
+  id:
+    from: file_stem
+  emits:
+  - edge:
+      kind: grants_permission
+      from: this_node
+      to:
+        from:
+          key: permissions
+        each: true
+  confidence: declared

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

@@ -0,0 +1,42 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A route, named by its key in a routing file, and the PHP method or form class that answers it. A
+# route requires a permission or a role it needs, and accepts each of permissions or roles any one
+# of which lets in. A route's title comes from a PHP method, its access from a service or a PHP
+# method, and a parameter's value is loaded as an entity of an entity type.
+
+node_types:
+- name: drupal.route
+  id_namespace: drupal.route
+
+edge_kinds:
+- kind: requires_permission
+  from: drupal.route
+  to: drupal.permission
+- kind: accepts_permission
+  from: drupal.route
+  to: drupal.permission
+- kind: handled_by
+  from: drupal.route
+  to: php.method
+- kind: uses_form
+  from: drupal.route
+  to: php.class
+- kind: titled_by
+  from: drupal.route
+  to: php.method
+- kind: requires_role
+  from: drupal.route
+  to: drupal.role
+- kind: accepts_role
+  from: drupal.route
+  to: drupal.role
+- kind: access_checked_by_service
+  from: drupal.route
+  to: drupal.service
+- kind: access_checked_by
+  from: drupal.route
+  to: php.method
+- kind: loads_entity_type
+  from: drupal.route
+  to: drupal.entity_type

periplus/packs/drupal_basic@0.3.0/route/route_definition.yaml

@@ -0,0 +1,113 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A route read from a routing file, one per top-level key that has a path. Two rules because a
+# rule that emits an edge emits no node. The key route_callbacks is a list, not a route, and has no
+# path. A route's _permission joins permissions with a comma (all needed), read first, or with a
+# plus sign (any one); each permission between them is one edge, without the spaces around it: a
+# requires_permission edge, or an accepts_permission edge for a value with a plus sign and no
+# comma. The first branch of each pattern takes the whole of a value that is not its own and names
+# no permission, so that value gives the edge kind nothing. A _controller written Class::method is
+# handled_by that method; one written service:method names a service and makes no edge. A
+# _title_callback written Class::method is titled_by that method. A leading backslash is dropped
+# from a class name. A route serves its path as written, a route_serves_path edge to the
+# drupal.url_path node that url/url.yaml joins links to.
+
+rules:
+- rule: route_from_routing_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.route
+  - attribute:
+      name: path
+      from:
+        key: path
+  - attribute:
+      name: controller
+      from:
+        key: defaults._controller
+  - attribute:
+      name: form
+      from:
+        key: defaults._form
+  - attribute:
+      name: title
+      from:
+        key: defaults._title
+  confidence: declared
+- rule: route_from_routing_file_edges
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: requires_permission
+      from: this_node
+      to:
+        from:
+          key: requirements._permission
+        each: true
+        pattern: '^[^,]*\+[^,]*$|(?<permission>[^,\s](?:[^,]*[^,\s])?)'
+        template: '{permission}'
+  - edge:
+      kind: accepts_permission
+      from: this_node
+      to:
+        from:
+          key: requirements._permission
+        each: true
+        where:
+        - matches: '*+*'
+        pattern: '.*,.*|(?<permission>[^+\s](?:[^+]*[^+\s])?)'
+        template: '{permission}'
+  - edge:
+      kind: handled_by
+      from: this_node
+      to:
+        from:
+          key: defaults._controller
+        pattern: '^\\?(?<method>[^\\:][^:]*::[^:]+)$'
+        template: '{method}'
+  - edge:
+      kind: titled_by
+      from: this_node
+      to:
+        from:
+          key: defaults._title_callback
+        pattern: '^\\?(?<method>[^\\:][^:]*::[^:]+)$'
+        template: '{method}'
+  - edge:
+      kind: uses_form
+      from: this_node
+      to:
+        from:
+          key: defaults._form
+        pattern: '^\\?(?<form>[^\\].*)$'
+        template: '{form}'
+  - edge:
+      kind: route_serves_path
+      from: this_node
+      to:
+        from:
+          key: path
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/route/route_options.yaml

@@ -0,0 +1,55 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A route's options, read from the routing file. Two rules because a rule that emits an edge emits
+# no node. A route parameter whose type is entity:<type> is converted to an entity of that type, a
+# loads_entity_type edge; any other parameter type names no entity type and gives no edge.
+
+rules:
+- rule: route_options_from_routing_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.route
+  - attribute:
+      name: no_cache
+      from:
+        key: options.no_cache
+  - attribute:
+      name: admin_route
+      from:
+        key: options._admin_route
+  confidence: declared
+- rule: route_options_from_routing_file_edges
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: loads_entity_type
+      from: this_node
+      to:
+        from:
+          key: options.parameters.*.type
+        pattern: '^entity:(?<entity_type>.+)$'
+        template: '{entity_type}'
+  confidence: declared

periplus/packs/drupal_basic@0.3.0/route/route_requirements.yaml

@@ -0,0 +1,108 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A route's methods and its access requirements, read from the routing file. Two rules because a
+# rule that emits an edge emits no node. A requirement that is only a value is an attribute. A
+# route's _role joins roles as _permission joins permissions: with a comma (all needed), read
+# first, or with a plus sign (any one); each role is one edge to the role's configuration,
+# user.role.<role>, a requires_role edge, or an accepts_role edge for a value with a plus sign and
+# no comma. A _custom_access written service:method is access_checked_by_service that service; one
+# written Class::method is access_checked_by that method. The whole value stays in the attribute
+# custom_access. A leading backslash is dropped from a class name.
+
+rules:
+- rule: route_requirements_from_routing_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.route
+  - attribute:
+      name: methods
+      from:
+        key: methods
+  - attribute:
+      name: access
+      from:
+        key: requirements._access
+  - attribute:
+      name: format
+      from:
+        key: requirements._format
+  - attribute:
+      name: user_is_logged_in
+      from:
+        key: requirements._user_is_logged_in
+  - attribute:
+      name: csrf_token
+      from:
+        key: requirements._csrf_token
+  - attribute:
+      name: entity_access
+      from:
+        key: requirements._entity_access
+  - attribute:
+      name: custom_access
+      from:
+        key: requirements._custom_access
+  confidence: declared
+- rule: route_requirements_from_routing_file_edges
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.routing'
+    filetype: yaml
+    each: '*'
+    where:
+    - has_key:
+        path: path
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: requires_role
+      from: this_node
+      to:
+        from:
+          key: requirements._role
+        each: true
+        pattern: '^[^,]*\+[^,]*$|(?<role>[^,\s](?:[^,]*[^,\s])?)'
+        template: 'user.role.{role}'
+  - edge:
+      kind: accepts_role
+      from: this_node
+      to:
+        from:
+          key: requirements._role
+        each: true
+        where:
+        - matches: '*+*'
+        pattern: '.*,.*|(?<role>[^+\s](?:[^+]*[^+\s])?)'
+        template: 'user.role.{role}'
+  - edge:
+      kind: access_checked_by_service
+      from: this_node
+      to:
+        from:
+          key: requirements._custom_access
+        pattern: '^(?<service>[^\\:][^:]*):[^:]+$'
+        template: '{service}'
+  - edge:
+      kind: access_checked_by
+      from: this_node
+      to:
+        from:
+          key: requirements._custom_access
+        pattern: '^\\?(?<method>[^\\:][^:]*::[^:]+)$'
+        template: '{method}'
+  confidence: declared

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

@@ -0,0 +1,56 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A service, named by its key in a services file, a tag a service carries, and the PHP class that
+# implements a service. service_class ends at a class or an interface, because a service built by a
+# factory may name an interface under class.
+
+node_types:
+- name: drupal.service
+  id_namespace: drupal.service
+- name: drupal.service_tag
+  id_namespace: drupal.service_tag
+
+edge_kinds:
+- kind: injects_service
+  from: drupal.service
+  to: drupal.service
+- kind: extends_service
+  from: drupal.service
+  to: drupal.service
+- kind: alias_of_service
+  from: drupal.service
+  to: drupal.service
+- kind: tagged_as
+  from: drupal.service
+  to: drupal.service_tag
+- kind: service_class
+  from: drupal.service
+  to: [php.class, php.interface]
+
+# A call site $this->helper->run() to Helper::run, when the call's class or its nearest ancestor
+# that declares the property assigns it $this->helper = \Drupal::service('my_module.helper') and
+# a services file gives that service its class. php_basic's calls_through_assigned_property reads
+# the same chain up to the assignment's value. The id is read in single or double quotes; the
+# edge runs from the method around the call, at the call's line. Inferred: the services file, not
+# the call, names the class.
+rules:
+- rule: calls_through_service_property
+  reads: map
+  match:
+    node_type: php.call_site
+    where: [{id_matches: '^php\.call_site::(?<site>(?<class>[^:]+)::[^:]+::\$this->(?<member>\w+)->(?<method>\w+))$'}]
+    follow:
+    - node: 'php.type::{class}'
+    - ancestors: [inherits]
+    - id_matches: '^php\.type::(?<owner>.+)$'
+    - node: 'php.property::{owner}::${member}'
+    - node: 'php.member_assignment::{owner}::$this->{member}'
+    - edge: assigned_value
+    - id_matches: '=\\?Drupal::service\(["''](?<service>[^"'']+)["'']\)$'
+    - node: 'drupal.service::{service}'
+    - edge: service_class
+    - id_matches: '^php\.type::(?<type>.+)$'
+    - node: 'php.call_site::{site}'
+    - edge: call_site_in
+  emits: [{edge: {kind: calls, from: matched_node, to: {template: "{type}::{method}", types: [php.method], on_miss: unresolved}}}]
+  confidence: inferred

periplus/packs/drupal_basic@0.3.0/service/service_definition.yaml

@@ -0,0 +1,181 @@
+$schema: "https://periplus.dev/schema/0/pack-file.schema.json"
+
+# A service read from a services file, one per key under services. Two rules because a rule that
+# emits an edge emits no node. The key _defaults holds settings for the file, not a service, and
+# id_matches leaves it out. An argument names a service when it is written @name or @?name; the
+# arguments may be a list or a mapping of names. The class key names the service's PHP class; a
+# leading backslash is dropped. An entry whose whole value is @name, or whose alias key is not
+# null, is an alias of the service it names and has no class, so an alias in either form is read
+# by its own node rule, which reads no class. An entry whose key holds a backslash and that has no
+# class key is a service of the class its key names, unless it is an alias. An access_check tag's
+# applies_to, the route requirement key the checker answers, is kept as an attribute of the
+# service, because an attribute on the tagged_as edge is accepted and not executed.
+
+rules:
+- rule: service_from_services_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: ^[^_]
+    - key:
+        name: alias
+        equals: null
+    - is_mapping: true
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.service
+  - attribute:
+      name: class
+      from:
+        key: class
+  - attribute:
+      name: applies_to
+      from:
+        key: tags.*.applies_to
+  confidence: declared
+- rule: service_alias_from_services_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: ^[^_]
+    - key:
+        name: alias
+        not_equals: null
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.service
+  confidence: declared
+- rule: service_text_alias_from_services_file
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: ^[^_]
+    - is_mapping: false
+  id:
+    from: key
+  emits:
+  - node:
+      type: drupal.service
+  confidence: declared
+- rule: service_from_services_file_edges
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: ^[^_]
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: injects_service
+      from: this_node
+      to:
+        from:
+          key: arguments
+        each: true
+        pattern: '^@\??(?<service>[^@=].*)$'
+        template: '{service}'
+  - edge:
+      kind: extends_service
+      from: this_node
+      to:
+        from:
+          key: parent
+  - edge:
+      kind: alias_of_service
+      from: this_node
+      to:
+        from:
+          key: alias
+        pattern: '^@?(?<service>.+)$'
+        template: '{service}'
+  - edge:
+      kind: alias_of_service
+      from: this_node
+      to:
+        from: text
+        pattern: '^@(?<service>.+)$'
+        template: '{service}'
+  - edge:
+      kind: tagged_as
+      from: this_node
+      to:
+        from:
+          key: tags.*.name
+  confidence: declared
+- rule: service_from_services_file_class
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: ^[^_]
+    - key:
+        name: alias
+        equals: null
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: service_class
+      from: this_node
+      to:
+        from:
+          key: class
+        pattern: '^\\?(?<class>[^\\].*)$'
+        template: '{class}'
+  confidence: declared
+- rule: service_from_services_file_class_key
+  reads: file
+  in:
+  - module_root
+  match:
+    file: '*.services'
+    filetype: yaml
+    each: services.*
+    where:
+    - id_matches: \\
+    - key:
+        name: class
+        equals: null
+    - key:
+        name: alias
+        equals: null
+    - is_mapping: true
+  id:
+    from: key
+  emits:
+  - edge:
+      kind: service_class
+      from: this_node
+      to:
+        from:
+        - key
+        template: '{key}'
+  confidence: declared