informator 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341da250ea78c55d21c12821a7cc8e91af9ed07b
-  data.tar.gz: dfa16302f4547fe123631d9dae3737fb960ca448
+  metadata.gz: 53d7f784fa22bf7f691c99d5e59f054c0c0ba3fb
+  data.tar.gz: 37dcc4751f1433fdcfdc9fc5650f6776ec065100
 SHA512:
-  metadata.gz: 21f6b276db2537b24a2012be0b9b03fc6522e760c80daf8aaef7cdf5f4e335677588712df378b33f1b6cc009e183be84a8f500c44651215776fd49d9ad55c25e
-  data.tar.gz: 1d19b1c9e78ec72579d1b931906302d2a5bb5f0a2e14a8b845f5f71b814933ee11c514c891b5858e7672b0bf47ee213c4e9e53e5d377d14556b7f43c50498021
+  metadata.gz: e22da1a142f55e6535b54db59652546cd750d23cfc237329eb7d3a11cb21b2ce6cfaffaab64563f941c91f0336f4f2af197a6bdf6702baf951646a2a7586b34d
+  data.tar.gz: 5463ec47db2b542e465f0bbc546068ee9a48dc9aca6e11c2f03c82c8e0a1be183ff912a0e47a6a69098873ffb6610668bb30e2200885b9581bb9777bd02e1ac7

data/.travis.yml

@@ -2,9 +2,10 @@
 language:     ruby
 bundler_args: --without metrics
 cache:        bundler
-script:       rake test:coverage:run
+script:       bundle exec rake test:coverage:run
 rvm:
   - '2.1'
+  - '2.2'
   - ruby-head
   - rbx-2 --2.1
   - jruby-9.0.0.0.pre1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## v0.1.0 2015-07-12
+
+### Changed (backward-incompatible)
+
+* Renamed event-carried `data` to `attributes` (nepalez)
+
+### Internal
+
+* Switched to `ice_nine` gem to freezing objects deeply (nepalez)
+* Switched to `hexx-suit` v2.3+ and `hexx-rspec` v0.5+ (nepalez)
+
+[Compare v0.0.2...v0.1.0](https://github.com/nepalez/informator/compare/v0.0.2...v0.1.0)

data/Gemfile

@@ -2,4 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "hexx-suit", "~> 2.2", group: :metrics if RUBY_ENGINE == "ruby"
+group :metrics do
+  gem "hexx-suit", "~> 2.3" if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.1"
+end

data/Guardfile

@@ -5,7 +5,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(%r{^spec/.+_spec\.rb$})
 
   watch(%r{^lib/(.+)\.rb}) do |m|
-    "spec/unit/#{ m[1] }_spec.rb"
+    "spec/unit/#{m[1]}_spec.rb"
   end
 
   watch("lib/informator.rb") { "spec" }

data/README.md

@@ -19,7 +19,7 @@ The [wisper]-inspired tiny implementation of publish/subscribe design pattern.
 
 The implementation differs from the original wisper's approach in the following aspects:
 
-* Unlike `Wisper::Publisher` that calls listener methods depending on the event, the `Informator` uses the same listener's callback for sending all events. Instead it wraps data to `Informator::Event` container and uses its as the argument for the callback.
+* Unlike `Wisper::Publisher` that calls listener methods depending on the event, the `Informator` uses the same listener's callback for sending all events. Instead it wraps attributes to `Informator::Event` container and uses its as the argument for the callback.
 
 * The `Informator` has two separate methods - `#remember` and `#publish`. The first one is used to build and collect events, while the second one publishes all unpublished events at once (and clears the list of events to be published).
 
@@ -44,7 +44,7 @@ The `Informator` module API defines 4 instance methods:
 Except for the `Informator` the module defines public class `Informator::Event` for immutable events, that has 3 attributes:
 
 * `#type` for symbolic type of the event
-* `#data` for hash of data, carried by the event
+* `#attributes` for hash of attributes, carried by the event
 * `#messages` for array of human-readable messages, describing the event
 
 The event instance is build by the `#remember`, `#publish` or `#publish!` methods and is sent to listeners by either `#publish` or `#publish!`. When sending an event, the informator just calls the listeners callback, defined by `#subscribe` method, and gives it a corresponding event object as the only argument.
@@ -81,8 +81,8 @@ result = service.call
 # The listener received success: ["for now all is fine"]
 # The listener received error: ["OMG!"]
 # => [
-#      #<Informator::Event @type=:success @data={ foo: :bar } @messages=["for now all is fine"]>,
-#      #<Informator::Event @type=:error @data={ bar: :baz } @messages=["OMG!"]>
+#      #<Informator::Event @type=:success @attributes={ foo: :bar } @messages=["for now all is fine"]>,
+#      #<Informator::Event @type=:error @attributes={ bar: :baz } @messages=["OMG!"]>
 #    ]
 
 ```

data/Rakefile

@@ -1,10 +1,7 @@
 # encoding: utf-8
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-  exit
-end
+
+require "rubygems"
+require "bundler/setup"
 
 # Loads bundler tasks
 Bundler::GemHelper.install_tasks
@@ -23,5 +20,10 @@ task default: "test:coverage:run"
 
 desc "Runs mutation metric for testing"
 task :mutant do
-  system "mutant -r informator --use rspec 'Informator*' --fail-fast"
+  system "bundle exec mutant -r informator --use rspec Informator* --fail-fast"
+end
+
+desc "Exhort all evils"
+task :mutant do
+  system "bundle exec mutant -r informator --use rspec Informator*"
 end

data/informator.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.author      = "Andrew Kozin"
   gem.email       = "andrew.kozin@gmail.com"
   gem.homepage    = "https://github.com/nepalez/informator"
-  gem.summary     = "Implementation of subscribe/publish design pattern"
+  gem.summary     = "Implementation of publish/subscribe design pattern"
   gem.license     = "MIT"
 
   gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -19,7 +19,8 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = "~> 2.1"
 
   gem.add_runtime_dependency "equalizer", "~> 0.0"
+  gem.add_runtime_dependency "ice_nine", "~> 0.11"
 
-  gem.add_development_dependency "hexx-rspec", "~> 0.4"
+  gem.add_development_dependency "hexx-rspec", "~> 0.5"
 
 end # Gem::Specification

data/lib/informator.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require "ice_nine"
 require "equalizer"
 
 require_relative "informator/event"
@@ -26,7 +27,7 @@ module Informator
     self
   end
 
-  # @!method remember(type, messages, data)
+  # @!method remember(type, messages, attributes)
   # Builds and stores the event waiting for being published
   #
   # @param (see Informator::Event.new)
@@ -39,7 +40,7 @@ module Informator
     self
   end
 
-  # @overload publish(type, messages, data)
+  # @overload publish(type, messages, attributes)
   #   Builds the event and then publishes all unpublished events
   #
   #   @param (see #remember)
@@ -56,7 +57,7 @@ module Informator
 
   # The same as `publish` except for it throws `:published` afterwards
   #
-  # @overload publish(type, messages, data)
+  # @overload publish(type, messages, attributes)
   #   Builds the event and then publishes all unpublished events
   #
   #   @param (see #remember)

data/lib/informator/event.rb

@@ -2,22 +2,23 @@
 
 module Informator
 
-  # Class Event provides an immutable container for hash of some data, to
+  # Class Event provides an immutable container for hash of some attributes, to
   # which a type is attached. It also contains an array of human-readable
   # messages describing the event.
   #
-  # The primary goal of events is folding data to be returned and/or sent
+  # The primary goal of events is folding attributes to be returned and/or sent
   # between various objects into unified format.
   #
   # @example
   #   event = Event[:success, "bingo!", foo: :bar]
-  #   # => #<Event @type=:success, @messages=["bingo!"], @data={ :foo => :bar }>
+  #   # <Event @type=:success @messages=["bingo!"] @attributes={ :foo => :bar }>
+  #
   #   event.frozen?
   #   # => true
   #
   class Event
 
-    include Equalizer.new(:type, :data)
+    include Equalizer.new(:type, :attributes)
 
     # @!attribute [r] type
     #
@@ -25,11 +26,11 @@ module Informator
     #
     attr_reader :type
 
-    # @!attribute [r] data
+    # @!attribute [r] attributes
     #
-    # @return [Hash] the event-specific data
+    # @return [Hash] the event-specific attributes
     #
-    attr_reader :data
+    attr_reader :attributes
 
     # @!attribute [r] messages
     #
@@ -38,12 +39,12 @@ module Informator
     attr_reader :messages
 
     # @!scope class
-    # @!method [](type, messages, data)
+    # @!method [](type, messages, attributes)
     # Builds the event
     #
     # @param [#to_sym] type
     # @param [#to_s, Array<#to_s>] messages
-    # @param [Hash] data
+    # @param [Hash] attributes
     #
     # @return [Informator::Event]
     def self.[](*args)
@@ -51,11 +52,11 @@ module Informator
     end
 
     # @private
-    def initialize(type, *messages, **data)
-      @type     = type.to_sym
-      @messages = messages.flatten.map(&:to_s)
-      @data     = data
-      freeze
+    def initialize(type, *messages, **attributes)
+      @type       = type.to_sym
+      @messages   = messages.flatten.map(&:to_s)
+      @attributes = attributes
+      IceNine.deep_freeze(self)
     end
 
   end # class Event

data/lib/informator/reporter.rb

@@ -9,7 +9,7 @@ module Informator
   #   reporter.events # => []
   #
   #   reporter.remember :success
-  #   reporter.events # => [#<Event @type=:success @data={} @messages=[]>]
+  #   reporter.events # => [#<Event @type=:success @attributes={} @messages=[]>]
   #
   #   # this will call subscriber.notify for any event
   #   reporter.notify subscriber
@@ -22,7 +22,7 @@ module Informator
     # @private
     def initialize
       @events = []
-      freeze
+      freeze # freezes the instance, but left events mutable!
     end
 
     # @!attribute [r] events
@@ -30,7 +30,7 @@ module Informator
     #   the list of registered events that havent'b been published yet
     attr_reader :events
 
-    # @!method remember(type, messages, data)
+    # @!method remember(type, messages, attributes)
     # Registers the event to be published to subscribers
     #
     # @param (see Informator::Event.new)
@@ -59,7 +59,7 @@ module Informator
 
     def publish(subscribers)
       event = events.shift
-      subscribers.each { |subscriber| subscriber.notify event }
+      subscribers.each { |subscriber| subscriber.notify(event) }
     end
 
   end # class Reporter

data/lib/informator/subscriber.rb

@@ -11,11 +11,11 @@ module Informator
   #   subscriber.frozen? # => true
   #
   #   event  = Informator::Event.new :success
-  #   # => #<Event @type=:success @data={} @messages=[]>
+  #   # => #<Event @type=:success @attributes={} @messages=[]>
   #
   #   subscriber.notify event
   #   object.event
-  #   # => #<Event @type=:success @data={} @messages=[]>
+  #   # => #<Event @type=:success @attributes={} @messages=[]>
   #
   # @api private
   #
@@ -48,7 +48,7 @@ module Informator
     def initialize(object, callback = :receive)
       @object   = object
       @callback = callback.to_sym
-      freeze
+      IceNine.deep_freeze(self)
     end
 
     # Sends the event to the subscriber object via its callback

data/lib/informator/version.rb

@@ -4,6 +4,6 @@ module Informator
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "0.0.2".freeze
+  VERSION = "0.1.0".freeze
 
 end # module Informator

data/spec/unit/informator/event_spec.rb

@@ -37,18 +37,18 @@ describe Informator::Event do
 
   end # describe #messages
 
-  describe "#data" do
+  describe "#attributes" do
 
-    subject { event.data }
+    subject { event.attributes }
     it { is_expected.to eq(baz: :qux) }
 
-  end # describe #data
+  end # describe #attributes
 
   describe "#==" do
 
     subject { event == other }
 
-    context "to event with the same type and data" do
+    context "to event with the same type and attributes" do
 
       let(:other) { Class.new(described_class).new type, baz: :qux }
       it { is_expected.to eql true }
@@ -62,7 +62,7 @@ describe Informator::Event do
 
     end # context
 
-    context "to event with other data" do
+    context "to event with other attributes" do
 
       let(:other) { described_class.new :success, baz: "qux" }
       it { is_expected.to eql false }

data/spec/unit/informator/subscriber_spec.rb

@@ -4,7 +4,7 @@ describe Informator::Subscriber do
 
   let(:callback) { "foo" }
   let(:event)    { double }
-  let(:object)   { double callback.to_sym => callback }
+  let(:object)   { double callback.to_sym => callback, freeze: nil }
 
   subject(:subscriber) { described_class.new object, callback }
 
@@ -61,12 +61,12 @@ describe Informator::Subscriber do
 
     context "to event with another object" do
 
-      let(:other) { described_class.new object.dup, callback }
+      let(:other) { double freeze: nil }
       it { is_expected.to eql false }
 
     end # context
 
-    context "to event with other data" do
+    context "to event with other attributes" do
 
       let(:other) { described_class.new object, :other }
       it { is_expected.to eql false }

data/spec/{integration → unit}/informator_spec.rb

@@ -7,7 +7,13 @@ describe Informator do
   let(:klass)    { Class.new { include Informator } }
   let(:callback) { :on_received }
   let(:listener) do
-    double receive: nil, callback => nil, foo: nil, bar: nil, receive: nil
+    double(
+      callback => nil,
+      foo: nil,
+      bar: nil,
+      receive: nil,
+      freeze: nil
+    )
   end
 
   before { informator.subscribe listener, callback }
@@ -67,7 +73,7 @@ describe Informator do
         expect(event).to be_kind_of Informator::Event
         expect(event.type).to eq :alert
         expect(event.messages).to eql %w(foo)
-        expect(event.data).to eql(bar: :baz)
+        expect(event.attributes).to eql(bar: :baz)
       end
 
       informator.publish :alert, "foo", bar: :baz
@@ -129,7 +135,7 @@ describe Informator do
     end
 
     it "throws :published" do
-      expect { informator.publish! }.to raise_error
+      expect { informator.publish! }.to raise_error(ArgumentError)
       expect { catch(:published) { informator.publish! } }.not_to raise_error
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: informator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 description: 
 email: andrew.kozin@gmail.com
 executables: []
@@ -76,11 +90,11 @@ files:
 - lib/informator/reporter.rb
 - lib/informator/subscriber.rb
 - lib/informator/version.rb
-- spec/integration/informator_spec.rb
 - spec/spec_helper.rb
 - spec/unit/informator/event_spec.rb
 - spec/unit/informator/reporter_spec.rb
 - spec/unit/informator/subscriber_spec.rb
+- spec/unit/informator_spec.rb
 homepage: https://github.com/nepalez/informator
 licenses:
 - MIT
@@ -104,10 +118,10 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Implementation of subscribe/publish design pattern
+summary: Implementation of publish/subscribe design pattern
 test_files:
 - spec/spec_helper.rb
-- spec/integration/informator_spec.rb
+- spec/unit/informator_spec.rb
 - spec/unit/informator/event_spec.rb
 - spec/unit/informator/reporter_spec.rb
 - spec/unit/informator/subscriber_spec.rb