vedeu 0.6.68 → 0.6.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850ce1133d6018ed381e4ddbb4ee9bdff12e4bbb
-  data.tar.gz: bb06f89c8568103c095e448fab6a2fc3eef3dfb8
+  metadata.gz: 0a0211b4a6e94bd7926f99ff108861471ea89615
+  data.tar.gz: e083d41fa583f3ef357d1814c17fe7bd36357e46
 SHA512:
-  metadata.gz: 2cdb5a8f19a21d62dd57faead71646070464ac3072e3945d08b534a642be3ad52004e53bf8af4614c870cf18f332888595805e280f6863b8a18c36d8f07bc347
-  data.tar.gz: e045c49ba37aaf20676442a648f8e5c84bc99181835c3fd09f00b349aa21dd15926a5a76216cf6618bdf1af4e51dc60ffc3c422ab32cc869cec4281986a30e59
+  metadata.gz: f8c146bd737d56df2eda77f1b8d762b80da4f2321240df7d29d4a48904276b7932d5bf11b59e773822e7456c895c3ed84277075bd4d1ed6ad1b7fb03acb333f7
+  data.tar.gz: d46ceb3d84bc7782854ca90aebc88bef0b9c397a120b5c23514e6827f860bea645f41fe751b61160acd0d9409dc7cfa0244dc163185374e339b32207eaa32629

data/.rubocop.yml

@@ -1,9 +1,7 @@
 inherit_from:
   - config/rubocop_enabled.yml
 
-# Common configuration.
 AllCops:
-  # Include gemspec and Rakefile
   Include:
     - '**/*.gemspec'
     - '**/*.podspec'
@@ -25,20 +23,9 @@ AllCops:
     - 'examples/**/*'
     - 'test/**/*'
     - 'vendor/**/*'
-  # By default, the rails cops are not run. Override in project or home
-  # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false
-  # Cop names are not displayed in offense messages by default. Change behavior
-  # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
-  # option.
   DisplayCopNames: true
-  # Style guide URLs are not displayed in offense messages by default. Change
-  # behavior by overriding DisplayStyleGuide, or by giving the
-  # -S/--display-style-guide option.
   DisplayStyleGuide: true
-  # Additional cops that do not reference a style guide rule may be enabled by
-  # default. Change behavior by overriding StyleGuideCopsOnly, or by giving
-  # the --only-guide-cops option.
   StyleGuideCopsOnly: false
 
 Style/EmptyLinesAroundBlockBody:
@@ -50,34 +37,23 @@ Style/EmptyLinesAroundClassBody:
 Style/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines
 
-# Built-in global variables are allowed by default.
-Style/GlobalVars:
-  AllowedVariables: [$LIB_DIR]
-
-# `MinBodyLength` defines the number of lines of the a body of an if / unless
-# needs to have to trigger this cop
-Style/GuardClause:
-  MinBodyLength: 1
-
-Style/IfUnlessModifier:
-  MaxLineLength: 80
-
-Style/IndentationWidth:
-  Width: 2
-
-# Checks the indentation of the first key in a hash literal.
-Style/IndentHash:
-  # The value `special_inside_parentheses` means that hash literals with braces
-  # that have their opening brace on the same line as a surrounding opening
-  # round parenthesis, shall have their first key indented relative to the
-  # first position inside the parenthesis.
-  # The value `consistent` means that the indentation of the first key shall
-  # always be relative to the first position of the line where the opening
-  # brace is.
-  EnforcedStyle: special_inside_parentheses
-  SupportedStyles:
-    - special_inside_parentheses
-    - consistent
+# Style/GlobalVars:
+#   AllowedVariables: [$LIB_DIR]
+
+# Style/GuardClause:
+#   MinBodyLength: 1
+
+# Style/IfUnlessModifier:
+#   MaxLineLength: 80
+
+# Style/IndentationWidth:
+#   Width: 2
+
+# Style/IndentHash:
+#   EnforcedStyle: special_inside_parentheses
+#   SupportedStyles:
+#     - special_inside_parentheses
+#     - consistent
 
 Style/MultilineOperationIndentation:
   Enabled: false
@@ -85,17 +61,12 @@ Style/MultilineOperationIndentation:
 Style/ModuleFunction:
   Enabled: false
 
-Style/Next:
-  # With `always` all conditions at the end of an iteration needs to be
-  # replaced by next - with `skip_modifier_ifs` the modifier if like this one
-  # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
-  EnforcedStyle: skip_modifier_ifs
-  # `MinBodyLength` defines the number of lines of the a body of an if / unless
-  # needs to have to trigger this cop
-  MinBodyLength: 3
-  SupportedStyles:
-    - skip_modifier_ifs
-    - always
+# Style/Next:
+#   EnforcedStyle: skip_modifier_ifs
+#   MinBodyLength: 3
+#   SupportedStyles:
+#     - skip_modifier_ifs
+#     - always
 
 Style/RescueModifier:
   Enabled: false
@@ -103,17 +74,17 @@ Style/RescueModifier:
 Style/SpaceAroundOperators:
   Enabled: false
 
-Style/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: space
+# Style/SpaceAroundEqualsInParameterDefault:
+#   EnforcedStyle: space
 
-Style/SpaceBeforeBlockBraces:
-  EnforcedStyle: space
+# Style/SpaceBeforeBlockBraces:
+#   EnforcedStyle: space
 
-Style/SpaceInsideBlockBraces:
-  EnforcedStyle: space
+# Style/SpaceInsideBlockBraces:
+#   EnforcedStyle: space
 
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: space
+# Style/SpaceInsideHashLiteralBraces:
+#   EnforcedStyle: space
 
 Style/TrailingBlankLines:
   EnforcedStyle: final_newline
@@ -122,19 +93,16 @@ Style/TrailingComma:
   EnforcedStyleForMultiline: comma
 
 Metrics/AbcSize:
-  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
-  # a Float.
   Max: 25
 
-Metrics/BlockNesting:
-  Max: 3
+# Metrics/BlockNesting:
+#   Max: 3
 
-# Avoid complex methods.
 Metrics/CyclomaticComplexity:
   Max: 12
 
 Metrics/MethodLength:
-  CountComments: false  # count full line comments?
+  CountComments: false
   Max: 30
 
 Metrics/PerceivedComplexity:

data/docs/api.md

@@ -343,7 +343,7 @@ Repository method. Access registered groups.
 
 ### Vedeu.hide_cursor
 
-@todo Add more documentation.
+See {file:docs/cursors.md#vedeuhide_cursor__}
 
 ### Vedeu.hide_group
 
@@ -506,7 +506,7 @@ Repository method. Access registered renderers.
 
 ### Vedeu.show_cursor
 
-@todo Add more documentation.
+See {file:docs/cursors.md#vedeushow_cursor__}
 
 ### Vedeu.show_group
 
@@ -522,7 +522,7 @@ Repository method. Access registered renderers.
 
 ### Vedeu.toggle_cursor
 
-@todo Add more documentation.
+See {file:docs/cursors.md#vedeutoggle_cursor__}
 
 ### Vedeu.toggle_group
 

data/docs/borders.md

@@ -27,13 +27,13 @@ The interfaces of Vedeu can each have their own border.
 Note: 'name' is a Symbol unless mentioned otherwise, and can be
 substituted for `Vedeu.focus` to use the interface currently in focus.
 
-### `:\_refresh_border\_`
+### `:_refresh_border_`
 This event refreshes the border of the named view, unless the view
 does not have a border, or the border is not enabled.
 
     Vedeu.trigger(:_refresh_border_, name)
 
-### `:\_set_border_title\_`
+### `:_set_border_title_`
 This event changes the title of the border of the named view to the
 value given.
 
@@ -47,7 +47,7 @@ value given.
   refreshed, unless the view does not have a border, or the border is
   not enabled, or the top border is set not to be shown.
 
-### `:\_set_border_caption\_`
+### `:_set_border_caption_`
 This event changes the caption of the border of the named view to the
 value given.
 

data/docs/cursors.md

@@ -22,19 +22,79 @@ conveniently after the interface itself.
   the content of the interface can change position if needed.
 
 
-## Cursor Events
+## Cursor API, DSL & Events
 
 Note: 'name' is a Symbol unless mentioned otherwise, and can be
 substituted for 'Vedeu.focus' to use the interface currently in focus.
 
-### `:\_cursor_origin\_`
+Cursors are automatically created for each interface defined. You can
+specify at the interface, or view level whether a cursor is shown or
+hidden.
+
+### Interface Cursors
+The initial state of visible (true) or invisible (false) for a cursor
+can be specified when defining the interface.
+
+Each example within each interface definition is equivalent.
+
+#### Showing the cursor
+
+    Vedeu.interface :my_interface do
+      cursor true
+
+      # or...
+
+      cursor!
+
+      # ...
+    end
+
+#### Hiding the cursor
+
+    Vedeu.interface :my_interface do
+      cursor false
+
+      # or...
+
+      no_cursor!
+
+      # ...
+    end
+
+### View Cursors
+The view cursor is the same as the interface cursor with the same
+name. However, view cursors can be made visible or invisible when the
+view is rendered, overriding the initial or current state.
+
+    Vedeu.views do
+      view :my_interface do
+        cursor true # => Specify the visibility of the cursor when
+                    #    the view is rendered.
+
+        # see other examples for other settings for cursor
+      end
+    end
+
+    Vedeu.renders do
+      view :my_interface do
+        cursor false # => Specify the visibility of the cursor when
+                     #    the view is rendered.
+
+        # see other examples for other settings for cursor
+      end
+    end
+
+
+## Cursor Positioning Events
+
+### `:_cursor_origin_`
 This event moves the cursor to the interface origin; the top left
 corner of the named interface.
 
     Vedeu.trigger(:_cursor_origin_, name)
     Vedeu.trigger(:_cursor_reset_, name)
 
-### `:\_cursor_position\_`
+### `:_cursor_position_`
 To ascertain the position of a cursor in a named interface, use the
 following event (substituting 'name' for the interface name):
 
@@ -45,7 +105,7 @@ name, you can check which interface is in focus:
 
     Vedeu.trigger(:_cursor_position_, Vedeu.focus)
 
-### `:\_cursor_reposition\_`
+### `:_cursor_reposition_`
 Moves the cursor to a relative position inside the interface.
 
     Vedeu.trigger(:_cursor_reposition_, name, y, x)
@@ -56,31 +116,31 @@ Adjusts the position of the named cursor or view in the direction
 specified. If 'name' is unknown, using 'Vedeu.focus' will use the
 interface currently in focus.
 
-### `:\_cursor_left\_`
+### `:_cursor_left_`
 Moves the cursor one character left, unless the left-most position
 for the view or terminal is reached.
 
     Vedeu.trigger(:_cursor_left_, name)
     Vedeu.trigger(:_cursor_left_, Vedeu.focus)
 
-### `:\_cursor_down\_`
+### `:_cursor_down_`
 
     Vedeu.trigger(:_cursor_down_, name)
     Vedeu.trigger(:_cursor_down_, Vedeu.focus)
 
-### `:\_cursor_up\_`
+### `:_cursor_up_`
 Moves the cursor one line up, unless the top-most position for the
 view or terminal is reached.
 
     Vedeu.trigger(:_cursor_up_, name)
     Vedeu.trigger(:_cursor_up_, Vedeu.focus)
 
-### `:\_cursor_right\_`
+### `:_cursor_right_`
 
     Vedeu.trigger(:_cursor_right_, name)
     Vedeu.trigger(:_cursor_right_, Vedeu.focus)
 
-### `:\_cursor_top\_`
+### `:_cursor_top_`
 Moves the cursor to the top-most position for the view or terminal.
 If the view contains content, then this event will effectively scroll
 to the first line of the content.
@@ -88,10 +148,49 @@ to the first line of the content.
     Vedeu.trigger(:_cursor_top_, name)
     Vedeu.trigger(:_cursor_top_, Vedeu.focus)
 
-### `:\_cursor_bottom\_`
+### `:_cursor_bottom_`
 Moves the cursor to the bottom-most position for the view or terminal.
 If the view contains content, then this event will effectively scroll
 to the last line of the content.
 
     Vedeu.trigger(:_cursor_bottom_, name)
     Vedeu.trigger(:_cursor_bottom_, Vedeu.focus)
+
+## Cursor Visibility API & Events
+
+Change the visibility of the cursor via an event or API call. These
+can be called at any time and affect the cursor of the named
+interface, or when a name is not given, the interface currently in
+focus.
+
+### Vedeu.hide_cursor / `:_cursor_hide_`
+Hide the cursor.
+
+    Vedeu.trigger(:_hide_cursor_, name)
+    Vedeu.trigger(:_hide_cursor_, Vedeu.focus)
+    Vedeu.trigger(:_cursor_hide_, name)
+    Vedeu.trigger(:_cursor_hide_, Vedeu.focus)
+
+    Vedeu.hide_cursor(name)
+    Vedeu.hide_cursor(Vedeu.focus)
+
+### Vedeu.show_cursor / `:_show_cursor_`
+Show the cursor.
+
+    Vedeu.trigger(:_show_cursor_, name)
+    Vedeu.trigger(:_show_cursor_, Vedeu.focus)
+    Vedeu.trigger(:_cursor_show_, name)
+    Vedeu.trigger(:_cursor_show_, Vedeu.focus)
+
+    Vedeu.show_cursor(name)
+    Vedeu.show_cursor(Vedeu.focus)
+
+### Vedeu.toggle_cursor / `:_toggle_cursor_`
+Toggle the visibility of the cursor. If hidden, then show. If shown,
+then hide.
+
+    Vedeu.trigger(:_toggle_cursor_, name)
+    Vedeu.trigger(:_toggle_cursor_, Vedeu.focus)
+
+    Vedeu.toggle_cursor(name)
+    Vedeu.toggle_cursor(Vedeu.focus)

data/docs/debugging.md

@@ -8,8 +8,8 @@ and hopefully be dropped into a Pry debuggging session:
 
     Vedeu::Terminal.cooked_mode!
     Vedeu::Terminal.open do
-      mouse_off   = Vedeu::EscapeSequences::Esc.string('mouse_x10_off')
-      show_cursor = Vedeu::EscapeSequences::Esc.string('show_cursor')
+      mouse_off   = Vedeu::EscapeSequences::Esc.mouse_x10_off
+      show_cursor = Vedeu::EscapeSequences::Esc.show_cursor
       Vedeu::Terminal.output(mouse_off + show_cursor)
 
       require 'pry'

data/docs/dsl.md

@@ -80,7 +80,7 @@ end
 
 ### Creating a new named border
 
-{include:Vedeu::Borders::DSL#border}
+{include:Vedeu::Borders::DSL.border}
 
 ### Setting a title for the border
 
@@ -113,7 +113,7 @@ end
 
 ### Creating a new named geometry
 
-{include:Vedeu::Geometries::DSL#geometry}
+{include:Vedeu::Geometries::DSL.geometry}
 
 ### Setting the interface dimensions
 

data/docs/events/application.md

@@ -2,7 +2,7 @@
 
 ## Application Events
 
-### `:\_goto\_`
+### `:_goto_`
 Call a client application controller's action with parameters.
 
     Vedeu.trigger(:_goto_,

data/docs/events/document.md

@@ -4,29 +4,29 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### `:\_editor_execute\_`
+### `:_editor_execute_`
 
     Vedeu.trigger(:_editor_execute_, name)
 
-### `:\_editor_delete_character\_`
+### `:_editor_delete_character_`
 This event attempts to delete the character in the named
 document at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_delete_character_, name)
 
-### `:\_editor_delete_line\_`
+### `:_editor_delete_line_`
 This event attempts to delete the line in the named document
 at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_delete_line_, name)
 
-### `:\_editor_down\_`
+### `:_editor_down_`
 This event attempts to move the virtual cursor down by one
 line in the named document.
 
     Vedeu.trigger(:_editor_down_, name)
 
-### `:\_editor_insert_character\_`
+### `:_editor_insert_character_`
 This event attempts to insert the given character in the named
 document at the current virtual cursor position.
 
@@ -34,25 +34,25 @@ Note: 'character' is a string.
 
     Vedeu.trigger(:_editor_insert_character_, name, character)
 
-### `:\_editor_insert_line\_`
+### `:_editor_insert_line_`
 This event attempts to insert a new line in the named document
 at the current virtual cursor position.
 
     Vedeu.trigger(:_editor_insert_line_, name)
 
-### `:\_editor_left\_`
+### `:_editor_left_`
 This event attempts to move the virtual cursor left by one
 character in the named document.
 
     Vedeu.trigger(:_editor_left_, name)
 
-### `:\_editor_right\_`
+### `:_editor_right_`
 This event attempts to move the virtual cursor right by one
 character in the named document.
 
     Vedeu.trigger(:_editor_right_, name)
 
-### `:\_editor_up\_`
+### `:_editor_up_`
 This event attempts to move the virtual cursor up by one line
 in the named document.