vedeu 0.8.0 → 0.8.1

data/lib/vedeu/editor/cropper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Editor
@@ -45,7 +47,7 @@ module Vedeu
           line.chars.each_with_index do |char, ix|
             out << Vedeu::Views::Char.new(name:     name,
                                           position: [(by + iy), (bx + ix)],
-                                          value:    char.freeze)
+                                          value:    char)
           end
         end
 

data/lib/vedeu/editor/cursor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Editor
@@ -129,7 +131,7 @@ module Vedeu
       #
       # @return [String]
       def to_s
-        "\e[#{real_y};#{real_x}H\e[?25h".freeze
+        "\e[#{real_y};#{real_x}H\e[?25h"
       end
       alias_method :to_str, :to_s
 
@@ -175,7 +177,7 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|NilClass|String|Symbol>]
       def defaults
         {
-          name: ''.freeze,
+          name: '',
           ox:   0,
           oy:   0,
           x:    0,

data/lib/vedeu/editor/delete.rb

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

data/lib/vedeu/editor/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Editor
@@ -36,7 +38,7 @@ module Vedeu
       #
       # @return [String]
       def execute
-        command = lines.map(&:to_s).join("\n".freeze)
+        command = lines.map(&:to_s).join("\n")
 
         reset!
 

data/lib/vedeu/editor/editor.rb

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

data/lib/vedeu/editor/insert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Editor
@@ -18,7 +20,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Editor::Insert.
       #
-      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @param collection [String|Vedeu::Editor::Line|Vedeu::Editor::Lines]
       # @param entity [String]
       # @param index [Fixnum]
       # @param size [Fixnum]
@@ -30,7 +32,7 @@ module Vedeu
         @size       = size
       end
 
-      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @return [String|Vedeu::Editor::Line|Vedeu::Editor::Lines]
       def insert
         return collection.insert(position, entity) if index?
 
@@ -39,10 +41,6 @@ module Vedeu
 
       protected
 
-      # @!attribute [r] collection
-      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
-      attr_reader :collection
-
       # @!attribute [r] entity
       # @return [String]
       attr_reader :entity
@@ -57,6 +55,18 @@ module Vedeu
 
       private
 
+      # @!attribute [r] collection
+      # @return [String|Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      def collection
+        if string?(@collection)
+          @collection.dup
+
+        else
+          @collection
+
+        end
+      end
+
       # @return [Boolean]
       def index?
         numeric?(index)

data/lib/vedeu/editor/item.rb

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

data/lib/vedeu/editor/line.rb

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

data/lib/vedeu/editor/lines.rb

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

data/lib/vedeu/editor/repository.rb

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

data/lib/vedeu/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Custom exceptions/errors which Vedeu will raise in certain
@@ -92,13 +94,16 @@ module Vedeu
       #
       # @return [String]
       def message
-        'Valid value is between 1 and 12 inclusive.'.freeze
+        'Valid value is between 1 and 12 inclusive.'
       end
 
     end # OutOfRange
 
-    # Raised when a method expecting a block to be given was not given
-    # the block.
+    # Raised when a method requiring a block was not given the block.
+    #
+    # @!macro [new] raise_requires_block
+    #    @raise [Vedeu::Error::RequiresBlock] When the required block
+    #      was not given.
     #
     class RequiresBlock < StandardError
 
@@ -106,7 +111,7 @@ module Vedeu
       #
       # @return [String]
       def message
-        'The required block was not given.'.freeze
+        'The required block was not given.'
       end
 
     end

data/lib/vedeu/esc/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module EscapeSequences
@@ -10,77 +12,77 @@ module Vedeu
 
       # @return [String]
       def bg_reset
-        "\e[49m".freeze
+        "\e[49m"
       end
 
       # @return [String]
       def blink
-        "\e[5m".freeze
+        "\e[5m"
       end
 
       # @return [String]
       def blink_off
-        "\e[25m".freeze
+        "\e[25m"
       end
 
       # @return [String]
       def bold
-        "\e[1m".freeze
+        "\e[1m"
       end
 
       # @return [String]
       def bold_off
-        "\e[22m".freeze
+        "\e[22m"
       end
 
       # @return [String]
       def cursor_position
-        "\e[6n".freeze
+        "\e[6n"
       end
 
       # @return [String]
       def dim
-        "\e[2m".freeze
+        "\e[2m"
       end
 
       # @return [String]
       def fg_reset
-        "\e[39m".freeze
+        "\e[39m"
       end
 
       # @return [String]
       def hide_cursor
-        "\e[?25l".freeze
+        "\e[?25l"
       end
 
       # @return [String]
       def negative
-        "\e[7m".freeze
+        "\e[7m"
       end
 
       # @return [String]
       def positive
-        "\e[27m".freeze
+        "\e[27m"
       end
 
       # @return [String]
       def reset
-        "\e[0m".freeze
+        "\e[0m"
       end
 
       # @return [String]
       def show_cursor
-        "\e[?25h".freeze
+        "\e[?25h"
       end
 
       # @return [String]
       def underline
-        "\e[4m".freeze
+        "\e[4m"
       end
 
       # @return [String]
       def underline_off
-        "\e[24m".freeze
+        "\e[24m"
       end
 
     end # Actions

data/lib/vedeu/esc/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides escape sequence strings.

data/lib/vedeu/esc/background.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module EscapeSequences
@@ -12,10 +14,10 @@ module Vedeu
       # @return [String]
       def on_black(&block)
         if block_given?
-          "\e[40m".freeze + yield + "\e[49m".freeze
+          "\e[40m" + yield + "\e[49m"
 
         else
-          "\e[40m".freeze
+          "\e[40m"
 
         end
       end
@@ -24,10 +26,10 @@ module Vedeu
       # @return [String]
       def on_red(&block)
         if block_given?
-          "\e[41m".freeze + yield + "\e[49m".freeze
+          "\e[41m" + yield + "\e[49m"
 
         else
-          "\e[41m".freeze
+          "\e[41m"
 
         end
       end
@@ -36,10 +38,10 @@ module Vedeu
       # @return [String]
       def on_green(&block)
         if block_given?
-          "\e[42m".freeze + yield + "\e[49m".freeze
+          "\e[42m" + yield + "\e[49m"
 
         else
-          "\e[42m".freeze
+          "\e[42m"
 
         end
       end
@@ -48,10 +50,10 @@ module Vedeu
       # @return [String]
       def on_yellow(&block)
         if block_given?
-          "\e[43m".freeze + yield + "\e[49m".freeze
+          "\e[43m" + yield + "\e[49m"
 
         else
-          "\e[43m".freeze
+          "\e[43m"
 
         end
       end
@@ -60,10 +62,10 @@ module Vedeu
       # @return [String]
       def on_blue(&block)
         if block_given?
-          "\e[44m".freeze + yield + "\e[49m".freeze
+          "\e[44m" + yield + "\e[49m"
 
         else
-          "\e[44m".freeze
+          "\e[44m"
 
         end
       end
@@ -72,10 +74,10 @@ module Vedeu
       # @return [String]
       def on_magenta(&block)
         if block_given?
-          "\e[45m".freeze + yield + "\e[49m".freeze
+          "\e[45m" + yield + "\e[49m"
 
         else
-          "\e[45m".freeze
+          "\e[45m"
 
         end
       end
@@ -84,10 +86,10 @@ module Vedeu
       # @return [String]
       def on_cyan(&block)
         if block_given?
-          "\e[46m".freeze + yield + "\e[49m".freeze
+          "\e[46m" + yield + "\e[49m"
 
         else
-          "\e[46m".freeze
+          "\e[46m"
 
         end
       end
@@ -96,10 +98,10 @@ module Vedeu
       # @return [String]
       def on_light_grey(&block)
         if block_given?
-          "\e[47m".freeze + yield + "\e[49m".freeze
+          "\e[47m" + yield + "\e[49m"
 
         else
-          "\e[47m".freeze
+          "\e[47m"
 
         end
       end
@@ -108,10 +110,10 @@ module Vedeu
       # @return [String]
       def on_default(&block)
         if block_given?
-          "\e[49m".freeze + yield + "\e[49m".freeze
+          "\e[49m" + yield + "\e[49m"
 
         else
-          "\e[49m".freeze
+          "\e[49m"
 
         end
       end
@@ -120,10 +122,10 @@ module Vedeu
       # @return [String]
       def on_dark_grey(&block)
         if block_given?
-          "\e[100m".freeze + yield + "\e[49m".freeze
+          "\e[100m" + yield + "\e[49m"
 
         else
-          "\e[100m".freeze
+          "\e[100m"
 
         end
       end
@@ -132,10 +134,10 @@ module Vedeu
       # @return [String]
       def on_light_red(&block)
         if block_given?
-          "\e[101m".freeze + yield + "\e[49m".freeze
+          "\e[101m" + yield + "\e[49m"
 
         else
-          "\e[101m".freeze
+          "\e[101m"
 
         end
       end
@@ -144,10 +146,10 @@ module Vedeu
       # @return [String]
       def on_light_green(&block)
         if block_given?
-          "\e[102m".freeze + yield + "\e[49m".freeze
+          "\e[102m" + yield + "\e[49m"
 
         else
-          "\e[102m".freeze
+          "\e[102m"
 
         end
       end
@@ -156,10 +158,10 @@ module Vedeu
       # @return [String]
       def on_light_yellow(&block)
         if block_given?
-          "\e[103m".freeze + yield + "\e[49m".freeze
+          "\e[103m" + yield + "\e[49m"
 
         else
-          "\e[103m".freeze
+          "\e[103m"
 
         end
       end
@@ -168,10 +170,10 @@ module Vedeu
       # @return [String]
       def on_light_blue(&block)
         if block_given?
-          "\e[104m".freeze + yield + "\e[49m".freeze
+          "\e[104m" + yield + "\e[49m"
 
         else
-          "\e[104m".freeze
+          "\e[104m"
 
         end
       end
@@ -180,10 +182,10 @@ module Vedeu
       # @return [String]
       def on_light_magenta(&block)
         if block_given?
-          "\e[105m".freeze + yield + "\e[49m".freeze
+          "\e[105m" + yield + "\e[49m"
 
         else
-          "\e[105m".freeze
+          "\e[105m"
 
         end
       end
@@ -192,10 +194,10 @@ module Vedeu
       # @return [String]
       def on_light_cyan(&block)
         if block_given?
-          "\e[106m".freeze + yield + "\e[49m".freeze
+          "\e[106m" + yield + "\e[49m"
 
         else
-          "\e[106m".freeze
+          "\e[106m"
 
         end
       end
@@ -204,10 +206,10 @@ module Vedeu
       # @return [String]
       def on_white(&block)
         if block_given?
-          "\e[107m".freeze + yield + "\e[49m".freeze
+          "\e[107m" + yield + "\e[49m"
 
         else
-          "\e[107m".freeze
+          "\e[107m"
 
         end
       end