vedeu 0.4.44 → 0.4.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e923ab136ae9285466e5526700a91bd23b78f03
-  data.tar.gz: 8af995c9b432d7ee21c51837bb6dd6a508b5e485
+  metadata.gz: 68ee4c2ed644e698df332ae110ee488fcb38251c
+  data.tar.gz: 5a542609da0c161347ec2cd3de1fada895995aef
 SHA512:
-  metadata.gz: b907622dd0291801638870f6456ecf0876c1e66395e3b87a75d433c5ba4449ca9ce23ad27c1520832d0843e7067dcd4969dd7a5b35735dadead4ff2365881f7e
-  data.tar.gz: 1533041a4c03464a27846e11bca3b6f4a4e948fcd8f95f5bfb6a33c8cae92e0a6e398e545785e78101888a59d96c25547c806f5d5d6e38026f5a75425202cbfa
+  metadata.gz: 32a29cc71db5d5e1347b6fa9fe5a0d424c4bac02dedf1eb61e325650f386d01dcaee72c4fc890cd6eba16b50f10353ec2cda4a4f75064e156ae61be003217193
+  data.tar.gz: 42a71d09b9aa1dfed20b9b60f1dc92a1967fd134d2b27f3b028d3d59bd6070ec9eb8c5606b924ab4a8c3a26fd43d68c7f74085ef6a584bcf43fbb73b30d9bdfa

data/.ruby-version

@@ -1 +1 @@
-2.2.1
+2.2.2

data/README.md

@@ -1,6 +1,5 @@
 [![Code Climate](https://codeclimate.com/github/gavinlaking/vedeu.png)](https://codeclimate.com/github/gavinlaking/vedeu)
 [![Build Status](https://travis-ci.org/gavinlaking/vedeu.svg?branch=master)](https://travis-ci.org/gavinlaking/vedeu)
-[![Inline docs](http://inch-ci.org/github/gavinlaking/vedeu.svg?branch=master)](http://inch-ci.org/github/gavinlaking/vedeu)
 
 # Vedeu
 
@@ -11,7 +10,9 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based
 
 ## Requirements
 
-Vedeu was been built primarily with Ruby v2.1.
+Vedeu was been built primarily with Ruby v2.1; however, the
+[.ruby-version](https://github.com/gavinlaking/vedeu/blob/master/.ruby-version)
+file will indicate the currently used Ruby version.
 
 When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't have any problems with either of these operating systems.
 

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'inch/rake'
 require 'yard'
 require 'rubocop/rake_task'
 
@@ -22,11 +21,6 @@ YARD::Rake::YardocTask.new(:yard) do |t|
   ]
 end
 
-Inch::Rake::Suggest.new(:inch) do |suggest|
-  suggest.args << '--pedantic'
-  suggest.args << '--all'
-end
-
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.patterns = ['lib/**/*.rb']
   task.formatters = ['progress']

data/docs/api.md

@@ -1,27 +1,7 @@
-## Vedeu API
+# @title Vedeu API
 
 Vedeu provides a simple DSL for the creation of terminal/console based
-applications.
-
-Below is a list of all the API methods. These can be accessed in your
-application by including Vedeu in your class or module or by calling them directly.
-
-
-### API 'include' example
-
-Doing it this way will mean you can use any API method without the `Vedeu.` prefix.
-
-```ruby
-class SomeClassInYourApplication
-  include Vedeu
-
-  # ...
-```
-
-
-### API direct example
-
-Doing it this way means you need to use the `Vedeu.` prefix.
+applications. Below is a list of all the API methods:
 
 ```ruby
 class OtherClassInYourApplication
@@ -34,32 +14,42 @@ class OtherClassInYourApplication
   # ...
 ```
 
-... TODO ...
+Note: Nesting indicates where an API method is allowed/supposed to be used.
 
+#### Borders
 
-### API DSL methods
+- Vedeu.border
 
-Note: Nesting indicates where an API method is allowed/supposed to be used.
+#### Configuration
+
+- Vedeu.configure
+- Vedeu.configuration
 
 #### Events
 
-- bind
-- trigger
-- unbind
+- Vedeu.bind
+- Vedeu.trigger
+- Vedeu.unbind
+
+#### Geometry
+
+- Vedeu.geometry
+
+#### Groups
 
+- Vedeu.group
 
 #### Input
 
-- keypress
-- keymap
+- Vedeu.keypress
+- Vedeu.keymap
   - key
   - name
   - interface
 
-
 #### Interfaces
 
-- interface
+- Vedeu.interface
   - background
   - border
   - cursor
@@ -83,10 +73,10 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
   - style
   - use
 
-
 #### Views
 
-- renders
+- Vedeu.renders
+- Vedeu.render
   - view
     - colour
     - cursor
@@ -116,36 +106,49 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
     - name
     - style
   - use
-- views
+- Vedeu.views
   - ... as #renders
 
-
 #### Menus
 
-- menu
+- Vedeu.menu
   - items
   - name
 
+#### Renderers
 
-#### Miscellany
+- Vedeu.renderer
+- Vedeu.renderers
 
-- configure
-- focus
-- focus_by_name
-- focussed?
-- focus_next
-- focus_previous
+#### Repositories
 
-- height
-  Usage: Vedeu.height
-  Returns the height (in lines) for the current terminal.
+These are collections which you can access:
 
-- log
-- resize
-  Usage: Vedeu.resize
+- Vedeu.background_colours
+- Vedeu.foreground_colours
+- Vedeu.borders
+- Vedeu.buffers
+- Vedeu.cursors
+- Vedeu.events
+- Vedeu.geometries
+- Vedeu.groups
+- Vedeu.interfaces
+- Vedeu.keymaps
+- Vedeu.menus
 
+#### Miscellany
 
-- width
-  Usage: Vedeu.width
-  Returns the width (in characters) for the current terminal.
+- Vedeu.cursor
+- Vedeu.focus
+- Vedeu.focus_by_name
+- Vedeu.focussed?
+- Vedeu.focus_next
+- Vedeu.focus_previous
+- Vedeu.height
+- Vedeu.log
+- Vedeu.log_stdout
+- Vedeu.log_stderr
+- Vedeu.resize
+- Vedeu.timer
+- Vedeu.width
 

data/docs/applications.md

@@ -1,4 +1,4 @@
-## Vedeu Applications
+# @title Vedeu Applications
 
 Vedeu has basic tools to generate client application scaffolding, in a similar
 way to Ruby on Rails. Although not nearly as advanced as the Rails equivalent,

data/docs/dsl.md

@@ -1,3 +1,5 @@
+# @title The Vedeu DSL
+
 Coupled with the API (for interacting with the running client application), the
  DSL provides the mechanism to configure aspects of your application whilst
  using Vedeu.

data/docs/getting_started.md

@@ -1,4 +1,4 @@
-## Getting Started with Vedeu
+# @title Getting Started with Vedeu
 
 - Set your configuration.
 - Define your interfaces.

data/docs/object_graph.md

@@ -1,4 +1,4 @@
-## Producing an object graph of Vedeu
+# @title Producing an object graph of Vedeu
 
 Sometimes I find looking at the project as a graph helps me to understand the
 relationship between the various objects. To achieve this, I use Yard's graph

data/docs/views.md

@@ -1,4 +1,4 @@
-## Views with Vedeu
+# @title Views with Vedeu
 
 There are two ways to construct views with Vedeu. You would like to draw the
  view to the screen immediately (immediate render) or you want to save a view to

data/lib/vedeu.rb

@@ -27,11 +27,14 @@ module Vedeu
 
   def_delegators Vedeu::Log, :log
 
+  # Return the name of currently focussed interface.
+  #
   # @return [Vedeu::Focus]
   def self.focusable
     @focusable ||= Vedeu::Focus
   end
 
+  # :nocov:
   # When Vedeu is included within one of your classes, you should have all
   # API methods at your disposal.
   #
@@ -48,6 +51,7 @@ module Vedeu
     receiver.send(:include, API)
     receiver.extend(API)
   end
+  # :nocov:
 
 end # Vedeu
 

data/lib/vedeu/api.rb

@@ -33,16 +33,31 @@ module Vedeu
 
     module_function
 
+    # Manipulate the repository of background colours.
+    #
+    # @example
+    #   Vedeu.background_colours
+    #
     # @!method background_colours
-    #   @see Vedeu::Backgrounds.background_colours
+    # @return [Vedeu::Backgrounds]
     def_delegators Vedeu::Backgrounds, :background_colours
 
+    # Manipulate the repository of borders.
+    #
+    # @example
+    #   Vedeu.borders
+    #
     # @!method borders
-    #   @see Vedeu::Borders.borders
+    # @return [Vedeu::Borders]
     def_delegators Vedeu::Borders, :borders
 
+    # Manipulate the repository of buffers.
+    #
+    # @example
+    #   Vedeu.buffers
+    #
     # @!method buffers
-    #   @see Vedeu::Buffers.buffers
+    # @return [Vedeu::Buffers]
     def_delegators Vedeu::Buffers, :buffers
 
     # @!method configure
@@ -51,11 +66,23 @@ module Vedeu
     #   @see Vedeu::Configuration.configuration
     def_delegators Vedeu::Configuration, :configure, :configuration
 
+    # Manipulate the currently focussed cursor.
+    #
+    # @example
+    #   Vedeu.cursor
+    #
     # @!method cursor
-    #   @see Vedeu::Cursors.cursor
+    # @return [Vedeu::Cursor]
+    def_delegators Vedeu::Cursors, :cursor
+
+    # Manipulate the repository of cursors.
+    #
+    # @example
+    #   Vedeu.cursors
+    #
     # @!method cursors
-    #   @see Vedeu::Cursors.cursors
-    def_delegators Vedeu::Cursors, :cursor, :cursors
+    # @return [Vedeu::Cursors]
+    def_delegators Vedeu::Cursors, :cursors
 
     # @!method border
     #   @see Vedeu::DSL::Border.border
@@ -89,8 +116,13 @@ module Vedeu
     #   @see Vedeu::Event.unbind
     def_delegators Vedeu::Event, :bind, :unbind
 
+    # Manipulate the repository of events.
+    #
+    # @example
+    #   Vedeu.events
+    #
     # @!method events
-    #   @see Vedeu::Events.events
+    # @return [Vedeu::Events]
     def_delegators Vedeu::Events, :events
 
     # @!method focus
@@ -106,24 +138,49 @@ module Vedeu
     def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
                    :focus_next, :focus_previous
 
+    # Manipulate the repository of foreground colours.
+    #
+    # @example
+    #   Vedeu.foreground_colours
+    #
     # @!method foreground_colours
-    #   @see Vedeu::Foregrounds.foreground_colours
+    # @return [Vedeu::Foregrounds]
     def_delegators Vedeu::Foregrounds, :foreground_colours
 
+    # Manipulate the repository of geometries.
+    #
+    # @example
+    #   Vedeu.geometries
+    #
     # @!method geometries
-    #   @see Vedeu::Geometries.geometries
+    # @return [Vedeu::Geometries]
     def_delegators Vedeu::Geometries, :geometries
 
+    # Manipulate the repository of groups.
+    #
+    # @example
+    #   Vedeu.groups
+    #
     # @!method groups
-    #   @see Vedeu::Groups.groups
+    # @return [Vedeu::Groups]
     def_delegators Vedeu::Groups, :groups
 
+    # Manipulate the repository of interfaces.
+    #
+    # @example
+    #   Vedeu.interfaces
+    #
     # @!method interfaces
-    #   @see Vedeu::Interfaces.interfaces
+    # @return [Vedeu::Interfaces]
     def_delegators Vedeu::Interfaces, :interfaces
 
+    # Manipulate the repository of keymaps.
+    #
+    # @example
+    #   Vedeu.keymaps
+    #
     # @!method keymaps
-    #   @see Vedeu::Keymaps.keymaps
+    # @return [Vedeu::Keymaps]
     def_delegators Vedeu::Keymaps, :keymaps
 
     # @!method log
@@ -142,8 +199,13 @@ module Vedeu
     #   @see Vedeu::Menu.menu
     def_delegators Vedeu::Menu, :menu
 
+    # Manipulate the repository of menus.
+    #
+    # @example
+    #   Vedeu.menus
+    #
     # @!method menus
-    #   @see Vedeu::Menus.menus
+    # @return [Vedeu::Menus]
     def_delegators Vedeu::Menus, :menus
 
     # @!method renderer

data/lib/vedeu/application/application_view.rb

@@ -37,6 +37,9 @@ module Vedeu
 
     private
 
+    # Provides the path to the template file using the base_path configuration
+    # option.
+    #
     # @param value [String]
     # @return [String]
     def template(value)

data/lib/vedeu/application/controller.rb

@@ -8,7 +8,20 @@ module Vedeu
     # When included, provide these methods as class methods.
     module ClassMethods
 
+      # Specifying the controller name in your controller provides a Vedeu event
+      # which will trigger the loading of the controller.
+      #
+      # @example
+      #   class YourController
+      #     controller_name :your_controller
+      #     # ...
+      #   end
+      #
+      #   Vedeu.trigger(:show_your_controller) # this event is now available to
+      #                                        # trigger.
+      #
       # @param name [Symbol] The name of the controller.
+      # @return [void]
       def controller_name(name)
         Vedeu.bind("show_#{name}".to_sym) { new }
       end