vedeu 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ef9364bd8562905d44a580a1f6b9f0acb3820d6
-  data.tar.gz: 30849fc7340fbb1ab220e24834580bd0941e8545
+  metadata.gz: 19ee0e20e445eeee950b4aaf5be06d25b6e7f5ad
+  data.tar.gz: f9dbeb37f02a0491376d1f1ad2e94abbf37c2548
 SHA512:
-  metadata.gz: 461240de809a3abd145c22eaea50bc32b5dfe56f41c16c35c407b6e13493f4d16e431d0fb9f2fdbb5111f847287d771f39fb7a239fe8f6c24f47677b930c4f44
-  data.tar.gz: e823ea6b126ea32dd259fdef8a58c3cd6c59c3a07bcaa8d51cb52bef0847226dbf69890d9b0e4c6ec064c5feffaaee17e48ccd91ea417dff7faf14579c5d2d83
+  metadata.gz: f848ddbd4480fd75e76a8a6f4dcef666eaacd4b7de53e9dd8e4b76ce37ca51909436898d1c41d6e159d2c7afde9a4414d6b65dd1c10f57a3416a6fdf8e010814
+  data.tar.gz: 96a133c336ccca5f5aa84414aa766f2c5b7666103feabe328de3c9166cda1cba7e13c4f92166025cd4ffa198d5fad9430c98c2bf7f11c161e37f6e29940e9a78

data/lib/vedeu/api/base.rb

@@ -8,12 +8,15 @@ module Vedeu
       def initialize(attributes, &block)
         @attributes = attributes
 
-        self.instance_eval(&block) if block_given?
+        @self_before_instance_eval = eval 'self', block.binding
+
+        self.instance_eval(&block)
       end
 
       def colour(*args)
         if args.is_a?(Array) && args.size == 2
-          attributes[:colour] = { background: args.first, foreground: args.last }
+          attributes[:colour] = { background: args.first,
+                                  foreground: args.last }
 
         elsif args.is_a?(Array) && args.size == 1 && args.first.is_a?(Hash)
           attributes[:colour] = args.first
@@ -31,6 +34,12 @@ module Vedeu
           [values].flatten.each { |value| attributes[:style] << value }
         end
       end
+
+      # :nocov:
+      def method_missing(method, *args, &block)
+        @self_before_instance_eval.send method, *args, &block
+      end
+      # :nocov
     end
   end
 end

data/lib/vedeu/api/grid.rb

@@ -0,0 +1,56 @@
+require 'vedeu/support/terminal'
+
+class Fixnum
+  # Augment Fixnum to calculate column width in a grid-based layout.
+  #
+  # The grid system splits the terminal width into 12 equal parts, by dividing
+  # the available width by 12. If the terminal width is not a multiple of 12,
+  # then Grid chooses the maximum value which will fit.
+  #
+  # Used primarily at interface creation time:
+  #
+  #   width: 9.columns  # (Terminal width / 12) * 9 characters wide; e.g.
+  #                     # Terminal is 92 characters wide, maximum value is
+  #                     # therefore 84, meaning a column is 7 characters wide.
+  def columns
+     Vedeu::API::Grid.columns(self)
+  end
+end
+
+module Vedeu
+  module API
+    OutOfRange = Class.new(StandardError)
+
+    class Grid
+      def self.columns(value)
+        new(value).columns
+      end
+
+      def initialize(value)
+        @value = value
+      end
+
+      def columns
+        fail OutOfRange, 'Valid range is 1..12.' if out_of_range?
+
+        column * value
+      end
+
+      private
+
+      attr_reader :value
+
+      def column
+        actual / 12
+      end
+
+      def actual
+        Terminal.width
+      end
+
+      def out_of_range?
+        value < 1 || value > 12
+      end
+    end
+  end
+end

data/lib/vedeu/api/interface.rb

@@ -1,4 +1,5 @@
 require 'vedeu/models/geometry'
+require 'vedeu/api/grid'
 require 'vedeu/support/interface_store'
 require 'vedeu/support/terminal'
 

data/lib/vedeu/api/line.rb

@@ -8,11 +8,6 @@ module Vedeu
         attributes
       end
 
-      def width(value)
-        #attributes[:streams][:width] = value
-        #attributes[:streams] << API::Stream.build({ width: value })
-      end
-
       def align(value)
         attributes[:align] = value
       end
@@ -26,15 +21,21 @@ module Vedeu
       end
 
       def foreground(value = '', &block)
-        attributes[:streams] << API::Stream.build({ colour: { foreground: value } }, &block)
+        attributes[:streams] << API::Stream.build({
+                                  colour: { foreground: value }
+                                }, &block)
       end
 
       def background(value = '', &block)
-        attributes[:streams] << API::Stream.build({ colour: { background: value } }, &block)
+        attributes[:streams] << API::Stream.build({
+                                  colour: { background: value }
+                                }, &block)
       end
 
       def attributes
-        @_attributes ||= { colour: {}, style: [], streams: [] }.merge!(@attributes)
+        @_attributes ||= { colour:  {},
+                           style:   [],
+                           streams: [] }.merge!(@attributes)
       end
     end
   end

data/lib/vedeu/api/stream.rb

@@ -7,10 +7,18 @@ module Vedeu
         attributes
       end
 
+      def align(value)
+        attributes[:align] = value
+      end
+
       def text(value)
         attributes[:text] = value
       end
 
+      def width(value)
+        attributes[:width] = value
+      end
+
       def attributes
         @_attributes ||= { colour: {}, style: [], text: '' }.merge!(@attributes)
       end

data/lib/vedeu/api/view.rb

@@ -18,6 +18,8 @@ module Vedeu
       end
 
       def build(&block)
+        @self_before_instance_eval = eval 'self', block.binding
+
         self.instance_eval(&block) if block_given?
 
         attributes
@@ -34,6 +36,12 @@ module Vedeu
       def name
         return @name if InterfaceStore.query(@name)
       end
+
+      # :nocov:
+      def method_missing(method, *args, &block)
+        @self_before_instance_eval.send method, *args, &block
+      end
+      # :nocov
     end
   end
 end

data/lib/vedeu/output/dsl_parser.rb

@@ -0,0 +1,19 @@
+module Vedeu
+  class DSLParser
+    def self.parse(data)
+      new(data).parse
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    def parse
+      { interfaces: [ data ] }
+    end
+
+    private
+
+    attr_reader :data
+  end
+end

data/lib/vedeu/output/render_interface.rb

@@ -24,31 +24,29 @@ module Vedeu
     attr_reader :interface
 
     def processed_lines
-      processed_lines = lines.map do |line|
-        if line.streams.any?
-          processed_streams = []
-          line_length       = 0
-          line.streams.each do |stream|
-            next if stream.text.empty?
+      return [] unless lines.any? { |line| line.streams.any? }
 
-            if (line_length += stream.text.size) >= width
-              remainder = width - line_length
+      lines.map do |line|
+        line_length = 0
+        streams     = line.streams.inject([]) do |processed, stream|
+          next if stream.text.empty?
 
