reports_web 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cce3c314a64cb98332c0bd5f20ee01090efcb661fec493cd956200fec8ca554e
+  data.tar.gz: 56a79b610b2312d3b830276daca73404ccec9b6c776f40c9db953fe9dd6cc875
+SHA512:
+  metadata.gz: 17ca2e2979d7c46b2ae716a4fd048113bbf5d307098fd7304120b1c892a408052b9d7f636c96015d5b9a784090d28c29ff6434611cb79a64e7ec14fb92ad7d63
+  data.tar.gz: a7c0cf4f546619cdb3f19c2e2a56c82fc93ba197e3e3c19fce540965cef75576eb45363db74fa2a1e92ddd86c797a815ae33e7f10a3de436c4651a9fd4690b63

data/LICENSE.md

@@ -0,0 +1,22 @@
+# Reports.Web License / 使用許諾
+
+Copyright (c) Pao@Office. All rights reserved.
+
+This package is part of **Reports.Web**, a commercial product of Pao@Office.
+Use of this package is governed by the Reports.Web End User License Agreement:
+
+- 使用許諾（正式な条件）: https://www.pao.ac/reports.web/manual/index.html#16
+- 製品サイト: https://www.pao.ac/reports.web/
+- ご購入・お見積もり: https://www.pao.ac/reports.web/buy.html
+
+## 要点 / Summary
+
+- **体験版 / Trial** — 出力される帳票には赤い「SAMPLE」の印が付きます。購入前の評価に、無償でお使いいただけます。
+  Output carries a red "SAMPLE" mark. You may evaluate it free of charge before purchase.
+- **製品版 / Product** — ご購入時に納品するライセンスファイルを Reports.Web エンジンに設定すると、「SAMPLE」の印が消えます。
+  Configure the license file delivered on purchase in the Reports.Web engine to remove the mark.
+- **ライセンスの数え方 / Licensing** — 開発用パソコン 1 台につき 1 開発ライセンスです。運用専用のサーバーやエンドユーザーのパソコンには不要です（ランタイムライセンスフリー）。
+  One development license per development PC. Production servers and end-user PCs need no license (royalty-free runtime).
+
+上記の要点と使用許諾が異なる場合は、使用許諾が優先します。
+If this summary and the license agreement differ, the license agreement prevails.

data/README.md

@@ -0,0 +1,93 @@
+# reports_web
+
+**Reports.Web for Ruby** — 帳票定義（`.prepdj`）に値を入れて印刷データ（PREPEJ）を作り、Reports.Web エンジン（C++ WebAssembly）で PDF にします。請求書・見積書・納品書・宛名ラベル・名刺など、日本の業務帳票向けです。
+
+Build print data (PREPEJ) from a report definition (`.prepdj`) and render it to PDF with the Reports.Web engine (C++ WebAssembly). Designed for Japanese business forms: invoices, estimates, delivery slips, address labels, business cards.
+
+- 製品サイト / Product: https://www.pao.ac/reports.web/
+- サンプル / Samples: https://github.com/ReportsWeb/wasm-ruby
+- オンラインデモ / Live demo: https://www.pao.ac/demo/reports.web/samples/ruby/
+
+## しくみ / How it works
+
+```
+your Ruby app ──(PREPEJ JSON)──▶ Reports.Web engine (Docker: ghcr.io/reportsweb/engine) ──▶ PDF
+      ▲
+ report definition (.prepdj) designed in the browser designer
+```
+
+帳票のデザインは、ブラウザで動くデザイナーで作ります。アプリは値を入れて印刷データを作り、エンジンに送るだけです。描画はすべてエンジンが行います。
+
+## インストール / Install
+
+```sh
+gem install reports_web          # or: gem 'reports_web', '~> 1.0' in your Gemfile
+docker run -d -p 3107:3107 ghcr.io/reportsweb/engine:1.0.0
+```
+
+Ruby 3.1 以降。エンジンは Docker イメージで動きます。追加の gem は不要です（json・net/http を使います）。
+Requires Ruby 3.1+. The engine runs as a Docker image. No extra gem dependencies.
+
+## 使い方 / Quick start
+
+```ruby
+require 'json'
+require 'reports_web'
+
+definition = JSON.parse(File.read('report.prepdj', encoding: 'UTF-8'))
+
+print_data = PaoReportsWeb::PrintData.new
+  .set_definition(definition)
+  .page_start
+  .set_value('Title', 'あっという間に帳票出力')
+  .set_value('CustomerName', '株式会社パオ')
+  .page_end
+
+engine = PaoReportsWeb::ReportsWebEngine.new(url: 'http://127.0.0.1:3107')
+File.binwrite('report.pdf', engine.render_pdf(print_data))
+```
+
+## API
+
+### `PaoReportsWeb::PrintData`
+
+| メソッド / Method | 内容 / Description |
+|---|---|
+| `set_definition(definition)` | 帳票定義（`.prepdj` の内容）を設定 / Set the report definition |
+| `page_start(definition = nil)` / `page_end` | ページの開始と終了。ページごとに別の定義も使えます / Begin and end a page |
+| `set_value(name, value, index = 0, drawing = true)` | 文字などの値を入れる / Set a value |
+| `set_repeated_value(name, value, x, y)` | 繰り返し（明細行など）の値 / Value for a repeated object |
+| `set_image(name, source)` / `set_barcode(name, code)` | 画像・バーコード / Image and barcode |
+| `change_attributes(name, values)` | 色・位置などの属性を変える / Change attributes |
+| `to_h` / `to_json` / `save(path)` | 印刷データ（PREPEJ）として取り出す・保存する / Get or save the PREPEJ |
+
+### `PaoReportsWeb::ReportsWebEngine`
+
+| メソッド / Method | 内容 / Description |
+|---|---|
+| `new(url:, timeout: 90, max_bytes:)` | 既定の URL は `REPORTS_ENGINE_URL`、なければ `http://127.0.0.1:3107` |
+| `render_pdf(print_data)` | PDF のバイト列（String）を返します / Returns the PDF bytes |
+| `health` | エンジンの状態 / Engine status |
+
+エラーは `PaoReportsWeb::ReportsWebEngineError`（`status` に HTTP ステータス）で返ります。
+Errors are raised as `PaoReportsWeb::ReportsWebEngineError` with the HTTP `status`.
+
+## 体験版と製品版 / Trial and product
+
+この gem とエンジンのイメージは体験版です。出力には赤い「SAMPLE」の印が付きます。ご購入後に納品するライセンスファイルをエンジンに設定すると、印が消えます。
+
+The gem and the engine image are trial builds: output carries a red "SAMPLE" mark. Mount the license file delivered on purchase to remove it:
+
+```sh
+docker run -d -p 3107:3107 -v /path/to/reports-web.license:/app/reports-web.license:ro ghcr.io/reportsweb/engine:1.0.0
+```
+
+開発用パソコン 1 台につき 1 ライセンス、運用環境はランタイムライセンスフリーです。詳しくは [LICENSE.md](LICENSE.md) と [使用許諾](https://www.pao.ac/reports.web/manual/index.html#16) をご覧ください。
+
+## 他の言語 / Other languages
+
+Reports.Web は同じ帳票定義と印刷データを、PHP・Java・.NET・Go・Ruby・Rust・Node.js から使えます。Pure Java・Pure Python・WPF 版もあります。
+https://github.com/ReportsWeb
+
+---
+Pao@Office — https://www.pao.ac/ — info@pao.ac

data/lib/pao_reports_web/engine.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require 'json'
+require 'net/http'
+require 'uri'
+
+module PaoReportsWeb
+  # Error returned by the Reports.Web engine. +status+ is the HTTP status, or nil for transport errors.
+  class ReportsWebEngineError < StandardError
+    attr_reader :status
+
+    def initialize(message, status = nil)
+      super(message)
+      @status = status
+    end
+  end
+
+  # Client for the Reports.Web engine (ghcr.io/reportsweb/engine).
+  # Sends PREPEJ print data to POST /render/pdf and returns the PDF bytes.
+  class ReportsWebEngine
+    DEFAULT_MAX = 32 * 1024 * 1024
+
+    attr_reader :url
+
+    # url: engine base URL (default: REPORTS_ENGINE_URL or http://127.0.0.1:3107)
+    # timeout: seconds; max_bytes: largest PDF accepted from the engine
+    def initialize(url: nil, timeout: 90, max_bytes: DEFAULT_MAX)
+      @url = (url || ENV['REPORTS_ENGINE_URL'] || 'http://127.0.0.1:3107').sub(%r{/+\z}, '')
+      @timeout = timeout
+      @max_bytes = max_bytes
+    end
+
+    # GET /health. Returns the engine status, e.g. {"status"=>"ok", "engine"=>"C++ WebAssembly"}.
+    def health
+      response = request(Net::HTTP::Get.new(uri('/health')))
+      raise ReportsWebEngineError.new("Engine health check failed (HTTP #{response.code}).", response.code.to_i) unless response.is_a?(Net::HTTPSuccess)
+      JSON.parse(response.body)
+    end
+
+    # Render PREPEJ print data (PrintData, its Hash form, or JSON text) to a PDF (binary String).
+    def render_pdf(data, swap_pdf_image: nil)
+      payload = case data
+                when String then data
+                when PrintData then data.to_json
+                else JSON.generate(data)
+                end
+      raise ReportsWebEngineError, 'Print data exceeds 32 MiB.' if payload.bytesize > DEFAULT_MAX
+      req = Net::HTTP::Post.new(uri('/render/pdf'))
+      req['Content-Type'] = 'application/json'
+      req['X-Reports-Swap-Pdf-Image'] = swap_pdf_image.to_s unless swap_pdf_image.nil?
+      req.body = payload
+      response = request(req)
+      unless response.is_a?(Net::HTTPSuccess)
+        detail = begin
+          JSON.parse(response.body.to_s)['error']
+        rescue JSON::ParserError, TypeError
+          response.body.to_s
+        end
+        message = "Engine could not create the PDF (HTTP #{response.code})"
+        message += detail.to_s.empty? ? '.' : ": #{detail}"
+        raise ReportsWebEngineError.new(message, response.code.to_i)
+      end
+      pdf = response.body.to_s.b
+      raise ReportsWebEngineError, "PDF exceeds #{@max_bytes} bytes." if pdf.bytesize > @max_bytes
+      raise ReportsWebEngineError, 'Engine response is not a PDF.' unless pdf.start_with?('%PDF-')
+      pdf
+    end
+
+    private
+
+    def uri(path) = URI(@url + path)
+
+    def request(req)
+      target = req.uri
+      Net::HTTP.start(target.host, target.port, use_ssl: target.scheme == 'https',
+                      open_timeout: [@timeout, 10].min, read_timeout: @timeout) { |http| http.request(req) }
+    rescue StandardError => e
+      raise ReportsWebEngineError, "Cannot reach the Reports.Web engine at #{@url}: #{e.message}"
+    end
+  end
+end

data/lib/pao_reports_web/print_data.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+require 'json'
+require 'tempfile'
+
+module PaoReportsWeb
+  # Framework-independent builder for the shared PREPEJ print-document format.
+  class PrintData
+    FORMAT = 'Reports.net PrintData'
+    VERSION = '1.0'
+
+    def initialize
+      @definition = nil
+      @pages = []
+      @page = nil
+    end
+
+    def set_definition(definition)
+      raise ArgumentError, 'Cannot change the definition inside a page' if @page
+      self.class.validate_definition!(definition)
+      @pages.each { |page| page['Definition'] = deep_copy(@definition) if page['Definition'].nil? } if @definition
+      @definition = deep_copy(definition)
+      self
+    end
+
+    def page_start(definition = nil)
+      raise ArgumentError, 'Call page_end before starting another page' if @page
+      self.class.validate_definition!(definition) if definition
+      raise ArgumentError, 'Set a definition first' unless definition || @definition
+      @page = {'Index' => @pages.length + 1, 'Definition' => definition && deep_copy(definition), 'Values' => [], 'DynamicAttributes' => []}
+      self
+    end
+
+    def set_value(name, value, index = 0, drawing = true)
+      add_value(name, nil, value, index, drawing)
+    end
+
+    def set_repeated_value(name, value, x, y, drawing = true)
+      add_value(name, nil, value, 0, drawing, x, y)
+    end
+
+    def set_typed_value(name, kind, value, index = 0, drawing = true)
+      add_value(name, kind, value, index, drawing)
+    end
+
+    def set_image(name, source) = set_typed_value(name, 'DynamicImage', source)
+    def set_barcode(name, code) = set_typed_value(name, 'DynamicBarcode', code)
+
+    def change_attributes(name, values, index = 0)
+      change_repeated_attributes(name, values, index)
+    end
+
+    def change_repeated_attributes(name, values, index = 0, x: nil, y: nil, kind: nil)
+      page = current_page
+      validate_indices!(index, x, y)
+      raise ArgumentError, 'Attributes must be an object' unless values.is_a?(Hash)
+      normalized = values.to_h { |key, value| raise(ArgumentError, 'Attribute values cannot be null') if value.nil?; [key.to_s, scalar(value)] }
+      item = {'Name' => required(name), 'Type' => resolve_type(name, kind), 'Index' => index, 'Values' => normalized}
+      item.merge!('IndexX' => x, 'IndexY' => y) unless x.nil?
+      page['DynamicAttributes'] << item
+      self
+    end
+
+    def page_end
+      @pages << current_page
+      @page = nil
+      self
+    end
+
+    def to_h
+      raise ArgumentError, 'An unfinished page exists' if @page
+      raise ArgumentError, 'A definition is required' unless @definition
+      raise ArgumentError, 'At least one completed page is required' if @pages.empty?
+      deep_copy({'Format' => FORMAT, 'Version' => VERSION, 'Definition' => @definition, 'Pages' => @pages})
+    end
+
+    def to_json(pretty: false)
+      (pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)) + "\n"
+    end
+
+    def save(path)
+      Tempfile.create(['.print-', '.tmp'], File.dirname(path)) do |file|
+        file.write(to_json(pretty: true)); file.flush; file.close
+        File.rename(file.path, path)
+      end
+    end
+
+    def self.validate_definition!(definition)
+      portable = definition.is_a?(Hash) && definition.key?('Version') && definition['Objects'].is_a?(Array) && %w[mm px].include?((definition['CoordinateUnit'] || 'mm').downcase)
+      web = definition.is_a?(Hash) && definition['format'] == 'pao-reports-web' && definition['version'] == 1 && definition['pages'].is_a?(Array) && !definition['pages'].empty?
+      raise ArgumentError, 'Invalid report definition' unless portable || web
+    end
+
+    private
+    def add_value(name, kind, value, index, drawing, x = nil, y = nil)
+      validate_indices!(index, x, y)
+      item = {'Name' => required(name), 'Type' => resolve_type(name, kind), 'Index' => index, 'Drawing' => drawing, 'Value' => scalar(value)}
+      item.merge!('IndexX' => x, 'IndexY' => y) unless x.nil?
+      current_page['Values'] << item
+      self
+    end
+    # 型省略時だけ、当該ページの定義を参照する。明示指定は保持する。
+    def resolve_type(name, explicit)
+      return required(explicit) unless explicit.nil?
+      d = current_page['Definition'] || @definition
+      objects = (d['Objects'] || []) + (d['pages'] || []).flat_map { |p| p['objects'] || [] }
+      kinds = %w[Text Line Square Circle Image Barcode]
+      web = {'text'=>'Text', 'line'=>'Line', 'rectangle'=>'Square', 'ellipse'=>'Circle', 'image'=>'Image', 'barcode'=>'Barcode'}
+      objects.each do |o|
+        next unless (o['Name'] || o['name']) == required(name)
+        return 'Dynamic' + kinds[o['Kind'].to_i] if /\A[0-5]\z/.match?(o['Kind'].to_s)
+        return 'Dynamic' + web[o['kind']] if web.key?(o['kind'])
+      end
+      'DynamicText'
+    end
+    def current_page = @page || raise(ArgumentError, 'Call page_start first')
+    def required(value) = value.to_s.strip.then { |v| v.empty? ? raise(ArgumentError, 'A name is required') : v }
+    def scalar(value)
+      return nil if value.nil?
+      raise ArgumentError, 'A finite scalar is required' if value.is_a?(Float) && !value.finite?
+      return value.dup if value.is_a?(String)
+      return value.to_s if value.is_a?(Numeric) || value == true || value == false
+      raise ArgumentError, 'Values must be scalar'
+    end
+    def deep_copy(value) = Marshal.load(Marshal.dump(value))
+    def validate_indices!(index, x, y)
+      valid = index.is_a?(Integer) && index >= 0 && x.nil? == y.nil?
+      valid &&= x.is_a?(Integer) && x >= 0 && y.is_a?(Integer) && y >= 0 unless x.nil?
+      raise ArgumentError, 'Indices must be non-negative integers; supply both x and y, or neither' unless valid
+    end
+  end
+end

data/lib/pao_reports_web/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module PaoReportsWeb
+  GEM_VERSION = '1.0.0'
+end

data/lib/pao_reports_web.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'reports_web'

data/lib/reports_web.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# Reports.Web for Ruby: PaoReportsWeb::PrintData builds PREPEJ print data,
+# PaoReportsWeb::ReportsWebEngine renders it to PDF with the Reports.Web engine.
+require_relative 'pao_reports_web/version'
+require_relative 'pao_reports_web/print_data'
+require_relative 'pao_reports_web/engine'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: reports_web
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pao@Office
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Reports.Web is a report designer and PDF engine for Japanese business
+  forms (invoices, estimates, delivery slips, labels, business cards). This gem builds
+  print data (PREPEJ JSON) and renders it to PDF with the Reports.Web engine (C++
+  WebAssembly, Docker image ghcr.io/reportsweb/engine). Trial build: output carries
+  a red SAMPLE mark until a purchased license file is configured in the engine.'
+email:
+- info@pao.ac
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/pao_reports_web.rb
+- lib/pao_reports_web/engine.rb
+- lib/pao_reports_web/print_data.rb
+- lib/pao_reports_web/version.rb
+- lib/reports_web.rb
+homepage: https://www.pao.ac/reports.web/
+licenses:
+- Nonstandard
+metadata:
+  homepage_uri: https://www.pao.ac/reports.web/
+  source_code_uri: https://github.com/ReportsWeb/wasm-ruby
+  documentation_uri: https://github.com/ReportsWeb/wasm-ruby#readme
+  bug_tracker_uri: https://www.pao.ac/reports.web/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+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: 'Reports.Web for Ruby: build PREPEJ print data from .prepdj report definitions
+  and render PDF with the Reports.Web engine.'
+test_files: []