emque-producing 1.0.0.beta5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f1afb52e6d649ccd49c231cc44ed853ee6e7834
-  data.tar.gz: 2169b3b4ceec2cb7a2487045600a34f20abc1722
+  metadata.gz: 7696c08ea749cf14c85f0ce963fc626038baa140
+  data.tar.gz: ea30e9981cb33b17abf705ee85a9d37a946a4180
 SHA512:
-  metadata.gz: 7e20a78cc95c44aba310fd4fee0f0723126e2f90dfcbf789359d2efde6412d0fc173139638b2d7d11d7942ec5204658d781a06d44cd58f438b3ca98cf585e17f
-  data.tar.gz: a6d4c399e335789042399d73ac2802b99ed3b7eb434e0a2aa6360660e235e584f278a27fe2aed0e5ef41b65dd15833198c59dbfe1dd939a7af5ab2f1d20c9816
+  metadata.gz: d3132e5cbce4b9c1fec5a428e5d7d202e6d56fa4e7f03946df231e9a73435713f49acf1d4a7de07aea1cc27fb8dc64ed58b907d65f76aa3ceb6c184789a26247
+  data.tar.gz: 3025a044fd1d2ed21200b3d8aa093bc8b340dd6637dd42b7c5ccc6cb86c60489c6ec3ec03a65a2c95d81445f004ba5f221090420ae16daf4d7c964c2ac81c48d

data/README.md

@@ -53,6 +53,36 @@ Or install it yourself as:
     message = MyMessage.new({:first_property => 1, :another_property => "another"})
     message.publish
 
