vedeu 0.8.22 → 0.8.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 317fd304eff7309a776c7520081310f4098f8d63
-  data.tar.gz: 7cb42ff7dbc8b4945d5951cfff3a4030829b0ffc
+  metadata.gz: 23c1d81d7fc643062c5bfe739de370ff0e5dc948
+  data.tar.gz: 4083354c5c95d5828d7108d1f1870ddbf934f38c
 SHA512:
-  metadata.gz: 7e4b571d22b599bcd5c977684c3e75862d5faaf740de1fe56db3588f64ba29b7a4873da43f02d7d169b8a9471f6ef505842eb62e6a243ee5ce5b5db2412ae5e1
-  data.tar.gz: cdc5fbb14ae664528bd42214fd9e80c13418a20851b1a4aefc03937e67fa509275ea5c6c0f8559d931bc5c58cebd54ee567f10f35716002dba17f6ca3492d549
+  metadata.gz: 31993a416e19b815f8d471d0a23364918c07d070ae9823c17316393b1523f6a2a4780eff35ea05bef6c6ab1a82d61f7b2eabadcba074407874102a0dd574f416
+  data.tar.gz: b9b5bed7178bac6915911f7d4c0b19081a1c5c8094622d4d1e25e10dcbeab4c28b129188bed49487e03c20c1b1b108125d3bd2ca415a9e6533774366e94fd858

data/.rubocop.yml

@@ -62,6 +62,9 @@ Style/ExtraSpacing:
 #     - special_inside_parentheses
 #     - consistent
 
+Style/MultilineBlockChain:
+  Enabled: false
+
 Style/MultilineOperationIndentation:
   Enabled: false
 

data/integrations/test_runner.rb

@@ -16,15 +16,17 @@ class TestRunner
   # @return [TestRunner]
   def initialize(testcase, filename)
     @testcase = testcase
-    @filename     = filename
+    @filename = filename
   end
 
   # @return [void]
   def result
     print "\e[36m#{filename}: "
+
     if expected == actual
       print "\e[32mPassed.\e[39m\n"
       exit 0;
+
     else
       print "\e[31mFailed.\e[39m\n"
       puts "\e[33mExpected:\e[39m"
@@ -32,6 +34,7 @@ class TestRunner
       puts "\e[34mActual:\e[39m"
       puts actual.inspect
       exit 1;
+
     end
   end
 

data/lib/vedeu/buffers/empty.rb

@@ -57,7 +57,7 @@ module Vedeu
       def empty
         Array.new(height) do |h|
           Array.new(width) do |w|
-            Vedeu::Cells::Empty.new(name: name, position: [(y + h), (x + w)])
+            Vedeu::Cells::Empty.new(name: name)
           end
         end
       end

data/lib/vedeu/cells/borders/corner.rb

@@ -10,7 +10,7 @@ module Vedeu
     #
     class Corner < Vedeu::Cells::Border
 
-      # @return [Vedeu::Geometries::Position]
+      # @return [NilClass|Vedeu::Geometries::Position]
       def position
         @position = defaults[:position]
       end

data/lib/vedeu/cells/empty.rb

@@ -88,6 +88,11 @@ module Vedeu
         :empty
       end
 
+      # @return [Boolean]
+      def value?
+        present?(value)
+      end
+
       private
 
       # @macro defaults_method

data/lib/vedeu/configuration/api.rb

@@ -36,6 +36,52 @@ module Vedeu
         instance_eval(&block) if block_given?
       end
 
