edrive 1.0.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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 9cd4944abb890c46f40eb1bf9e27fc83df7c5fe2e3e8d698a1463783e670af9b
4
+ data.tar.gz: 54ec78f62a48010a9b07b2a26b8e769b43b6cd088d2929a4aaeef83a712c2075
5
+ SHA512:
6
+ metadata.gz: 25647f39711646dd577a39a8c723afdcec6cb7ef7b60222c2a3080663b83557497fadb6da046602161e8fa825346b167ff4a32bad33d617fb12b140b77ac945a
7
+ data.tar.gz: d2c82215cc2217930d405bda18b196bbb9fd4197936e3a46c613ff606ab0824905de5d3c7dc00a6bfbd0e133e5fdb1ef38b716badb9123066c210fee63cb14d7
@@ -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 shimizu.michinao@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,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in edrive.gemspec
6
+ gemspec
@@ -0,0 +1,35 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ edrive (1.0.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ rake (10.5.0)
11
+ rspec (3.7.0)
12
+ rspec-core (~> 3.7.0)
13
+ rspec-expectations (~> 3.7.0)
14
+ rspec-mocks (~> 3.7.0)
15
+ rspec-core (3.7.1)
16
+ rspec-support (~> 3.7.0)
17
+ rspec-expectations (3.7.0)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.7.0)
20
+ rspec-mocks (3.7.0)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.7.0)
23
+ rspec-support (3.7.1)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ bundler (~> 1.16)
30
+ edrive!
31
+ rake (~> 10.0)
32
+ rspec (~> 3.0)
33
+
34
+ BUNDLED WITH
35
+ 1.16.2
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 MichinaoShimizu
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.
@@ -0,0 +1,104 @@
1
+ # Edrive
2
+
3
+ We provide simple event dispatcher mechanism for your ruby products.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'edrive'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install edrive
20
+
21
+ ## Usage
22
+
23
+ ### subscribe lambda & dispatch
24
+
25
+ ```ruby
26
+ dispatcher = Edrive::Dispatcher.new
27
+ dispatcher.subscribe(:event, -> { puts 1 })
28
+ dispatcher.subscribe(:event, -> { puts 2 })
29
+ dispatcher.subscribe(:event, -> { puts 3 })
30
+ dispatcher.dispatch(:event)
31
+
32
+ 1
33
+ 2
34
+ 3
35
+ ```
36
+
37
+ ### subscribe lambda & dispatch with data
38
+
39
+ ```ruby
40
+ dispatcher = Edrive::Dispatcher.new
41
+ dispatcher.subscribe(:event, ->(data) { data + 1 })
42
+ dispatcher.subscribe(:event, ->(data) { data + 2 })
43
+ dispatcher.subscribe(:event, ->(data) { data + 3 })
44
+ dispatcher.subscribe(:event, ->(data) { puts data })
45
+ dispatcher.dispatch_with_data(:event, 100)
46
+
47
+ 106
48
+ ```
49
+
50
+ ### subscribe block
51
+
52
+ ```ruby
53
+ dispatcher = Edrive::Dispatcher.new
54
+ dispatcher.subscribe_block(:event) { puts 1 }
55
+ dispatcher.subscribe_block(:event) { puts 2 }
56
+ dispatcher.subscribe_block(:event) { puts 3 }
57
+ dispatcher.dispatch(:event)
58
+
59
+ 1
60
+ 2
61
+ 3
62
+ ```
63
+
64
+ ### subscribe block & dispatch with data
65
+
66
+ ```ruby
67
+ dispatcher = Edrive::Dispatcher.new
68
+ dispatcher.subscribe_block(:event) { |data| data + 1 }
69
+ dispatcher.subscribe_block(:event) { |data| data + 2 }
70
+ dispatcher.subscribe_block(:event) { |data| data + 3 }
71
+ dispatcher.dispatch_with_data(:event, 100)
72
+
73
+ 106
74
+ ```
75
+
76
+ ### clear target event
77
+
78
+ ```ruby
79
+ dispatcher.clear_subscribers!(:event)
80
+ ```
81
+
82
+ ### clean all event
83
+
84
+ ```ruby
85
+ dispatcher.clear_all_subscribers!
86
+ ```
87
+
88
+ ## Development
89
+
90
+ 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.
91
+
92
+ 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).
93
+
94
+ ## Contributing
95
+
96
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/edrive. 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.
97
+
98
+ ## License
99
+
100
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
101
+
102
+ ## Code of Conduct
103
+
104
+ Everyone interacting in the Edrive project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/edrive/blob/master/CODE_OF_CONDUCT.md).
@@ -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
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "edrive"
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(__FILE__)
@@ -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,29 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "edrive/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "edrive"
8
+ spec.version = Edrive::VERSION
9
+ spec.authors = ["MichinaoShimizu"]
10
+ spec.email = ["shimizu.michinao@gmail.com"]
11
+
12
+ spec.summary = %q{Generic Event Dispatcher}
13
+ spec.description = %q{Generic Event Dispatcher}
14
+ spec.homepage = "https://github.com/MichinaoShimizu/edrive"
15
+ spec.license = "MIT"
16
+
17
+ # Specify which files should be added to the gem when it is released.
18
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.16"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ end
@@ -0,0 +1,6 @@
1
+ require "edrive/version"
2
+ require "edrive/dispatcher"
3
+
4
+ module Edrive
5
+ # Your code goes here...
6
+ end
@@ -0,0 +1,86 @@
1
+ module Edrive
2
+ # Simple Event Dispatcher
3
+ # @author Michinao Shimizu <shimizu.michinao@gmail.com>
4
+ class Dispatcher
5
+ attr_accessor :event_listeners
6
+
7
+ # initialize
8
+ def initialize
9
+ @event_listeners = {}
10
+ end
11
+
12
+ # Subscribe with proc, lambda
13
+ # @param [Symbol] event event name symbol
14
+ # @param [Proc] subscriber subscriber
15
+ # @raise ArgumentError
16
+ # @return [Array] registered subscriber list
17
+ def subscribe(event, subscriber)
18
+ raise ArgumentError, 'subscriber must be Proc object' unless subscriber.is_a?(Proc)
19
+ regist_subscriber_proc(event, subscriber)
20
+ end
21
+
22
+ # Subscribe with block
23
+ # @param [Symbol] event event name symbol
24
+ # @param [Block] subscriber subscriber
25
+ # @return [Array] registered subscriber list
26
+ def subscribe_block(event, &subscriber)
27
+ regist_subscriber_proc(event, subscriber)
28
+ end
29
+
30
+ # Dispatch specific event subscribers
31
+ # @param [Symbol] event event name
32
+ # @param [Mixed] args
33
+ # @return [Mixed] last subscriber return value
34
+ def dispatch(event, *args)
35
+ result = nil
36
+
37
+ @event_listeners[event]&.each do |subscriber|
38
+ result = subscriber.call(*args)
39
+ end
40
+ result
41
+ end
42
+
43
+ # Dispatch specific event subscribers with data
44
+ # @param [Symbol] event event name
45
+ # @param [Mixed] args
46
+ # @return [Mixed] last subscriber return value
47
+ def dispatch_with_data(event, data, *args)
48
+ result = data.dup
49
+ @event_listeners[event]&.each do |subscriber|
50
+ result = subscriber.call(result, *args)
51
+ end
52
+ result
53
+ end
54
+
55
+ # Get specific event subscribers
56
+ # @param [Symbol] event event name symbol
57
+ # @return [Array] registered subscriber list
58
+ def subscribers(event)
59
+ @event_listeners[event] || []
60
+ end
61
+
62
+ # Clear specific event subscribers
63
+ # @param [Symbol] event event name symbol
64
+ # @return [Array] emnpty array
65
+ def clear_subscribers!(event)
66
+ @event_listeners[event] = []
67
+ end
68
+
69
+ # Clear all of event subscribers
70
+ # @return [Hash] emnpty hash
71
+ def clear_all_subscribers!
72
+ @event_listeners = {}
73
+ end
74
+
75
+ private
76
+
77
+ # Regist subscriber proc
78
+ # @param [Symbol] event event name symbol
79
+ # @param [Proc] subscriber subscriber
80
+ # @return [Array] registered subscriber list
81
+ def regist_subscriber_proc(event, subscriber)
82
+ @event_listeners[event] ||= []
83
+ @event_listeners[event] << subscriber
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,3 @@
1
+ module Edrive
2
+ VERSION = "1.0.0"
3
+ end
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: edrive
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - MichinaoShimizu
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-07-01 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: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
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: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Generic Event Dispatcher
56
+ email:
57
+ - shimizu.michinao@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - CODE_OF_CONDUCT.md
63
+ - Gemfile
64
+ - Gemfile.lock
65
+ - LICENSE.txt
66
+ - README.md
67
+ - Rakefile
68
+ - bin/console
69
+ - bin/setup
70
+ - edrive.gemspec
71
+ - lib/edrive.rb
72
+ - lib/edrive/dispatcher.rb
73
+ - lib/edrive/version.rb
74
+ homepage: https://github.com/MichinaoShimizu/edrive
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.7.6
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: Generic Event Dispatcher
98
+ test_files: []