vedeu 0.8.0 → 0.8.1

data/lib/vedeu/geometries/positionable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Geometries

data/lib/vedeu/geometries/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Geometries

data/lib/vedeu/groups/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Views can be combined together into a group for easier

data/lib/vedeu/groups/clear.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Groups

data/lib/vedeu/groups/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Groups
@@ -54,7 +56,7 @@ module Vedeu
       #
       # @param name [String|Symbol] The name of this group.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Groups::Group]
       def self.group(name, &block)
         fail Vedeu::Error::MissingRequired unless name

data/lib/vedeu/groups/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Groups
@@ -163,7 +165,7 @@ module Vedeu
       def defaults
         {
           members:    Set.new,
-          name:       ''.freeze,
+          name:       '',
           repository: Vedeu.groups,
           visible:    true,
         }

data/lib/vedeu/groups/refresh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Groups
@@ -35,7 +37,7 @@ module Vedeu
 
       # @return [void]
       def by_name
-        Vedeu.timer("Refresh Group: '#{group_name}'".freeze) do
+        Vedeu.timer("Refresh Group: '#{group_name}'") do
           Vedeu.groups.by_name(group_name).by_zindex.each do |name|
             Vedeu.trigger(:_refresh_view_, name)
           end
@@ -58,7 +60,7 @@ module Vedeu
         return group_from_interface if present?(group_from_interface)
 
         fail Vedeu::Error::MissingRequired,
-             'Cannot refresh group with an empty group name.'.freeze
+             'Cannot refresh group with an empty group name.'
       end
 
       # @return [String|Symbol]

data/lib/vedeu/groups/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Groups

data/lib/vedeu/input/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Classes within the Input namespace handle various aspects of

data/lib/vedeu/input/capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   ESCAPE_KEY_CODE = 27 # \e
@@ -46,7 +48,7 @@ module Vedeu
       #
       # @return [Array|String|Symbol]
       def read
-        Vedeu.log(type: :input, message: 'Waiting for user input...'.freeze)
+        Vedeu.log(type: :input, message: 'Waiting for user input...')
 
         if raw_mode?
           Vedeu.trigger(:_keypress_, keypress)
@@ -115,7 +117,7 @@ module Vedeu
       def click?(keys)
         return false if keys.nil? || keys.is_a?(Symbol)
 
-        keys.is_a?(Vedeu::Cursors::Cursor) || keys.start_with?("\e[M".freeze)
+        keys.is_a?(Vedeu::Cursors::Cursor) || keys.start_with?("\e[M")
       end
 
       # @return [IO]

data/lib/vedeu/input/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -58,9 +60,9 @@ module Vedeu
       # @param name [String|Symbol] The name of the interface which
       #   this keymap relates to.
       # @param block [Proc]
-      # @raise [Vedeu::Error::MissingRequired|
-      #   Vedeu::Error::RequiresBlock] When a name or block
-      #   respectively are not given.
+      # @macro raise_requires_block
+      # @raise [Vedeu::Error::MissingRequired] When the name is not
+      #   given.
       # @return [Vedeu::Input::Keymap]
       def self.keymap(name, &block)
         fail Vedeu::Error::MissingRequired unless name
@@ -88,15 +90,15 @@ module Vedeu
       # @return [Array] A collection containing the keypress(es).
       def key(*values, &block)
         fail Vedeu::Error::InvalidSyntax,
-             'No action defined for `key`.'.freeze unless block_given?
+             'No action defined for `key`.' unless block_given?
 
         fail Vedeu::Error::InvalidSyntax,
-             'No keypress(es) defined for `key`.'.freeze unless present?(values)
+             'No keypress(es) defined for `key`.' unless present?(values)
 
         values.each do |value|
           unless present?(value)
             fail Vedeu::Error::InvalidSyntax,
-                 'An invalid value for `key` was encountered.'.freeze
+                 'An invalid value for `key` was encountered.'
           end
 
           model.add(Vedeu::Input::Key.new(value, &block))

data/lib/vedeu/input/key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -16,7 +18,7 @@ module Vedeu
       #
       # @param input [String|Symbol]
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Input::Key]
       def initialize(input = nil, &block)
         fail Vedeu::Error::RequiresBlock unless block_given?

data/lib/vedeu/input/keymap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -76,7 +78,7 @@ module Vedeu
       def use(input)
         return false unless key_defined?(input)
 
-        Vedeu.log(type: :input, message: "Key pressed: '#{input}'".freeze)
+        Vedeu.log(type: :input, message: "Key pressed: '#{input}'")
 
         keys.select { |key| key.input == input }.map(&:press)
       end
@@ -88,7 +90,7 @@ module Vedeu
       # @return [Hash<Symbol => Array|String|Vedeu::Input::Repository]
       def defaults
         {
-          name:       ''.freeze,
+          name:       '',
           keys:       [],
           repository: Vedeu.keymaps,
         }
@@ -104,7 +106,7 @@ module Vedeu
 
         Vedeu.log(type:    :input,
                   message: "Keymap '#{name}' already " \
-                           "defines '#{key.input}'.".freeze)
+                           "defines '#{key.input}'.")
 
         false
       end

data/lib/vedeu/input/keys.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input

data/lib/vedeu/input/mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -31,10 +33,10 @@ module Vedeu
         def registered?(key = nil, name = nil)
           fail Vedeu::Error::MissingRequired,
                'Cannot check whether a key is registered to a keymap without ' \
-               'the key.'.freeze if absent?(key)
+               'the key.' if absent?(key)
           fail Vedeu::Error::MissingRequired,
                'Cannot check whether a key is registered to a keymap without ' \
-               'the keymap name.'.freeze if absent?(name)
+               'the keymap name.' if absent?(name)
 
           new(key, name).registered?
         end
@@ -142,10 +144,10 @@ module Vedeu
       # @return [String]
       def log_message(key)
         if key.is_a?(Vedeu::Cursors::Cursor)
-          "Click detected: x: #{key.x} y: #{key.y}".freeze
+          "Click detected: x: #{key.x} y: #{key.y}"
 
         else
-          "Key detected: #{key.inspect}".freeze
+          "Key detected: #{key.inspect}"
 
         end
       end
@@ -181,7 +183,7 @@ module Vedeu
 
   # See {file:docs/events/drb.md#\_drb_input_}
   Vedeu.bind(:_drb_input_) do |data, type|
-    Vedeu.log(type: :drb, message: "Sending input (#{type})".freeze)
+    Vedeu.log(type: :drb, message: "Sending input (#{type})")
 
     if type == :command
       Vedeu.trigger(:_command_, data)

data/lib/vedeu/input/mouse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -28,7 +30,7 @@ module Vedeu
       def click
         Vedeu.log(type:    :input,
                   message: "Mouse pressed: '#{button}' " \
-                           "(x: #{x}, y: #{y})".freeze)
+                           "(x: #{x}, y: #{y})")
 
         Vedeu.trigger(:_mouse_event_, input)
 
@@ -44,7 +46,7 @@ module Vedeu
         else
           Vedeu.log(type:    :input,
                     message: 'Vedeu does not support mouse button ' \
-                             "'#{button}' yet.".freeze)
+                             "'#{button}' yet.")
 
         end
       end

data/lib/vedeu/input/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input

data/lib/vedeu/input/read.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -118,7 +120,7 @@ module Vedeu
       def mode
         unless valid_mode?
           fail Vedeu::Error::InvalidSyntax,
-               ':mode must be `:raw`, `:fake` or `:cooked`.'.freeze
+               ':mode must be `:raw`, `:fake` or `:cooked`.'
         end
 
         options[:mode]

data/lib/vedeu/input/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input

data/lib/vedeu/input/store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input

data/lib/vedeu/input/translator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Input
@@ -125,6 +127,6 @@ module Vedeu
     "\e[Z" => :shift_tab,
     "\t" => :tab,
     "\u21B9" => :tab,
-  }.freeze
+  }
 
 end # Vedeu

data/lib/vedeu/interfaces/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # {include:file:docs/interfaces.md}

data/lib/vedeu/interfaces/clear.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Interfaces
@@ -83,7 +85,7 @@ module Vedeu
 
       # @return [String] A string of blank characters.
       def chars
-        @chars ||= (' ' * width).freeze
+        @chars ||= (' ' * width)
       end
 
       # @return [Vedeu::Colours::Colour]
@@ -139,7 +141,7 @@ module Vedeu
 
       # @return [String]
       def optimised_output
-        Vedeu.timer("Optimised clearing #{clearing}: '#{name}'".freeze) do
+        Vedeu.timer("Optimised clearing #{clearing}: '#{name}'") do
           height.times.map do |iy|
             [
               build_position(y + iy, x),
@@ -157,7 +159,7 @@ module Vedeu
       #
       # @return [Array<Array<Vedeu::Views::Char>>]
       def output
-        Vedeu.timer("Clearing #{clearing}: '#{name}'".freeze) do
+        Vedeu.timer("Clearing #{clearing}: '#{name}'") do
           @clear ||= Array.new(height) do |iy|
             Array.new(width) do |ix|
               Vedeu::Cells::Clear.new(colour:   colour,
@@ -171,10 +173,10 @@ module Vedeu
       # @return [String]
       def clearing
         @clearing ||= if content_only?
-                        'content'.freeze
+                        'content'
 
                       else
-                        'interface'.freeze
+                        'interface'
 
                       end
       end

data/lib/vedeu/interfaces/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Interfaces
@@ -32,7 +34,7 @@ module Vedeu
         #   execution lifetime.
         # @param block [Proc] A set of attributes which define the
         #   features of the interface.
-        # @raise [Vedeu::Error::RequiresBlock]
+        # @macro raise_requires_block
         # @return [Vedeu::Interfaces::Interface]
         # @todo More documentation required.
         def interface(name, &block)
@@ -106,7 +108,7 @@ module Vedeu
         # @param block [Proc]
         # @return [Object]
         def client(&block)
-          eval('self', block.binding)
+          eval('self', block.binding) if block_given?
         end
 
         private

data/lib/vedeu/interfaces/interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Interfaces
@@ -148,8 +150,8 @@ module Vedeu
           cursor_visible: true,
           delay:          0.0,
           editable:       false,
-          group:          ''.freeze,
-          name:           ''.freeze,
+          group:          '',
+          name:           '',
           parent:         nil,
           repository:     Vedeu.interfaces,
           style:          :normal,

data/lib/vedeu/interfaces/null.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Interfaces

data/lib/vedeu/interfaces/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Interfaces

data/lib/vedeu/logging/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Classes within the Logging namespace handle various aspects of
@@ -13,6 +15,5 @@ require 'vedeu/logging/clock_time'
 require 'vedeu/logging/lockless_log_device'
 require 'vedeu/logging/mono_logger'
 require 'vedeu/logging/log'
-require 'vedeu/logging/ips'
 require 'vedeu/logging/debug'
 require 'vedeu/logging/timer'