anatomy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 547b0c69a5d69834407e72746658ae60ba8aef42
+  data.tar.gz: 4937b2321af83a9ea71d9ec66f4ff55c31cdd005
+SHA512:
+  metadata.gz: 44eee7a43b3c6421ab8d56445b4df1b814889742015be3a453fe7eabf0a2973172147aafed0ab1001379733207a045d7f011b3e66a47f58025d6dd792e143d0f
+  data.tar.gz: 29b12c49804886a3fe1ee069e9c57d91e9e04b388841517490f3613483681b5133f07cfd5605b2305db619e75ab1aa116abcad297c6a6be816c267e9e856c8ed

data/LICENSE.md

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/bin/anatomy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# vim: ft=ruby
+
+require "atomy/rubygems"
+require "anatomy/cmd"

data/lib/anatomy/atomy.ay

@@ -0,0 +1,202 @@
+use(require("atomy"))
+io = require("io")
+pretty = require("pretty")
+
+require("stringio")
+
+hl = require("hl")
+token = require("hl/token")
+atomy = hl load("atomy")
+
+use(require("anatomy/html"))
+base = require("anatomy/base")
+data = require("anatomy/data")
+
+require("atomy/message_structure")
+
+fn(format-inline(tokens, link-only = nil)):
+  tokens collect [t]:
+    data Element new(
+      -- constants, identifiers, and operators
+      if((link-only && link-only include?(t contents)) ||
+          (!link-only && ["no", "n", "o"] include?(t type tag)))
+        then:
+          data ResolveElement new(
+            [part]:
+              tag = part find-tag(t contents)
+              if(tag)
+                then: data Reference new(tag, t contents)
+                else: t contents)
+        else: t contents
+      .class(t type tag))
+
+fn(format-block(tokens, link-only = nil)):
+  data Block new(
+    base verbatim(format-inline(tokens, link-only))
+    .class("highlight"))
+
+-- redirect ALL stdout/stderr for interaction
+fn(with-all-output-to(out, err) &action):
+  before-out = io OutputPort instance-variable-get(."@default")
+  before-err = io ErrorPort instance-variable-get(."@default")
+
+  { io OutputPort instance-variable-set(."@default", out)
+    io ErrorPort instance-variable-set(."@default", err)
+
+    io with-output-to(out):
+      io with-error-to(err):
+        action call
+  } ensuring:
+    io OutputPort instance-variable-set(."@default", before-out)
+    io ErrorPort instance-variable-set(."@default", before-err)
+
+fn(interactive-line(mod, input, line, context)):
+  out = StringIO new
+  err = StringIO new
+
+  output-tokens =
+    with-restarts(use-tokens(ts): ts) {
+      res =
+        with-all-output-to(out, err):
+          mod eval(input, line)
+
+      -- shorten the long-form inspections that show the ivars
+      atomy lex(pretty show(res) sub(r"#<([^\s]+)\s+@.*$", "#<\\1>"))
+    } bind:
+      (e & Error):
+        restart(
+          .use-tokens
+          [ token Token new(
+              token Tagged new(.gr)
+              i"#{e name}: #{e message}")
+          ])
+
+  [ format-inline(
+      token Token new(token Tagged new(.caret), "> ") .
+        atomy lex(input))
+    "\n"
+    out string
+    unless(err string empty?):
+      data Element new(err string, .class("gr"))
+    format-inline(output-tokens)
+    "\n"
+  ]
+
+
+def(hl(x)): base code(format-inline(atomy new(x) run))
+def(atomy(x)): format-block(atomy new(x) run)
+
+fn(new-interaction-env(where = nil)):
+  Atomy Module new(where || "interaction") tap [mod]:
+    mod use("atomy")
+
+environments = #{}
+def(interaction(x, where = nil)):
+  mod =
+    if(where)
+      then:
+        environments[where] ||= new-interaction-env(where)
+      else:
+        new-interaction-env(where)
+
+  data Block new(
+    data Block new(
+      x split("\n") collect with-index [input, line]:
+        interactive-line(mod, input, line + 1, where)
+      .tt)
+    .class("interaction"))
+
+def(example(x, where = nil)):
+  data Block new(
+    [ data Paragraph new([data Element new("Example:", .italic)])
+      interaction(x, where)
+    ]
+    .class("example"))
+
+def(example-segment(x)):
+  data Block new(
+    [ data Paragraph new([data Element new("Example:", .italic)])
+      format-block(atomy new(x) run)
+    ]
+    .class("example"))
+
+
+def(define(what, *rules, returns, body)):
+  thumb = Atomy Parser parse-string(what)
+
+  structure = Atomy MessageStructure new(thumb nodes first)
+  message-name = structure name to-s
+  tag-name =
+    if(message-name =~ r"^[\p{Ll}_]")
+      then: message-name tr("_", "-")
+      else: message-name
+
+  display = format-inline(atomy lex(what), [tag-name])
+  data Block new(
+    [ base target-element(tag-name)
+      data Block new(
+        [ data Block new(
+            [ display
+              data Element new(
+                " => "
+                .class("definition_result_arrow"))
+              format-inline(atomy lex(returns))
+              rules collect [rule]:
+                ["\n  | ", format-inline(atomy lex(rule))]
+            ]
+            .tt)
+        ]
+        .class("thumb"))
+      body
+    ]
+    .class("definition"))
+
+def(assign(name, to, body)):
+  display = format-inline(atomy lex(name), [name])
+  data Block new(
+    [ base target-element(name)
+      data Block new(
+        [ data Block new(
+            [ display
+              data Element new(
+                " = "
+                .class("definition_result_arrow"))
+              format-inline(atomy lex(to))
+            ]
+            .tt)
+        ]
+        .class("thumb"))
+      body
+    ]
+    .class("definition", "assign"))
+
+fn(find-tags(tags, c & Atomy Grammar AST Constant)): tags << c name to-s
+fn(find-tags(tags, `((~what)(~*_)))): find-tags(tags, what)
+fn(find-tags(tags, `(~what: ~*childs))):
+  find-tags(tags, what)
+
+  childs each [c]:
+    find-tags(tags, c)
+
+def(data(tree, body)):
+  tree-ast = Atomy Parser parse-string(tree) nodes first
+
+  tag-names = []
+  find-tags(tag-names, tree-ast)
+
+  display = format-inline(atomy lex(tree), tag-names)
+  data Block new(
+    [ tag-names collect [name]: base target-element(name)
+      data Block new([base verbatim(display)], .class("thumb"))
+      body
+    ]
+    .class("definition", "data"))
+
+def(macro(pattern, *tag-names, result, body)):
+  display = format-inline(atomy lex(pattern), tag-names)
+  data Block new(
+    [ tag-names collect [name]: base target-element(name)
+      data Block new([data Block new([display], .tt)], .class("thumb"))
+      body
+    ]
+    .class("definition", "macro"))

data/lib/anatomy/base.ay

@@ -0,0 +1,151 @@
+use(require("atomy"))
+
+require("atomy/codeloader")
+
+data = require("anatomy/data")
+meta = require("anatomy/stages/meta")
+traverse = require("anatomy/stages/traverse")
+collect = require("anatomy/stages/collect")
+
+hl = require("hl")
+
+def(title(content, tag-name = data sanitize(content), *extra-tag-names)):
+  data MetaBlock new(
+    [part]:
+      part title = content
+
+      part tag = part set-tag(tag-name, .self, content)
+
+      extra-tag-names each [t]:
+        part set-tag(t))
+
+def(table-of-contents):
+  data MetaBlock new(
+    [part]:
+      part style properties << .toc)
+
+def(omit-children-from-table-of-contents):
+  data ResolveElement new(
+    [part]:
+      part omit-children-from-table-of-contents? = true
+      "")
+
+def(section(title, *tag-names, content)):
+  decode(title(title, *tag-names), content)
+
+def(include-section(path)):
+  Atomy CodeLoader require(path) doc
+
+def(include-sections(path)):
+  Dir glob(path) collect [s]:
+    Atomy CodeLoader require(s) doc
+
+def(target-element(tag-name, display = nil)):
+  data CollectElement new(
+    [part]:
+      part set-tag(tag-name, .anchor(tag-name), display)
+      data Target new(tag-name))
+
+def(verbatim(content)):
+  data Block new(content, .verbatim)
+
+def(hyperlink(url, content)):
+  data Element new(content, .hyperlink(url))
+
+def(reference(tag-name, content = nil)):
+  data ResolveElement new(
+    [part]:
+      tag = part find-tag(tag-name)
+      unless(tag):
+        warning(.undefined(tag-name))
+
+      data Reference new(
+        tag
+        content || ((tag && tag display) || tag-name)))
+
+def(centered(content)):
+  data Block new(content, .centered)
+
+def(image(asset-path, alt-text = "")):
+  data ResolveElement new(
+    [part]:
+      part assets << File expand-path(asset-path)
+
+      data Element new(
+        alt-text
+        .image(File basename(asset-path))))
+
+def(definitions(content)):
+  defs = []
+  Array(content) select [x]:
+    x match:
+      .item(name, val):
+        defs << [name, val]
+
+  data Itemization new(defs)
+
+def(item(name, content)): .item(name, content)
+
+def(italic(content)): data Element new(content, .italic)
+
+def(strike(content)): data Element new(content, .strike)
+
+def(list(*elements)): data List new(elements)
+
+def(ordered-list(*elements)): data OrderedList new(elements)
+
+def(bold(content)): data Element new(content, .bold)
+
+def(smaller(content)): data Element new(content, .smaller)
+
+def(larger(content)): data Element new(content, .larger)
+
+def(superscript(content)): data Element new(content, .superscript)
+
+def(subscript(content)): data Element new(content, .subscript)
+
+def(code(content)): data Element new(content, .tt)
+
+def(margin-note(content)): data Block new(content, .margin-note)
+
+def(aux(content)): data Element new(content, .aux)
+
+def(inset(content)): data Block new(content, .inset)
+
+fn(format-inline(tokens, link-only = nil)):
+  tokens collect [t]:
+    data Element new(
+      -- constants, identifiers, and operators
+      if((link-only && link-only include?(t contents)) ||
+          (!link-only && ["no", "n", "o"] include?(t type tag)))
+        then:
+          data ResolveElement new(
+            [part]:
+              tag = part find-tag(t contents)
+              if(tag)
+                then: data Reference new(tag, t contents)
+                else: t contents)
+        else: t contents
+      .class(t type tag))
+
+fn(format-block(tokens, link-only = nil)):
+  data Block new(
+    verbatim(format-inline(tokens, link-only))
+    .class("highlight"))
+
+def(codeblock(language, content)):
+  format-block(hl load(language) new(content) run) rescue:
+    LoadError:
+      warning(.unknown-language(language))
+      verbatim(content)
+
+def(newline): data Element new("", .newline)
+
+def(no-break(content)): data Element new(content, .no-break)
+
+def(decode(*cs)):
+  part = data Part new
+
+  meta over(cs, part)
+
+  part

