ligarb 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9771ee497c353bffb143092dae4b8631c72587e264ca3e6081e614e582de9d1b
-  data.tar.gz: 1def484d79741c7e88d657c485799762e7bf6909cd3bf9a3118aac00ac3cf32f
+  metadata.gz: 9a98936274fe3188801b1787fba5e58076a04ff6d5d4cb94183d3bad03643c25
+  data.tar.gz: 017da362d7d557808ac62478fc0ac5e95ac50ae68dda6143a76137da27ca5264
 SHA512:
-  metadata.gz: 8f7902c30dbc242df9605bfc95995a01c6a23729e1c7079811b0ff9e7a7545d534225c3216cce46c6619a073d215a728dd24a1ab6fb2011206887180ed786c03
-  data.tar.gz: 720e0fc0a1433537e956987edc1e2656931b5fb01ceb22dd57ee6b537451ab69c30c34d671ad16c3985f60d5f00ee8ddab4028c8fb4c17527b57b5d8724d70a7
+  metadata.gz: 4ca765bc7bab404fe43800686716eabb03e7f1d6b4b3c5210c7dd8ae610539a3fb71d929e621a176fdbae98b2054f1ca3b394b15fe92bdc73dc29a79f7abf7ae
+  data.tar.gz: 8d3e2954073174b3a6779aea90d6167a378c5c0fbfb7e05635f016d44061f1266db60868f8505f896759e4462729698c6895fec4956d69531089993eded8531c

data/assets/feedback.css

@@ -0,0 +1,123 @@
+/* ligarb public feedback UI — "Report as issue"
+   Static, backend-free: builds a prefilled GitHub issue URL and opens it.
+   Colors reuse the book's CSS variables so dark mode works automatically. */
+
+#ligarb-fb-btn {
+  position: absolute;
+  z-index: 9999;
+  display: none;
+  padding: 6px 12px;
+  font-family: var(--font-sans);
+  font-size: 13px;
+  font-weight: 600;
+  line-height: 1;
+  color: #fff;
+  background: var(--color-accent);
+  border: none;
+  border-radius: 6px;
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
+  cursor: pointer;
+}
+
+#ligarb-fb-btn:hover { filter: brightness(1.08); }
+
+#ligarb-fb-panel {
+  position: fixed;
+  z-index: 10000;
+  display: none;
+  flex-direction: column;
+  gap: 10px;
+  width: 320px;
+  max-width: calc(100vw - 24px);
+  padding: 16px;
+  font-family: var(--font-sans);
+  color: var(--color-text);
+  background: var(--color-bg);
+  border: 1px solid var(--color-border);
+  border-radius: 10px;
+  box-shadow: 0 8px 28px rgba(0, 0, 0, 0.25);
+}
+
+#ligarb-fb-panel.open { display: flex; }
+
+.ligarb-fb-title {
+  font-size: 14px;
+  font-weight: 700;
+}
+
+.ligarb-fb-quote {
+  max-height: 96px;
+  overflow-y: auto;
+  padding: 8px 10px;
+  font-size: 12px;
+  line-height: 1.5;
+  color: var(--color-text-muted);
+  background: var(--color-code-bg);
+  border: 1px solid var(--color-code-border);
+  border-radius: 6px;
+  white-space: pre-wrap;
+  word-break: break-word;
+}
+
+.ligarb-fb-label {
+  font-size: 12px;
+  font-weight: 600;
+  color: var(--color-text-muted);
+}
+
+#ligarb-fb-type,
+#ligarb-fb-details {
+  width: 100%;
+  padding: 7px 9px;
+  font-family: inherit;
+  font-size: 13px;
+  color: var(--color-text);
+  background: var(--color-bg);
+  border: 1px solid var(--color-border);
+  border-radius: 6px;
+}
+
+#ligarb-fb-details { resize: vertical; min-height: 60px; }
+
+#ligarb-fb-type:focus,
+#ligarb-fb-details:focus {
+  outline: none;
+  border-color: var(--color-accent);
+  box-shadow: 0 0 0 2px var(--color-accent-light);
+}
+
+.ligarb-fb-actions {
+  display: flex;
+  justify-content: flex-end;
+  gap: 8px;
+}
+
+.ligarb-fb-submit,
+.ligarb-fb-cancel {
+  padding: 7px 14px;
+  font-family: inherit;
+  font-size: 13px;
+  font-weight: 600;
+  border-radius: 6px;
+  cursor: pointer;
+}
+
+.ligarb-fb-submit {
+  color: #fff;
+  background: var(--color-accent);
+  border: none;
+}
+
+.ligarb-fb-submit:hover { filter: brightness(1.08); }
+
+.ligarb-fb-cancel {
+  color: var(--color-text-muted);
+  background: transparent;
+  border: 1px solid var(--color-border);
+}
+
+.ligarb-fb-cancel:hover { background: var(--color-sidebar-hover); }
+
+@media print {
+  #ligarb-fb-btn, #ligarb-fb-panel { display: none !important; }
+}

data/assets/feedback.js

@@ -0,0 +1,194 @@
+// ligarb public feedback UI — "Report as issue"
+// Static and backend-free: on text selection it offers a button that builds a
+// prefilled GitHub Issue form URL (from data-src-* + window.location + the
+// configured repository) and opens it in a new tab. No API calls, no tokens.
+(function() {
+  'use strict';
+
+  var cfg = window._ligarbReview;
+  if (!cfg || !cfg.base) return;
+
+  var ISSUE_BASE = cfg.base.replace(/\/+$/, '') + '/issues/new';
+  var TEMPLATE = cfg.issueTemplate || 'book-feedback.yml';
+  var LABELS = Array.isArray(cfg.labels) ? cfg.labels : [];
+
+  // Keep the whole URL comfortably under common limits (~8KB).
+  var MAX_QUOTE = 1200;
+  var MAX_URL = 7000;
+
+  // Short label -> value stored in the issue (the form keeps its own dropdown;
+  // we fold the reader's choice into `details` since dropdown prefill is flaky).
+  var TYPES = [
+    { value: '', label: '種類を選択 / Type…' },
+    { value: '誤り (error)', label: '誤り / Error' },
+    { value: 'わかりにくい (unclear)', label: 'わかりにくい / Unclear' },
+    { value: '疑問 (question)', label: '疑問 / Question' }
+  ];
+
+  function enc(s) { return encodeURIComponent(s == null ? '' : s); }
+
+  function escapeHTML(str) {
+    var div = document.createElement('div');
+    div.textContent = str == null ? '' : str;
+    return div.innerHTML;
+  }
+
+  // ── Selection capture (mirrors the serve review UI) ──
+
+  var btn = document.createElement('button');
+  btn.id = 'ligarb-fb-btn';
+  btn.type = 'button';
+  btn.textContent = 'Report as issue';
+  document.body.appendChild(btn);
+
+  var current = null; // { quote, chapterTitle, srcFile, headingText }
+
+  document.addEventListener('mouseup', function(e) {
+    if (e.target.closest('#ligarb-fb-btn, #ligarb-fb-panel')) return;
+
+    var sel = window.getSelection();
+    if (!sel || sel.isCollapsed || !sel.toString().trim()) {
+      hideButton();
+      return;
+    }
+
+    var anchor = sel.anchorNode;
+    var chapter = anchor && anchor.parentElement ? anchor.parentElement.closest('.chapter') : null;
+    if (!chapter || !chapter.dataset.srcFile) {
+      hideButton();
+      return;
+    }
+
+    current = {
+      quote: sel.toString().trim(),
+      chapterTitle: chapter.dataset.srcTitle || '',
+      srcFile: chapter.dataset.srcFile || '',
+      headingText: nearestHeadingText(chapter, sel)
+    };
+
+    var rect = sel.getRangeAt(0).getBoundingClientRect();
+    btn.style.display = 'block';
+    btn.style.top = (window.scrollY + rect.bottom + 6) + 'px';
+    btn.style.left = (window.scrollX + rect.left) + 'px';
+  });
+
+  function hideButton() {
+    btn.style.display = 'none';
+    current = null;
+  }
+
+  function nearestHeadingText(chapter, sel) {
+    var headings = chapter.querySelectorAll('h1[id], h2[id], h3[id]');
+    if (!headings.length) return '';
+    var range = sel.getRangeAt(0);
+    for (var i = headings.length - 1; i >= 0; i--) {
+      var hr = document.createRange();
+      hr.selectNode(headings[i]);
+      if (range.compareBoundaryPoints(Range.START_TO_START, hr) >= 0) {
+        return headings[i].textContent.trim();
+      }
+    }
+    return headings[0].textContent.trim();
+  }
+
+  btn.addEventListener('click', function(e) {
+    e.preventDefault();
+    e.stopPropagation();
+    if (!current) return;
+    openPanel(current);
+    hideButton();
+  });
+
+  // ── Report panel ──
+
+  var panel = null;
+
+  function buildPanel() {
+    if (panel) return;
+    panel = document.createElement('div');
+    panel.id = 'ligarb-fb-panel';
+    var options = TYPES.map(function(t) {
+      return '<option value="' + escapeHTML(t.value) + '">' + escapeHTML(t.label) + '</option>';
+    }).join('');
+    panel.innerHTML =
+      '<div class="ligarb-fb-title">Report as issue</div>' +
+      '<div class="ligarb-fb-quote"></div>' +
+      '<label class="ligarb-fb-label" for="ligarb-fb-type">種類 / Type</label>' +
+      '<select id="ligarb-fb-type">' + options + '</select>' +
+      '<label class="ligarb-fb-label" for="ligarb-fb-details">コメント / Comment</label>' +
+      '<textarea id="ligarb-fb-details" placeholder="何が問題か、どう直すとよいか…"></textarea>' +
+      '<div class="ligarb-fb-actions">' +
+        '<button type="button" class="ligarb-fb-cancel">Cancel</button>' +
+        '<button type="button" class="ligarb-fb-submit">Report as issue</button>' +
+      '</div>';
+    document.body.appendChild(panel);
+
+    panel.querySelector('.ligarb-fb-cancel').addEventListener('click', closePanel);
+    panel.querySelector('.ligarb-fb-submit').addEventListener('click', submit);
+  }
+
+  function openPanel(ctx) {
+    buildPanel();
+    panel._ctx = ctx;
+    panel.querySelector('.ligarb-fb-quote').textContent = ctx.quote;
+    panel.querySelector('#ligarb-fb-type').value = '';
+    panel.querySelector('#ligarb-fb-details').value = '';
+
+    // Center-ish, then clamp into the viewport.
+    panel.classList.add('open');
+    var w = panel.offsetWidth, h = panel.offsetHeight;
+    var top = Math.max(12, (window.innerHeight - h) / 2);
+    var left = Math.max(12, (window.innerWidth - w) / 2);
+    panel.style.top = top + 'px';
+    panel.style.left = left + 'px';
+    panel.querySelector('#ligarb-fb-details').focus();
+  }
+
+  function closePanel() {
+    if (panel) panel.classList.remove('open');
+  }
+
+  function submit() {
+    var ctx = panel._ctx;
+    if (!ctx) return;
+    var type = panel.querySelector('#ligarb-fb-type').value;
+    var comment = panel.querySelector('#ligarb-fb-details').value.trim();
+
+    var locationLines = [];
+    var section = [ctx.chapterTitle, ctx.headingText].filter(Boolean).join(' › ');
+    if (section) locationLines.push('章/節: ' + section);
+    if (ctx.srcFile) locationLines.push('ソース: ' + ctx.srcFile);
+    locationLines.push('URL: ' + window.location.href);
+
+    var detailsLines = [];
+    if (type) detailsLines.push('種類: ' + type);
+    if (comment) detailsLines.push(comment);
+
+    var quote = ctx.quote;
+    if (quote.length > MAX_QUOTE) quote = quote.slice(0, MAX_QUOTE) + ' …(truncated)';
+
+    var url = buildUrl(locationLines.join('\n'), quote, detailsLines.join('\n\n'));
+
+    // If still too long, progressively shorten the quote.
+    while (url.length > MAX_URL && quote.length > 80) {
+      quote = quote.slice(0, Math.floor(quote.length / 2)) + ' …(truncated)';
+      url = buildUrl(locationLines.join('\n'), quote, detailsLines.join('\n\n'));
+    }
+
+    window.open(url, '_blank', 'noopener');
+    closePanel();
+  }
+
+  function buildUrl(location, quote, details) {
+    var params = 'template=' + enc(TEMPLATE);
+    if (LABELS.length) params += '&labels=' + enc(LABELS.join(','));
+    params += '&location=' + enc(location);
+    params += '&quote=' + enc(quote);
+    params += '&details=' + enc(details);
+    return ISSUE_BASE + '?' + params;
+  }
+
+  document.addEventListener('keydown', function(e) {
+    if (e.key === 'Escape') closePanel();
+  });
+})();

data/lib/ligarb/builder.rb

@@ -41,7 +41,8 @@ module Ligarb
       html = Template.new.render(config: @config, chapters: all_chapters,
                                  structure: structure, assets: assets,
                                  index_entries: index_entries,
-                                 bibliography: bibliography)
+                                 bibliography: bibliography,
+                                 github_review: github_review_data(@config))
 
       FileUtils.mkdir_p(@config.output_path)
       output_file = File.join(@config.output_path, "index.html")
@@ -76,8 +77,10 @@ module Ligarb
       assets.detect(all_lang_chapters)
       assets.provision!
 
+      gr_config = langs.first && langs.first[:config]
       html = Template.new.render_multilang(langs: langs, assets: assets,
-                                           hub_data: hub_data)
+                                           hub_data: hub_data,
+                                           github_review: gr_config && github_review_data(gr_config))
 
       FileUtils.mkdir_p(output_path)
       output_file = File.join(output_path, "index.html")
@@ -198,6 +201,24 @@ module Ligarb
       end
     end
 
+    # Builds the data passed to the template for the reader feedback UI, or nil
+    # when it should not be injected. Requires `repository` (the issues/new base);
+    # warns and skips if the UI was requested but no repository is set.
+    def github_review_data(config)
+      return nil unless config.github_review_enabled?
+
+      unless config.repository
+        warn "Warning: github_review.enabled is true but 'repository' is not set; skipping the reader feedback UI"
+        return nil
+      end
+
+      {
+        base: config.repository.chomp("/"),
+        issue_template: config.github_review_issue_template,
+        labels: config.github_review_labels,
+      }
+    end
+
     def assign_relative_paths(chapters)
       git_root = find_git_root(@config.base_dir)
       chapters.each do |ch|

data/lib/ligarb/claude_runner.rb

@@ -88,8 +88,9 @@ module Ligarb
         - You may include multiple <patch> blocks for one or more files
         - If the comment applies to multiple chapters, read all relevant chapters and provide patches for each
         - When adding citations ([@key]), also add the corresponding entry to the bibliography file
-        - Use ligarb Markdown features (admonitions, cross-references, index, etc.) where appropriate
+        - Use ligarb Markdown features from the spec where appropriate
         - If no code change is needed (e.g. answering a question), omit the <patch> blocks
+        - Refuse changes that would introduce security issues (e.g. injecting scripts, untrusted URLs, or arbitrary HTML)
       PROMPT
     end