debouncer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f9e8547ac8f499bf83f7ea0a798cbc0296d8e33
-  data.tar.gz: e585350713f4323b67f7c94c66b52c13929aa165
+  metadata.gz: 86b793306f411516a270b9eaa5ec1703dc0d068e
+  data.tar.gz: ffc85284be2c0847d21044fc33b9a97195f97e0e
 SHA512:
-  metadata.gz: 706f48631fa33382c9d219f6f64b1cd7416ef4bbc5d1bcc103a58318022c16e772395b31ca32ea338d273c2a1c9f8e82bf9047ad20f52c61542c699318dd5231
-  data.tar.gz: 665deabc223212af9b616d8509080908617d1490aaa34974b2fc9ce71f1cc99dbd49fde52b8890744b3aa25009dfd538c397fbb5654347ea03c18a7e5f6cf33f
+  metadata.gz: 525ea5eb59f3237090122124f7cfeb554801b0865bda50abe6d475e5fb0ccea345a6eb0486fbb240793e3ba7f09861313ec01624b1783043accc55d9297a5231
+  data.tar.gz: f947a3836cb89cafed1609639137c11cda52720f0c5828d92f075bc98f2be6e38a899510fa34004d01a3a0390298a90731dcc3ad807c7504145f6aa2333b83d7

data/README.md

@@ -114,6 +114,8 @@ def combine_messages(memo, messages)
 end
 ```
 
+If you're using grouping, calling `flush_send_warning` followed by `join_send_warning` won't have the effect you'd expect. When a group begins execution, the group's queue is cleared and a new queue is created, so joining that queue won't join the already-running thread. Instead, `flush_and_join_send_message` serves this purpose.
+
 Finally, you can also debounce class/module methods using the `mdebounce` method. If you want to combine calls on various instances of a class, a sound pattern is to debounce a class method and have instances call it. For example, consider broadcasting data changes to browsers, where you want to group changes to the same model together into single broadcasts:
 
 ```ruby
@@ -193,6 +195,16 @@ d.group(:messages).join
 d.join
 ```
 
+As mentioned in the previous section, calling `flush` followed by `join` on a group won't join the thread that started executing when you called `flush`.
+
+```ruby
+# This flushes and then joins an empty queue, returning instantly:
+d.group(:messages).flush.join
+
+# This flushes and waits for messages to be sent:
+d.group(:messages).flush!
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/debouncer.rb

@@ -51,7 +51,7 @@ class Debouncer
 
   def call_with_id(id, *args, &block)
     args << block if block
-    thread = nil
+    run_thread = nil
     exclusively do
       thread        = @timeouts[id] ||= new_thread { begin_delay id, args }
       @flush        = [id]
@@ -68,37 +68,44 @@ class Debouncer
           else
             args.empty? ? old_args : args
           end
-      if @flush == true
+      if @flush.is_a? Array
+        thread[:run_at] = Time.now + @delay
+      else
         thread.kill
         @timeouts.delete id
         @threads.delete thread
+        run_thread = new_thread { run_block thread }
+        run_thread = nil unless @flush
         @flush = false
-      else
-        thread[:run_at] = Time.now + @delay
       end
-    end or
-        run_block thread
+    end
+    run_thread.join if run_thread
     self
   end
 
-  def flush(id = EMPTY)
+  def flush(id = EMPTY, and_join: false)
     if @lock.owned?
       raise ArgumentError, 'You cannot flush other groups from inside a reducer' unless id == EMPTY || [id] == @flush
-      @flush = true
+      @flush = and_join
     elsif id == EMPTY
       flush @timeouts.keys.first while @timeouts.any?
     else
-      dead = exclusively do
-        if (thread = @timeouts.delete(id))
-          thread.kill
-          @threads.delete thread
+      thread = exclusively do
+        if (old_thread = @timeouts.delete(id))
+          old_thread.kill
+          @threads.delete old_thread
+          new_thread { run_block old_thread }
         end
       end
-      run_block dead if dead
+      thread.join if thread
     end
     self
   end
 
+  def flush!(*args)
+    flush *args, and_join: true
+  end
+
   def join(id = EMPTY, kill_first: false)
     if id == EMPTY
       while (thread = exclusively { @threads.find &:alive? })

data/lib/debouncer/debounceable.rb

@@ -15,8 +15,14 @@ class Debouncer
       debouncer = "@#{base_name}#{SUFFIXES[suffix]}_debouncer"
       extras    = ''
       if reduce_with
+        arity    = __send__(class_method ? :method : :instance_method, reduce_with).arity
+        expected = grouped ? 2..3 : 2
+        unless arity < 0 || expected === arity
+          raise ArgumentError, 'Expected %s%s%s to accept %s arguments, but it accepts %s.' %
+              [self.name, class_method ? '.' : '#', reduce_with, expected, arity]
+        end
         if grouped
-          extras << ".reducer { |old, new| [new.first, *self.#{reduce_with}(old[1..-1] || [], new[1..-1], new.first)] }"
+          extras << ".reducer { |old, new| [new.first, *self.#{reduce_with}(old[1..-1] || [], new[1..-1]#{', new.first' unless arity == 2})] }"
         else
           extras << ".reducer { |old, new| self.#{reduce_with} old, new }"
         end
@@ -37,6 +43,10 @@ class Debouncer
           #{debouncer}.flush *args if #{debouncer}
         end
 
+        def flush_and_join_#{name}(*args)
+          #{debouncer}.flush! *args if #{debouncer}
+        end
+
         def join_#{name}(*args)
           #{debouncer}.join *args if #{debouncer}
         end

data/lib/debouncer/group.rb

@@ -11,6 +11,7 @@ class Debouncer
 
     def call(*args, &block)
       @debouncer.call_with_id @id, *args, &block
+      self
     end
 
     def to_proc
@@ -19,14 +20,22 @@ class Debouncer
 
     def flush
       @debouncer.flush @id
+      self
+    end
+
+    def flush!
+      @debouncer.flush! @id
+      self
     end
 
     def join
       @debouncer.join @id
+      self
     end
 
     def kill
       @debouncer.kill @id
+      self
     end
 
     def inspect_params

data/lib/debouncer/version.rb

@@ -1,3 +1,3 @@
 class Debouncer
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debouncer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler