vedeu 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6715eeab8888f23894a0f912e36418930d4bcb10
-  data.tar.gz: eff8b0d4c7eac80db7a17f1760f52bcd9df6dc7d
+  metadata.gz: c8361e0f679e7a752058e9a18febf179a3866dcb
+  data.tar.gz: 48b0d34dc40c43fad42cc60c9c768716fea5fc55
 SHA512:
-  metadata.gz: 62af5ad1afd927b7afb3ca81826a50dec90008f015bc86b5d885ad5bd411bde8caff604383a174f7b8e712746cadd382b645fdfd2e5aab4e7d7c74db771ea2b7
-  data.tar.gz: e456f90b8acc575aa181e33c4787d38d3a7b87d0245ad9aa4fcf47bc7af6148f994ff59e99ca843e3c6bfae19e8070af5fff911ec7a49629c1c6144a5bc77c2c
+  metadata.gz: 78eaf93359ac8620f7039ef9f15aef044c6023e1cb71baff51809bd0d70bea21665223f43a810d061cbe42d72059bc325d999890ce407a6ae432007b67a810e0
+  data.tar.gz: ecdaafd1a7c70f86d9bf4ce2358135646b2692974b4de25a683b57c8771c218f0cb50942d9eec6e15adfa7ce1ddd83b6047563c0daf269cd46ceb39c74e4f8a4

data/.codeclimate.yml

@@ -1,39 +1,9 @@
-# This is a sample .codeclimate.yml configured for Engine analysis on Code
-# Climate Platform. For an overview of the Code Climate Platform, see here:
-# http://docs.codeclimate.com/article/300-the-codeclimate-platform
-
-# Under the engines key, you can configure which engines will analyze your repo.
-# Each key is an engine name. For each value, you need to specify enabled: true
-# to enable the engine as well as any other engines-specific configuration.
-
-# For more details, see here:
-# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
-
-# For a list of all available engines, see here:
-# http://docs.codeclimate.com/article/296-engines-available-engines
-languages:
-  Ruby: true
-
 engines:
-# to turn on an engine, add it here and set enabled to `true`
-# to turn off an engine, set enabled to `false` or remove it
   rubocop:
     enabled: true
-
-# Engines can analyze files and report issues on them, but you can separately
-# decide which files will receive ratings based on those issues. This is
-# specified by path patterns under the ratings key.
-
-# For more details see here:
-# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
-
 ratings:
   paths:
     - lib/**
-
-# You can globally exclude files from being analyzed by any engine using the
-# exclude_paths key.
-
 exclude_paths:
   - examples/**/*
   - test/**/*

data/lib/vedeu/all.rb

@@ -41,7 +41,6 @@ require 'vedeu/null/menu'
 require 'vedeu/null/view'
 
 require 'vedeu/refresh/refresh'
-require 'vedeu/refresh/refresh_buffer'
 require 'vedeu/refresh/refresh_group'
 
 require 'vedeu/models/toggleable'

data/lib/vedeu/api.rb

@@ -28,23 +28,10 @@ module Vedeu
     #   @see Vedeu::Configuration.configuration
     def_delegators Vedeu::Configuration, :configure, :configuration
 
-    # Manipulate the currently focussed cursor.
-    #
-    # @example
-    #   Vedeu.cursor
-    #
     # @!method cursor
     # @return [Vedeu::Cursors::Cursor]
     def_delegators Vedeu::Cursors::Repository, :cursor
 
-    # Manipulate the DRb server implementation.
-    #
-    # @example
-    #   Vedeu.drb_restart
-    #   Vedeu.drb_start
-    #   Vedeu.drb_status
-    #   Vedeu.drb_stop
-    #
     # @!method drb_restart
     #   @see Vedeu::Distributed::Server#restart
     # @!method drb_start
@@ -56,46 +43,26 @@ module Vedeu
     def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
                    :drb_status, :drb_stop
 
-    # @example
-    #   Vedeu.border
-    #
     # @!method border
     #   @see Vedeu::Borders::DSL.border
     def_delegators Vedeu::Borders::DSL, :border
 
-    # @example
-    #   Vedeu.geometry
-    #
     # @!method geometry
     #   @see Vedeu::Geometry::DSL.geometry
     def_delegators Vedeu::Geometry::DSL, :geometry
 
-    # @example
-    #   Vedeu.group
-    #
     # @!method group
     #   @see Vedeu::DSL::Group.group
     def_delegators Vedeu::DSL::Group, :group
 
-    # @example
-    #   Vedeu.keymap
-    #
     # @!method keymap
     #   @see Vedeu::DSL::Keymap.keymap
     def_delegators Vedeu::DSL::Keymap, :keymap
 
-    # @example
-    #   Vedeu.interface
-    #
     # @!method interface
     #   @see Vedeu::DSL::Interface.interface
     def_delegators Vedeu::DSL::Interface, :interface
 
-    # @example
-    #   Vedeu.renders
-    #   Vedeu.render
-    #   Vedeu.views
-    #
     # @!method render
     #   @see Vedeu::DSL::View.render
     # @!method renders
@@ -104,11 +71,6 @@ module Vedeu
     #   @see Vedeu::DSL::View.views
     def_delegators Vedeu::DSL::View, :renders, :render, :views
 
-    # @example
-    #   Vedeu.bind(name) { }
-    #   Vedeu.bound?(name)
-    #   Vedeu.unbind(name)
-    #
     # @!method bind
     #   @see Vedeu::Events::Event.bind
     # @!method bound?
@@ -117,23 +79,12 @@ module Vedeu
     #   @see Vedeu::Events::Event.unbind
     def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind
 
-    # @example
-    #   Vedeu.bind_alias(alias_name, event_name)
-    #   Vedeu.unbind_alias(alias_name)
-    #
     # @!method bind_alias
-    #   @see Vedeu::Events::Aliases.bind_alias
+    #   @see Vedeu::Events::Aliases#bind_alias
     # @!method unbind_alias
-    #   @see Vedeu::Events::Aliases.unbind_alias
+    #   @see Vedeu::Events::Aliases#unbind_alias
     def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias
 
-    # @example
-    #   Vedeu.focus
-    #   Vedeu.focus_by_name
-    #   Vedeu.focussed?
-    #   Vedeu.focus_next
-    #   Vedeu.focus_previous
-    #
     # @!method focus
     #   @see Vedeu::Focus#focus
     # @!method focus_by_name
@@ -147,11 +98,6 @@ module Vedeu
     def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
                    :focus_next, :focus_previous
 
-    # @example
-    #   Vedeu.log
-    #   Vedeu.log_stdout
-    #   Vedeu.log_stderr
-    #
     # @!method log
     #   @see Vedeu::Log.log
     # @!method log_stdout
@@ -160,116 +106,56 @@ module Vedeu
     #   @see Vedeu::Log.log_stderr
     def_delegators Vedeu::Log, :log, :log_stdout, :log_stderr
 
-    # @example
-    #   Vedeu.keypress
-    #
     # @!method keypress
     #   @see Vedeu::Mapper.keypress
     def_delegators Vedeu::Mapper, :keypress
 
-    # @example
-    #   Vedeu.menu
-    #
     # @!method menu
     #   @see Vedeu::Menu.menu
     def_delegators Vedeu::Menu, :menu
 
-    # Instruct Vedeu to load the client application controller action with
-    # parameters.
-    #
     # @!method goto
-    #   @see Vedeu::Router.goto
+    #   @see Vedeu::Router#goto
     def_delegators Vedeu::Router, :goto
 
-    # Return the height of the terminal running the client application.
-    #
-    # @example
-    #   Vedeu.height
-    #
     # @!method height
     #   @see Vedeu::Terminal#height
     def_delegators Vedeu::Terminal, :height
 
-    # Return the width of the terminal running the client application.
-    #
-    # @example
-    #   Vedeu.width
-    #
     # @!method width
     #   @see Vedeu::Terminal#width
     def_delegators Vedeu::Terminal, :width
 
-    # Trigger an event by name.
-    #
-    # @example
-    #   Vedeu.trigger(:name)
-    #
     # @!method trigger
     #   @see Vedeu::Events::Trigger.trigger
     def_delegators Vedeu::Events::Trigger, :trigger
 
-    # Exit the client application using Vedeu.
-    #
-    # @example
-    #   Vedeu.exit
-    #
     # @!method exit
     #   @see Vedeu::Application.stop
     def_delegators Vedeu::Application, :exit
 
-    # Clear the entire terminal.
-    #
-    # @example
-    #   Vedeu.clear
-    #
     # @!method clear
-    #   @see Vedeu::Terminal.clear
+    #   @see Vedeu::Terminal#clear
     def_delegators Vedeu::Terminal, :clear
 
-    # Clear the interface with the given name.
-    #
-    # @example
-    #   Vedeu.clear_by_name(name)
-    #
     # @!method clear_by_name
     #   @see Vedeu::Clear::NamedInterface.render
     def_delegators Vedeu::Clear::NamedInterface, :clear_by_name
 
-    # Clears the group of interfaces belonging to the given name.
-    #
-    # @example
-    #   Vedeu.clear_by_group(name)
-    #
     # @!method clear_by_group
     #   @see Vedeu::Clear::NamedGroup.render
     def_delegators Vedeu::Clear::NamedGroup, :clear_by_group
 
-    # Hide the cursor for the interface of the given name.
-    #
-    # @example
-    #   Vedeu.hide_cursor(name)
-    #
     # @!method hide_cursor
     #   @see Vedeu::Cursors::Cursor#hide
     def_delegators Vedeu::Cursors::Cursor, :hide_cursor
 
-    # Shows the cursor for the interface of the given name.
-    #
-    # @example
-    #   Vedeu.show_cursor(name)
-    #
     # @!method show_cursor
     #   @see Vedeu::Cursors::Cursor#show
     def_delegators Vedeu::Cursors::Cursor, :show_cursor
 
-    # Toggle the visibility of the cursor with the given name.
-    #
-    # @example
-    #   Vedeu.toggle_cursor(name)
-    #
     # @!method toggle_cursor
-    #   @see Vedeu::Cursors::Cursor#hide
-    #   @see Vedeu::Cursors::Cursor#show
+    #   @see Vedeu::Cursors::Cursor#toggle
     def_delegators Vedeu::Cursors::Cursor, :toggle_cursor
 
     # @!method hide_group
@@ -280,38 +166,18 @@ module Vedeu
     #   @see Vedeu::Group#show
     def_delegators Vedeu::Group, :show_group
 
-    # Toggle the visibility of the group with the given name.
-    #
-    # @example
-    #   Vedeu.toggle_group(name)
-    #
     # @!method toggle_group
     #   @see Vedeu::Group#toggle
     def_delegators Vedeu::Group, :toggle_group
 
-    # Hide the interface with the given name.
-    #
-    # @example
-    #   Vedeu.hide_interface(name)
-    #
     # @!method hide_interface
     #   @see Vedeu::Interface#hide
     def_delegators Vedeu::Interface, :hide_interface
 
-    # Shows the interface with the given name.
-    #
-    # @example
-    #   Vedeu.show_interface(name)
-    #
     # @!method show_interface
     #   @see Vedeu::Interface#show
     def_delegators Vedeu::Interface, :show_interface
 
-    # Toggle the visibility of the interface with the given name.
-    #
-    # @example
-    #   Vedeu.toggle_interface(name)
-    #
     # @!method toggle_interface
     #   @see Vedeu::Interface#toggle
     def_delegators Vedeu::Interface, :toggle_interface

data/lib/vedeu/application/application_controller.rb

@@ -1,8 +1,8 @@
 module Vedeu
 
-  # Provides methods which should be available to all client application
-  # controllers. The client application's ApplicationController will inherit
-  # from this class.
+  # Provides methods which should be available to all client
+  # application controllers. The client application's
+  # ApplicationController will inherit from this class.
   #
   class ApplicationController
 
@@ -10,18 +10,20 @@ module Vedeu
 
     # Returns an instance of Vedeu::ApplicationController.
     #
-    # @param params [Hash] The named parameters provided to the controller which
-    #   will be used by the actions within the controller.
+    # @param params [Hash] The named parameters provided to the
+    #   controller which will be used by the actions within the
+    #   controller.
     # @return [Vedeu::ApplicationController]
     def initialize(**params)
       @params = params
     end
 
