vedeu 0.4.34 → 0.4.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 627cd72e48091fbe2959ffc08efac5353a7af4cb
-  data.tar.gz: f027bb4b0648c2dce85949bdb8b381ba7eb09408
+  metadata.gz: 84b194d5028029767ac815eb90fee5806af559ed
+  data.tar.gz: ecce8b75baa7b87fd03f18ffb491034659febff9
 SHA512:
-  metadata.gz: 05fdee8984b672ea21e8fd03b29139dfcaa237ec93db32c2d7d4afa63ba421656caff81caa6cf580682cb66184e8fbbc67b331c96c9c2a16a67bb4d725b853d0
-  data.tar.gz: 50e6af9ada7c570262c426c493a330ab39897d4218e635bd151540d5c3a719a1eb0233d2280aef038ebd2b2aaa396030968ba068e9e51c5bcec8828bc6dcd4a0
+  metadata.gz: cf0641babb32ff61b8511a02c7898cabc04c0622b16557c72a5b61590caf7dea14b5eae9c3b5ebfcfb4ef8d51dd988f41a79b92cecb589e0be45c54cd1d68484
+  data.tar.gz: a9c5358c3c7b08293b26b8f57f3d3f69ed352b58184a684a54b8b16bfdf3349e0784ba62750ef8b82d51549fed272ffd3b339bd1f3bd1a4e3cd8a4b2ed09f487

data/examples/view_templates_app/default.erb

@@ -0,0 +1,4 @@
+This example shows the 'default' mode.
+Content is not pruned or wrapped.
+
+<%= time_now %>

data/examples/view_templates_app/prune.erb

@@ -0,0 +1,4 @@
+This example shows the 'prune' mode.
+Content is pruned at 22 characters.
+
+<%= time_now %>

data/examples/view_templates_app/view_templates_app.rb

@@ -8,73 +8,79 @@ require 'vedeu'
 # An example application to demonstrate templates.
 class VedeuViewTemplateApp
 
-  include Vedeu
-
-  configure do
+  Vedeu.configure do
     debug!
     log '/tmp/vedeu_view_templates_app.log'
   end
 
-  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-  interface 'default' do
+  Vedeu.interface 'default' do
     colour foreground: '#ff0000', background: '#000000'
     cursor!
   end
 
-  interface 'prune' do
+  Vedeu.interface 'prune' do
     colour foreground: '#00ff00', background: '#000000'
     cursor!
   end
 
-  interface 'wrap' do
+  Vedeu.interface 'wrap' do
     colour foreground: '#0000ff', background: '#000000'
     cursor!
   end
 
-  keymap('_global_') do
+  Vedeu.keymap('_global_') do
     key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
   end
 
-  border('default') do
+  Vedeu.border('default') do
     colour foreground: '#aadd00', background: '#000000'
   end
-  border('prune') do
+  Vedeu.border('prune') do
     colour foreground: '#00aadd', background: '#000000'
   end
-  border('wrap') do
+  Vedeu.border('wrap') do
     colour foreground: '#dd00aa', background: '#000000'
   end
 
-  geometry('prune') do
+  Vedeu.geometry('prune') do
     centred!
     height 6
     width  25
   end
 
-  geometry 'default' do
+  Vedeu.geometry 'default' do
     height 6
     width  25
     x      use('prune').left
     y      use('prune').north(7)
   end
 
-  geometry 'wrap' do
+  Vedeu.geometry 'wrap' do
     height 6
     width  25
     x      use('prune').left
     y      use('prune').south(1)
   end
 
-  renders do
-    template_for('default', (File.dirname(__FILE__) + '/template.erb'), nil)
-    template_for('prune', (File.dirname(__FILE__) + '/template.erb'), nil,
-                 mode: :prune, width: 22)
-    template_for('wrap', (File.dirname(__FILE__) + '/template.erb'), nil,
-                 mode: :wrap, width: 25)
+  def self.default_template
+    File.dirname(__FILE__) + '/default.erb'
+  end
+  def self.prune_template
+    File.dirname(__FILE__) + '/prune.erb'
+  end
+  def self.wrap_template
+    File.dirname(__FILE__) + '/wrap.erb'
+  end
+
+  Vedeu.renders do
+    template_for('default', default_template, nil)
+    template_for('prune', prune_template, nil, mode: :prune, width: 22)
+    template_for('wrap', wrap_template, nil, mode: :wrap, width: 25)
   end
 
   def self.start(argv = ARGV)

