enumerable_observer 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 9ac752dcc1e203df3fdd563769a3e9a3a0cee301
4
+ data.tar.gz: a8bf01bf3c2c2e898c62ac258e42ccd1b31bb34d
5
+ SHA512:
6
+ metadata.gz: 6dc4606ac9821a284960fac90eaa720e926206870dc93eb030704a9e01ab50f349d8536be37448a7abbeadfbdb3763008cb4127c5e377c40bd6067a3740faceb
7
+ data.tar.gz: 63f1128aa9bc5986b4c7872ac2feeed7f451cfc606c9dce05690b245d046a2bd54aa455c708918cacfdad8b150f956c0de704f6a400e912032441ce61d2a9ab9
@@ -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
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in enumerable_observer.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Jason Waldrip
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,84 @@
1
+ # EnumerableObserver
2
+
3
+ Observe changes in enumerable objects in ruby and run callbacks when items are
4
+ added or removed.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'enumerable_observer'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install enumerable_observer
21
+
22
+ ## Usage
23
+
24
+ Use as a module
25
+
26
+ ```ruby
27
+ class MyClass
28
+ include EnumerableObserver
29
+
30
+ def initialize
31
+ @my_array = []
32
+ observer = observe(@my_array)
33
+
34
+ observer.added do |items|
35
+ puts "items added: #{items}"
36
+ end
37
+
38
+ observer.removed do |items
39
+ puts "items removed: #{items}"
40
+ end
41
+ end
42
+ end
43
+ ```
44
+
45
+ ...or directly
46
+
47
+ ```ruby
48
+ class MyClass
49
+ def initialize
50
+ @my_array = []
51
+ observer = EnumerableObserver.observe(@my_array)
52
+
53
+ observer.added do |items|
54
+ puts "items added: #{items}"
55
+ end
56
+
57
+ observer.removed do |items
58
+ puts "items removed: #{items}"
59
+ end
60
+ end
61
+ end
62
+ ```
63
+
64
+ ...or by extending, and in one line.
65
+
66
+ ```ruby
67
+ @my_array.extend(EnumerableObserver).observe.added { |items| puts "items added: #{items}" }.removed { |items| puts "items removed: #{items}" }
68
+ ```
69
+
70
+ ## Development
71
+
72
+ 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.
73
+
74
+ 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).
75
+
76
+ ## Contributing
77
+
78
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enumerable_observer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
79
+
80
+
81
+ ## License
82
+
83
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
84
+
@@ -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 "enumerable_observer"
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
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'enumerable_observer/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "enumerable_observer"
8
+ spec.version = EnumerableObserver::VERSION
9
+ spec.authors = ["Jason Waldrip"]
10
+ spec.email = ["jason@waldrip.net"]
11
+
12
+ spec.summary = %q{Observe changes in enumerable objects in ruby and run callbacks when items are
13
+ added or removed.}
14
+ spec.homepage = "https://github.com/jwaldrip/enumerable_observer"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
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_dependency "unstrict_proc"
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.10"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec"
27
+ end
@@ -0,0 +1,90 @@
1
+ require 'enumerable_observer/version'
2
+ require 'unstrict_proc'
3
+
4
+ module EnumerableObserver
5
+ using UnstrictProc
6
+
7
+ def self.observe(obj)
8
+ Observer.new(obj)
9
+ end
10
+
11
+ def observe(obj = self)
12
+ Observer.new(obj)
13
+ end
14
+
15
+ class Observer
16
+ using UnstrictProc
17
+
18
+ UNSAFE_METHODS = %i{
19
+ instance_variable_set
20
+ remove_instance_variable
21
+ define_singleton_method
22
+ instance_eval
23
+ instance_exec
24
+ }
25
+ SAFE_METHODS = (%i{each} + Object.instance_methods) - UNSAFE_METHODS
26
+
27
+ private def observer_method_proc(existing = [])
28
+ array = [self, *existing].freeze
29
+ lambda do
30
+ array
31
+ end
32
+ end
33
+
34
+ def initialize(obj)
35
+ @object = obj
36
+ observers_proc =
37
+ observer_method_proc(obj.respond_to?(:observers) ? obj.observers : [])
38
+ obj.define_singleton_method(:observers, &observers_proc)
39
+ obj.extend mod
40
+ end
41
+
42
+ def mod
43
+ @mod ||= begin
44
+ obj = @object
45
+ blocks = self.blocks
46
+ Module.new do
47
+ (obj.methods - SAFE_METHODS).each do |meth|
48
+ old = obj.method(meth).unbind.bind(obj)
49
+ define_method(meth) do |*args, &block|
50
+ before = each.to_a
51
+ val = old.call(*args, &block)
52
+ after = each.to_a
53
+ added = after - before
54
+ removed = before - after
55
+ blocks[:add].unstrict.call(added) unless added.empty? || !blocks[:add]
56
+ blocks[:remove].unstrict.call(removed) unless removed.empty? || !blocks[:remove]
57
+ val
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
63
+
64
+ def unobserve
65
+ mod.instance_methods.each do |method_name|
66
+ mod.module_eval do
67
+ remove_method method_name
68
+ end
69
+ end
70
+ @unobserved = true
71
+ end
72
+
73
+ def added(&block)
74
+ blocks[:add] = block
75
+ self
76
+ end
77
+
78
+ def removed(&block)
79
+ blocks[:remove] = block
80
+ self
81
+ end
82
+
83
+ protected
84
+
85
+ def blocks
86
+ @blocks ||= {}
87
+ end
88
+
89
+ end
90
+ end
@@ -0,0 +1,3 @@
1
+ module EnumerableObserver
2
+ VERSION = "1.0.0"
3
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: enumerable_observer
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Jason Waldrip
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-12-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: unstrict_proc
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
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.10'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.10'
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: '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
+ - jason@waldrip.net
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
+ - enumerable_observer.gemspec
87
+ - lib/enumerable_observer.rb
88
+ - lib/enumerable_observer/version.rb
89
+ homepage: https://github.com/jwaldrip/enumerable_observer
90
+ licenses:
91
+ - MIT
92
+ metadata: {}
93
+ post_install_message:
94
+ rdoc_options: []
95
+ require_paths:
96
+ - lib
97
+ required_ruby_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ required_rubygems_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ requirements: []
108
+ rubyforge_project:
109
+ rubygems_version: 2.4.8
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: Observe changes in enumerable objects in ruby and run callbacks when items
113
+ are added or removed.
114
+ test_files: []