-    # @param controller [Symbol] The name of controller to be redirected to.
-    # @param action [Symbol] The name of the action within the controller to be
-    #   called.
-    # @param params [Hash] Any named parameter which need to be passed to the
-    #   action.
+    # @param controller [Symbol] The name of controller to be
+    #   redirected to.
+    # @param action [Symbol] The name of the action within the
+    #   controller to be called.
+    # @param params [Hash] Any named parameter which need to be passed
+    #   to the action.
     def redirect_to(controller, action, **params)
       Vedeu.trigger(:_goto_, controller, action, params)
     end

data/lib/vedeu/application/application_helper.rb

@@ -1,8 +1,8 @@
 module Vedeu
 
-  # Provides methods which should be available to all client application
-  # helpers. The client application's ApplicationHelper will include this
-  # module.
+  # Provides methods which should be available to all client
+  # application helpers. The client application's ApplicationHelper
+  # will include this module.
   #
   module ApplicationHelper
 

data/lib/vedeu/application/application_view.rb

@@ -1,7 +1,8 @@
 module Vedeu
 
-  # Provides the mechanism to render views for the client application. The
-  # client application's ApplicationView will inherit from this class.
+  # Provides the mechanism to render views for the client application.
+  # The client application's ApplicationView will inherit from this
+  # class.
   #
   class ApplicationView
 
@@ -27,8 +28,8 @@ module Vedeu
       end
     end
 
-    # @raise [Vedeu::Error::NotImplemented] Subclasses of this class must
-    #   implement this method.
+    # @raise [Vedeu::Error::NotImplemented] Subclasses of this class
+    #   must implement this method.
     def render
       fail Vedeu::Error::NotImplemented,
            'The subclass of Vedeu::ApplicationView must implement the #render' \
@@ -43,8 +44,8 @@ module Vedeu
 
     private
 
-    # Provides the path to the template file using the base_path configuration
-    # option.
+    # Provides the path to the template file using the base_path
+    # configuration option.
     #
     # @param value [String]
     # @return [String]

data/lib/vedeu/application/controller.rb

@@ -10,8 +10,9 @@ module Vedeu
 
       attr_accessor :controller_name
 
-      # Specifying the controller name in your controller provides Vedeu with
-      # the means to route requests to different parts of your application.
+      # Specifying the controller name in your controller provides
+      # Vedeu with the means to route requests to different parts of
+      # your application.
       #
       # @example
       #   class YourController
@@ -25,7 +26,8 @@ module Vedeu
       #   end
       #
       # @param controller_name [Symbol] The name of the controller.
-      # @return [Hash<Symbol => Hash<Symbol => String, Array<Symbol>>>]
+      # @return
+      #   [Hash<Symbol => Hash<Symbol => String, Array<Symbol>>>]
       def controller(controller_name = nil)
         @controller_name = controller_name
 
@@ -33,8 +35,9 @@ module Vedeu
       end
       alias_method :controller_name, :controller
 
-      # Specifying the action names in your controller provides Vedeu with the
-      # means to route requests to different parts of your application.
+      # Specifying the action names in your controller provides Vedeu
+      # with the means to route requests to different parts of your
+      # application.
       #
       # @example
       #   class YourController
@@ -51,10 +54,13 @@ module Vedeu
       #
       #   end
       #
-      #   Vedeu.trigger(:_goto_, :your_controller, :show, { some: :args })
+      #   Vedeu.trigger(:_goto_,
+      #                 :your_controller,
+      #                 :show,
+      #                 { some: :args })
       #
-      # @param action_names [Array<Symbol>, Symbol] A collection of action names
-      #   or the name of the action.
+      # @param action_names [Array<Symbol>, Symbol] A collection of
+      #   action names or the name of the action.
       # @return [Array<Symbol>]
       def action(*action_names)
         action_names.each do |action_name|
@@ -66,8 +72,8 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
+    # When this module is included in a class, provide ClassMethods as
+    # class methods for the class.
     #
     # @param klass [Class]
     # @return [void]