vedeu 0.8.0 → 0.8.1

data/lib/vedeu/logging/clock_time.rb

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

data/lib/vedeu/logging/debug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Logging
@@ -13,12 +15,12 @@ module Vedeu
       # @param obj [Object]
       # @return [void]
       def debug(binding = nil, obj = nil)
-        require 'pry'
+        Vedeu.requires_gem!('pry')
 
         if obj
           message = ::Pry::ColorPrinter.pp(obj, '')
 
-          Vedeu.log(type: :debug, message: "#{message}")
+          Vedeu.log(type: :debug, message: message)
 
         elsif binding
           Vedeu::Terminal.cooked_mode!
@@ -32,37 +34,31 @@ module Vedeu
       end
 
       # :nocov:
-      # Helps to profile a running application by providing a stack
-      # trace of its execution upon exiting.
-      #
-      # @example
-      #   Vedeu.profile('some_file.html') do
-      #     # ... code to profile ...
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/profile.md}
       # @param filename [String] Optional, and defaults to being
       #   written to the /tmp directory.
       # @param block [Proc]
+      # @macro raise_requires_block
       # @return [void]
       # @yieldreturn [void] The section of the application to profile.
-      def self.profile(filename = 'profile.html', &block)
-        return nil unless block_given?
+      def profile(filename = '/tmp/profile.html', &block)
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
-        require 'ruby-prof'
+        Vedeu.requires_gem!('ruby-prof')
 
-        # RubyProf.measure_mode = RubyProf::WALL_TIME
-        # RubyProf.measure_mode = RubyProf::PROCESS_TIME
-        RubyProf.measure_mode = RubyProf::CPU_TIME
-        # RubyProf.measure_mode = RubyProf::ALLOCATIONS
-        # RubyProf.measure_mode = RubyProf::MEMORY
-        # RubyProf.measure_mode = RubyProf::GC_TIME
-        # RubyProf.measure_mode = RubyProf::GC_RUNS
+        # ::RubyProf.measure_mode = ::RubyProf::WALL_TIME
+        # ::RubyProf.measure_mode = ::RubyProf::PROCESS_TIME
+        ::RubyProf.measure_mode = ::RubyProf::CPU_TIME
+        # ::RubyProf.measure_mode = ::RubyProf::ALLOCATIONS
+        # ::RubyProf.measure_mode = ::RubyProf::MEMORY
+        # ::RubyProf.measure_mode = ::RubyProf::GC_TIME
+        # ::RubyProf.measure_mode = ::RubyProf::GC_RUNS
 
-        RubyProf.start
+        ::RubyProf.start
 
         work = yield
 
-        result = RubyProf.stop
+        result = ::RubyProf.stop
         result.eliminate_methods!([
           /^Array/,
           /^Hash/,
@@ -70,39 +66,41 @@ module Vedeu
           /^Fixnum/,
         ])
 
-        File.open('/tmp/' + filename, 'w') do |file|
+        File.open(filename, 'w') do |file|
           # - Creates a HTML visualization of the Ruby stack
-          RubyProf::CallStackPrinter.new(result).print(file)
+          ::RubyProf::CallStackPrinter.new(result).print(file)
 
           # Used with QTCacheGrind to analyse performance.
-          # RubyProf::CallTreePrinter.new(result).print(file)
+          # ::RubyProf::CallTreePrinter.new(result).print(file)
 
           # Creates a flat report in text format
-          # RubyProf::FlatPrinter
+          # ::RubyProf::FlatPrinter
 
           # - same as above but more verbose
-          # RubyProf::FlatPrinterWithLineNumbers
+          # ::RubyProf::FlatPrinterWithLineNumbers
 
           # - Creates a call graph report in text format
-          # RubyProf::GraphPrinter
+          # ::RubyProf::GraphPrinter
 
           # - Creates a call graph report in HTML (separate files per
           #   thread)
-          # RubyProf::GraphHtmlPrinter
+          # ::RubyProf::GraphHtmlPrinter
 
           # - Creates a call graph report in GraphViz's DOT format
           #   which can be converted to an image
-          # RubyProf::DotPrinter
+          # ::RubyProf::DotPrinter
 
           # - Creates a call tree report compatible with KCachegrind.
-          # RubyProf::CallTreePrinter
+          # ::RubyProf::CallTreePrinter
 
           # - Uses the other printers to create several reports in one
           #   profiling run
-          # RubyProf::MultiPrinter
+          # ::RubyProf::MultiPrinter
         end
 
         work
+      rescue NameError
+        yield
       end
       # :nocov:
 
@@ -110,23 +108,13 @@ module Vedeu
 
   end # Logging
 
-  # Allow debugging via the creation of stack traces courtesy of
-  # ruby-prof.
-  #
-  # @example
-  #   Vedeu.profile
-  #
+  # {include:file:docs/dsl/by_method/profile.md}
   # @!method profile
   # @return [Vedeu::Logging::Debug]
   def_delegators Vedeu::Logging::Debug,
                  :profile
 
-  # Drop into a debugging session within a running client application,
-  # courtesy of pry.
-  #
-  # @example
-  #   Vedeu.debug
-  #
+  # {include:file:docs/dsl/by_method/debug.md}
   # @!method debug
   # @return [void]
   def_delegators Vedeu::Logging::Debug,

data/lib/vedeu/logging/lockless_log_device.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Logging
@@ -34,7 +36,7 @@ module Vedeu
         @dev.write(message)
 
       rescue StandardError => exception
-        warn("log writing failed. #{exception}".freeze)
+        warn("log writing failed. #{exception}")
       end
 
       # @return [void]

data/lib/vedeu/logging/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Logging
@@ -90,7 +92,7 @@ module Vedeu
         #   coloured and combined.
         # @return [String]
         def formatted_message(message)
-          "#{timestamp}#{message}\n".freeze if message
+          "#{timestamp}#{message}\n" if message
         end
 
         # Returns the message:
@@ -102,7 +104,16 @@ module Vedeu
         #   log file, useful for debugging.
         # @return [String]
         def log_entry(type, message)
-          "#{message_type(type)}#{message_body(type, message)}".freeze
+          colours = message_types.fetch(type, [:default, :default])
+
+          [
+            Vedeu::EscapeSequences::Esc.colour(colours[0]) do
+              "[#{type}]".ljust(11)
+            end,
+            Vedeu::EscapeSequences::Esc.colour(colours[1]) do
+              message
+            end,
+          ].join('')
         end
 
         # Fetches the filename from the configuration.
@@ -113,36 +124,6 @@ module Vedeu
         end
         alias_method :enabled?, :log_file
 
-        # Displays the message body using the colour specified in the
-        # last element of {message_types}.
-        #
-        # @param type [Symbol] The type of log message.
-        # @param body [String] The log message itself.
-        # @return [String]
-        def message_body(type, body)
-          message_colour(type, -1) { body }
-        end
-
-        # @param type [Symbol] The type of log message.
-        # @param index [Fixnum] Either 0 or -1.
-        # @param block [Proc]
-        # @return [String]
-        def message_colour(type, index, &block)
-          Vedeu::EscapeSequences::Esc.send(
-            message_types.fetch(type, :default)[index]) do
-            yield if block_given?
-          end
-        end
-
-        # Displays the message type using the colour specified in the
-        # first element of {message_types}.
-        #
-        # @param type [Symbol] The type of log message.
-        # @return [String]
-        def message_type(type)
-          message_colour(type, 0) { "[#{type}]".ljust(11) }
-        end
-
         # The defined message types for Vedeu with their respective
         # colours. When used, produces a log entry of the format:
         #
@@ -213,11 +194,4 @@ module Vedeu
                  :log_stderr,
                  :log_timestamp
 
-  # :nocov:
-
-  # See {file:docs/events/system.md#\_log_}
-  Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/logging/mono_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Logging
@@ -14,7 +16,7 @@ module Vedeu
       #   (typically STDOUT, STDERR or an open file).
       # @return [Vedeu::Logging::MonoLogger]
       def initialize(logdev)
-        @progname          = 'Vedeu'.freeze
+        @progname          = 'Vedeu'
         @level             = Logger::DEBUG
         @default_formatter = Logger::Formatter.new
         @formatter         = nil

data/lib/vedeu/logging/timer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Logging
@@ -10,18 +12,10 @@ module Vedeu
 
       class << self
 
-        # Measure the execution time of the code in the given block.
-        # The message provided will have ' took <time>ms.' appended.
-        #
-        # @example
-        #   Vedeu.timer 'Really complex code' do
-        #     # ... code to be measured
-        #   end
-        #
-        #   # => 'Really complex code took 0.234ms.'
-        #
+        # {include:file:docs/dsl/by_method/timer.md}
         # @param message [String]
         # @param block [Proc]
+        # @macro raise_requires_block
         # @return [void] The return value of the executed block.
         def timer(message = '', &block)
           new(message).measure(&block)
@@ -42,7 +36,7 @@ module Vedeu
       # code took in milliseconds. Useful for debugging performance.
       #
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [void] The return value of the executed block.
       def measure(&block)
         fail Vedeu::Error::RequiresBlock unless block_given?
@@ -51,7 +45,7 @@ module Vedeu
           work = yield
 
           Vedeu.log(type:    :timer,
-                    message: "#{message} took #{elapsed}ms.".freeze)
+                    message: "#{message} took #{elapsed}ms.")
 
           work
 
@@ -83,13 +77,7 @@ module Vedeu
 
   end # Logging
 
-  # Measure the execution time of the code in the given block.
-  #
-  # @example
-  #   Vedeu.timer do
-  #     # ... some code here ...
-  #   end
-  #
+  # {include:file:docs/dsl/by_method/timer.md}
   # @!method timer
   #   @see Vedeu::Logging::Timer.timer
   def_delegators Vedeu::Logging::Timer,

data/lib/vedeu/menus/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides the mechanism to create menus within client

data/lib/vedeu/menus/dsl.rb

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

data/lib/vedeu/menus/menu.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Menus
@@ -201,7 +203,7 @@ module Vedeu
           client:     nil,
           collection: [],
           current:    0,
-          name:       ''.freeze,
+          name:       '',
           repository: Vedeu.menus,
           selected:   nil,
         }

data/lib/vedeu/menus/repository.rb

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

data/lib/vedeu/models/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides various models which Vedeu uses.

data/lib/vedeu/models/focus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Models
@@ -36,7 +38,7 @@ module Vedeu
 
         else
           Vedeu.log(type:    :store,
-                    message: "Storing focus entry: '#{name}'".freeze)
+                    message: "Storing focus entry: '#{name}'")
 
           focus ? storage.unshift(name) : storage.push(name)
         end
@@ -56,7 +58,7 @@ module Vedeu
       # @return [String|Symbol] The name of the interface now in
       #   focus.
       def by_name(name)
-        not_registered! unless registered?(name)
+        not_registered!(name) unless registered?(name)
 
         storage.rotate!(storage.index(name))
 
@@ -206,10 +208,10 @@ module Vedeu
       end
 
       # @raise [Vedeu::Error::ModelNotFound]
-      def not_registered!
+      def not_registered!(name)
         fail Vedeu::Error::ModelNotFound,
              "Cannot focus '#{name}' as this interface has not been " \
-             'registered.'.freeze
+             'registered.'
       end
 
       # Return the name of the interface in focus after triggering the
@@ -220,7 +222,7 @@ module Vedeu
       def update
         return false if storage.empty?
 
-        Vedeu.log(message: "Interface in focus: '#{current}'".freeze)
+        Vedeu.log(message: "Interface in focus: '#{current}'")
 
         refresh
 

data/lib/vedeu/models/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Models
@@ -33,7 +35,7 @@ module Vedeu
         else
           fail Vedeu::Error::InvalidSyntax,
                'Cannot coerce as value is not an Array, Vedeu::Models::Page ' \
-               "or Vedeu::Models::Row. Is a '#{value.class.name}'.".freeze
+               "or Vedeu::Models::Row. Is a '#{value.class.name}'."
 
         end
       end

data/lib/vedeu/models/row.rb

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

data/lib/vedeu/models/toggleable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # This module provides behaviour for certain classes which can be

data/lib/vedeu/null/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # A group of objects that serve to intercept messages destined for