owskilog 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6459bd8a1a6b903ad85aa8e403d7d7d260b0e43d
-  data.tar.gz: 6e60ef11ca4e096f391bf26cf4fccccdf690d48e
+  metadata.gz: 2179acba77e13e5e5573c13c6d1fff8d7efbbaa5
+  data.tar.gz: a5acf17d817e99ea5490d3052f3fc4e06c24a178
 SHA512:
-  metadata.gz: '091679cb43ce217108988d7120596115ba175ee16cceba90111b6aae9b35e5fbab63ea63c8ff2a8c6fbc49b0025f7aaca70d4a86ae33078b2b2a0095bd2f0f89'
-  data.tar.gz: 917da3973713cc25f6353104fb53a8aa28b903e8a3b6aa605060ca25c205d79e8e047a408554ce3ee8987bfbb437dff9a99d02dab87757a8667ef2959ba5ba60
+  metadata.gz: 14b6be86ad04d3e9b3a95e4fd9a263c8baa63d1794a452f4d7c355f2842f2cb4e60dcc938ed546e767ed74fa854a64a67634d11b9e196da322fd880e9c9f166d
+  data.tar.gz: f7d2a3be83f31b3f7458f47e65b3f30a24a24f045e7d020c1a0912fb8b8f7a3a263945f5319ea61e931b90aee8b24c079c224821b2d4c1e0a0a732ef905a727b

data/README.md

@@ -1,8 +1,6 @@
 # owskilog
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/owskilog`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Project created with the intention of helping managing scripts that need to constant log their actions and status.
 
 ## Installation
 
@@ -32,7 +30,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owskilog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/augustoccesar/owskilog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +38,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the owskilog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/owskilog/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the owskilog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/augustoccesar/owskilog/blob/master/CODE_OF_CONDUCT.md).

data/lib/owskilog.rb

@@ -1,25 +1,40 @@
 require 'owskilog/version'
+require 'owskilog/watcher'
 require 'owskilog/event'
-require 'owskilog/event_manager'
 
 module OwskiLog
   class Holder
-    include EventManager
-    attr_accessor :events
+    attr_accessor :events, :watchers
 
     def initialize
       @events = Hash.new
+      @watchers = Array.new
     end
 
-    def wrap(key, description, parent_key: nil, &block)
+    def register_event(key, description, parent_key: nil)
       ev = Event.new(key, description)
-      register_event(@events, ev, parent_key: parent_key)
+      EventManager::register_event(@events, ev, parent_key: parent_key)
+      WatcherManager::trigger_watchers(@watchers, triggers: [:after_register, :all])
+      ev
+    end
+
+    def finish_event(key, status, cause: nil)
+      EventManager::finish_event(@events, key, status, cause: cause)
+      WatcherManager::trigger_watchers(@watchers, triggers: [:after_finish, :all])
+    end
+
+    def register_watcher(watcher)
+      WatcherManager::register_watcher(@watchers, watcher)
+    end
+
+    def wrap(key, description, parent_key: nil, &block)
+      ev = register_event(key, description, parent_key: parent_key)
       block.call(key)
       unless ev.is_finished?
-        finish_event(@events, key, OwskiLog::Status::OK)
+        finish_event(key, OwskiLog::Status::OK)
       end
     rescue Exception => e
-      finish_event(@events, key, OwskiLog::Status::ERROR, cause: e.inspect)
+      finish_event(key, OwskiLog::Status::ERROR, cause: e.inspect)
     end
 
     def get_log_structure

data/lib/owskilog/event.rb

@@ -46,4 +46,30 @@ module OwskiLog
       }.to_json(*a)
     end
   end
+
+  module EventManager
+    def self.register_event(event_collection, event, parent_key: nil)
+      raise ArgumentError.new('You can only register OwskiLog::Event.') unless event.is_a? Event
+
+      if parent_key != nil
+        event.parent = find_event(event_collection,parent_key)
+      end
+
+      event_collection[event.key] = event
+    end
+
+    def self.find_event(event_collection, event_key)
+      event_collection[event_key]
+    end
+
+    def self.finish_event(event_collection, event_key, status, cause: nil)
+      ev = find_event(event_collection, event_key)
+      if ev
+        ev.finish(status, cause: cause)
+        if ev.parent != nil && cause != nil
+          ev.parent.finish(status, cause: cause)
+        end
+      end
+    end
+  end
 end

data/lib/owskilog/version.rb

@@ -1,3 +1,3 @@
 module OwskiLog
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 end

data/lib/owskilog/watcher.rb

@@ -0,0 +1,28 @@
+module OwskiLog
+  class Watcher
+    TRIGGERS = [:all, :after_register, :after_finish]
+
+    attr_accessor :lambda, :trigger
+
+    def initialize(lambda, trigger: nil)
+      @lambda = lambda
+      @trigger = TRIGGERS.include?(trigger) ? trigger : :all
+    end
+  end
+
+  module WatcherManager
+    def self.register_watcher(watcher_collection, watcher)
+      raise ArgumentError.new('You can only register OwskiLog::Watcher.') unless watcher.is_a? Watcher
+
+      watcher_collection << watcher
+    end
+
+    def self.trigger_watchers(watcher_collection, triggers: nil)
+      if triggers
+        watcher_collection.select {|w| triggers.include?(w.trigger)}.each {|w| w.lambda.call}
+      else
+        watcher_collection.each {|w| w.lambda.call}
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: owskilog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Augusto César Freitas e Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2017-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,8 +73,8 @@ files:
 - exe/owskilog
 - lib/owskilog.rb
 - lib/owskilog/event.rb
-- lib/owskilog/event_manager.rb
 - lib/owskilog/version.rb
+- lib/owskilog/watcher.rb
 - owskilog.gemspec
 homepage: https://github.com/augustoccesar/owskilog
 licenses:

data/lib/owskilog/event_manager.rb

@@ -1,27 +0,0 @@
-module OwskiLog
-  module EventManager
-    def register_event(event_collection, event, parent_key: nil)
-      raise ArgumentError.new('You can only register owskilog::Event.') unless event.is_a? Event
-
-      if parent_key != nil
-        event.parent = find_event(event_collection,parent_key)
-      end
-
-      event_collection[event.key] = event
-    end
-
-    def find_event(event_collection, event_key)
-      event_collection[event_key]
-    end
-
-    def finish_event(event_collection, event_key, status, cause: nil)
-      ev = find_event(event_collection, event_key)
-      if ev
-        ev.finish(status, cause: cause)
-        if ev.parent != nil && cause != nil
-          ev.parent.finish(status, cause: cause)
-        end
-      end
-    end
-  end
-end