resugan 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b0c94f2885b44f9105e0f6bc738947aa41cdb29e
4
+ data.tar.gz: aa688b92c3fb9542685f00f0121ae274fcd605aa
5
+ SHA512:
6
+ metadata.gz: a7dd76bc32c30971518858f3106a23edc2ad8c198c762aaf9b6cfded67079d0fbeef2a2f81fc701593493f0ef94cc75dee7587f9b66ab2d4062313b88ac6c848
7
+ data.tar.gz: a513e050ea06afa69a81cb8627076688d27808e4149a5e3d5713af09d69bc6ff449170672b46b68c66d409800e0745c6fff8e91b4554fd20fad8af53929c7a68
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ *.gem
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.3
@@ -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 joseph.dayo@gmail.com. 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 resugan.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Joseph Emmanuel Dayo
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,73 @@
1
+ # Resugan
2
+
3
+ Simple, powerful and unobstrusive observer pattern framework for ruby. This gem provides
4
+ a base framework in order to build a more powerful event based system on top of it.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'resugan'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install resugan
21
+
22
+ ## Basic Usage
23
+
24
+ Register listeners:
25
+
26
+ ```ruby
27
+ Resugan::Kernel.register(:event2, ->(params) {
28
+ puts "hello! event 2 has been called!"
29
+ })
30
+
31
+ Resugan::Kernel.register(:hay, ->(params) {
32
+ puts "hello! someone said hay!"
33
+ })
34
+ ```
35
+
36
+ Generate events and wrap them in a resugan block:
37
+
38
+ ```ruby
39
+ resugan {
40
+ puts "I am now going to generate an event"
41
+
42
+ fire :event2
43
+
44
+ fire :hay
45
+ }
46
+ ```
47
+
48
+ The two events should fire and should print:
49
+
50
+ ```
51
+ hello! event 2 has been called!
52
+ hello! someone said hay!
53
+ ```
54
+
55
+ Note that your listener will be executed once even if an event has been fired
56
+ multiple times. However params will contain the payload of both events.
57
+
58
+ Please see spec/resugan_spec.rb for more examples and details.
59
+
60
+ ## Development
61
+
62
+ 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.
63
+
64
+ 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).
65
+
66
+ ## Contributing
67
+
68
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resugan. 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.
69
+
70
+
71
+ ## License
72
+
73
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
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 "resugan"
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,25 @@
1
+ module Resugan
2
+ class Context
3
+ def initialize(namespace = '')
4
+ @namespace = namespace
5
+ @events = {}
6
+ end
7
+
8
+ def register(event, params = {})
9
+ event = event.to_sym
10
+ payload = { params: params }
11
+ if @events[event]
12
+ @events[event] << payload
13
+ else
14
+ @events[event] = [payload]
15
+ end
16
+ end
17
+
18
+ def invoke
19
+ @events.each do |k,v|
20
+ puts "fire #{k}"
21
+ Resugan::Kernel.invoke(@namespace, k, v)
22
+ end
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,39 @@
1
+ module Resugan
2
+ class Kernel
3
+ def self.register(event, block)
4
+ register_with_namespace("", event, block)
5
+ end
6
+
7
+ def self.register_with_namespace(namespace, event, block)
8
+ @listener = {} unless @listener
9
+
10
+ event = "#{namespace}_#{event}".to_sym
11
+
12
+ unless @listener[event]
13
+ @listener[event] = [block]
14
+ else
15
+ @listener[event] << block
16
+ end
17
+
18
+ self
19
+ end
20
+
21
+ def self.invoke(namespace, event, payload = [])
22
+ event = "#{namespace}_#{event}".to_sym
23
+ p payload
24
+ if @listener[event]
25
+ @listener[event].each do |listener|
26
+ listener.call(payload.map { |p| p[:params] })
27
+ end
28
+ end
29
+ end
30
+
31
+ def self.listeners
32
+ @listener
33
+ end
34
+
35
+ def self.clear
36
+ @listener.clear if @listener
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,18 @@
1
+ class Object
2
+ def resugan(namespace = '', &block)
3
+ current_thread = Thread.current
4
+ current_thread.push_resugan_context(namespace)
5
+
6
+ block.call
7
+
8
+ context = current_thread.pop_resugan_context
9
+ context.invoke
10
+ end
11
+
12
+ def fire(event, params = {})
13
+ current_thread = Thread.current
14
+ if current_thread.resugan_context
15
+ current_thread.resugan_context.register(event, params)
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,19 @@
1
+ module Resugan
2
+ module ObjectHelpers
3
+ def self.included base
4
+ base.extend ClassMethods
5
+ end
6
+
7
+ module ClassMethods
8
+ def attach_hook(method, options = {})
9
+ alias_method "_resugan_orig_#{method}".to_sym, method.to_sym
10
+
11
+ define_method(method.to_sym) do |*args|
12
+ resugan options[:namespace] do
13
+ send("_resugan_orig_#{method}".to_sym, *args)
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,18 @@
1
+ class Thread
2
+ def push_resugan_context(namespace = '')
3
+ if !@resugan_context
4
+ @resugan_context_stack = []
5
+ end
6
+
7
+ @resugan_context = Resugan::Context.new(namespace)
8
+ @resugan_context_stack << @resugan_context
9
+ end
10
+
11
+ def pop_resugan_context
12
+ @resugan_context = @resugan_context_stack.pop
13
+ end
14
+
15
+ def resugan_context
16
+ @resugan_context
17
+ end
18
+ end
@@ -0,0 +1,3 @@
1
+ module Resugan
2
+ VERSION = "0.1.0"
3
+ end
data/lib/resugan.rb ADDED
@@ -0,0 +1,9 @@
1
+ require "resugan/version"
2
+ require "resugan/kernel"
3
+ require "resugan/object"
4
+ require "resugan/thread"
5
+ require "resugan/context"
6
+ require "resugan/object_helpers"
7
+
8
+ module Resugan
9
+ end
data/resugan.gemspec ADDED
@@ -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 'resugan/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "resugan"
8
+ spec.version = Resugan::VERSION
9
+ spec.authors = ["Joseph Emmanuel Dayo"]
10
+ spec.email = ["joseph.dayo@gmail.com"]
11
+
12
+ spec.summary = %q{ simple, powerful and unobstrusive observer pattern framework for ruby }
13
+ spec.description = %q{ simple, powerful and unobstrusive observer pattern framework for ruby }
14
+ spec.homepage = "https://github.com/jedld/resugan"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing 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_development_dependency "bundler", "~> 1.12"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "rspec", "~> 3.0"
33
+ spec.add_development_dependency "pry"
34
+ end
metadata ADDED
@@ -0,0 +1,119 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: resugan
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Joseph Emmanuel Dayo
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-13 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.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
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
+ - !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: " simple, powerful and unobstrusive observer pattern framework for ruby "
70
+ email:
71
+ - joseph.dayo@gmail.com
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/resugan.rb
87
+ - lib/resugan/context.rb
88
+ - lib/resugan/kernel.rb
89
+ - lib/resugan/object.rb
90
+ - lib/resugan/object_helpers.rb
91
+ - lib/resugan/thread.rb
92
+ - lib/resugan/version.rb
93
+ - resugan.gemspec
94
+ homepage: https://github.com/jedld/resugan
95
+ licenses:
96
+ - MIT
97
+ metadata:
98
+ allowed_push_host: https://rubygems.org
99
+ post_install_message:
100
+ rdoc_options: []
101
+ require_paths:
102
+ - lib
103
+ required_ruby_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ requirements: []
114
+ rubyforge_project:
115
+ rubygems_version: 2.5.1
116
+ signing_key:
117
+ specification_version: 4
118
+ summary: simple, powerful and unobstrusive observer pattern framework for ruby
119
+ test_files: []