vedeu 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9a714b2238fa3c5bbdeeccef8713918b40f4f5
-  data.tar.gz: 2f3dd1b000581dacd7f007347333fc5bc6028701
+  metadata.gz: 12ee9a34dc28d9a2230a6e1acb69e62e8da7cd20
+  data.tar.gz: 27b92a31c6f1585f4f84e6d1de7469569e5ddfa9
 SHA512:
-  metadata.gz: e823c499c813c68bf11108eaf1c96de24ec984aff02afa56d240ca00fae273698b51d08b04c9fd85f730a78f9b7e713459b70cecd7316d6affa8e183fd669efb
-  data.tar.gz: 2b92ab94bf23c05680545fdb6e3a2beccda9484809a82b416ef04354e74d6f13113e031c1077ba7c716407c5c1485717a7a0955192890e00152f508ce04134c8
+  metadata.gz: e24f06eb598a6776473d4f1a7364be6eca6e9c1660260093643a3a752ccd4765c66a1c9f429db439f5de99bafe2bdc64df3173bc38549e34d5df91029778f68b
+  data.tar.gz: abb7551af78cb1c8339cd678a33e0e590a74b057cf32c9f256bc77980a6b1f2b05da31fc563b86a3e79775ab6a267eb4c3ae7817669797ee072146dc18b8b890

data/docs/configuration.md

@@ -66,6 +66,12 @@ reason, simply ask for it:
 ### log_only
 {include:Vedeu::Config::API#log_only}
 
+### log_except
+{include:Vedeu::Config::API#log_except}
+
+### loggable?
+{include:Vedeu::Configuration.loggable?}
+
 ### profile / profile!
 {include:Vedeu::Config::API#profile}
 

data/docs/debugging.md

@@ -8,9 +8,7 @@ and hopefully be dropped into a Pry debuggging session:
 
     Vedeu::Terminal.cooked_mode!
     Vedeu::Terminal.open do
-      mouse_off   = Vedeu::EscapeSequences::Esc.mouse_x10_off
-      show_cursor = Vedeu::EscapeSequences::Esc.show_cursor
-      Vedeu::Terminal.output(mouse_off + show_cursor)
+      Vedeu::Terminal.debugging!
 
       require 'pry'
       binding.pry

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

@@ -13,6 +13,11 @@ module Vedeu
         @position = defaults[:position]
       end
 
+      # @return [String]
+      def text
+        '+'
+      end
+
     end # Corner
 
   end # Cells

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

@@ -9,6 +9,11 @@ module Vedeu
     #
     class Horizontal < Vedeu::Cells::Border
 
+      # @return [String]
+      def text
+        '-'
+      end
+
       # @return [Symbol]
       def type
         :horizontal

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

@@ -9,6 +9,11 @@ module Vedeu
     #
     class Vertical < Vedeu::Cells::Border
 
+      # @return [String]
+      def text
+        '|'
+      end
+
       # @return [Symbol]
       def type
         :vertical

data/lib/vedeu/cells/char.rb

@@ -17,6 +17,11 @@ module Vedeu
         false
       end
 
+      # @return [String]
+      def text
+        @value || ' '
+      end
+
     end # Char
 
   end # Cells

data/lib/vedeu/cells/clear.rb

@@ -21,6 +21,7 @@ module Vedeu
       def value
         ' '.freeze
       end
+      alias_method :text, :value
 
     end # Clear
 

data/lib/vedeu/cells/empty.rb

@@ -43,6 +43,11 @@ module Vedeu
       end
       alias_method :==, :eql?
 
+      # @return [String]
+      def text
+        ' '
+      end
+
       # @return [Hash]
       def to_hash
         {

data/lib/vedeu/configuration/api.rb

@@ -303,6 +303,26 @@ module Vedeu
         options[:log] = filename
       end
 
+      # Log specific message types except those given. A complete list
+      # of message types can be found at
+      # {Vedeu::Logging::Log.message_types}.
+      #
+      #   Vedeu.configure do
+      #     log_except :debug, :event
+      #
+      #     # or
+      #     log_except [:debug, :info]
+      #
+      #     # ...
+      #   end
+      #
+      # @param types [Array<Symbol>] The message types which should
+      #   not be logged.
+      # @return [Array<Symbol>]
+      def log_except(*types)
+        options[:log_except] = types.flatten
+      end
+
       # Only log specific message types. A complete list of message
       # types can be found at {Vedeu::Logging::Log.message_types}.
       #

data/lib/vedeu/configuration/configuration.rb

@@ -170,11 +170,27 @@ module Vedeu
         log != nil
       end
 
+      # @return [Array<Symbol>]
+      def log_except
+        instance.options[:log_except] || []
+      end
+
       # @return [Array<Symbol>]
       def log_only
         instance.options[:log_only] || []
       end
 
+      # Returns true if the given type was included in the :log_only
+      # configuration option or not included in the :log_except
+      # option.
+      #
+      # @param type [Symbol]
+      # @return [Boolean]
+      def loggable?(type)
+        Vedeu::Configuration.log_only.include?(type) ||
+        !Vedeu::Configuration.log_except.include?(type)
+      end
+
       # Returns whether mouse support was enabled or disabled.
       #
       # @return [Boolean]
@@ -323,6 +339,7 @@ module Vedeu
         height:        nil,
         interactive:   true,
         log:           nil,
+        log_except:    [],
         log_only:      [],
         mouse:         true,
         once:          false,

data/lib/vedeu/cursors/cursor.rb

@@ -197,7 +197,7 @@ module Vedeu
       def hide
         super
 
-        Vedeu.log(type: :output, message: "Hiding cursor: '#{name}'".freeze)
+        Vedeu.log(type: :cursor, message: "Hiding cursor: '#{name}'".freeze)
 
         render
       end
@@ -234,7 +234,7 @@ module Vedeu
       def show
         super
 
-        Vedeu.log(type: :output, message: "Showing cursor: '#{name}'".freeze)
+        Vedeu.log(type: :cursor, message: "Showing cursor: '#{name}'".freeze)
 
         render
       end

data/lib/vedeu/cursors/refresh.rb

@@ -53,7 +53,7 @@ module Vedeu
       def by_name
         refresh_view if refresh_view?
 
-        Vedeu.log(type:    :output,
+        Vedeu.log(type:    :cursor,
                   message: "Refreshing cursor: '#{name}' (x:#{x}, y:#{y}, " \
                            "ox:#{ox}, oy:#{oy}, visible:#{visible})".freeze)
 

data/lib/vedeu/logging/log.rb

@@ -26,8 +26,7 @@ module Vedeu
         def log(message:, force: false, type: :info)
           output = log_entry(type, message)
 
-          if (enabled? || force) && (Vedeu::Configuration.log_only.empty? ||
-                     Vedeu::Configuration.log_only.include?(type))
+          if (enabled? || force) && Vedeu::Configuration.loggable?(type)
             logger.debug(output)
           end
 
@@ -172,6 +171,7 @@ module Vedeu
             input:  [:light_yellow, :yellow],
 
             compress: [:white, :light_grey],
+            cursor:   [:light_green, :green],
             output:   [:light_green, :green],
             render:   [:light_green, :green],
 

data/lib/vedeu/models/row.rb

@@ -48,7 +48,7 @@ module Vedeu
 
       # @return [Array<void>]
       def content
-        (cells.flatten << reset_character).reject(&:cell?)
+        (cells.flatten << reset_character)
       end
 
       # Provides iteration over the collection.

data/lib/vedeu/output/text.rb

@@ -244,12 +244,12 @@ module Vedeu
       #
       # @return [Fixnum]
       def width
-        if present?(options[:name])
-          geometry.bordered_width
-
-        elsif present?(options[:width])
+        if present?(options[:width])
           options[:width]
 
+        elsif present?(options[:name])
+          geometry.bordered_width
+
         end
       end
 

data/lib/vedeu/renderers/all.rb

@@ -145,3 +145,4 @@ require 'vedeu/renderers/file'
 require 'vedeu/renderers/html'
 require 'vedeu/renderers/json'
 require 'vedeu/renderers/terminal'
+require 'vedeu/renderers/text'

data/lib/vedeu/renderers/text.rb

@@ -0,0 +1,103 @@
+module Vedeu
+
+  module Renderers
+
+    # Converts a grid of {Vedeu::Cells} objects or
+    # {Vedeu::Views::Char} objects into a stream of characters without
+    # escape sequences.
+    #
+    class Text < Vedeu::Renderers::File
+
+      include Vedeu::Common
+      include Vedeu::Renderers::Options
+
+      # Returns a new instance of Vedeu::Renderers::Text.
+      #
+      # @param options [Hash]
+      # @return [Vedeu::Renderers::Text]
+      def initialize(options = {})
+        @options = options || {}
+      end
+
+      # Render a cleared output.
+      #
+      # @return [String]
+      def clear
+        ''
+      end
+
+      # @param output [Vedeu::Models::Page]
+      # @return [Array<String>]
+      def render(output)
+        return '' unless present?(output)
+
+        output.each do |row|
+          row.each do |char|
+            next unless renderable?(char) &&
+                        positionable?(char) &&
+                        textual?(char)
+
+            # fail char.inspect
+
+            buffer[char.position.y - 1][char.position.x - 1] = char.text
+          end
+        end
+
+        ::File.write(filename, data) if write_file?
+
+        data
+      end
+
+      private
+
+      # @return [Array<String>]
+      def buffer
+        @buffer ||= Array.new(Vedeu.height) { Array.new(Vedeu.width) { ' ' } }
+      end
+
+      # @return [String]
+      def data
+        @data ||= buffer.map(&:join).join("\n").unpack('U*').map do |c|
+          (c > 255) ? ' ' : c.chr
+        end.join
+      end
+
+      # @return [Boolean]
+      def positionable?(char)
+        char.respond_to?(:position) &&
+        char.position.is_a?(Vedeu::Geometries::Position)
+      end
+
+      # @return [Array<Class>]
+      def renderables
+        [
+          Vedeu::Cells::Empty,
+          Vedeu::Cells::TopLeft,
+          Vedeu::Cells::TopHorizontal,
+          Vedeu::Cells::Char,
+          Vedeu::Cells::TopRight,
+          Vedeu::Views::Char,
+          Vedeu::Cells::Clear,
+          Vedeu::Cells::LeftVertical,
+          Vedeu::Cells::RightVertical,
+          Vedeu::Cells::BottomLeft,
+          Vedeu::Cells::BottomHorizontal,
+          Vedeu::Cells::BottomRight,
+        ]
+      end
+
+      # @return [Boolean]
+      def renderable?(char)
+        renderables.include?(char.class)
+      end
+
+      # @return [Boolean]
+      def textual?(char)
+        char.respond_to?(:text)
+      end
+
+    end # Text
+
+  end # Renderers
+
+end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.7.2'.freeze
 
 end

data/lib/vedeu/views/char.rb

@@ -104,6 +104,15 @@ module Vedeu
         Vedeu::EscapeSequences::Esc.border { @value }
       end
 
+      # @return [String]
+      def text
+        if border
+          ' '
+        else
+          @value
+        end
+      end
+
       # Returns a Hash of all the values before coercion.
       #
       # @note

data/test/lib/vedeu/cells/borders/corner_test.rb

@@ -50,6 +50,14 @@ module Vedeu
         end
       end
 
+      describe '#text' do
+        let(:instance) { Vedeu::Cells::TopRight.new }
+
+        subject { instance.text }
+
+        it { subject.must_equal('+') }
+      end
+
     end # Corner
 
   end # Cells

data/test/lib/vedeu/cells/borders/horizontal_test.rb

@@ -9,6 +9,12 @@ module Vedeu
       let(:described) { Vedeu::Cells::Horizontal }
       let(:instance)  { described.new }
 
+      describe '#text' do
+        subject { instance.text }
+
+        it { subject.must_equal('-') }
+      end
+
       describe '#type' do
         subject { instance.type }
 

data/test/lib/vedeu/cells/borders/vertical_test.rb

@@ -9,6 +9,12 @@ module Vedeu
       let(:described) { Vedeu::Cells::Vertical }
       let(:instance)  { described.new }
 
+      describe '#text' do
+        subject { instance.text }
+
+        it { subject.must_equal('|') }
+      end
+
       describe '#type' do
         subject { instance.type }
 

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

@@ -15,6 +15,12 @@ module Vedeu
         it { subject.must_equal(false) }
       end
 
+      describe '#text' do
+        subject { instance.text }
+
+        it { subject.must_equal('') }
+      end
+
     end # Char
 
   end # Cells

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

@@ -25,6 +25,8 @@ module Vedeu
         subject { instance.value }
 
         it { subject.must_equal(' ') }
+
+        it { instance.must_respond_to(:text) }
       end
 
     end # Clear

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

@@ -48,6 +48,12 @@ module Vedeu
         end
       end
 
+      describe '#text' do
+        subject { instance.text }
+
+        it { subject.must_equal(' ') }
+      end
+
       describe '#to_hash' do
         let(:position) { [1, 1] }
         let(:colour)   { Vedeu::Colours::Colour.new(background: '#000000') }

data/test/lib/vedeu/configuration/api_test.rb

@@ -241,6 +241,18 @@ module Vedeu
         end
       end
 
+      describe '#log_except' do
+        it 'sets the options to the desired value' do
+          configuration = Vedeu.configure { log_except :debug, :store }
+          configuration.log_except.must_equal([:debug, :store])
+        end
+
+        it 'sets the options to the desired value' do
+          configuration = Vedeu.configure { log_except [:debug, :info] }
+          configuration.log_except.must_equal([:debug, :info])
+        end
+      end
+
       describe '#log_only' do
         it 'sets the options to the desired value' do
           configuration = Vedeu.configure { log_only :debug, :store }

data/test/lib/vedeu/configuration/configuration_test.rb

@@ -93,6 +93,22 @@ module Vedeu
       end
     end
 
+    describe '.log_except' do
+      context 'when log_except is not configured' do
+        it { described.log_except.must_equal([]) }
+      end
+
+      context 'when log_except is configured' do
+        before do
+          Vedeu.configure do
+            log_except :timer, :event
+          end
+        end
+
+        it { described.log_except.must_equal([:timer, :event]) }
+      end
+    end
+
     describe '.log_only' do
       context 'when log_only is not configured' do
         it { described.log_only.must_equal([]) }
@@ -109,6 +125,48 @@ module Vedeu
       end
     end
 
+    describe '.loggable?' do
+      let(:type) { :hydrogen }
+
+      subject { described.loggable?(type) }
+
+      context 'when the type exists in log_only and log_except' do
+        before do
+          described.stubs(:log_only).returns([:hydrogen])
+          described.stubs(:log_except).returns([:hydrogen])
+        end
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when the type exists in log_only' do
+        before do
+          described.stubs(:log_only).returns([:hydrogen])
+          described.stubs(:log_except).returns([])
+        end
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when the type exists in log_except' do
+        before do
+          described.stubs(:log_only).returns([])
+          described.stubs(:log_except).returns([:hydrogen])
+        end
+
+        it { subject.must_equal(false) }
+      end
+
+      context 'when the type does not exist in either' do
+        before do
+          described.stubs(:log_only).returns([])
+          described.stubs(:log_except).returns([])
+        end
+
+        it { subject.must_equal(true) }
+      end
+    end
+
     describe '.mouse?' do
       it { described.must_respond_to(:mouse) }
 

data/test/lib/vedeu/models/row_test.rb

@@ -100,6 +100,7 @@ module Vedeu
         let(:expected) {
           [
             Vedeu::Views::Char.new(value: 'A'),
+            Vedeu::Cells::Empty.new(value: 'B'),
             Vedeu::Views::Char.new(value: 'C'),
             Vedeu::Views::Char.new(value: "\e[0m"),
           ]

data/test/lib/vedeu/renderers/text_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Renderers
+
+    describe Text do
+
+      let(:described) { Vedeu::Renderers::Text }
+      let(:instance)  { described.new(options) }
+      let(:options)   { {} }
+
+      let(:geometry)  {
+        Vedeu::Geometries::Geometry.new(name: 'Vedeu::Renderers::Text',
+                                        x:    2,
+                                        xn:   4,
+                                        y:    2,
+                                        yn:   4)
+      }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+      end
+
+      describe '#clear' do
+        subject { instance.clear }
+
+        it { subject.must_equal('') }
+      end
+
+      describe '#render' do
+        let(:output) {}
+
+        before do
+          Vedeu.stubs(:height).returns(5)
+          Vedeu.stubs(:width).returns(5)
+          Vedeu.geometries.stubs(:by_name).returns(geometry)
+          ::File.stubs(:write)
+        end
+
+        subject { instance.render(output) }
+
+        context 'when the output is nil' do
+          it { subject.must_equal('') }
+        end
+
+        context 'when the output is a Vedeu::Models::Page' do
+          let(:output) { Vedeu::Models::Page.coerce(rows) }
+          let(:rows) {
+            [
+              Vedeu::Models::Row.new([
+                Vedeu::Cells::TopLeft.new,
+                Vedeu::Cells::TopHorizontal.new,
+                Vedeu::Cells::TopRight.new,
+              ]),
+              Vedeu::Models::Row.new([
+                Vedeu::Cells::LeftVertical.new,
+                Vedeu::Cells::Char.new,
+                Vedeu::Cells::RightVertical.new,
+              ]),
+              Vedeu::Models::Row.new([
+                Vedeu::Cells::BottomLeft.new,
+                Vedeu::Cells::BottomHorizontal.new,
+                Vedeu::Cells::BottomRight.new,
+              ]),
+            ]
+          }
+          let(:expected) {
+            "     \n" \
+            " + + \n" \
+            "     \n" \
+            " + + \n" \
+            "     "
+          }
+
+          it { subject.must_equal(expected) }
+        end
+      end
+
+    end # Text
+
+  end # Renderers
+
+end # Vedeu

data/test/lib/vedeu/views/char_test.rb

@@ -109,6 +109,18 @@ module Vedeu
         it { subject.must_be_instance_of(Vedeu::Interfaces::Interface) }
       end
 
+      describe '#text' do
+        subject { instance.text }
+
+        it { subject.must_equal('a') }
+
+        context 'when there is a border defined' do
+          let(:border) { :horizontal }
+
+          it { subject.must_equal(' ') }
+        end
+      end
+
       describe '#to_hash' do
         let(:position) { Vedeu::Geometries::Position.coerce([17, 2]) }
         let(:expected) {

data/test/support/examples/material_colours_app.rb

@@ -23,6 +23,7 @@ class VedeuMaterialColoursApp
     # foreground '#ffff00'
     # profile!
     log '/tmp/vedeu_material_colours_app.log'
+    log_except [:cursor, :update, :render]
     # height 11
     # width  20
     # renderers(Vedeu::Renderers::File

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -524,6 +524,7 @@ files:
 - lib/vedeu/renderers/options.rb
 - lib/vedeu/renderers/templates/html_renderer.vedeu
 - lib/vedeu/renderers/terminal.rb
+- lib/vedeu/renderers/text.rb
 - lib/vedeu/repositories/all.rb
 - lib/vedeu/repositories/assemblage.rb
 - lib/vedeu/repositories/collection.rb
@@ -729,6 +730,7 @@ files:
 - test/lib/vedeu/renderers/json_test.rb
 - test/lib/vedeu/renderers/options_test.rb
 - test/lib/vedeu/renderers/terminal_test.rb
+- test/lib/vedeu/renderers/text_test.rb
 - test/lib/vedeu/repositories/assemblage_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
 - test/lib/vedeu/repositories/defaults_test.rb
@@ -971,6 +973,7 @@ test_files:
 - test/lib/vedeu/renderers/json_test.rb
 - test/lib/vedeu/renderers/options_test.rb
 - test/lib/vedeu/renderers/terminal_test.rb
+- test/lib/vedeu/renderers/text_test.rb
 - test/lib/vedeu/repositories/assemblage_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
 - test/lib/vedeu/repositories/defaults_test.rb