batch_any 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92c5a5e652092edbb5b409b38d80314daf72ffb7
+  data.tar.gz: 4bb6bc663d2eba26aa229117bbef93fb38f52a38
+SHA512:
+  metadata.gz: 62c787644cc09f815333b57f275a75266b15c58cd23c84d96cce88fcd1722c0a8f4b5373f04295c2eeb9d13425b12b1d93a76d4ccd851cf8262f0c0305410502
+  data.tar.gz: ef3b09a0713c9b032e4c9088474cff6985976e162b5d0be405c460c5c18113dca2cc54ab7e83e5634c95ce678c64d1bca26804f49f246e84aac38ac338ec643b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Bochkarev
+
+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,84 @@
+# BatchAny
+
+Allows you to use the batching service both for grouping requests into one and a single access to api. It makes it easy to integrate the batching service into the current logic without huge refactoring.
+Internally it uses [Fibers](http://ruby-doc.org/core-2.4.1/Fiber.html) to pause current control flow and resumes after batches are formed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'batch_any'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install batch_any
+
+## Usage
+
+```ruby
+STORAGE = [:a, :b].freeze
+
+class Service < BatchAny::Service
+  @@fetch_count = 0
+
+  def self.fetch_count
+    @@fetch_count
+  end
+
+  def can_serve?(item)
+    item.class == Request
+  end
+
+  def fetch
+    @@fetch_count += 1
+    items.each { |item| item.result { STORAGE.fetch(item.index) } }
+  end
+end
+
+class Request < BatchAny::Item
+  attr_reader :index
+
+  def initialize(index)
+    @index = index
+  end
+
+  def service_class
+    Service
+  end
+end
+
+a = nil
+b = nil
+
+batching_manager = BatchAny::Manager.new
+batching_manager.add_computation { a = Request.new(0).fetch }
+batching_manager.add_computation { b = Request.new(1).fetch }
+batching_manager.run
+
+puts a
+# => a
+puts b
+# => b
+puts Service.fetch_count
+# => 1 # not 2
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryBochkarev/batch_any.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/batch_any.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batch_any/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "batch_any"
+  spec.version       = BatchAny::VERSION
+  spec.authors       = ["Dmitry Bochkarev"]
+  spec.email         = ["dimabochkarev@gmail.com"]
+
+  spec.summary       = %q{Practical application of ruby fibers. Help you to batching requests.}
+  spec.description   = %q{Allows you to use the batching service both for grouping requests into one and a single \
+    access to api. It makes it easy to integrate the batching service into the current logic without huge refactoring.}
+  spec.homepage      = "https://github.com/DmitryBochkarev/batch_any"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

data/bin/setup

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

data/lib/batch_any.rb

@@ -0,0 +1,8 @@
+require 'fiber'
+require 'batch_any/version'
+require 'batch_any/manager'
+require 'batch_any/service'
+require 'batch_any/item'
+
+module BatchAny
+end

data/lib/batch_any/item.rb

@@ -0,0 +1,26 @@
+module BatchAny
+  class Item
+    attr_accessor :value, :exception
+
+    def service_class
+      raise "Not implemented: #{self.class}#service_class -> Class, required by BatchAny::Item"
+    end
+
+    def fetch
+      batching_manager = Thread.current[:batch_any_manager]
+      if batching_manager
+        batching_manager.enqueue_item(self)
+      else
+        service_class.new(self).fetch
+      end
+      raise @exception if @exception
+      @value
+    end
+
+    def result
+      @value = yield
+    rescue => e
+      @exception = e
+    end
+  end
+end

data/lib/batch_any/manager.rb

@@ -0,0 +1,88 @@
+module BatchAny
+  class Manager
+    class FiberError
+      attr_reader :fiber, :exception
+
+      def initialize(fiber, exception)
+        @fiber = fiber
+        @exception = exception
+      end
+    end
+
+    attr_reader :exceptions
+
+    def initialize
+      @computations = []
+      @awaiting_services = {}
+    end
+
+    def add_computation(&block)
+      fiber = Fiber.new do
+        Thread.current[:batch_any_manager] = self
+        block.call
+      end
+      @computations << fiber
+      fiber
+    end
+
+    def run
+      @exceptions = []
+      while @computations.any?
+        @computations.each do |computation|
+          begin
+            computation.resume
+          rescue => e
+            @exceptions << FiberError.new(computation, e)
+          end
+        end
+        linear_keep_if!(@computations, &:alive?)
+        @awaiting_services.values.each do |services|
+          services.each do |service|
+            begin
+              service.fetch
+            rescue => e
+              service.items.each { |item| item.exception = e }
+            end
+          end
+        end
+        @awaiting_services.clear
+      end
+      @exceptions
+    end
+
+    def enqueue_item(item)
+      service_class = item.service_class
+      @awaiting_services[service_class] ||= []
+      awaiting_services = @awaiting_services[service_class]
+      service = awaiting_services.find { |service| service.can_serve?(item) }
+      if service
+        service.items << item
+      else
+        awaiting_services << item.service_class.new(item)
+      end
+      Fiber.yield
+    end
+
+    private
+
+    # https://bugs.ruby-lang.org/issues/10714
+    # https://github.com/ruby/ruby/commit/5ec029d1ea52224a365a11987379c3e9de74b47a
+    def linear_keep_if!(arr)
+      i = 0
+      j = 0
+      while i < arr.length
+        v = arr[i]
+        if yield v
+          arr[j] = v
+          j += 1
+        end
+        i += 1
+      end
+      i != j ? arr : nil
+    ensure
+      if i != j
+        arr[j, i-j] = []
+      end
+    end
+  end
+end

data/lib/batch_any/service.rb

@@ -0,0 +1,18 @@
+module BatchAny
+  class Service
+    attr_reader :item_class, :items
+
+    def initialize(item)
+      @item_class = item.class
+      @items = [item]
+    end
+
+    def can_serve?(item)
+      raise "Not implemented: #{self.class}#can_serve?(item) -> truthy, required by BatchAny::Service"
+    end
+
+    def fetch
+      raise "Not implemented: #{self.class}#fetch, required by BatchAny::Service"
+    end
+  end
+end

data/lib/batch_any/version.rb

@@ -0,0 +1,3 @@
+module BatchAny
+  VERSION = "1.3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: batch_any
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Dmitry Bochkarev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: |-
+  Allows you to use the batching service both for grouping requests into one and a single \
+      access to api. It makes it easy to integrate the batching service into the current logic without huge refactoring.
+email:
+- dimabochkarev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- batch_any.gemspec
+- bin/console
+- bin/setup
+- lib/batch_any.rb
+- lib/batch_any/item.rb
+- lib/batch_any/manager.rb
+- lib/batch_any/service.rb
+- lib/batch_any/version.rb
+homepage: https://github.com/DmitryBochkarev/batch_any
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Practical application of ruby fibers. Help you to batching requests.
+test_files: []