handling_queue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d447fa9814068456364559b5259312d693b98bb409dfc1be0fb2b7767d313a01
+  data.tar.gz: 34ef9a975afb0aab5f20d2616f4a87b34acebae1e64dcad4d677b77efd319ba1
+SHA512:
+  metadata.gz: acf5e6bbdc92c2e4cf740454da07710c130450e81488187578a63249725157623a24542d1056001fc2bfadb0c1684ee537a403129cec1dfc9c8f8d71391278fe
+  data.tar.gz: 2bd825ed166e77ebaa65267f9d4d019198e44e2b6d9332b94bb0dd32432276bcfb9d780a5ecd7eb378b1609ac8cfe98081fe315854a8f275f2baee7b0dfd6015

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,41 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: false
+  TargetRubyVersion: 2.6
+  Exclude:
+    - config/**/*
+    - tmp/**/*
+    - Capfile
+    - Gemfile
+    - Rakefile
+
+# Follow RubyGuides on this one
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+# Just enough
+Layout/LineLength:
+  Max: 100
+
+# Allow long testing methods
+Metrics/MethodLength:
+  Exclude:
+    - test/test_*.rb
+
+# Follow RubyGuides on this one
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# Prefer using Rubies methods
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-06-12 22:08:35 +0300 using RuboCop version 0.85.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'
+
+gem 'rubocop', '~> 0.85.0'
+gem 'rubocop-performance', require: false
+
+gem 'pry', '~> 0.13.1'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Fizvlad
+
+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,37 @@
+# HandlingQueue
+
+Timed handling of elements of queue in separate threads.
+
+## Installation
+
+Add gem to your Gemfile using
+
+	$ bundle add handling_queue
+
+## Usage
+
+Setting up handler:
+
+	handling_queue = HandlingQueue.new(slice: 1, interval: 1) do |a|
+	  # Handle `a` which is array of `HandlingQueue::Request`
+      a.each { |e| e.re = e.obj * 2 } # It is necessar to assign `e.re`
+    end
+
+Adding elements to queue:
+
+    handling_queue.handle(1) # Sleeps until handler called for this number, then => 2
+    handling_queue.handle(2) # => 4
+    handling_queue.handle(5) # => 10
+
+## Development
+
+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/fizvlad/handling_queue.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,48 @@
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) {}
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace 'rubocop' do
+  desc 'Generate rubocop TODO file.'
+  task 'todo' do
+    puts `rubocop --auto-gen-config`
+  end
+end
+
+namespace 'yardoc' do
+  desc 'Generate documentation'
+  task 'generate' do
+    puts `yardoc lib/*`
+  end
+
+  desc 'List undocumented elements'
+  task 'undoc' do
+    puts `yardoc stats --list-undoc lib/*`
+  end
+end
+
+namespace 'eol' do
+  desc 'Replace CRLF with LF.'
+  task :dos2unix, [:pattern] do |_t, args|
+    path_list = Dir.glob(args.pattern || '**/*.{rb,rake}', File::FNM_EXTGLOB)
+    counter = 0
+    path_list.each do |path|
+      next unless File.file?(path)
+
+      counter += 1
+      puts "Handling `#{path}`..."
+      content = File.read(path, mode: 'rb')
+      content.gsub!(/\r\n/, "\n")
+      File.write(path, content, mode: 'wb')
+    end
+    puts "Handled #{counter} files."
+  end
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'handling_queue'
+
+# 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

data/handling_queue.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/handling_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'handling_queue'
+  spec.version       = HandlingQueue::VERSION
+  spec.authors       = ['Fizvlad']
+  spec.email         = ['fizvlad@mail.ru']
+
+  spec.summary       = 'General purpose text bots'
+  spec.homepage      = 'https://github.com/fizvlad/handling_queue'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.5')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fizvlad/handling_queue'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+end

data/lib/handling_queue.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'handling_queue/version'
+require_relative 'handling_queue/request'
+
+# Execute handling process from time to time.
+class HandlingQueue
+  # @param slice [Integer] amount of handled objects in single +handler+ call.
+  # @param interval [Integer] interval between handler calls in seconds.
+  # @yieldparam obj [Array<Request>] array of handling requests.
+  def initialize(slice: 1, interval: 1, &handler)
+    @slice = slice
+    @interval = interval
+    @handler = handler
+
+    @requests_queue = [] # Use Array with #push and #shift methods to have queue.
+    # NOTE: effeciency is pretty good, btw. O(1) if no new memory required.
+
+    @mutex = Mutex.new # Queue and requests accessing mutex
+    @cv = ConditionVariable.new # Condition variable to signal when some of results are ready.
+
+    @working = false
+    @thread = nil
+    start_handler_thread
+  end
+
+  # Request handling of +obj+ and wait for it to be handled.
+  # @param obj [void] object to be handled.
+  # @return [void] result of handling.
+  def handle(obj)
+    request = Request.new(obj)
+    @mutex.synchronize do
+      @requests_queue.push(request)
+      @cv.wait(@mutex) while request.re.nil?
+      request.re
+    end
+  end
+
+  private
+
+  def start_handler_thread
+    @working = true
+    @thread = Thread.new do
+      handler_iteration while @working
+    end
+    @thread.name = 'handling_queue'
+  end
+
+  def handler_iteration
+    sleep @interval
+    @mutex.synchronize do
+      arg = @requests_queue.shift(@slice)
+      @handler.call(arg) unless arg.empty?
+      @cv.broadcast
+    end
+  end
+
+  def stop_handler_thread
+    @working = false
+    @thread.join
+    @thread = nil
+  end
+end

data/lib/handling_queue/request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class HandlingQueue
+  # Represents single request to {HandlingQueue}.
+  class Request
+    # @return [void] object to be handled.
+    attr_accessor :obj
+
+    # @return [void] handled object or +nil+ if not handled yet.
+    attr_accessor :re
+
+    # @param obj [void] object to be handled.
+    def initialize(obj)
+      @obj = obj
+      @re = nil
+    end
+  end
+end

data/lib/handling_queue/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class HandlingQueue
+  # Library version.
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: handling_queue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fizvlad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- fizvlad@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- handling_queue.gemspec
+- lib/handling_queue.rb
+- lib/handling_queue/request.rb
+- lib/handling_queue/version.rb
+homepage: https://github.com/fizvlad/handling_queue
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fizvlad/handling_queue
+  source_code_uri: https://github.com/fizvlad/handling_queue
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.0.pre2
+signing_key: 
+specification_version: 4
+summary: General purpose text bots
+test_files: []