vedeu 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f08172957be2fc1e8da242d1e5169f2ef6f9f6c3
-  data.tar.gz: c6692d292848d90ee1544ef5c0ebf41086f66637
+  metadata.gz: b30006037c42b5b8edf6c8dadb382342a593a509
+  data.tar.gz: 14c1db8169f22fa1266dfd249942d7aca7ddbe69
 SHA512:
-  metadata.gz: 2e5009a40a5c90ca3b4bd2cb36481ae2dfa5af09df0146c29ce80cdcd6045ea81e905181576a5011986132ca72854323c55688a22c38a2622c6a52af729c5d9d
-  data.tar.gz: 7af3be17bd322e76965c62d13253e2f3044fe4f7145e82b38ea32993228f61b4c2596b78710606d15ac2656f542a2a1b44f09ca556b38ceca50852d546810eb7
+  metadata.gz: f5b66b1fb91bb76e83defef25c99f79af93c36297e3607a592e8302a5165c0a2c076b31325d803c19a74f1613493a9fba26772ecf98e13d2f49f842a4981d4f3
+  data.tar.gz: 9b090b685842e11c0f45aa2c341ae8eb99234a0fcade6c58f5b0e6b4fda1c16afb75b3df01d95006a715a24e6f892e331fdee6a0ef7a53a55b49e95c1458e9d0

data/README.md

@@ -50,9 +50,9 @@ Expect proper documentation soon!
         when 'a' then puts "Apple"
         when 'b' then puts "Banana"
         # ...
-        when :f1 then run(:some_event)
+        when :f1 then trigger(:some_event)
         when :f2 then
-          run(:other_event, { args: here }, [:or, :here], :etc)
+          trigger(:other_event, { args: here }, [:or, :here], :etc)
         end
       end
     end
@@ -116,7 +116,9 @@ Note: not setting a width or height will set the values to the terminal's report
     event :event_name do |arg1, arg2|
     end
 
-One can define events which perform work or trigger other events. Vedeu has built-in events which are namespaced with underscores as to hopefully not cause a collision with events you wish to create:
+One can define events which perform work or trigger other events. Vedeu has built-in events which are namespaced with underscores:
+
+- `:_initialize_` Special event which Vedeu triggers when it is ready to enter the main loop. Client applications can listen for this event and perform some action(s), like render the first screen, interface or make a sound.
 
 - `:_clear_` Clears the whole terminal space.
 
@@ -155,25 +157,26 @@ Vedeu has a range of symbol styles which are compatible with most terminals whic
 
 Like colours, they can be defined in either interfaces, for specific lines or within streams. Styles are applied as encountered.
 
-| Style name    | Escape Sequence          |
-|---------------|--------------------------|
-| bg_reset      | `\e[48;2;49m`            |
-| blink         | `\e[5m`                  |
-| blink_off     | `\e[25m`                 |
-| bold          | `\e[1m`                  |
-| bold_off      | `\e[21m`                 |
-| clear         | `\e[2J`                  |
-| colour_reset  | `\e[38;2;39m\e[48;2;49m` |
-| fg_reset      | `\e[38;2;39m`            |
-| hide_cursor   | `\e[?25l`                |
-| negative      | `\e[7m`                  |
-| positive      | `\e[27m`                 |
-| reset         | `\e[0m`                  |
-| normal        | `\e[24m\e[21m\e[27m`     |
-| dim           | `\e[2m`                  |
-| show_cursor   | `\e[?25h`                |
-| underline     | `\e[4m`                  |
-| underline_off | `\e[24m`                 |
+| Style name    | Escape Sequence               |
+|---------------|-------------------------------|
+| bg_reset      | `\e[48;2;49m`                 |
+| blink         | `\e[5m`                       |
+| blink_off     | `\e[25m`                      |
+| bold          | `\e[1m`                       |
+| bold_off      | `\e[21m`                      |
+| clear         | `\e[2J`                       |
+| clear_line    | `\e[38;2;39m\e[48;2;49m\e[2K` |
+| colour_reset  | `\e[38;2;39m\e[48;2;49m`      |
+| fg_reset      | `\e[38;2;39m`                 |
+| hide_cursor   | `\e[?25l`                     |
+| negative      | `\e[7m`                       |
+| positive      | `\e[27m`                      |
+| reset         | `\e[0m`                       |
+| normal        | `\e[24m\e[21m\e[27m`          |
+| dim           | `\e[2m`                       |
+| show_cursor   | `\e[?25h`                     |
+| underline     | `\e[4m`                       |
+| underline_off | `\e[24m`                      |
 
 
 ## Contributing
@@ -186,4 +189,4 @@ Like colours, they can be defined in either interfaces, for specific lines or wi
 6. Write some tests, write some code, have some fun
 7. Commit your changes (`git commit -am 'Add some feature'`)
 8. Push to the branch (`git push origin my-new-feature`)
-9. Create new Pull Request
+9. Create a new pull request

data/deps.md

@@ -22,7 +22,7 @@ API::Interface
   API::Grid
   Geometry
   Interface
-  InterfaceStore
+  API::Store
   Terminal
 
 API::Line
@@ -34,13 +34,13 @@ API::Stream
 
 API::View
   API::Line
-  InterfaceStore
+  API::Store
 
 Application
   Input
   Terminal
 
-ClearInterface
+Clear
 
 Collection
 
@@ -63,10 +63,10 @@ Geometry
 
 Esc
 
-Events
+API::Events
 
 Input
-  Events
+  API::Events
   Terminal
 
 Instrumentation
@@ -74,17 +74,16 @@ Instrumentation
   Trace
 
 Interface
-  ClearInterface
+  Clear
   Colour
   Geometry
   LineCollection
-  Queue
-  RenderInterface
+  Render
   Style
   Terminal
 
 InterfaceCollection
-  InterfaceStore
+  API::Store
 
 Launcher
   Application
@@ -100,14 +99,12 @@ LineCollection
   Line
 
 Menu
-  Events
+  API::Events
 
-InterfaceStore
+API::Store
   Interface
 
-Queue
-
-RenderInterface
+Render
   Line
   Stream
 
@@ -144,7 +141,7 @@ Grouped
 API::Interface
   Interface
   Geometry
-  InterfaceStore
+  API::Store
 
 Launcher
   Application
@@ -158,9 +155,9 @@ Launcher
 View
   Composition
     InterfaceCollection
-      InterfaceStore
+      API::Store
         Interface
-          ClearInterface
+          Clear
           Colour
             Background
             Foreground
@@ -184,8 +181,7 @@ View
                     Esc
               Style
                 Esc
-          Queue
-          RenderInterface
+          Render
             Line
             Stream
           Style

data/lib/vedeu.rb

@@ -1,61 +1,18 @@
 require 'vedeu/instrumentation'
+
+require 'vedeu/api/events'
+require 'vedeu/api/grid'
 require 'vedeu/api/interface'
-require 'vedeu/support/events'
-require 'vedeu/support/interface_store'
+require 'vedeu/api/line'
+require 'vedeu/api/store'
+require 'vedeu/api/stream'
 require 'vedeu/api/view'
-require 'vedeu/models/geometry'
+
 require 'vedeu/support/menu'
-require 'vedeu/output/view'
 require 'vedeu/launcher'
 
-# Todo: mutation (events)
-
 module Vedeu
-  # :nocov:
-  def self.debug?
-    false
-  end
-
-  Vedeu::Instrumentation::Trace.call if debug?
-
-  module API
-    def interface(name, &block)
-      Interface.save(name, &block)
-    end
-
-    def on(name, delay = 0, &block)
-      Vedeu.events.on(name, delay, &block)
-    end
-    alias_method :event, :on
-
-    def trigger(name, *args)
-      Vedeu.events.trigger(name, *args)
-    end
-    alias_method :run, :trigger
-
-    def with(name, &block)
-      InterfaceStore.query(name)
-    end
-
-    def view(name = '', &block)
-      Vedeu::API::View.build(name, &block)
-    end
-  end
-
-  def self.events
-    @events ||= Events.new do
-      on(:_exit_)        { fail StopIteration }
-      on(:_log_)         { |message| Vedeu.log(message) }
-      on(:_mode_switch_) { fail ModeSwitch    }
-      on(:_clear_)       { Terminal.output(Esc.string('clear')) }
-
-      on(:_keypress_) do |key|
-        trigger(:key, key)
-        trigger(:_log_, (' ' * 42) + "key: #{key}")
-        trigger(:_mode_switch_) if key == :escape
-      end
-    end
-  end
+  extend API
 
   def self.log(message)
     Vedeu::Instrumentation::Log.logger.debug(message)
@@ -69,7 +26,4 @@ module Vedeu
     receiver.send(:include, API)
     receiver.extend(API)
   end
-
-  extend API
-  # :nocov:
 end

data/lib/vedeu/api/base.rb

@@ -5,7 +5,7 @@ module Vedeu
         new(attributes, &block).build
       end
 
-      def initialize(attributes, &block)
+      def initialize(attributes = {}, &block)
         @attributes = attributes
 
         @self_before_instance_eval = eval 'self', block.binding
@@ -30,16 +30,18 @@ module Vedeu
       def style(values = [], &block)
         if block_given?
           attributes[:streams] << API::Stream.build({ style: [values] }, &block)
+
         else
           [values].flatten.each { |value| attributes[:style] << value }
+
         end
       end
 
-      # :nocov:
+      private
+
       def method_missing(method, *args, &block)
         @self_before_instance_eval.send method, *args, &block
       end
-      # :nocov
     end
   end
 end

data/lib/vedeu/api/events.rb

@@ -0,0 +1,75 @@
+# Todo: mutation (events)
+
+module Vedeu
+  module API
+    def on(name, delay = 0, &block)
+      Vedeu.events.on(name, delay, &block)
+    end
+    alias_method :event, :on
+
+    def trigger(name, *args)
+      Vedeu.events.trigger(name, *args)
+    end
+
+    def events
+      @events ||= API::Events.new do
+        on(:_exit_)        { fail StopIteration }
+        on(:_log_)         { |message| Vedeu.log(message) }
+        on(:_mode_switch_) { fail ModeSwitch    }
+        on(:_clear_)       { Terminal.output(Esc.string('clear')) }
+
+        on(:_keypress_) do |key|
+          trigger(:key, key)
+          trigger(:_log_, (' ' * 42) + "key: #{key}")
+          trigger(:_mode_switch_) if key == :escape
+        end
+      end
+    end
+
+    class Events
+      def initialize(&block)
+        @handlers = Hash.new do |hash, key|
+          hash[key] = {
+            delay:     0,
+            events:    [],
+            last_exec: 0,
+          }
+        end
+        self.instance_eval(&block) if block_given?
+        self
+      end
+
+      def add(object, &block)
+        @self_before_instance_eval = eval 'self', block.binding
+
+        self.instance_eval(&block)
+      end
+
+      def on(event, delay = 0, &block)
+        handlers[event][:events] << block
+        handlers[event][:delay]  = delay
+        handlers[event]
+      end
+
+      def trigger(event, *args)
+        elapsed = Time.now.to_f - handlers[event][:last_exec]
+
+        if elapsed > handlers[event][:delay]
+          handlers[event][:last_exec] = Time.now.to_f
+
+          handlers[event][:events].each do |handler|
+            handler.call(*args)
+          end
+        end
+      end
+
+      private
+
+      attr_reader :handlers, :throttles
+
+      def method_missing(method, *args, &block)
+        @self_before_instance_eval.send method, *args, &block
+      end
+    end
+  end
+end

data/lib/vedeu/api/interface.rb

@@ -1,6 +1,6 @@
 require 'vedeu/models/geometry'
 require 'vedeu/api/grid'
-require 'vedeu/support/interface_store'
+require 'vedeu/api/store'
 require 'vedeu/support/terminal'
 
 module Vedeu
@@ -10,6 +10,10 @@ module Vedeu
     XOutOfBounds  = Class.new(StandardError)
     YOutOfBounds  = Class.new(StandardError)
 
+    def interface(name, &block)
+      Interface.save(name, &block)
+    end
+
     class Interface
       def self.save(name, &block)
         new(name).save(&block)
@@ -22,13 +26,19 @@ module Vedeu
       def save(&block)
         self.instance_eval(&block) if block_given?
 
-        InterfaceStore.create(attributes)
+        stored_attributes = Store.create(attributes)
+
+        Vedeu::Interface.new(stored_attributes)
       end
 
       private
 
       attr_reader :name
 
+      def use(value)
+        Vedeu.use(value)
+      end
+
       def x(value)
         fail XOutOfBounds if x_out_of_bounds?(value)
 

data/lib/vedeu/api/store.rb

@@ -0,0 +1,37 @@
+require 'vedeu/models/interface'
+
+# Todo: mutation (persistence)
+
+module Vedeu
+  module API
+    EntityNotFound = Class.new(StandardError)
+
+    def use(name)
+      Vedeu::Interface.new(Store.query(name))
+    end
+
+    module Store
+      extend self
+
+      def create(attributes)
+        storage.store(attributes[:name], attributes)
+      end
+
+      def query(name)
+        attributes = storage.fetch(name) do
+          fail EntityNotFound, 'Interface was not found.'
+        end
+      end
+
+      def reset
+        @storage = {}
+      end
+
+      private
+
+      def storage
+        @storage ||= {}
+      end
+    end
+  end
+end