moku6 0.1.0

data/sig/generated/moku6/rules/visibility_rule.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/moku6/rules/visibility_rule.rb with RBS::Inline
+
+module Moku6
+  module Rules
+    class VisibilityRule < BaseRule
+      # : (Event event) -> Array[Offense]
+      def check: (Event event) -> Array[Offense]
+    end
+  end
+end

data/sig/generated/moku6/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/moku6/version.rb with RBS::Inline
+
+module Moku6
+  VERSION: String
+end

data/sig/generated/moku6.rbs

@@ -0,0 +1,9 @@
+# Generated from lib/moku6.rb with RBS::Inline
+
+module Moku6
+  class Error < StandardError
+  end
+
+  class UsageError < Error
+  end
+end

data/sig/manual/dependencies.rbs

@@ -0,0 +1,13 @@
+# Hand-written supplements for third-party gems and stdlib gaps.
+
+# senko's bundled RBS is not wired into this project's signature load path.
+Senko: untyped
+
+# YAML is an alias of Psych; both safe_load_file and SyntaxError are missing
+# from the bundled stdlib RBS.
+module Psych
+  def self.safe_load_file: (untyped path, ?permitted_classes: untyped, ?permitted_symbols: untyped, ?aliases: untyped, **untyped) -> untyped
+
+  class SyntaxError < ::StandardError
+  end
+end

data/sig/manual/offense.rbs

@@ -0,0 +1,13 @@
+# Hand-written: Offense is a Struct, which rbs-inline cannot type precisely.
+module Moku6
+  class Offense
+    attr_accessor rule: String?
+    attr_accessor severity: Symbol
+    attr_accessor action: String?
+    attr_accessor file: String?
+    attr_accessor message: String?
+
+    def initialize: (?rule: String?, ?severity: Symbol, ?action: String?, ?file: String?, ?message: String?) -> void
+    def to_h: () -> Hash[Symbol, untyped]
+  end
+end

data/templates/init/.moku6.yml

@@ -0,0 +1,18 @@
+catalog_dir: catalog
+output_dir: generated
+
+naming:
+  # Allowed action pattern (default: namespace.verb)
+  pattern: '^[a-z0-9_]+(\.[a-z0-9_]+)+$'
+
+rules:
+  strict: false            # treat warnings as errors when true
+  warn_pii_field_names: true
+
+generators:
+  docs: { out: generated/docs/audit-events.md }
+  json_schema: { out: generated/schema }
+  typescript: { out: generated/typescript/audit-events.ts }
+  ruby: { out: generated/ruby/audit_events.rb }
+  bigquery: { out: generated/bigquery/audit_events.sql }
+  examples: { out: examples/generated }

data/templates/init/catalog/employee.updated.yaml

@@ -0,0 +1,36 @@
+action: employee.updated
+label: Employee updated
+description: Recorded when an employee's basic information is updated
+
+category: employee
+required: true
+
+actor:
+  required: true
+
+target:
+  type: employee
+  required: true
+
+fields:
+  employee_id:
+    type: string
+    required: true
+    description: ID of the updated employee
+  changed_fields:
+    type: array
+    required: true
+    description: List of changed field names
+
+privacy:
+  contains_personal_data: true
+  masked_fields:
+    - before.email
+    - after.email
+
+visibility:
+  customer_visible: true
+  internal_only: false
+
+retention:
+  years: 5

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: moku6
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: senko
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: moku6 is not another audit log storage library. It helps teams define
+  what should be recorded as audit events, how each event should be shaped, which
+  fields are required, whether personal data must be hidden, and whether the event
+  can be shown to customers.
+email:
+- t.yudai92@gmail.com
+executables:
+- moku6
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/moku6
+- lib/moku6.rb
+- lib/moku6/catalog.rb
+- lib/moku6/cli.rb
+- lib/moku6/config.rb
+- lib/moku6/differ.rb
+- lib/moku6/envelope_schema.rb
+- lib/moku6/event.rb
+- lib/moku6/generate.rb
+- lib/moku6/generators.rb
+- lib/moku6/generators/base_generator.rb
+- lib/moku6/generators/bigquery_generator.rb
+- lib/moku6/generators/cloud_events_generator.rb
+- lib/moku6/generators/docs_generator.rb
+- lib/moku6/generators/event_catalog_generator.rb
+- lib/moku6/generators/example_generator.rb
+- lib/moku6/generators/json_schema_generator.rb
+- lib/moku6/generators/open_api_generator.rb
+- lib/moku6/generators/outbox_generator.rb
+- lib/moku6/generators/rails_generator.rb
+- lib/moku6/generators/ruby_generator.rb
+- lib/moku6/generators/typescript_generator.rb
+- lib/moku6/initializer.rb
+- lib/moku6/linter.rb
+- lib/moku6/loader.rb
+- lib/moku6/offense.rb
+- lib/moku6/reporter.rb
+- lib/moku6/result.rb
+- lib/moku6/rules/action_naming_rule.rb
+- lib/moku6/rules/base_rule.rb
+- lib/moku6/rules/example_consistency_rule.rb
+- lib/moku6/rules/label_description_rule.rb
+- lib/moku6/rules/pii_field_name_heuristic_rule.rb
+- lib/moku6/rules/privacy_masking_rule.rb
+- lib/moku6/rules/retention_rule.rb
+- lib/moku6/rules/schema_rule.rb
+- lib/moku6/rules/uniqueness_rule.rb
+- lib/moku6/rules/visibility_rule.rb
+- lib/moku6/version.rb
+- schemas/audit-event.schema.json
+- sig/generated/moku6.rbs
+- sig/generated/moku6/catalog.rbs
+- sig/generated/moku6/config.rbs
+- sig/generated/moku6/differ.rbs
+- sig/generated/moku6/envelope_schema.rbs
+- sig/generated/moku6/event.rbs
+- sig/generated/moku6/generators.rbs
+- sig/generated/moku6/generators/base_generator.rbs
+- sig/generated/moku6/generators/bigquery_generator.rbs
+- sig/generated/moku6/generators/cloud_events_generator.rbs
+- sig/generated/moku6/generators/docs_generator.rbs
+- sig/generated/moku6/generators/event_catalog_generator.rbs
+- sig/generated/moku6/generators/example_generator.rbs
+- sig/generated/moku6/generators/json_schema_generator.rbs
+- sig/generated/moku6/generators/open_api_generator.rbs
+- sig/generated/moku6/generators/outbox_generator.rbs
+- sig/generated/moku6/generators/rails_generator.rbs
+- sig/generated/moku6/generators/ruby_generator.rbs
+- sig/generated/moku6/generators/typescript_generator.rbs
+- sig/generated/moku6/initializer.rbs
+- sig/generated/moku6/linter.rbs
+- sig/generated/moku6/loader.rbs
+- sig/generated/moku6/reporter.rbs
+- sig/generated/moku6/result.rbs
+- sig/generated/moku6/rules/action_naming_rule.rbs
+- sig/generated/moku6/rules/base_rule.rbs
+- sig/generated/moku6/rules/example_consistency_rule.rbs
+- sig/generated/moku6/rules/label_description_rule.rbs
+- sig/generated/moku6/rules/pii_field_name_heuristic_rule.rbs
+- sig/generated/moku6/rules/privacy_masking_rule.rbs
+- sig/generated/moku6/rules/retention_rule.rbs
+- sig/generated/moku6/rules/schema_rule.rbs
+- sig/generated/moku6/rules/uniqueness_rule.rbs
+- sig/generated/moku6/rules/visibility_rule.rbs
+- sig/generated/moku6/version.rbs
+- sig/manual/dependencies.rbs
+- sig/manual/offense.rbs
+- templates/init/.moku6.yml
+- templates/init/catalog/employee.updated.yaml
+homepage: https://github.com/ydah/moku6
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ydah/moku6
+  source_code_uri: https://github.com/ydah/moku6
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Define, lint, and document business-level audit events.
+test_files: []