vedeu 0.2.12 → 0.3.0

data/lib/vedeu/support/keymap_validator.rb

@@ -1,100 +0,0 @@
-module Vedeu
-
-  # Validates that a given key is can be used and is not already in-use, either
-  # by the same interface, globally or as a system key.
-  #
-  # @api private
-  class KeymapValidator
-
-    include Common
-
-    # Checks the key is not in use by the system, is not already defined as a
-    # global key, is not already defined for the interface specified.
-    #
-    # @param storage [Hash]
-    # @param key [String|Symbol]
-    # @param interface [String]
-    # @return [Array] A boolean indicating validity, and a helpful message.
-    def self.check(storage, key, interface = '')
-      new(storage, key, interface).check
-    end
-
-    # Instantiates a new KeymapValidator instance.
-    #
-    # @param storage [Hash]
-    # @param key [String|Symbol]
-    # @param interface [String]
-    # @return [KeymapValidator]
-    def initialize(storage, key, interface = '')
-      @storage, @key, @interface = storage, key, interface
-    end
-
-    # @raise [KeyInUse] When the key is already in use.
-    # @see KeymapValidator.check
-    def check
-      if system_key?(key)
-        fail KeyInUse, "'#{key}' is already in use by the system."
-
-      elsif global_key?(key)
-        fail KeyInUse, "'#{key}' is already in use as a global key."
-
-      elsif interface_key?(key, interface)
-        if defined_value?(interface)
-          fail KeyInUse, "'#{key}' is already in use by this interface."
-
-        else
-          fail KeyInUse, "'#{key}' is already in use and cannot be global."
-
-        end
-      end
-
-      true
-    end
-
-    private
-
-    attr_reader :storage, :key, :interface
-
-    # Returns a boolean indicating whether the key has been registered for the
-    # named interface's keymap. If no interface is specified, then it is
-    # assumed that the key is attempting to be registered globally, and so all
-    # interfaces are checked for this key. (A key cannot be global if an
-    # interface is using it.)
-    #
-    # @param key [String|Symbol]
-    # @param interface [String]
-    # @return [Boolean]
-    def interface_key?(key, interface = '')
-      if defined_value?(interface)
-        return false unless storage.key?(interface)
-
-        storage.fetch(interface).keys.include?(key)
-
-      else
-        storage.keys.reject do |keymap|
-          keymap == '_global_keymap_'
-        end.map { |name| storage[name].keys.include?(key) }.any?
-
-      end
-    end
-
-    # Returns a boolean indicating whether the key is in the global keymap.
-    #
-    # @param key [String|Symbol]
-    # @return [Boolean]
-    def global_key?(key)
-      storage.fetch('_global_keymap_').keys.include?(key)
-    end
-
-    # Returns a boolean indicating whether the key is in the system keymap.
-    # At present, it is not possible to redefine system keys.
-    #
-    # @param key [String|Symbol]
-    # @return [Boolean]
-    def system_key?(key)
-      Configuration.system_keys.values.include?(key)
-    end
-
-  end # KeymapValidator
-
-end # Vedeu

data/lib/vedeu/support/model.rb

@@ -1,14 +0,0 @@
-module Vedeu
-
-  module Model
-
-    attr_reader :repository
-
-    # @return [void] The model instance stored in the repository.
-    def store
-      repository.store(self)
-    end
-
-  end # Model
-
-end # Vedeu

data/lib/vedeu/support/presentation.rb

