nydp-html 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c6bd4ce8e9265ae9efdf0b5be0e0d0a19d5e017
-  data.tar.gz: 714c127398ed568b92ec43b4bf4b38818de09865
+  metadata.gz: 9072543e9d73bf1cba1b4a1d3e8a948986afa2cb
+  data.tar.gz: 63bcce7beddc22b819218a1d09a66c7d15904c88
 SHA512:
-  metadata.gz: 7b9d69c89841bef6e7490406e86c8758b7190558ba6789fac51ca9b19af7ed15568ac3db2899e875bd3b11d92289bb518c3bd40ca25d40b540da9497cf514c24
-  data.tar.gz: f720b775f02ca686b956fe8f6142bfe80defff0ba8f4d6bfeb72916252f9707f5fb04621d253b385b455fc74382f7227a3600eebf10d5af077eddd24105d99f8
+  metadata.gz: 5afdc105df1bcb48d34e124a60ab930456df57fef490698d3f12c4265e04153b357a62e73c6d9d826d9d19c1f1ffea2dbe1b166873434e69331a54c0c06aea09
+  data.tar.gz: 227ad74bf6660d041e1b24e468c294d1222d817e52aeb93415912bbaa390c4b9fd45b335ee0af84f8fb81371d1e60239b331a59de818e443071aef1cdaad69df

data/lib/lisp/{to-html.nydp → html-010-tools.nydp}

@@ -1,17 +1,3 @@
-;
-; render-as-textile:
-;
-; (render-as-textile "hello world")                   ;=>  "<p>hello world</p>"
-; (render-as-textile (get-some-text-from 'somewhere)) ;=>  (textile-to-html (get-some-text-from 'somewhere))
-; (render-as-textile "hello ~name")                   ;=> (string-pieces "<p>hello" name "<p>")
-;
-; render-as-haml:
-;
-; (render-as-haml "%p hello world")                ;=> "<p>hello world</p>"
-; (render-as-haml (get-some-text-from 'somewhere)) ;=> (haml-to-html (get-some-text-from 'somewhere))
-; (render-as-haml "%p hello ~name")                ;=>  (string-pieces "<p>hello" name "<p>")
-;
-
 (def interpolate (arg) arg)
 
 (def html-process-parts (parts converter)
@@ -31,6 +17,12 @@
                                           (map html-interpolatify-arg tuples))))))
 
 (mac render-as-haml (arg)
+     ; produce code to convert 'arg to html using a haml interpreter
+     ; for example:
+     ;
+     ; (render-as-haml "%p hello world")                ;=> "<p>hello world</p>"
+     ; (render-as-haml (get-some-text-from 'somewhere)) ;=> (haml-to-html (get-some-text-from 'somewhere))
+     ; (render-as-haml "%p hello ~name")                ;=>  (string-pieces "<p>hello" name "<p>")
      (if (isa 'string arg)
          (haml-to-html arg)
          (and (pair? arg)
@@ -39,6 +31,12 @@
          `(haml-to-html ,arg)))
 
 (mac render-as-textile (arg)
+     ; produces code to convert 'arg to html using a textile interpreter
+     ; for example:
+     ;
+     ; (render-as-textile "hello world")                   ;=>  "<p>hello world</p>"
+     ; (render-as-textile (get-some-text-from 'somewhere)) ;=>  (textile-to-html (get-some-text-from 'somewhere))
+     ; (render-as-textile "hello ~name")                   ;=> (string-pieces "<p>hello" name "<p>")
      (if (isa 'string arg)
          (textile-to-html arg)
          (and (pair? arg)
@@ -49,6 +47,15 @@
 (def to-css-rule (prop val) (joinstr "" prop ":" val ";"))
 
 (def to-css (hsh)
+  ; convert given 'hsh to a CSS string. Keys of 'hsh are
+  ; css properties; the corresponding values are css values.
+  ;
+  ; example:
+  ; (to-css { background "black" font-size "12px" })
+  ;
+  ; produces
+  ; "background:black;font-size:12px;"
+  ;
   (and hsh
        (joinstr "" (map (fn (k) (to-css-rule k hsh.,k))
                         (hash-keys hsh)))))

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

@@ -0,0 +1,62 @@
+(def helpful/type (thing)
+  (if (no thing)
+      "nil"
+      (let type (type-of thing)
+        (if (string-match type "ruby/Hash")
+            'ruby-hash
+            (string-match type "ruby/")
+            'object
+            type))))
+
+(def helpful/info (thing)
+  ; tries to say something useful about the 'thing
+  (if (no thing)
+      "nil"
+      (pair? thing)
+      "list with ~(len thing) elements, first is a ~(helpful/type:car thing)"
+      (let mytype (helpful/type thing)
+        (if (or (eq? mytype 'hash)
+                (eq? mytype 'ruby-hash)
+                (eq? mytype 'object))
+            (joinstr "\n"
+                     (map λk(joinstr " -> " k (helpful/type thing.,k))
+                          (hash-keys thing)))
+            "~(inspect thing) is a ~(helpful/type thing)"))))
+
+(def helpful/index ()
+  ; return the names and types of all the things that are documented
+  (joinstr "\n"
+           (map (curry inspect:firstn 2)
+                (collect dox-with-documentation (dox-all-items)))))
+
+(mac helpful/dox (name)
+  ; finds documentation for the named thing
+  `(let infos (dox-lookup ',name)
+     (if (no infos)
+         (joinstr " : " ,(pp name) (helpful/info ,name))
+         (joinstr "\n\n"
+                  (map λi(apply dox-show-info i)
+                       infos)))))
+
+(def helpful/examples (name)
+  ; finds examples that have been defined for the given 'name
+  (let examples (dox-examples name)
+    (if examples
+        (joinstr "\n"
+                 (map (curry dox-show-examples name)
+                      examples)))))
+
+(mac help (thing)
+  ; returns helpful information about the thing
+  ; if thing is nil, show what help is available for
+  `(%pre.helpful ,(if (no thing)
+                      `(helpful/index)
+                      `(joinstr "\n\n"
+                                (helpful/dox ,thing)
+                                (helpful/examples ',thing)))))
+
+(def-colon-syntax help names
+  (let target (cadr names)
+    `(help ,(if (eq? target '||)
+                nil
+                target))))

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

@@ -0,0 +1,40 @@
+;; 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))
+
+(examples-for test-example-f
+  ("adds two"
+   (test-example-f 99)
+   101))
+
+(examples-for help
+  ("returns dox and examples for the given name"
+   help:test-example-f
+   "<pre class='helpful'>Function : test-example-f
+
+args : (foo)
+
+more than just foo
+
+source
+======
+(def test-example-f (foo)
+    (+ 2 foo))
+
+
+
+Examples for test-example-f
+==================
+
+test-example-f adds two
+
+running  :
+(test-example-f 99)
+
+produces : 101
+
+--------------------------------
+
+
+</pre>"))

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

@@ -1,21 +1,19 @@
-(register-test
- '(suite "html-tag functions"
-    (suite "html-tag"
-           ("returns a html string"
-            (html-tag "div" { class 'yellow style (to-css { border "1px solid blue" font-size "3em" }) }
-                      (html-tag "h1" nil "Welcome")
-                      (html-tag "p" { class "yadda" } "blah blah"))
-            "<div class='yellow' style='border:1px solid blue;font-size:3em;'><h1>Welcome</h1><p class='yadda'>blah blah</p></div>"))
-
-    (suite "img"
-           ("returns an img tag"
-            (img "/assets/face.png")
-            "<img src='/assets/face.png'/>"))
-
-    (suite "a"
-           ("returns an anchor tag"
-            (link-to "click here!" "/other-page.html" { class "turbo" })
-            "<a href='/other-page.html' class='turbo'>click here!</a>"))))
+(examples-for html-tag
+  ("returns a html string"
+   (html-tag "div" { class 'yellow style (to-css { border "1px solid blue" font-size "3em" }) }
+             (html-tag "h1" nil "Welcome")
+             (html-tag "p" { class "yadda" } "blah blah"))
+   "<div class='yellow' style='border:1px solid blue;font-size:3em;'><h1>Welcome</h1><p class='yadda'>blah blah</p></div>"))
+
+(examples-for img
+  ("returns an img tag"
+   (img "/assets/face.png")
+   "<img src='/assets/face.png'/>"))
+
+(examples-for a
+  ("returns an anchor tag"
+   (link-to "click here!" "/other-page.html" { class "turbo" })
+   "<a href='/other-page.html' class='turbo'>click here!</a>"))
 
 (examples-for percent-syntax
   ("generates a simple html tag"
@@ -30,6 +28,10 @@
    (%p "hello " (%b.thick "you") " over " (%i "there"))
    "<p>hello <b class='thick'>you</b> over <i>there</i></p>")
 
+  ("concatenates content"
+   (%p (map λx(%span.hello x) '(a b c)))
+   "<p><span class='hello'>a</span><span class='hello'>b</span><span class='hello'>c</span></p>")
+
   ("generates html tags with multiple classnames"
    (%p "hello " (%b.thick.dense "you") " over " (%i "there"))
    "<p>hello <b class='thick dense'>you</b> over <i>there</i></p>")

data/lib/nydp/html.rb

@@ -18,8 +18,7 @@ module Nydp
       end
 
       def loadfiles
-        b = relative_path('../lisp/to-html.nydp')
-        [b]
+        Dir.glob(relative_path '../lisp/html-*.nydp').sort
       end
 
       def testfiles

data/lib/nydp/html/version.rb

@@ -1,5 +1,5 @@
 module Nydp
   module Html
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nydp-html
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Conan Dalton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2015-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,10 +122,12 @@ files:
 - README.md
 - Rakefile
 - bin/nydp-tests
+- lib/lisp/html-010-tools.nydp
+- lib/lisp/html-020-help.nydp
 - lib/lisp/tests/haml-tests.nydp
+- lib/lisp/tests/help-examples.nydp
 - lib/lisp/tests/html-tag-tests.nydp
 - lib/lisp/tests/textile-tests.nydp
-- lib/lisp/to-html.nydp
 - lib/nydp/html.rb
 - lib/nydp/html/version.rb
 - nydp-html.gemspec