avertasks 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79c837ad19ecaceaca12d8b4cf077cce9b6e9af618fba5696a928f64b6c81187
+  data.tar.gz: 8ef59d946cbb9a28c5bceaf37af088cdbb82ce335bb32c478e1c51f4555b87e0
+SHA512:
+  metadata.gz: 2083e3e65f13878bad68879c7a9656df5d663a51a8e56a36cc2315fd4b00ac5319d7b034722a076e74f5ecc13719617452104d7736533ca9078cfc6cdb7fdfec
+  data.tar.gz: 7e5070e67779055a7f3c8d468a6d329a5dac4df7beb77ff2104a0671399543def6dc287287fb354bb2acca616f77dd6e8ebcf8888e1af4718c222f13bdd3f28c

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rgbmarco@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 MarcoEpsilon
+
+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,60 @@
+# Avertasks
+
+It's my gem, I write it to solve my problem about use multi-threads to download files from network..etc, which have common in handling many same work or task in multi-threads
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avertasks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install avertasks
+
+## Usage
+More detail you should look lib/*
+```ruby
+require 'avertasks'
+def fibonacci(n)
+    if (n == 1 || n == 2) then
+        return 1
+    else
+        return fibonacci(n - 1) + fibonacci(n - 2)
+    end
+end
+def main()
+    taskmanager = TaskManager.new
+    5.upto(35).each do |index|
+        taskmanager.add_task(index) { puts fibonacci(index) }
+    end
+    # wait all tasks completed ...
+    taskmanager.join
+    puts "vertify tasks counts: #{TaskManager.run_times}"
+end
+main()
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/avertasks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Avertasks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/avertasks/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/avertasks.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "avertasks/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "avertasks"
+  spec.version       = Avertasks::VERSION
+  spec.authors       = ["MarcoEpsilon"]
+  spec.email         = ["rgbmarco@gmail.com"]
+
+  spec.summary       = %q{Produce reasonable number of threads to completed the tasks}
+  spec.description   = %q{To use it, we only need placed tasks in taskqueue and wait it, like download many files from network}
+  spec.homepage      = "https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks"
+  spec.license       = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks"
+  spec.metadata["changelog_uri"] = "https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + Dir.glob('./lib/avertasks/*').append(*Dir.glob('./lib/test/*').append(*Dir.glob('./lib/*')))
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "avertasks"
+
+# 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/avertasks.rb

@@ -0,0 +1,6 @@
+require "avertasks/version"
+require "avertasks/taskmanager"
+module Avertasks
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/avertasks/task.rb

@@ -0,0 +1,15 @@
+class Task
+    class TaskErr < StandardError
+    end
+    @@errMsg = [
+        'you need pass run block to initialize'
+    ]
+    def initialize(*args, &block)
+        raise TaskErr.new(@@errMsg[0]) unless block_given?
+        @task_proc = block
+        @args = args
+    end
+    def run()
+        return @task_proc.call(*@args)
+    end
+end

data/lib/avertasks/taskmanager.rb

@@ -0,0 +1,66 @@
+require File.join(File.dirname(__FILE__), 'task.rb')
+require File.join(File.dirname(__FILE__), 'taskqueue.rb')
+class TaskManager
+    @@queue = []
+    @@thread_lookup = Hash.new
+    @@queue_mutex = Mutex.new
+    @@should_sort = 10
+    @@add_count = 0
+    @@full_count = 1
+    def initialize()
+    end
+    def add_task(*args, &block)
+        begin
+            task = Task.new(*args, &block) 
+            add_to_hungry_queue(task)
+        rescue => exception
+            raise exception
+        end
+    end
+    def broadcast_cankill()
+        @@queue_mutex.synchronize do
+            @@queue.each { |item| item.cankill = true }
+        end
+    end
+    def join()
+        self.broadcast_cankill()
+        @@queue_mutex.synchronize do
+            @@thread_lookup.each_value do |thr|
+                thr.join
+            end
+        end
+    end
+    class << self
+        def run_times()
+            return TaskQueue.run_times
+        end
+    end
+private
+    def add_to_hungry_queue(task)
+        @@queue_mutex.synchronize do
+            @@add_count += 1
+            if @@add_count > @@should_sort then
+                @@queue.sort_by { |item| -item.hungry? }
+                @@add_count = 0
+            end
+            tasks = @@queue.find do |obj| 
+                if obj.hungry? == 0 then
+                    false
+                else
+                    true
+                end
+            end
+            unless tasks.nil? then
+                tasks.push(task)
+            else
+                task_queue = TaskQueue.new(@@queue.size + 1, @@queue.size + 1).push(task)
+                @@queue.push(task_queue)
+                @@thread_lookup[task_queue.id] = task_queue.start()
+                @@full_count = @@queue.size
+                @@queue.each do |queue|
+                    queue.full_count = @@full_count
+                end
+            end
+        end
+    end
+end

data/lib/avertasks/taskqueue.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), 'task.rb')
+class TaskQueue
+    attr_reader :tasks
+    attr_reader :id
+    attr_reader :completed
+    attr_reader :runing
+    attr_reader :waiting
+    attr_accessor :full_count
+    attr_accessor :cankill
+    alias :waiting? :waiting
+    alias :runing? :runing
+    class ArgumentErr < StandardError
+    end
+    class TaskRunErr < StandardError
+    end
+    @@errMsg = [
+        'ArgumentErr for func:{func} argument type: {type} is requirement'
+    ]
+    @@run_times = 0
+    def initialize(id, full_count)
+        # define for collect tasks
+        @tasks = []
+        @id = id
+        @completed = 0
+        @runing = false
+        @waiting = true
+        @task_mutex = Mutex.new
+        @full_count = full_count
+        @cankill = false
+        @alldo = false
+    end
+    def push(task)
+        raise ArgumentErr.new(TaskQueue.errMsg[0].sub(/{func}/, 'TaskQueue.push').sub(/{type}/, 'Task')) unless task.instance_of? Task
+        @task_mutex.synchronize { @tasks << task }
+        self
+    end
+    # @waiting,@runing now is useless...
+    def run()
+        @task_mutex.synchronize do
+            if @tasks.none? then
+                @waiting = true
+                @runing = false
+                @alldo = true
+                return false
+            else
+                @waiting = false
+                @runing = true
+                @alldo = false
+                # temp variable for this func
+                @current_task = @tasks.pop
+            end
+        end
+        # note that i have drop out the result of your proc
+        @current_task.run if @current_task
+        @completed += 1
+        @@run_times += 1
+        return true
+    end
+    def hungry?()
+        count = 0
+        @task_mutex.synchronize do
+            count = full_count - @tasks.size
+        end
+        return 0 if count <= 0
+        return count
+    end
+    def none?
+        @task_mutex.synchronize do
+            @tasks.none?    
+        end
+    end
+    def start()
+        thr = Thread.new do
+            while (!cankill || !@alldo) do
+                Thread.pass unless self.run
+            end
+        end
+        return thr
+    end
+    class << self
+        def run_times()
+            return @@run_times
+        end
+    end
+end

data/lib/avertasks/version.rb

@@ -0,0 +1,3 @@
+module Avertasks
+  VERSION = "0.2.0"
+end

data/lib/test/tc_task.rb

@@ -0,0 +1,15 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
+require 'test/unit'
+require 'avertasks/task.rb'
+class Use < Test::Unit::TestCase
+    def test_use_task()
+        begin
+            task = Task.new('hello') do |arg|
+                arg.capitalize
+            end
+            assert(task.run() == 'Hello', 'task run test failed')
+        rescue => exception
+            assert(false, "occur exception: #{exception.message}")
+        end
+    end
+end

data/lib/test/tc_taskmanager.rb

@@ -0,0 +1,19 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", '..', "lib")
+require 'test/unit'
+require 'avertasks/taskmanager.rb'
+class Use < Test::Unit::TestCase
+    def fibonacci(n)
+        if n == 1 || n == 2 then
+            return 1
+        end
+        return fibonacci(n - 1) + fibonacci(n - 2)
+    end
+    def test_taskmanager()
+        taskmanager = TaskManager.new
+        10.upto(22) do |index|
+            taskmanager.add_task(index) { |index| puts fibonacci(index) }
+        end
+        taskmanager.join()
+        assert(TaskQueue.run_times == 13, 'some thread loss ...')
+    end
+end

data/lib/test/ts_avertask.rb

@@ -0,0 +1,3 @@
+# group tests
+require './tc_task.rb'
+require './tc_taskmanager.rb'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: avertasks
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- MarcoEpsilon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: To use it, we only need placed tasks in taskqueue and wait it, like download
+  many files from network
+email:
+- rgbmarco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/avertasks.rb"
+- "./lib/avertasks/task.rb"
+- "./lib/avertasks/taskmanager.rb"
+- "./lib/avertasks/taskqueue.rb"
+- "./lib/avertasks/version.rb"
+- "./lib/test/tc_task.rb"
+- "./lib/test/tc_taskmanager.rb"
+- "./lib/test/ts_avertask.rb"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- avertasks.gemspec
+- bin/console
+- bin/setup
+- lib/avertasks.rb
+- lib/avertasks/task.rb
+- lib/avertasks/taskmanager.rb
+- lib/avertasks/taskqueue.rb
+- lib/avertasks/version.rb
+- lib/test/tc_task.rb
+- lib/test/tc_taskmanager.rb
+- lib/test/ts_avertask.rb
+homepage: https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks
+  source_code_uri: https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks
+  changelog_uri: https://github.com/MarcoEpsilon/self-rubygems/tree/avertasks
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Produce reasonable number of threads to completed the tasks
+test_files: []