+      # {include:file:docs/configuration/background.md}
+      # @param value [String]
+      # @return [Vedeu::Colours::Background]
+      def background(value = nil)
+        return options[:background] unless value
+
+        options[:background] = value
+      end
+
+      # {include:file:docs/configuration/base_path.md}
+      # @param path [String]
+      # @return [String]
+      def base_path(path = nil)
+        options[:base_path] = path
+      end
+
+      # {include:file:docs/configuration/colour.md}
+      # @param attrs [Hash<Symbol => String>]
+      # @return [Hash<Symbol => void>]
+      def colour(attrs = {})
+        options[:background] = attrs[:background] if attrs.key?(:background)
+        options[:foreground] = attrs[:foreground] if attrs.key?(:foreground)
+        options
+      end
+
+      # {include:file:docs/configuration/colour_mode.md}
+      # @param value [Fixnum]
+      # @macro raise_invalid_syntax
+      # @return [Boolean]
+      def colour_mode(value = nil)
+        unless valid_colour_mode?(value)
+          raise Vedeu::Error::InvalidSyntax,
+                '`colour_mode` must be `8`, `16`, `256`, `16777216`.'
+        end
+
+        options[:colour_mode] = value
+      end
+
+      # {include:file:docs/configuration/compression.md}
+      # @param value [Boolean]
+      # @return [Boolean]
+      def compression(value = true)
+        options[:compression] = value
+      end
+      alias compression! compression
+
       # Returns the configuration options set up by the API DSL.
       #
       # @return [Hash<Symbol => Boolean, Fixnum, String>]
@@ -58,29 +104,20 @@ module Vedeu
         options
       end
 
-      # {include:file:docs/configuration/interactive.md}
-      # @param value [Boolean]
-      # @return [Boolean]
-      def interactive!(value = true)
-        options[:interactive] = value
-      end
-      alias interactive interactive!
-
-      # {include:file:docs/configuration/standalone.md}
-      # @param value [Boolean]
+      # {include:file:docs/configuration/cooked.md}
       # @return [Boolean]
-      def standalone!(value = true)
-        options[:interactive] = !value
+      def cooked!
+        options[:terminal_mode] = :cooked
       end
-      alias standalone standalone!
+      alias cooked cooked!
 
-      # {include:file:docs/configuration/run_once.md}
+      # {include:file:docs/configuration/debug.md}
       # @param value [Boolean]
       # @return [Boolean]
-      def run_once!(value = true)
-        options[:once] = value
+      def debug!(value = true)
+        options[:debug] = value
       end
-      alias run_once run_once!
+      alias debug debug!
 
       # {include:file:docs/configuration/drb.md}
       # @param value [Boolean]
@@ -90,6 +127,13 @@ module Vedeu
       end
       alias drb drb!
 
+      # {include:file:docs/configuration/drb_height.md}
+      # @param height [Fixnum]
+      # @return [Fixnum]
+      def drb_height(height = 25)
+        options[:drb_height] = height
+      end
+
       # {include:file:docs/configuration/drb_host.md}
       # @param hostname [String]
       # @return [String]
@@ -104,13 +148,6 @@ module Vedeu
         options[:drb_port] = port
       end
 
-      # {include:file:docs/configuration/drb_height.md}
-      # @param height [Fixnum]
-      # @return [Fixnum]
-      def drb_height(height = 25)
-        options[:drb_height] = height
-      end
-
       # {include:file:docs/configuration/drb_width.md}
       # @param width [Fixnum]
       # @return [Fixnum]
@@ -118,13 +155,6 @@ module Vedeu
         options[:drb_width] = width
       end
 
-      # {include:file:docs/configuration/cooked.md}
-      # @return [Boolean]
-      def cooked!
-        options[:terminal_mode] = :cooked
-      end
-      alias cooked cooked!
-
       # {include:file:docs/configuration/fake.md}
       # @return [Boolean]
       def fake!
@@ -132,32 +162,13 @@ module Vedeu
       end
       alias fake fake!
 
