vedeu 0.6.15 → 0.6.16

data/lib/vedeu/dsl/use.rb

@@ -8,10 +8,10 @@ module Vedeu
 
       # Use the attribute of stored model.
       #
-      # This DSL method provides access to a stored model by name. You can
-      # then request an attribute of that model for use within the current
-      # model. The models which current support this are Border, Geometry and
-      # Interface.
+      # This DSL method provides access to a stored model by name.
+      # You can then request an attribute of that model for use within
+      # the current model. The models which current support this are
+      # Border, Geometry and Interface.
       #
       # @example
       #   # Here the character used for 'my_border' is used in
@@ -21,14 +21,16 @@ module Vedeu
       #   end
       #
       # @note
-      #   - Only models of the same repository can be used in this way.
-      #   - If the stored model cannot be found, a ModelNotFound exception may
-      #     be raised, or the request for an attribute may raise a
-      #     NoMethodError exception.
+      #   - Only models of the same repository can be used in this
+      #     way.
+      #   - If the stored model cannot be found, a ModelNotFound
+      #     exception may be raised, or the request for an attribute
+      #     may raise a NoMethodError exception.
       #
-      # @param name [String] The name of the model with the value you wish to
-      #   use.
-      # @raise [Vedeu::Error::ModelNotFound|Vedeu::Error::NoMethodError]
+      # @param name [String] The name of the model with the value you
+      #   wish to use.
+      # @raise
+      #   [Vedeu::Error::ModelNotFound|Vedeu::Error::NoMethodError]
       #   The model or attribute cannot be found.
       # @return [void] The stored model.
       def use(name)

data/lib/vedeu/dsl/view.rb

@@ -2,16 +2,18 @@ module Vedeu
 
   module DSL
 
-    # 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 be drawn when you trigger a refresh event later (deferred view).
+    # 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 be drawn when you trigger a refresh
+    # event later (deferred view).
     #
-    # Both of these approaches require that you have defined an interface (or
-    # 'visible area') first. You can find out how to define an interface with
-    # Vedeu below or in {Vedeu::DSL::Interface}. The examples in 'Immediate
-    # Render' and 'Deferred View' use these interface definitions: (Note: should
-    # you use these examples, ensure your terminal is at least 70 characters in
-    # width and 5 lines in height.)
+    # Both of these approaches require that you have defined an
+    # interface (or 'visible area') first. You can find out how to
+    # define an interface with Vedeu below or in
+    # {Vedeu::DSL::Interface}. The examples in 'Immediate Render' and
+    # 'Deferred View' use these interface definitions: (Note: should
+    # you use these examples, ensure your terminal is at least 70
+    # characters in width and 5 lines in height.)
     #
     #   Vedeu.interface 'main' do
     #     geometry do
@@ -30,26 +32,27 @@ module Vedeu
     #     end
     #   end
     #
-    # Both of these approaches use a concept of Buffers in Vedeu. There are
-    # three buffers for any defined interface. These are imaginatively called:
-    # 'back', 'front' and 'previous'.
+    # Both of these approaches use a concept of Buffers in Vedeu.
+    # There are three buffers for any defined interface. These are
+    # imaginatively called: 'back', 'front' and 'previous'.
     #
-    # The 'back' buffer is the content for an interface which will be shown next
-    # time a refresh event is fired globally or for that interface. So, 'back'
-    # becomes 'front'.
+    # The 'back' buffer is the content for an interface which will be
+    # shown next time a refresh event is fired globally or for that
+    # interface. So, 'back' becomes 'front'.
     #
-    # The 'front' buffer is the content for an interface which is currently
-    # showing. When a refresh event is fired, again, globally or for that
-    # interface specifically, the content of this 'front' buffer is first copied
-    # to the 'previous' buffer, and then the current 'back' buffer overwrites
-    # this 'front' buffer.
+    # The 'front' buffer is the content for an interface which is
+    # currently showing. When a refresh event is fired, again,
+    # globally or for that interface specifically, the content of this
+    # 'front' buffer is first copied to the 'previous' buffer, and
+    # then the current 'back' buffer overwrites this 'front' buffer.
     #