-              processed_streams << Stream.new(
-                                    text:   truncate(stream.text, remainder),
+          if (line_length += stream.text.size) >= width
+            remainder = width - line_length
+
+            processed << Stream.new(text:   truncate(stream.text, remainder),
                                     style:  stream.style,
                                     colour: stream.colour)
 
-            else
-              processed_streams << stream
+          else
+            processed << stream
 
-            end
           end
-
-          Line.new(streams: processed_streams,
-                   style:   line.style,
-                   colour:  line.colour)
         end
+
+        Line.new(streams: streams,
+                 style:   line.style,
+                 colour:  line.colour)
       end
     end
 

data/lib/vedeu/output/view.rb

@@ -1,4 +1,5 @@
 require 'vedeu/models/composition'
+require 'vedeu/output/dsl_parser'
 require 'vedeu/output/erb_parser'
 require 'vedeu/output/raw_parser'
 require 'vedeu/output/json_parser'
@@ -29,6 +30,7 @@ module Vedeu
 
     def parser
       {
+        dsl:     DSLParser,
         erb:     ERBParser,
         json:    JSONParser,
         hash:    RawParser,

data/test/lib/vedeu/api/grid_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+require 'vedeu/api/grid'
+
+module Vedeu
+  module API
+    describe Grid do
+      it 'raises an exception if the value is less than 1' do
+        proc { Grid.columns(0) }.must_raise(OutOfRange)
+      end
+
+      it 'raises an exception if the value is greater than 12' do
+        proc { Grid.columns(13) }.must_raise(OutOfRange)
+      end
+
+      it 'returns the width if the value is in range' do
+        IO.console.stub :winsize, [25, 80] do
+          Grid.columns(7).must_equal(42)
+        end
+      end
+    end
+  end
+end

data/test/lib/vedeu/api/view_test.rb

@@ -9,8 +9,6 @@ module Vedeu
       before do
         InterfaceStore.reset
         Interface.save('testing_view') do
-          width  80
-          height 25
           x      1
           y      1
           colour  foreground: '#ffffff', background: '#000000'
@@ -387,11 +385,12 @@ module Vedeu
       end
 
       it 'handles alignment' do
-        skip
         Vedeu.view 'testing_view' do
           line do
-            width 80
-            text  'This is aligned left, and padded with spaces.'
+            stream do
+              width 80
+              text  'This is aligned left, and padded with spaces.'
+            end
           end
         end.must_equal(
           {
@@ -400,8 +399,10 @@ module Vedeu
               colour:  {},
               style:   [],
               streams: [{
-                width: 80,
-                text:  'This is aligned left, and padded with spaces.'
+                colour: {},
+                style:  [],
+                width:  80,
+                text:   'This is aligned left, and padded with spaces.'
               }]
             }]
           }
@@ -412,18 +413,24 @@ module Vedeu
         skip
         Vedeu.view 'testing_view' do
           line do
-            width 80
-            align :left # explicit
-            text  'This is aligned left, and padded with spaces.'
+            stream do
+              width 80
+              align :left # explicit
+              text  'This is aligned left, and padded with spaces.'
+            end
           end
         end.must_equal(
           {
             name:  'testing_view',
             lines: [{
+              colour:  {},
+              style:   [],
               streams: [{
-                width: 80,
-                align: :left,
-                text:  'This is aligned left, and padded with spaces.'
+                colour: {},
+                style:  [],
+                width:  80,
+                align:  :left,
+                text:   'This is aligned left, and padded with spaces.'
               }]
             }]
           }
@@ -434,18 +441,24 @@ module Vedeu
         skip
         Vedeu.view 'testing_view' do
           line do
-            width 80
-            align :centre
-            text  'This is aligned centrally, and padded with spaces.'
+            stream do
+              width 80
+              align :centre
+              text  'This is aligned centrally, and padded with spaces.'
+            end
           end
         end.must_equal(
           {
             name:  'testing_view',
             lines: [{
+              colour:  {},
+              style:   [],
               streams: [{
-                width: 80,
-                align: :centre,
-                text:  'This is aligned right, and padded with spaces.'
+                colour: {},
+                style:  [],
+                width:  80,
+                align:  :centre,
+                text:   'This is aligned right, and padded with spaces.'
               }]
             }]
           }
@@ -456,23 +469,103 @@ module Vedeu
         skip
         Vedeu.view 'testing_view' do
           line do
-            width 80
-            align :right
-            text  'This is aligned right, and padded with spaces.'
+            stream do
+              width 80
+              align :right
+              text  'This is aligned right, and padded with spaces.'
+            end
           end
         end.must_equal(
           {
             name:  'testing_view',
             lines: [{
+              colour:  {},
+              style:   [],
               streams: [{
-                width: 80,
-                align: :right,
-                text:  'This is aligned right, and padded with spaces.'
+                colour: {},
+                style:  [],
+                width:  80,
+                align:  :right,
+                text:   'This is aligned right, and padded with spaces.'
               }]
             }]
           }
         )
       end
+
+      it 'handles multiple colour and text statements correctly' do
+        Vedeu.view 'testing_view' do
+          line do
+            foreground('#ffff00') { text "\u{25B2}" }
+            text " Prev"
+
+            foreground('#ffff00') { text "\u{25BC}" }
+            text " Next"
+
+            foreground('#ffff00') { text "\u{21B2}" }
+            text " Select"
+
+            foreground('#ffff00') { text "\u{2395}" }
+            text " Pause"
+
+            foreground('#ffff00') { text "Q" }
+            text " Quit"
+          end
+        end.must_equal(
+          {
+            name:  'testing_view',
+            lines: [
+              {
+                colour:  {},
+                style:   [],
+                streams: [
+                  {
+                    colour: {
+                      foreground: "#ffff00"
+                    },
+                    style: [],
+                    text: "▲"
+                  }, {
+                    text: " Prev"
+                  }, {
+                    colour: {
+                      foreground: "#ffff00"
+                    },
+                    style: [],
+                    text: "▼"
+                  }, {
+                    text: " Next"
+                  }, {
+                    colour: {
+                      foreground: "#ffff00"
+                    },
+                    style: [],
+                    text: "↲"
+                  }, {
+                    text: " Select"
+                  }, {
+                    colour: {
+                      foreground: "#ffff00"
+                    },
+                    style: [],
+                    text: "⎕"
+                  }, {
+                    text: " Pause"
+                  }, {
+                    colour: {
+                      foreground: "#ffff00"
+                    },
+                    style: [],
+                    text: "Q"
+                  }, {
+                    text: " Quit"
+                  }
+                ]
+              }
+            ]
+          }
+        )
+      end
     end
   end
 end

data/test/lib/vedeu/application_test.rb

@@ -3,5 +3,8 @@ require 'vedeu/application'
 
 module Vedeu
   describe Application do
+    it 'returns an instance of Application' do
+      Application.new.must_be_instance_of(Application)
+    end
   end
 end

data/test/lib/vedeu/output/dsl_parser_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+require 'vedeu/output/dsl_parser'
+
+module Vedeu
+  describe DSLParser do
+    it 'returns attributes suitable for Composition' do
+      DSLParser.parse({ name: 'dummy' }).must_equal(
+        {
+          interfaces: [
+            {
+              name: 'dummy'
+            }
+          ]
+        }
+      )
+    end
+  end
+end

data/test/lib/vedeu/output/render_interface_test.rb

@@ -10,12 +10,12 @@ module Vedeu
     describe '.call' do
       it 'returns the content for the interface' do
         interface = Interface.new({
-          name:   '.call',
+          name:     '.call',
           geometry: {
             width:  32,
             height: 3,
           },
-          lines:  [
+          lines:    [
             {
               streams: [{ text: 'this is the first' }]
             }, {
@@ -40,6 +40,55 @@ module Vedeu
           "\e[3;1Hthis is the third, it is even lo"
         )
       end
+
+      it 'returns a blank interface if there are no streams of text' do
+        interface = Interface.new({
+          name:     '.call',
+          geometry: {
+            width:  32,
+            height: 3,
+          },
+          lines:    []
+        })
+        RenderInterface.call(interface).must_equal(
+          "\e[1;1H                                \e[1;1H" \
+          "\e[2;1H                                \e[2;1H" \
+          "\e[3;1H                                \e[3;1H"
+        )
+      end
+
+      it 'skips lines which have streams with no content' do
+        interface = Interface.new({
+          name:     '.call',
+          geometry: {
+            width:  32,
+            height: 3,
+          },
+          lines:    [
+            {
+              streams: [{ text: 'this is the first' }]
+            }, {
+              streams: { text: '' }
+            }, {
+              streams: [
+                { text: 'this is the third, ' },
+                { text: 'it is even longer '  },
+                { text: 'and still truncated' }
+              ]
+            }, {
+              streams: [{ text: 'this should not render' }]
+            }
+          ]
+        })
+        RenderInterface.call(interface).must_equal(
+          "\e[1;1H                                \e[1;1H" \
+          "\e[2;1H                                \e[2;1H" \
+          "\e[3;1H                                \e[3;1H" \
+          "\e[1;1Hthis is the first" \
+          "\e[2;1H" \
+          "\e[3;1Hthis is the third, it is even lo"
+        )
+      end
     end
   end
 end

data/test/lib/vedeu/support/helpers_test.rb

@@ -16,8 +16,6 @@ module Vedeu
     describe '.foreground' do
       it 'returns an escape sequence for the specified CSS foreground' do
         TestHelpers.new.foreground('#a5f500').must_equal("\e[38;5;148m")
-
-        TestHelpers.new.fg('#851500').must_equal("\e[38;5;88m")
       end
 
       it 'returns an escape sequence plus interpolation when a block is given' do
@@ -29,8 +27,6 @@ module Vedeu
     describe '.background' do
       it 'returns an escape sequence for the specified CSS background' do
         TestHelpers.new.background('#2f2f2f').must_equal("\e[48;5;16m")
-
-        TestHelpers.new.bg('#ffffff').must_equal("\e[48;5;231m")
       end
 
       it 'returns an escape sequence plus interpolation when a block is given' do

data/test/lib/vedeu_test.rb

@@ -33,19 +33,16 @@ end
 describe Vedeu do
   describe '.events' do
     it 'creates some system events for the client application' do
-      skip
     end
   end
 
   describe '.log' do
     it 'returns a logger instance for writing debug messages to' do
-      skip
     end
   end
 
   describe '.error' do
     it 'writes an error to the log' do
-      skip
     end
   end
 end

data/vedeu.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.1.5'
+  spec.version       = '0.1.6'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = %q{A terminal case of wonderland.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,6 +186,7 @@ files:
 - deps.md
 - lib/vedeu.rb
 - lib/vedeu/api/base.rb
+- lib/vedeu/api/grid.rb
 - lib/vedeu/api/interface.rb
 - lib/vedeu/api/line.rb
 - lib/vedeu/api/stream.rb
@@ -207,6 +208,7 @@ files:
 - lib/vedeu/models/style.rb
 - lib/vedeu/output/clear_interface.rb
 - lib/vedeu/output/colour_translator.rb
+- lib/vedeu/output/dsl_parser.rb
 - lib/vedeu/output/erb_parser.rb
 - lib/vedeu/output/json_parser.rb
 - lib/vedeu/output/menu_parser.rb
@@ -225,6 +227,7 @@ files:
 - lib/vedeu/support/wordwrap.rb
 - logs/.gitkeep
 - test/lib/vedeu/api/base_test.rb
+- test/lib/vedeu/api/grid_test.rb
 - test/lib/vedeu/api/interface_test.rb
 - test/lib/vedeu/api/line_test.rb
 - test/lib/vedeu/api/stream_test.rb
@@ -245,6 +248,7 @@ files:
 - test/lib/vedeu/models/style_test.rb
 - test/lib/vedeu/output/clear_interface_test.rb
 - test/lib/vedeu/output/colour_translator_test.rb
+- test/lib/vedeu/output/dsl_parser_test.rb
 - test/lib/vedeu/output/erb_parser_test.rb
 - test/lib/vedeu/output/json_parser_test.rb
 - test/lib/vedeu/output/menu_parser_test.rb
@@ -312,6 +316,7 @@ specification_version: 4
 summary: A terminal case of wonderland.
 test_files:
 - test/lib/vedeu/api/base_test.rb
+- test/lib/vedeu/api/grid_test.rb
 - test/lib/vedeu/api/interface_test.rb
 - test/lib/vedeu/api/line_test.rb
 - test/lib/vedeu/api/stream_test.rb
@@ -332,6 +337,7 @@ test_files:
 - test/lib/vedeu/models/style_test.rb
 - test/lib/vedeu/output/clear_interface_test.rb
 - test/lib/vedeu/output/colour_translator_test.rb
+- test/lib/vedeu/output/dsl_parser_test.rb
 - test/lib/vedeu/output/erb_parser_test.rb
 - test/lib/vedeu/output/json_parser_test.rb
 - test/lib/vedeu/output/menu_parser_test.rb