vedeu 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abd33ac728a08d3f956652ebd9d8bac4b7c8174c
-  data.tar.gz: 9a9e106f52a0313cd07403bf11e2a39ba68c187c
+  metadata.gz: 49ac999b75c8f827532fdfd56a33cdc5df094082
+  data.tar.gz: 0ce9c396da5d723b9859dd350e6549789646b9e9
 SHA512:
-  metadata.gz: 44a86ea06288d4aa5addcd6a9035622e45f489e53c99214ac3191daf64662ea3d85044110a536ed0d30dcebcf2112ebddfddd3e54af71e3c3ae54d9c7d3b1cb1
-  data.tar.gz: 48cd0c06ff4387e3629e07a162b9ca74b4172e8cf815fe9b93e15dd4f1a3d50c8b7e162ffe6438e72bb7e295e348449ddfcc811d2ebe6914d00f822e3b057094
+  metadata.gz: 32b568646e20740ceedb3993f87e9fd45ea8da54eb07103ea85811e67859d981168279075b45c48104aabbce542143651b2603518b0c2e7e3f1e1c8d6244f8ae
+  data.tar.gz: 5d5325bf31f0f0cbdbf99726413de072aef1f2b3bf9dd6ba52fb65dc40e6e2d4744bfcfd939edace218c61ac1ed568775af8e3ed8411d44c4da0006e6224a151

data/TODO.md

@@ -0,0 +1,4 @@
+## 2016-01-16
+
+- Add Vedeu::Index which converts a Vedeu::Point to an array index.
+  i.e. Never less than 0, always 1 less than the Vedeu::Point value.

data/docs/dsl.md

@@ -113,7 +113,7 @@ end
 
 ### Creating a new named geometry
 
-{include:Vedeu::DSL::Geometry::ClassMethods.geometry}
+{include:Vedeu::DSL::Geometry::ClassMethods#geometry}
 
 ### Setting the interface dimensions
 
@@ -150,7 +150,6 @@ end
 ## Keymaps
 
 {include:Vedeu::Input::DSL}
-{include:Vedeu::Input::DSL#name}
 
 ### Creating a new named group
 
@@ -161,7 +160,6 @@ end
 {include:Vedeu::Menus::DSL}
 {include:Vedeu::Menus::DSL#item}
 {include:Vedeu::Menus::DSL#items}
-{include:Vedeu::Menus::DSL#name}
 
 ### Creating a new named menu
 
@@ -180,14 +178,6 @@ end
 
 {include:Vedeu::DSL::Views.views}
 
-### Specifying view content
-
-{include:Vedeu::DSL::Line}
-{include:Vedeu::DSL::Line#line}
-{include:Vedeu::DSL::Line#streams}
-
-`@todo` More documentation coming soon.
-
 #### Authors Notes
 
 The Rubydoc documentation has more specific information about the DSL

data/docs/dsl/by_method/geometry/align.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/align_bottom.md

@@ -0,0 +1,40 @@
+### align_bottom
+
+Providing the optional 'height' will set the interface height,
+overriding any previous or calculated value for 'height'.
+
+Aligning the view with the bottom of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_bottom
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_bottom
+
+          # ...
+    #   end
+    # end
+
+Align this view with the bottom of the terminal and setting the
+height to 20 rows/lines:
+
+    # Vedeu.geometry :my_interface do
+        align_bottom 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_bottom 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/align_centre.md

@@ -0,0 +1,40 @@
+### align_centre
+
+Providing the optional 'width' will set the interface width,
+overriding any previous or calculated value for 'width'.
+
+Aligning the view centrally within the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_centre
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_centre
+
+          # ...
+    #   end
+    # end
+
+Align this view centrally within the terminal and setting the
+width to 20 columns/chars:
+
+    # Vedeu.geometry :my_interface do
+        align_centre 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_centre 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/align_left.md

@@ -0,0 +1,40 @@
+### align_left
+
+Providing the optional 'width' will set the interface width,
+overriding any previous or calculated value for 'width'.
+
+Aligning the view to the left within the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_left
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_left
+
+          # ...
+    #   end
+    # end
+
+Align this view to the left within the terminal and setting the
+width to 20 columns/chars:
+
+    # Vedeu.geometry :my_interface do
+        align_left 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_left 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/align_middle.md

@@ -0,0 +1,40 @@
+### align_middle
+
+Providing the optional 'height' will set the interface height,
+overriding any previous or calculated value for 'height'.
+
+Aligning the view in the vertical centre of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_middle
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_middle
+
+          # ...
+    #   end
+    # end
+
+Align this view in the vertical centre of the terminal and setting the
+height to 20 rows/lines:
+
+    # Vedeu.geometry :my_interface do
+        align_middle 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_middle 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/align_right.md

@@ -0,0 +1,40 @@
+### align_right
+
+Providing the optional 'width' will set the interface width,
+overriding any previous or calculated value for 'width'.
+
+Aligning the view to the right within the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_right
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_right
+
+          # ...
+    #   end
+    # end
+
+Align this view to the right within the terminal and setting the
+width to 20 columns/chars:
+
+    # Vedeu.geometry :my_interface do
+        align_right 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_right 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/align_top.md

@@ -0,0 +1,40 @@
+### align_top
+
+Providing the optional 'height' will set the interface height,
+overriding any previous or calculated value for 'height'.
+
+Aligning the view with the top of the terminal:
+
+    # Vedeu.geometry :my_interface do
+        align_top
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_top
+
+          # ...
+    #   end
+    # end
+
+Align this view with the top of the terminal and setting the
+height to 20 rows/lines:
+
+    # Vedeu.geometry :my_interface do
+        align_top 20
+
+        # ...
+    # end
+
+or...
+
+    # Vedeu.interface :my_interface do
+    #   geometry do
+          align_top 20
+
+    #   end
+    # end

data/docs/dsl/by_method/geometry/columns.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/horizontal_alignment.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/rows.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/vertical_alignment.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/x.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/xn.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/y.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/geometry/yn.md

@@ -0,0 +1 @@
+@todo Add more documentation.

data/docs/dsl/by_method/render.md

@@ -1 +1,5 @@
-@todo Add more documentation.
+### Vedeu.render
+
+Alias for `Vedeu.renders`.
+
+See {file:docs/dsl/by_method/renders.md}

data/docs/dsl/by_method/renders.md

@@ -1 +1,31 @@
-@todo Add more documentation.
+### Vedeu.renders
+
+Also aliased as `Vedeu.render`.
+
+Directly write a view buffer to the terminal. Using this method means
+that the refresh event does not need to be triggered after creating
+the views, though can be later triggered when needed.
+
+Multiple views can be rendered inside a `renders` block as the example
+below shows:
+
+    Vedeu.renders do
+      view :some_interface do
+        # line do
+        #   stream do
+        #     left 'Title goes here', width: 35
+        #   end
+        #   stream do
+        #     right Time.now.strftime('%H:%m'), width: 7
+        #   end
+        # end
+      end
+
+      view :other_interface do
+        # lines do
+        #   line 'This is content for the main interface.'
+        #   line ''
+        #   line 'Pretty easy eh?'
+        # end
+      end
+    end

data/docs/dsl/by_method/view.md

@@ -0,0 +1,26 @@
+### `view`
+
+Used within a `Vedeu.renders` or `Vedeu.views` block, the `view` DSL
+method defines a view for the named interface.
+
+    # Vedeu.renders do
+        view :my_interface do
+          # ...
+        end
+
+        view :other_interface do
+          # ...
+        end
+    # end
+
+or
+
+    # Vedeu.views do
+        view :my_interface do
+          # ...
+        end
+
+        view :other_interface do
+          # ...
+        end
+    # end

data/docs/dsl/by_method/view/stream.md

@@ -0,0 +1,18 @@
+Multiple `stream` entries directly within a `view` are treated as
+individual lines:
+
+    # Vedeu.render do
+    #   view(name) do
+
+        stream do
+          # ...
+        end
+
+        stream do
+          # ...
+        end
+
+    #   end
+    # end
+
+

data/docs/dsl/by_method/views.md

@@ -1 +1,32 @@
-@todo Add more documentation.
+### Vedeu.views
+
+Define a view (content) for an interface.
+
+The views declared within this block are stored in their respective
+interface back buffers until a refresh event occurs. When the refresh
+event is triggered, the back buffers are swapped into the front
+buffers and the content here will be rendered.
+
+Multiple views can be rendered inside a `views` block as the example
+below shows:
+
+  Vedeu.views do
+    # view :some_interface do
+    #   line do
+    #     stream do
+    #       left 'Title goes here', width: 35
+    #     end
+    #     stream do
+    #       right Time.now.strftime('%H:%m'), width: 7
+    #     end
+    #   end
+    # end
+
+    # view :other_interface do
+    #   lines do
+    #     line 'This is content for the main interface.'
+    #     line ''
+    #     line 'Pretty easy eh?'
+    #   end
+    # end
+  end