simple_tools 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b41f5e2bc4aae37adeeafe28d802074c6275a2f2ca6f4adb8a45536f3b41e362
-  data.tar.gz: e56eb6bb951d112b7c31367ffc80b5b50e31d26b362047afa84d43ac0e33f1fb
+  metadata.gz: 22b2635dbf11b1b9b7351f49acd3aa871b7894f09c429f776bf8e8eabeeb3ec1
+  data.tar.gz: be3960f0d89e35d1a636739760f3d6c506c6aad05d3f47933a54d60ece2d6715
 SHA512:
-  metadata.gz: fc6fa20a9d3e7f7b1d8e2ed06e1ca91d49c02174acdc8a2d7ce93ca375135a521e4d1fa21b4dc7011509f6f60f2e77a4b90928a2e2a669efcab212aa95fb32f9
-  data.tar.gz: 6ee47fd86e0b0e7823ddc01b6d0aa56538782f5afb174693603b8964b8d985f3051d4abda719c3aa61e825d5ee78a9ddca918c21115b5e3496e9d21ac1871769
+  metadata.gz: b62bf8cde989ece7c08fd7cc7282bd9dafd2dc1ef8609a6414676ee495251fc921328da3e16b7aa843589c3ca5089cfab9b54b69a830bed83495674394a6d435
+  data.tar.gz: 742bef145d4c517de4c8a6a2458cc336ead4b241e8332419fb61e911226465a96395b95fdb23ed784284be238fdc9c6209483f96b83120dd427080602d2e50d6

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in simple_tools.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    simple_tools (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec
+  simple_tools!
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
+* [Operation](#Operation)
+* [Pub/Sub (Events)](#pubsub)
+
+
 ### Operation
 Inspired by trailblaizer operation.
 
@@ -55,7 +59,7 @@ Example of calling operation:
 `SimpleTools::Operation` respond to `.call` and can receive hash of parameters.
 Inside operation to share variables between steps use `update_context(:any_key, 'any value')` setter and `context[:any_key]` getter.
 
-`.call` returns object which respond to `.success?` and returns boolean value. 
+`.call` returns object which respond to `.success?` and returns boolean value.
 
 Also `.context` method is available which returns setted in operation values.
 
@@ -85,7 +89,7 @@ class FailedOperation < SimpleTools::Operation
   end
 end
 ```
-`error!`, `errors!` - add new item(s) to list of errors. It do not raise exception and dont break execution of current method. 
+`error!`, `errors!` - add new item(s) to list of errors. It do not raise exception and dont break execution of current method.
 
 Example of calling failed operation:
 ```ruby
@@ -98,8 +102,57 @@ Example of calling failed operation:
 => result.errors
 # {name: ['error description', 'one more error', 'and another error']}
 ```
+------
+
 
+### Pub/Sub
+Publish/subscribe messaging, or pub/sub messaging, is a form of service-to-service communication. In a pub/sub model, any message published to a topic is immediately received by all of the subscribers to the topic. Pub/sub messaging can be used to enable event-driven architectures, or to decouple applications in order to increase performance, reliability and scalability.
+
+Write subscriber which will be waiting for event:
+```ruby
+class NewSubscriber < SimpleTools::Events::Subscriber
+  def handle
+    p 'notification about event received!'
+    p event_name
+    p payload
+  end
+end
+```
+`payload`, `event_name` methods available in instance of `SimpleTools::Events::Subscriber`.
+
+Subscribe to event by name:
+```ruby
+SimpleTools::Events.subscribe('some_event_name', NewSubscriber)
+```
 
+Publish event:
+```ruby
+SimpleTools::Events.publish('some_event_name')
+```
+Output example:
+```
+"notification about event received!"
+"some_event_name"
+nil
+```
+Or publish event with payload if required:
+```ruby
+payload = {
+  id: 11,
+  type: 'description of type',
+  some_values: [1,2,3]
+}
+
+SimpleTools::Events.publish('some_event_name', payload)
+```
+
+Output example:
+```
+"notification about event received!"
+"some_event_name"
+{:id=>11, :type=>"description of type", :some_values=>[1, 2, 3]}
+```
+------
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "simple_tools"
+require 'bundler/setup'
+require 'simple_tools'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "simple_tools"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/simple_tools.rb

@@ -1,5 +1,8 @@
-require "simple_tools/version"
-require "simple_tools/operation"
+# frozen_string_literal: true
+
+require 'simple_tools/version'
+require 'simple_tools/operation'
+require 'simple_tools/events'
 
 module SimpleTools
 end

data/lib/simple_tools/events.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'singleton'
+require 'simple_tools/events/subscriber'
+require 'simple_tools/events/subscribers'
+
+module SimpleTools
+  module Events
+    def self.subscribers
+      Subscribers.instance
+    end
+
+    def self.subscribe(event_name, subscriber_class)
+      subscribers.add(event_name, subscriber_class)
+    end
+
+    def self.publish(event_name, payload = nil)
+      subscribers.select(event_name).each do |subscriber|
+        subscriber[:subscriber_class].notify(event_name, payload)
+      end
+    end
+  end
+end

data/lib/simple_tools/events/subscriber.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SimpleTools
+  module Events
+    class Subscriber
+      BehaviourNotDefined = Class.new(StandardError)
+
+      attr_reader :event_name, :payload
+
+      def self.notify(event_name, payload)
+        new(event_name, payload).call
+      end
+
+      def initialize(event_name, payload)
+        @event_name = event_name
+        @payload = payload
+      end
+
+      def call
+        handle
+      end
+
+      private
+
+      def handle
+        raise(BehaviourNotDefined, 'Implement :handle method in your subscriber class')
+      end
+    end
+  end
+end

data/lib/simple_tools/events/subscribers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module SimpleTools
+  module Events
+    class Subscribers
+      include Singleton
+
+      def add(event_name, subscriber_class)
+        !!list.add?(event_name: event_name, subscriber_class: subscriber_class)
+      end
+
+      def remove_by_event!(event_name)
+        !!list.reject! { |item| item[:event_name] == event_name }
+      end
+
+      def remove_by_subscriber!(subscriber_class)
+        !!list.reject! { |item| item[:subscriber_class] == subscriber_class }
+      end
+
+      def select(event_name)
+        list.select { |item| item[:event_name] == event_name }
+      end
+
+      def to_a
+        list.to_a
+      end
+
+      private
+
+      def list
+        @list ||= Set[]
+      end
+    end
+  end
+end

data/lib/simple_tools/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleTools
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/simple_tools.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'simple_tools/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - isidzukuri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,11 +61,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/simple_tools.rb
+- lib/simple_tools/events.rb
+- lib/simple_tools/events/subscriber.rb
+- lib/simple_tools/events/subscribers.rb
 - lib/simple_tools/operation.rb
 - lib/simple_tools/version.rb
 - simple_tools.gemspec