plux 0.1.2

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
+ SHA256:
3
+ metadata.gz: a48ed6a3720e61c2bce1d3b181f93b2b8c290019c7feb076ca2398a4c0b6f203
4
+ data.tar.gz: 67d7f993aeba391f3986e284c38846e5bc4afb3305b475e390969c3f3dca5c09
5
+ SHA512:
6
+ metadata.gz: 10539dd311f59a391218943e159d389b99033239136f6aeb04137f39e3d563c5fb5af287d907a708bb1f4cbbfec942e3a1e4d053c64e92147f91ca121b3c1559
7
+ data.tar.gz: eab024ca828276eebc07118249bd7d9493dde24988f14bd7df71f367d865a5a7580fdc7dc5fdd97e6ee119b56d9cb43f98f9bd81ce0dd58cd74932719c46bed9
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ *.gem
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.4
7
+ before_install: gem install bundler -v 2.0.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at block24block@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in plux.gemspec
4
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,28 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ plux (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ coderay (1.1.2)
10
+ method_source (0.9.2)
11
+ minitest (5.14.1)
12
+ pry (0.12.2)
13
+ coderay (~> 1.1.0)
14
+ method_source (~> 0.9.0)
15
+ rake (10.5.0)
16
+
17
+ PLATFORMS
18
+ ruby
19
+
20
+ DEPENDENCIES
21
+ bundler (~> 2.0)
22
+ minitest (~> 5.0)
23
+ plux!
24
+ pry
25
+ rake (~> 10.0)
26
+
27
+ BUNDLED WITH
28
+ 2.0.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 ken
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,66 @@
1
+ # Plux
2
+
3
+ An easy unixsocket server
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'plux'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install plux
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ # start one and only process named 'abc',
25
+ # no matter the code below is called how many times in whatever processes/threads
26
+ server = Plux.worker(:abc) do
27
+
28
+ # prepare resources like mq/db, to handle requests
29
+ def initialize
30
+ # @db = ...
31
+ end
32
+
33
+ # threads call this method to deal with clients' message
34
+ def work(msg)
35
+ # @db << parse(msg)
36
+ end
37
+ end
38
+
39
+ # five threads will be started to handle these clients,
40
+ # and finished once their counterparts call close
41
+ 5.times do |n|
42
+ Thread.new do
43
+ client = server.connect
44
+ client.puts "hello #{n}"
45
+ client.close
46
+ end
47
+ end
48
+ ```
49
+
50
+ ## Development
51
+
52
+ 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.
53
+
54
+ 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).
55
+
56
+ ## Contributing
57
+
58
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plux. 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.
59
+
60
+ ## License
61
+
62
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
63
+
64
+ ## Code of Conduct
65
+
66
+ Everyone interacting in the Plux project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/plux/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "plux"
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 "pry"
14
+ pry
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,22 @@
1
+ module Plux
2
+ class Client
3
+ attr_reader :server_name
4
+
5
+ def initialize(server_name)
6
+ @server_name = server_name
7
+ UNIXSocket.open(Plux.server_file(server_name)) do |c|
8
+ reader, @writer = IO.pipe
9
+ c.send_io(reader)
10
+ reader.close
11
+ end
12
+ end
13
+
14
+ def puts(arg)
15
+ @writer.puts(arg)
16
+ end
17
+
18
+ def close
19
+ @writer.close
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,81 @@
1
+ module Plux
2
+
3
+ class Server
4
+ attr_reader :name, :pid
5
+
6
+ Active = {}
7
+ at_exit{ Active.values.each(&:close) }
8
+
9
+ def initialize(name)
10
+ @name = name
11
+ end
12
+
13
+ def boot(block)
14
+ Plux.lock_pid_file(name) do |file|
15
+ start_server_if_not_pid(file, block)
16
+ end
17
+ self
18
+ end
19
+
20
+ def close
21
+ Process.kill('TERM', pid) rescue Errno::ESRCH
22
+ end
23
+
24
+ def connect
25
+ Client.new(name)
26
+ end
27
+
28
+ private
29
+
30
+ def start_server_if_not_pid(file, block)
31
+ @pid = file.read.to_i
32
+ return unless pid == 0
33
+
34
+ child, parent = IO.pipe
35
+
36
+ @pid = fork do
37
+ at_exit{ delete_server }
38
+ file.close
39
+ child.close
40
+ UNIXServer.open(Plux.server_file(name)) do |serv|
41
+ parent.close
42
+ worker = Class.new(&block).new
43
+ loop do
44
+ socket = serv.accept
45
+ Worker.new(socket, worker)
46
+ end
47
+ end
48
+ end
49
+
50
+ parent.close
51
+ child.read
52
+ child.close
53
+
54
+ file.rewind
55
+ file.write(pid)
56
+ Process.detach(pid)
57
+ Active[name] = self
58
+ end
59
+
60
+ def delete_server
61
+ [:server_file, :pid_file].each do |file|
62
+ File.delete(Plux.send(file, name))
63
+ end
64
+ end
65
+
66
+ class Worker
67
+ def initialize(socket, worker)
68
+ t = Thread.new do
69
+ client = socket.recv_io
70
+ socket.close
71
+ while line = client.gets
72
+ worker.work(line)
73
+ end
74
+ client.close
75
+ end
76
+ end
77
+ end
78
+
79
+ end
80
+
81
+ end
@@ -0,0 +1,3 @@
1
+ module Plux
2
+ VERSION = "0.1.2"
3
+ end
data/lib/plux.rb ADDED
@@ -0,0 +1,39 @@
1
+ require "fileutils"
2
+ require "socket"
3
+ require "plux/version"
4
+ require "plux/server"
5
+ require "plux/client"
6
+
7
+ module Plux
8
+
9
+ class << self
10
+ def dir
11
+ File.join(Dir.home, '.plux')
12
+ end
13
+
14
+ def pid_file(server_name)
15
+ File.join(dir, "#{server_name}.pid")
16
+ end
17
+
18
+ def lock_pid_file(name)
19
+ File.open(pid_file(name), File::RDWR|File::CREAT, 0644) do |file|
20
+ begin
21
+ file.flock(File::LOCK_EX)
22
+ yield file
23
+ ensure
24
+ file.flock(File::LOCK_UN)
25
+ end
26
+ end
27
+ end
28
+
29
+ def server_file(server_name)
30
+ File.join(dir, "#{server_name}.so")
31
+ end
32
+
33
+ def worker(name, &block)
34
+ Server.new(name).boot(block)
35
+ end
36
+ end
37
+
38
+ FileUtils.mkdir_p(self.dir)
39
+ end
data/plux.gemspec ADDED
@@ -0,0 +1,26 @@
1
+ lib = File.expand_path("lib", __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "plux/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "plux"
7
+ spec.version = Plux::VERSION
8
+ spec.authors = ["ken"]
9
+ spec.email = ["block24block@gmail.com"]
10
+
11
+ spec.summary = %q{Easy unixsocket & server}
12
+ spec.homepage = "https://github.com/turnon/plux"
13
+ spec.license = "MIT"
14
+
15
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
16
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ end
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 2.0"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "minitest", "~> 5.0"
25
+ spec.add_development_dependency "pry"
26
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: plux
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.2
5
+ platform: ruby
6
+ authors:
7
+ - ken
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-09-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description:
70
+ email:
71
+ - block24block@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".travis.yml"
78
+ - CODE_OF_CONDUCT.md
79
+ - Gemfile
80
+ - Gemfile.lock
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - lib/plux.rb
87
+ - lib/plux/client.rb
88
+ - lib/plux/server.rb
89
+ - lib/plux/version.rb
90
+ - plux.gemspec
91
+ homepage: https://github.com/turnon/plux
92
+ licenses:
93
+ - MIT
94
+ metadata: {}
95
+ post_install_message:
96
+ rdoc_options: []
97
+ require_paths:
98
+ - lib
99
+ required_ruby_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ requirements: []
110
+ rubygems_version: 3.0.3
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Easy unixsocket & server
114
+ test_files: []