-    # The 'previous' buffer contains what was shown on the 'front' before the
-    # current 'front'.
+    # The 'previous' buffer contains what was shown on the 'front'
+    # before the current 'front'.
     #
-    # You can only write to either the 'front' (you want the content to be drawn
-    # immediately (immediate render)) or the 'back' (you would like the content
-    # to be drawn on the next refresh (deferred view)).
+    # You can only write to either the 'front' (you want the content
+    # to be drawn immediately (immediate render)) or the 'back' (you
+    # would like the content to be drawn on the next refresh
+    # (deferred view)).
     #
     # The basic view DSL methods look like this:
     #
@@ -91,9 +94,10 @@ module Vedeu
 
         include Vedeu::Common
 
-        # 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.
+        # 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.
         #
         #   Vedeu.renders do
         #     view 'some_interface' do
@@ -124,8 +128,9 @@ module Vedeu
         #     end
         #   end
         #
-        # @param block [Proc] The directives you wish to send to render.
-        #   Typically includes `view` with associated sub-directives.
+        # @param block [Proc] The directives you wish to send to
+        #   render. Typically includes `view` with associated
+        #   sub-directives.
         # @raise [Vedeu::Error::RequiresBlock]
         # @return [Array<View>]
         def renders(&block)
@@ -137,15 +142,15 @@ module Vedeu
 
         # Define a view (content) for an interface.
         #
-        # As you can see by comparing the examples above to these below, the
-        # immediate render simply wraps what is already here in the deferred
-        # view.
+        # As you can see by comparing the examples above to these
+        # below, the immediate render simply wraps what is already
+        # here in the deferred view.
         #
-        # 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 to
-        # {Vedeu::Terminal#output}.
+        # 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 to {Vedeu::Terminal#output}.
         #
         #   Vedeu.views do
         #     view 'some_interface' do
@@ -168,8 +173,9 @@ module Vedeu
         #     # ... some code
         #   end
         #
-        # @param block [Proc] The directives you wish to send to render.
-        #   Typically includes `view` with associated sub-directives.
+        # @param block [Proc] The directives you wish to send to
+        #   render. Typically includes `view` with associated
+        #   sub-directives.
         # @raise [Vedeu::Error::RequiresBlock]
         # @return [Array<View>]
         def views(&block)
@@ -188,8 +194,8 @@ module Vedeu
           eval('self', block.binding)
         end
 
-        # Creates a new Vedeu::Views::Composition which may contain one or more
-        # views (Vedeu::Views::View objects).
+        # Creates a new Vedeu::Views::Composition which may contain
+        # one or more views (Vedeu::Views::View objects).
         #
         # @param client [Object]
         # @param block [Proc]
@@ -198,12 +204,12 @@ module Vedeu
           Vedeu::Views::Composition.build(client: client, &block)
         end
 
-        # Stores each of the views defined in their respective buffers ready to
-        # be rendered on next refresh.
+        # Stores each of the views defined in their respective buffers
+        # ready to be rendered on next refresh.
         #
         # @param method [Symbol] An instruction; `:store_immediate` or
-        #   `:store_deferred` which determines whether the view will be shown
-        #   immediately or later respectively.
+        #   `:store_deferred` which determines whether the view will
+        #   be shown immediately or later respectively.
         # @param block [Proc]
         # @return [Array]
         def store(method, &block)

data/lib/vedeu/editor/cursor.rb

@@ -82,7 +82,7 @@ module Vedeu
       # @return [Vedeu::Editor::Cursor]
       def left
         @ox -= 1 unless @ox == 0
-        @x  -= 1
+        @x -= 1
 
         self
       end
@@ -121,7 +121,7 @@ module Vedeu
       # @return [Vedeu::Editor::Cursor]
       def up
         @oy -= 1 unless @oy == 0
-        @y  -= 1
+        @y -= 1
 
         self
       end

data/lib/vedeu/editor/insert.rb

@@ -28,13 +28,9 @@ module Vedeu
 
       # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
       def insert
-        if index
-          collection.insert(index, entity)
+        return collection.insert(index, entity) if index
 
-        else
-          collection << entity
-
-        end
+        collection << entity
       end
 
       protected

data/lib/vedeu/editor/line.rb

@@ -16,15 +16,10 @@ module Vedeu
       # @param line [String|Vedeu::Editor::Line]
       # @return [Vedeu::Editor::Line]
       def self.coerce(line)
-        return line if line.is_a?(self)
+        return line      if line.is_a?(self)
+        return new(line) if line.is_a?(String)
 
-        if line.is_a?(String)
-          new(line)
-
-        else
-          new
-
-        end
+        new
       end
 
       # Returns a new instance of Vedeu::Editor::Line.

data/lib/vedeu/editor/lines.rb

@@ -21,18 +21,7 @@ module Vedeu
           new(document.lines)
 
         elsif document.is_a?(Array)
-          lines = document.map do |line|
-            if line.is_a?(Vedeu::Editor::Line)
-              line
-
-            elsif line.is_a?(String)
-              Vedeu::Editor::Line.coerce(line)
-
-            else
-              Vedeu::Editor::Line.new
-
-            end
-          end
+          lines = document.map { |line| Vedeu::Editor::Line.coerce(line) }
 
           new(lines)
 

data/lib/vedeu/events/event.rb

@@ -2,31 +2,30 @@ module Vedeu
 
   module Events
 
-    # Contains all the logic of an event. Handles debouncing and throttling.
+    # Contains all the logic of an event. Handles debouncing and
+    # throttling.
     #
-    # Vedeu provides an event mechanism to facilitate the functionality of your
-    # application. The events are either Vedeu defined, ie. system events or
-    # user defined, ie. user events. User events allow you to orchestrate
-    # behaviour within your application, ie. the user presses a specific key,
-    # you trigger an event to make something happen. Eg. pressing 'p' instructs
-    # the player to play.
+    # Vedeu provides an event mechanism to facilitate the
+    # functionality of your application. The events are either Vedeu
+    # defined, ie. system events or user defined, ie. user events.
+    # User events allow you to orchestrate behaviour within your
+    # application, ie. the user presses a specific key,
+    # you trigger an event to make something happen. Eg. pressing 'p'
+    # instructs the player to play.
     #
-    # Events described here assume that you have either included Vedeu in your
-    # class:
+    # Events described here assume that you have bound the events
+    # within your classes:
     #
     #   class SomeClassInYourApplication
-    #     include Vedeu
-    #
-    #     bind :event_name do |arg1, arg2|
-    #       # Things that should happen when the event is triggered; these can
-    #       # be method calls or the triggering of another event or events.
+    #     Vedeu.bind(:event_name) do |arg1, arg2|
+    #       # Things that should happen when the event is triggered;
+    #       # these can be method calls or the triggering of another
+    #       # event or events.
     #     end
     #
-    # or, you are prepared to use the `Vedeu` prefix:
-    #
-    #   class SomeClassInYourApplication
     #     Vedeu.bind(:event_name) do
-    #       # Not all events you define will have arguments; like methods.
+    #       # Not all events you define will have arguments; like
+    #       # methods.
     #       :do_stuff
     #     end
     #
@@ -36,20 +35,25 @@ module Vedeu
 
       class << self
 
-        # Register an event by name with optional delay (throttling) which when
-        # triggered will execute the code contained within the passed block.
+        # Register an event by name with optional delay (throttling)
+        # which when triggered will execute the code contained within
+        # the passed block.
         #
