vedeu 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df3b0bf5973c1141fa43aec3158ed216111732e
-  data.tar.gz: 2e83e12eccb80ba91665e2b7968f7d51565c0a1f
+  metadata.gz: 60d8aaa6126ec4e15edc18e5b0c7be8a932e500c
+  data.tar.gz: 71f61ddeb4937aa1992866756386748430a64172
 SHA512:
-  metadata.gz: 156f3f9c49999d8aa267e4724291edf9894670502e90807af499089e60827473d1daf349f0fd4f294fd103da0729dd9a388cbf081f2d31da60822c332558dcb8
-  data.tar.gz: 9aaa4e225c60ced5c75a7b2d64f5406e4c728000780e75af9c3eeeecf84329e298aaa233e0ef4512e17f1c87ea9b9a3bf43993a785f0461cd2b21f68032adac4
+  metadata.gz: 00cf06475482f5dc6f3ef13c20725f7d67017446c2023a160f460cbf1f3558eb353a49e98db310a721eb7051b25c53baf6053f9de79870b437c87029e5f08806
+  data.tar.gz: 2504ea7c128679347dc7e207ff48edfc601c4870bd2e81fe0e1ccbd301d7219bfc747c9925808e096facad2ed157c65724f5f1d83de482dea2e7b573cd8d46bc

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.0

data/.yardopts

@@ -12,7 +12,6 @@ docs/chars.md
 docs/colours_styles.md
 docs/configuration.md
 docs/cursors.md
-docs/debugging.md
 docs/dsl.md
 docs/events.md
 docs/geometry.md

data/README.md

@@ -24,12 +24,10 @@ have any problems with either of these operating systems.
 Vedeu relies on the following gems, these will be automatically
  installed when you install Vedeu (as documented below).
 
-- benchmark-ips
 - bundler
 - rake
-- ruby-prof
-- thor
 - vedeu_cli
+  - thor
 
 ## Installation
 
@@ -66,7 +64,6 @@ documentation for the various aspects of Vedeu (not comprehensive):
 - [Colours & Styles](http://rubydoc.info/gems/vedeu/file/docs/colours_styles.md)
 - [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
 - [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursors.md)
-- [Debugging](http://rubydoc.info/gems/vedeu/file/docs/debugging.md)
 - [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
 - [Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
     - [Application Events](http://rubydoc.info/gems/vedeu/file/docs/events/application.md)

data/docs/api.md

@@ -129,10 +129,6 @@ See {file:docs/events.md}
   - items
   - name
 
-## Renderers
-
-### Vedeu.renderer
-
 
 # API Methods
 
@@ -490,10 +486,6 @@ You can also access the input given using the API methods:
 
 @todo Add more documentation.
 
-### Vedeu.renderer
-
-@todo Add more documentation.
-
 ### Vedeu.renderers
 
 Repository method. Access registered renderers.

data/docs/borders.md

@@ -22,6 +22,10 @@ The interfaces of Vedeu can each have their own border.
   - The last character (right) of the geometry.
 - The border can be refreshed independently of the interface.
 
+## Border DSL
+
+{include:file:docs/dsl/borders.md}
+
 ## Border Events
 
 Note: 'name' is a Symbol unless mentioned otherwise, and can be

data/docs/dsl/borders.md

@@ -0,0 +1,37 @@
+# {include:file:docs/dsl/by_method/border.md}
+
+# {include:file:docs/dsl/by_method/bottom_horizontal.md}
+
+# {include:file:docs/dsl/by_method/bottom_left.md}
+
+# {include:file:docs/dsl/by_method/bottom.md}
+
+# {include:file:docs/dsl/by_method/bottom_right.md}
+
+# {include:file:docs/dsl/by_method/caption.md}
+
+# {include:file:docs/dsl/by_method/disable.md}
+
+# {include:file:docs/dsl/by_method/enable.md}
+
+# {include:file:docs/dsl/by_method/horizontal.md}
+
+# {include:file:docs/dsl/by_method/left.md}
+
+# {include:file:docs/dsl/by_method/left_vertical.md}
+
+# {include:file:docs/dsl/by_method/right.md}
+
+# {include:file:docs/dsl/by_method/right_vertical.md}
+
+# {include:file:docs/dsl/by_method/title.md}
+
+# {include:file:docs/dsl/by_method/top_horizontal.md}
+
+# {include:file:docs/dsl/by_method/top_left.md}
+
+# {include:file:docs/dsl/by_method/top.md}
+
+# {include:file:docs/dsl/by_method/top_right.md}
+
+# {include:file:docs/dsl/by_method/vertical.md}

data/docs/dsl/by_method/background_colours.md

@@ -0,0 +1,3 @@
+Manipulate the repository of background colours.
+
+    Vedeu.background_colours

data/docs/dsl/by_method/border.md

@@ -0,0 +1,7 @@
+### Vedeu.border(name, &block)
+
+Specify the border of an interface or view with a simple DSL.
+
+    Vedeu.border :some_interface do
+      # ... some code
+    end

data/docs/dsl/by_method/bottom.md

@@ -0,0 +1,10 @@
+Enable/disable the bottom border.
+
+    Vedeu.border :border_demo do
+      bottom true  # or...
+      bottom false # or...
+      hide_bottom! # or...
+      show_bottom!
+      # ... some code
+    end
+

data/docs/dsl/by_method/bottom_horizontal.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the bottom horizontal
+part of the border.
+
+    Vedeu.border :border_demo do
+      bottom_horizontal '-'
+      # ... some code
+    end
+

data/docs/dsl/by_method/bottom_left.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the bottom left corner of the
+border.
+
+    Vedeu.border :some_interface do
+      bottom_left '+', options
+
+      # ... some code
+    end

data/docs/dsl/by_method/bottom_right.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the bottom right corner
+of the border.
+
+    Vedeu.border :border_demo do
+      bottom_right '+'
+      # ... some code
+    end
+

data/docs/dsl/by_method/caption.md

@@ -0,0 +1,11 @@
+If you have you are showing a bottom border, you could add a caption.
+
+    Vedeu.border :border_demo do
+      caption 'My Cool Caption'
+      # ... some code
+    end
+
+produces, depending on other customisations:
+
+    +------------------------------ My Cool Caption -+
+

data/docs/dsl/by_method/clear.md

@@ -0,0 +1,7 @@
+Clears the whole terminal space.
+
+    Vedeu.clear
+
+    # or...
+
+    Vedeu.trigger(:_clear_)

data/docs/dsl/by_method/configuration.md

@@ -0,0 +1,5 @@
+Returns the configuration singleton.
+
+Append configuration methods to access the configuration variable.
+
+    Vedeu.configuration

data/docs/dsl/by_method/configure.md

@@ -0,0 +1,6 @@
+Provides the mechanism to configure Vedeu. If the client application
+sets options, override the defaults with those.
+
+    Vedeu.configure do
+      # ...
+    end

data/docs/dsl/by_method/debug.md

@@ -0,0 +1,4 @@
+Drop into a debugging session within a running client application,
+courtesy of 'pry'. Will raise an exception if 'pry' is not available.
+
+    Vedeu.debug(binding, variable)

data/docs/dsl/by_method/disable.md

@@ -0,0 +1,14 @@
+Disable the border:
+
+    Vedeu.border :border_demo do
+      disable!
+      # ... some other code (will be ignored)
+    end
+
+or
+
+    Vedeu.border :border_demo do
+      disabled!
+      # ... some other code (will be ignored)
+    end
+

data/docs/dsl/by_method/enable.md

@@ -0,0 +1,14 @@
+Enable the border:
+(Borders are enabled by default when defined for an interface).
+
+    Vedeu.border :border_demo do
+      enable!
+      # ... some code
+    end
+
+or
+
+    Vedeu.border :border_demo do
+      enabled!
+      # ... some code
+    end

data/docs/dsl/by_method/foreground_colours.md

@@ -0,0 +1,3 @@
+Manipulate the repository of foreground colours.
+
+    Vedeu.foreground_colours

data/docs/dsl/by_method/goto.md

@@ -0,0 +1,6 @@
+# Instruct Vedeu to load the client application controller
+# action with parameters.
+#
+# @example
+#   Vedeu.goto(controller, action, args)
+#

data/docs/dsl/by_method/height.md

@@ -0,0 +1,7 @@
+Returns the total height (number of rows/lines) of the current
+terminal.
+
+    Vedeu.height # => provides the height via the Vedeu API.
+
+See {Vedeu::Terminal#size} for more information about the reported
+terminal size.

data/docs/dsl/by_method/horizontal.md

@@ -0,0 +1,6 @@
+Set the character to be used to draw a horizontal part of the border.
+
+    Vedeu.border :border_demo do
+      horizontal '-'
+      # ... some code
+    end

data/docs/dsl/by_method/left.md

@@ -0,0 +1,10 @@
+Enable/disable the left border.
+
+    Vedeu.border :border_demo do
+      left true  # or...
+      left false # or...
+      hide_left! # or...
+      show_left!
+      # ... some code
+    end
+

data/docs/dsl/by_method/left_vertical.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the left vertical part of
+the border.
+
+    Vedeu.border :border_demo do
+      left_vertical '|'
+      # ... some code
+    end
+

data/docs/dsl/by_method/profile.md

@@ -0,0 +1,6 @@
+Allow debugging via the creation of stack traces courtesy of
+'ruby-prof'. Will raise an exception if 'ruby-prof' is not available.
+
+    Vedeu.profile('/tmp/profile.html') do
+      # ... code to profile ...
+    end