periplus-map 0.4.1__tar.gz → 0.4.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {periplus_map-0.4.1 → periplus_map-0.4.2}/PKG-INFO +7 -6
- {periplus_map-0.4.1 → periplus_map-0.4.2}/README.md +6 -5
- {periplus_map-0.4.1 → periplus_map-0.4.2}/pyproject.toml +1 -1
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/pattern.py +3 -2
- periplus_map-0.4.2/src/periplus/skills/periplus-gaps/SKILL.md +282 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/skills/periplus-map/SKILL.md +1 -1
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/skills/periplus-rutter/SKILL.md +147 -10
- periplus_map-0.4.1/src/periplus/skills/periplus-gaps/SKILL.md +0 -57
- {periplus_map-0.4.1 → periplus_map-0.4.2}/.gitignore +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/LICENSE +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/NOTICE +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/__init__.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/checkmap.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/cli.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/schema/map.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/schema/navigation.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/schema/pack-file.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/schema/pack-manifest.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/schema/project-settings.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/spec/engine.md +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/contract/spec/rules.md +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/detect.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/__init__.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/check.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/emit.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/packload.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/rules.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/select.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/source.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/engine/tree.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/errors.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/init.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/layout.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/manifest.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/map.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/mapshared.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/__init__.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/export.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/find.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/ids.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/listing.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/mapfile.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/path.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/show.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/slice.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/types.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/navigate/walk.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/advancedqueue_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/advancedqueue_basic@0.0.1/queue_job_type/queue_job_type_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/ai_basic@0.0.1/ai_agent/ai_agent.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/ai_basic@0.0.1/ai_agent/ai_agent_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/ai_basic@0.0.1/ai_function_call/ai_function_call.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/ai_basic@0.0.1/ai_function_call/ai_function_call_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/ai_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/config_pages_basic@0.0.1/bundle/config_pages_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/config_pages_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/crop_basic@0.0.1/bundle/crop_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/crop_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_placement.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_placement_code.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_altered.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_content.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_derived.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_plugin_deriver.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_type.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_type_code.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/block/block_type_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/cache/cache.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/cache/cache_backend.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/component/sdc.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/component/sdc_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/component/sdc_use.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/config/config_object.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/display/display.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/display/display_code.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/display/display_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/entity/entity.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/entity/entity_class.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/entity/entity_save.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/entity/entity_type_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/entity/entity_type_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/field/field_instance_code.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/field/field_storage.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/field/field_storage_code.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/form/form.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/form/form_class.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/form/form_id.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/form/form_methods.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/hook/hook.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/module/module.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/module/module_info.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/plugin/plugin.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/plugin/plugin_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/recommendations/recommendations.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/service/service.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/service/service_autowire.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/service/service_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal@0.1.0/service/service_use.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/action/action.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/action/action_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/action/action_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block/block_placement_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block_plugin/block_plugin_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block_type/block_type.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/block_type/block_type_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/boundary/boundary_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/bundle/bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/call/call.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/component/component.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/config/config_object.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/constraint/constraint_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/display/display.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/display/display_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/display/display_mode_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/entity_type/config_entity_type_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/entity_type/config_entity_type_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/entity_type/content_entity_type_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/entity_type/content_entity_type_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/entity_type/entity_type.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field/field_instance_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field/field_storage_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_formatter/field_formatter_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_type/field_type_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_type/field_type_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_widget/field_widget_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/field_widget/field_widget_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/form/form_id.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/hook/hook.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/hook/hook_theme_include.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/library/library.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/library/library_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/local_action/local_action.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/local_action/local_action_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/mail/mail.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/mail/mail_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/media_source/media_source_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/menu_link/menu_link.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/menu_link/menu_link_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/module/module.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/module/module_info.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/permission/permission.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/permission/permission_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/queue_worker/queue_worker_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/rest_resource/rest_resource_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/role/role.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/role/role_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/route/route.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/route/route_call.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/route/route_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/route/route_options.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/route/route_requirements.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/service/service.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/service/service_definition.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/template/template.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/template/template_route_link.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/theme/theme.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/theme/theme_info.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/template_suggestion.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/theme_hook.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/theme_hook/theme_hook_render.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/url/url.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_field_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_filter_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_plugin.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_basic@0.3.0/views_plugin/views_style_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_php.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_php_array.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/attachment_in_twig.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/attachment/php_function_holder.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/behavior/behavior.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting_in_js.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drupal_js_basic@0.0.1/setting/setting_in_php.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drush_basic@0.0.1/command/command.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drush_basic@0.0.1/command/command_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drush_basic@0.0.1/command/command_attribute.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/drush_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/eck_basic@0.0.1/bundle/eck_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/eck_basic@0.0.1/entity_type/eck_entity_type_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/eck_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go@0.0.2/interfaces/satisfies.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go@0.0.2/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go@0.0.2/types/find_declarations.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go@0.0.2/types/node_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go_basic@0.0.3/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go_basic@0.0.3/rules/calls.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go_basic@0.0.3/rules/declarations.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go_basic@0.0.3/rules/imports.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/go_basic@0.0.3/types/node_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/js_basic@0.0.1/function/function.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/js_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/rules/classes.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/rules/config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/rules/routes.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/rules/types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/laravel_basic@0.0.5/rules/views.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/paragraphs_basic@0.0.1/bundle/paragraph_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/paragraphs_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/edges/edge_kinds.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/edges/find_calls.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/edges/find_imports.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/edges/find_member_access.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/edges/find_structure.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/embedded/embedded_regions.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/imports/imports.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/resolution/excluded_tokens.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/resolution/resolution.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/types/find_declarations.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php@0.1.0/types/node_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/edges/edge_kinds.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/edges/find_structure.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/imports/imports.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/types/find_declarations.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/php_basic@0.2.0/types/node_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/profile_basic@0.0.1/bundle/profile_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/profile_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/event/salesforce_event.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping/salesforce_mapping.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping/salesforce_mapping_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping_field/salesforce_mapping_field.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/salesforce_basic@0.0.1/salesforce_mapping_field/salesforce_mapping_field_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig@0.0.1/types/template.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_tweak_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/block.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/entity.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/field.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/twig_tweak_basic@0.0.1/rules/menu.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/webform_basic@0.0.1/bundle/webform_submission_bundle_config.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/webform_basic@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/webform_basic@0.0.1/webform_handler/webform_handler_annotation.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/yaml@0.0.1/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/yaml@0.0.1/types/find_mapping_entry.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/yaml@0.0.1/types/yaml_types.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs/yaml_basic@0.1.0/pack.yaml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/packs.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/preflight.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/py.typed +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/report.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/resolution.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/settings.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/settings.stub.yml +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/skills/periplus-map/references/descriptions.schema.json +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/skills_install.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/spec.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/update.py +0 -0
- {periplus_map-0.4.1 → periplus_map-0.4.2}/src/periplus/validate.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: periplus-map
|
|
3
|
-
Version: 0.4.
|
|
3
|
+
Version: 0.4.2
|
|
4
4
|
Summary: A schema-first, deterministic codebase mapper, configurable to any stack.
|
|
5
5
|
Project-URL: Homepage, https://github.com/camoa/periplus
|
|
6
6
|
Project-URL: Repository, https://github.com/camoa/periplus
|
|
@@ -52,7 +52,7 @@ Description-Content-Type: text/markdown
|
|
|
52
52
|
`js` and `go` extras for the tests. It runs pytest on Python 3.11 to 3.14, ruff and mypy, and validates
|
|
53
53
|
every bundled pack. It does not run the acceptance scripts, and it never maps a Go project.</sub>
|
|
54
54
|
|
|
55
|
-
Status: **beta**, version 0.4.
|
|
55
|
+
Status: **beta**, version 0.4.2.
|
|
56
56
|
|
|
57
57
|
</div>
|
|
58
58
|
|
|
@@ -105,7 +105,7 @@ periplus --version
|
|
|
105
105
|
To install a tagged version from the repository:
|
|
106
106
|
|
|
107
107
|
```
|
|
108
|
-
uv tool install git+https://github.com/camoa/periplus@v0.4.
|
|
108
|
+
uv tool install git+https://github.com/camoa/periplus@v0.4.2
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
To install from a local copy of this repository:
|
|
@@ -350,9 +350,10 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
350
350
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
351
351
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
352
352
|
|
|
353
|
-
New in this release: the
|
|
354
|
-
|
|
355
|
-
|
|
353
|
+
New in this release: the gaps skill reports resolution gaps and detail gaps apart, with a site
|
|
354
|
+
fault under its own heading; the rutter skill measures what a rule added by mapping before and
|
|
355
|
+
after, and offers the next gap; and a rule pattern may hold an escaped backslash right before a
|
|
356
|
+
named group.
|
|
356
357
|
|
|
357
358
|
## Write a rutter
|
|
358
359
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
`js` and `go` extras for the tests. It runs pytest on Python 3.11 to 3.14, ruff and mypy, and validates
|
|
13
13
|
every bundled pack. It does not run the acceptance scripts, and it never maps a Go project.</sub>
|
|
14
14
|
|
|
15
|
-
Status: **beta**, version 0.4.
|
|
15
|
+
Status: **beta**, version 0.4.2.
|
|
16
16
|
|
|
17
17
|
</div>
|
|
18
18
|
|
|
@@ -65,7 +65,7 @@ periplus --version
|
|
|
65
65
|
To install a tagged version from the repository:
|
|
66
66
|
|
|
67
67
|
```
|
|
68
|
-
uv tool install git+https://github.com/camoa/periplus@v0.4.
|
|
68
|
+
uv tool install git+https://github.com/camoa/periplus@v0.4.2
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
To install from a local copy of this repository:
|
|
@@ -310,9 +310,10 @@ To map a Laravel application, pin `php_basic@0.2.0` and `laravel_basic@0.0.5` an
|
|
|
310
310
|
at the application's root. The default Laravel folders need no settings. To move the templates,
|
|
311
311
|
set `views_root` under `folders`; a template is named by its path below `views_root`.
|
|
312
312
|
|
|
313
|
-
New in this release: the
|
|
314
|
-
|
|
315
|
-
|
|
313
|
+
New in this release: the gaps skill reports resolution gaps and detail gaps apart, with a site
|
|
314
|
+
fault under its own heading; the rutter skill measures what a rule added by mapping before and
|
|
315
|
+
after, and offers the next gap; and a rule pattern may hold an escaped backslash right before a
|
|
316
|
+
named group.
|
|
316
317
|
|
|
317
318
|
## Write a rutter
|
|
318
319
|
|
|
@@ -25,7 +25,7 @@ classifiers = [
|
|
|
25
25
|
# Declared here and nowhere else. src/periplus/__init__.py reads it back at runtime through
|
|
26
26
|
# importlib.metadata.version(), so the number is written once and `periplus --version` prints
|
|
27
27
|
# what this file says by construction rather than by two places agreeing.
|
|
28
|
-
version = "0.4.
|
|
28
|
+
version = "0.4.2"
|
|
29
29
|
|
|
30
30
|
# Five runtime distributions. The count is still a decision, not an accident, and this comment
|
|
31
31
|
# said "two runtime distributions, zero transitive" until `periplus validate` needed a validator.
|
|
@@ -8,7 +8,8 @@ from collections.abc import Sequence
|
|
|
8
8
|
__all__ = ["compile_pattern", "reshape"]
|
|
9
9
|
|
|
10
10
|
#: A named group written ``(?<name>``, which ``re`` spells ``(?P<name>``; lookbehind stays alone.
|
|
11
|
-
|
|
11
|
+
#: Group 1 is an even run of backslashes, which escapes nothing; an odd run leaves a literal paren.
|
|
12
|
+
_NAMED_GROUP = re.compile(r"(?<!\\)((?:\\\\)*)\(\?<(?![=!])")
|
|
12
13
|
|
|
13
14
|
|
|
14
15
|
def compile_pattern(expression: str) -> re.Pattern[str]:
|
|
@@ -16,7 +17,7 @@ def compile_pattern(expression: str) -> re.Pattern[str]:
|
|
|
16
17
|
|
|
17
18
|
The pack format names RE2; this uses Python's ``re`` engine instead.
|
|
18
19
|
"""
|
|
19
|
-
return re.compile(_NAMED_GROUP.sub("(?P<", expression))
|
|
20
|
+
return re.compile(_NAMED_GROUP.sub(r"\1(?P<", expression))
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
def reshape(value: str, normalize: Sequence[tuple[re.Pattern[str], str]], case: str = "") -> str:
|
|
@@ -0,0 +1,282 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: periplus-gaps
|
|
3
|
+
description: Read a Periplus map and the code behind it, list what the map lacks, and say for each gap whether it needs a new rule or a new rutter, and where that rule belongs.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Find the gaps in a map
|
|
7
|
+
|
|
8
|
+
## Standing rules
|
|
9
|
+
|
|
10
|
+
1. Rules are small and add to each other: split by rule file inside one rutter, never by adding rutters.
|
|
11
|
+
2. A rutter reads its stack in passes by depth: structure first, then one layer inside each class, then joins in the map.
|
|
12
|
+
3. There is no stack knowledge in the engine; a stack's shape is a rule in a rutter.
|
|
13
|
+
4. Write the rule and run it: probe before saying a rutter cannot, and quote the engine's message.
|
|
14
|
+
5. A rutter meant for others never names the project it was built on, in its code, rules, examples or prose.
|
|
15
|
+
|
|
16
|
+
## Where the detail lives
|
|
17
|
+
|
|
18
|
+
- [Navigation](https://github.com/camoa/periplus/blob/v0.4.2/docs/navigation.md) holds the signature, output rows and exit codes of each command used here.
|
|
19
|
+
- [Where a rule belongs](https://github.com/camoa/periplus/blob/v0.4.2/docs/map-report-guide.md#where-a-rule-belongs) and
|
|
20
|
+
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.4.2/docs/map-report-guide.md#when-a-gap-is-the-engines) hold the full choice of destination.
|
|
21
|
+
- [The rutter author guide](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide.md) and the rutter skill hold how a rule is written and a rutter started.
|
|
22
|
+
- [Bundled rutters](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutters.md) lists every rutter that ships with Periplus.
|
|
23
|
+
|
|
24
|
+
## Find the gaps
|
|
25
|
+
|
|
26
|
+
Run the steps in the project root, after `periplus map`. The report has two halves, resolution
|
|
27
|
+
gaps and detail gaps, and a third list apart from both, site faults.
|
|
28
|
+
|
|
29
|
+
1. Check the map and see what it holds. `periplus check-map` exits 0 on a valid map; fix any
|
|
30
|
+
fault it names before you read further. `periplus types` counts the node types and edge kinds.
|
|
31
|
+
2. List every node. Every id holds the text `::`, so `periplus find :: --limit 0 --format json`
|
|
32
|
+
prints all of them, each row with its id, type, state and first location. A row whose state
|
|
33
|
+
is `referenced` (a name seen, with nothing describing it) or `unresolved` (a rule looked and
|
|
34
|
+
failed) is where a missing rule shows, except an id step 4 prints under Site faults.
|
|
35
|
+
3. Read the rows the map skipped. `periplus map --format json` prints the map report; read its
|
|
36
|
+
`skipped` rows, each a file, line, rule and reason, for code a rule matched and could not use.
|
|
37
|
+
4. Print the report from the map file. The program below reads `.periplus/map.json` with the
|
|
38
|
+
standard library, so pass it that path: `python3 gap-read.py .periplus/map.json` after saving
|
|
39
|
+
the block as `gap-read.py`. Under Resolution gaps it prints the count of `referenced` nodes,
|
|
40
|
+
of `unresolved` nodes and of edges whose confidence is `inferred`, each followed by a
|
|
41
|
+
`first-party` split. A node is first-party when its state is `mapped` and it has a location,
|
|
42
|
+
so a `referenced` or `unresolved` node is always outside; for those two lists a
|
|
43
|
+
`reached from first-party` line counts the ones an edge from a first-party node reaches. The
|
|
44
|
+
map file holds no folder list, so read the folders `custom_module`, `custom_theme` and
|
|
45
|
+
`js_source` in `settings.yml` to tell which first-party files a gap sits in.
|
|
46
|
+
5. Open the file and line of each gap and read the code; a row whose location is null has none,
|
|
47
|
+
so `periplus affected ID` names the nodes whose edges reach it, and you read those. Skip
|
|
48
|
+
the ids printed under Site faults; they are site faults, not missing rules. Decide
|
|
49
|
+
whether a rule would resolve it: name the shape the rule would match and the node or edge it
|
|
50
|
+
would emit.
|
|
51
|
+
6. Open `.periplus/descriptions.yaml`, the file the map skill describes. Count every node id in the
|
|
52
|
+
step 2 list, whichever its state, with no descriptions entry under `nodes` as a description gap to fill; a file with no `nodes` key
|
|
53
|
+
holds zero entries.
|
|
54
|
+
|
|
55
|
+
<!-- nav-run -->
|
|
56
|
+
```
|
|
57
|
+
$ periplus check-map
|
|
58
|
+
$ periplus types
|
|
59
|
+
$ periplus find :: --limit 0 --format json
|
|
60
|
+
$ periplus map --format json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
<!-- gap-read -->
|
|
64
|
+
```python
|
|
65
|
+
import json
|
|
66
|
+
import sys
|
|
67
|
+
|
|
68
|
+
m = json.load(open(sys.argv[1]))
|
|
69
|
+
nodes = {n["id"]: n for n in m["nodes"]}
|
|
70
|
+
edges = m["edges"]
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
def name(i):
|
|
74
|
+
return i.split("::", 1)[1]
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
def module_of(ns):
|
|
78
|
+
p = ns.split("\\")
|
|
79
|
+
return p[1] if len(p) > 2 and p[0] == "Drupal" else None
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
def mapped(i):
|
|
83
|
+
return i in nodes and nodes[i]["state"] == "mapped"
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
def chain(c):
|
|
87
|
+
seen, todo = [], [c]
|
|
88
|
+
while todo:
|
|
89
|
+
x = todo.pop()
|
|
90
|
+
if x in seen:
|
|
91
|
+
continue
|
|
92
|
+
if not mapped(x):
|
|
93
|
+
return None
|
|
94
|
+
seen.append(x)
|
|
95
|
+
todo += [e["to"] for e in edges if e["kind"] in ("inherits", "mixes_in") and e["from"] == x]
|
|
96
|
+
return seen
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
def defines(c, meth):
|
|
100
|
+
return any(
|
|
101
|
+
e["kind"] == "contains" and e["from"] == c and name(e["to"]).split("::")[-1] == meth
|
|
102
|
+
and e["to"] in nodes and e["to"].startswith("php.method::")
|
|
103
|
+
for e in edges
|
|
104
|
+
)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
def fault(n):
|
|
108
|
+
t, nm = n["type"], name(n["id"])
|
|
109
|
+
if t == "php.method" and "::" in nm:
|
|
110
|
+
cls, meth = nm.rsplit("::", 1)
|
|
111
|
+
for c in (chain(k + "::" + cls) for k in ("php.type", "php.class")):
|
|
112
|
+
if c is not None:
|
|
113
|
+
enum = any(nodes[x]["type"] == "php.enum" for x in c)
|
|
114
|
+
if enum and meth in ("cases", "from", "tryFrom"):
|
|
115
|
+
return None
|
|
116
|
+
return None if any(defines(x, meth) for x in c) else "method no class defines"
|
|
117
|
+
return None
|
|
118
|
+
if t == "drupal.library":
|
|
119
|
+
k, kind = nm.split("/")[0], "library no libraries file defines"
|
|
120
|
+
elif n["id"].startswith("php.type::"):
|
|
121
|
+
k, kind = module_of(nm), "class no file holds"
|
|
122
|
+
else:
|
|
123
|
+
return None
|
|
124
|
+
return kind if k and mapped("drupal.module::" + k) else None
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
faults = {n["id"]: fault(n) for n in m["nodes"] if n["state"] in ("referenced", "unresolved")}
|
|
128
|
+
faults = {i: k for i, k in faults.items() if k}
|
|
129
|
+
gaps = [n for n in m["nodes"] if n["id"] not in faults]
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
def first_party(n):
|
|
133
|
+
return n["state"] == "mapped" and bool(n["locations"])
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
def split(found):
|
|
137
|
+
inside = sum(first_party(n) for n in found)
|
|
138
|
+
return f"first-party {inside} outside {len(found) - inside}"
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
reached = {e["to"] for e in edges if first_party(nodes[e["from"]])}
|
|
142
|
+
|
|
143
|
+
print("Resolution gaps")
|
|
144
|
+
lists = {
|
|
145
|
+
"referenced": [n for n in gaps if n["state"] == "referenced"],
|
|
146
|
+
"unresolved": [n for n in gaps if n["state"] == "unresolved"],
|
|
147
|
+
"inferred": [
|
|
148
|
+
nodes[e["from"]]
|
|
149
|
+
for e in edges
|
|
150
|
+
if any(p["confidence"] == "inferred" for p in e["provenance"])
|
|
151
|
+
],
|
|
152
|
+
}
|
|
153
|
+
for word, found in lists.items():
|
|
154
|
+
print(f"{word} {len(found)}")
|
|
155
|
+
print(split(found))
|
|
156
|
+
if word != "inferred":
|
|
157
|
+
print(f"reached from first-party {sum(n['id'] in reached for n in found)}")
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
def group(n):
|
|
161
|
+
if (n.get("provenance") or [{}])[0].get("rule") == "any_config_file":
|
|
162
|
+
return name(n["id"]).split(".")[0]
|
|
163
|
+
if n["type"] == "php.class":
|
|
164
|
+
return module_of(name(n["id"])) or "none"
|
|
165
|
+
return "-"
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
print("Detail gaps")
|
|
169
|
+
groups = {}
|
|
170
|
+
for n in gaps:
|
|
171
|
+
rule = (n.get("provenance") or [{}])[0].get("rule")
|
|
172
|
+
if rule:
|
|
173
|
+
groups.setdefault((rule, group(n)), []).append(n)
|
|
174
|
+
for (rule, d), found in sorted(groups.items()):
|
|
175
|
+
print(f"{rule} {d} {len(found)}")
|
|
176
|
+
print(split(found))
|
|
177
|
+
|
|
178
|
+
present = {}
|
|
179
|
+
for n in gaps:
|
|
180
|
+
present.setdefault(n["type"], []).append(n)
|
|
181
|
+
roots = {r["type"] for r in m["type_hierarchy"] if not r["parent"]}
|
|
182
|
+
children = {r["type"]: [] for r in m["type_hierarchy"]}
|
|
183
|
+
for r in m["type_hierarchy"]:
|
|
184
|
+
if r["parent"]:
|
|
185
|
+
children.setdefault(r["parent"], []).append(r["type"])
|
|
186
|
+
for parent in sorted(children):
|
|
187
|
+
if parent in roots or children[parent]:
|
|
188
|
+
for child in sorted(children[parent]) or ["none"]:
|
|
189
|
+
found = present.get(child, [])
|
|
190
|
+
print(f"{parent} {child} {len(found)}")
|
|
191
|
+
if found:
|
|
192
|
+
print(split(found))
|
|
193
|
+
own = {}
|
|
194
|
+
for n in present.get(parent, []) if children[parent] else []:
|
|
195
|
+
own.setdefault(group(n), []).append(n)
|
|
196
|
+
for d, found in sorted(own.items()):
|
|
197
|
+
print(f"{parent} own {d} {len(found)}")
|
|
198
|
+
print(split(found))
|
|
199
|
+
|
|
200
|
+
group_of = {}
|
|
201
|
+
for n in gaps:
|
|
202
|
+
if n["state"] == "referenced" and n["type"] == "drupal.module":
|
|
203
|
+
group_of[n["id"]] = name(n["id"])
|
|
204
|
+
elif n["state"] == "referenced" and n["id"].startswith("php.type::"):
|
|
205
|
+
group_of[n["id"]] = module_of(name(n["id"]))
|
|
206
|
+
leaning = {g: set() for g in group_of.values() if g}
|
|
207
|
+
for e in edges:
|
|
208
|
+
g = group_of.get(e["to"])
|
|
209
|
+
if g and mapped(e["from"]):
|
|
210
|
+
leaning[g].add(e["from"])
|
|
211
|
+
names = [p["pack"] for p in m["packs"]]
|
|
212
|
+
for g in sorted(leaning, key=lambda g: (-len(leaning[g]), g)):
|
|
213
|
+
pack = next((p for p in names if p == g or p.startswith(g + "_")), "none")
|
|
214
|
+
print(f"{g} {len(leaning[g])} rutter: {pack}")
|
|
215
|
+
|
|
216
|
+
print("Site faults")
|
|
217
|
+
first = {}
|
|
218
|
+
for e in edges:
|
|
219
|
+
first.setdefault(e["to"], (e["locations"] or [{}])[0])
|
|
220
|
+
for i in sorted(faults):
|
|
221
|
+
where = first.get(i, {})
|
|
222
|
+
print(f"{i} {where.get('file', '-')}:{where.get('line', 0)} {faults[i]}")
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## Detail gaps
|
|
226
|
+
|
|
227
|
+
The second half of the report says what a sibling rutter would add, from the map file alone.
|
|
228
|
+
Read the Detail gaps lines in three groups. Under each rule line and each child-type line with
|
|
229
|
+
nodes, a `first-party <n> outside <n>` line splits its nodes as the Resolution gaps lines do.
|
|
230
|
+
|
|
231
|
+
- A rule line, `<rule> <discriminator> <count>`, counts the nodes one rule made. A catch-all rule
|
|
232
|
+
hides what it made, so its nodes are split by a discriminator: for `any_config_file` the config
|
|
233
|
+
prefix, the id text after `drupal.config::` up to the first dot; for a rule that makes
|
|
234
|
+
`php.class` nodes the module in the namespace `Drupal\<module>\...`, or `none`; for every other
|
|
235
|
+
rule there is none, printed as `-`. The map file holds no annotation name, so a plugin class
|
|
236
|
+
splits by its module, not its annotation; record the missing annotation name as a finding for
|
|
237
|
+
the engine.
|
|
238
|
+
- A child-type line, `<parent> <child> <count>`, shows for each parent type the child types the
|
|
239
|
+
map holds and how many nodes each has; a parent with no child prints the word `none` and 0. A
|
|
240
|
+
parent with children also prints `<parent> own <discriminator> <count>` for the nodes left on the
|
|
241
|
+
parent itself, grouped by the rule line's discriminator: a group no child type took. That is the
|
|
242
|
+
room a sibling rutter would fill.
|
|
243
|
+
- A module line, `<module> <count> rutter: <pack>`, groups the referenced `drupal.module` nodes
|
|
244
|
+
and the referenced `php.type` nodes by module, all outside the mapped code, counts the distinct
|
|
245
|
+
mapped nodes that lean on it, and names the first pack in the map file's `packs` list that covers it, or `none`. Highest first:
|
|
246
|
+
a module with a large count and no rutter is the next rutter to write. `periplus status` lists
|
|
247
|
+
the packs on disk.
|
|
248
|
+
|
|
249
|
+
## Site faults
|
|
250
|
+
|
|
251
|
+
A site fault is a name the map was right about and the site has wrong. It prints as
|
|
252
|
+
`<id> <file>:<line> <kind>`, with the file and line of the first edge that reaches it. Fix the
|
|
253
|
+
site, not the rules; no site fault needs a rule. The program prints three kinds, each only when the
|
|
254
|
+
place that should define the name is itself in the mapped code.
|
|
255
|
+
|
|
256
|
+
- `method no class defines`: a method called on a mapped class where the class, every class it
|
|
257
|
+
inherits from and every trait it mixes in are mapped, and none contains a method of that name.
|
|
258
|
+
The methods PHP builds into every enum, `cases`, `from` and `tryFrom`, are never a fault.
|
|
259
|
+
- `library no libraries file defines`: a library attached whose module is mapped and whose libraries
|
|
260
|
+
file has no such library.
|
|
261
|
+
- `class no file holds`: a class named under `Drupal\<module>\` whose module is mapped and which no
|
|
262
|
+
file holds.
|
|
263
|
+
|
|
264
|
+
When a class or trait in the chain is referenced, outside the mapped code, the name stays a resolution gap:
|
|
265
|
+
the missing rule is the PHP rutter's, never a site fault.
|
|
266
|
+
|
|
267
|
+
## Where a rule belongs
|
|
268
|
+
|
|
269
|
+
Write the rule in the project's own rutter first: a rutter folder in the project's
|
|
270
|
+
`.periplus/packs`. When any other project on the stack could use it, move it to the bundled
|
|
271
|
+
rutter for that stack, as a new rule file or a rule added to one, once a second project needs it.
|
|
272
|
+
When no bundled rutter covers the stack at all, start a new rutter with the rutter skill, then
|
|
273
|
+
write the rule in it.
|
|
274
|
+
A gap is the engine's when the engine refuses the rule you wrote and no other rule can state the
|
|
275
|
+
shape. The test and the message to quote are in
|
|
276
|
+
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.4.2/docs/map-report-guide.md#when-a-gap-is-the-engines).
|
|
277
|
+
|
|
278
|
+
## Run it again
|
|
279
|
+
|
|
280
|
+
Every rule changes the list. After you write a rule and run `periplus map`, run these steps again
|
|
281
|
+
and read the report anew: a gap the rule closed leaves it, and a gap the rule exposed joins it.
|
|
282
|
+
Stop when the report holds only gaps no rule of yours can close.
|
|
@@ -25,7 +25,7 @@ Run `periplus map` first. Then pick the one command that answers the question.
|
|
|
25
25
|
| Which ids match a name? | `periplus find TEXT` |
|
|
26
26
|
| Which kinds of node and edge does the map hold? | `periplus types` |
|
|
27
27
|
|
|
28
|
-
Each command's options, output and exit codes are in [Navigation](https://github.com/camoa/periplus/blob/v0.4.
|
|
28
|
+
Each command's options, output and exit codes are in [Navigation](https://github.com/camoa/periplus/blob/v0.4.2/docs/navigation.md). Take an id from
|
|
29
29
|
`periplus find` before passing it to the other commands. On the project in the Navigation
|
|
30
30
|
guide's worked example, these run as shown:
|
|
31
31
|
|
|
@@ -18,17 +18,17 @@ description: Write or change a Periplus rutter, the pack of data that tells Peri
|
|
|
18
18
|
This skill gives the steps. Each rule shape, and what the format cannot say, is in the rutter
|
|
19
19
|
author guides; read the section the step names instead of guessing a key:
|
|
20
20
|
|
|
21
|
-
- [Rutter author guide](https://github.com/camoa/periplus/blob/v0.4.
|
|
22
|
-
- [Rutter author guide: text](https://github.com/camoa/periplus/blob/v0.4.
|
|
23
|
-
- [Rutter author guide: abilities](https://github.com/camoa/periplus/blob/v0.4.
|
|
24
|
-
- [Rutter author guide: references](https://github.com/camoa/periplus/blob/v0.4.
|
|
25
|
-
- [Rutter author guide: imports](https://github.com/camoa/periplus/blob/v0.4.
|
|
26
|
-
- [Rutter author guide: map rules](https://github.com/camoa/periplus/blob/v0.4.
|
|
27
|
-
- [Rutter author guide: Drupal](https://github.com/camoa/periplus/blob/v0.4.
|
|
21
|
+
- [Rutter author guide](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide.md): the files of a rutter, one rule of each shape, how to check a rutter.
|
|
22
|
+
- [Rutter author guide: text](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-text.md): text spans, nested regions of a text file.
|
|
23
|
+
- [Rutter author guide: abilities](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-abilities.md): a call's class and method in one rule, id patterns.
|
|
24
|
+
- [Rutter author guide: references](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-references.md): reference rules on a parse tree, and the keys the engine does not run.
|
|
25
|
+
- [Rutter author guide: imports](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-imports.md): imports and bindings.
|
|
26
|
+
- [Rutter author guide: map rules](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-map-rules.md): map rules, which join what earlier passes found.
|
|
27
|
+
- [Rutter author guide: Drupal](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutter-author-guide-drupal.md): the PHP and Drupal rutters, read as worked examples.
|
|
28
28
|
|
|
29
|
-
[Bundled rutters](https://github.com/camoa/periplus/blob/v0.4.
|
|
29
|
+
[Bundled rutters](https://github.com/camoa/periplus/blob/v0.4.2/docs/rutters.md) lists every rutter that ships with Periplus.
|
|
30
30
|
|
|
31
|
-
The [README](https://github.com/camoa/periplus/blob/v0.4.
|
|
31
|
+
The [README](https://github.com/camoa/periplus/blob/v0.4.2/README.md) section "Write a rutter" and [CONTRIBUTING](https://github.com/camoa/periplus/blob/v0.4.2/CONTRIBUTING.md) give the loop: write the rutter in the
|
|
32
32
|
project's own `.periplus/packs` first, and map that project until the map holds what the code holds.
|
|
33
33
|
|
|
34
34
|
## Write a rule
|
|
@@ -45,7 +45,7 @@ project's own `.periplus/packs` first, and map that project until the map holds
|
|
|
45
45
|
confidence: the first is `declared`, the second `inferred`.
|
|
46
46
|
|
|
47
47
|
The example adds a rule file to `python_text` in a project that already holds the
|
|
48
|
-
[second-stack example](https://github.com/camoa/periplus/blob/v0.4.
|
|
48
|
+
[second-stack example](https://github.com/camoa/periplus/blob/v0.4.2/examples/second-stack) rutters. A module-level name in capitals is a constant only by convention,
|
|
49
49
|
so the rule is `inferred`:
|
|
50
50
|
|
|
51
51
|
<!-- example write-rule: .periplus/packs/python_text@0.1.0/rules/constants.yaml -->
|
|
@@ -171,6 +171,7 @@ packs:
|
|
|
171
171
|
```yaml
|
|
172
172
|
name: billing
|
|
173
173
|
image: billing:1.4
|
|
174
|
+
stack: shop
|
|
174
175
|
```
|
|
175
176
|
|
|
176
177
|
<!-- example custom-rutter: .periplus/packs/app_config@0.1.0/pack.yaml -->
|
|
@@ -187,6 +188,10 @@ folders:
|
|
|
187
188
|
node_types:
|
|
188
189
|
- name: app.service
|
|
189
190
|
id_namespace: app.service
|
|
191
|
+
edge_kinds:
|
|
192
|
+
- kind: part_of
|
|
193
|
+
from: app.service
|
|
194
|
+
to: app.service
|
|
190
195
|
rules:
|
|
191
196
|
- rule: service
|
|
192
197
|
reads: file
|
|
@@ -197,6 +202,13 @@ rules:
|
|
|
197
202
|
- node: {type: app.service}
|
|
198
203
|
- attribute: {name: image, from: {key: image}}
|
|
199
204
|
confidence: declared
|
|
205
|
+
- rule: service_in_stack
|
|
206
|
+
reads: file
|
|
207
|
+
in: [app_config]
|
|
208
|
+
match: {file: services, filetype: yaml}
|
|
209
|
+
id: {from: file_stem}
|
|
210
|
+
emits: [{edge: {kind: part_of, from: this_node, to: {from: {key: stack}}}}]
|
|
211
|
+
confidence: declared
|
|
200
212
|
```
|
|
201
213
|
|
|
202
214
|
Check the custom rutter, then map; the node's provenance names `app_config`:
|
|
@@ -206,3 +218,128 @@ Check the custom rutter, then map; the node's provenance names `app_config`:
|
|
|
206
218
|
$ periplus validate app_config
|
|
207
219
|
$ periplus map
|
|
208
220
|
```
|
|
221
|
+
|
|
222
|
+
## Measure what the rule added
|
|
223
|
+
|
|
224
|
+
Report what a rule added as numbers read from two maps, never as a number predicted from the rows
|
|
225
|
+
the rule would match. A prediction counts every row the rule fires on; a correct edge may already
|
|
226
|
+
sit beside each false one, so the map can gain far fewer edges than the rule fires on.
|
|
227
|
+
|
|
228
|
+
1. Keep a copy of the map before the rule. Copy `.periplus/map.json` to a path outside the project:
|
|
229
|
+
the folder you name or, by default, the system temp folder under a `periplus` subfolder named
|
|
230
|
+
after the project folder. Say the path after you write it.
|
|
231
|
+
|
|
232
|
+
```console
|
|
233
|
+
$ mkdir -p /tmp/periplus/<project-folder> && cp .periplus/map.json /tmp/periplus/<project-folder>/before.json
|
|
234
|
+
```
|
|
235
|
+
2. Write or change the rule, check it with `periplus validate`, and run `periplus map`.
|
|
236
|
+
3. Run the block with the copy as `sys.argv[1]`, the live `.periplus/map.json` as `sys.argv[2]`
|
|
237
|
+
and, to list what one rule made, `<pack>/<rule>` as `sys.argv[3]`. It prints `Measured`, one
|
|
238
|
+
line per changed count of `counts.nodes_by_state`, `counts.nodes_by_type` and
|
|
239
|
+
`counts.edges_by_kind`, the nodes and edges added, and with a rule the nodes and edges whose
|
|
240
|
+
provenance names it.
|
|
241
|
+
|
|
242
|
+
Save the gap-read block below to a file, such as `/tmp/periplus/<project-folder>/gap_read.py`,
|
|
243
|
+
then run it with the two map paths and the optional rule:
|
|
244
|
+
|
|
245
|
+
```console
|
|
246
|
+
$ python3 /tmp/periplus/<project-folder>/gap_read.py /tmp/periplus/<project-folder>/before.json .periplus/map.json [<pack>/<rule>]
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Read bundled rules through `periplus status` (the pack roots and the matched rutters with paths)
|
|
250
|
+
and `periplus spec <pack>`, never through a repository path.
|
|
251
|
+
The block below does not copy the map: make the step 1 copy first, or `periplus map` overwrites
|
|
252
|
+
the before map.
|
|
253
|
+
|
|
254
|
+
<!-- nav-run -->
|
|
255
|
+
```console
|
|
256
|
+
$ periplus status
|
|
257
|
+
$ periplus spec python_text
|
|
258
|
+
$ periplus map
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
<!-- gap-read -->
|
|
262
|
+
```python
|
|
263
|
+
import json
|
|
264
|
+
import sys
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
def load(path):
|
|
268
|
+
with open(path, encoding="utf-8") as handle:
|
|
269
|
+
return json.load(handle)
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
def provs(item):
|
|
273
|
+
value = item.get("provenance") or []
|
|
274
|
+
return value if isinstance(value, list) else [value]
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
before, after = load(sys.argv[1]), load(sys.argv[2])
|
|
278
|
+
rule = sys.argv[3] if len(sys.argv) > 3 else None
|
|
279
|
+
print("Measured")
|
|
280
|
+
for group, key in (
|
|
281
|
+
("state", "nodes_by_state"),
|
|
282
|
+
("type", "nodes_by_type"),
|
|
283
|
+
("kind", "edges_by_kind"),
|
|
284
|
+
):
|
|
285
|
+
was, now = before["counts"].get(key, {}), after["counts"].get(key, {})
|
|
286
|
+
for name in sorted(set(was) | set(now)):
|
|
287
|
+
a, b = was.get(name, 0), now.get(name, 0)
|
|
288
|
+
if a != b:
|
|
289
|
+
print(f"{group} {name} {a} {b} {b - a:+d}")
|
|
290
|
+
old_nodes = {n["id"] for n in before["nodes"]}
|
|
291
|
+
old_edges = {(e["from"], e["kind"], e["to"]) for e in before["edges"]}
|
|
292
|
+
print("added nodes ", len([n for n in after["nodes"] if n["id"] not in old_nodes]))
|
|
293
|
+
print("added edges ", len([e for e in after["edges"] if (e["from"], e["kind"], e["to"]) not in old_edges]))
|
|
294
|
+
if rule:
|
|
295
|
+
pack, _, name = rule.partition("/")
|
|
296
|
+
|
|
297
|
+
def named(item):
|
|
298
|
+
return any(p.get("pack") == pack and p.get("rule") == name for p in provs(item))
|
|
299
|
+
|
|
300
|
+
for node_id in sorted(n["id"] for n in after["nodes"] if named(n)):
|
|
301
|
+
print(f"node {node_id}")
|
|
302
|
+
for row in sorted((e["from"], e["kind"], e["to"]) for e in after["edges"] if named(e)):
|
|
303
|
+
print("edge " + " ".join(row))
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## Offer the next rule
|
|
307
|
+
|
|
308
|
+
After the measurement, read what is left and offer one rule per turn until the person says stop or
|
|
309
|
+
the gap is accepted.
|
|
310
|
+
|
|
311
|
+
1. Run `periplus map --format json` and read `skipped` for the rows whose `rule` names the new
|
|
312
|
+
rule: each is a match the rule could not turn into a node or edge, with its reason.
|
|
313
|
+
2. Read the `edge <from> <kind> <to>` lines of the measurement. Run
|
|
314
|
+
`periplus find :: --limit 0 --format json` and look up the `to` ids there: the referenced and
|
|
315
|
+
unresolved nodes the new edges end on are what the next rule has to define.
|
|
316
|
+
3. Offer one next rule from those rows, in plain words, and write it only when the person agrees.
|
|
317
|
+
|
|
318
|
+
<!-- nav-run -->
|
|
319
|
+
```console
|
|
320
|
+
$ periplus map --format json
|
|
321
|
+
$ periplus find :: --limit 0 --format json
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
## Stop with an accepted unknown
|
|
325
|
+
|
|
326
|
+
The loop stops on the person's word, or on an entry under `accepted_unknowns` in
|
|
327
|
+
`.periplus/settings.yml`. An entry holds `id`, `rule`, `reason`, `accepted_by` and `accepted_on`;
|
|
328
|
+
the commented stub in the settings file shows the shape. Name the entry as the stop, add it only
|
|
329
|
+
when the person accepts the gap, and offer no further rule for it.
|
|
330
|
+
|
|
331
|
+
## Draft the upstream issue
|
|
332
|
+
|
|
333
|
+
When `periplus validate` or `periplus map` refuses a shape with a message, or a bundled rule made a
|
|
334
|
+
wrong node or edge (its provenance names the bundled rutter), the fix belongs in the bundled
|
|
335
|
+
rutter, not in the project's rutter. Never work around a bundled rule's defect inside the project
|
|
336
|
+
rutter. The same draft serves a rule any project on the stack could use, as a contribution.
|
|
337
|
+
|
|
338
|
+
Write the draft to a file outside the project, in the scratch folder from the measurement, and
|
|
339
|
+
say the path. Never file the issue. Five parts, in this order:
|
|
340
|
+
|
|
341
|
+
1. The rule name and the rutter version, from the `packs` list of the map file.
|
|
342
|
+
2. One minimal example of the shape, written fresh. Quote no site file.
|
|
343
|
+
3. The measured counts, from the measurement.
|
|
344
|
+
4. The engine message, verbatim.
|
|
345
|
+
5. A link to [When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.4.2/docs/map-report-guide.md#when-a-gap-is-the-engines).
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: periplus-gaps
|
|
3
|
-
description: Read a Periplus map and the code behind it, list what the map lacks, and say for each gap whether it needs a new rule or a new rutter, and where that rule belongs.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Find the gaps in a map
|
|
7
|
-
|
|
8
|
-
## Standing rules
|
|
9
|
-
|
|
10
|
-
1. Rules are small and add to each other: split by rule file inside one rutter, never by adding rutters.
|
|
11
|
-
2. A rutter reads its stack in passes by depth: structure first, then one layer inside each class, then joins in the map.
|
|
12
|
-
3. There is no stack knowledge in the engine; a stack's shape is a rule in a rutter.
|
|
13
|
-
4. Write the rule and run it: probe before saying a rutter cannot, and quote the engine's message.
|
|
14
|
-
5. A rutter meant for others never names the project it was built on, in its code, rules, examples or prose.
|
|
15
|
-
|
|
16
|
-
## Where the detail lives
|
|
17
|
-
|
|
18
|
-
- [Navigation](https://github.com/camoa/periplus/blob/v0.4.1/docs/navigation.md) holds the signature, output rows and exit codes of each command used here.
|
|
19
|
-
- [Where a rule belongs](https://github.com/camoa/periplus/blob/v0.4.1/docs/map-report-guide.md#where-a-rule-belongs) and
|
|
20
|
-
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.4.1/docs/map-report-guide.md#when-a-gap-is-the-engines) hold the full choice of destination.
|
|
21
|
-
- [The rutter author guide](https://github.com/camoa/periplus/blob/v0.4.1/docs/rutter-author-guide.md) and the rutter skill hold how a rule is written and a rutter started.
|
|
22
|
-
- [Bundled rutters](https://github.com/camoa/periplus/blob/v0.4.1/docs/rutters.md) lists every rutter that ships with Periplus.
|
|
23
|
-
|
|
24
|
-
## Find the gaps
|
|
25
|
-
|
|
26
|
-
Run the steps in the project root, after `periplus map`.
|
|
27
|
-
|
|
28
|
-
1. Check the map and see what it holds. `periplus check-map` exits 0 on a valid map; fix any
|
|
29
|
-
fault it names before you read further. `periplus types` counts the node types and edge kinds.
|
|
30
|
-
2. List every node. Every id holds the text `::`, so `periplus find :: --limit 0 --format json`
|
|
31
|
-
prints all of them, each row with its id, type, state and first location. Keep the rows whose
|
|
32
|
-
state is `referenced` (a name seen, with nothing describing it) or `unresolved` (a rule looked
|
|
33
|
-
and failed). That is where a missing rule shows.
|
|
34
|
-
3. Open the file and line of each kept row and read the code; a row whose location is null has
|
|
35
|
-
none, so `periplus affected ID` names the nodes whose edges reach it, and you read those. Decide whether a rule would resolve
|
|
36
|
-
it: name the shape the rule would match and the node or edge it would emit.
|
|
37
|
-
4. Open `.periplus/descriptions.yaml`, the file the map skill describes. Count every node id in the
|
|
38
|
-
step 2 list, whichever its state, with no descriptions entry under `nodes` as a description gap to fill; a file with no `nodes` key
|
|
39
|
-
holds zero entries.
|
|
40
|
-
|
|
41
|
-
<!-- nav-run -->
|
|
42
|
-
```
|
|
43
|
-
$ periplus check-map
|
|
44
|
-
$ periplus types
|
|
45
|
-
$ periplus find :: --limit 0 --format json
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Where a rule belongs
|
|
49
|
-
|
|
50
|
-
Write the rule in the project's own rutter first: a rutter folder in the project's
|
|
51
|
-
`.periplus/packs`. When any other project on the stack could use it, move it to the bundled
|
|
52
|
-
rutter for that stack, as a new rule file or a rule added to one, once a second project needs it.
|
|
53
|
-
When no bundled rutter covers the stack at all, start a new rutter with the rutter skill, then
|
|
54
|
-
write the rule in it.
|
|
55
|
-
A gap is the engine's when the engine refuses the rule you wrote and no other rule can state the
|
|
56
|
-
shape. The test and the message to quote are in
|
|
57
|
-
[When a gap is the engine's](https://github.com/camoa/periplus/blob/v0.4.1/docs/map-report-guide.md#when-a-gap-is-the-engines).
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|