-        # @param name [Symbol] The name of the event to be triggered later.
-        # @param options [Hash] The options to register the event with.
-        # @option options :delay [Fixnum|Float] Limits the execution of the
-        #   triggered event to only execute when first triggered, with
-        #   subsequent triggering being ignored until the delay has expired.
-        # @option options :debounce [Fixnum|Float] Limits the execution of the
-        #   triggered event to only execute once the debounce has expired.
-        #   Subsequent triggers before debounce expiry are ignored.
-        # @param block [Proc] The event to be executed when triggered. This
-        #   block could be a method call, or the triggering of another event, or
-        #   sequence of either/both.
+        # @param name [Symbol] The name of the event to be triggered
+        #   later.
+        # @param options [Hash] The options to register the event
+        #   with.
+        # @option options :delay [Fixnum|Float] Limits the execution
+        #   of the triggered event to only execute when first
+        #   triggered, with subsequent triggering being ignored until
+        #   the delay has expired.
+        # @option options :debounce [Fixnum|Float] Limits the
+        #   execution of the triggered event to only execute once the
+        #   debounce has expired. Subsequent triggers before debounce
+        #   expiry are ignored.
+        # @param block [Proc] The event to be executed when triggered.
+        #   This block could be a method call, or the triggering of
+        #   another event, or sequence of either/both.
         #
         # @example
         #   Vedeu.bind :my_event do |some, args|
@@ -87,7 +91,8 @@ module Vedeu
         alias_method :event, :bind
         alias_method :register, :bind
 
-        # Return a boolean indicating whether the named event is registered.
+        # Return a boolean indicating whether the named event is
+        # registered.
         #
         # @example
         #   Vedeu.bound?(:some_event)
@@ -153,7 +158,8 @@ module Vedeu
         true
       end
 
-      # Triggers the event based on debouncing and throttling conditions.
+      # Triggers the event based on debouncing and throttling
+      # conditions.
       #
       # @param args [Array]
       # @return [void]
@@ -194,9 +200,9 @@ module Vedeu
         closure.call(*args)
       end
 
-      # Returns a boolean indicating whether throttling is required for this
-      # event. Setting the delay option to any value greater than 0 will enable
-      # throttling.
+      # Returns a boolean indicating whether throttling is required
+      # for this event. Setting the delay option to any value greater
+      # than 0 will enable throttling.
       #
       # @return [Boolean]
       def throttling?
@@ -216,11 +222,12 @@ module Vedeu
         false
       end
 
-      # Returns a boolean indicating whether debouncing is required for this
-      # event. Setting the debounce option to any value greater than 0 will
-      # enable debouncing.
-      # Sets the deadline for when this event can be executed to a point in the
-      # future determined by the amount of debounce time left.
+      # Returns a boolean indicating whether debouncing is required
+      # for this event. Setting the debounce option to any value
+      # greater than 0 will enable debouncing.
+      # Sets the deadline for when this event can be executed to a
+      # point in the future determined by the amount of debounce time
+      # left.
       #
       # @return [Boolean]
       def debouncing?
@@ -242,7 +249,8 @@ module Vedeu
         false
       end
 
-      # Returns a boolean indicating whether this event has a deadline.
+      # Returns a boolean indicating whether this event has a
+      # deadline.
       #
       # @return [Boolean]
       def deadline?
@@ -263,7 +271,8 @@ module Vedeu
         options[:delay] || defaults[:delay]
       end
 
-      # Combines the options provided at instantiation with the default values.
+      # Combines the options provided at instantiation with the
+      # default values.
       #
       # @return [Hash]
       def options

data/lib/vedeu/events/trigger.rb

@@ -38,13 +38,9 @@ module Vedeu
       #
       # @return [Array]
       def trigger
-        if results.one?
-          results[0]
+        return results[0] if results.one?
 
-        else
-          results
-
-        end
+        results
       end
 
       protected
@@ -72,17 +68,13 @@ module Vedeu
       #
       # @return [Array|Array<Vedeu::Events::Event>]
       def registered_events
-        if repository.registered?(name)
-          repository.find(name)
-
-        else
-          Vedeu::Events::Aliases.find(name).map do |event_name|
-            Vedeu::Events::Trigger.trigger(event_name, *args)
-          end
-
-          []
+        return repository.find(name) if repository.registered?(name)
 
+        Vedeu::Events::Aliases.find(name).map do |event_name|
+          Vedeu::Events::Trigger.trigger(event_name, *args)
         end
+
+        []
       end
 
     end # Trigger