debouncer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c5f11d271a659197a50ff8aeeec2ca4de582a46
+  data.tar.gz: 2de745511d408a7a3885ab51127ffc972059aa06
+SHA512:
+  metadata.gz: 7fb76db2e170d28b71e30515b91be732b3336d078333059565996a77873e5b83c08e856bf460e9ea0d61b99bdfa7adbfdc8795b3f9a8708b456b5541f7be0aa8
+  data.tar.gz: 65d859b8392e1f3962b384ed29866a4e08c4f9ab0745c335449e92f7dd80c0eb5a6cb1aebc3b34040a596aace74c838ecaf1ccab4ba4654c2d41a66e0c4c4332

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.3
+  - 2.3.3
+before_install: gem install bundler -v 1.14.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at neil@pearson.sydney. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in debouncer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Neil E. Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Debouncer
+
+Background thread debouncing for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'debouncer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install debouncer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/debouncer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'debouncer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/debouncer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'debouncer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'debouncer'
+  spec.version       = Debouncer::VERSION
+  spec.authors       = ['Neil E. Pearson']
+  spec.email         = ['neil@pearson.sydney']
+
+  spec.summary       = 'Debouncer'
+  spec.description   = 'Background thread debouncing for Ruby.'
+  spec.homepage      = 'https://github.com/hx/debouncer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/debouncer.rb

@@ -0,0 +1,127 @@
+require 'debouncer/version'
+
+class Debouncer
+  def initialize(delay, &block)
+    raise ArgumentError, 'Expected a number' unless delay.is_a? Numeric
+    @delay    = delay
+    @timeouts = {}
+    @threads  = []
+    @lock     = Mutex.new
+    @rescuers = {}
+    block.arity.zero? ? instance_exec(&block) : yield(self) if block
+  end
+
+  def reducer(*initial, &block)
+    @reducer = [initial, block]
+    self
+  end
+
+  def limiter(&block)
+    @limiter = block
+    self
+  end
+
+  def rescuer(kind = StandardError, &block)
+    @rescuers[kind] = block
+    self
+  end
+
+  def debounce(id = nil, *args, &block)
+    raise ArgumentError, 'Expected a block' unless block
+    exclusively do
+      thread = @timeouts[id] ||= new_thread { begin_delay id, &block }
+      @flush = [id]
+      args   = reduce_args(thread, args, id)
+      if (@limiter && !@limiter[*args]) || @flush == true
+        thread.kill
+        @timeouts.delete id
+        @threads.delete thread
+        @flush = false
+      else
+        thread[:args]   = args
+        thread[:run_at] = Time.now + @delay
+      end
+    end or
+        yield *args
+    self
+  end
+
+  def flush(*args)
+    if args.empty?
+      if @lock.owned?
+        @flush = true
+      else
+        flush @timeouts.keys.first while @timeouts.any?
+      end
+    else
+      id = args.first
+      if @lock.owned? && @flush == [id]
+        @flush = true
+      else
+        dead = exclusively do
+          if (thread = @timeouts.delete(id))
+            thread.kill
+            @threads.delete thread
+          end
+        end
+        dead[:block].call *dead[:args] if dead
+      end
+    end
+    self
+  end
+
+  def join(kill_first = false)
+    while (thread = exclusively { @threads.find &:alive? })
+      thread.kill if kill_first
+      thread.join
+    end
+    exclusively { [@threads, @timeouts].each &:clear } if kill_first
+    self
+  end
+
+  def kill
+    join true
+  end
+
+  def inspect
+    "#<#{self.class}:0x#{'%014x' % (object_id << 1)} delay: #{@delay} timeouts: #{@timeouts.count} threads: #{@threads.count}>"
+  end
+
+  private
+
+  def begin_delay(id, &block)
+    thread[:block] = block
+    sleep @delay
+    until exclusively { (thread[:run_at] <= Time.now).tap { |ready| @timeouts.delete id if ready } }
+      sleep [thread[:run_at] - Time.now, 0].max
+    end
+    yield *thread[:args]
+  rescue => ex
+    @timeouts.reject! { |_, v| v == thread }
+    (rescuer = @rescuers.find { |klass, _| ex.is_a? klass }) && rescuer.last[ex]
+  ensure
+    exclusively { @threads.delete thread }
+  end
+
+  def reduce_args(thread, new_args, id)
+    old_args = thread[:args]
+    if @reducer
+      initial, reducer = @reducer
+      reducer[old_args || initial || [], new_args, id]
+    else
+      new_args.empty? ? old_args : new_args
+    end
+  end
+
+  def new_thread(*args, &block)
+    Thread.new(*args, &block).tap { |t| @threads << t }
+  end
+
+  def exclusively(&block)
+    @lock.synchronize &block
+  end
+
+  def thread
+    Thread.current
+  end
+end

data/lib/debouncer/debounceable.rb

@@ -0,0 +1,74 @@
+require 'debouncer'
+
+class Debouncer
+  module Debounceable
+    def debounce(name, delay, rescue_with: nil, group_by: :object_id, reduce_with: nil)
+      name =~ /^(\w+)([?!=]?)$/ or
+          raise ArgumentError, 'Invalid method name'
+
+      base_name = $1
+      suffix    = $2
+      immediate = "#{base_name}_immediately#{suffix}"
+
+      debouncer_for_method name, delay do |d|
+        d.rescuer do |ex|
+          case rescue_with
+            when Symbol
+              __send__ rescue_with, ex
+            when Proc
+              rescue_with[ex]
+            else
+              # Silent failure
+          end
+        end if rescue_with
+
+        d.reducer do |old, args, id|
+          case reduce_with
+            when Symbol
+              debouncing_instance(name, id).__send__ reduce_with, old, args
+            when Proc
+              reduce_with[old, args, id]
+            else
+              raise ArgumentError
+          end
+        end if reduce_with
+      end
+
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        alias_method :#{immediate}, :#{name}
+
+        def #{name}(*args)
+          id = #{group_by}
+          #{self.name}.debouncing_instance :#{name}, id, self
+          #{self.name}.debouncer_for_method(:#{name}).debounce(id, *args) { |*args| #{immediate} *args }
+        end
+
+        def flush_#{name}
+          #{self.name}.debouncer_for_method(:#{name}).flush #{group_by}
+        end
+
+        def self.join_#{name}
+          debouncer_for_method(:#{name}).join
+        end
+
+        def self.cancel_#{name}
+          debouncer_for_method(:#{name}).kill
+        end
+      RUBY
+    end
+
+    def debouncer_for_method(name, delay = 0, &block)
+      @method_debouncers       ||= {}
+      @method_debouncers[name] ||= Debouncer.new(delay, &block)
+    end
+
+    def debouncing_instance(method, id, instance = nil)
+      hash = (@debouncing_instances ||= {})[method] ||= {}
+      if instance
+        hash[id] = instance
+      else
+        hash[id]
+      end
+    end
+  end
+end

data/lib/debouncer/version.rb

@@ -0,0 +1,3 @@
+class Debouncer
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: debouncer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil E. Pearson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Background thread debouncing for Ruby.
+email:
+- neil@pearson.sydney
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- debouncer.gemspec
+- lib/debouncer.rb
+- lib/debouncer/debounceable.rb
+- lib/debouncer/version.rb
+homepage: https://github.com/hx/debouncer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Debouncer
+test_files: []