wisper-compat 4.0.0

data/spec/lib/wisper/value_objects/events_spec.rb

@@ -0,0 +1,107 @@
+describe Wisper::ValueObjects::Events do
+  context 'nil' do
+    subject { described_class.new nil }
+
+    describe '#include?' do
+      it 'returns true' do
+        expect(subject.include? 'foo').to be_truthy
+        expect(subject.include? :bar).to be_truthy
+      end
+    end
+  end
+
+  context '"foo"' do
+    let(:foo) { Class.new(String).new 'foo' }
+    subject   { described_class.new foo }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context ':foo' do
+    subject { described_class.new :foo }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context '[:foo, "bar"]' do
+    subject { described_class.new [:foo, 'bar'] }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns true for "bar"' do
+        expect(subject.include? 'bar').to be_truthy
+      end
+
+      it 'returns true for :bar' do
+        expect(subject.include? :bar).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'baz').to be_falsey
+        expect(subject.include? :baz).to be_falsey
+      end
+    end
+  end
+
+  context 'by /foo/' do
+    subject { described_class.new(/foo/) }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context 'another class' do
+    subject { described_class.new Object.new }
+
+    describe '#include?' do
+      it 'raises ArgumentError' do
+        expect { subject.include? 'foo' }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/lib/wisper/value_objects/prefix_spec.rb

@@ -0,0 +1,46 @@
+describe Wisper::ValueObjects::Prefix do
+  
+  it 'is a string' do
+    expect(subject).to be_kind_of String
+  end
+
+  describe '.new' do
+    context 'without arguments' do
+      subject { described_class.new }
+      it { is_expected.to eq '' }
+    end
+
+    context 'nil' do
+      subject { described_class.new nil }
+      it { is_expected.to eq '' }
+    end
+
+    context 'true' do
+      subject { described_class.new true }
+      it { is_expected.to eq 'on_' }
+    end
+
+    context '"foo"' do
+      subject { described_class.new 'foo' }
+      it { is_expected.to eq 'foo_' }
+    end
+  end
+
+  describe '.default=' do
+    after { described_class.default = nil }
+
+    context 'nil' do
+      it "doesn't change default prefix" do
+        expect { described_class.default = nil }
+          .not_to change { described_class.new true }.from('on_')
+      end
+    end
+
+    context '"foo"' do
+      it 'changes default prefix' do
+        expect { described_class.default = 'foo' }
+          .to change { described_class.new true }.from('on_').to('foo_')
+      end
+    end
+  end
+end

data/spec/lib/wisper_spec.rb

@@ -0,0 +1,99 @@
+describe Wisper do
+  describe '.subscribe' do
+    context 'when given block' do
+
+      it 'subscribes listeners to all events for duration of the block' do
+        publisher = publisher_class.new
+        listener  = double('listener')
+
+        expect(listener).to receive(:first_event)
+        expect(listener).not_to receive(:second_event)
+
+        Wisper.subscribe(listener) do
+          publisher.send(:broadcast, 'first_event')
+        end
+
+        publisher.send(:broadcast, 'second_event')
+      end
+    end
+
+    context 'when no block given' do
+      it 'subscribes listener to all events' do
+        listener = double('listener')
+        Wisper.subscribe(listener)
+        expect(Wisper::GlobalListeners.listeners).to eq [listener]
+      end
+
+      it 'subscribes listeners to all events' do
+        listener_1 = double('listener')
+        listener_2 = double('listener')
+
+        Wisper.subscribe(listener_1, listener_2)
+
+        expect(Wisper::GlobalListeners.listeners).to include listener_1, listener_2
+      end
+    end
+  end
+
+  describe '.unsubscribe' do
+    it 'removes listener from list of listeners' do
+      listener = double('listener')
+
+      Wisper.subscribe(listener)
+      expect(Wisper::GlobalListeners.listeners).to eq [listener]
+
+      Wisper.unsubscribe(listener)
+      expect(Wisper::GlobalListeners.listeners).to eq []
+    end
+
+    it 'removes listeners from list of listeners' do
+      listener_1 = double('listener')
+      listener_2 = double('listener')
+
+      Wisper.subscribe(listener_1, listener_2)
+      expect(Wisper::GlobalListeners.listeners).to include listener_1, listener_2
+
+      Wisper.unsubscribe(listener_1, listener_2)
+      expect(Wisper::GlobalListeners.listeners).to eq []
+    end
+  end
+
+  describe '.publisher' do
+    it 'returns the Publisher module' do
+      expect(Wisper.publisher).to eq Wisper::Publisher
+    end
+  end
+
+  describe '.clear' do
+    before { Wisper.subscribe(double) }
+
+    it 'clears all global listeners' do
+      Wisper.clear
+      expect(Wisper::GlobalListeners.listeners).to be_empty
+    end
+  end
+
+  describe '.configuration' do
+    it 'returns configuration object' do
+      expect(Wisper.configuration).to be_an_instance_of(Wisper::Configuration)
+    end
+
+    it 'is memorized' do
+      expect(Wisper.configuration).to eq Wisper.configuration
+    end
+  end
+
+  describe '.configure' do
+    it 'passes configuration to given block' do
+      Wisper.configure do |config|
+        expect(config).to be_an_instance_of(Wisper::Configuration)
+      end
+    end
+  end
+
+  describe '.setup' do
+    it 'sets a default broadcaster' do
+      expect(Wisper.configuration.broadcasters[:default]).to be_instance_of(Wisper::Broadcasters::SendBroadcaster)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'wisper'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.after(:each) { Wisper::GlobalListeners.clear }
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+# returns an anonymous wispered class
+def publisher_class
+  Class.new { include Wisper::Publisher }
+end

data/wisper-compat.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "wisper-compat"
+  gem.version       = Wisper::VERSION
+  gem.authors       = ["Kris Leech", "Dima Sukhikh", "Jamie Schembri"]
+  gem.email         = ["kris.leech@gmail.com", "dima.sukhikh@nedap.com", "jamie.schembri@nedap.com"]
+  gem.description   = <<-DESC
+    A micro library providing objects with Publish-Subscribe capabilities.
+    Both synchronous (in-process) and asynchronous (out-of-process) subscriptions are supported.
+    Check out the Wiki for articles, guides and examples: https://github.com/krisleech/wisper/wiki
+  DESC
+  gem.summary       = "A micro library providing objects with Publish-Subscribe capabilities"
+  gem.homepage      = "https://github.com/nedap/wisper-compat"
+  gem.license       = "MIT"
+
+  gem.required_ruby_version = '>= 2.7'
+
+  gem.files         = `git ls-files`.split($/).reject { |f| f.split('/').first == 'bin' }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: wisper-compat
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Kris Leech
+- Dima Sukhikh
+- Jamie Schembri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      A micro library providing objects with Publish-Subscribe capabilities.
+      Both synchronous (in-process) and asynchronous (out-of-process) subscriptions are supported.
+      Check out the Wiki for articles, guides and examples: https://github.com/krisleech/wisper/wiki
+email:
+- kris.leech@gmail.com
+- dima.sukhikh@nedap.com
+- jamie.schembri@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/wisper.rb
+- lib/wisper/broadcasters/logger_broadcaster.rb
+- lib/wisper/broadcasters/send_broadcaster.rb
+- lib/wisper/configuration.rb
+- lib/wisper/global_listeners.rb
+- lib/wisper/publisher.rb
+- lib/wisper/registration/block.rb
+- lib/wisper/registration/object.rb
+- lib/wisper/registration/registration.rb
+- lib/wisper/temporary_listeners.rb
+- lib/wisper/value_objects/events.rb
+- lib/wisper/value_objects/prefix.rb
+- lib/wisper/version.rb
+- spec/lib/global_listeners_spec.rb
+- spec/lib/integration_spec.rb
+- spec/lib/simple_example_spec.rb
+- spec/lib/temporary_global_listeners_spec.rb
+- spec/lib/wisper/broadcasters/logger_broadcaster_spec.rb
+- spec/lib/wisper/broadcasters/send_broadcaster_spec.rb
+- spec/lib/wisper/configuration/broadcasters_spec.rb
+- spec/lib/wisper/configuration_spec.rb
+- spec/lib/wisper/publisher_spec.rb
+- spec/lib/wisper/registrations/object_spec.rb
+- spec/lib/wisper/value_objects/events_spec.rb
+- spec/lib/wisper/value_objects/prefix_spec.rb
+- spec/lib/wisper_spec.rb
+- spec/spec_helper.rb
+- wisper-compat.gemspec
+homepage: https://github.com/nedap/wisper-compat
+licenses:
+- MIT
+metadata:
+  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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: A micro library providing objects with Publish-Subscribe capabilities
+test_files:
+- spec/lib/global_listeners_spec.rb
+- spec/lib/integration_spec.rb
+- spec/lib/simple_example_spec.rb
+- spec/lib/temporary_global_listeners_spec.rb
+- spec/lib/wisper/broadcasters/logger_broadcaster_spec.rb
+- spec/lib/wisper/broadcasters/send_broadcaster_spec.rb
+- spec/lib/wisper/configuration/broadcasters_spec.rb
+- spec/lib/wisper/configuration_spec.rb
+- spec/lib/wisper/publisher_spec.rb
+- spec/lib/wisper/registrations/object_spec.rb
+- spec/lib/wisper/value_objects/events_spec.rb
+- spec/lib/wisper/value_objects/prefix_spec.rb
+- spec/lib/wisper_spec.rb
+- spec/spec_helper.rb