vedeu 0.6.7 → 0.6.8

data/lib/vedeu/log/log.rb

@@ -1,172 +0,0 @@
-module Vedeu
-
-  # Provides the ability to log anything to the Vedeu log file.
-  #
-  class Log
-
-    class << self
-
-      # Write a message to the Vedeu log file.
-      #
-      # @example
-      #   Vedeu.log(type: :debug, message: 'A useful debugging message: Error!')
-      #
-      # @param message [String] The message you wish to emit to the log file,
-      #   useful for debugging.
-      # @param force [Boolean] When evaluates to true will attempt to write to
-      #   the log file regardless of the Configuration setting.
-      # @param type [Symbol] Colour code messages in the log file depending
-      #   on their source. See {message_types}
-      #
-      # @return [TrueClass]
-      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))
-          logger.debug(output)
-        end
-
-        output
-      end
-
-      # Write a message to STDOUT.
-      #
-      # @example
-      #   Vedeu.log_stdout
-      #
-      # @return [TrueClass]
-      def log_stdout(type: :info, message:)
-        $stdout.puts log_entry(type, message)
-      end
-
-      # Write a message to STDERR.
-      #
-      # @example
-      #   Vedeu.log_stderr
-      #
-      # @return [TrueClass]
-      def log_stderr(type: :info, message:)
-        $stderr.puts log_entry(type, message)
-      end
-
-      private
-
-      # @return [TrueClass]
-      def logger
-        MonoLogger.new(log_file).tap do |log|
-          log.formatter = proc do |_, _, _, message|
-            formatted_message(message)
-          end
-        end
-      end
-
-      # Returns the message with timestamp.
-      #
-      #    [ 0.0987] [debug]  Something happened.
-      #
-      # @param message [String] The message type and message coloured and
-      #   combined.
-      # @return [String]
-      def formatted_message(message)
-        "#{timestamp}#{message}\n" if message
-      end
-
-      # Returns the message:
-      #
-      #     [type] message
-      #
-      # @param type [Symbol] The type of log message.
-      # @param message [String] The message you wish to emit to the log file,
-      #   useful for debugging.
-      # @return [String]
-      def log_entry(type, message)
-        "#{message_type(type)}#{message_body(type, message)}"
-      end
-
-      # Fetches the filename from the configuration.
-      #
-      # @return [String]
-      def log_file
-        Vedeu::Configuration.log
-      end
-      alias_method :enabled?, :log_file
-
-      # Displays the message body using the colour specified in the last element
-      # of {message_types}.
-      #
-      # @param type [Symbol] The type of log message.
-      # @param body [String] The log message itself.
-      # @return [String]
-      def message_body(type, body)
-        Vedeu::Esc.send(message_types.fetch(type, :default)[-1]) do
-          body
-        end
-      end
-
-      # Displays the message type using the colour specified in the first
-      # element of {message_types}.
-      #
-      # @param type [Symbol] The type of log message.
-      # @return [String]
-      def message_type(type)
-        Vedeu::Esc.send(message_types.fetch(type, :default)[0]) do
-          "[#{type}]".ljust(9)
-        end
-      end
-
-      # The defined message types for Vedeu with their respective colours.
-      # When used, produces a log entry of the format:
-      #
-      #     [type] message
-      #
-      # The 'type' will be shown as the first colour defined in the value
-      # array, whilst the 'message' will be shown using the last colour.
-      #
-      # Valid types available:
-      #
-      #     :config, :create, :debug, :error, :drb, :event, :info, :input,
-      #     :output, :reset, :store, :test, :timer, :update
-      #
-      # @return [Hash<Symbol => Array<Symbol>>]
-      def message_types
-        {
-          config: [:light_yellow,  :yellow],
-          create: [:light_green,   :green],
-          debug:  [:light_red,     :red],
-          error:  [:light_red,     :red],
-          drb:    [:light_blue,    :blue],
-          event:  [:light_magenta, :magenta],
-          info:   [:white,         :default],
-          input:  [:light_yellow,  :yellow],
-          output: [:light_green,   :green],
-          reset:  [:light_cyan,    :cyan],
-          store:  [:light_cyan,    :cyan],
-          test:   [:light_white,   :white],
-          timer:  [:light_yellow,  :yellow],
-          update: [:light_cyan,    :cyan],
-        }
-      end
-
-      # Returns a formatted timestamp.
-      # eg. [137.7824]
-      #
-      # @return [String]
-      def timestamp
-        @now  = Time.now.to_f
-        @time = 0.0  unless @time
-        @last = @now unless @last
-
-        unless @last == @time
-          @time += (@now - @last).round(4)
-          @last = @now
-        end
-
-        "[#{format('%7.4f', @time.to_s)}] ".rjust(7)
-      end
-
-    end # Eigenclass
-
-  end # Log
-
-end # Vedeu

data/lib/vedeu/log/mono_logger.rb

@@ -1,21 +0,0 @@
-module Vedeu
-
-  # Allows the creation of a lock-less log device.
-  #
-  class MonoLogger < Logger
-
-    # Create a trappable Logger instance.
-    #
-    # @param logdev [String|IO] The filename (String) or IO object (typically
-    #   STDOUT, STDERR or an open file).
-    # @return [Vedeu::MonoLogger]
-    def initialize(logdev)
-      @level             = Logger::DEBUG
-      @default_formatter = Logger::Formatter.new
-      @formatter         = nil
-      @logdev            = Vedeu::LocklessLogDevice.new(logdev) if logdev
-    end
-
-  end # MonoLogger
-
-end # Vedeu

data/lib/vedeu/log/timer.rb

@@ -1,63 +0,0 @@
-module Vedeu
-
-  # Measure the duration. Used for debugging.
-  #
-  class Timer
-
-    class << self
-
-      # @example
-      #   Vedeu.timer 'message' do
-      #     # ... code to be measured
-      #   end
-      #
-      # @param message [String]
-      # @param block [Proc]
-      # @return [void] The return value of the executed block.
-      def timer(message = '', &block)
-        new(message).measure(&block)
-      end
-
-    end # Eigenclass
-
-    # Returns a new instance of Vedeu::Timer.
-    #
-    # @param message [String]
-    # @return [Vedeu::Timer]
-    def initialize(message = '')
-      @message = message
-      @started = Time.now.to_f
-    end
-
-    # Write an entry to the log file stating how long a section of code took in
-    # milliseconds. Useful for debugging performance.
-    #
-    # @return [void] The return value of the executed block.
-    def measure
-      work = yield
-
-      Vedeu.log(type: :timer, message: "#{message} took #{elapsed}ms.")
-
-      work
-    end
-
-    protected
-
-    # @!attribute [r] started
-    # @return [Time]
-    attr_reader :started
-
-    # @!attribute [r] message
-    # @return [String]
-    attr_reader :message
-
-    # Returns the elapsed time in milliseconds with 3 decimal places.
-    #
-    # @return [Float]
-    def elapsed
-      ((Time.now.to_f - started) * 1000).round(3)
-    end
-
-  end # Timer
-
-end # Vedeu

data/lib/vedeu/models/menu.rb

@@ -1,217 +0,0 @@
-module Vedeu
-
-  # Converts the collection passed into a list of menu items which can be
-  # navigated using the instance methods or events provided.
-  #
-  class Menu
-
-    include Vedeu::Model
-
-    # @!attribute [rw] collection
-    # @return [Array]
-    attr_accessor :collection
-
-    # Returns the index of the value in the collection which is current.
-    #
-    # @!attribute [rw] current
-    # @return [Fixnum]
-    attr_accessor :current
-
-    # The name of the menu. Used to reference the menu throughout the
-    # application's execution lifetime.
-    #
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
-
-    # Returns the index of the value in the collection which is selected.
-    #
-    # @!attribute [rw] selected
-    # @return [Fixnum]
-    attr_accessor :selected
-
-    # Register a menu by name which will display a collection of items for
-    # your users to select; and provide interactivity within your application.
-    #
-    # @param name [String]
-    # @param block [Proc] A set of attributes which define the features of the
-    #   menu. See {Vedeu::DSL::Menu#items} and {Vedeu::DSL::Menu#name}.
-    #
-    # @example
-    #   Vedeu.menu 'my_interface' do
-    #     items [:item_1, :item_2, :item_3]
-    #     # ...
-    #   end
-    #
-    #   Vedeu.menu do
-    #     name 'menus_must_have_a_name'
-    #     items Track.all_my_favourites
-    #     # ...
-    #   end
-    #
-    # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-    # @return [API::Menu]
-    def self.menu(name = '', &block)
-      fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
-
-      build(name: name, &block).store
-    end
-
-    # Returns a new instance of Vedeu::Menu.
-    #
-    # @param attributes [Hash]
-    # @option attributes collection [Array]
-    # @option attributes name [String]
-    # @option attributes current [Fixnum]
-    # @option attributes selected [Fixnum|NilClass]
-    # @return [Vedeu::Menu]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Returns the item from the collection which shares the same index as the
-    # value of {Vedeu::Menu#current}.
-    #
-    # @return [void]
-    def current_item
-      @collection[@current]
-    end
-
-    # Returns the item from the collection which shares the same index as the
-    # value of {Vedeu::Menu#selected}.
-    #
-    # @return [|NilClass]
-    def selected_item
-      return nil unless @selected
-
-      @collection[@selected]
-    end
-
-    # Returns a new collection of items.
-    # Each element of the collection is of the format:
-    #
-    #   [selected, current, item]
-    #
-    # `selected` is a boolean indicating whether the item is selected.
-    # `current`  is a boolean indicating whether the item is current.
-    # `item`     is the item itself.
-    #
-    # @return [Array]
-    def items
-      items = []
-      @collection.each_with_index do |item, index|
-        if index == @current && index == @selected
-          items << [true, true, item]
-
-        elsif index == @current
-          items << [false, true, item]
-
-        elsif index == @selected
-          items << [true, false, item]
-
-        else
-          items << [false, false, item]
-
-        end
-      end
-      items
-    end
-
-    # Returns a subset of all the items.
-    #
-    # @return [Array]
-    def view
-      items[@current, @collection.size]
-    end
-
-    # Sets the value of current to be the first item of the collection.
-    #
-    # @return [Array]
-    def top_item
-      @current = 0
-
-      items
-    end
-
-    # Sets the value of current to be the last item of the collection.
-    #
-    # @return [Array]
-    def bottom_item
-      @current = last
-
-      items
-    end
-
-    # Sets the value of current to be the next item in the collection until we
-    # reach the last.
-    #
-    # @return [Array]
-    def next_item
-      @current += 1 if @current < last
-
-      items
-    end
-
-    # Sets the value of current to be the previous item in the collection until
-    # we reach the first.
-    #
-    # @return [Array]
-    def prev_item
-      @current -= 1 if @current > 0
-
-      items
-    end
-
-    # Sets the selected item to be the same value as the current item.
-    #
-    # @return [Array]
-    def select_item
-      @selected = @current
-
-      items
-    end
-
-    # Removes the value of `selected`, meaning no items are selected.
-    #
-    # @return [Array]
-    def deselect_item
-      @selected = nil
-
-      items
-    end
-
-    # Returns the last index of the collection.
-    #
-    # @return [Fixnum]
-    def last
-      @collection.size - 1
-    end
-
-    # Returns the size of the collection.
-    #
-    # @return [Fixnum]
-    def size
-      @collection.size
-    end
-
-    private
-
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        client:     nil,
-        collection: [],
-        current:    0,
-        name:       '',
-        repository: Vedeu.menus,
-        selected:   nil,
-      }
-    end
-
-  end # Menu
-
-end # Vedeu

data/lib/vedeu/models/menus.rb

@@ -1,14 +0,0 @@
-module Vedeu
-
-  # Allows the storing of menus by name.
-  #
-  class Menus < Vedeu::Repository
-
-    singleton_class.send(:alias_method, :menus, :repository)
-
-    real Vedeu::Menu
-    null Vedeu::Null::Menu
-
-  end # Menus
-
-end # Vedeu

data/lib/vedeu/output/html_char.rb

@@ -1,161 +0,0 @@
-module Vedeu
-
-  # Represents a {Vedeu::Views::Char} as a HTML tag with value. By default, a
-  # table cell is used.
-  #
-  class HTMLChar
-
-    include Vedeu::Common
-
-    # @param char [Vedeu::Views::Char]
-    # @param options [Hash<Symbol => String>]
-    # @option options start_tag [String]
-    # @option options end_tag [String]
-    # @return [String]
-    def self.render(char, options = {})
-      new(char, options).render
-    end
-
-    # Returns a new instance of Vedeu::HTMLChar.
-    #
-    # @param char [Vedeu::Views::Char]
-    # @param options [Hash<Symbol => String>]
-    # @option options start_tag [String]
-    # @option options end_tag [String]
-    # @return [Vedeu::HTMLChar]
-    def initialize(char, options = {})
-      @char    = char
-      @options = options
-    end
-
-    # @return [String]
-    def render
-      "#{start_tag}#{tag_style}>#{tag_value}#{end_tag}"
-    end
-
-    protected
-
-    # @!attribute [r] char
-    # @return [Vedeu::Views::Char]
-    attr_reader :char
-
-    private
-
-    # @return [String]
-    def tag_style
-      return '' unless border || present?(value)
-
-      out = " style='"
-      out << tag_style_background unless char.background.empty?
-      out << tag_style_foreground unless char.foreground.empty?
-      out << "'"
-    end
-
-    # @return [String]
-    def tag_style_background
-      "border:1px #{char.background.to_html} solid;" \
-        "background:#{char.background.to_html};"
-    end
-
-    # @return [String]
-    def tag_style_foreground
-      "color:#{char.foreground.to_html};#{border_style}"
-    end
-
-    # @return [String]
-    def tag_value
-      return '&nbsp;' if border || !present?(value)
-
-      value
-    end
-
-    # @return [String]
-    def border_style
-      case border
-      when :top_horizontal    then css('top')
-      when :left_vertical     then css('left')
-      when :right_vertical    then css('right')
-      when :bottom_horizontal then css('bottom')
-      when :top_left     then "#{css('top')}#{css('left')}"
-      when :top_right    then "#{css('top')}#{css('right')}"
-      when :bottom_left  then "#{css('bottom')}#{css('left')}"
-      when :bottom_right then "#{css('bottom')}#{css('right')}"
-      else
-        ''
-      end
-    end
-
-    # @return [String]
-    def css(direction = '')
-      "border-#{direction}:1px #{char.foreground.to_html} solid;"
-    end
-
-    # # @return [String]
-    # def fg
-    #   @fg ||= colour(char, 'foreground', '#222')
-    # end
-
-    # # @return [String]
-    # def bg
-    #   @bg ||= colour(char, 'background', '#000')
-    # end
-
-    # @param char [Vedeu::Views::Char]
-    # @param type [String] 'background' or 'foreground'
-    # @param default [String] A default colour (CSS style; e.g. '#b2adf2')
-    # @return [String]
-    # def colour(char, type, default)
-    #   parent_type         = char.send(:parent).send(type).send(:to_html)
-    #   #parent_type         = ('parent_' + type).to_sym
-    #   type_to_html        = char.send(type).send(:to_html)
-    #   #parent_type_to_html = char.send(parent_type).send(:to_html)
-
-    #   if present?(type_to_html)
-    #     type_to_html
-
-    #   elsif char.parent
-    #     parent_type
-    #     #char.parent.send(type).send(:to_html)
-
-    #   else
-    #     default
-
-    #   end
-    # end
-
-    # @return [Symbol|NilClass]
-    def border
-      char.border
-    end
-
-    # @return [String]
-    def value
-      char.value
-    end
-
-    # @return [String]
-    def start_tag
-      options[:start_tag]
-    end
-
-    # @return [String]
-    def end_tag
-      options[:end_tag]
-    end
-
-    # @return [Hash<Symbol => String>]
-    def options
-      defaults.merge!(@options)
-    end
-
-    # @return [Hash<Symbol => String>]
-    def defaults
-      {
-        start_tag: '<td',
-        end_tag:   '</td>',
-      }
-    end
-
-  end # HTMLChar
-
-end # Vedeu

data/test/lib/vedeu/input/input_translator_test.rb

@@ -1,32 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  describe InputTranslator do
-
-    let(:described) { Vedeu::InputTranslator }
-    let(:instance)  { described.new(code) }
-    let(:code)      {}
-
-    describe '#initialize' do
-      it { instance.must_be_instance_of(described) }
-      it { instance.instance_variable_get('@code').must_equal(code) }
-    end
-
-    describe '.translate' do
-      context 'when the code is not recognised' do
-        it { described.translate('a').must_equal('a') }
-      end
-
-      context 'when the code is recognised' do
-        it { described.translate("\e[H").must_equal(:home) }
-      end
-    end
-
-    describe '#translate' do
-      it { instance.must_respond_to(:translate) }
-    end
-
-  end # InputTranslator
-
-end # Vedeu

data/test/lib/vedeu/log/debug_test.rb

@@ -1,35 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  describe Debug do
-
-    let(:described) { Vedeu::Debug }
-
-    before do
-      File.stubs(:open).with('/tmp/profile.html', 'w').returns(:some_code)
-    end
-
-    describe '.debug' do
-      let(:filename)  { 'profile.html' }
-      let(:some_code) { :some_code }
-
-      context 'when the block is not given' do
-        subject { described.debug(filename) }
-
-        it { subject.must_equal(nil) }
-      end
-
-      context 'when the block is given' do
-        subject { described.debug(filename) { some_code } }
-
-        it {
-          ::File.expects(:open).with('/tmp/profile.html', 'w')
-          subject
-        }
-      end
-    end
-
-  end # Debug
-
-end # Vedeu