nydp-html 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85b8b871b325a09e1ed4092544af3205820e3185
-  data.tar.gz: 0138daad46a200840138859679f2a2b2d7987c8d
+  metadata.gz: 751aa88fd39cb3d8f3a95ade9ed8160572f45092
+  data.tar.gz: 43f776df056578e92a468cbabd376cf4d2839433
 SHA512:
-  metadata.gz: 7e5afdc1dfd90171a94ef3e0e7bcc66e4d44bc076cdbfccb7358cb03fd0025a9576a575a8df6110b50c7813bf2f14ed92444d66123dcf41400e9a828b11663a0
-  data.tar.gz: 864f724f996c71ec0f0a61f7b486cbcb87bd86002d0ddd1fd14c7de8fed1363c9dbb116e8e08b3dead3102f92a0756fe01648830ffe2a4ccc8d4d8737db41057
+  metadata.gz: f1f82b3e379729919d5c1338dd33834d8c490acd9fa502cdd0cf53ceb9185fcae02f132717ae0b5a456748366fdcedac0f5d95a42716db7bf4684a63bd2dc65a
+  data.tar.gz: 0cc111be4533c79bb865e85b7a42f3952bbc082ecc4a7cdcac08136be730634d980617fa748b498b10308d94bf860227c0abe6ae75ec1859ccdc63978b54cf70

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 conanite
+Copyright (c) 2014-2016 Conan Dalton conan@conandalton.net
 
 MIT License
 

data/lib/lisp/html-010-tools.nydp

@@ -23,25 +23,46 @@ Also provides percent-syntax for concise html-generation in nydp, for example
                (splot (or (hash-get hsh part)
                           part)))))
 