data/examples/view_templates_app/wrap.erb

@@ -0,0 +1,4 @@
+This example shows the 'wrap' mode.
+Content is wrapped at 25 characters.
+
+<%= time_now %>

data/lib/vedeu/output/all.rb

@@ -17,3 +17,4 @@ require_relative 'output'
 require_relative 'viewport'
 require_relative 'virtual_terminal'
 require_relative 'wordwrap'
+require_relative 'view_helpers/all'

data/lib/vedeu/output/colour.rb

@@ -40,22 +40,7 @@ module Vedeu
     # @param value []
     # @return [Object]
     def self.coerce(value)
-      return value if value.is_a?(self)
-      return new unless value.is_a?(Hash)
-
-      if value[:colour]
-        return value[:colour] if value[:colour].is_a?(self)
-        return new unless value[:colour].is_a?(Hash)
-        return new(value[:colour]) if value[:colour][:background] ||
-                                      value[:colour][:foreground]
-
-      elsif value[:background] || value[:foreground]
-        new(value)
-
-      else
-        new
-
-      end
+      Vedeu::ColourCoercer.coerce(value)
     end
 
     # Returns a new instance of Vedeu::Colour.

data/lib/vedeu/output/view_helpers/all.rb

@@ -0,0 +1,7 @@
+require 'vedeu/output/view_helpers/view_helpers'
+
+module Vedeu
+
+
+
+end # Vedeu

data/lib/vedeu/output/view_helpers/view_helpers.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # This module can be included client application classes to provide various
+  # further functionality and simplify Vedeu view construction.
+  #
+  module ViewHelpers
+
+    def time_now
+      Time.now.strftime('%a %e %b %k:%M')
+    end
+
+  end # ViewHelpers
+
+end # Vedeu

data/lib/vedeu/output/wordwrap.rb

@@ -55,7 +55,7 @@ module Vedeu
     # @return [String]
     def wrap
       processed = []
-      text.split(/\n/).map do |unprocessed|
+      split_lines.map do |unprocessed|
         line_length = 0
         reformatted = []
 

data/lib/vedeu/support/all.rb

@@ -1,3 +1,4 @@
+require_relative 'colour_coercer'
 require_relative 'common'
 require_relative 'options'
 require_relative 'template'

data/lib/vedeu/support/colour_coercer.rb

@@ -0,0 +1,97 @@
+module Vedeu
+
+  class ColourCoercer
+
+    # @param value [Vedeu::Colour|Hash<Symbol => Fixnum|String|Symbol>]
+    # @return [Vedeu::Colour]
+    def self.coerce(value)
+      new(value).coerce
+    end
+
+    # @param value [Hash<Symbol => Fixnum|String|Symbol>]
+    def self.from_hash(value)
+      new(value).from_hash
+    end
+
+    # @param value [Vedeu::Colour|Hash<Symbol => Fixnum|String|Symbol]
+    # @return [Vedeu::ColourCoercer]
+    def initialize(value)
+      @value = value
+    end
+
+    # @return [Vedeu::Colour]
+    def coerce
+      return value if colour?
+
+      if hash?
+        Vedeu::ColourCoercer.from_hash(value)
+
+      else
+        build
+
+      end
+    end
+
+    # @return [Vedeu::Colour]
+    def from_hash
+      return build unless value
+
+      if colour_key?
+        Vedeu::ColourCoercer.coerce(value[:colour])
+
+      elsif background? || foreground?
+        build_from_hash(value)
+
+      else
+        build
+
+      end
+    end
+
+    protected
+
+    # @!attribute [r] colour
+    # @return [void]
+    attr_reader :value
+
+    private
+
+    # @return [Vedeu::Colour]
+    def build
+      Vedeu::Colour.new
+    end
+
+    # @param value [Hash<Symbol => Fixnum|String|Symbol>]
+    # @return [Vedeu::Colour]
+    def build_from_hash(value)
+      Vedeu::Colour.new(value)
+    end
+
+    # @return [Boolean]
+    def colour?
+      value.is_a?(Vedeu::Colour)
+    end
+
+    # @return [Boolean]
+    def hash?
+      value.is_a?(Hash)
+    end
+
+    # @return [Boolean]
+    def background?
+      value.key?(:background)
+    end
+
+    # @return [Boolean]
+    def colour_key?
+      value.key?(:colour)
+    end
+
+    # @return [Boolean]
+    def foreground?
+      value.key?(:foreground)
+    end
+
+  end # ColourCoercer
+
+end # Vedeu

data/lib/vedeu/support/template.rb

@@ -5,6 +5,8 @@ module Vedeu
   # @api private
   class Template
 
+    include Vedeu::ViewHelpers
+
     # @param (see Vedeu::Template#new)
     # @return [void]
     def self.parse(object, path, options = {})

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.34'
+  VERSION = '0.4.35'
 
 end

data/test/lib/vedeu/output/view_helpers/view_helpers_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module Vedeu
+
+  class ViewHelpersTestClass
+
+    include Vedeu::ViewHelpers
+
+  end
+
+  describe ViewHelpers do
+
+    let(:described) { ViewHelpers }
+    let(:instance)  { ViewHelpersTestClass.new }
+
+    describe '#time_now' do
+      let(:_time) { Time.new(2015, 6, 23, 22, 25, 17) }
+
+      before { Time.stubs(:now).returns(_time) }
+
+      subject { instance.time_now }
+
+      it 'returns a formatted time' do
+        subject.must_equal('Tue 23 Jun 22:25')
+      end
+    end
+
+  end # ViewHelpers
+
+end # Vedeu

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

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+module Vedeu
+
+  describe ColourCoercer do
+
+    let(:described) { Vedeu::ColourCoercer }
+    let(:instance)  { described.new(_value) }
+    let(:_value)    { }
+
+    describe '#initialize' do
+      subject { instance }
+    end
+
+    describe '.coerce' do
+      it { described.must_respond_to(:coerce) }
+    end
+
+    describe '.from_hash' do
+      it { described.must_respond_to(:from_hash) }
+    end
+
+    describe '#coerce' do
+      subject { instance.coerce }
+
+      context 'when no value is given' do
+        it { subject.must_be_instance_of(Vedeu::Colour) }
+      end
+
+      context 'when a value is given' do
+        context 'when the value is a Vedeu::Colour' do
+          let(:_value) { Vedeu::Colour.new }
+
+          it { subject.must_equal(_value) }
+        end
+
+        context 'when the value is a Hash' do
+          let(:_value) { { } }
+
+          it {
+            Vedeu::ColourCoercer.expects(:from_hash).with(_value)
+            subject
+          }
+        end
+      end
+    end
+
+    describe '#from_hash' do
+      subject { instance.from_hash }
+
+      context 'when no value is given' do
+        it { subject.must_be_instance_of(Vedeu::Colour) }
+      end
+
+      context 'when a value is given' do
+        context 'when the value has a :colour key' do
+          let(:_value) { { colour: colour_value } }
+          let(:colour_value) { Vedeu::Colour.new }
+
+          it {
+            Vedeu::ColourCoercer.expects(:coerce).with(colour_value)
+            subject
+          }
+        end
+
+        context 'when the value has a :background or :foreground key' do
+          let(:_value) { { background: '#000000', foreground: '#ffffff' } }
+
+          it {
+            Vedeu::Colour.expects(:new).with(_value)
+            subject
+          }
+        end
+
+        context 'when the value is empty or has unhandled keys' do
+          let(:_value) { { unhandled: :some_value } }
+
+          it { subject.must_be_instance_of(Vedeu::Colour) }
+        end
+      end
+    end
+
+  end # ColourCoercer
+
+end # Vedeu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.34
+  version: 0.4.35
 platform: ruby
 authors:
 - Gavin Laking
@@ -282,8 +282,10 @@ files:
 - examples/typed_commands/output.erb
 - examples/typed_commands/status.erb
 - examples/typed_commands/typed_commands_app.rb
-- examples/view_templates_app/template.erb
+- examples/view_templates_app/default.erb
+- examples/view_templates_app/prune.erb
 - examples/view_templates_app/view_templates_app.rb
+- examples/view_templates_app/wrap.erb
 - features/start_stop.feature
 - features/support/env.rb
 - inch.yml
@@ -395,6 +397,8 @@ files:
 - lib/vedeu/output/templates/html_renderer.vedeu
 - lib/vedeu/output/text.rb
 - lib/vedeu/output/translator.rb
+- lib/vedeu/output/view_helpers/all.rb
+- lib/vedeu/output/view_helpers/view_helpers.rb
 - lib/vedeu/output/viewport.rb
 - lib/vedeu/output/virtual_buffer.rb
 - lib/vedeu/output/virtual_terminal.rb
@@ -424,6 +428,7 @@ files:
 - lib/vedeu/storage/fifo_store.rb
 - lib/vedeu/storage/store.rb
 - lib/vedeu/support/all.rb
+- lib/vedeu/support/colour_coercer.rb
 - lib/vedeu/support/common.rb
 - lib/vedeu/support/log.rb
 - lib/vedeu/support/options.rb
@@ -521,6 +526,7 @@ files:
 - test/lib/vedeu/output/style_test.rb
 - test/lib/vedeu/output/text_test.rb
 - test/lib/vedeu/output/translator_test.rb
+- test/lib/vedeu/output/view_helpers/view_helpers_test.rb
 - test/lib/vedeu/output/viewport_test.rb
 - test/lib/vedeu/output/virtual_buffer_test.rb
 - test/lib/vedeu/output/virtual_terminal_test.rb
@@ -547,6 +553,7 @@ files:
 - test/lib/vedeu/storage/conveyor_store_test.rb
 - test/lib/vedeu/storage/fifo_store_test.rb
 - test/lib/vedeu/storage/store_test.rb
+- test/lib/vedeu/support/colour_coercer_test.rb
 - test/lib/vedeu/support/common_test.rb
 - test/lib/vedeu/support/log_test.rb
 - test/lib/vedeu/support/options_test.rb
@@ -675,6 +682,7 @@ test_files:
 - test/lib/vedeu/output/style_test.rb
 - test/lib/vedeu/output/text_test.rb
 - test/lib/vedeu/output/translator_test.rb
+- test/lib/vedeu/output/view_helpers/view_helpers_test.rb
 - test/lib/vedeu/output/viewport_test.rb
 - test/lib/vedeu/output/virtual_buffer_test.rb
 - test/lib/vedeu/output/virtual_terminal_test.rb
@@ -701,6 +709,7 @@ test_files:
 - test/lib/vedeu/storage/conveyor_store_test.rb
 - test/lib/vedeu/storage/fifo_store_test.rb
 - test/lib/vedeu/storage/store_test.rb
+- test/lib/vedeu/support/colour_coercer_test.rb
 - test/lib/vedeu/support/common_test.rb
 - test/lib/vedeu/support/log_test.rb
 - test/lib/vedeu/support/options_test.rb

data/examples/view_templates_app/template.erb

@@ -1,8 +0,0 @@
-Here's a simple example that will be displayed in the main interface of the
-application. It's a multi-line affair, composed of words, punctuation and
-with no doubt, bad grammar. An empty line follows:
-
-Now, this line contains a <%= colours({ fg: '#ff0000', bg: '#000000' }) { 'red' } %> word. Whilst
-this has a <% foreground('#33aa33') do %>green foreground<% end %> or
-<% background('#33aa33') do %>green background<% end %>. There's also a short
-syntax being used <%= fg('#0000ff') { 'here' } %> and <%= bg('#0000ff') { 'here' } %>.