@@ -1,86 +0,0 @@
-module Vedeu
-
-  # This module allows the sharing of presentation concerns between the models:
-  # Interface, Line and Stream.
-  #
-  # @api private
-  module Presentation
-
-    # Returns the colour and style attributes of the receiving class.
-    #
-    # @return [Hash]
-    def view_attributes
-      {
-        colour: attributes[:colour],
-        style:  attributes[:style],
-      }
-    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
-
-    # Converts the colours and styles to escape sequences, and if the parent
-    # model has previously set the colour and style, reverts back to that for
-    # consistent formatting.
-    #
-    # @return [String]
-    def to_s
-      render_colour do
-        render_style do
-          data
-        end
-      end
-    end
-
-    private
-
-    # Renders the colour attributes of the receiver, yields (to then render the
-    # the styles) and once returned, attempts to set the colours back to the
-    # those of the receiver's parent.
-    #
-    # @return [String]
-    def render_colour(&block)
-      [ colour.to_s, yield, parent_colour ].join
-    end
-
-    # Renders the style attributes of the receiver, yields (to then render the
-    # next model, or finally, the content) and once returned, attempts to set
-    # the colours back to those of the receiver's parent.
-    #
-    # @return [String]
-    def render_style(&block)
-      [ style.to_s, yield, parent_style ].join
-    end
-
-    # Returns the parent colour as an escape sequence if set.
-    #
-    # @return [String]
-    def parent_colour
-      return '' if parent.nil?
-
-      Colour.new(parent[:colour]).to_s
-    end
-
-    # Returns the parent style as an escape sequence if set.
-    #
-    # @return [String]
-    def parent_style
-      return '' if parent.nil?
-
-      Style.new(parent[:style]).to_s
-    end
-
-  end # Presentation
-
-end # Vedeu

data/lib/vedeu/support/registrar.rb

@@ -1,53 +0,0 @@
-module Vedeu
-
-  # When the client application has defined an interface to be used, the
-  # Registrar stores the attributes into various repositories for later use.
-  #
-  # @api private
-  class Registrar
-
-    REPOSITORIES = [Buffers, Cursors, Groups, Interfaces, Offsets]
-
-    # @param attributes [Hash]
-    # @return [TrueClass|MissingRequired]
-    def self.record(attributes = {})
-      new(attributes).record
-    end
-
-    # Removes all entities from all repositories. Use with caution.
-    #
-    # @return [TrueClass]
-    def self.reset!
-      REPOSITORIES.each { |repository| repository.reset }
-
-      true
-    end
-
-    # @param attributes [Hash]
-    # @return [Registrar]
-    def initialize(attributes = {})
-      @attributes = attributes
-    end
-
-    # Adds the attributes to a variety of repositories to use later.
-    #
-    # @return [TrueClass|MissingRequired]
-    def record
-      focus
-
-      REPOSITORIES.each { |repository| repository.add(attributes) }
-
-      true
-    end
-
-    private
-
-    attr_reader :attributes
-
-    def focus
-      Focus.add(attributes[:name], attributes[:focus])
-    end
-
-  end # Registrar
-
-end # Vedeu

data/test/integration/api/api_test.rb

@@ -1,97 +0,0 @@
-require 'test_helper'
-
-describe 'Testing Vedeu::API methods' do
-
-  describe '.configure' do
-    it 'raises an exception when the required block is not given' do
-      proc { Vedeu.configure }.must_raise(Vedeu::InvalidSyntax)
-    end
-  end
-
-  describe '.defined' do
-    it 'returns the Vedeu::API::Defined module name' do
-      Vedeu.defined.must_equal(Vedeu::API::Defined)
-    end
-  end
-
-  describe '.event' do
-    it 'returns a list of event associated with the provided event name ' \
-    'after adding the event' do
-      skip 'Need to mock an event'
-      Vedeu.event(:_hydrogen_event_).must_equal('')
-    end
-
-    it 'should raise an exception when the event name is nil or empty' do
-      skip 'Need to raise an exception'
-      Vedeu.event(nil).must_equal('')
-    end
-  end
-
-  describe '.focus' do
-    it 'raises an exception when the interface does not exist' do
-      proc { Vedeu.focus(nil) }.must_raise(Vedeu::ModelNotFound)
-    end
-
-    it 'raises an exception when the interface does not exist' do
-      proc { Vedeu.focus('not_defined') }.must_raise(Vedeu::ModelNotFound)
-    end
-
-    it 'sets the specified interface as in focus' do
-      skip 'Finish this test off'
-      Vedeu.focus('hydrogen')
-    end
-  end
-
-  describe '.height' do
-    before { Vedeu::Terminal.console.stubs(:winsize).returns([25, 80]) }
-
-    it 'returns the height of the terminal' do
-      Vedeu.height.must_equal(25)
-    end
-  end
-
-  describe '.interface' do
-  end
-
-  describe '.keypress' do
-  end
-
-  describe '.keys' do
-  end
-
-  describe '.log' do
-  end
-
-  describe '.menu' do
-  end
-
-  describe '.render' do
-  end
-
-  describe '.resize' do
-  end
-
-  describe '.trigger' do
-  end
-
-  describe '.unevent' do
-  end
-
-  describe '.use' do
-  end
-
-  describe '.view' do
-  end
-
-  describe '.views' do
-  end
-
-  describe '.width' do
-    before { Vedeu::Terminal.console.stubs(:winsize).returns([25, 80]) }
-
-    it 'returns the width of the terminal' do
-      Vedeu.width.must_equal(80)
-    end
-  end
-
-end

data/test/integration/api_dsl/dsl_api_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL API tests' do
-end

data/test/integration/api_dsl/dsl_composition_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Composition tests' do
-end

data/test/integration/api_dsl/dsl_defined_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Defined tests' do
-end

data/test/integration/api_dsl/dsl_helpers_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Helpers tests' do
-end

data/test/integration/api_dsl/dsl_interface_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Interface tests' do
-end

data/test/integration/api_dsl/dsl_keymap.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Keymap tests' do
-end

data/test/integration/api_dsl/dsl_line_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Line tests' do
-end

data/test/integration/api_dsl/dsl_menu_test.rb

@@ -1,4 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Menu tests' do
-end

data/test/integration/api_dsl/dsl_stream_test.rb

@@ -1,138 +0,0 @@
-require 'test_helper'
-
-describe 'DSL Stream tests' do
-
-  # describe '#align' do
-  #   it ':left' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align :left
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-
-  #   it ':right' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align :right
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-
-  #   it ':centre' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align :centre
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-
-  #   it ':invalid' do
-  #     proc { Vedeu.view 'test' do
-  #              line do
-  #                stream do
-  #                  align :invalid
-  #                end
-  #              end
-  #     end }.must_raise(Vedeu::InvalidSyntax)
-  #   end
-
-  #   it ':right overriding :centre' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align :centre
-  #           align :right
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-  # end
-
-  # describe '#centre' do
-  #   it 'centre' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align centre
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-  # end
-
-  # describe '#left' do
-  #   it 'left' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align left
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-  # end
-
-  # describe '#right' do
-  #   it 'right' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           align right
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-  # end
-
-  # describe '#text' do
-  #   it 'text' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           text 'Some text...'
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-
-  #   it 'invalid' do
-  #     proc { Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           text
-  #         end
-  #       end
-  #     end }.must_raise(ArgumentError)
-  #   end
-  # end
-
-  # describe '#width' do
-  #   it 'width' do
-  #     Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           width 35
-  #         end
-  #       end
-  #     end.must_equal({})
-  #   end
-
-  #   it 'invalid' do
-  #     proc { Vedeu.view 'test' do
-  #       line do
-  #         stream do
-  #           width
-  #         end
-  #       end
-  #     end }.must_raise(ArgumentError)
-  #   end
-  # end
-
-end

data/test/integration/cursors_test.rb

@@ -1,9 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  describe 'Integrations: Testing cursors, offsets and viewports' do
-
-  end
-
-end # Vedeu

data/test/integration/defining_interfaces_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-class MyFirstApplication
-  include Vedeu
-
-  interface 'hydrogen' do
-    x       2
-    y       2
-    width   40
-    height  4
-    centred false
-    delay   0.25
-    group   'elements'
-  end
-
-  def initialize; end
-end
-
-describe 'Define an interface' do
-  it 'defines an interface' do
-    skip
-    MyFirstApplication.new
-
-    Vedeu.defined.interfaces.must_equal(['hydrogen'])
-  end
-end

data/test/integration/run_once_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-class MyFirstApplication
-  include Vedeu
-
-  interface 'hydrogen' do
-    x       2
-    y       2
-    width   50
-    height  2
-  end
-
-  def self.start
-    Vedeu::Launcher.new(['--run-once', '--noninteractive']).execute!
-  end
-end
-
-describe 'Run the application once, printing a message on the screen and ' \
-         'gracefully terminating.' do
-  it 'writes a message to the screen' do
-    skip
-    stdout, stderr = capture_io { MyFirstApplication.start }
-    stdout.must_equal('Great success! Now, try something a little harder.')
-    stderr.must_equal('')
-  end
-end