-(def html-split-fn (seq sep hsh escapef)
+(def html-split-fn (seq sep hsh escapef piece-handler)
   (fn (piece)
       (if (isa 'string piece)
           piece
           (let key (j "hsf:" (seq) ":hsf")
-            (hash-set hsh key `(interpolate ,piece))
+            (hash-set hsh key (piece-handler piece))
             (escapef:j sep key sep)))))
 
-(def html-process-parts (parts converter)
-  (with (hsh  (hash)
-         sep  (random-string 12))
-        (html-resplit (string-split (converter.method
-                                               (j:map (html-split-fn (seqf 0) sep hsh converter.esc)
-                                                  parts))
-                                    sep)
-                      hsh)))
+(def html-build-processor (converter)
+  (with (hsh (hash)
+         sep (random-string 12))
+        { method    converter.method
+          processor (html-split-fn (seqf 0)
+                                   sep
+                                   hsh
+                                   (or converter.esc x1)
+                                   (or converter.interpolate interpolatify))
+          hsh       hsh
+          sep       sep }))
+
+(def interpolatify (arg) `(interpolate ,arg))
+
+(def html-process-parts (parts processor)
+  ; 'parts a mixed list containing strings or uncompiled lisp forms - the cdr of 'string-pieces after parting a string with interpolations
+  ; 'converter is a hash with the following keys
+  ; * method - textile-to-html, haml-to-html, or strip-nydp-tags, or anything that takes a string and returns a string
+  ; * esc - a function that takes a string and returns another string such that when 'method processes the result, the original string is returned. For example, if 'method is 'textile-to-html, then 'esc could be (fn (txt) "==~|txt|==") because "==" is used by textile to mark text not-to-be-processed.
+  ; * interpolator - a function that takes an uncompiled lisp form and returns another uncompiled lisp form such that when executed in the context of 'string-pieces will give the desired result
+  ; returns a mixed list containing strings or uncompiled lisp forms such that the concatenation of the list is html output by converter.method (the textile, haml, or other processor)
+  (html-resplit (string-split (processor.method (j:map processor.processor parts))
+                              processor.sep)
+                processor.hsh))
 
 (def html-build-interpolator (pieces converter)
-  `(string-pieces ,@(html-process-parts pieces converter)))
+  `(string-pieces ,@(html-process-parts pieces (html-build-processor converter))))
+
+(def strip-nydp-tags (txt)
+  ; remove <nydp> and </nydp> tags from given 'txt, some editing environments (ckeditor) may require such tags
+  ; in order to protect active content from reformatting or other transformations
+  (string-replace "</?nydp>" "" txt))
 
 (mac render-as-html (arg)
      ; produce code to convert 'arg to html using a null interpreter.
@@ -59,7 +80,7 @@ Also provides percent-syntax for concise html-generation in nydp, for example
          arg
          (and (pair? arg)
               (eq? 'string-pieces (car arg)))
-         (html-build-interpolator (cdr arg) { method x1 esc x1 })
+         (html-build-interpolator (cdr arg) { method strip-nydp-tags esc x1 })
          arg))
 
 (mac render-as-haml (arg)
@@ -92,6 +113,14 @@ Also provides percent-syntax for concise html-generation in nydp, for example
          (html-build-interpolator (cdr arg) { method textile-to-html esc notextile-esc })
          `(textile-to-html ,arg)))
 
+(def textile-to-html-source (doc)
+     (if (isa 'string doc)
+         (textile-to-html doc)
+         (and (pair? arg)
+              (eq?   'string-pieces (car arg)))
+         (html-build-interpolator (cdr arg) { method textile-to-html esc notextile-esc })
+         (error "can't convert doc to html: not a string")))
+
 (def to-css-rule (prop val) (joinstr "" prop ":" val ";"))
 
 (def to-css (hsh)
@@ -133,8 +162,11 @@ Also provides percent-syntax for concise html-generation in nydp, for example
                            (+ `(class ,(joinstr " " (cdr dot-params))) attrs)))
       (build-html-tag-fn (to-string tagname) attrs)))
 
-(mac percent-syntax names
-  (html-percent-syntax (cadr names) nil))
+(mac percent-syntax (empty . names)
+  (let name (car names)
+    (if (caris 'colon-syntax name)
+        `(colon-syntax ,(html-percent-syntax (cadr name) nil) ,@(cddr name))
+        (html-percent-syntax name nil))))
 
 (define-prefix-list-macro "^%.+" vars expr
   ; allows (%a(href "/fr/index") "click" name)
@@ -160,3 +192,5 @@ Also provides percent-syntax for concise html-generation in nydp, for example
   (string-replace ">" "&gt;"
     (string-replace "<" "&lt;"
       (string-replace "&" "&amp;" txt))))
+
+(def/cycler rowclass (oddrow evenrow))

data/lib/lisp/html-020-help.nydp

@@ -17,7 +17,7 @@
                      (%div.key k)
                      "->"
                      (%div.keyvalue (helpful/type thing.,k))))
-       (hash-keys thing)))
+       (sort:hash-keys thing)))
 
 (def helpful/info (thing)
   ; tries to say something useful about the thing

data/lib/lisp/html-030-html-documentation.nydp

@@ -0,0 +1,96 @@
+(chapter-start 'html-help "Utilities for generating html-formatted documentation")
+
+(def helpful/chapters/path (chapter-name)
+  ; override this to customise for your own application's routes
+  "/dox/chapters/~chapter-name")
+
+(def helpful/items/path (item-name)
+  ; override this to customise for your own application's routes
+  "/dox/items/~(percent-encode item-name)")
+
+(defmemo helpful/chapters/index ()
+  ; return a HTML table element with a row for each chapter. Each row provides a link to the chapter,
+  ; the chapter descripton, and chapter content names
+  (%table.chapters
+          (mapx (sort (chapter-names)) chap
+                (%tr (%td (%a(href (helpful/chapters/path chap)) chap))
+                     (let chapter (chapter-find chap)
+                       (j (%td chapter.description)
+                          (%td (joinstr "\n"
+                                        (map λi(%a.item(href (helpful/items/path i.name)) (hesc i.name))
+                                             chapter.contents)))))))))
+
+(defmemo helpful/chapters/show (chapter-name)
+  ; return a HTML div element containing a paragraph for the chapter description, and a table element
+  ; containing  a row for each item. Each item row provides a link to the item, the item type, and
+  ; the item documentation
+  (let chapter (chapter-find chapter-name)
+    (%div (%p chapter.description)
+          (%table.chapter-items
+                  (mapx (sort-by &name chapter.contents) item-group
+                        (mapx item-group item
+                              (%tr(class (rowclass))
+                                  (%td item.what)
+                                  (%td (%a.item(href (helpful/items/path item.name)) item.name))
+                                  (%td (render-as-textile (joinstr "\n" item.texts))))))))))
+
+
+; generate html to present documentation for a 'def or a 'mac
+(def helpful/item/def (item)
+  (%div.item-info
+        (%h4 (%span.type item.what) " "
+             (%span.name item.name) " "
+             (%span.small.args (inspect item.args)))
+        (%p.small "Defined in " (%b (inspect item.file)) " in plugin " (%b (inspect item.plugin)))
+        (%p
+         (j:map λc(%a.chapter(href (helpful/chapters/path c)) c) item.chapters)
+         (render-as-textile (joinstr "\n" item.texts)))
+        (%h4 "Source")
+        (%pre.source (preserve:hesc:dox-show-src item.src))))
+
+; generate html documentation for a setting
+(def helpful/item/setting (item)
+  (%div.item-info
+     (%h4 (%span.type item.setting.context) " " (%span.name item.name))
+     (%p (j:map λc(%a.chapter(href (helpful/chapters/path c)) c) item.chapters)
+         (render-as-textile (joinstr "\n" item.texts)))
+    (%h4 "Current value (evaluated)")
+    (%pre.source:setting item.setting.name)
+    (%h4 "Definitions and sources")
+    (%table.setting-values (settings/values/help item.values))))
+
+(assign helpful/handlers
+        {
+         def     helpful/item/def
+         mac     helpful/item/def
+         setting helpful/item/setting
+        })
+
+(def helpful/item/info (item)
+  ((hash-get helpful/handlers item.what) item))
+
+(def helpful/item/example (example)
+  (%div.item-example
+        (%h5 "example: " (%b (car example)))
+        (%pre.source (preserve:hesc:dox-show-src:cadr example))
+        (%pre.source (preserve:hesc:dox-show-src:caddr example))))
+
+(defmemo helpful/item (item-name)
+  ; return a HTML div element with lots of information about the named item
+  (with (items    (dox-lookup item-name)
+         examples (dox-examples item-name))
+    (%div.items-info
+          (j:map λi(helpful/item/info i) items)
+          (%h4 "Examples")
+          (j:map λx(map λy(helpful/item/example y) x) examples))))
+
+; show history of setters for this item
+(def settings/values/help (values)
+  (map-inline values val
+    (%tr (%td val.plugin) (%td val.script) (%td (%pre.source:preserve:hesc:dox-show-src val.value)))))
+
+; show history of setters for item with given name, except for initial default value
+(def settings/values (name) (aif (dox-item-by-type 'setting (sym name)) (settings/values/help (all-but-last it.values))))
+
+; generate html documentation for the setting with the given name
+(def settings/help (name) (settings/help/item (dox-item-by-type 'setting (sym name))))

data/lib/lisp/tests/help-examples.nydp

@@ -1,4 +1,3 @@
-;; this function and the following example are used as test-cases in examples-for help
 (def test-example-f (foo)
   ; more than just foo
   (+ 2 foo))
@@ -48,8 +47,7 @@ more than just foo
 
 source
 ======
-(def test-example-f (foo)
-    (+ 2 foo))
+(def test-example-f (foo) (+ 2 foo))
 
 
 <div class='helpful-examples'><h2>Examples for <span class='example-name'>test-example-f</span></h2><pre class='helpful-example'>test-example-f adds two to 45

data/lib/lisp/tests/html-examples.nydp

@@ -30,3 +30,16 @@
                   "</li>\n  <li>item " (interpolate (assign counter (+ counter 1)))
                   "</li>\n  <li>item " (interpolate (assign counter (+ counter 1)))
                   "</li>\n</ul>\n")))
+
+(examples-for strip-nydp-tags
+  ("does nothing to an empty string"
+   (strip-nydp-tags "")
+   "")
+
+  ("does nothing to an ordinary string with no nydp tag"
+   (strip-nydp-tags "hello nothing to see here")
+   "hello nothing to see here")
+
+  ("removes <nydp> and </nydp> tags from given string"
+   (strip-nydp-tags "blah blah <nydp>\~(blah)</nydp> more blah")
+   "blah blah \~(blah) more blah"))

data/lib/lisp/tests/html-tag-tests.nydp

@@ -49,9 +49,17 @@
    (%p "hello " (%b.thick.dense "you") " over " (%i "there"))
    "<p>hello <b class='thick dense'>you</b> over <i>there</i></p>")
 
+  ("combine with colon syntax : precompile"
+   (pre-compile:car:parse "%th:len")
+   (fn args ((fn args (apply html-tag "th" nil args)) (apply len args))))
+
+  ("combine with colon syntax"
+   (%th:len "foobar")
+   "<th>6</th>")
+
   ("does not insert empty 'brace-list for no attributes"
    (pre-compile '(%p foo))
-   ((curry html-tag "p" nil) foo)))
+   ((fn args (apply html-tag "p" nil args)) foo))
 
 (examples-for prefix-list
   ("generates a simple html tag with attributes"

data/lib/lisp/tests/percent-encode-examples.nydp

@@ -20,5 +20,5 @@
    "a-b")
 
   ("escapes a bunch of stuff in the same string"
-   (percent-encode "x[y?]=a&b%c")
-   "x%5By%3F%5D=a&b%25c"))
+   (percent-encode "x[y?]=a&b%c/d")
+   "x%5By%3F%5D=a&b%25c%2Fd"))

data/lib/lisp/tests/textile-tests.nydp

@@ -1,26 +1,25 @@
-(register-test
- '(suite "textile"
-         ("build a function to render a given textile string with the given arguments"
-          (pre-compile '(render-as-textile "hello ~context.name this file was in ~(just source.name)."))
-          (string-pieces
-           "<p>hello "
-           (interpolate (hash-get context 'name))
-           " this file was in "
-           (interpolate (hash-get source 'name))
-           ".</p>"))
-
-         ("render a plain textile string to html"
-          (render-as-textile "h1. header text
+(examples-for render-as-textile
+  ("build a function to render a given textile string with the given arguments"
+   (pre-compile '(render-as-textile "hello ~context.name this file was in ~(just source.name)."))
+   (string-pieces
+    "<p>hello "
+    (interpolate (hash-get context 'name))
+    " this file was in "
+    (interpolate (hash-get source 'name))
+    ".</p>"))
+
+  ("render a plain textile string to html"
+   (render-as-textile "h1. header text
 
 paragraph text
 
 * item 1
 * item 2
 ")
-          "<h1>header text</h1>\n<p>paragraph text</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n</ul>")
+   "<h1>header text</h1>\n<p>paragraph text</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n</ul>")
 
-         ("compile a string with interpolations to an instruction to generate textile"
-          (pre-compile '(render-as-textile "h1. HEADER
+  ("compile a string with interpolations to an instruction to generate textile"
+   (pre-compile '(render-as-textile "h1. HEADER
 
 ~a and ~b and ~(c 3)
 
@@ -29,39 +28,39 @@ paragraph text
 * item ~(assign counter (+ counter 1))
 "))
 
-          (string-pieces "<h1>HEADER</h1>\n<p>"
-                         (interpolate a) " and " (interpolate b) " and " (interpolate (c 3))
-                         "</p>\n<ul>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
-                         "</li>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
-                         "</li>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
-                         "</li>\n</ul>"))
+   (string-pieces "<h1>HEADER</h1>\n<p>"
+                  (interpolate a) " and " (interpolate b) " and " (interpolate (c 3))
+                  "</p>\n<ul>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
+                  "</li>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
+                  "</li>\n\t<li>item " (interpolate (assign counter (+ counter 1)))
+                  "</li>\n</ul>"))
 
-         ("compile a function invocation to render as textile"
-          (pre-compile '(render-as-textile a))
-          (textile-to-html a))
+  ("compile a function invocation to render as textile"
+   (pre-compile '(render-as-textile a))
+   (textile-to-html a))
 
-         ("compile a plain string with no interpolations to an instruction to generate textile"
-          (pre-compile '(render-as-textile "h1. HEADER
+  ("compile a plain string with no interpolations to an instruction to generate textile"
+   (pre-compile '(render-as-textile "h1. HEADER
 
 para
 
 * item 1
 * item 2
 "))
-          "<h1>HEADER</h1>\n<p>para</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n</ul>")
+   "<h1>HEADER</h1>\n<p>para</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n</ul>")
 
-         ("compile a simple string with one interpolation to render html"
-          (pre-compile '(render-as-textile "hello ~name "))
-          (string-pieces "<p>hello " (interpolate name) "</p>"))
+  ("compile a simple string with one interpolation to render html"
+   (pre-compile '(render-as-textile "hello ~name "))
+   (string-pieces "<p>hello " (interpolate name) "</p>"))
 
-         ("render a simple string with one interpolation to html"
-          (let name "conan"
-               (render-as-textile "hello ~name "))
-          "<p>hello conan</p>")
+  ("render a simple string with one interpolation to html"
+   (let name "conan"
+     (render-as-textile "hello ~name "))
+   "<p>hello conan</p>")
 
-         ("render a string with interpolations to html"
-          (with (a 1 b 2 c (fn (x) (* 2 x)) counter 0)
-                (render-as-textile "h1. HEADER
+  ("render a string with interpolations to html"
+   (with (a 1 b 2 c (fn (x) (* 2 x)) counter 0)
+         (render-as-textile "h1. HEADER
 
 ~a and ~b and ~(c 3)
 
@@ -70,20 +69,20 @@ para
 * item ~(assign counter (+ counter 1))
 "))
 
-          "<h1>HEADER</h1>\n<p>1 and 2 and 6</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n\t<li>item 3</li>\n</ul>")
+   "<h1>HEADER</h1>\n<p>1 and 2 and 6</p>\n<ul>\n\t<li>item 1</li>\n\t<li>item 2</li>\n\t<li>item 3</li>\n</ul>")
 
-         ("render a string with no interpolations to html"
-          (with (a "hello, world") (render-as-textile a))
+  ("render a string with no interpolations to html"
+   (with (a "hello, world") (render-as-textile a))
 
-          "<p>hello, world</p>")
+   "<p>hello, world</p>")
 
-         ("render a string containing only a single interpolation"
-          (with (π 3.14 r 12) (render-as-textile "~(* (* r r) π)"))
+  ("render a string containing only a single interpolation"
+   (with (π 3.14 r 12) (render-as-textile "~(* (* r r) π)"))
 
-          "452.16")
+   "452.16")
 
-         ("render a longer multi-line string with some lines containing only a single interpolation"
-          (with (π 3.14 r 12) (render-as-textile "Start
+  ("render a longer multi-line string with some lines containing only a single interpolation"
+   (with (π 3.14 r 12) (render-as-textile "Start
 
 ~(* (* r r) π)
 
@@ -94,4 +93,4 @@ para
 end
 "))
 
-          "<p>Start</p>\n452.16<p>-*-</p>\n904.32<p>end</p>")))
+   "<p>Start</p>\n452.16<p>-*-</p>\n904.32<p>end</p>"))

data/lib/lisp/tests/textile-to-source-examples.nydp

@@ -0,0 +1,30 @@
+(examples-for textile-to-html-source
+  ("returns a html string for a textile string"
+   (textile-to-html-source "h1. hello
+
+* item 1
+* item 2
+
+bye")
+   "<h1>hello</h1>
+<ul>
+\t<li>item 1</li>
+\t<li>item 2</li>
+</ul>
+<p>bye</p>")
+
+  ("returns a html string with interpolations for a textile string with interpolations"
+   (textile-to-html-source "h1. hello
+
+* item ~~first
+* item ~~(second items)
+
+bye")
+   "<h1>hello</h1>
+<ul>
+\t<li>item ~~first</li>
+\t<li>item ~~(second items)</li>
+</ul>
+<p>bye</p>")
+
+)

data/lib/nydp/html.rb

@@ -42,7 +42,7 @@ module Nydp
       end
 
       def percent_encode s
-        s.gsub('%', '%25').gsub(/[ \n"\?.<>\\^_`{\|}~\[\]]/) { |x| "%%%2X" % x.ord }
+        s.gsub('%', '%25').gsub(/[ \n"\?.<>\\^_`{\|}~\[\]\/]/) { |x| "%%%2X" % x.ord }
       end
     end
 

data/lib/nydp/html/version.rb

@@ -1,5 +1,5 @@
 module Nydp
   module Html
-    VERSION = "0.0.16"
+    VERSION = "0.0.17"
   end
 end

data/nydp-html.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec_numbering_formatter'
 
-  spec.add_dependency             'nydp',    '~> 0.2.1'
+  spec.add_dependency             'nydp',    '~> 0.4.2'
   spec.add_dependency             'haml',    '~> 4.0'
   spec.add_dependency             'haml-contrib'
   spec.add_dependency             'RedCloth'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nydp-html
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Conan Dalton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +138,7 @@ files:
 - bin/nydp-tests
 - lib/lisp/html-010-tools.nydp
 - lib/lisp/html-020-help.nydp
+- lib/lisp/html-030-html-documentation.nydp
 - lib/lisp/tests/haml-tests.nydp
 - lib/lisp/tests/help-examples.nydp
 - lib/lisp/tests/hesc-examples.nydp
@@ -145,6 +146,7 @@ files:
 - lib/lisp/tests/html-tag-tests.nydp
 - lib/lisp/tests/percent-encode-examples.nydp
 - lib/lisp/tests/textile-tests.nydp
+- lib/lisp/tests/textile-to-source-examples.nydp
 - lib/lisp/tests/to-url-examples.nydp
 - lib/nydp/html.rb
 - lib/nydp/html/version.rb