harold 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 999bf26c131f015edef47e72ac9f6b231400b54ebf276cad8eb7c88c79645003
-  data.tar.gz: 5f12d443f19489932f676ca69f3db7565484c85c90945f0552a733d70cb685b5
+  metadata.gz: f28b164ddcc78416136bf13e8edae7c069280feefe2e5d9ac321ef1009505e1f
+  data.tar.gz: 8eb1cc7ebef6255a4d3ef47c01a62836fe1cff354e102b0d9acb79233a19af8a
 SHA512:
-  metadata.gz: e6c3f042e3eab3045f085168a799d4689ef6db09417d3f70d208f36bc09f301ecd6a3a732825c270b323f449ef62138974055961e3cf7701deb05c1418640e34
-  data.tar.gz: d4e0edf7a7d67517e436a83d41f77ac104233cf3c9267e7c6f1bd8ea5e6760d48fa74a62d5d7932a6247aaa2fd328d33aa96c89b3a66db32a2854d714f8f3e34
+  metadata.gz: 540890ebce56d693dceabdf2c444ee6d25318eb619abb7554ce329dd2e2b56f1f382e37561232bec58be20a909f401a9fe5e257a4d5b8b62ba7a2da06d814bab
+  data.tar.gz: 761c49f3bc1fcc80bb639b55218cd477f25917eb76f7d68d138eefd6306b3548c49f62124818614c19c491ff1c84bc31f6908655db0787e4e0f47e5cc5350df6

data/Gemfile.lock

@@ -1,40 +1,45 @@
 PATH
   remote: .
   specs:
-    harold (0.0.1)
+    harold (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    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)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
   ruby
@@ -46,4 +51,4 @@ DEPENDENCIES
   rubocop (~> 0.79)
 
 BUNDLED WITH
-   2.1.4
+   2.3.10

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.2'
   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/cancel.rb

@@ -24,14 +24,20 @@ module Harold
       # The result of this method are all the id's of operations which
       # have been added 'or' updated. All items which are added/updated
       # 'and' afterwards deleted will be non-present in this list.
+      # If an operation has been updated and afterards deleted, both
+      # operations will be returned.
       def useful_items(operations)
-        operations.each_with_object(Set.new) do |op, items|
-          if op.type == :delete && items.include?(op.id)
-            items.delete(op.id)
+        items = Hash.new { |hash, key| hash[key] = [] }
+
+        operations.each do |operation|
+          if operation.type == :delete && items[operation.id].include?(:add)
+            items.delete(operation.id)
           else
-            items.add(op.id)
+            items[operation.id] << operation.type
           end
         end
+
+        items.keys
       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.2
 platform: ruby
 authors:
 - grdw
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2022-04-22 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
@@ -79,7 +80,7 @@ metadata:
   homepage_uri: https://github.com/wetransfer/harold
   source_code_uri: https://github.com/wetransfer/harold
   changelog_uri: https://github.com/wetransfer/harold/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Helpers for collaborative environments
 test_files: []