data_hopper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27c884262589c4b4caecbcde26f574ae98b024e3
+  data.tar.gz: 292ca14fe5a910bea84f6d4f7720d3be4241381f
+SHA512:
+  metadata.gz: f8b0ac1913d6ec2034c552c41df239e8a96f860bd5d05fd9389c8d36867b73a6556f55d41ab890b863014c31daecbcda37ee32320486d2388c62d52ad59971f4
+  data.tar.gz: 65f6d95b7c82bd02cbaecae73fca6beb9918286760597a9f1e87a6b8eb9d3d56064c7a2a83b47e478c4291917ea46db79ee27242fb46643f45ab864b4759c311

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Doug Everly
+
+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,58 @@
+# Hopper
+
+*Hopper* (noun): A storage container used to collect granular materials designed to easily dispense these materials through the use of gravity. (http://en.wikipedia.org/wiki/Hopper)
+
+**Hopper** accumulates items and executes a block of code when its capacity is reached, or the timeout is reached, whichever event occurs first.
+
+**Hopper** is useful for collecting a certain number of items before processing them, whilst not blocking too long if the capacity is not reached.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hopper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hopper
+
+## Usage
+
+
+Create a hopper:
+
+    h = Hopper.new capacity: 28, timeout: 1 do |items, timed_out|
+      puts "I have #{items.size} items"
+      puts "I timed out" if timed_out
+    end
+
+Add items to the hopper:
+
+    h << 'an item'
+
+To run the block even when there are no items present:
+
+    h = Hopper.new capacity: 28, timeout: 1 do |items, timed_out|
+      puts "I have #{items.size} items"
+      puts "I timed out" if timed_out
+    end
+    
+To stop the hopper:
+
+    h.stop
+    
+Hopper raises an exception if an item is added to the hopper while its not running.
+    
+    
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/example/run_hopper.rb

@@ -0,0 +1,28 @@
+#!/bin/env ruby
+
+require 'hopper'
+
+h = Hopper.new capacity: 10, timeout: 1, exact: true do |items, timed_out|
+    puts "I have #{items.size} items"
+end
+
+
+22.times do |i|
+  h << i
+end
+
+h.stop
+# h.start
+
+
+sleep 3
+begin
+1005.times do |i|
+  h << i
+end
+rescue Exception => e
+  puts e.message
+end
+
+
+# h.stop

data/hopper.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hopper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_hopper"
+  spec.version       = Hopper::VERSION
+  spec.authors       = ["Doug Everly"]
+  spec.email         = ["Doug@Everly.org"]
+  spec.description   = %q{Hopper accumulates items and executes a block of code when its capacity is reached, or the timeout is reached, whichever event occurs first.}
+  spec.summary       = %q{Hopper is useful for collecting a certain number of items before processing them, whilst not blocking too long if the capacity is not reached.}
+  spec.homepage      = "https://github.com/DougEverly/hopper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+end

data/lib/hopper.rb

@@ -0,0 +1,75 @@
+require_relative "hopper/version"
+require 'thread'
+
+class Hopper
+  
+  def initialize(capacity: 10, timeout: 2, always: false, exact: true, &block)
+    @capacity = capacity
+    @timeout  = timeout
+    @always   = always
+    @exact    = exact
+
+    @running = false
+    @condvar = ConditionVariable.new
+    @hopper_mutex = Mutex.new
+    @signal_mutex = Mutex.new
+    @hopper = Array.new
+    @block = block
+    @thread = nil
+    
+    start
+  end
+
+  def start
+    @running = true
+    @thread = Thread.new do
+      while @running
+        timed_out = false
+
+        # wait for signal or timeout
+        @signal_mutex.synchronize {
+          if @condvar.wait(@signal_mutex, @timeout) then
+            timed_out = false
+          else
+            timed_out = true
+          end
+        }
+
+        # yield passed block
+        @hopper_mutex.synchronize {
+          if @always || @hopper.size > 0
+            @block.call @hopper, timed_out if @block
+          end
+          @hopper = Array.new
+          @condvar.signal if @exact
+        }
+
+      end
+    end
+  end
+  
+  def stop
+    @running = false
+    @thread.join
+  end
+  
+  def size
+    @hopper_mutex.synchronize {
+      return @hopper.size
+    }
+  end
+  
+  def <<(item)
+    if !@running
+      raise "Hopper is not running."
+    end
+    @hopper_mutex.synchronize {
+      @hopper << item
+      if @hopper.size >= @capacity then
+        @condvar.signal
+        @condvar.wait(@hopper_mutex) if @exact
+      end
+    }
+  end
+
+end

data/lib/hopper/version.rb

@@ -0,0 +1,3 @@
+class Hopper
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: data_hopper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doug Everly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Hopper accumulates items and executes a block of code when its capacity
+  is reached, or the timeout is reached, whichever event occurs first.
+email:
+- Doug@Everly.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/run_hopper.rb
+- hopper.gemspec
+- lib/hopper.rb
+- lib/hopper/version.rb
+homepage: https://github.com/DougEverly/hopper
+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.0
+signing_key: 
+specification_version: 4
+summary: Hopper is useful for collecting a certain number of items before processing
+  them, whilst not blocking too long if the capacity is not reached.
+test_files: []