shojiku 0.1.0

data/lib/shojiku.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "shojiku/version"
+require_relative "shojiku/errors"
+require_relative "shojiku/env"
+require_relative "shojiku/log"
+require_relative "shojiku/library"
+require_relative "shojiku/engine"
+require_relative "shojiku/diagnostic"
+require_relative "shojiku/failure"
+require_relative "shojiku/result"
+require_relative "shojiku/verification_report"
+require_relative "shojiku/artifact"
+require_relative "shojiku/local_pem"
+require_relative "shojiku/lockdown"
+require_relative "shojiku/sources"
+require_relative "shojiku/template_root"
+require_relative "shojiku/request"
+require_relative "shojiku/outcome"
+require_relative "shojiku/config"
+require_relative "shojiku/settings"
+require_relative "shojiku/client"
+
+# Shojiku for Ruby — a template plus your data, deterministically, as a PDF.
+#
+# ```ruby
+# client = Shojiku::Client.new(templates: "app/templates")
+# result = client.generate("receipt_ja", customer: { name: "Yamada Shoji K.K." })
+# result.artifact.write("receipt.pdf") if result.success?
+# ```
+#
+# Three things about this gem are worth knowing before reading any of it.
+#
+# **Results, not exceptions.** No lifecycle operation raises in the normal
+# flow. What raises is programmer misuse ({UsageError}) and an environment
+# with no engine in it ({LibraryNotFound}).
+#
+# **Nothing here reimplements the engine.** Layout, formatting and PDF
+# construction all happen in the shared C library this gem loads, so the same
+# params produce the same bytes here, in the CLI, in the Designer and in the
+# other six SDKs. A missing capability is missing in the engine and gets added
+# there.
+#
+# **Nothing here downloads anything**, at install time or at run time. The
+# platform gem carries the binary; otherwise you point `SHOJIKU_LIBRARY` at
+# one you built. Sources an application fetched itself go to
+# {Client#generate_source} — fetching is the application's act, and a
+# deployment that wants to forbid even that declares `strict:` (see
+# {Lockdown}).
+module Shojiku
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: shojiku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kengos
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: |
+  Ruby bindings for Shojiku, a document engine for invoices, receipts and
+  slips. A YAML template plus JSON or YAML params in, a deterministic PDF
+  out, with signing and verification over the result. The layout engine is a
+  shared C library loaded through fiddle, so the same params produce the same
+  bytes here as in the CLI and every other Shojiku SDK.
+email:
+- kengo@kengos.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shojiku.rb
+- lib/shojiku/artifact.rb
+- lib/shojiku/client.rb
+- lib/shojiku/config.rb
+- lib/shojiku/diagnostic.rb
+- lib/shojiku/engine.rb
+- lib/shojiku/env.rb
+- lib/shojiku/errors.rb
+- lib/shojiku/failure.rb
+- lib/shojiku/library.rb
+- lib/shojiku/local_pem.rb
+- lib/shojiku/lockdown.rb
+- lib/shojiku/log.rb
+- lib/shojiku/outcome.rb
+- lib/shojiku/request.rb
+- lib/shojiku/result.rb
+- lib/shojiku/settings.rb
+- lib/shojiku/sources.rb
+- lib/shojiku/template_root.rb
+- lib/shojiku/verification_report.rb
+- lib/shojiku/version.rb
+homepage: https://github.com/kengos/shojiku
+licenses:
+- MIT
+- Apache-2.0
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/kengos/shojiku
+  source_code_uri: https://github.com/kengos/shojiku/tree/main/sdk/ruby
+  documentation_uri: https://github.com/kengos/shojiku/blob/main/docs/engine/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Deterministic PDF documents from a YAML template plus your data
+test_files: []