tzispa_annotations 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +4 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/LICENSE.txt +21 -0
- data/README.md +43 -0
- data/lib/tzispa/annotations/annotation.rb +41 -0
- data/lib/tzispa/annotations/annotations.rb +43 -0
- data/lib/tzispa/annotations/builtin.rb +14 -0
- data/lib/tzispa/annotations/builtin/async.rb +13 -0
- data/lib/tzispa/annotations/builtin/deprecation.rb +18 -0
- data/lib/tzispa/annotations/builtin/error_trap.rb +21 -0
- data/lib/tzispa/annotations/builtin/lazy.rb +24 -0
- data/lib/tzispa/annotations/builtin/memoize.rb +19 -0
- data/lib/tzispa/annotations/builtin/retry.rb +24 -0
- data/lib/tzispa/annotations/version.rb +7 -0
- data/lib/tzispa_annotations.rb +9 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 50a8e496975df15c0d459385cca0ab03c334604e
|
4
|
+
data.tar.gz: 4f19279aa208f5634668eba5d73b2af7cfa9de30
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ecc81c29adc662093eaf3253983ffaa9dbe9a3eb0d3db1b7a5aa7870fc072b499772026e6da6662b79cc7cc71d09e9ca897b8a11f588b0f37e5cae6e58b86479
|
7
|
+
data.tar.gz: 4dd33b58ba578e94fc2ce380ac11dae732b97c91b4a121dcf1b6c5da2955217f15c5483c9e6791ce63eb9f534a606167c42ec90dfda57bb55de965aa285ed3ac
|
data/CHANGELOG.md
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -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 japinero@area-integral.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/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Juan Antonio Piñero
|
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,43 @@
|
|
1
|
+
# TzispaAnnotation
|
2
|
+
|
3
|
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tzispa_annotation`. To experiment with that code, run `bin/console` for an interactive prompt.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'tzispa_annotation'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install tzispa_annotation
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
30
|
+
|
31
|
+
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).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tzispa_annotation. 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.
|
36
|
+
|
37
|
+
## License
|
38
|
+
|
39
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
40
|
+
|
41
|
+
## Code of Conduct
|
42
|
+
|
43
|
+
Everyone interacting in the TzispaAnnotation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tzispa_annotation/blob/master/CODE_OF_CONDUCT.md).
|
@@ -0,0 +1,41 @@
|
|
1
|
+
module Tzispa
|
2
|
+
class Annotation
|
3
|
+
attr_accessor :context
|
4
|
+
|
5
|
+
@@annmutext = Mutex.new
|
6
|
+
|
7
|
+
def +@
|
8
|
+
self.class.synchronize do
|
9
|
+
self.class.annotations << self
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
class << self
|
14
|
+
# rubocop:disable Style/ClassVars
|
15
|
+
def annotations
|
16
|
+
return __annotations_container if @@annmutext.locked?
|
17
|
+
synchronize do
|
18
|
+
__annotations_container
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
def +@
|
23
|
+
+new
|
24
|
+
end
|
25
|
+
|
26
|
+
def current_annotations
|
27
|
+
annotations.pop annotations.size
|
28
|
+
end
|
29
|
+
|
30
|
+
def synchronize
|
31
|
+
@@annmutext.synchronize { yield }
|
32
|
+
end
|
33
|
+
|
34
|
+
private
|
35
|
+
|
36
|
+
def __annotations_container
|
37
|
+
@@current_annotations ||= []
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
require_relative 'annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
def __annotatated_visibility(name)
|
6
|
+
if protected_method_defined? name
|
7
|
+
protected name
|
8
|
+
elsif private_method_defined? name
|
9
|
+
private name
|
10
|
+
else
|
11
|
+
public name
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
def method_added(name)
|
16
|
+
super
|
17
|
+
annotations = Tzispa::Annotation.current_annotations
|
18
|
+
return if annotations.empty?
|
19
|
+
annotations.each do |annotation|
|
20
|
+
original_method = instance_method(name)
|
21
|
+
define_method(name) do |*args, &block|
|
22
|
+
annotation.context = self
|
23
|
+
super_method = original_method.bind(self)
|
24
|
+
annotation.call(super_method, *args, &block)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
__annotatated_visibility name
|
28
|
+
end
|
29
|
+
|
30
|
+
def singleton_method_added(name)
|
31
|
+
super
|
32
|
+
annotations = Tzispa::Annotation.current_annotations
|
33
|
+
return if annotations.empty?
|
34
|
+
annotations.each do |annotation|
|
35
|
+
original_method = method(name)
|
36
|
+
define_singleton_method(name) do |*args, &block|
|
37
|
+
annotation.context = self
|
38
|
+
annotation.call(original_method, *args, &block)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
module Tzispa
|
2
|
+
module Annotations
|
3
|
+
module Builtin
|
4
|
+
|
5
|
+
autoload :Deprecation, 'tzispa/annotations/builtin/deprecation'
|
6
|
+
autoload :ErrorTrap, 'tzispa/annotations/builtin/error_trap'
|
7
|
+
autoload :Lazy, 'tzispa/annotations/builtin/lazy'
|
8
|
+
autoload :Memoize, 'tzispa/annotations/builtin/memoize'
|
9
|
+
autoload :Memoize, 'tzispa/annotations/builtin/retry'
|
10
|
+
autoload :Async, 'tzispa/annotations/builtin/async'
|
11
|
+
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
require_relative '../annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
module Builtin
|
6
|
+
class Deprecation < Annotation
|
7
|
+
def initialize(new_name)
|
8
|
+
@new_name = new_name
|
9
|
+
end
|
10
|
+
|
11
|
+
def call(method, *args, &block)
|
12
|
+
warn "Method `#{method.name}` is deprecated. Use `#{@new_name}` instead."
|
13
|
+
method.call(*args, &block)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
require_relative '../annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
module Builtin
|
6
|
+
class ErrorTrap < Annotation
|
7
|
+
def initialize(logger = nil, &block)
|
8
|
+
@logger = logger
|
9
|
+
@err_block = block
|
10
|
+
end
|
11
|
+
|
12
|
+
def call(method, *args, &block)
|
13
|
+
method.call(*args, &block)
|
14
|
+
rescue StandardError => err
|
15
|
+
context.send(@logger, err) if @logger
|
16
|
+
context.instance_eval(&@err_block) if @err_block
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require_relative '../annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
module Builtin
|
6
|
+
class Lazy < Annotation
|
7
|
+
class Proxy < BasicObject
|
8
|
+
def initialize(&block)
|
9
|
+
@block = block
|
10
|
+
end
|
11
|
+
|
12
|
+
def method_missing(name, *args, &block)
|
13
|
+
@result ||= @block.call
|
14
|
+
@result.send name, *args, &block
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
def call(method, *args, &block)
|
19
|
+
Proxy.new { method.call(*args, &block) }
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require_relative '../annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
module Builtin
|
6
|
+
class Memoize < Annotation
|
7
|
+
def initialize
|
8
|
+
@cache ||= {}
|
9
|
+
end
|
10
|
+
|
11
|
+
def call(method, *args, &block)
|
12
|
+
current_cache = @cache[method.receiver] ||= {}
|
13
|
+
return current_cache[args] if current_cache.key? args
|
14
|
+
current_cache[args] = method.call(*args, &block)
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require_relative '../annotation'
|
2
|
+
|
3
|
+
module Tzispa
|
4
|
+
module Annotations
|
5
|
+
module Builtin
|
6
|
+
class Retry < Annotation
|
7
|
+
def initialize(t = 3)
|
8
|
+
@times = t
|
9
|
+
end
|
10
|
+
|
11
|
+
def call(method, *args, &block)
|
12
|
+
tries = 0
|
13
|
+
begin
|
14
|
+
tries += 1
|
15
|
+
method.call(*args, &block)
|
16
|
+
rescue StandardError
|
17
|
+
retry if tries < @times
|
18
|
+
raise
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: tzispa_annotations
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Juan Antonio Piñero
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-10-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.15'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.15'
|
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
|
+
description:
|
42
|
+
email:
|
43
|
+
- japinero@area-integral.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- CHANGELOG.md
|
49
|
+
- CODE_OF_CONDUCT.md
|
50
|
+
- LICENSE.txt
|
51
|
+
- README.md
|
52
|
+
- lib/tzispa/annotations/annotation.rb
|
53
|
+
- lib/tzispa/annotations/annotations.rb
|
54
|
+
- lib/tzispa/annotations/builtin.rb
|
55
|
+
- lib/tzispa/annotations/builtin/async.rb
|
56
|
+
- lib/tzispa/annotations/builtin/deprecation.rb
|
57
|
+
- lib/tzispa/annotations/builtin/error_trap.rb
|
58
|
+
- lib/tzispa/annotations/builtin/lazy.rb
|
59
|
+
- lib/tzispa/annotations/builtin/memoize.rb
|
60
|
+
- lib/tzispa/annotations/builtin/retry.rb
|
61
|
+
- lib/tzispa/annotations/version.rb
|
62
|
+
- lib/tzispa_annotations.rb
|
63
|
+
homepage: https://github.com/japiber/tzispa_annotations
|
64
|
+
licenses:
|
65
|
+
- MIT
|
66
|
+
metadata: {}
|
67
|
+
post_install_message:
|
68
|
+
rdoc_options: []
|
69
|
+
require_paths:
|
70
|
+
- lib
|
71
|
+
- test
|
72
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
requirements: []
|
83
|
+
rubyforge_project:
|
84
|
+
rubygems_version: 2.6.13
|
85
|
+
signing_key:
|
86
|
+
specification_version: 4
|
87
|
+
summary: methods annotation in ruby
|
88
|
+
test_files: []
|