+    # create a message class including changesets
+    class MyChangesetMessage
+      include Emque::Producing.message(:with_changeset => true)
+      topic "topic1"
+      message_type "mymessage.new"
+
+      # Need to override an attribute name in the changeset? Simply define
+      # the old name and new name here. This can be useful for ensuring
+      # messages are consistent across varying producers.
+      translate_changeset_attrs :old_attr_name => :new_attr_name
+    end
+
+    produced_message = TestMessageWithChangeset.new(
+      :updated => {:old_attr_name => "Event"},
+      :original => {:old_attr_name => "Game"}
+    )
+    json = produced_message.to_json
+    consumed_message = Oj.load(json)
+    expect(consumed_message["change_set"]).to eql(
+      {
+        "original"=>{"new_attr_name"=>"Game"},
+        "updated"=>{"new_attr_name"=>"Event"},
+        "delta"=>{
+          "new_attr_name"=>{
+            "original"=>"Game", "updated"=>"Event"
+          }
+        }
+      }
+    )
+
 For a more thorough guide to creating new messages and/or message producing
 applications, [please read the wiki
 entry](https://github.com/teamsnap/emque-producing/wiki/Creating-New-Producing-Applications)
@@ -77,7 +107,7 @@ configuration option `publish_messages` to false like so:
     Emque::Producing.configure do |c|
       c.publish_messages = false
     ...other options
-    end 
+    end
 ```
 This will prevent Emque from actually attempting to make the connection to your
 adapter which may be convenient in the case of CI environments.

data/lib/emque/producing/message/message_with_changeset.rb

@@ -1,7 +1,15 @@
 module Emque
   module Producing
     module MessageWithChangeset
+      module ClassMethods
+        def translate_changeset_attrs(attrs = {})
+          @attrs_to_translate ||= {}
+          @attrs_to_translate.merge!(attrs)
+        end
+      end
+
       def self.included(base)
+        base.extend(ClassMethods)
         base.send(:include, Emque::Producing::Message)
         base.send(:attribute, :partition_key, String, :default => nil, :required => false)
         base.send(:attribute, :change_set, Hash, :default => :build_change_set, :required => true)
@@ -9,10 +17,18 @@ module Emque
         base.send(:private_attribute, :original)
       end
 
+      def translated_attrs
+        self.class.instance_variable_get(:@attrs_to_translate)
+      end
+
       def build_change_set
-        ChangesPayloadGenerator
-          .new({:original => original, :updated => updated})
-          .execute
+        ChangesPayloadGenerator.new(
+          {
+            :original => original,
+            :updated => updated,
+            :translated_attrs => translated_attrs
+          }
+        ).execute
       end
 
       def build_id
@@ -27,18 +43,45 @@ module Emque
     end
 
     class ChangesPayloadGenerator
-      def initialize(opts = {})
-        @original = opts.fetch(:original, {}) || {}
-        @updated = opts.fetch(:updated, {}) || {}
+      def initialize(changeset_data = {})
+        @original = changeset_data[:original] || {}
+        @updated = changeset_data[:updated] || {}
+        @translated_attrs = changeset_data[:translated_attrs] || {}
       end
 
       def execute
+        translate_attrs if translated_attrs.any?
         {:original => original, :updated => updated, :delta => delta}
       end
 
       private
 
-      attr_reader :original, :updated
+      attr_reader :original, :updated, :translated_attrs
+
+      def translate_attrs
+        @original = translate(original)
+        @updated = translate(updated)
+      end
+
+      def deep_copy(attr_set)
+        Oj.load(Oj.dump(attr_set))
+      end
+
+      def translate(attr_set)
+        deep_copy(attr_set).tap do |cloned_attrs|
+          stringified_attrs.each_pair do |old_name, new_name|
+            if cloned_attrs.key?(old_name)
+              cloned_attrs[new_name] = cloned_attrs.delete(old_name)
+            end
+          end
+        end
+      end
+
+      def stringified_attrs
+        {}.tap do |new_hash|
+          translated_attrs.each_pair { |k,v| new_hash[k.to_s] = v.to_s }
+        end
+      end
 
       def delta
         if original.empty?

data/lib/emque/producing/version.rb

@@ -1,5 +1,5 @@
 module Emque
   module Producing
-    VERSION = "1.0.0.beta5"
+    VERSION = "1.0.0"
   end
 end

data/spec/producing/message/message_spec.rb

@@ -3,16 +3,6 @@ require "virtus"
 require "emque/producing/message/message"
 require "emque/producing/message/message_with_changeset"
 
-class TestMessageWithChangeset
-  include Emque::Producing.message(:with_changeset => true)
-
-  topic "queue"
-  message_type "queue.new"
-
-  attribute :test_id, Integer, :required => true, :default => :build_id
-  private_attribute :extra, String, :default => "value"
-end
-
 class TestMessageWithChangesetCustomBuildId
   include Emque::Producing.message(:with_changeset => true)
 
@@ -53,10 +43,66 @@ class MessageNoType
   topic "testing"
 end
 
+class TestMessageWithChangeset
+  include Emque::Producing.message(:with_changeset => true)
+
+  topic "queue"
+  message_type "queue.new"
+
+  attribute :test_id, Integer, :required => true, :default => :build_id
+  private_attribute :extra, String, :default => "value"
+  translate_changeset_attrs(
+    :type => :event_type, :date => :event_date, :not_an_attr => :still_not_an_attr
+  )
+end
+
 describe Emque::Producing::Message do
-  before do
-    Emque::Producing.configure do |c|
-      c.app_name = "my_app"
+  before { Emque::Producing.configure { |c| c.app_name = "my_app" } }
+
+  describe "translating changeset attr names" do
+    it "allows a client to change attr names in the changeset message" do
+      produced_message = TestMessageWithChangeset.new(
+        :test_id => 1,
+        :original => {"type" => "Game", "date" => "2000-01-02"},
+        :updated => {"type" => "Event", "date" => "2000-01-01"}
+      )
+      json = produced_message.to_json
+      consumed_message = Oj.load(json)
+      expect(consumed_message["change_set"]).to eql(
+        {
+          "original"=>{"event_type"=>"Game", "event_date"=>"2000-01-02"},
+          "updated"=>{"event_type"=>"Event", "event_date"=>"2000-01-01"},
+          "delta"=>{
+            "event_type"=>{
+              "original"=>"Game", "updated"=>"Event"
+            },
+            "event_date"=>{
+              "original"=>"2000-01-02", "updated"=>"2000-01-01"
+            }
+          }
+        }
+      )
+    end
+
+    it "does not add new attr if the old attr is not present" do
+      produced_message = TestMessageWithChangeset.new(
+        :test_id => 1,
+        :updated => {"type" => "Event"},
+        :original => {"type" => "Game"}
+      )
+      json = produced_message.to_json
+      consumed_message = Oj.load(json)
+      expect(consumed_message["change_set"]).to eql(
+        {
+          "original"=>{"event_type"=>"Game"},
+          "updated"=>{"event_type"=>"Event"},
+          "delta"=>{
+            "event_type"=>{
+              "original"=>"Game", "updated"=>"Event"
+            }
+          }
+        }
+      )
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emque-producing
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0
 platform: ruby
 authors:
 - Emily Dobervich
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -153,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2