vedeu 0.8.1 → 0.8.2

data/lib/vedeu/input/read.rb

@@ -80,12 +80,12 @@ module Vedeu
 
       # @return [String]
       def mouse_off
-        Vedeu::EscapeSequences::Esc.mouse_x10_off
+        Vedeu.esc.mouse_x10_off
       end
 
       # @return [String]
       def show_cursor
-        Vedeu::EscapeSequences::Esc.show_cursor
+        Vedeu.esc.show_cursor
       end
 
       # @return [String]
@@ -103,7 +103,7 @@ module Vedeu
 
                     elsif fake?
                       console.cooked do
-                        Vedeu::Terminal.output(mouse_off + show_cursor)
+                        Vedeu::Terminal.debugging!
 
                         console.gets.chomp
                       end

data/lib/vedeu/input/store.rb

@@ -10,70 +10,39 @@ module Vedeu
 
       extend self
 
-      # Add a command (a collection of characters/keypresses from an
-      # Editor::Document) to the store. Used by Vedeu internally to
-      # store commands entered.
-      #
-      # @example
-      #   Vedeu.add_command(:some_command)
-      #
+      # {include:file:docs/dsl/by_method/add_command.md}
       # @param command [Symbol|String]
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def add_command(command)
         all_commands << command
       end
 
-      # Add a keypress to the store. Used by Vedeu internally to
-      # store a keypress entered.
-      #
-      # @example
-      #   Vedeu.add_keypress(:escape)
-      #
+      # {include:file:docs/dsl/by_method/add_keypress.md}
       # @param keypress [Symbol|String]
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def add_keypress(keypress)
         all_keypresses << keypress
       end
 
-      # Access all commands stored.
-      #
-      # @example
-      #   Vedeu.all_commands
-      #
+      # {include:file:docs/dsl/by_method/all_commands.md}
       # @return [Array<Symbol|String>]
       def all_commands
         storage[:commands]
       end
 
-      # Access all keypresses stored.
-      #
-      # @example
-      #   Vedeu.all_keypresses
-      #
+      # {include:file:docs/dsl/by_method/all_keypresses.md}
       # @return [Array<Symbol|String>]
       def all_keypresses
         storage[:keypresses]
       end
 
-      # Access the last command stored. If no commands have been
-      # entered since the client application started, then this will
-      # return nil.
-      #
-      # @example
-      #   Vedeu.last_command
-      #
+      # {include:file:docs/dsl/by_method/last_command.md}
       # @return [NilClass|Symbol|String]
       def last_command
         all_commands[-1]
       end
 
-      # Access the last keypress stored. If no keys have been pressed
-      # since the client application started, then this will return
-      # nil.
-      #
-      # @example
-      #   Vedeu.last_keypress
-      #
+      # {include:file:docs/dsl/by_method/last_keypress.md}
       # @return [NilClass|Symbol|String]
       def last_keypress
         all_keypresses[-1]

data/lib/vedeu/interfaces/interface.rb

@@ -146,7 +146,7 @@ module Vedeu
       def defaults
         {
           client:         nil,
-          colour:         Vedeu::Configuration.colour,
+          colour:         Vedeu.config.colour,
           cursor_visible: true,
           delay:          0.0,
           editable:       false,

data/lib/vedeu/logging/debug.rb

@@ -18,7 +18,7 @@ module Vedeu
         Vedeu.requires_gem!('pry')
 
         if obj
-          message = ::Pry::ColorPrinter.pp(obj, '')
+          message = ::Pry::ColorPrinter.pp(obj, ''.dup)
 
           Vedeu.log(type: :debug, message: message)
 

data/lib/vedeu/logging/log.rb

@@ -28,7 +28,8 @@ module Vedeu
         def log(message:, force: false, type: :info)
           output = log_entry(type, message)
 
-          if (enabled? || force) && Vedeu::Configuration.loggable?(type)
+          if (Vedeu.config.log? || force) &&
+             Vedeu.config.loggable?(type)
             logger.debug(output)
           end
 
@@ -77,7 +78,7 @@ module Vedeu
 
         # @return [Boolean]
         def logger
-          MonoLogger.new(log_file).tap do |log|
+          MonoLogger.new(Vedeu.config.log).tap do |log|
             log.formatter = proc do |_, _, _, message|
               formatted_message(message)
             end
@@ -107,23 +108,11 @@ module Vedeu
           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('')
+            Vedeu.esc.colour(colours[0]) { "[#{type}]".ljust(11) },
+            Vedeu.esc.colour(colours[1]) { message },
+          ].join
         end
 
-        # Fetches the filename from the configuration.
-        #
-        # @return [String]
-        def log_file
-          Vedeu::Configuration.log
-        end
-        alias_method :enabled?, :log_file
-
         # The defined message types for Vedeu with their respective
         # colours. When used, produces a log entry of the format:
         #

data/lib/vedeu/logging/timer.rb

@@ -41,7 +41,7 @@ module Vedeu
       def measure(&block)
         fail Vedeu::Error::RequiresBlock unless block_given?
 
-        if Vedeu::Configuration.debug?
+        if Vedeu.config.debug?
           work = yield
 
           Vedeu.log(type:    :timer,

data/lib/vedeu/models/row.rb

@@ -81,7 +81,7 @@ module Vedeu
       #
       # @return [Vedeu::Views::Char]
       def reset_character
-        Vedeu::Views::Char.new(value: Vedeu::EscapeSequences::Esc.reset)
+        Vedeu::Views::Char.new(value: Vedeu.esc.reset)
       end
 
       # @return [Fixnum]

data/lib/vedeu/output/write.rb

@@ -100,9 +100,7 @@ module Vedeu
 
       # @return [String]
       def to_s
-        @_to_s ||= super +
-                   Vedeu::EscapeSequences::Esc.reset +
-                   position(position_end)
+        @_to_s ||= super + Vedeu.esc.reset + position(position_end)
       end
       alias_method :to_str, :to_s
 

data/lib/vedeu/presentation/style.rb

@@ -82,9 +82,7 @@ module Vedeu
       def to_s
         return '' unless present?(value)
 
-        @sequences ||= Array(value).flat_map do |v|
-          Vedeu::EscapeSequences::Esc.string(v)
-        end.join
+        @sequences ||= Array(value).flat_map { |v| Vedeu.esc.string(v) }.join
       end
       alias_method :escape_sequences, :to_s
       alias_method :to_str, :to_s

data/lib/vedeu/renderers/all.rb

@@ -69,8 +69,8 @@ module Vedeu
 
     # @return [Set]
     def in_memory
-      if Vedeu::Configuration.renderers.any?
-        Set.new(Vedeu::Configuration.renderers)
+      if Vedeu.config.renderers.any?
+        Set.new(Vedeu.config.renderers)
 
       else
         Set.new([Vedeu::Renderers::Terminal.new])

data/lib/vedeu/renderers/file.rb

@@ -89,7 +89,7 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          compression: Vedeu::Configuration.compression?,
+          compression: Vedeu.config.compression?,
           filename:    'out',
           timestamp:   false,
           write_file:  true,

data/lib/vedeu/renderers/options.rb

@@ -19,7 +19,7 @@ module Vedeu
       #
       # @return [Boolean]
       def compress?
-        options[:compression] || Vedeu::Configuration.compression? || false
+        options[:compression] || Vedeu.config.compression? || false
       end
 
       private

data/lib/vedeu/runtime/application.rb

@@ -10,14 +10,14 @@ module Vedeu
 
       class << self
 
-        # @param (see #initialize)
-        def start(configuration)
-          new(configuration).start
+        # @return [void]
+        def start
+          new.start
         end
 
-        # @param (see #initialize)
-        def restart(configuration)
-          new(configuration).start
+        # @return [void]
+        def restart
+          new.start
         end
 
         # Stops the application! - The `:_cleanup_` event is
@@ -44,11 +44,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Runtime::Application.
       #
-      # @param configuration [Vedeu::Configuration]
       # @return [Vedeu::Runtime::Application]
-      def initialize(configuration = Vedeu::Configuration)
-        @configuration = configuration
-      end
+      def initialize; end
 
       # Starts the application!
       #
@@ -75,12 +72,6 @@ module Vedeu
         end
       end
 
-      protected
-
-      # @!attribute [r] configuration
-      # @return [Vedeu::Configuration]
-      attr_reader :configuration
-
       private
 
       # Runs the application loop either once, or forever (exceptions
@@ -89,7 +80,7 @@ module Vedeu
       # @param block [Proc]
       # @return [void]
       def runner(&block)
-        return yield if configuration.once?
+        return yield if Vedeu.config.once?
 
         run_many { yield }
       end
@@ -104,7 +95,7 @@ module Vedeu
       #
       # @return [void]
       def main_sequence
-        if configuration.interactive?
+        if Vedeu.config.interactive?
           Vedeu::Input::Capture.read
 
         else
@@ -124,7 +115,7 @@ module Vedeu
         Vedeu::Runtime::MainLoop.start! { yield }
 
       rescue Vedeu::Error::ModeSwitch
-        Vedeu::Runtime::Application.restart(Vedeu::Configuration)
+        Vedeu::Runtime::Application.restart
       end
 
       # :nocov:

data/lib/vedeu/runtime/bootstrap.rb

@@ -49,7 +49,7 @@ module Vedeu
 
       # @return [String]
       def base_path
-        Vedeu::Configuration.base_path
+        Vedeu.config.base_path
       end
 
       # @note
@@ -78,8 +78,8 @@ module Vedeu
 
       # @return [void]
       def client_initialize!
-        if Vedeu::Configuration.root
-          Vedeu.trigger(:_goto_, *Vedeu::Configuration.root)
+        if Vedeu.config.root
+          Vedeu.trigger(:_goto_, *Vedeu.config.root)
 
         else
           Vedeu.log_stderr(type: :debug, message: client_initialize_error)
@@ -113,7 +113,7 @@ module Vedeu
       def configure_log!
         Vedeu.configure do
           log('/tmp/vedeu_bootstrap.log')
-        end unless Vedeu::Configuration.log?
+        end unless Vedeu.config.log?
       end
 
       # @return [String]

data/lib/vedeu/runtime/launcher.rb

@@ -62,16 +62,14 @@ module Vedeu
       $stdout = @stdout
       $stderr = @stderr
 
-      optionally_profile do
-        Vedeu::Runtime::Application.start(Vedeu::Configuration)
-      end
+      optionally_profile { Vedeu::Runtime::Application.start }
 
       @exit_code = 0
 
       terminate!
 
     rescue StandardError => uncaught_exception
-      output = if Vedeu::Configuration.debug?
+      output = if Vedeu.config.debug?
                  uncaught_exception.message + "\n" +
                  uncaught_exception.backtrace.join("\n")
                else
@@ -93,7 +91,7 @@ module Vedeu
     # @param block [Proc]
     # @return [void]
     def optionally_profile(&block)
-      if Vedeu::Configuration.profile?
+      if Vedeu.config.profile?
         Vedeu.profile { yield }
 
       else

data/lib/vedeu/terminal/mode.rb

@@ -81,7 +81,7 @@ module Vedeu
       #
       # @return [Symbol]
       def mode
-        @mode = Vedeu::Configuration.terminal_mode
+        @mode = Vedeu.config.terminal_mode
       end
 
       private

data/lib/vedeu/terminal/terminal.rb

@@ -61,7 +61,7 @@ module Vedeu
     def initialize_screen(mode, &block)
       Vedeu.log(message: "Terminal entering '#{mode}' mode")
 
-      output(Vedeu::EscapeSequences::Esc.screen_init)
+      output(Vedeu.esc.screen_init)
 
       yield if block_given?
     end
@@ -70,8 +70,7 @@ module Vedeu
     #
     # @return [String]
     def debugging!
-      output(Vedeu::EscapeSequences::Esc.mouse_x10_off +
-             Vedeu::EscapeSequences::Esc.show_cursor)
+      output(Vedeu.esc.mouse_x10_off + Vedeu.esc.show_cursor)
     end
 
     # Clears the entire terminal space.
@@ -81,7 +80,7 @@ module Vedeu
     #
     # @return [String]
     def clear
-      output(Vedeu::EscapeSequences::Esc.clear)
+      output(Vedeu.esc.clear)
     end
 
     # Attempts to tidy up the screen just before the application
@@ -91,7 +90,7 @@ module Vedeu
     #
     # @return [String]
     def restore_screen
-      output(Vedeu::EscapeSequences::Esc.screen_exit)
+      output(Vedeu.esc.screen_exit)
     end
 
     # Sets the cursor to be visible unless in raw mode, whereby it
@@ -99,7 +98,7 @@ module Vedeu
     #
     # @return [String]
     def set_cursor_mode
-      output(Vedeu::EscapeSequences::Esc.show_cursor) unless raw_mode?
+      output(Vedeu.esc.show_cursor) unless raw_mode?
     end
 
     # Returns a coordinate tuple of the format [y, x], where `y` is
@@ -141,8 +140,8 @@ module Vedeu
     # {include:file:docs/dsl/by_method/width.md}
     # @return [Fixnum]
     def width
-      return Vedeu::Configuration.drb_width if Vedeu::Configuration.drb?
-      return Vedeu::Configuration.width     if Vedeu::Configuration.width
+      return Vedeu.config.drb_width if Vedeu.config.drb?
+      return Vedeu.config.width     if Vedeu.config.width
 
       size[-1]
     end
@@ -152,8 +151,8 @@ module Vedeu
     # {include:file:docs/dsl/by_method/height.md}
     # @return [Fixnum]
     def height
-      return Vedeu::Configuration.drb_height if Vedeu::Configuration.drb?
-      return Vedeu::Configuration.height     if Vedeu::Configuration.height
+      return Vedeu.config.drb_height if Vedeu.config.drb?
+      return Vedeu.config.height     if Vedeu.config.height
 
       size[0]
     end

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 
 end