octokiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 387dcbd87d4bf68d9cef986923fe654c1d62a1a13ed9288f1cc2c4c5edc7647d
+  data.tar.gz: ad3bf793c30fa11cb61bc59f5bf2479eb884030f3590a2650af671170214deb5
+SHA512:
+  metadata.gz: 2b5ffccf25e4d3033c886dddaaaf4446bb62a6e29fe4312b8fa147931c9b0aafcbdd47fe15fdcf1621a03c4eb32c1bc15d070a8f5225d6ce6733f18c00fb4f6d
+  data.tar.gz: 795233440f34f446b6897615bac42923f5e1a848a10ae9ebcdfd131f626ac0c55f11a50ccf812de8fc8459460a61714f520a90f386488e045d62d6c45fdb9862

data/.gitignore

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 - 2020-12-29
+
+Initial release 🚀

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 bran.liang@shopify.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in octokiq.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "pry-byebug"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    octokiq (0.1.0)
+      redis (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    redis (4.2.5)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  octokiq!
+  pry-byebug
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bran Liang
+
+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,44 @@
+# Octokiq
+
+Next generation background processing for ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'octokiq'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install octokiq
+
+## Usage
+
+Run worker server:
+
+    $ bundle exec octokiq
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/BranLiang/octokiq. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/BranLiang/octokiq/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Octokiq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/BranLiang/octokiq/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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 :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pry-byebug'
+require 'octokiq'
+
+# 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/exe/octokiq

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'octokiq'
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: bundle exec octokiq [options]'
+
+  opts.on '-r', '--require [PATH]', 'Location of file to require' do |arg|
+    require File.expand_path(arg)
+  end
+end.parse!
+
+cmd = Octokiq::CMD.new
+cmd.run

data/lib/octokiq.rb

@@ -0,0 +1,39 @@
+require 'redis'
+
+require 'etc'
+require 'logger'
+require 'json'
+require 'optparse'
+
+require 'octokiq/version'
+require 'octokiq/configuration'
+require 'octokiq/connection'
+require 'octokiq/worker'
+require 'octokiq/processor'
+require 'octokiq/server'
+require 'octokiq/cmd'
+
+module Octokiq
+  extend self
+  class Error < StandardError; end
+
+  def configure
+    yield(configuration)
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def server_connection
+    @server_connection ||= Connection.new
+  end
+
+  def client_connection
+    @client_connection ||= Connection.new
+  end
+
+  def logger
+    Logger.new($stdout)
+  end
+end

data/lib/octokiq/cmd.rb

@@ -0,0 +1,37 @@
+module Octokiq
+  class CMD
+    def run
+      puts logo
+      server.start
+    rescue Interrupt
+      Octokiq.logger.info 'Bye!'
+    end
+
+    private
+
+    def server
+      @server ||= Server.new
+    end
+
+    def logo
+      <<-EOF
+      _,gggggg,_                                                                 
+      ,d8P""d8P"Y8b,                I8                 ,dPYb,                      
+     ,d8'   Y8   "8b,dP             I8                 IP'`Yb                      
+     d8'    `Ybaaad88P'          88888888              I8  8I      gg              
+     8P       `""""Y8               I8                 I8  8bgg,   ""              
+     8b            d8     ,gggg,    I8      ,ggggg,    I8 dP" "8   gg     ,gggg,gg 
+     Y8,          ,8P    dP"  "Yb   I8     dP"  "Y8ggg I8d8bggP"   88    dP"  "Y8I 
+     `Y8,        ,8P'   i8'        ,I8,   i8'    ,8I   I8P' "Yb,   88   i8'    ,8I 
+      `Y8b,,__,,d8P'   ,d8,_    _ ,d88b, ,d8,   ,d8'  ,d8    `Yb,_,88,_,d8,   ,d8b 
+        `"Y8888P"'     P""Y8888PP 8P""Y8 P"Y8888P"    88P      Y88P""Y8P"Y8888P"88d
+                                                                                I8P
+                                                                                I8'
+                                                                                I8 
+                                                                                I8 
+                                                                                I8 
+                                                                                I8 
+      EOF
+    end
+  end
+end

data/lib/octokiq/configuration.rb

@@ -0,0 +1,15 @@
+module Octokiq
+  class Configuration
+    attr_accessor :processors_count,
+                  :queue_prefix,
+                  :default_queue,
+                  :queues
+
+    def initialize
+      @processors_count = Etc.nprocessors
+      @queue_prefix = 'octokiq'
+      @default_queue = 'default'
+      @queues = [@default_queue]
+    end
+  end
+end

data/lib/octokiq/connection.rb

@@ -0,0 +1,28 @@
+module Octokiq
+  class Connection
+    attr_accessor :redis
+
+    def initialize
+      @redis = Redis.new
+    end
+
+    def fetch(queues)
+      _, job = redis.blpop(*build_queues(queues), 0)
+      JSON.parse(job)
+    end
+
+    def push(queue, data)
+      redis.rpush(build_queue(queue), data.to_json)
+    end
+
+    private
+
+    def build_queues(queues)
+      queues.map { |q| build_queue(q) }
+    end
+
+    def build_queue(queue)
+      "#{Octokiq.configuration.queue_prefix}:#{queue}"
+    end
+  end
+end

data/lib/octokiq/logger.rb

@@ -0,0 +1,4 @@
+module Octokiq
+  class Logger < ::Logger
+  end
+end

data/lib/octokiq/processor.rb

@@ -0,0 +1,15 @@
+module Octokiq
+  class Processor
+    attr_accessor :job
+    def initialize(job)
+      @job = job
+    end
+
+    def run
+      Octokiq.logger.info "Job: #{job}"
+      klass = job.fetch(Worker::CLASS_KEY)
+      args = job.fetch(Worker::ARGS_KEY)
+      Object.const_get(klass).new.perform(*args)
+    end
+  end
+end

data/lib/octokiq/server.rb

@@ -0,0 +1,32 @@
+module Octokiq
+  class Server
+    def start
+      (1..Octokiq.configuration.processors_count).map do
+        Ractor.new(pipe) do |pipe|
+          job = pipe.take
+          processor = Processor.new(job)
+          processor.run
+        end
+      end
+
+      loop do
+        job = Octokiq.server_connection.fetch(queues)
+        pipe << job
+      end
+    end
+
+    private
+
+    def queues
+      Octokiq.configuration.queues
+    end
+
+    def pipe
+      @pipe ||= Ractor.new do
+        loop do
+          Ractor.yield Ractor.receive
+        end
+      end
+    end
+  end
+end

data/lib/octokiq/version.rb

@@ -0,0 +1,3 @@
+module Octokiq
+  VERSION = "0.1.0"
+end

data/lib/octokiq/worker.rb

@@ -0,0 +1,27 @@
+module Octokiq
+  module Worker
+    CLASS_KEY = 'class'.freeze
+    ARGS_KEY = 'args'.freeze
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.queue(Octokiq.configuration.default_queue)
+    end
+
+    module ClassMethods
+      def perform_async(*args)
+        client_push(CLASS_KEY => self, ARGS_KEY => args)
+      end
+
+      def queue(name)
+        @@queue = name
+      end
+
+      private
+
+      def client_push(item)
+        Octokiq.client_connection.push(@@queue, item)
+      end
+    end
+  end
+end

data/octokiq.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/octokiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'octokiq'
+  spec.version       = Octokiq::VERSION
+  spec.authors       = ['Bran Liang']
+  spec.email         = ['bran@corran.cn']
+
+  spec.summary       = 'Next generation background processing for ruby'
+  spec.description   = 'Ractor based worker system.'
+  spec.homepage      = 'https://github.com/BranLiang/octokiq'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/BranLiang/octokiq'
+  spec.metadata['changelog_uri'] = 'https://github.com/BranLiang/octokiq/CHANGELOG.md'
+
+  # 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|examples)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency('redis', '~> 4.2')
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: octokiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bran Liang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Ractor based worker system.
+email:
+- bran@corran.cn
+executables:
+- octokiq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/octokiq
+- lib/octokiq.rb
+- lib/octokiq/cmd.rb
+- lib/octokiq/configuration.rb
+- lib/octokiq/connection.rb
+- lib/octokiq/logger.rb
+- lib/octokiq/processor.rb
+- lib/octokiq/server.rb
+- lib/octokiq/version.rb
+- lib/octokiq/worker.rb
+- octokiq.gemspec
+homepage: https://github.com/BranLiang/octokiq
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BranLiang/octokiq
+  source_code_uri: https://github.com/BranLiang/octokiq
+  changelog_uri: https://github.com/BranLiang/octokiq/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Next generation background processing for ruby
+test_files: []