harold 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 999bf26c131f015edef47e72ac9f6b231400b54ebf276cad8eb7c88c79645003
-  data.tar.gz: 5f12d443f19489932f676ca69f3db7565484c85c90945f0552a733d70cb685b5
+  metadata.gz: 9f0c669ead3b29951907de99683b9f405976519a2df862162089bd1ecd7acac1
+  data.tar.gz: 82373aa580155a2e0bd5662bfa4c0529a0007b2e58b5c911e851a5d93d5b7e31
 SHA512:
-  metadata.gz: e6c3f042e3eab3045f085168a799d4689ef6db09417d3f70d208f36bc09f301ecd6a3a732825c270b323f449ef62138974055961e3cf7701deb05c1418640e34
-  data.tar.gz: d4e0edf7a7d67517e436a83d41f77ac104233cf3c9267e7c6f1bd8ea5e6760d48fa74a62d5d7932a6247aaa2fd328d33aa96c89b3a66db32a2854d714f8f3e34
+  metadata.gz: b67d813a4fd9657c34977ddc79f917661a8ecc891d8f78c0d5ab1780279d0d12bdbd2130c5c20736ef859ebe235d96c4c9524f62d475c2fd2b3e5875b456eef0
+  data.tar.gz: 41e25bce01afa0fddaebea9c5be3a9a55896bde26697f7a85c1c5f538f98b57d597b23e79c4e327ddd3af23a22ab5a5be381ea82a3fd605dbf7c5c408fd2610d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    harold (0.0.1)
+    harold (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,31 +10,33 @@ GEM
     diff-lcs (1.3)
     jaro_winkler (1.5.4)
     parallel (1.19.1)
-    parser (2.7.0.2)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
     rainbow (3.0.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,3 +1,39 @@
 # harold [![Build Status](https://travis-ci.com/WeTransfer/harold.svg?token=9FxKF7M1tP265s2qQFFJ&branch=master)](https://travis-ci.com/WeTransfer/harold)
 
-A gem which acts like a bookkeeper for who did what to a certain context.
+A gem which acts like a bookkeeper for 'who did what' to a certain context and can apply filtering strategies. The context in this gem is invisible but it can be any structure to which changes need to be applied. Currently this gem has two strategies to filter out changes (known as 'operations'):
+
+## Harold::Strategies::Cancel
+
+This strategy cancels out `:add` and `:delete` operations to the same identifier.
+
+Usage:
+
+```ruby
+operations = [
+  Harold::Operation.new('1', :add),
+  Harold::Operation.new('1', :delete),
+  Harold::Operation.new('2', :add),
+]
+
+Harold::Strategies::Cancel.call(operations)
+# returns => [#<Harold::Operation:0x0000 @id="2", @type=:add, @payload={}>]
+```
+
+## Harold::Strategies::Update
+
+This strategy transforms `:add` and `:delete` operations to an `:update`
+statement based on a mutually shared 'scope'.
+
+Usage:
+
+```ruby
+operations = [
+  Harold::Operation.new('1', :delete, 'scope' => 1),
+  Harold::Operation.new('2', :add, 'scope' => 1),
+  Harold::Operation.new('2', :delete, 'scope' => 1),
+  Harold::Operation.new('3', :add, 'scope' => 1)
+]
+
+Harold::Strategies::Update.new('scope').call(operations)
+# returns => [#<Harold::Operation:0x0000 @id="3", @type=:update, @payload={'scope' => 1}>]
+```

data/harold.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'harold'
-  spec.version = '0.0.1'
+  spec.version = '0.1.0'
   spec.authors = ['grdw']
   spec.email = ['gerard@wetransfer.com']
 

data/lib/harold.rb

@@ -1,2 +1,3 @@
 require_relative 'operation'
 require_relative 'strategies/cancel'
+require_relative 'strategies/update'

data/lib/operation.rb

@@ -1,9 +1,9 @@
 module Harold
   class Operation
     VALID_TYPES = %i[add update delete].freeze
-    attr_reader :id, :type, :payload
+    attr_reader :id, :type, :payload, :attributes
 
-    def initialize(id, type, payload = {})
+    def initialize(id, type, payload = {}, attributes = {})
       unless VALID_TYPES.include?(type)
         raise ArgumentError,
               "#{type} is not a valid type"
@@ -12,6 +12,11 @@ module Harold
       @id = id
       @type = type
       @payload = payload
+      @attributes = attributes
+
+      attributes.each_pair do |key, val|
+        define_singleton_method(key) { val }
+      end
     end
   end
 end

data/lib/strategies/update.rb

@@ -0,0 +1,44 @@
+module Harold
+  module Strategies
+    class Update
+      def initialize(scope)
+        @scope = scope
+      end
+
+      def call(operations)
+        grouped = operations
+                  .select(&method(:scope))
+                  .group_by(&method(:scope))
+
+        grouped.each_value do |ops|
+          next unless updateable?(ops)
+
+          operations << update_operation(ops.last)
+          ops.each { |o| operations.delete(o) }
+        end
+
+        operations
+      end
+
+      private
+
+      def updateable?(ops)
+        types = ops.map(&:type).uniq.sort
+        types == %i[add delete]
+      end
+
+      def scope(operation)
+        operation.payload[@scope]
+      end
+
+      def update_operation(operation)
+        Operation.new(
+          operation.id,
+          :update,
+          operation.payload,
+          operation.attributes
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harold
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - grdw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/harold.rb
 - lib/operation.rb
 - lib/strategies/cancel.rb
+- lib/strategies/update.rb
 homepage: https://github.com/wetransfer/harold
 licenses:
 - GPL-3.0