mimi-signal 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0eaf7ad67ee461b781fc1f1dad8211b55bfa8402
4
+ data.tar.gz: 32d0c1354c9965c8341b2dd35eaac502d306ed59
5
+ SHA512:
6
+ metadata.gz: 676e87a4d4c36804ce7bb67108956f4eab5767952b3cb96951e10c93394e35cd7a1690968fbfa565220029d19f517b1e83ced712ae5d74dc06da507c2801e55e
7
+ data.tar.gz: 35fb4e4a1c79b0e54d46fbb0153d1cadc92b8cb228aaf32d109c860037faaf7e88c93563079287c8ce334131feddc848850db3502b0cbb4cd4ae64f703809e24
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at alex@kukushk.in. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in mimi-signal.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Alex Kukushkin
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,97 @@
1
+ # Mimi::Signal
2
+
3
+ Asynchronous processing of trapped signals, solving the limitations of the
4
+ [Ruby trap context](https://www.google.de/search?q=ruby+trap+context).
5
+
6
+ #### Problem:
7
+ ```ruby
8
+ logger = Logger.new(STDOUT)
9
+
10
+ trap('INT') do
11
+ logger.warn 'Interrupted' # => (ThreadError) can't be called from trap context
12
+ # shutdown gracefully ... never executed :(
13
+ end
14
+ ```
15
+
16
+ #### Solution:
17
+ ```ruby
18
+ require 'mimi/signal'
19
+
20
+ logger = Logger.new(STDOUT)
21
+
22
+ Mimi::Signal.trap('INT') do
23
+ logger.warn 'Interrupted' # works!
24
+ # shutdown gracefully ...
25
+ end
26
+ ```
27
+
28
+ ## Installation
29
+
30
+ Add this line to your application's Gemfile:
31
+
32
+ ```ruby
33
+ gem 'mimi-signal'
34
+ ```
35
+
36
+ And then execute:
37
+
38
+ $ bundle
39
+
40
+ Or install it yourself as:
41
+
42
+ $ gem install mimi-signal
43
+
44
+ ## Usage
45
+
46
+ Setting up a signal handler:
47
+ ```ruby
48
+ require 'mimi/signal'
49
+
50
+ Mimi::Signal.trap('INT') do
51
+ # do my stuff
52
+ end
53
+ ```
54
+
55
+ Setting up multiple signal handlers:
56
+ ```ruby
57
+ require 'mimi/signal'
58
+
59
+ Mimi::Signal.trap('INT', 'TERM') do
60
+ # this will be invoked on SIGINT or SIGTERM
61
+ end
62
+
63
+ Mimi::Signal.trap('INT') do
64
+ # this will be invoked on SIGINT in addition to the handler above
65
+ end
66
+ ```
67
+
68
+ Stopping the signal handlers, untrapping the previously trapped signals:
69
+ ```ruby
70
+ require 'mimi/signal'
71
+
72
+ Mimi::Signal.trap('TERM') do
73
+ # something
74
+ end
75
+
76
+ Mimi::Signal.trap('INT') do
77
+ # something
78
+ end
79
+
80
+ Mimi::Signal.stop # untraps INT and TERM, reverting the handlers to the original handlers
81
+ ```
82
+
83
+ ## Development
84
+
85
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
86
+
87
+ 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).
88
+
89
+ ## Contributing
90
+
91
+ Bug reports and pull requests are welcome on GitHub at https://github.com/kukushkin/mimi-signal. 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.
92
+
93
+
94
+ ## License
95
+
96
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
97
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "mimi/signal"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ module Mimi
2
+ class Signal
3
+ VERSION = '0.1.0'.freeze
4
+ end
5
+ end
@@ -0,0 +1,84 @@
1
+ require 'mimi/core'
2
+
3
+ # Asynchronous processing of trapped signals
4
+ #
5
+ # Example:
6
+ # logger = Logger.new(STDOUT)
7
+ #
8
+ # trap('INT') do
9
+ # logger.warn 'Interrupted' # => (ThreadError) can't be called from trap context
10
+ # # shutdown gracefully ...
11
+ # end
12
+ #
13
+ # Solution:
14
+ # logger = Logger.new(STDOUT)
15
+ #
16
+ # Mimi::Signal.trap('INT') do
17
+ # logger.warn 'Interrupted' # works!
18
+ # # shutdown gracefully ...
19
+ # end
20
+ #
21
+ #
22
+ module Mimi
23
+ class Signal
24
+ attr_reader :signal
25
+
26
+ private
27
+
28
+ def initialize(signal, &block)
29
+ self.class.handlers[signal.to_sym] ||= { old_trap: nil, blocks: [] }
30
+ self.class.handlers[signal.to_sym][:blocks].push(block)
31
+ self.class.handlers[signal.to_sym][:old_trap] ||=
32
+ Kernel.trap(signal) do
33
+ puts "#{self} got signal #{signal}"
34
+ self.class.queue << signal.to_sym
35
+ end
36
+ self.class.start
37
+ end
38
+
39
+ # Traps a signal (or multiple signals) and installs the signal handler
40
+ #
41
+ # @param [Array<String,Symbol>] signals
42
+ #
43
+ def self.trap(*signals, &block)
44
+ signals.each { |s| new(s, &block) }
45
+ end
46
+
47
+ # Starts the background thread which monitors queued signals.
48
+ # Invoked implicitly when any signal handler is installed
49
+ #
50
+ def self.start
51
+ return if @thread
52
+ @thread = Thread.new do
53
+ loop do
54
+ signal = queue.pop # it's blocking
55
+ handlers[signal][:blocks].each(&:call) if handlers[signal]
56
+ end
57
+ end
58
+ end
59
+
60
+ # Stops the Mimi::Signal, untraps all trapped signals
61
+ #
62
+ def self.stop
63
+ return unless @thread
64
+ handlers.keys.each do |signal|
65
+ Kernel.trap(signal, handlers[signal][:old_trap])
66
+ end
67
+ @thread.kill
68
+ @thread = nil
69
+ @handlers = nil
70
+ end
71
+
72
+ private # -ish class methods
73
+
74
+ def self.handlers
75
+ @handlers ||= {}
76
+ end
77
+
78
+ def self.queue
79
+ @queue ||= Queue.new
80
+ end
81
+ end # class Signal
82
+ end # module Mimi
83
+
84
+ require_relative 'signal/version'
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'mimi/signal/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'mimi-signal'
8
+ spec.version = Mimi::Signal::VERSION
9
+ spec.authors = ['Alex Kukushkin']
10
+ spec.email = ['alex@kukushk.in']
11
+
12
+ spec.summary = 'Asynchronous signal trap'
13
+ spec.description = 'Asynchronous processing of trapped signals'
14
+ spec.homepage = 'https://github.com/kukushkin/mimi-signal'
15
+ spec.license = 'MIT'
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org'
21
+ else
22
+ raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = 'exe'
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ['lib']
29
+
30
+ spec.add_dependency 'mimi-core', '~> 0.1'
31
+ spec.add_development_dependency 'bundler', '~> 1.11'
32
+ spec.add_development_dependency 'rake', '~> 10.0'
33
+ spec.add_development_dependency 'rspec', '~> 3.0'
34
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mimi-signal
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Alex Kukushkin
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-07-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: mimi-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Asynchronous processing of trapped signals
70
+ email:
71
+ - alex@kukushk.in
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - lib/mimi/signal.rb
87
+ - lib/mimi/signal/version.rb
88
+ - mimi-signal.gemspec
89
+ homepage: https://github.com/kukushkin/mimi-signal
90
+ licenses:
91
+ - MIT
92
+ metadata:
93
+ allowed_push_host: https://rubygems.org
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.4.5.1
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Asynchronous signal trap
114
+ test_files: []