defer_proc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0b6a68f5efc24480758256d9edacdbef4ebebaf
+  data.tar.gz: 27ee0d11d670e7fd2adbd30c36f62ec617210e4b
+SHA512:
+  metadata.gz: b79f42405d5f8859a3ce41a2866211825993cb1df60ced8f4f3cca82c8efff5b318181d41ce4d35d38b4a2264c7cf192659241f5803c07dc8b23ad8096393651
+  data.tar.gz: 1b73ba1f6c4a04e91857ee1b338257eb73314310397ff1f6c0111c4e0abae62cb588dc36e3ae475619c8367bcf46f5b08df249538b6d5ae8b45d52757eb6a5ad

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rake_tasks
+/html/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,70 @@
+# DeferProc
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/defer_proc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'defer_proc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install defer_proc
+
+## Usage
+
+This gem can be used to defer execution of some blocks until certain conditions are met.
+
+The `DeferProc` class takes a block on initialization to run at a later time. The `DeferProc#until` and `DeferProc#while` methods are used to specify the conditions for later execution:
+
+```ruby
+  2.2.1 :001 > require 'defer_proc'
+   => true
+  2.2.1 :002 > trigger = false
+   => false
+  2.2.1 :003 > DeferProc.new { puts "Hello, World!" }.until { trigger }
+   => #<Thread:0xa3c8e58@/path/to/lib/defer_proc.rb:16 run>
+  2.2.1 :004 > trigger = true
+   => true
+  Hello, World
+```
+
+The method `DeferProc#until` defers execution *until* the block provided is true, and the method `DeferProc#while` defers execution *while* the block provided is true. The block provided to `DeferProc#until` or `DeferProc#while` runs in a separate thread, which polls the value of the conditional at specified intervals. By default, polling occurs every 1/10 of a second, although the interval can be specified when `DeferProc` is initialized:
+
+```ruby
+require 'defer_proc'
+
+# Defer usage of class until it exists, polling every second
+DeferProc.new(1.0) { FutureClass.do_something }.until { defined?(FutureClass) }
+
+class FutureClass
+  # Class definition
+end
+
+# FutureClass.do_something gets called
+```
+
+This gem was written for use in the [`dotfile`](https://github.com/tedstudley/dotfile.git) gem, to enable certain Rails features to be wrapped from inside the .irbrc or .pryrc ruby dotfiles.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/TedStudley/defer_proc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main      = 'README.md'
+
+  if rdoc.respond_to? :markup=
+    rdoc.markup  = 'markdown'
+  end
+  rdoc.generator = 'fivefish'
+
+  rdoc.rdoc_files.include(rdoc.main, 'lib/**/*.rb')
+end
+
+Rake::TestTask.new do |test|
+  test.libs.push 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.warning = true
+  test.verbose = true
+end
+
+desc 'Generates a coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "defer"
+
+# 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

data/bin/setup

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

data/defer_proc.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'defer_proc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "defer_proc"
+  spec.version       = DeferProc::VERSION
+  spec.authors       = ["tedstudley"]
+  spec.email         = ["tedstudley@gmail.com"]
+
+  spec.summary       = %q{Defer execution of a block until certain requirements are met.}
+  spec.homepage      = "https://github.com/tedstudley/defer_proc.git"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rdoc-generator-fivefish', '~> 0.1'
+  spec.add_development_dependency 'minitest'
+end

data/lib/defer_proc.rb

@@ -0,0 +1,45 @@
+require "defer_proc/version"
+
+# Class to defer execution of a block
+class DeferProc
+
+  # Initialize with the block for deferred execution
+  def initialize(interval=0.1, &block)
+    # `Procrastinate` requires a block be passed to initialization
+    throw ArgumentError.new("DeferProc must be initialized with a block") if block.nil?
+    # Interval must be a positive number
+    throw ArgumentError.new("Polling interval must be a number.") unless interval.is_a? Numeric
+    throw ArgumentError.new("Polling interval must be positive.") unless interval > 0
+
+    @interval = interval
+    @deferred_block = block
+  end
+
+  # Defer execution until the provided block is satisfied
+  def until(&conditional)
+    # `DeferProc#until` must be passed a conditional block
+    throw ArgumentError.new("A conditional block is required") if conditional.nil?
+
+    # forward the (negated) block to `DeferProc#while`
+    conditional_proc = Proc.new { not conditional.call }
+    self.while(&conditional_proc)
+  end
+
+  # Defer execution of the @deferred_block while the provided block is satisfied
+  def while(&conditional)
+    # `DeferProc#while` must be passed a conditional block
+    throw ArgumentError.new("A conditional block is required") if conditional.nil?
+
+    Thread.new {
+      # Lower the priority for the polling thread
+      Thread.current.priority = -2
+
+      while yield do
+        # Poll ever `@interval` seconds until the conditional block is satisfied.
+        sleep @interval
+      end
+      # Call the deferred block
+      @deferred_block.call
+    }
+  end
+end

data/lib/defer_proc/version.rb

@@ -0,0 +1,3 @@
+class DeferProc
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: defer_proc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tedstudley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tedstudley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- defer_proc.gemspec
+- lib/defer_proc.rb
+- lib/defer_proc/version.rb
+homepage: https://github.com/tedstudley/defer_proc.git
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Defer execution of a block until certain requirements are met.
+test_files: []
+has_rdoc: