concurrent-polling 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06d620fe5303099e5e33bb1c5f0cc9aa63db4887
+  data.tar.gz: a55dca6423e435f84a7fd0ca04f65a728a2df9f9
+SHA512:
+  metadata.gz: e88c768dba9788757b6fe18eb7073243f99dff8332f2d3d45689234dae888c16711448dec5d3ea7fd68d8009ea27b4f05137653e39cc8bb99eca74af36f4da4b
+  data.tar.gz: c7599a9a65899afa9dbe782216eb32fb586d6ba773cedf7f01572ab9985101476445c03506c7f92b71398f4ecc245c06977c6cf79e8906f8617ed25c863adf65

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.1.1
+- 2.0.0
+- jruby-head
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Dd0l16iSFErUc9ClkPfStyqMKFY1PpA1qX5+59kTwF6+3srgNiDLzlLnxxAj7ESNS5JCRSbt0URWIotRApNTz0qAdPww5radc+9y6iDtRU7OGh1N3aFJZDtYv+0gs0dzm5tQjrPBwePQOLnzN5x/3iHv9Ei1avk3cqQwoWPrhIg=
+  gem: concurrent-polling
+  on:
+    tags: false
+    repo: falti/concurrent-polling

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Frank Falkenberg
+
+MIT License
+
+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,29 @@
+# Concurrent::Polling
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'concurrent-polling'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install concurrent-polling
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/concurrent-polling/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 new Pull Request

data/Rakefile

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

data/concurrent-polling.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'concurrent/polling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "concurrent-polling"
+  spec.version       = Concurrent::Polling::VERSION
+  spec.authors       = ["Frank Falkenberg"]
+  spec.email         = ["faltibrain@gmail.com"]
+  spec.summary       = %q{Concurrency based polling.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby", '~> 0.6.1'
+  spec.add_dependency "values", '~> 1.5'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+end

data/lib/concurrent/polling.rb

@@ -0,0 +1,70 @@
+require "concurrent"
+require "concurrent/polling/version"
+require "values"
+
+module Concurrent
+
+  module Polling
+    DEFAULT_OPTIONS = {
+      retries: 1,
+      success_condition: lambda {|polled_value| true },
+      poll: lambda { :default_options_polling_result }
+    }
+
+
+    TimeoutError = Class.new(StandardError)
+    ConditionError = Class.new(StandardError)
+
+    class TempResult < Value.new(:ok, :retries, :reason); end
+    class FinalResult < Value.new(:ok, :reason); end
+
+    class Solver
+
+      def initialize(poll_function, check_function)
+        @poll_function = poll_function
+        @check_function = check_function
+      end
+
+      def solve(result)
+
+        condition_met = begin
+          @check_function.call(result.ok)
+        rescue Exception => e
+          raise ConditionError.new(e)
+        end
+
+        if(condition_met)
+          result
+        elsif result.retries == 0
+          raise TimeoutError.new
+        else
+
+          future = Concurrent::Future.new(&@poll_function).execute
+
+          future_result = future.value # blocking
+
+          solve(TempResult.new(future_result, (result.retries - 1) , nil))
+        end
+      end
+    end
+
+    def self.poll(options = {})
+
+      opts = DEFAULT_OPTIONS.merge(options)
+
+      success_condition = opts[:success_condition]
+      poll = opts[:poll]
+
+
+      retries = opts[:retries]
+
+      solver = Solver.new(poll, success_condition )
+      promise = Promise.new{ solver.solve(TempResult.new(poll.call(), retries, nil)) }
+        .rescue { |reason| FinalResult.with(ok: nil, reason: reason)}
+        .then { |result| FinalResult.new(result.ok, result.reason) }
+
+      promise.execute
+      promise.value
+    end
+  end
+end

data/lib/concurrent/polling/version.rb

@@ -0,0 +1,5 @@
+module Concurrent
+  module Polling
+    VERSION = "0.0.1"
+  end
+end

data/spec/polling_spec.rb

@@ -0,0 +1,90 @@
+
+RSpec.describe Concurrent::Polling do
+
+  it "should poll with default options" do
+    polling_result = Concurrent::Polling.poll()
+    expect(polling_result.ok).to eq(:default_options_polling_result)
+  end
+
+  it "should handle exceptions on the poll proc" do
+    polling_result = Concurrent::Polling.poll(poll: lambda{ raise "polling boom" })
+
+    expect(polling_result.ok).to be_nil
+    expect(polling_result.reason).to be_a RuntimeError
+  end
+
+
+
+  it "should handle expection on the success_condition proc" do
+    polling_result = Concurrent::Polling.poll(success_condition: lambda{|result| raise "some error" })
+    expect(polling_result.ok).to be_nil
+    expect(polling_result.reason).to be_a Concurrent::Polling::ConditionError
+  end
+
+  it "should run into timeout" do
+    polling_result = Concurrent::Polling.poll(success_condition: lambda{|result| false })
+
+
+    expect(polling_result.ok).to be_nil
+    expect(polling_result.reason).to be_a Concurrent::Polling::TimeoutError
+
+  end
+
+  it "should work with custom options" do
+
+    polling = Concurrent::Polling.poll(
+      retries: 10,
+      execution_interval: 0.1,
+      timeout_interval: 0.01,
+      success_condition: lambda {|result| result == "success" },
+      poll: Proc.new do
+        "success"
+      end
+    )
+
+    expect(polling.ok).to eq("success")
+
+  end
+
+  describe "Stress Test" do
+
+    it "should work with multiple polls" do
+      puts "running the multi test"
+      futures = (1..10000).map do |i|
+
+        f = Concurrent::Future.new do
+          polling = Concurrent::Polling.poll(
+          retries: 10,
+          success_condition: lambda {|result| true },
+          poll: Proc.new do
+            "success"
+          end
+          )
+
+          polling
+
+          #expect(polling.ok).to eq("success#{i}")
+        end
+
+        f.execute
+        f.value
+      end
+
+
+      sleep(1)
+
+      futures.each do |f|
+        expect(f.ok).to be_truthy
+        expect(f.ok).to eq("success")
+
+
+      end
+
+
+
+    end
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+$VERBOSE=nil
+$LOAD_PATH.unshift  File.expand_path("../lib",__FILE__)
+require 'concurrent/polling'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+    # These two settings work together to allow you to limit a spec run
+    # to individual examples or groups you care about by tagging them with
+    # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+    # get run.
+    config.filter_run :focus
+    config.run_all_when_everything_filtered = true
+
+    # Many RSpec users commonly either run the entire suite or an individual
+    # file, and it's useful to allow more verbose output when running an
+    # individual spec file.
+    if config.files_to_run.one?
+      # Use the documentation formatter for detailed output,
+      # unless a formatter has already been configured
+      # (e.g. via a command-line flag).
+      config.default_formatter = 'doc'
+    end
+
+    # Print the 10 slowest examples and example groups at the
+    # end of the spec run, to help surface which specs are running
+    # particularly slow.
+    config.profile_examples = 10
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = :random
+
+    # Seed global randomization in this process using the `--seed` CLI option.
+    # Setting this allows you to use `--seed` to deterministically reproduce
+    # test failures related to randomization by passing the same `--seed` value
+    # as the one that triggered the failure.
+    Kernel.srand config.seed
+
+    # rspec-expectations config goes here. You can use an alternate
+    # assertion/expectation library such as wrong or the stdlib/minitest
+    # assertions if you prefer.
+    config.expect_with :rspec do |expectations|
+      # Enable only the newer, non-monkey-patching expect syntax.
+      # For more details, see:
+      #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+      expectations.syntax = :expect
+    end
+
+    # rspec-mocks config goes here. You can use an alternate test double
+    # library (such as bogus or mocha) by changing the `mock_with` option here.
+    config.mock_with :rspec do |mocks|
+      # Enable only the newer, non-monkey-patching expect syntax.
+      # For more details, see:
+      #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+      mocks.syntax = :expect
+
+      # Prevents you from mocking or stubbing a method that does not exist on
+      # a real object. This is generally recommended.
+      mocks.verify_partial_doubles = true
+    end
+=end
+
+    config.expect_with :rspec do |expectations|
+      expectations.syntax = :expect
+    end
+
+    config.mock_with :rspec do |mocks|
+      mocks.syntax = :expect
+      mocks.verify_partial_doubles = true
+    end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: concurrent-polling
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Frank Falkenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
+- faltibrain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- concurrent-polling.gemspec
+- lib/concurrent/polling.rb
+- lib/concurrent/polling/version.rb
+- spec/polling_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Concurrency based polling.
+test_files:
+- spec/polling_spec.rb
+- spec/spec_helper.rb