vedeu 0.8.0 → 0.8.1

data/lib/vedeu/colours/colour.rb

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

data/lib/vedeu/colours/foreground.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Colours
@@ -19,7 +21,7 @@ module Vedeu
 
       # @return [String]
       def prefix
-        "\e[38;".freeze
+        "\e[38;"
       end
 
       # Returns an escape sequence for a named colour.

data/lib/vedeu/colours/foregrounds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Colours
@@ -6,11 +8,7 @@ module Vedeu
     #
     class Foregrounds < Vedeu::Colours::Repository
 
-      # Manipulate the repository of foreground colours.
-      #
-      # @example
-      #   Vedeu.foreground_colours
-      #
+      # {include:file:docs/dsl/by_method/foreground_colours.md}
       # @return [Vedeu::Colours::Foregrounds]
       # @see Vedeu::Repositories::Repository
       def self.foreground_colours

data/lib/vedeu/colours/repository.rb

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

data/lib/vedeu/colours/translator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Colours
@@ -143,7 +145,7 @@ module Vedeu
       #
       # @return [String]
       def numbered
-        "#{prefix}5;#{css_to_numbered}m".freeze
+        "#{prefix}5;#{css_to_numbered}m"
       end
 
       # Returns an escape sequence.
@@ -169,7 +171,7 @@ module Vedeu
       #
       # @return [String]
       def rgb_prefix
-        "#{prefix}2;%s;%s;%sm".freeze
+        "#{prefix}2;%s;%s;%sm"
       end
 
       # Returns a collection of converted HTML/CSS octets as their
@@ -227,7 +229,7 @@ module Vedeu
       #   must implement this method.
       # @return [Vedeu::Error::NotImplemented]
       def not_implemented
-        fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'.freeze
+        fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'
       end
       alias_method :named_code, :not_implemented
       alias_method :repository, :not_implemented

data/lib/vedeu/colours/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Colours
@@ -44,7 +46,7 @@ module Vedeu
       #
       # @return [Boolean]
       def rgb?
-        return true if value =~ /^#([A-Fa-f0-9]{6})$/.freeze
+        return true if value =~ /^#([A-Fa-f0-9]{6})$/
 
         false
       end

data/lib/vedeu/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # A module for common methods used throughout Vedeu.
@@ -88,15 +90,22 @@ module Vedeu
     #   snake_case(NameSpaced::ClassName)
     #   # => "name_spaced/class_name"
     #
-    # @param name [String]
+    #   snake_case('MyClassName') # => "my_class_name"
+    #   snake_case(NameSpaced::ClassName)
+    #   # => "name_spaced/class_name"
+    #
+    # @param klass [Module|Class|String]
     # @return [String]
-    def snake_case(name)
-      name.gsub!(/::/, '/')
-      name.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      name.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      name.tr!('-', '_')
-      name.downcase!
-      name
+    def snake_case(klass)
+      str = klass.is_a?(Module) ? klass.name : klass
+
+      str.split(/::/).map do |namespace|
+        *upper, _ = namespace.split(/([A-Z]+)/).reject(&:empty?).map do |chars|
+          chars.match(/\p{Lower}/) ? [chars, '_'] : chars
+        end.flatten
+
+        upper.map(&:downcase).join
+      end.join('/')
     end
 
     # Returns a boolean indicating whether the value is a Fixnum.

data/lib/vedeu/configuration/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Namespace for configuration classes.
@@ -14,11 +16,11 @@ module Vedeu
     def log(from, options)
       options.each do |option, value|
         Vedeu.log(type:    :config,
-                  message: "#{from} #{option}: #{value}".freeze)
+                  message: "#{from} #{option}: #{value}")
       end
     end
 
-  end
+  end # Config
 
 end # Vedeu
 

data/lib/vedeu/configuration/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Config
@@ -584,8 +586,8 @@ module Vedeu
       # @param attrs [Hash<Symbol => String>]
       # @return [Hash<Symbol => void>]
       def colour(attrs = {})
-        options[:background] = attrs[:background]
-        options[:foreground] = attrs[:foreground]
+        options[:background] = attrs[:background] if attrs.key?(:background)
+        options[:foreground] = attrs[:foreground] if attrs.key?(:foreground)
         options
       end
 
@@ -610,22 +612,10 @@ module Vedeu
 
       private
 
-      # @param attrs [Hash<Symbol => Vedeu::Colours::Background,
-      #   Vedeu::Colours::Foreground>]
-      # @option attrs background [Vedeu::Colours::Background]
-      # @option attrs foreground [Vedeu::Colours::Foreground]
-      # @return [Hash<Symbol => Symbol>]
-      def colour_attributes(attrs = {})
-        {
-          background: Vedeu::Configuration.background,
-          foreground: Vedeu::Configuration.foreground,
-        }.merge!(attrs)
-      end
-
       # @raise [Vedeu::Error::InvalidSyntax]
       def invalid_mode!
         fail Vedeu::Error::InvalidSyntax,
-             'Terminal mode can be set to either :cooked, :fake or :raw'.freeze
+             'Terminal mode can be set to either :cooked, :fake or :raw'
       end
 
       # Returns the options set via the configuration API DSL or an

data/lib/vedeu/configuration/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Allows the customisation of Vedeu's behaviour through the
@@ -17,9 +19,9 @@ module Vedeu
       # Return the configured background colour for the client
       # application.
       #
-      # @return [Vedeu::Colours::Background]
+      # @return [String|Symbol]
       def background
-        Vedeu::Colours::Background.coerce(instance.options[:background])
+        instance.options[:background]
       end
 
       # Returns the base_path value.
@@ -37,14 +39,7 @@ module Vedeu
       end
       alias_method :compression?, :compression
 
-      # Provides the mechanism to configure Vedeu. If the client
-      # application sets options, override the defaults with those.
-      #
-      # @example
-      #   Vedeu.configure do
-      #     # ...
-      #   end
-      #
+      # {include:file:docs/dsl/by_method/configure.md}
       # @param opts [Hash<Symbol => void>]
       # @option opts stdin [File|IO]
       # @option opts stdout [File|IO]
@@ -57,22 +52,18 @@ module Vedeu
         instance.configure(opts, &block)
       end
 
-      # Returns the configuration singleton.
-      # Append configuration methods to access the configuration
-      # variable.
-      #
-      # @example
-      #   Vedeu.configuration
-      #
+      # {include:file:docs/dsl/by_method/configuration.md}
       # @return [Vedeu::Configuration]
       def configuration
         instance
       end
 
-      # @return [Vedeu::Colours::Colour]
+      # @return [Hash]
       def colour
-        Vedeu::Colours::Colour.coerce(background: background,
-                                      foreground: foreground)
+        {
+          background: background,
+          foreground: foreground,
+        }
       end
 
       # Returns the chosen colour mode.
@@ -132,9 +123,9 @@ module Vedeu
       # Return the configured foreground colour for the client
       # application.
       #
-      # @return [Vedeu::Colours::Foreground]
+      # @return [String|Symbol]
       def foreground
-        Vedeu::Colours::Foreground.coerce(instance.options[:foreground])
+        instance.options[:foreground]
       end
 
       # Returns the client defined height for the terminal.
@@ -305,8 +296,6 @@ module Vedeu
 
       @options.merge!(Config::API.configure(&block)) if block_given?
 
-      Vedeu::Renderers.renderer(*@options[:renderers])
-
       Vedeu::Configuration
     end
 
@@ -344,7 +333,7 @@ module Vedeu
         mouse:         true,
         once:          false,
         profile:       false,
-        renderers:     [Vedeu::Renderers::Terminal.new],
+        renderers:     [],
         root:          nil,
         stdin:         nil,
         stdout:        nil,
@@ -375,8 +364,6 @@ module Vedeu
 
   end # Configuration
 
-  require 'vedeu/renderers/all'
-
   Vedeu::Configuration.configure({})
 
   # @!method configure

data/lib/vedeu/cursors/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Vedeu creates an individual cursor for each interface defined,

data/lib/vedeu/cursors/coordinate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Cursors
@@ -129,7 +131,7 @@ module Vedeu
                    when :y then [:y, :by, :byn, :bordered_height]
                    else
                      fail Vedeu::Error::InvalidSyntax,
-                          'Coordinate type not given, cannot continue.'.freeze
+                          'Coordinate type not given, cannot continue.'
                    end
       end
 
@@ -164,7 +166,7 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|String|Symbol>]
       def defaults
         {
-          name:   ''.freeze,
+          name:   '',
           offset: nil,
           type:   :x,
         }

data/lib/vedeu/cursors/cursor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Cursors
@@ -88,7 +90,7 @@ module Vedeu
       # @return [String]
       def inspect
         "<#{self.class.name} name:'#{name}', x:#{x}, y:#{y}, ox:#{ox}, " \
-        "oy:#{oy}, visible:#{visible}>".freeze
+        "oy:#{oy}, visible:#{visible}>"
       end
 
       # Moves the cursor down by one row.
@@ -179,7 +181,7 @@ module Vedeu
       def to_s(&block)
         return escape_sequence.to_s unless block_given?
 
-        "#{position}#{yield}#{escape_sequence}".freeze
+        "#{position}#{yield}#{escape_sequence}"
       end
       alias_method :to_str, :to_s
 
@@ -198,7 +200,7 @@ module Vedeu
       def hide
         super
 
-        Vedeu.log(type: :cursor, message: "Hiding cursor: '#{name}'".freeze)
+        Vedeu.log(type: :cursor, message: "Hiding cursor: '#{name}'")
 
         render
       end
@@ -235,7 +237,7 @@ module Vedeu
       def show
         super
 
-        Vedeu.log(type: :cursor, message: "Showing cursor: '#{name}'".freeze)
+        Vedeu.log(type: :cursor, message: "Showing cursor: '#{name}'")
 
         render
       end
@@ -278,7 +280,7 @@ module Vedeu
       #   Vedeu::Cursors::Repository>]
       def defaults
         {
-          name:       ''.freeze,
+          name:       '',
           ox:         0,
           oy:         0,
           repository: Vedeu.cursors,

data/lib/vedeu/cursors/dsl.rb

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

data/lib/vedeu/cursors/move.rb

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

data/lib/vedeu/cursors/refresh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Cursors
@@ -55,7 +57,7 @@ module Vedeu
 
         Vedeu.log(type:    :cursor,
                   message: "Refreshing cursor: '#{name}' (x:#{x}, y:#{y}, " \
-                           "ox:#{ox}, oy:#{oy}, visible:#{visible})".freeze)
+                           "ox:#{ox}, oy:#{oy}, visible:#{visible})")
 
         render
       end

data/lib/vedeu/cursors/reposition.rb

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

data/lib/vedeu/cursors/repository.rb

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

data/lib/vedeu/distributed/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to control a running client application via

data/lib/vedeu/distributed/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to control a running client application via
@@ -40,7 +42,7 @@ module Vedeu
 
       rescue DRb::DRbBadURI
         Vedeu.log_stdout(message: 'Could not connect to DRb server, URI may ' \
-                                  'be bad.'.freeze)
+                                  'be bad.')
 
         :drb_bad_uri
       end
@@ -85,7 +87,7 @@ module Vedeu
         drb_connection_error
 
       rescue Interrupt
-        Vedeu.log_stdout(message: 'Client application exited.'.freeze)
+        Vedeu.log_stdout(message: 'Client application exited.')
 
       ensure
         :shutdown
@@ -106,7 +108,7 @@ module Vedeu
 
       # @return [Symbol]
       def drb_connection_error
-        Vedeu.log_stdout(message: 'Could not connect to DRb server.'.freeze)
+        Vedeu.log_stdout(message: 'Could not connect to DRb server.')
 
         :drb_connection_error
       end