-      # {include:file:docs/configuration/raw.md}
-      # @return [Boolean]
-      def raw!
-        options[:terminal_mode] = :raw
-      end
-      alias raw raw!
-
-      # {include:file:docs/configuration/debug.md}
-      # @param value [Boolean]
-      # @return [Boolean]
-      def debug!(value = true)
-        options[:debug] = value
-      end
-      alias debug debug!
-
-      # {include:file:docs/configuration/colour_mode.md}
-      # @param value [Fixnum]
-      # @macro raise_invalid_syntax
-      # @return [Boolean]
-      def colour_mode(value = nil)
-        unless valid_colour_mode?(value)
-          raise Vedeu::Error::InvalidSyntax,
-                '`colour_mode` must be `8`, `16`, `256`, `16777216`.'
-        end
+      # {include:file:docs/configuration/foreground.md}
+      # @param value [String]
+      # @return [Vedeu::Colours::Foreground]
+      def foreground(value = nil)
+        return options[:foreground] unless value
 
-        options[:colour_mode] = value
+        options[:foreground] = value
       end
 
       # {include:file:docs/configuration/height.md}
@@ -168,6 +179,14 @@ module Vedeu
       end
       alias height= height
 
+      # {include:file:docs/configuration/interactive.md}
+      # @param value [Boolean]
+      # @return [Boolean]
+      def interactive!(value = true)
+        options[:interactive] = value
+      end
+      alias interactive interactive!
+
       # {include:file:docs/configuration/log.md}
       # @param filename_or_false [FalseClass|String]
       # @return [NilClass|String]
@@ -199,6 +218,14 @@ module Vedeu
         options[:log_only] = types.flatten
       end
 
+      # {include:file:docs/configuration/mouse.md}
+      # @param value [Boolean]
+      # @return [Boolean]
+      def mouse!(value = true)
+        options[:mouse] = value
+      end
+      alias mouse mouse!
+
       # {include:file:docs/configuration/profile.md}
       # @param value [Boolean]
       # @return [Boolean]
@@ -207,6 +234,13 @@ module Vedeu
       end
       alias profile profile!
 
+      # {include:file:docs/configuration/raw.md}
+      # @return [Boolean]
+      def raw!
+        options[:terminal_mode] = :raw
+      end
+      alias raw raw!
+
       # {include:file:docs/configuration/renderer.md}
       # @param renderer [Array<Class>|Class]
       # @return [Array<Class>]
@@ -215,13 +249,6 @@ module Vedeu
       end
       alias renderers renderer
 
-      # {include:file:docs/configuration/base_path.md}
-      # @param path [String]
-      # @return [String]
-      def base_path(path = nil)
-        options[:base_path] = path
-      end
-
       # {include:file:docs/configuration/root.md}
       # @param args [Array<Symbol|void>]
       # @return [Class]
@@ -229,6 +256,22 @@ module Vedeu
         options[:root] = args
       end
 
+      # {include:file:docs/configuration/run_once.md}
+      # @param value [Boolean]
+      # @return [Boolean]
+      def run_once!(value = true)
+        options[:once] = value
+      end
+      alias run_once run_once!
+
+      # {include:file:docs/configuration/standalone.md}
+      # @param value [Boolean]
+      # @return [Boolean]
+      def standalone!(value = true)
+        options[:interactive] = !value
+      end
+      alias standalone standalone!
+
       # {include:file:docs/configuration/stdin.md}
       # @param io [File|IO]
       # @return [File|IO]
@@ -250,14 +293,6 @@ module Vedeu
         options[:stderr] = io
       end
 
-      # {include:file:docs/configuration/compression.md}
-      # @param value [Boolean]
-      # @return [Boolean]
-      def compression(value = true)
-        options[:compression] = value
-      end
-      alias compression! compression
-
       # {include:file:docs/configuration/terminal_mode.md}
       # @param mode [Symbol] Either ':cooked', ':fake' or ':raw'.
       # @macro raise_invalid_syntax
@@ -288,41 +323,6 @@ module Vedeu
       end
       alias width= width
 
