execution_deadline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8db051c4e993ec213f306abdbd5bc2b040ee54a1deaf2dd3e792499bd7df2281
+  data.tar.gz: 51f845449e648ff5194b80e03c99e38678c483da9b3f7768d3c839010870034a
+SHA512:
+  metadata.gz: 557fcc632853b4d9f36ade03025724900060e2c6a2469f0d53f71f5f1184d455a87f21d77bd7409577c265ebe0349ff83e2826dcbe8c3849a5cb1943eb003101
+  data.tar.gz: d8daf31b451a24e88a69854a32fb29a852932cba06a191ab98c03cd3e539145f238a4a2823e90d1a9ef400678cd3fd9358abbffdbd6b962ffc9783a2895dbbe3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

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 bmalinconico@terminus.com. 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,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in execution_deadline.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Brian Malinconico
+
+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,207 @@
+# ExecutionDeadline
+
+Odds are, you should never ever, ever, use Ruby's built in timeout module
+unless you are 100% certain the wrapped code may be interrupted at any point.
+This gem provides a way to easily identify safe breakpoints for timeout
+operations.
+
+Usage of this gem should be combined with [the-ultimate-guide-to-ruby-timeouts](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts)
+to ensure your application releases resources from otherwise stuck threads.
+
+## Why use deadlines?
+[gRPC and Deadlines](https://grpc.io/blog/deadlines/)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'execution_deadline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install execution_deadline
+
+## Usage
+
+### Deadline Enforcement
+
+Deadlines are enforced only at breakpoints in the code specifically marked as
+safe to error. This is most easily done with the simple method wrappers
+provided in ExecutionDeadline::Helpers.
+
+#### Examples
+
+```ruby
+class SlowClass
+  extend ExecutionDeadline::Helpers
+
+  deadline in: 1
+  def perform
+    sub_method_1
+    sub_method_1
+    method_never_called
+  end
+
+  deadline runs_for: 0.6
+  def sub_method_1
+    sleep 0.7
+  end
+
+  def method_never_called; end
+end
+
+instance = SlowClass.new
+instance.perform # Throws OutOfTime error since sub_method_1 takes 0.6s of
+                 # the total allowed 1s execution time. Since only 0.4s
+                 # is left, the second execution of sub_method_1 is prevented
+```
+
+When calculating time left after the execution of a method the actual execution
+time of the method is used. Consider the above example, but with a shorter
+actual execution time.
+
+```ruby
+class ThinksItsSlowClass
+  extend ExecutionDeadline::Helpers
+
+  deadline in: 1
+  def perform
+    sub_method_1
+    sub_method_1
+    method_never_called
+  end
+
+  deadline runs_for: 0.6
+  def sub_method_1
+    sleep 0.1
+  end
+
+  def method_is_called
+    :abcd
+  end
+end
+
+instance = SlowClass.new
+instance.perform # No errors are thrown and :abcd returned. Even though
+                 # sub_method_1 says it will take 0.6 seconds, it actually
+                 # takes 0.1 seconds. The second execution of sub_method_1 is
+                 # checked against the remaining 0.9s, and allowed to continue
+```
+
+Deadlines are also usable on class methods and module methods.
+
+```ruby
+class SlowClass
+  extend ExecutionDeadline::Helpers
+
+  deadline in: 1
+  def self.perform
+    sub_method_1
+    sub_method_1
+    method_never_called
+  end
+
+  deadline runs_for: 0.6
+  def self.sub_method_1
+    sleep 0.7
+  end
+
+  def self.method_never_called; end
+end
+
+SlowClass..perform # Throws OutOfTime error
+
+module SlowModule
+  extend ExecutionDeadline::Helpers
+
+  deadline in: 1
+  def self.perform
+    sub_method_1
+    sub_method_1
+    method_never_called
+  end
+
+  deadline runs_for: 0.6
+  def self.sub_method_1
+    sleep 0.7
+  end
+
+  def self.method_never_called; end
+end
+
+SlowModule.perform # Throws OutOfTime error
+```
+
+### Raised Errors
+`ExecutionDeadline::OutOfTime` - Raised when a deadlined method is called but
+  there is less time left then the expected runtime.
+
+`ExecutionDeadline::DeadlineExceeded` - Raised when a deadlined method is
+and completed after the deadline time has passed.
+
+All errors are subclasses of `ExecutionDeadline::DeadlineError`
+
+#### Customizing Errors
+
+The errors raised may be customized using the `raises` keyword. The error to be
+raised may _only_ be set when the deadline is defined (using the `in` keyword)
+
+```ruby
+module SlowModule
+  class CustomError < StandardError; end
+  extend ExecutionDeadline::Helpers
+
+  deadline in: 1, raises: CustomError
+  def self.runs_out_of_time
+    sub_method_1
+    sub_method_1
+    method_never_called
+  end
+
+  deadline runs_for: 0.6
+  def self.sub_method_1
+    sleep 0.8
+  end
+
+  deadline in: 1, raises: CustomError
+  def self.runs_over_time
+    runs_over
+    method_never_called
+  end
+
+  deadline runs_for: 0.5
+  def self.runs_over
+    sleep 1.1
+  end
+
+  def self.method_never_called; end
+end
+
+SlowModule.runs_out_of_time # Throws CustomError error in place of OutOfTime
+SlowModule.runs_over_time # Throws CustomError error in place of DeadlineExceeded
+```
+
+## 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]/execution_deadline. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ExecutionDeadline project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/execution_deadline/blob/master/CODE_OF_CONDUCT.md).

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 "execution_deadline"
+
+# 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/execution_deadline.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "execution_deadline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "execution_deadline"
+  spec.version       = ExecutionDeadline::VERSION
+  spec.authors       = ["Brian Malinconico"]
+
+  spec.summary       = %q{Manage code deadlines without the hard termination of Timeout}
+  spec.description   = %q{Easily create and enforce deadline timings for code without the harsh termination of the Timeout module.}
+  spec.homepage      = "https://github.com/arjes/execution_deadline"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/execution_deadline/deadline.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'execution_deadline/errors'
+
+module ExecutionDeadline
+  class Deadline
+    def initialize(expires_at:, raises: nil)
+      @expires_at = expires_at
+      @raises = raises
+    end
+
+    def runs_for(duration)
+      time_left < duration &&
+        raise(
+          @raises || OutOfTime,
+          "Unable to run method expected run time #{duration} " \
+          "but only #{time_left}s left"
+        )
+
+      yield.tap do
+        expired? && raise(@raises || DeadlineExceeded)
+      end
+    end
+
+    def time_left
+      @expires_at - Time.now
+    end
+
+    def expired?
+      @expires_at <= Time.now
+    end
+  end
+end

data/lib/execution_deadline/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ExecutionDeadline
+  class DeadlineError < StandardError; end
+  class OutOfTime < DeadlineError; end
+  class DeadlineExceeded < DeadlineError; end
+end

data/lib/execution_deadline/helpers.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'execution_deadline/version'
+require 'execution_deadline/deadline'
+
+module ExecutionDeadline
+  module Helpers
+    UNWRAPPED_METHOD_NAME_SUFFIX = "_without_deadline"
+    WRAPPED_METHOD = Proc.new do |options|
+      Proc.new do |*args, &blk|
+        set_deadline = options[:in]  && ExecutionDeadline.set_deadline(
+          expires_at: Time.now + options[:in],
+          raises: options[:raises]
+        )
+
+        if ExecutionDeadline.current_deadline && options[:runs_for]
+          ExecutionDeadline.current_deadline.runs_for(options[:runs_for]) do
+            send(options[:aliased_method_name], *args, &blk)
+          end
+        else
+          send(options[:aliased_method_name], *args, &blk)
+        end
+      ensure
+        ExecutionDeadline.clear_deadline! if set_deadline
+      end
+    end
+
+    def deadline(options = {})
+      options[:in] ||
+        options[:runs_for] ||
+        raise('expected deadline to include either :in or :runs_for')
+
+      @last_deadline_config = options
+    end
+
+    def method_added(method_name)
+      return super unless _has_deadline_config?
+
+      options = _fetch_and_reset_deadline_config
+      options[:aliased_method_name] ||= "_#{method_name}#{UNWRAPPED_METHOD_NAME_SUFFIX}".to_sym
+
+      alias_method options[:aliased_method_name], method_name
+
+      define_method(method_name, &WRAPPED_METHOD.call(options))
+    end
+
+    def singleton_method_added(method_name)
+      return super unless _has_deadline_config?
+
+      options = _fetch_and_reset_deadline_config
+
+      options[:aliased_method_name] ||= "_#{method_name}#{UNWRAPPED_METHOD_NAME_SUFFIX}".to_sym
+
+      singleton_class.class_eval do
+        alias_method options[:aliased_method_name], method_name
+      end
+
+      define_singleton_method(method_name, &WRAPPED_METHOD.call(options))
+    end
+
+    private
+
+    def _has_deadline_config?
+      !(@last_deadline_config.nil? || @last_deadline_config == {})
+    end
+
+    def _fetch_and_reset_deadline_config
+      @last_deadline_config.tap { @last_deadline_config = nil }
+    end
+
+    def _add_deadlined_method(method_name, options)
+    end
+
+  end
+end

data/lib/execution_deadline/version.rb

@@ -0,0 +1,3 @@
+module ExecutionDeadline
+  VERSION = "0.1.0"
+end

data/lib/execution_deadline.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'execution_deadline/version'
+require 'execution_deadline/helpers'
+
+module ExecutionDeadline
+  def self.current_deadline
+    Thread.current[:deadline]
+  end
+
+  def self.clear_deadline!
+    Thread.current[:deadline] = nil
+  end
+
+  # @param expires_at [Time] The time at which to set the current deadline to
+  #   expire
+  # @return [Boolean|Deadline] returns false if a deadline is already set, and
+  #   returns a deadline object if it was successfully set
+  def self.set_deadline(expires_at:, raises: nil)
+    !current_deadline &&
+      Thread.current[:deadline] = Deadline.new(expires_at: expires_at, raises: raises)
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: execution_deadline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Malinconico
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Easily create and enforce deadline timings for code without the harsh
+  termination of the Timeout module.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- execution_deadline.gemspec
+- lib/execution_deadline.rb
+- lib/execution_deadline/deadline.rb
+- lib/execution_deadline/errors.rb
+- lib/execution_deadline/helpers.rb
+- lib/execution_deadline/version.rb
+homepage: https://github.com/arjes/execution_deadline
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Manage code deadlines without the hard termination of Timeout
+test_files: []