vedeu 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2e18e1de7f428b1890aacc71abffae0ea935431
-  data.tar.gz: 3c32f191ff6dfead712551de9c4375261d46dc54
+  metadata.gz: b2a6839a91cbe235601f64318bbeae95e5be439d
+  data.tar.gz: a3eb219aab24bf02d8cdf2280754c3a5a8375066
 SHA512:
-  metadata.gz: 5b2dc0ebd0bfa591774ead8d58fdd090ca80152619545226230a02d72c2b9a0f991aa0813eec3bffeee38070091cedfce8a0e6df2648a8a740ffe6589bfe6c18
-  data.tar.gz: a785503d6086eaa2b8a4d1c4aa882f99d03ff4a791c42828fef352e053d0f146b67b4b6fa0e6bb2f9f87b46be82d8e1c42100e4d64c6d059263cff3cd9d9c01a
+  metadata.gz: d202139c56d5f1d12763ed282387d0c99059d820d2527940d6ae8805e0eb73bd58029aba5fc7ddb511f00ea628ff487dd3349bbf17bdb7a7670b7676b296cac4
+  data.tar.gz: c941ca66c0c66128ae4d1dd125fe02180d42b0bd28c6f23f8e5697409d4b4c17376ad7a2e801a13f242b00414b83c2c6e6e4dd02cd85e31156e9d37c832c3001

data/examples/borders_app.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+-> { its -> { a } }
+trap('INT') { exit! }
+
+require 'vedeu'
+
+class VedeuBordersApp
+  include Vedeu
+
+  event(:_initialize_) { trigger(:_refresh_) }
+
+  interface 'lur' do
+    border
+    x       2
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#ff0000'
+  end
+
+  interface 'tan' do
+    x       11
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#00ff00'
+  end
+
+  interface 'tal' do
+    border  show_top: false
+    x       20
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#0000ff'
+  end
+
+  interface 'ums' do
+    border  show_bottom: false
+    x       29
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'ulp' do
+    border  show_left: false
+    x       38
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'hur' do
+    border  show_right: false
+    x       47
+    y       2
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'sto' do
+    border  top_right: 'B', top_left: 'A', bottom_right: 'D', bottom_left: 'C'
+    x       2
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#ff0000'
+  end
+
+  interface 'sod' do
+    border  horizontal: '*', vertical: '$'
+    x       11
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#00ff00'
+  end
+
+  interface 'sil' do
+    border  show_right: false, show_bottom: false, show_left: false
+    x       20
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#0000ff'
+  end
+
+  interface 'ver' do
+    border  show_top: false, show_right: false, show_left: false
+    x       29
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'ico' do
+    border  show_top: false, show_bottom: false, show_right: false
+    x       38
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'sel' do
+    border  show_top: false, show_bottom: false, show_left: false
+    x       47
+    y       7
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#ffff00'
+  end
+
+  interface 'ens' do
+    border  colour: { foreground: '#ffff00', background: '#0000ff' }
+    x       2
+    y       12
+    height  3
+    width   7
+    colour  foreground: '#ffffff', background: '#ff0000'
+  end
+
+  interface 'eab' do
+    border  style: 'negative'
+    x       11
+    y       12
+    height  3
+    width   7
+    colour  foreground: '#000000', background: '#00ff00'
+    style   'normal'
+  end
+
+  render do
+    view('lur') { line 'on'   }
+    view('tan') { line 'off'  }
+    view('tal') { line 'no t' }
+    view('ums') { line 'no b' }
+    view('ulp') { line 'no l' }
+    view('hur') { line 'no r' }
+
+    view('sto') { line 'chars'; line '1' }
+    view('sod') { line 'chars'; line '2' }
+    view('sil') { line 'only';  line 't' }
+    view('ver') { line 'only';  line 'b' }
+    view('ico') { line 'only';  line 'l' }
+    view('sel') { line 'only';  line 'r' }
+
+    view('ens') { line 'color' }
+    view('eab') { line 'style' }
+  end
+
+  Vedeu.configure do
+    debug!
+    log '/tmp/vedeu_borders_app.log'
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
+  end
+end
+
+VedeuBordersApp.start(ARGV)

data/lib/vedeu.rb

@@ -75,6 +75,7 @@ require 'vedeu/support/presentation'
 require 'vedeu/support/sentence'
 require 'vedeu/support/terminal'
 
+require 'vedeu/models/border'
 require 'vedeu/models/char'
 require 'vedeu/models/composition'
 require 'vedeu/models/geometry'
@@ -114,7 +115,6 @@ require 'vedeu/support/refresh'
 
 require 'vedeu/output/compositor'
 require 'vedeu/output/output'
-require 'vedeu/output/view'
 require 'vedeu/output/viewport'
 
 require 'vedeu/support/bounding_area'

data/lib/vedeu/api/interface.rb

@@ -9,6 +9,18 @@ module Vedeu
 
       include Helpers
 