-      # {include:file:docs/configuration/background.md}
-      # @param value [String]
-      # @return [Vedeu::Colours::Background]
-      def background(value = nil)
-        return options[:background] unless value
-
-        options[:background] = value
-      end
-
-      # {include:file:docs/configuration/foreground.md}
-      # @param value [String]
-      # @return [Vedeu::Colours::Foreground]
-      def foreground(value = nil)
-        return options[:foreground] unless value
-
-        options[:foreground] = value
-      end
-
-      # {include:file:docs/configuration/colour.md}
-      # @param attrs [Hash<Symbol => String>]
-      # @return [Hash<Symbol => void>]
-      def colour(attrs = {})
-        options[:background] = attrs[:background] if attrs.key?(:background)
-        options[:foreground] = attrs[:foreground] if attrs.key?(:foreground)
-        options
-      end
-
-      # {include:file:docs/configuration/mouse.md}
-      # @param value [Boolean]
-      # @return [Boolean]
-      def mouse!(value = true)
-        options[:mouse] = value
-      end
-      alias mouse mouse!
-
       protected
 
       # @!attribute [r] default

data/lib/vedeu/editor/cropper.rb

@@ -76,14 +76,15 @@ module Vedeu
 
       private
 
-      # Returns the visible lines.
+      # Returns the visible lines and their respective content,
+      # determined by the offsets 'ox' and 'oy'.
       #
       # @note If there are no lines of content, we return an empty
       # array. If there are any empty lines, then they are discarded.
       #
       # @return [Array<void>]
       def visible
-        lines.map { |line| columns(line) }
+        lines.map { |line| line[ox...(ox + bordered_width)] || '' }
       end
 
       # Return a range of visible lines.
@@ -93,13 +94,6 @@ module Vedeu
         @lines[oy...(oy + bordered_height)] || []
       end
 
-      # Return a range of visible characters from each line.
-      #
-      # @return [String]
-      def columns(line)
-        line[ox...(ox + bordered_width)] || ''
-      end
-
       # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)

data/lib/vedeu/editor/cursor.rb

@@ -43,7 +43,7 @@ module Vedeu
       #
       # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
       # @option attributes y [Fixnum] The current line.
-      # @option attributes x [Fixnum] The current character with the
+      # @option attributes x [Fixnum] The current character within the
       #   line.
       # @option attributes name [String|Symbol]
       # @option attributes oy [Fixnum]
@@ -67,7 +67,9 @@ module Vedeu
 
       # Move the virtual cursor down by one line.
       #
-      # @param size [Fixnum]
+      # @param size [Fixnum] The number of characters on the next
+      #   line. The cursor is placed at the end of this next line if
+      #   the x coordinate is greater than the next line length.
       # @return [Vedeu::Editor::Cursor]
       def down(size = nil)
         @y += 1
@@ -93,7 +95,7 @@ module Vedeu
       # @return [Vedeu::Editor::Cursor]
       # @todo Should ox/oy be 0; or set to @ox/@oy? (GL: 2015-10-02)
       def refresh
-        Vedeu::Cursors::Cursor.store(refresh_attributes)
+        Vedeu::Cursors::Cursor.store(new_attributes)
 
         Vedeu.trigger(:_refresh_cursor_, name)
 
@@ -132,7 +134,9 @@ module Vedeu
 
       # Move the virtual cursor up by one line.
       #
-      # @param size [Fixnum]
+      # @param size [Fixnum] The number of characters on the next
+      #   line. The cursor is placed at the end of this next line if
+      #   the x coordinate is greater than the next line length.
       # @return [Vedeu::Editor::Cursor]
       def up(size = nil)
         @oy -= 1 unless @oy == 0
@@ -191,14 +195,14 @@ module Vedeu
       end
 
       # @return [Hash<Symbol => Fixnum, String, Symbol>]
-      def refresh_attributes
+      def new_attributes
         {
           name:    name,
           x:       real_x,
           y:       real_y,
           ox:      0,
           oy:      0,
-          visible: true
+          visible: true,
         }
       end
 

data/lib/vedeu/output/compressors/character.rb

@@ -27,26 +27,22 @@ module Vedeu
           @style   = ''
         end
 
+        # Process the content as a stream; for each sequence with the
+        # same position take the first sequence and ignore the rest.
+        #
         # @return [String]
         def with
           @same = ''
           @compress ||= Vedeu.timer(message) do
             content.map do |cell|
-              rendered = [
-                cell.position.to_s,
+              character = [
+                position_for(cell),
                 colour_for(cell),
                 style_for(cell),
-                cell.value,
+                value_for(cell),
               ].join
 
-              if @same == rendered
-                next
-
-              else
-                @same = rendered
-                @same
-
-              end
+              character == @same ? next : @same = character
             end.join.tap do |out|
               Vedeu.log(type:    :compress,
                         message: "#{message} -> #{out.size} characters")
@@ -85,6 +81,14 @@ module Vedeu
           content.size
         end
 
+        # @param char [Vedeu::Cells::Char]
+        # @return [String]
+        def position_for(char)
+          return '' unless char.position?
+
+          char.position.to_s
+        end
+
         # Compress by not repeatedly sending the same style(s) for each
         # character which has the same style(s) as the last character
         # output.
@@ -98,6 +102,14 @@ module Vedeu
           @style.to_s
         end
 
+        # @param char [Vedeu::Cells::Char]
+        # @return [String]
+        def value_for(char)
+          return '' unless char.value?
+
+          char.value
+        end
+
       end # Character
 
     end # Compressors

data/lib/vedeu/output/write.rb

@@ -46,7 +46,7 @@ module Vedeu
         nil
       end
 
-      # @return [Vedeu::Geometries::Position]
+      # @return [NilClass|Vedeu::Geometries::Position]
       def position(pos = position_start)
         Vedeu::Geometries::Position.coerce(pos)
       end

data/lib/vedeu/presentation/position.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       # Gets the position.
       #
-      # @return [Vedeu::Geometries::Position]
+      # @return [NilClass|Vedeu::Geometries::Position]
       def position
         Vedeu::Geometries::Position.coerce(@position)
       end
@@ -21,7 +21,7 @@ module Vedeu
       #
       # @param value [Array<void>|Hash<void>|
       #   Vedeu::Geometries::Position]
-      # @return [Vedeu::Geometries::Position]
+      # @return [NilClass|Vedeu::Geometries::Position]
       def position=(value)
         @position = Vedeu::Geometries::Position.coerce(value)
       end

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/buffers/empty_test.rb

@@ -92,7 +92,6 @@ module Vedeu
 
         it { subject.size.must_equal(height + 1) }
         it { subject.first.size.must_equal(width + 1) }
-        it { subject.first.first.position.must_equal(position) }
       end
 
       describe '#height' do

data/test/lib/vedeu/cells/empty_test.rb

@@ -35,10 +35,6 @@ module Vedeu
         it { instance.must_respond_to(:name) }
       end
 
-      describe '#value' do
-        it { instance.must_respond_to(:value) }
-      end
-
       describe '#eql?' do
         let(:other) { instance }
 
@@ -188,6 +184,24 @@ module Vedeu
         it { subject.must_equal(:empty) }
       end
 
+      describe '#value' do
+        it { instance.must_respond_to(:value) }
+      end
+
+      describe '#value?' do
+        subject { instance.value? }
+
+        context 'when a value exists' do
+          let(:_value) { "\e[0m" }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when a value does not exist' do
+          it { subject.must_equal(false) }
+        end
+      end
+
     end # Empty
 
   end # Cells

data/vedeu.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest',           '5.8.4'
   spec.add_development_dependency 'minitest-reporters', '1.1.8'
   spec.add_development_dependency 'mocha',              '1.1.0'
-  spec.add_development_dependency 'rubocop',            '0.38.0'
+  spec.add_development_dependency 'rubocop',            '0.39.0'
   spec.add_development_dependency 'simplecov',          '0.11.2'
   spec.add_development_dependency 'simplecov-console',  '0.3.0'
   spec.add_development_dependency 'yard',               '0.8.7.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.8.22
+  version: 0.8.23
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-27 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.38.0
+        version: 0.39.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement