haveapi 0.32.1 → 0.32.2

data/spec/documentation/validators_spec.rb

@@ -120,4 +120,29 @@ describe HaveAPI::DocumentationValidators do
     expect(render(payload, { 'extra' => payload })).to include('<th scope="row">&lt;script&gt;&amp;&quot;</th>')
     expect(Marshal.dump(options)).to eq(before)
   end
+
+  it 'localizes framework presentation while preserving metadata and machine values' do
+    validators = {
+      present: { empty: false }, include: { values: { 'ready' => 'Application label' } },
+      number: { min: 2, step: 3, even: true }, length: { min: 2, max: 8 },
+      custom: 'Application rule', extension: { 'supplied' => 'Untranslated metadata' }
+    }
+    before = Marshal.dump(validators)
+    html = I18n.with_locale(:cs) { described_class.render(validators, type: 'String') }
+
+    expect(html).to include('<caption>Validační pravidla</caption>', '<th scope="col">Pravidlo</th>',
+                            '<th scope="col">Podrobnosti</th>', 'Musí být uvedeno', 'Povolené hodnoty',
+                            '<code>ready</code>: Application label', 'Application rule', 'Untranslated metadata')
+    expect(html).not_to include('Validation rules', 'Allowed values', 'Minimum length:')
+    expect(Marshal.dump(validators)).to eq(before)
+  end
+
+  it 'escapes translated text and interpolated metadata independently' do
+    html = I18n.with_locale(:cs) do
+      render(:confirm, { parameter: '<script>&', equal: false })
+    end
+
+    expect(html).to include('Musí se lišit od parametru <code>&lt;script&gt;&amp;</code>.')
+    expect(html).not_to include('<script>', '&amp;lt;')
+  end
 end

data/spec/extensions/exception_mailer_spec.rb

@@ -125,7 +125,7 @@ describe HaveAPI::Extensions::ExceptionMailer do
   it 'does not mail a missing JSON schema documentation file' do
     mailer = new_mailer
     calls = collect_mail_calls(mailer)
-    doc_path = File.join(app.settings.root, '../../doc/json-schema.html')
+    doc_path = File.expand_path('../../doc/en/json-schema.html', app.settings.root)
     allow(File).to receive(:read).and_call_original
     allow(File).to receive(:read).with(doc_path).and_raise(Errno::ENOENT, doc_path)
 
@@ -142,7 +142,7 @@ describe HaveAPI::Extensions::ExceptionMailer do
     calls = collect_mail_calls(mailer)
     app.set :raise_errors, false
     app.set :show_exceptions, false
-    doc_path = File.join(app.settings.root, '../../doc/json-schema.html')
+    doc_path = File.expand_path('../../doc/en/json-schema.html', app.settings.root)
     allow(File).to receive(:read).and_call_original
     allow(File).to receive(:read).with(doc_path).and_raise(Errno::EACCES, doc_path)
 

data/spec/packaging_spec.rb

@@ -9,7 +9,12 @@ require 'tmpdir'
 
 describe HaveAPI::Server do
   def required_docs
-    %w[json-schema.html protocol.md create-client.md typed-input-validation.md client-examples.md protocol.png]
+    %w[protocol.png en/documentation-ui.md en/documentation-oauth.md en/performance.md] +
+      %w[en cs].flat_map do |locale|
+        %w[readme.md protocol.md create-client.md typed-input-validation.md client-examples.md json-schema.html].map do |name|
+          "#{locale}/#{name}"
+        end
+      end
   end
 
   before(:context) do
@@ -22,14 +27,15 @@ describe HaveAPI::Server do
     Rake::Task[:build].invoke
   end
 
-  %i[missing empty].each do |condition|
-    it "rejects a direct build with #{condition} shared documentation" do
+  %w[en/json-schema.html cs/json-schema.html cs/protocol.md].product(%i[missing empty]).each do |document, condition|
+    it "rejects a direct build with #{condition} #{document}" do
       Dir.mktmpdir('haveapi-doc-check') do |dir|
         FileUtils.mkdir_p(File.join(dir, 'doc'))
         required_docs.each do |name|
-          next if name == 'json-schema.html' && condition == :missing
+          next if name == document && condition == :missing
 
-          content = name == 'json-schema.html' && condition == :empty ? '' : 'document'
+          content = name == document && condition == :empty ? '' : 'document'
+          FileUtils.mkdir_p(File.dirname(File.join(dir, 'doc', name)))
           File.write(File.join(dir, 'doc', name), content)
         end
 
@@ -38,12 +44,42 @@ describe HaveAPI::Server do
             expect { invoke_build }.to raise_error(SystemExit) do |error|
               expect(error.status).to eq(1)
             end
-          end.to output(/json-schema.html.*Run `make doc`/).to_stderr
+          end.to output(/#{Regexp.escape(document)}.*Run `make doc`/).to_stderr
         end
       end
     end
   end
 
+  it 'copies localized schema documentation without application gems or Bundler' do
+    root = File.expand_path('../../..', __dir__)
+    Dir.mktmpdir('haveapi-copydoc') do |dir|
+      destination = File.join(dir, 'server')
+      empty_gems = File.join(dir, 'empty-gems')
+      FileUtils.mkdir_p(empty_gems)
+      environment = {
+        'GEM_HOME' => empty_gems,
+        'GEM_PATH' => empty_gems,
+        'RUBYLIB' => nil,
+        'RUBYOPT' => nil,
+        'RUBYGEMS_GEMDEPS' => nil
+      }
+      stdout, stderr, status = Bundler.with_unbundled_env do
+        Open3.capture3(environment, File.join(root, 'utils/copydoc.sh'), destination, chdir: root)
+      end
+      expect(status.success?).to be(true), "Isolated documentation copy failed: #{stdout}#{stderr}"
+
+      schemas = %w[en cs].map do |locale|
+        body = File.read(File.join(destination, 'doc', locale, 'json-schema.html'))
+        heading = ::I18n.t('haveapi.documentation.schema.envelope', locale:, raise: true)
+        expect(body).to include(%(<h1 id="envelope">#{ERB::Util.html_escape(heading)}</h1>))
+        code = body.scan(%r{<pre><code>(.*?)</code></pre>}m).flatten
+        expect(code.length).to eq(4)
+        code
+      end
+      expect(schemas[0]).to eq(schemas[1])
+    end
+  end
+
   it 'ships and serves shared documentation from the built gem' do
     invoke_build
     gem_path = File.expand_path("../pkg/haveapi-#{HaveAPI::VERSION}.gem", __dir__)
@@ -85,13 +121,18 @@ describe HaveAPI::Server do
         server.use_version(1)
         server.mount('/')
         request = Rack::MockRequest.new(server.app)
-        responses = %w[/ /doc /doc/index /doc/index.md /doc/readme /doc/json-schema /doc/protocol.md /doc/create-client.md /doc/client-examples.md /js/highlight-LICENSE].to_h do |path|
-          response = request.get(path, 'HTTP_HOST' => 'localhost')
+        responses = %w[/ /doc /doc/index /doc/index.md /doc/readme /doc/json-schema /doc/protocol.md /doc/create-client.md /doc/client-examples.md /doc/typed-input-validation /js/highlight-LICENSE].to_h do |path|
+          response = request.get(path, 'HTTP_HOST' => 'localhost', 'HTTP_ACCEPT_LANGUAGE' => 'en')
           [path, { status: response.status, type: response.content_type, cache_control: response['Cache-Control'], body: response.body }]
         end
+        translated = %w[/doc /doc/index /doc/index.md /doc/readme /doc/protocol.md /doc/create-client.md /doc/typed-input-validation /doc/client-examples.md /doc/json-schema /doc/documentation-ui].to_h do |path|
+          response = request.get(path, 'HTTP_HOST' => 'localhost', 'HTTP_ACCEPT_LANGUAGE' => 'cs-CZ')
+          [path, { status: response.status, body: response.body }]
+        end
         puts JSON.generate({
           framework: HaveAPI::Server.instance_method(:mount).source_location.first,
-          responses: responses
+          responses: responses,
+          translated: translated
         })
       RUBY
 
@@ -128,6 +169,7 @@ describe HaveAPI::Server do
         '/doc/protocol.md' => 'Protocol definition',
         '/doc/create-client.md' => 'Client definition',
         '/doc/client-examples.md' => 'Client examples',
+        '/doc/typed-input-validation' => 'Typed input validation',
         '/js/highlight-LICENSE' => 'Copyright'
       }.each do |path, heading|
         response = result.fetch('responses').fetch(path)
@@ -140,6 +182,23 @@ describe HaveAPI::Server do
         expect(response.fetch('body')).to include('data-docs', '/js/documentation.js', '/css/documentation.css')
         expect(response.fetch('body')).not_to include('/js/main.js', '/css/bootstrap')
       end
+      {
+        '/doc' => 'Serverová implementace',
+        '/doc/index' => 'Serverová implementace',
+        '/doc/index.md' => 'Serverová implementace',
+        '/doc/readme' => 'Serverová implementace',
+        '/doc/protocol.md' => 'Definice protokolu',
+        '/doc/create-client.md' => 'Definice klienta',
+        '/doc/typed-input-validation' => 'Validace typovaných vstupů',
+        '/doc/client-examples.md' => 'Klientské příklady',
+        '/doc/json-schema' => 'Obálka',
+        '/doc/documentation-ui' => 'Browsing API documentation'
+      }.each do |path, heading|
+        response = result.fetch('translated').fetch(path)
+        expect(response.fetch('status')).to eq(200), "Packaged Czech route failed: #{path}"
+        expect(response.fetch('body')).to include('lang="cs"', heading)
+      end
+      expect(result.fetch('translated').fetch('/doc/documentation-ui').fetch('body')).to include('lang="en"')
       %w[/doc /doc/index /doc/index.md /doc/readme].each do |path|
         body = result.fetch('responses').fetch(path).fetch('body')
         expect(body).to include('<title>HaveAPI internals · ', 'Server framework features',

data/spec/performance/event_baseline_spec.rb

@@ -344,7 +344,7 @@ RSpec.describe HaveAPI::PerformanceCI do
     %w[flake.lock Gemfile Makefile .ruby-version servers/ruby/benchmarks/endpoints.rb
        servers/ruby/benchmarks/Gemfile servers/ruby/benchmarks/Gemfile.lock servers/ruby/benchmarks/shell.nix
        servers/ruby/test_support/performance_sqlite_fixture.rb clients/ruby/Gemfile clients/rust/Gemfile
-       doc/performance.md utils/performance_ci.rb .github/workflows/servers-ruby-performance.yml
+       doc/en/performance.md utils/performance_ci.rb .github/workflows/servers-ruby-performance.yml
        servers/ruby/benchmarks/spec/client_examples_spec.rb servers/ruby/test_support/all_client_performance_fixture.rb
        clients/go/lib/haveapi/go_client/documentation.rb clients/typescript/lib/haveapi/typescript_client/documentation.rb
        clients/js/src/client.ts clients/python/haveapi/client.py clients/php/src/Client.php clients/new-client/renderer.rb].each do |path|

data/spec/performance/source_versions_spec.rb

@@ -10,6 +10,8 @@ require_relative 'support/samples'
 describe HaveAPI::PerformanceCI::Campaign do
   let(:root) { File.expand_path('../../../..', __dir__) }
   let(:error) { HaveAPI::Performance::ContractError }
+  let(:shallow_files) { "  s.files       = `git ls-files -z`.split(\"\\x0\") + Dir.glob('doc/*')\n" }
+  let(:recursive_files) { "  s.files       = `git ls-files -z`.split(\"\\x0\") + Dir.glob('doc/**/*').select { |path| File.file?(path) }\n" }
 
   before do
     # These metadata fixtures evaluate real gemspecs without loading the optional
@@ -44,6 +46,12 @@ describe HaveAPI::PerformanceCI::Campaign do
     end
   end
 
+  def with_files(contents, statement)
+    path = 'servers/ruby/haveapi.gemspec'
+    previous = contents.fetch(path).lines.find { |line| line.start_with?('  s.files ') }
+    contents.merge(path => contents.fetch(path).sub(previous, statement))
+  end
+
   def prepare(baseline, candidate)
     Dir.mktmpdir('haveapi-own-versions-') do |directory|
       roots = { baseline: File.join(directory, 'baseline'), candidate: File.join(directory, 'candidate') }
@@ -82,11 +90,12 @@ describe HaveAPI::PerformanceCI::Campaign do
     end
   end
 
-  def replay_samples(baseline = '0.31.0')
+  def replay_samples(baseline = '0.31.0', selections: {}, normalize_files: true)
     samples, budgets = PerformanceSamples.fixture
     samples.fetch('sources').each do |role, source|
       contents = source_contents(role == 'baseline' ? baseline : '0.31.1').slice(*HaveAPI::Performance::SourceVersions::PATHS)
-      receipt = HaveAPI::Performance::SourceVersions.capture(contents)
+      contents = with_files(contents, selections.fetch(role)) if selections.has_key?(role)
+      receipt = HaveAPI::Performance::SourceVersions.capture(contents, normalize_files:)
       source['files_sha256'].merge!(receipt.fetch('raw_sha256'))
       samples.fetch('observations').each_value do |observation|
         next unless observation.fetch('source').fetch('root') == source.fetch('root')
@@ -165,4 +174,104 @@ describe HaveAPI::PerformanceCI::Campaign do
     samples, budgets = PerformanceSamples.fixture
     expect(compare(samples, JSON.parse(budgets)).fetch('status')).to eq('pass')
   end
+
+  it 'accepts only the reviewed packaging transition in preparation and live input capture' do
+    contents = { baseline: with_files(source_contents('0.31.1'), shallow_files),
+                 candidate: with_files(source_contents('0.31.1'), recursive_files) }
+    prepare(contents[:baseline], contents[:candidate]) do |roots|
+      retained = JSON.parse(File.read(File.join(File.dirname(roots[:baseline]), 'dependency-compatibility.json')))
+      expect(retained['baseline']['gemspecs']).to eq(retained['candidate']['gemspecs'])
+      receipts = retained.values.map { |input| input.fetch('source_versions') }
+      expect(receipts.first.fetch('raw_sha256')).not_to eq(receipts.last.fetch('raw_sha256'))
+      expect(receipts.first.fetch('normalized_sha256')).to eq(receipts.last.fetch('normalized_sha256'))
+      expect(receipts.map { |receipt| receipt.fetch('file_selection') }).to eq(%w[documentation-files-v1 documentation-files-v1])
+
+      graphs = roots.map do |role, directory|
+        %w[HaveAPI::VERSION HaveAPI::Client::VERSION HaveAPI::RustClient::VERSION].each { |constant| stub_const(constant, '0.31.1') }
+        inputs = JSON.parse(JSON.generate(HaveAPI::Performance::Worker.inputs(directory, 'quick', benchmark: true)))
+        hashes = contents.fetch(role).transform_values { |text| Digest::SHA256.hexdigest(text) }
+        expect(inputs.fetch('source_versions')).to eq(retained.fetch(role.to_s).fetch('source_versions'))
+        expect do
+          HaveAPI::Performance.validate_input_receipts(inputs, { 'files_sha256' => hashes }, profile: 'quick', lineage: nil)
+        end.not_to raise_error
+        HaveAPI::Performance::Release.graph(inputs)
+      end
+      expect(graphs.first).to eq(graphs.last)
+    end
+  end
+
+  it 'replays the exact old/new packaging pair while retaining raw source hashes' do
+    samples, budgets = replay_samples('0.31.1', selections: { 'baseline' => shallow_files, 'candidate' => recursive_files })
+
+    expect(compare(samples, budgets).fetch('status')).to eq('pass')
+    path = 'servers/ruby/haveapi.gemspec'
+    expect(samples['sources']['baseline']['files_sha256'][path]).not_to eq(samples['sources']['candidate']['files_sha256'][path])
+  end
+
+  it 'keeps all bytes outside the exact packaging statement and evaluated requirements strict' do
+    original = with_files(source_contents('0.31.0'), shallow_files)
+    candidate = with_files(source_contents('0.31.1'), recursive_files)
+    path = 'servers/ruby/haveapi.gemspec'
+    changes = [
+      candidate.merge(path => candidate.fetch(path).sub('Framework for creating', 'Framework for describing')),
+      candidate.merge(path => candidate.fetch(path).sub("'activesupport', '>= 7.1'", "'activesupport', '>= 7.0'")),
+      candidate.merge(path => "#{candidate.fetch(path)}\n# unrelated comment\n"),
+      candidate.merge('.ruby-version' => "3.2.1\n")
+    ]
+    changes.each do |changed|
+      expect { prepare(original, changed) }.to raise_error(HaveAPI::PerformanceCI::Error, /Dependency inputs differ/)
+    end
+  end
+
+  it 'does not normalize unknown, absent, duplicated or modified file statements' do
+    contents = source_contents('0.31.1').slice(*HaveAPI::Performance::SourceVersions::PATHS)
+    expected = HaveAPI::Performance::SourceVersions.capture(with_files(contents, shallow_files)).fetch('normalized_sha256')
+    variants = [
+      recursive_files.sub('doc/**/*', 'doc/**'), recursive_files.sub('File.file?', 'File.symlink?'),
+      recursive_files.sub("\n", " # additional behavior\n"), '', shallow_files + recursive_files,
+      "#{recursive_files}  s.files = []\n"
+    ]
+    variants.each do |statement|
+      changed = with_files(contents, statement)
+      receipt = HaveAPI::Performance::SourceVersions.capture(changed)
+      expect(receipt).not_to have_key('file_selection')
+      expect(receipt.fetch('normalized_sha256')).not_to eq(expected)
+      expect(receipt).to eq(HaveAPI::Performance::SourceVersions.capture(changed, normalize_files: false))
+    end
+  end
+
+  it 'rejects tampered or stripped packaging markers and source bindings on replay' do
+    %w[marker stripped added raw normalized content source manifest].each do |fault|
+      selections = fault == 'added' ? {} : { 'baseline' => shallow_files, 'candidate' => recursive_files }
+      samples, budgets = replay_samples(selections:, normalize_files: fault != 'added')
+      inputs = samples['observations']['candidate']['inputs']
+      receipt = inputs.fetch('source_versions')
+      path = 'servers/ruby/haveapi.gemspec'
+      case fault
+      when 'marker' then receipt['file_selection'] = 'unreviewed-policy'
+      when 'stripped' then receipt.delete('file_selection')
+      when 'added' then receipt['file_selection'] = 'documentation-files-v1'
+      when 'raw' then receipt['raw_sha256'][path] = 'f' * 64
+      when 'normalized' then receipt['normalized_sha256'][path] = 'f' * 64
+      when 'content' then receipt['contents'][path] += "# changed\n"
+      when 'source' then samples['sources']['candidate']['files_sha256'][path] = 'f' * 64
+      when 'manifest' then inputs['manifests'][path] = 'f' * 64
+      end
+      expect { compare(samples, budgets) }.to raise_error(error), fault
+    end
+  end
+
+  it 'continues to replay legacy own-version receipts with raw file selection' do
+    samples, budgets = replay_samples(normalize_files: false)
+
+    expect(compare(samples, budgets).fetch('status')).to eq('pass')
+  end
+
+  it 'leaves the historical maintenance packaging comparison strict' do
+    contents = source_contents('0.30.1')
+    old = HaveAPI::Performance::Release.capture(with_files(contents, shallow_files))
+    new = HaveAPI::Performance::Release.capture(with_files(contents, recursive_files))
+
+    expect(old.fetch('normalized_sha256')).not_to eq(new.fetch('normalized_sha256'))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.32.2
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.32.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.32.2
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -218,17 +218,24 @@ files:
 - benchmarks/performance_compare.rb
 - benchmarks/shell.nix
 - benchmarks/spec/client_examples_spec.rb
-- doc/client-examples.md
-- doc/create-client.md
-- doc/documentation-oauth.md
-- doc/documentation-ui.md
+- doc/cs/client-examples.md
+- doc/cs/create-client.md
+- doc/cs/json-schema.html
+- doc/cs/protocol.md
+- doc/cs/readme.md
+- doc/cs/typed-input-validation.md
+- doc/en/client-examples.md
+- doc/en/create-client.md
+- doc/en/documentation-oauth.md
+- doc/en/documentation-ui.md
+- doc/en/json-schema.html
+- doc/en/performance.md
+- doc/en/protocol.md
+- doc/en/readme.md
+- doc/en/typed-input-validation.md
 - doc/hooks.erb
 - doc/index.md
-- doc/json-schema.html
-- doc/performance.md
-- doc/protocol.md
 - doc/protocol.png
-- doc/typed-input-validation.md
 - haveapi.gemspec
 - lib/haveapi.rb
 - lib/haveapi/action.rb
@@ -271,6 +278,7 @@ files:
 - lib/haveapi/documentation_clients.rb
 - lib/haveapi/documentation_context.rb
 - lib/haveapi/documentation_helpers.rb
+- lib/haveapi/documentation_locale.rb
 - lib/haveapi/documentation_oauth.rb
 - lib/haveapi/documentation_schema.rb
 - lib/haveapi/documentation_search.rb
@@ -381,6 +389,8 @@ files:
 - spec/client_examples/assets/documentation_test.cjs
 - spec/client_examples/assets/highlighter_test.cjs
 - spec/client_examples/assets/tabs_test.cjs
+- spec/client_examples/comment_capture.rb
+- spec/client_examples/comments_spec.rb
 - spec/client_examples/context_performance_spec.rb
 - spec/client_examples/context_spec.rb
 - spec/client_examples/detail_spec.rb
@@ -408,12 +418,15 @@ files:
 - spec/documentation/client_examples_spec.rb
 - spec/documentation/client_overview_spec.rb
 - spec/documentation/current_user_html_escaping_spec.rb
+- spec/documentation/example_selection_spec.rb
 - spec/documentation/example_variants_spec.rb
 - spec/documentation/examples_spec.rb
 - spec/documentation/fixtures/search_index.json
 - spec/documentation/host_html_escaping_spec.rb
 - spec/documentation/identity_and_guides_spec.rb
 - spec/documentation/identity_context_spec.rb
+- spec/documentation/language_settings_spec.rb
+- spec/documentation/locale_spec.rb
 - spec/documentation/navigation_spec.rb
 - spec/documentation/oauth_fixture_spec.rb
 - spec/documentation/oauth_spec.rb