data/lib/anatomy/cmd.ay

@@ -0,0 +1,60 @@
+use(require("atomy"))
+
+require("optparse")
+
+$LOAD_PATH unshift(File expand-path("../../lib", __FILE__))
+
+processor = require("anatomy/processor")
+
+ARGV shift
+
+options = #{
+  .input -> ARGV[0]
+  .output -> "."
+  .renderer -> "html"
+  .serve -> nil
+}
+
+op = OptionParser new [o]:
+  o banner = "usage: anatomy [file] [options]"
+
+  o on("-s", "--serve PORT", "serve the rendered documents on the given port") [v]:
+    options[.serve] = v to-i
+
+  o on("-i", "--input FILE", "anatomy document") [v]:
+    options[.input] = v
+
+  o on("-o", "--output DIRECTORY",
+       "where to place output documents and files") [v]:
+    options[.output] = v
+
+  o on("-r", "--renderer NAME",
+       "which renderer to use (e.g. html)") [v]:
+    options[.renderer] = v
+
+op parse!
+
+input = options[.input]
+output = options[.output]
+renderer = options[.renderer]
+
+unless(input):
+  puts(op help)
+  exit(1)
+
+-- a / in the renderer name implies it's external
+unless(renderer include?("/")):
+  renderer = i"anatomy/renderers/#{renderer}"
+
+if(options[.serve])
+  then:
+    server = require("anatomy/server") Server new(
+      options[.input]
+      options[.output]
+      processor
+      require(renderer)
+    )
+
+    server serve(options[.serve])
+  else:
+    processor process(input, require(renderer), output)