event_machine-test 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b7a121f5bec41e4b6166b82ea73c3b3706d0469
+  data.tar.gz: 648055187bbcf925704a73ec8a672500249da99e
+SHA512:
+  metadata.gz: 701087f4d4885e4fe76798b533c4cd94279f7cdbc49b5715fcdbc47424b4ecd82d748c5e085e940a9b8888eb294c67b22e1bd250a53347fd6b0c6acf6d14b2b3
+  data.tar.gz: 3d12964726de0a74c398ef5ce7f67fc186c4f2c3d08c00adeb4147e61ca73ffc0941335a6006d630d071f6a9eb218c0691cc54ab9cc4929ef1cef2575305b871

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cameron Martin
+
+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,63 @@
+# EventMachine::Test
+
+Small library for testing asynchronous eventmachine code. It is [inspired by jasmine][1].
+
+Each example spins up it's own reactor, you make your expectations/assertions, and you call a done callback when you've finished.
+If your example takes too long, it throws an error.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'event_machine-test'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_machine-test
+
+## Usage
+
+```ruby
+
+describe YourLib do
+
+  include EventMachine::Test.new(5) # Pass timeout in seconds
+
+  it 'does something' do
+    em_test do |done|
+
+      # Do some actual useful asynchronous stuff, then call done when you've finished
+      EventMachine.add_timer(1) do
+        expect(true).to eq(true)
+        done.call
+      end
+
+    end
+  end
+
+end
+```
+
+## How it works
+1. Spins up eventmachine inside a block
+2. Sets a timer to throw a `TimeoutError`
+3. Runs a block, passing a done callback which throws a symbol
+4. Symbol is caught outside eventmachine reactor, and the block terminates (with no error).
+
+
+## Contributing
+
+1. Fork it ( https://github.com/cameron-martin/event_machine-test/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
+
+
+[1]: http://jasmine.github.io/2.0/introduction.html#section-Asynchronous_Support

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/event_machine-test.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_machine-test"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Cameron Martin"]
+  spec.email         = ["cameronmartin123@gmail.com"]
+  spec.summary       = %q{Easily test asynchronous eventmachine code.}
+  spec.description   = %q{Easily test asynchronous eventmachine code. Inspired by jasmine.}
+  spec.homepage      = "https://github.com/cameron-martin/event_machine-test"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-eventmachine", "~> 0.1"
+end

data/lib/event_machine/test.rb

@@ -0,0 +1,25 @@
+module EventMachine
+  class Test < Module
+
+    class TimeoutError < RuntimeError; end
+
+    def initialize(timeout)
+      super() do
+
+        define_method(:em_test) do |&block|
+          done_callback = -> { throw :stop }
+
+          # Calling EM.stop does not work, since it waits for the timer to finish first.
+          catch(:stop) do
+            EventMachine.run do
+              EventMachine.add_timer(timeout) { raise TimeoutError }
+              block.call(done_callback)
+            end
+          end
+        end
+
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require 'event_machine/test'
+require 'rspec/em'
+
+# 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.
+  # 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

data/spec/test_spec.rb

@@ -0,0 +1,29 @@
+
+describe EventMachine::Test do
+
+  include EventMachine::Test.new(1)
+  include RSpec::EM::FakeClock
+
+  #before { clock.stub }
+  #after { clock.reset }
+
+  it 'raises timeout error when done is not called' do
+    expect do
+      em_test do |done|
+        #clock.stub
+        #clock.tick(1)
+      end
+    end.to raise_error(EventMachine::Test::TimeoutError)
+  end
+
+  it 'does not raise timeout error if done is called' do
+
+    expect do
+      em_test do |done|
+        done.call
+      end
+    end.to_not raise_error
+
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: event_machine-test
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cameron Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-eventmachine
+  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'
+description: Easily test asynchronous eventmachine code. Inspired by jasmine.
+email:
+- cameronmartin123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- event_machine-test.gemspec
+- lib/event_machine/test.rb
+- spec/spec_helper.rb
+- spec/test_spec.rb
+homepage: https://github.com/cameron-martin/event_machine-test
+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: Easily test asynchronous eventmachine code.
+test_files:
+- spec/spec_helper.rb
+- spec/test_spec.rb
+has_rdoc: