omnes 0.1.0

data/lib/omnes.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "omnes/bus"
+require "omnes/event"
+require "omnes/subscriber"
+require "omnes/version"
+
+# Pub/sub library for Ruby.
+#
+# There're two ways to make use of the pub/sub features Omnes provides:
+#
+# - Standalone, through an {Omnes::Bus} instance.
+# - Mixing in the behavior in another class by including the {Omnes} module.
+#
+# Refer to {Omnes::Bus} documentation for the available methods. The only
+# difference for the mixing use case is that the methods are directly called in
+# the including instance.
+#
+# ```
+# class MyClass
+#   include Omnes
+#
+#   def initialize
+#     register(:foo)
+#   end
+#
+#   def call
+#     publish(:foo, bar: :baz)
+#   end
+# end
+# ```
+#
+# Refer to {Omnes::Subscriber} for how to provide event handlers through methods
+# defined in a class.
+module Omnes
+  # Shortcut to access the configuration for different Omnes components
+  #
+  # TODO: Make automation for it
+  #
+  # @return [Omnes::Config]
+  def self.config
+    Config
+  end
+
+  # Wrapper for the configuration of Omnes components
+  module Config
+    # {Omnes::Subscriber} configuration
+    #
+    # @return [Dry::Configurable::Config]
+    def self.subscriber
+      Omnes::Subscriber.config.tap do |klass|
+        klass.define_singleton_method(:adapter) do
+          Module.new do
+            def self.sidekiq
+              Omnes::Subscriber::Adapter::Sidekiq.config
+            end
+
+            def self.active_job
+              Omnes::Subscriber::Adapter::ActiveJob.config
+            end
+          end
+        end
+      end
+    end
+
+    # {Omnes::Event} configuration
+    #
+    # @return [Dry::Configurable::Config]
+    def self.event
+      Omnes::Event.config
+    end
+  end
+
+  # @api private
+  def self.included(klass)
+    klass.define_method(:omnes_bus) { @omnes_bus ||= Bus.new(cal_loc_start: 2) }
+    Bus.instance_methods(false).each do |method|
+      klass.define_method(method) do |*args, **kwargs, &block|
+        omnes_bus.send(method, *args, **kwargs, &block)
+      end
+    end
+  end
+end

data/omnes.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/omnes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omnes"
+  spec.version = Omnes::VERSION
+  spec.authors = ["Marc Busqué"]
+  spec.email = ["marc@lamarciana.com"]
+
+  spec.summary = "Pub/Sub for ruby"
+  spec.description = <<~MSG
+    Omnes is a Ruby library implementing the publish-subscribe pattern. This
+    pattern allows senders of messages to be decoupled from their receivers. An
+    Event Bus acts as a middleman where events are published while interested
+    parties can subscribe to them.
+  MSG
+  spec.homepage = "https://github.com/nebulab/omnes"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-configurable", "~> 0.14"
+
+  spec.add_development_dependency "activejob", "~> 7.0"
+  spec.add_development_dependency "redcarpet", "~> 3.5"
+  spec.add_development_dependency "sidekiq", "~> 6.4"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: omnes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc Busqué
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |
+  Omnes is a Ruby library implementing the publish-subscribe pattern. This
+  pattern allows senders of messages to be decoupled from their receivers. An
+  Event Bus acts as a middleman where events are published while interested
+  parties can subscribe to them.
+email:
+- marc@lamarciana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omnes.rb
+- lib/omnes/bus.rb
+- lib/omnes/errors.rb
+- lib/omnes/event.rb
+- lib/omnes/execution.rb
+- lib/omnes/publication.rb
+- lib/omnes/registry.rb
+- lib/omnes/subscriber.rb
+- lib/omnes/subscriber/adapter.rb
+- lib/omnes/subscriber/adapter/active_job.rb
+- lib/omnes/subscriber/adapter/method.rb
+- lib/omnes/subscriber/adapter/method/errors.rb
+- lib/omnes/subscriber/adapter/sidekiq.rb
+- lib/omnes/subscriber/errors.rb
+- lib/omnes/subscriber/state.rb
+- lib/omnes/subscription.rb
+- lib/omnes/unstructured_event.rb
+- lib/omnes/version.rb
+- omnes.gemspec
+homepage: https://github.com/nebulab/omnes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nebulab/omnes
+  source_code_uri: https://github.com/nebulab/omnes
+  changelog_uri: https://github.com/nebulab/omnes/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.20
+signing_key:
+specification_version: 4
+summary: Pub/Sub for ruby
+test_files: []