intercept 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65efc6449e64770b9e8e4fc660e3ca5f2ff6944a6dffb98de6fb9c57f6e1bc38
-  data.tar.gz: 487e479414bd01699d4931b69295551f9e117f0a0a9195c84887f4856260c760
+  metadata.gz: b8545ab8342d8437069c4f8bae1096cc88a541932086c29a1a697fc5ddf53bd1
+  data.tar.gz: c72134e33df3909b77734d554c68c7ee3db58f037a04ef3bd1b4f7fcc7847eb0
 SHA512:
-  metadata.gz: 182782a85baf8ee54d6977512a25b9bc949d08c03de5d2a39cea00d6bcb9d02d6fe0bba2d894061bfb6079ee8dfb6cc8baacd0a818eb20f993ce1e4bfdd96c19
-  data.tar.gz: a60e30b42b9f8ca96c89d80da8f928cae6229f6bc1a699f5d0eb744c04c354abc36e1be8c63737d0ecb387f7176ec9bd0067acfed1a166aa4cac61297a4e00e0
+  metadata.gz: 215018d5e8bce4ee3bc2e49b733a28b92803bb747947ff44b3e95fe3e73a899ad1c7691a4fa274df44188d19678119c0e1b46568c6f65c3e3fa90a4e049fb9ea
+  data.tar.gz: f346a8deedd06161621330767bded0b3858d5ba07bc2742eb19a4ed0c2cd92694fb14d7258bdae50835880525e58b74201e91172da75d1b71d0ce7259d34e113

data/lib/intercept/strategy/mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intercept
   module Strategy
     class Mapper

data/lib/intercept/strategy/replace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intercept
   module Strategy
     class Replace

data/lib/intercept/strategy/white_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intercept
   module Strategy
     class WhiteList

data/lib/intercept/version.rb

@@ -1,3 +1,3 @@
 module Intercept
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/intercept/{builder.rb → worker.rb}

@@ -1,21 +1,31 @@
+# frozen_string_literal: true
+
 require 'intercept/strategy/replace'
 require 'intercept/strategy/mapper'
 require 'intercept/strategy/white_list'
 
 module Intercept
-  class Builder
+  # Base class of the intercept module.
+  # A worker object is responsible to intercept and modify state of registering class's objects
+  class Worker
     attr_reader :interceptor_map, :decorator_map
 
+    # @param registration_method [String, Symbol] method_name which is called by the registering class.
+    # @param interceptor_map [Hash] Keys represent fields to be modified. Values are Strategy class object
+    # @param decorator_map [Hash] Keys represent fields to be modified. Values are Decorator class object
     def initialize(registration_method, interceptor_map = {}, decorator_map = {})
       @interceptor_map = interceptor_map
       @decorator_map = decorator_map
 
-      if registration_method != 'delivering_message' && registration_method != :delivering_message
+      if registration_method != 'intercept' && registration_method != :intercept
         define_singleton_method(registration_method) { |message| delivering_message(message) }
       end
     end
 
-    def delivering_message(message)
+    # This method is called when we want to intercept and modify an object.
+    # 'registration_method' parameter of initialize is an alias to this method.
+    # @param message is an object of any registering class
+    def intercept(message)
       interceptor_map.each do |field, strategy|
         if message.respond_to?(field) && message.respond_to?("#{field}=")
           message.public_send("#{field}=", strategy.process_identities(message.public_send field))

data/lib/intercept.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'intercept/version'
-require 'intercept/builder'
+require 'intercept/worker'
 
 module Intercept
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercept
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gemin Patel
@@ -71,11 +71,11 @@ files:
 - bin/setup
 - intercept.gemspec
 - lib/intercept.rb
-- lib/intercept/builder.rb
 - lib/intercept/strategy/mapper.rb
 - lib/intercept/strategy/replace.rb
 - lib/intercept/strategy/white_list.rb
 - lib/intercept/version.rb
+- lib/intercept/worker.rb
 - spec/intercept_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/GeminPatel/intercept