reactor 0.11.4 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f2967da3845ee85524fe9c738839f0e6fdb29c7
-  data.tar.gz: c0ed7956ea7c152528db44ec1c898c47415d1cb5
+  metadata.gz: a875645d8c1549921096a747103a1a7af62180c2
+  data.tar.gz: ce40f2f7f17011fe49e54f9a30587ea45c7be874
 SHA512:
-  metadata.gz: a155ca4b6daf0250992a8e3a9a15f8b5a56ccab20a5e8c04ee80e26e19b234a4a9e486e5f6932bbb76226a7d3d3570235402a9eb9873175b0f4c398dc6788be7
-  data.tar.gz: 106ba452f9d9a2b2623157738f271f20afee7a6df280e4f9971a071ff572361e60fae79e414329076a0d4233bce55b8a9e9f2c77b21057f916be4f473ed9ab60
+  metadata.gz: f8e4d71a75a7d579950253820e1eb50e41525d10313f446a778e1c09bd39053cb6c97a0e478b1b47c2a4f190979101e5a1a770c96dcea5474d3fa585f14131ed
+  data.tar.gz: 55489b1ddc957731b19060258d2f916e4ddda221558f715dc150db902cde93329f5798acb4085f637d2ef48437cb39c76ddd84f308e45a26754365afadaf43a2

data/Changes.md

@@ -1,5 +1,16 @@
 # Reactor Change Log
 
+0.12.1
+-----------
+Fix unicode encoding protection to allow valid multi-byte unicode characters
+
+0.12.0
+-----------
+Use `__data__` as the internal data hash. THIS _MAY BE_ A BREAKING CHANGE.
+
+If someone wants to use the key `data` for their event attributes, it would get confused with the internal event data. The internal event data is now called `__data__`. 
+Some users of this library access event.data directly. This is a breaking change for them.
+
 0.11.4
 -----------
 Fixes an issue related to class reloading in Rails development and test modes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    reactor (0.11.2)
+    reactor (0.12.1)
       activerecord (< 5.0)
       sidekiq
 

data/lib/reactor/event.rb

@@ -2,12 +2,12 @@ class Reactor::Event
   include Reactor::OptionallySubclassable
   include Sidekiq::Worker
 
-  attr_accessor :data
+  attr_accessor :__data__
 
   def initialize(data = {})
-    self.data = {}.with_indifferent_access
+    self.__data__ = {}.with_indifferent_access
     data.each do |key, value|
-      value = value.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '') if value.is_a?(String)
+      value = value.encode('UTF-8', invalid: :replace, undef: :replace, replace: '') if value.is_a?(String)
       self.send("#{key}=", value)
     end
   end
@@ -58,9 +58,9 @@ class Reactor::Event
       message = new(data.merge(event: name, uuid: SecureRandom.uuid))
 
       if message.at
-        perform_at message.at, name, message.data
+        perform_at message.at, name, message.__data__
       else
-        perform_async name, message.data
+        perform_async name, message.__data__
       end
     end
 
@@ -95,24 +95,24 @@ class Reactor::Event
       send("#{method}_id", object.id)
       send("#{method}_type", object.class.to_s)
     else
-      data[method.to_s.gsub('=','')] = object
+      __data__[method.to_s.gsub('=','')] = object
     end
   end
 
   def try_getter(method)
     if polymorphic_association? method
       initialize_polymorphic_association method
-    elsif data.has_key?(method)
-      data[method]
+    elsif __data__.has_key?(method)
+      __data__[method]
     end
   end
 
   def polymorphic_association?(method)
-    data.has_key?("#{method}_type")
+    __data__.has_key?("#{method}_type")
   end
 
   def initialize_polymorphic_association(method)
-    data["#{method}_type"].constantize.find(data["#{method}_id"])
+    __data__["#{method}_type"].constantize.find(__data__["#{method}_id"])
   end
 
   def fire_database_driven_subscribers(data, name)

data/lib/reactor/version.rb

@@ -1,3 +1,3 @@
 module Reactor
-  VERSION = "0.11.4"
+  VERSION = "0.12.1"
 end

data/spec/event_spec.rb

@@ -29,6 +29,23 @@ describe Reactor::Event do
   let(:model) { ArbitraryModel.create! }
   let(:event_name) { :user_did_this }
 
+  describe 'encoding' do
+    let(:event) { Reactor::Event.new(thing_one: "\xAD", thing_two: "\xAB", money: "£900", emoji: "\u{1f4a9}") }
+
+    it 'strips bad characters' do
+      expect(event.thing_one).to eq('')
+      expect(event.thing_two).to eq('')
+    end
+
+    it 'allows valid multibyte UTF8' do
+      expect(event.money).to eq('£900')
+    end
+
+    it 'allows astral plane characters' do
+      expect(event.emoji).to eq("\u{1f4a9}")
+    end
+  end
+
   describe 'publish' do
     let!(:uuid) { 'uuid' }
     before { allow(SecureRandom).to receive(:uuid).and_return(uuid) }
@@ -140,7 +157,7 @@ describe Reactor::Event do
     let(:event_data) { {random: 'data', pet_id: cat.id, pet_type: cat.class.to_s, arbitrary_model: arbitrary_model } }
     let(:event) { Reactor::Event.new(event_data) }
 
-    describe 'data key fallthrough' do
+    describe 'data key interaction with internals' do
       subject { event }
 
       describe 'getters' do
@@ -152,12 +169,30 @@ describe Reactor::Event do
           its(:pet) { is_expected.to be_a MyModule::Cat }
           its('pet.id') { is_expected.to eq(MyModule::Cat.last.id) }
         end
+
+        context 'accessing the internal __data__' do
+          its(:__data__) do
+            is_expected.to eq ({
+                  'random' => 'data',
+                  'pet_id' => cat.id,
+                  'pet_type' => 'MyModule::Cat',
+                  'arbitrary_model_id' => arbitrary_model.id,
+                  'arbitrary_model_type' => arbitrary_model.class.name
+                })
+          end
+        end
+
+        context 'a key named "data"' do
+          let(:event_data) { {random: 'data', data: 'info' } }
+          its(:random) { is_expected.to eq('data') }
+          its(:data) { is_expected.to eq 'info' }
+        end
       end
 
       describe 'setters' do
         it 'sets simple keys' do
           event.simple = 'key'
-          expect(event.data[:simple]).to eq('key')
+          expect(event.__data__[:simple]).to eq('key')
         end
 
         it 'sets active_record polymorphic keys' do
@@ -168,8 +203,8 @@ describe Reactor::Event do
       end
     end
 
-    describe 'data' do
-      let(:serialized_event) { event.data }
+    describe '__data__' do
+      let(:serialized_event) { event.__data__ }
       specify { expect(serialized_event).to be_a Hash }
       specify { expect(serialized_event[:random]).to eq('data') }
     end

data/spec/models/concerns/subscribable_spec.rb

@@ -51,12 +51,6 @@ describe Reactor::Subscribable do
       Reactor::Event.publish(:bid_made, target: Auction.create!(start_at: 10.minutes.from_now))
     end
 
-    it 'protects against bad unicode characters in event attributes' do
-      expect {
-        Reactor::Event.publish(:bad_unicode, thing_one: "\xAD", thing_two: "\xAB" )
-      }.to_not raise_error
-    end
-
     describe 'building uniquely named subscriber handler classes' do
       it 'adds a static subscriber to the global lookup constant' do
         expect(Reactor::SUBSCRIBERS['puppy_delivered'][0]).to eq(Reactor::StaticSubscribers::Auction::PuppyDeliveredHandler)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reactor
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.12.1
 platform: ruby
 authors:
 - winfred
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq