vedeu 0.1.15 → 0.1.16

data/lib/vedeu/{api → support}/grid.rb

@@ -1,4 +1,5 @@
 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
@@ -11,44 +12,47 @@ class Fixnum
   #                     # Terminal is 92 characters wide, maximum value is
   #                     # therefore 84, meaning a column is 7 characters wide.
   def columns
-     Vedeu::API::Grid.columns(self)
+     Vedeu::Grid.columns(self)
   end
 end
 
 module Vedeu
-  module API
-    OutOfRange = Class.new(StandardError)
+  class Grid
 
-    class Grid
-      def self.columns(value)
-        new(value).columns
-      end
+    # @param value [Fixnum]
+    # @return []
+    def self.columns(value)
+      new(value).columns
+    end
 
-      def initialize(value)
-        @value = value
-      end
+    # @param value [Fixnum]
+    # @return [Grid]
+    def initialize(value)
+      @value = value
+    end
 
-      def columns
-        fail OutOfRange, 'Valid range is 1..12.' if out_of_range?
+    # @return []
+    def columns
+      fail OutOfRange, 'Valid range is 1..12.' if out_of_range?
 
-        column * value
-      end
+      column * value
+    end
 
-      private
+    private
 
-      attr_reader :value
+    attr_reader :value
 
-      def column
-        actual / 12
-      end
+    def column
+      actual / 12
+    end
 
-      def actual
-        Terminal.width
-      end
+    def actual
+      Terminal.width
+    end
 
-      def out_of_range?
-        value < 1 || value > 12
-      end
+    def out_of_range?
+      value < 1 || value > 12
     end
+
   end
 end

data/lib/vedeu/support/groups.rb

@@ -0,0 +1,51 @@
+module Vedeu
+  class Groups
+
+    # @return [Groups]
+    def initialize; end
+
+    # @return [Set]
+    def all
+      @_storage
+    end
+
+    # @param name [String]
+    # @return [Set]
+    def find(name)
+      storage.fetch(name) do
+        fail GroupNotFound, 'Cannot find interface group with this name.'
+      end
+    end
+
+    # @param group [String]
+    # @param name [String]
+    # @param delay [Float]
+    # @return [Groups|FalseClass]
+    def add(group, name, delay = 0.0)
+      return false if group.empty?
+
+      storage[group] << name
+
+      Vedeu.event("_refresh_group_#{group}_".to_sym, { delay: delay }) do
+        Buffers.refresh_group(group)
+      end
+
+      self
+    end
+
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    private
+
+    def storage
+      @_storage ||= in_memory
+    end
+
+    def in_memory
+      Hash.new { |hash, key| hash[key] = Set.new }
+    end
+  end
+end

data/lib/vedeu/support/input.rb

@@ -1,11 +1,15 @@
 module Vedeu
   class Input
+
+    # @return []
     def self.capture
       new.capture
     end
 
+    # @return []
     def initialize; end
 
+    # @return []
     def capture
       Vedeu.trigger(:_keypress_, keypress)
     end
@@ -53,5 +57,6 @@ module Vedeu
 
       translated
     end
+
   end
 end

data/lib/vedeu/support/log.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+require 'time'
+
+module Vedeu
+  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).
+    # @param shift_age [] Number of old log files to keep, or frequency of
+    #   rotation (daily, weekly, monthly).
+    # @param shift_size [] Maximum log file size (only applies when shift_age
+    #   is a number).
+    #
+    # @example
+    #   Logger.new(name, shift_age = 7, shift_size = 1048576)
+    #   Logger.new(name, shift_age = 'weekly')
+    #
+    def initialize(logdev, shift_age=nil, shift_size=nil)
+      @progname = nil
+      @level = DEBUG
+      @default_formatter = Formatter.new
+      @formatter = nil
+      @logdev = nil
+      if logdev
+        @logdev = LocklessLogDevice.new(logdev)
+      end
+    end
+
+    class LocklessLogDevice < LogDevice
+      def initialize(log = nil)
+        @dev = @filename = @shift_age = @shift_size = nil
+        if log.respond_to?(:write) and log.respond_to?(:close)
+          @dev = log
+        else
+          @dev = open_logfile(log)
+          @dev.sync = true
+          @filename = log
+        end
+      end
+
+      def write(message)
+        @dev.write(message)
+      rescue Exception => ignored
+        warn("log writing failed. #{ignored}")
+      end
+
+      def close
+        @dev.close rescue nil
+      end
+
+    private
+
+      def open_logfile(filename)
+        if (FileTest.exist?(filename))
+          open(filename, (File::WRONLY | File::APPEND))
+        else
+          create_logfile(filename)
+        end
+      end
+
+      def create_logfile(filename)
+        logdev = open(filename, (File::WRONLY | File::APPEND | File::CREAT))
+        logdev.sync = true
+        add_log_header(logdev)
+        logdev
+      end
+
+      def add_log_header(file)
+        file.write(
+          "# Logfile created on %s by %s\n" % [Time.now.to_s, Logger::ProgName]
+        )
+      end
+    end
+  end
+
+  class Log
+
+    # @return []
+    def self.logger
+      @logger ||= MonoLogger.new(filename).tap do |log|
+        log.formatter = proc do |_, time, _, message|
+          time.utc.iso8601 + ": " + message + "\n"
+        end
+      end
+    end
+
+    private
+
+    def self.filename
+      @_filename ||= directory + '/vedeu.log'
+    end
+
+    def self.directory
+      FileUtils.mkdir_p(path) unless File.directory?(path)
+
+      path
+    end
+
+    def self.path
+      Dir.home + '/.vedeu'
+    end
+
+  end
+end

data/lib/vedeu/support/menu.rb

@@ -1,5 +1,8 @@
 module Vedeu
   class Menu
+
+    # @param collection []
+    # @return [Menu]
     def initialize(collection)
       @collection = collection
       @current    = 0
@@ -7,6 +10,7 @@ module Vedeu
       @events     = events
     end
 
+    # @return []
     def events
       @_events ||= Vedeu.events.add(self) do
         event(:menu_next)     { next_item     }
@@ -22,24 +26,29 @@ module Vedeu
       end
     end
 
+    # @return []
     def current
       @current
     end
 
+    # @return []
     def selected
       @selected
     end
 
+    # @return []
     def current_item
       @collection[@current]
     end
 
+    # @return []
     def selected_item
       return nil unless @selected
 
       @collection[@selected]
     end
 
+    # @return [Array]
     def items
       items = []
       @collection.each_with_index do |item, index|
@@ -60,52 +69,62 @@ module Vedeu
       items
     end
 
+    # @return []
     def view
       items[@current, @collection.size]
     end
 
+    # @return []
     def top_item
       @current = 0
 
       items
     end
 
+    # @return []
     def bottom_item
       @current = last
 
       items
     end
 
+    # @return []
     def next_item
       @current += 1 if @current < last
 
       items
     end
 
+    # @return []
     def prev_item
       @current -= 1 if @current > 0
 
       items
     end
 
+    # @return []
     def select_item
       @selected = @current
 
       items
     end
 
+    # @return []
     def deselect_item
       @selected = nil
 
       items
     end
 
+    # @return []
     def last
       @collection.size - 1
     end
 
+    # @return []
     def size
       @collection.size
     end
+
   end
 end

data/lib/vedeu/support/position.rb

@@ -1,9 +1,15 @@
 module Vedeu
   class Position
+
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Position]
     def initialize(y = 1, x = 1)
       @y, @x = y, x
     end
 
+    # @param block [Proc]
+    # @return [String]
     def to_s(&block)
       if block_given?
         [ sequence, yield, sequence ].join
@@ -27,5 +33,6 @@ module Vedeu
     def x
       (@x == 0 || @x == nil) ? 1 : @x
     end
+
   end
 end

data/lib/vedeu/{output → support}/render.rb

@@ -1,13 +1,19 @@
 module Vedeu
   class Render
+
+    # @param interface [Interface]
+    # @return [String]
     def self.call(interface)
       new(interface).render
     end
 
+    # @param interface [Interface]
+    # @return [Render]
     def initialize(interface)
       @interface = interface
     end
 
+    # @return [String]
     def render
       out = [ Clear.call(interface) ]
       processed_lines.each_with_index do |line, index|
@@ -42,7 +48,7 @@ module Vedeu
 
               processed << Stream.new({
                              colour: stream.colour.attributes,
-                             style:  stream.style,
+                             style:  stream.style.values,
                              text:   truncate(stream.text, remainder),
                            })
 
@@ -55,7 +61,7 @@ module Vedeu
           Line.new({
             colour:  line.colour.attributes,
             streams: processed,
-            style:   line.style,
+            style:   line.style.values,
           })
 
         else
@@ -66,8 +72,7 @@ module Vedeu
     end
 
     def exceeds_width?(line)
-      content = line.streams.map(&:text).join
-      content.size > width
+      line.streams.map(&:text).join.size > width
     end
 
     def truncate(text, value)
@@ -79,11 +84,12 @@ module Vedeu
     end
 
     def height
-      interface.height
+      interface.viewport_height
     end
 
     def width
-      interface.width
+      interface.viewport_width
     end
+
   end
 end