thomas_utils 0.1.13.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 681af6043ae2f6638036ba67523a2b01687ae758
+  data.tar.gz: 6e0d5f0910cbf715d8857a69e9acd4386ca937af
+SHA512:
+  metadata.gz: 9e05ff0e99623ecb608285132fef52fb8271dd4a9df03c593122aed37e0a08c5c4aaac18d30a3f9e1ee177fd159d5ceb4699070bf8497c14d874d8f99944b65d
+  data.tar.gz: a792c556f3d4716551e35f89e49ad66c373ed0d8d2db03f24ecaab58c8b77d64cb2de3bdedf04d32583bce33995703f099d1b2f27c8d18908c99307460704980

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Thomas RM Rogers
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,15 @@
+# Thomas Utils
+
+Thomas Utils is a gem to provide some basic helper classes to be used with my other projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thomas_utils', git: 'https://github.com/thomasrogers03/thomas_utils.git'
+
+## Current Features
+
+* FutureWrapper: Apply some additional logic to your futures before returning a value. Supports futures implementing #join and #get.
+* ObjectStream: Incrementally write object values to a stream, flushing them in groups to a provided block.
+* PeriodicFlusher: To be used with ObjectStream; periodically calls #flush on the buffer, running the block on regular intervals.

data/lib/thomas_utils.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright 2015 Thomas RM Rogers
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'concurrent'
+
+require 'thomas_utils/object_stream'
+require 'thomas_utils/periodic_flusher'
+require 'thomas_utils/future_wrapper'
+require 'thomas_utils/multi_future_wrapper'
+require 'thomas_utils/key_comparer'
+require 'thomas_utils/key_indexer'
+require 'thomas_utils/future'

data/lib/thomas_utils/future.rb

@@ -0,0 +1,42 @@
+module ThomasUtils
+  class Future
+    DEFAULT_EXECUTOR = ::Concurrent::CachedThreadPool.new
+
+    def initialize(options = {})
+      options[:executor] ||= DEFAULT_EXECUTOR
+
+      @mutex = Mutex.new
+      @future = ::Concurrent::Future.execute(executor: options[:executor]) do
+        begin
+          @result = yield
+          @result = @result.get if @result.is_a?(FutureWrapper)
+          @mutex.synchronize { @success_callback.call(@result) if @success_callback }
+          @result
+        rescue => e
+          @error = e
+          @mutex.synchronize { @failure_callback.call(e) if @failure_callback }
+        end
+      end
+    end
+
+    def get
+      result = @future.value
+      raise @error if @error
+      result
+    end
+
+    def join
+      get rescue nil
+    end
+
+    def on_success(&block)
+      @mutex.synchronize { @success_callback = block }
+      @success_callback.call(@result) if @future.fulfilled? && !@error
+    end
+
+    def on_failure(&block)
+      @mutex.synchronize { @failure_callback = block }
+      @failure_callback.call(@error) if @future.fulfilled? && @error
+    end
+  end
+end

data/lib/thomas_utils/future_wrapper.rb

@@ -0,0 +1,21 @@
+module ThomasUtils
+  class FutureWrapper
+    extend Forwardable
+
+    def_delegator :@future, :join
+    def_delegator :@future, :on_failure
+
+    def initialize(future, &callback)
+      @future = future
+      @callback = callback
+    end
+
+    def get
+      @result ||= @callback.call(@future.get)
+    end
+
+    def on_success
+      @future.on_success { |result| yield @callback.call(result) }
+    end
+  end
+end

data/lib/thomas_utils/key_comparer.rb