+      # Allows the setting of a border for the interface. Via the `values`
+      # parameter, the various characters for the borders sides and corners can
+      # be set, a custom foreground and background, a custom style, and whether
+      # a particular side should be drawn or not. See {Border#initialize} for
+      # more details.
+      #
+      # @return [Hash]
+      def border(values = {})
+        auto_enable = { enabled: true }
+        attributes[:border] = auto_enable.merge(values)
+      end
+
       # Instructs Vedeu to calculate x and y geometry automatically based on the
       # centre character of the terminal, the width and the height.
       #

data/lib/vedeu/api/menu.rb

@@ -26,7 +26,7 @@ module Vedeu
       # @param  attributes [Hash]
       # @return [API::Menu]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
+        @attributes = defaults.merge(attributes)
       end
 
       # @param block [Proc]

data/lib/vedeu/colours/colour.rb

@@ -14,7 +14,7 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Colour]
     def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
+      @attributes = defaults.merge(attributes)
     end
 
     # Converts the `:foreground` attribute into a terminal escape sequence.

data/lib/vedeu/models/border.rb

@@ -0,0 +1,238 @@
+module Vedeu
+
+  #
+  #
+  # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
+  #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
+  #
+  class Border
+
+    # Returns a new instance of Border.
+    #
+    # @param interface [Interface]
+    # @param attributes [Hash]
+    # @return [Border]
+    def initialize(interface, attributes = {})
+      @interface  = interface
+      @attributes = defaults.merge(attributes)
+    end
+
+    def enabled?
+      attributes[:enabled]
+    end
+
+    def bottom?
+      attributes[:show_bottom]
+    end
+
+    def left?
+      attributes[:show_left]
+    end
+
+    def right?
+      attributes[:show_right]
+    end
+
+    def top?
+      attributes[:show_top]
+    end
+
+    def to_s
+      to_viewport.map { |line| line.flatten.join }.join("\n")
+    end
+
+    def to_viewport
+      return viewport unless enabled?
+
+      out = []
+
+      out << top if top?
+
+      viewport[0...height].each do |line|
+        out << [left, line[0...width], right].flatten
+      end
+
+      out << bottom if bottom?
+
+      out
+    end
+
+    private
+
+    attr_reader :attributes, :interface, :attributes
+
+    def bottom
+      return [] unless bottom?
+
+      out = []
+
+      out << bottom_left if left?
+      horizontal_border.each do |border|
+        out << border
+      end
+      out << bottom_right if right?
+
+      out
+    end
+
+    def left
+      return '' unless left?
+
+      vertical_border
+    end
+
+    def right
+      return '' unless right?
+
+      vertical_border
+    end
+
+    def top
+      return [] unless top?
+
+      out = []
+      out << top_left if left?
+      horizontal_border.each do |border|
+        out << border
+      end
+      out << top_right if right?
+
+      out
+    end
+
+    def bottom_left
+      [*presentation, on, bl, off, *reset].join
+    end
+
+    def bottom_right
+      [*presentation, on, br, off, *reset].join
+    end
+
+    def top_left
+      [*presentation, on, tl, off, *reset].join
+    end
+
+    def top_right
+      [*presentation, on, tr, off, *reset].join
+    end
+
+    def width
+      if left? && right?
+        interface.width - 2
+
+      elsif left? || right?
+        interface.width - 1
+
+      else
+        interface.width
+
+      end
+    end
+
+    def height
+      if top? && bottom?
+        interface.height - 2
+
+      elsif top? || bottom?
+        interface.height - 1
+
+      else
+        interface.height
+
+      end
+    end
+
+    def horizontal_border
+      [[*presentation, on, h, off, *reset].join] * width
+    end
+
+    def horizontal_space
+      [' '] * width
+    end
+
+    def vertical_border
+      [*presentation, on, v, off, *reset].join
+    end
+
+    def h
+      attributes[:horizontal]
+    end
+
+    def v
+      attributes[:vertical]
+    end
+
+    def tr
+      attributes[:top_right]
+    end
+
+    def tl
+      attributes[:top_left]
+    end
+
+    def br
+      attributes[:bottom_right]
+    end
+
+    def bl
+      attributes[:bottom_left]
+    end
+
+    def on
+      "\e(0"
+    end
+
+    def off
+      "\e(B"
+    end
+
+    def viewport
+      interface.viewport
+    end
+
+    def presentation
+      [colour.to_s, style.to_s]
+    end
+
+    def reset
+      [interface.colour.to_s, interface.style.to_s]
+    end
+
+    # Returns a new Colour instance.
+    #
+    # @return [Colour]
+    def colour
+      @colour ||= Colour.new(attributes[:colour])
+    end
+
+    # Returns a new Style instance.
+    #
+    # @return [Style]
+    def style
+      @style ||= Style.new(attributes[:style])
+    end
+
+    # The default values for a new instance of Border.
+    #
+    # @return [Hash]
+    def defaults
+      {
+        enabled:      false,
+        show_bottom:  true,
+        show_left:    true,
+        show_right:   true,
+        show_top:     true,
+        bottom_right: "\x6A", # ┘
+        top_right:    "\x6B", # ┐
+        top_left:     "\x6C", # ┌
+        bottom_left:  "\x6D", # └
+        horizontal:   "\x71", # ─
+        colour:       {},
+        style:        [],
+        vertical:     "\x78", # │
+      }
+    end
+
+  end # Border
+
+end # Vedeu