vedeu 0.7.4 → 0.8.0

data/lib/vedeu/esc/borders.rb

@@ -2,7 +2,12 @@ module Vedeu
 
   module EscapeSequences
 
-    # Provides border/box related escape sequences.
+    # Provides border/box related escape sequences for semigraphic
+    # characters.
+    #
+    # # 0 1 2 3 4 5 6 7 8 9 A B C D E F
+    # 6                     ┘ ┐ ┌ └ ┼
+    # 7   ─     ├ ┤ ┴ ┬ │
     #
     # @note
     #   Refer to UTF-8 U+2500 to U+257F for border characters. More
@@ -17,47 +22,88 @@ module Vedeu
 
       extend self
 
+      # @return [String]
+      def border_off
+        "\e(B".freeze
+      end
+
       # @return [String]
       def border_on
         "\e(0".freeze
       end
 
+      # └ # \u2514
+      #
       # @return [String]
-      def border_off
-        "\e(B".freeze
+      def bottom_left
+        "\x6D".freeze
+      end
+
+      # ┘ # \u2518
+      #
+      # @return [String]
+      def bottom_right
+        "\x6A".freeze
+      end
+
+      # ─ # \u2500
+      #
+      # @return [String]
+      def horizontal
+        "\x71".freeze
+      end
+
+      # ┴ # \u2534
+      #
+      # @return [String]
+      def horizontal_bottom
+        "\x76".freeze
+      end
+
+      # ┬ # \u252C
+      #
+      # @return [String]
+      def horizontal_top
+        "\x77".freeze
+      end
+
+      # ┌ # \u250C
+      #
+      # @return [String]
+      def top_left
+        "\x6C".freeze
+      end
+
+      # ┐ # \u2510
+      #
+      # @return [String]
+      def top_right
+        "\x6B".freeze
       end
 
-      # Provides all the semigraphic characters.
+      # │ # \u2502
       #
-      # # 0 1 2 3 4 5 6 7 8 9 A B C D E F
-      # 6                     ┘ ┐ ┌ └ ┼
-      # 7   ─     ├ ┤ ┴ ┬ │
+      # @return [String]
+      def vertical
+        "\x78".freeze
+      end
+
+      # ├ # \u251C
       #
-      # @return [Hash<Symbol => String>]
-      def characters
-        {
-          bottom_right:      "\x6A".freeze, # ┘ # \u2518
-          top_right:         "\x6B".freeze, # ┐ # \u2510
-          top_left:          "\x6C".freeze, # ┌ # \u250C
-          bottom_left:       "\x6D".freeze, # └ # \u2514
-          horizontal:        "\x71".freeze, # ─ # \u2500
-          vertical_left:     "\x74".freeze, # ├ # \u251C
-          vertical_right:    "\x75".freeze, # ┤ # \u2524
-          horizontal_bottom: "\x76".freeze, # ┴ # \u2534
-          horizontal_top:    "\x77".freeze, # ┬ # \u252C
-          vertical:          "\x78".freeze, # │ # \u2502
-        }
+      # @return [String]
+      def vertical_left
+        "\x74".freeze
       end
 
-      # @return [void]
-      def setup!
-        characters.each { |key, code| define_method(key) { code } }
+      # ┤ # \u2524
+      #
+      # @return [String]
+      def vertical_right
+        "\x75".freeze
       end
 
     end # Borders
 
   end # EscapeSequences
 
-  Vedeu::EscapeSequences::Borders.setup!
-
 end # Vedeu

data/lib/vedeu/esc/colours.rb

@@ -66,42 +66,41 @@ module Vedeu
           white:         97,
         }.freeze
       end
-      alias_method :codes, :foreground_codes
 
-      # @return [void]
-      def setup!
-        define_backgrounds!
-        define_foregrounds!
+      # @param named_colour [Symbol]
+      # @return [String]
+      def background_colour(named_colour)
+        return ''.freeze unless valid_name?(named_colour)
+
+        colour(named_colour.to_s.prepend('on_').to_sym)
       end
 
-      # @return [void]
-      def define_backgrounds!
-        background_codes.each do |key, code|
-          define_method(:"on_#{key}") do |&blk|
-            "\e[#{code}m".freeze +
-              (blk ? blk.call + "\e[49m".freeze : ''.freeze)
-          end
-        end
+      # @param named_colour [Symbol]
+      # @return [String]
+      def colour(named_colour)
+        return ''.freeze unless valid_name?(named_colour)
+
+        public_send(named_colour)
       end
+      alias_method :foreground_colour, :colour
 
-      # Dynamically creates methods for each terminal named colour.
-      # When a block is given, then the colour is reset to 'default'
-      # once the block is called.
-      #
-      # @return [void]
-      def define_foregrounds!
-        foreground_codes.each do |key, code|
-          define_method(key) do |&blk|
-            "\e[#{code}m".freeze +
-              (blk ? blk.call + "\e[39m".freeze : ''.freeze)
-          end
-        end
+      # @return [Array<Symbol>]
+      def valid_codes
+        @_valid_codes ||= foreground_codes.keys.map do |name|
+          name.to_s.prepend('on_').to_sym
+        end + foreground_codes.keys
+      end
+
+      # @param named_colour [Symbol]
+      # @return [Boolean]
+      def valid_name?(named_colour)
+        return false unless named_colour.is_a?(Symbol)
+
+        valid_codes.include?(named_colour)
       end
 
     end # Colours
 
   end # EscapeSequences
 
-  Vedeu::EscapeSequences::Colours.setup!
-
 end # Vedeu

data/lib/vedeu/esc/esc.rb

@@ -9,8 +9,10 @@ module Vedeu
 
       include Vedeu::Common
       include Vedeu::EscapeSequences::Actions
+      include Vedeu::EscapeSequences::Background
       include Vedeu::EscapeSequences::Borders
       include Vedeu::EscapeSequences::Colours
+      include Vedeu::EscapeSequences::Foreground
       include Vedeu::EscapeSequences::Mouse
       extend self
 
@@ -70,8 +72,6 @@ module Vedeu
         "#{last_character_position}\n".freeze
       end
 
-      private
-
       # @return [String]
       def clear_line
         "#{colour_reset}\e[2K".freeze
@@ -84,7 +84,7 @@ module Vedeu
 
       # @return [String]
       def disable_mouse
-        if Vedeu::Configuration.mouse == true
+        if truthy?(Vedeu::Configuration.mouse)
           "#{mouse_x10_off}".freeze
 
         else
@@ -95,7 +95,7 @@ module Vedeu
 
       # @return [String]
       def enable_mouse
-        if Vedeu::Configuration.mouse == true
+        if truthy?(Vedeu::Configuration.mouse)
           "#{mouse_x10_on}".freeze
 
         else

data/lib/vedeu/esc/foreground.rb

@@ -0,0 +1,219 @@
+module Vedeu
+
+  module EscapeSequences
+
+    # Provides foreground colour related escape sequences.
+    #
+    module Foreground
+
+      extend self
+
+      # @param block [Proc]
+      # @return [String]
+      def black(&block)
+        if block_given?
+          "\e[30m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[30m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def red(&block)
+        if block_given?
+          "\e[31m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[31m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def green(&block)
+        if block_given?
+          "\e[32m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[32m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def yellow(&block)
+        if block_given?
+          "\e[33m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[33m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def blue(&block)
+        if block_given?
+          "\e[34m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[34m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def magenta(&block)
+        if block_given?
+          "\e[35m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[35m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def cyan(&block)
+        if block_given?
+          "\e[36m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[36m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_grey(&block)
+        if block_given?
+          "\e[37m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[37m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def default(&block)
+        if block_given?
+          "\e[39m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[39m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def dark_grey(&block)
+        if block_given?
+          "\e[90m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[90m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_red(&block)
+        if block_given?
+          "\e[91m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[91m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_green(&block)
+        if block_given?
+          "\e[92m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[92m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_yellow(&block)
+        if block_given?
+          "\e[93m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[93m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_blue(&block)
+        if block_given?
+          "\e[94m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[94m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_magenta(&block)
+        if block_given?
+          "\e[95m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[95m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def light_cyan(&block)
+        if block_given?
+          "\e[96m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[96m".freeze
+
+        end
+      end
+
+      # @param block [Proc]
+      # @return [String]
+      def white(&block)
+        if block_given?
+          "\e[97m".freeze + yield + "\e[39m".freeze
+
+        else
+          "\e[97m".freeze
+
+        end
+      end
+
+    end # Foreground
+
+  end # EscapeSequences
+
+end # Vedeu