@@ -0,0 +1,50 @@
+module ThomasUtils
+  class KeyComparer
+    OPERATOR_MAP = {eq: '=', ge: '>=', gt: '>', le: '<=', lt: '<', ne: '!='}
+
+    attr_reader :key
+
+    def initialize(key, comparer)
+      @key = key
+      @comparer = comparer
+    end
+
+    def new_key(updated_key)
+      KeyComparer.new(updated_key, @comparer)
+    end
+
+    def to_s
+      "#{pretty_key} #{@comparer}"
+    end
+
+    def ==(rhs)
+      to_s == rhs.to_s
+    end
+
+    def eql?(rhs)
+      self == rhs
+    end
+
+    def hash
+      to_s.hash
+    end
+
+    private
+
+    def pretty_key
+      key.is_a?(Array) ? "(#{key * ','})" : key
+    end
+  end
+end
+
+class Symbol
+  ThomasUtils::KeyComparer::OPERATOR_MAP.each do |method, operator|
+    define_method(method) { ThomasUtils::KeyComparer.new(self, operator) }
+  end
+end
+
+class Array
+  ThomasUtils::KeyComparer::OPERATOR_MAP.each do |method, operator|
+    define_method(method) { ThomasUtils::KeyComparer.new(self, operator) }
+  end
+end

data/lib/thomas_utils/key_indexer.rb

@@ -0,0 +1,20 @@
+module ThomasUtils
+  class KeyIndexer
+    attr_reader :key
+
+    def initialize(key, index)
+      @key = key
+      @index = index
+    end
+
+    def to_s
+      "#{@key}['#{@index}']"
+    end
+  end
+end
+
+class Symbol
+  def index(index)
+    ThomasUtils::KeyIndexer.new(self, index)
+  end
+end

data/lib/thomas_utils/multi_future_wrapper.rb

@@ -0,0 +1,33 @@
+module ThomasUtils
+  class MultiFutureWrapper
+    def initialize(futures, leader = nil, &callback)
+      @futures = futures
+      @leader = leader
+      @callback = callback
+    end
+
+    def join
+      @futures.map(&:join)
+    end
+
+    def get
+      @futures.map(&:get).map(&@callback)
+    end
+
+    def on_failure(&block)
+      if @leader
+        @leader.on_failure(&block)
+      else
+        @futures.each { |future| future.on_failure(&block) }
+      end
+    end
+
+    def on_success
+      if @leader
+        @leader.on_success { |result| yield @callback.call(result) }
+      else
+        @futures.each { |future| future.on_success { |result| yield @callback.call(result) } }
+      end
+    end
+  end
+end

data/lib/thomas_utils/object_stream.rb

@@ -0,0 +1,19 @@
+module ThomasUtils
+  class ObjectStream
+
+    def initialize(&callback)
+      @buffer = Queue.new
+      @callback = callback
+    end
+
+    def <<(item)
+      @buffer << item
+    end
+
+    def flush
+      length = @buffer.size
+      items = length.times.map { @buffer.pop }
+      @callback.call(items)
+    end
+  end
+end

data/lib/thomas_utils/periodic_flusher.rb

@@ -0,0 +1,18 @@
+module ThomasUtils
+  class PeriodicFlusher
+    @@streams = {}
+
+    def self.<<(stream_desc)
+      name = stream_desc[:name]
+      unless @@streams[name]
+        stream = stream_desc[:stream]
+        @@streams[name] = stream
+        Workers::PeriodicTimer.new(stream_desc[:timeout] || 1) { stream.flush }
+      end
+    end
+
+    def self.[](name)
+      @@streams[name]
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: thomas_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.13.2
+platform: ruby
+authors:
+- Thomas RM Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-02 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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: workers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: |-
+  Helper utilities gem used in a number of my projects.
+    Includes future wrappers and provides some override methods for Ruby core classes
+    that make defining behaviours easier to code.
+email: thomasrogers03@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/thomas_utils.rb
+- lib/thomas_utils/future.rb
+- lib/thomas_utils/future_wrapper.rb
+- lib/thomas_utils/key_comparer.rb
+- lib/thomas_utils/key_indexer.rb
+- lib/thomas_utils/multi_future_wrapper.rb
+- lib/thomas_utils/object_stream.rb
+- lib/thomas_utils/periodic_flusher.rb
+homepage: https://www.github.com/thomasrogers03/thomas_utils
+licenses:
+- Apache License 2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Helper utilities gem used in a number of my projects
+test_files: []