vedeu 0.8.0 → 0.8.1

data/lib/vedeu/renderers/text.rb

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

data/lib/vedeu/repositories/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides all registered repositories.

data/lib/vedeu/repositories/assemblage.rb

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

data/lib/vedeu/repositories/collection.rb

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

data/lib/vedeu/repositories/defaults.rb

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

data/lib/vedeu/repositories/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Repositories
@@ -37,7 +39,7 @@ module Vedeu
 
           Vedeu.log(type:    :debug,
                     message: "DSL building: '#{model.class.name}' for " \
-                             "'#{model.name}'".freeze)
+                             "'#{model.name}'")
 
           model.deputy.instance_eval(&block) if block_given?
 

data/lib/vedeu/repositories/parent.rb

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

data/lib/vedeu/repositories/registerable.rb

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

data/lib/vedeu/repositories/repositories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides all registered repositories.
@@ -30,7 +32,7 @@ module Vedeu
 
         Vedeu.log(type:    :store,
                   message: "Repository '#{repository.class.name}':" \
-                           " #{registered.inspect}".freeze)
+                           " #{registered.inspect}")
 
         registered
       end

data/lib/vedeu/repositories/repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Repositories
@@ -94,7 +96,7 @@ module Vedeu
       # @return [Hash<String => Object>]
       def find!(name)
         find(name) || fail(Vedeu::Error::ModelNotFound,
-                           "Cannot find model by name: '#{name}'".freeze)
+                           "Cannot find model by name: '#{name}'")
       end
 
       # Find a model by name, registers the model by name when not
@@ -107,14 +109,14 @@ module Vedeu
 
         Vedeu.log(type:    :store,
                   message: "Model (#{model}) not found, " \
-                           "registering: '#{name}'".freeze)
+                           "registering: '#{name}'")
 
         model.new(name).store
       end
 
       # @return [String]
       def inspect
-        "<#{self.class.name}>".freeze
+        "<#{self.class.name}>"
       end
 
       # Returns a boolean indicating whether the named model is
@@ -173,8 +175,8 @@ module Vedeu
       def log_store(model)
         type = registered?(model.name) ? :update : :create
 
-        Vedeu.log(type: type,
-                  message: "#{model.class.name}: '#{model.name}'".freeze)
+        Vedeu.log(type:    type,
+                  message: "#{model.class.name}: '#{model.name}'")
       end
 
       #
@@ -183,7 +185,7 @@ module Vedeu
       def valid_model?(model)
         fail Vedeu::Error::MissingRequired,
              "Cannot store model '#{model.class}' without a name " \
-             'attribute.'.freeze unless present?(model.name)
+             'attribute.' unless present?(model.name)
       end
 
     end # Repository

data/lib/vedeu/repositories/store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Repositories
@@ -53,7 +55,7 @@ module Vedeu
       # @return [Array|Hash|Set]
       def reset!
         Vedeu.log(type:    :reset,
-                  message: "(#{self.class.name}) #{registered.inspect}".freeze)
+                  message: "(#{self.class.name}) #{registered.inspect}")
 
         @storage = in_memory
       end

data/lib/vedeu/runtime/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides the classes which control the basic Vedeu runtime.

data/lib/vedeu/runtime/application.rb

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

data/lib/vedeu/runtime/bootstrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Runtime
@@ -65,12 +67,12 @@ module Vedeu
       # @return [void]
       def client_application!
         [
-          'app/views/templates/**/*'.freeze,
-          'app/views/interfaces/**/*'.freeze,
-          'app/controllers/**/*'.freeze,
-          'app/helpers/**/*'.freeze,
-          'app/views/**/*'.freeze,
-          'app/models/keymaps/**/*'.freeze,
+          'app/views/templates/**/*',
+          'app/views/interfaces/**/*',
+          'app/controllers/**/*',
+          'app/helpers/**/*',
+          'app/views/**/*',
+          'app/models/keymaps/**/*',
         ].each { |path| load(File.join(base_path, path)) }
       end
 
@@ -103,7 +105,7 @@ module Vedeu
       # @return [Array<String>]
       def loadables(path)
         Dir.glob(path).select do |file|
-          File.file?(file) && File.extname(file) == '.rb'.freeze
+          File.file?(file) && File.extname(file) == '.rb'
         end
       end
 
@@ -121,7 +123,7 @@ module Vedeu
         "controller and action: (args are optional)\n\n" \
         "Vedeu.configure do\n" \
         "  root :some_controller, :show, *args\n" \
-        "end\n\n".freeze
+        "end\n\n"
       end
 
     end # Bootstrap

data/lib/vedeu/runtime/flags.rb

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

data/lib/vedeu/runtime/launcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # This class ensures that STDIN, STDOUT and STDERR point to the
@@ -70,8 +72,8 @@ module Vedeu
 
     rescue StandardError => uncaught_exception
       output = if Vedeu::Configuration.debug?
-                 uncaught_exception.message + "\n".freeze +
-                 uncaught_exception.backtrace.join("\n".freeze)
+                 uncaught_exception.message + "\n" +
+                 uncaught_exception.backtrace.join("\n")
                else
                  uncaught_exception.message
                end
@@ -106,7 +108,7 @@ module Vedeu
     #
     # @return [void]
     def terminate!
-      Vedeu.log(message: 'Exiting gracefully.'.freeze)
+      Vedeu.log(message: 'Exiting gracefully.')
 
       $stdin  = STDIN
       $stdout = STDOUT

data/lib/vedeu/runtime/main_loop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Runtime
@@ -45,7 +47,7 @@ module Vedeu
             safe_exit_point!
           end
         rescue Vedeu::Error::Interrupt
-          Vedeu.log(message: 'Vedeu execution interrupted, exiting.'.freeze)
+          Vedeu.log(message: 'Vedeu execution interrupted, exiting.')
         end
 
         # Signal that we wish to terminate the running application.

data/lib/vedeu/runtime/router.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Runtime
@@ -22,11 +24,11 @@ module Vedeu
       def add_controller(controller, klass)
         unless present?(controller)
           fail Vedeu::Error::MissingRequired,
-               'Cannot store controller without a name attribute.'.freeze
+               'Cannot store controller without a name attribute.'
         end
 
         Vedeu.log(type:    :create,
-                  message: "Controller: ':#{controller}'.freeze")
+                  message: "Controller: ':#{controller}'")
 
         if registered?(controller)
           storage[controller].merge!(klass: klass)
@@ -51,7 +53,7 @@ module Vedeu
         if present?(controller) && present?(action)
           Vedeu.log(type:    :create,
                     message: "Action: ':#{action}' " \
-                             "(for ':#{controller}')".freeze)
+                             "(for ':#{controller}')")
 
           if registered?(controller)
             storage[controller][:actions] << action
@@ -67,17 +69,12 @@ module Vedeu
         else
           fail Vedeu::Error::MissingRequired,
                'Cannot store action without a controller or name ' \
-               'attribute.'.freeze
+               'attribute.'
 
         end
       end
 
-      # Instruct Vedeu to load the client application controller
-      # action with parameters.
-      #
-      # @example
-      #   Vedeu.goto(controller, action, args)
-      #
+      # {include:file:docs/dsl/by_method/goto.md}
       # @param controller [Symbol]
       # @param action [Symbol]
       # @param args [void]
@@ -86,7 +83,7 @@ module Vedeu
       # @return [void]
       def goto(controller, action, **args)
         Vedeu.log(type:    :debug,
-                  message: "Routing: #{controller} #{action}".freeze)
+                  message: "Routing: #{controller} #{action}")
 
         route(controller, action, args) if action_defined?(action, controller)
       end
@@ -122,11 +119,11 @@ module Vedeu
           return true if storage[controller][:actions].include?(action)
 
           fail Vedeu::Error::ActionNotFound,
-               "#{action} is not registered for #{controller}.".freeze
+               "#{action} is not registered for #{controller}."
 
         else
           fail Vedeu::Error::ControllerNotFound,
-               "#{controller} is not registered.".freeze
+               "#{controller} is not registered."
 
         end
       end
@@ -155,7 +152,7 @@ module Vedeu
 
         else
           fail Vedeu::Error::MissingRequired,
-               "Cannot route to #{controller} as no class defined.".freeze
+               "Cannot route to #{controller} as no class defined."
 
         end
       end

data/lib/vedeu/runtime/traps.rb

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

data/lib/vedeu/templating/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides means to use templates with Vedeu.

data/lib/vedeu/templating/decoder.rb

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

data/lib/vedeu/templating/encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Templating
@@ -43,7 +45,7 @@ module Vedeu
       #
       # @return [String]
       def wrap
-        "{{#{encode64}}}".freeze
+        "{{#{encode64}}}"
       end
 
       # Encode the compressed, marshalled object or objects into a

data/lib/vedeu/templating/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Templating
@@ -10,7 +12,7 @@ module Vedeu
 
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def background(value, &block)
         define_stream(background: value, &block)
@@ -23,7 +25,7 @@ module Vedeu
       # @option attributes background [String] The HTML/CSS background
       #   colour.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def colour(attributes = {}, &block)
         define_stream(attributes, &block)
@@ -31,7 +33,7 @@ module Vedeu
 
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Views::Stream]
       def foreground(value, &block)
         define_stream(foreground: value, &block)

data/lib/vedeu/templating/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Templating
@@ -52,11 +54,11 @@ module Vedeu
       # @return [String]
       def path
         fail Vedeu::Error::MissingRequired,
-             'No path to template specified.'.freeze if @path.empty?
+             'No path to template specified.' if @path.empty?
 
         unless File.exist?(@path)
           fail Vedeu::Error::MissingRequired,
-               "Template file cannot be found. (#{@path})".freeze
+               "Template file cannot be found. (#{@path})"
         end
 
         @path

data/lib/vedeu/templating/view_template.rb

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

data/lib/vedeu/terminal/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # This module is the direct interface between Vedeu and your

data/lib/vedeu/terminal/mode.rb

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

data/lib/vedeu/terminal/terminal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # This module is the direct interface between Vedeu and your
@@ -13,8 +15,7 @@ module Vedeu
     # {Vedeu::Terminal#restore_screen}.
     #
     # @param block [Proc]
-    # @raise [Vedeu::Error::RequiresBlock] The required block was not
-    #   given.
+    # @macro raise_requires_block
     # @return [Array]
     def open(&block)
       fail Vedeu::Error::RequiresBlock unless block_given?
@@ -37,21 +38,14 @@ module Vedeu
     def output(*streams)
       streams.each do |stream|
         Vedeu.log(type:    :output,
-                  message: "Writing to terminal #{stream.size} bytes".freeze)
+                  message: "Writing to terminal #{stream.size} bytes")
 
         console.print(stream)
       end
     end
     alias_method :write, :output
 
-    # When the terminal emit the 'SIGWINCH' signal, Vedeu can
-    # intercept this and attempt to redraw the current interface with
-    # varying degrees of success. Can also be used to simulate a
-    # terminal resize.
-    #
-    # @example
-    #   Vedeu.resize
-    #
+    # {include:file:docs/dsl/by_method/resize.md}
     # @return [Boolean]
     def resize
       Vedeu.trigger(:_clear_)
@@ -65,15 +59,14 @@ module Vedeu
     # @param mode [Symbol]
     # @return [void]
     def initialize_screen(mode, &block)
-      Vedeu.log(message: "Terminal entering '#{mode}' mode".freeze)
+      Vedeu.log(message: "Terminal entering '#{mode}' mode")
 
       output(Vedeu::EscapeSequences::Esc.screen_init)
 
       yield if block_given?
     end
 
-    # Disables the mouse and shows the cursor. Used by the debugging
-    # snippet in {file:docs/debugging.md}.
+    # Disables the mouse and shows the cursor.
     #
     # @return [String]
     def debugging!
@@ -145,16 +138,7 @@ module Vedeu
     alias_method :tx, :origin
     alias_method :ty, :origin
 
-    # Returns the total width (number of columns/characters) of the
-    # current terminal.
-    #
-    # @example
-    #   Vedeu.width # => provides the width via the Vedeu API.
-    #
-    # @note
-    #   See Vedeu::Terminal#size for more information about the
-    #   reported terminal size.
-    #
+    # {include:file:docs/dsl/by_method/width.md}
     # @return [Fixnum]
     def width
       return Vedeu::Configuration.drb_width if Vedeu::Configuration.drb?
@@ -165,16 +149,7 @@ module Vedeu
     alias_method :xn, :width
     alias_method :txn, :width
 
-    # Returns the total height (number of rows/lines) of the current
-    # terminal.
-    #
-    # @example
-    #   Vedeu.height # => provides the height via the Vedeu API.
-    #
-    # @note
-    #   See Vedeu::Terminal#size for more information about the
-    #   reported terminal size.
-    #
+    # {include:file:docs/dsl/by_method/height.md}
     # @return [Fixnum]
     def height
       return Vedeu::Configuration.drb_height if Vedeu::Configuration.drb?