canto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43e960399cb0a94b0062d5c7ac3752de9a42faa039bc8319408d4b05112eb992
+  data.tar.gz: 68f6804de4d4f0b590178c42522ff9edab6936bd8f7e6ac95f72938795ac47a7
+SHA512:
+  metadata.gz: 274c5e3277fc0bc29b8698c7e428f1d606ce2b52e5cda3eda9a753b31823898b32eb5f6a090c501782d48b98552f7c19bc5b076f0d0860a1a37d9fd32a7f3177
+  data.tar.gz: 3b88b4c04acd0569d1d6ae5ceff2da8323dba55031be16d006220adcd510a42c778803fb9b17440b880aba38a061be3e74ebd63d0de956bdd97be2303f221565

data/.circleci/config.yml

@@ -0,0 +1,39 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.0.0
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.2
+
+    steps:
+      - checkout
+      - ruby/install-deps
+
+  minitest:
+    docker:
+      - image: circleci/ruby:2.7.2
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+
+    steps:
+      - checkout
+      - ruby/install-deps
+
+      - run:
+          name: Stale code fix
+          command: git fetch && git reset --hard origin/${CIRCLE_BRANCH}
+      - run:
+          name: Minitest
+          command: bundle exec rake test
+
+workflows:
+  tests:
+    jobs:
+      - build
+      - minitest:
+          requires:
+            - build

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.standard.yml

@@ -0,0 +1,22 @@
+#fix: true               # default: false
+parallel: true           # default: false
+#format: progress        # default: Standard::Formatter
+#ruby_version: 2.3.3     # default: RUBY_VERSION
+#default_ignores: false  # default: true
+#
+ignore:
+  - './**/*':
+    - Style/RescueModifier
+    - Style/StringLiterals
+    - Style/StringLiteralsInInterpolation
+    - Lint/AssignmentInCondition
+    - Security/YAMLLoad
+    - Layout/SpaceInsideHashLiteralBraces
+    - Layout/ArgumentAlignment
+    - Standard/SemanticBlocks
+#  - 'db/schema.rb'
+#  - 'vendor/**/*'
+  - 'config/**/*'
+  - 'spec/**/*':
+    - Layout/EmptyLinesAroundBlockBody
+#      - Layout/AlignHash

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 merkulov@uchi.ru. 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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in canto.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    canto (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  canto!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Alexander Merkulov
+
+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,43 @@
+# Canto
+
+Canto is a tool to run plain non-blocking ruby programs, like pubsub.
+Canto has simple IO.pipe interface, watching for signals, makes your non-blocking running.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canto'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install canto
+
+## Usage
+
+    bundle exec canto -r PATH_TO_YOUR_RUBY_FILE -e production
+
+## 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/merqlove/canto. 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/merqloveu/canto/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 Canto project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/merqloveu/canto/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/canto

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/canto'
+require_relative '../lib/canto/cli'
+
+begin
+  cli = Canto::CLI.instance
+  cli.parse
+  cli.run
+rescue => e
+  raise e if $DEBUG
+
+  exit 1
+end

data/canto.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/canto/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'canto'
+  spec.version = Canto::VERSION
+  spec.authors = ['Alexander Merkulov']
+  spec.email = ['merkulov@uchi.ru']
+
+  spec.summary = 'Canto is a tool to run non-blocking ruby programs, like pubsub.'
+  spec.description = 'Canto has simple IO.pipe interface, watching for signals, makes your non-blocking running.'
+  spec.homepage = 'https://github.com/merqloveu/canto'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/merqloveu/canto'
+
+  # 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)/}) }
+  end
+
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/canto.rb

@@ -0,0 +1,7 @@
+require 'canto/version'
+
+module Canto
+  DEFAULTS = {
+    environment: nil
+  }.freeze
+end

data/lib/canto/cli.rb

@@ -0,0 +1,150 @@
+require 'singleton'
+require 'optparse'
+require 'fileutils'
+
+$stdout.sync = true
+
+class Canto
+  class CLI
+    include Singleton
+
+    attr_reader :logger
+    attr_accessor :environment
+
+    def parse(args = ARGV)
+      setup_options(args)
+      initialize_logger
+      validate!
+    end
+
+    def run(launcher, boot_app: true)
+      boot_application if boot_app
+
+      self_read, self_write = IO.pipe
+      sigs = %w[INT TERM TTIN TSTP]
+      sigs.each do |sig|
+        trap sig do
+          self_write.puts(sig)
+        end
+      rescue ArgumentError
+        puts "Signal #{sig} not supported"
+      end
+
+      launch(self_read)
+    end
+
+    def launch(self_read)
+      begin
+        while (readable_io = IO.select([self_read]))
+          signal = readable_io.first[0].gets.strip
+          handle_signal(signal)
+        end
+      rescue Interrupt
+        Canto.logger.info 'Shutting down'
+        Canto.logger.info 'Bye!'
+
+        # Explicitly exit so busy Processor threads won't block process shutdown.
+        #
+        # NB: slow at_exit handlers will prevent a timely exit if they take
+        # a while to run. If Sidekiq is getting here but the process isn't exiting,
+        # use the TTIN signal to determine where things are stuck.
+        exit(0)
+      end
+    end
+
+    SIGNAL_HANDLERS = {
+      # Ctrl-C in terminal
+      'INT' => ->(_) { raise Interrupt },
+      # TERM is the signal that Pipe must exit.
+      # Heroku sends TERM and then waits 30 seconds for process to exit.
+      'TERM' => ->(_) { raise Interrupt },
+      'TSTP' => ->(_) {
+        Canto.logger.info 'Received TSTP, no longer accepting new work'
+      },
+      'TTIN' => ->(_) {
+        Thread.list.each do |thread|
+          Canto.logger.warn "Thread TID-#{(thread.object_id ^ ::Process.pid).to_s(36)} #{thread.name}"
+          if thread.backtrace
+            Canto.logger.warn thread.backtrace.join("\n")
+          else
+            Canto.logger.warn '<no backtrace available>'
+          end
+        end
+      }
+    }.freeze
+    UNHANDLED_SIGNAL_HANDLER = ->(_) { Canto.logger.info 'No signal handler registered, ignoring' }
+    SIGNAL_HANDLERS.default = UNHANDLED_SIGNAL_HANDLER
+
+    def handle_signal(sig)
+      Canto.logger.debug "Got #{sig} signal"
+      SIGNAL_HANDLERS[sig].call(self)
+    end
+
+    def setup_options(args)
+      # parse CLI options
+      opts = parse_options(args)
+
+      set_environment opts[:environment]
+
+      options.merge!(opts)
+    end
+
+    def parse_options(argv)
+      opts = {}
+      @parser = option_parser(opts)
+      @parser.parse!(argv)
+      opts
+    end
+
+    def set_environment(cli_env)
+      @environment = cli_env || ENV['APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+    end
+
+    def initialize_logger
+      @logger = Logger.new($stdout, level: Logger::INFO)
+    end
+
+    def boot_application
+      ENV['RACK_ENV'] = ENV['RAILS_ENV'] = environment
+
+      require options[:require]
+    end
+
+    def validate!
+      if !File.exist?(options[:require]) ||
+          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
+        logger.info '=================================================================='
+        logger.info '  Please point Canto to Ruby file  '
+        logger.info '  to load your classes with -r [FILE].'
+        logger.info '=================================================================='
+        logger.info @parser
+        die(1)
+      end
+    end
+
+    def option_parser(opts)
+      parser = OptionParser.new { |o|
+        o.on '-e', '--environment ENV', 'Application environment' do |arg|
+          opts[:environment] = arg
+        end
+
+        o.on '-r', '--require [PATH]', 'Location of ruby file to require' do |arg|
+          opts[:require] = arg
+        end
+
+        o.on '-V', '--version', 'Print version and exit' do |arg|
+          puts "Canto #{Canto::VERSION}"
+          die(0)
+        end
+      }
+
+      parser.banner = 'canto [options]'
+      parser.on_tail '-h', '--help', 'Show help' do
+        logger.info parser
+        die 1
+      end
+
+      parser
+    end
+  end
+end

data/lib/canto/version.rb

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: canto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Merkulov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-19 00:00:00.000000000 Z
+dependencies: []
+description: Canto has simple IO.pipe interface, watching for signals, makes your
+  non-blocking running.
+email:
+- merkulov@uchi.ru
+executables:
+- canto
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/canto
+- canto.gemspec
+- lib/canto.rb
+- lib/canto/cli.rb
+- lib/canto/version.rb
+homepage: https://github.com/merqloveu/canto
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/merqloveu/canto
+  source_code_uri: https://github.com/merqloveu/canto
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: Canto is a tool to run non-blocking ruby programs, like pubsub.
+test_files: []