swiftcore-tasks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d0d01200027a06200339af48535cbe026187165932737e2d425f2ec3e257488
+  data.tar.gz: a6ff25224dc5667f9d4d1c3f9e80b206e20e1bd75da26c17e1764acf16ce703f
+SHA512:
+  metadata.gz: e24f0a3a35d9a7ab75cc28405f33a159c4e3fb8d484a1ef22d7d9f96fc8e74a3768311aabcde4853021f29567014692bb27d77b7010b8d15939f018892b034f2
+  data.tar.gz: 4dc177905310462e6c5f21140461a573bfc5fed6506b0d696c7990eb64ca8c389954ff7a040dc335c13857fa539ecd39497bee64440417971e08bc1704e8bd83

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in swiftcore-tasks.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    swiftcore-tasks (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  swiftcore-tasks!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kirk Haines
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kirk Haines
+
+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,54 @@
+# Swiftcore::Tasks
+
+This little library encapsulates a very simple task queue implementation.
+Tasks have a priority, and an object that responds to #call.
+
+A TaskList is a set of Task objects that it orders according to priority.
+
+The Tasklist allows running the whole queue of tasks, or running just a single
+task at a time.
+
+If any Task returns a TaskList, that TaskList gets merged into the parent's
+list of tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swiftcore-tasks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swiftcore-tasks
+
+## Usage
+
+```ruby
+result_list = []
+list = Swiftcore::Tasks::TaskList.new
+list << Swiftcore::Tasks::Task.new(4) { result_list << 3 }
+list << Swiftcore::Tasks::Task.new(2) do
+  sublist = Swiftcore::Tasks::TaskList.new
+  sublist << Swiftcore::Tasks::Task.new(3) { result_list << 2 }
+  sublist << Swiftcore::Tasks::Task.new(5) { result_list << 5 }
+  sublist
+end
+list << Swiftcore::Tasks::Task.new(1) { result_list << 1 }
+
+list.run
+result_list == [1,2,3,5]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swiftcore-tasks.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task defaults: :test

data/lib/swiftcore/tasks.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'swiftcore/tasks/version'
+require 'swiftcore/tasks/tasklist'

data/lib/swiftcore/tasks/task.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Swiftcore
+  module Tasks
+    # This is a sortable, orderable container for a #call()able object.
+    class Task
+      include Comparable
+
+      attr_accessor :order, :status, :result
+      attr_reader :task, :taskord
+
+      def initialize(order = 0, &task)
+        @order = order
+        self.task = task
+        @status = :pending
+        @result = nil
+      end
+
+      def task=(val)
+        @taskord = val.to_s
+        @task = val
+      end
+
+      def less_than(other)
+        (@order < other.order) ||
+          (@order == other.order && @taskord < other.taskord)
+      end
+
+      def greater_than(other)
+        (@order > other.order) ||
+          (@order == other.order && @taskord > other.taskord)
+      end
+
+      def <=>(other)
+        if less_than(other)
+          -1
+        elsif greater_than(other)
+          1
+        else
+          0
+        end
+      end
+
+      def call(*args)
+        @status = :running
+        @result = @task&.call(*args)
+        @status = :finished
+        @result
+      rescue StandardError => e
+        @status = e
+      end
+    end
+  end
+end

data/lib/swiftcore/tasks/tasklist.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'swiftcore/tasks/task'
+
+module Swiftcore
+  module Tasks
+    # Just a SortedSet with a few special powers.
+    class TaskList < SortedSet
+      attr_accessor :status
+
+      def initialize(*args)
+        @status = :pending
+        super(*args)
+      end
+
+      def run
+        @status = :running
+        tick while any?
+        @status = :finished
+      end
+
+      def finished?
+        @status = :finished if empty?
+        @status == :finished
+      end
+
+      # Run a single task in the queue.
+      def tick
+        prior_status = @status
+        @status = :tick
+        task = first
+        result = task.call
+        delete task
+        merge(result) if result.is_a?(TaskList)
+        @status = prior_status
+        finished?
+        result
+      end
+    end
+  end
+end

data/lib/swiftcore/tasks/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Swiftcore
+  module Tasks
+    VERSION = '0.1.0'
+  end
+end

data/swiftcore-tasks.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swiftcore/tasks/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'swiftcore-tasks'
+  spec.version = Swiftcore::Tasks::VERSION
+  spec.authors = ['Kirk Haines']
+  spec.email = ['kirk-haines@cookpad.com']
+
+  spec.summary = <<~ESUMMARY
+    Simple task list library.
+  ESUMMARY
+  spec.description = <<~EDESCRIPTION
+    This is a very simple task list library that I use in a bunch of other places.
+  EDESCRIPTION
+  spec.homepage = 'https://github.com/wyhaines/swiftcore-tasks'
+  spec.license = 'MIT'
+
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: swiftcore-tasks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirk Haines
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: 'This is a very simple task list library that I use in a bunch of other
+  places.
+
+'
+email:
+- kirk-haines@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swiftcore/tasks.rb
+- lib/swiftcore/tasks/task.rb
+- lib/swiftcore/tasks/tasklist.rb
+- lib/swiftcore/tasks/version.rb
+- swiftcore-tasks.gemspec
+homepage: https://github.com/wyhaines/swiftcore-tasks
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Simple task list library.
+test_files: []