dont 0.1.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: 8df12a0318bc20065d835a2140936de4a303b0b1
4
+ data.tar.gz: 4ce2cae8395f12d253c9de429316a1ba60daeb2b
5
+ SHA512:
6
+ metadata.gz: 24da3afc49cf4a355be86e2b716165d413164597a38650de4fdd4befb9684a608875bff42b6f9de5e44ffc46c50b18b0bacb91c5818e0fde74908551c34c25cb
7
+ data.tar.gz: c2deede14c9f51997d34021a5b3885566f59a7e475e6944e14c474542e12b2ce342c43cecaf2a7a5ea9f944191a17623062b0b569d91cf71bb453630137cbe8a
@@ -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,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.13.6
@@ -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 maartencls@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 dont.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Maarten Claes
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,75 @@
1
+ # Dont
2
+
3
+ Easily deprecate methods.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'dont'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install dont
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ # Register custom handlers
25
+ #
26
+ Dont.register_handler(:logger, ->(object, method) {
27
+ class_name = object.class.name
28
+ logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
29
+ })
30
+ class Shouter
31
+ include Dont.new(:logger)
32
+
33
+ def shout(msg)
34
+ msg.upcase
35
+ end
36
+
37
+ def scream(msg)
38
+ shout(msg)
39
+ end
40
+ dont_use :scream
41
+ end
42
+
43
+ # This will log "Don't use `Shouter#scream`. It's deprecated.", and then
44
+ # execute the method.
45
+ Shouter.new.scream("hello")
46
+ # => HELLO
47
+
48
+ # There's also a builtin "exception" handler, which is handy for in development
49
+ class Person
50
+ include Dont.new(:exception)
51
+
52
+ attr_accessor :firstname
53
+ attr_accessor :first_name
54
+
55
+ dont_use :firstname
56
+ end
57
+
58
+ Person.new.firstname # => Dont::DeprecationError
59
+ ```
60
+
61
+ ## Development
62
+
63
+ 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.
64
+
65
+ 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).
66
+
67
+ ## Contributing
68
+
69
+ Bug reports and pull requests are welcome on GitHub at https://github.com/datacamp/dont. 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.
70
+
71
+
72
+ ## License
73
+
74
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
75
+
@@ -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 "dont"
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,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
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dont/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dont"
8
+ spec.version = Dont::VERSION
9
+ spec.authors = ["Maarten Claes"]
10
+ spec.email = ["maartencls@gmail.com"]
11
+
12
+ spec.summary = %q{Mark methods as deprecated}
13
+ spec.description = %q{Mark methods as deprecated}
14
+ spec.homepage = "https://github.com/datacamp/dont"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "dry-container", ">= 0.6"
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.13"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec", "~> 3.0"
29
+ end
@@ -0,0 +1,99 @@
1
+ require "dont/version"
2
+ require "dry-container"
3
+
4
+ # Defines a `dont_use` method which can be used to deprecate methods. Whenever
5
+ # the deprecated method is used the specified handler will get triggered.
6
+ #
7
+ # @example
8
+ #
9
+ # class Person
10
+ # include Dont.new(:exception)
11
+ #
12
+ # attr_accessor :firstname
13
+ # attr_accessor :first_name
14
+ #
15
+ # dont_use :firstname
16
+ # end
17
+ #
18
+ # Person.new.firstname # => Dont::DeprecationError
19
+ #
20
+ # # Register custom handlers
21
+ # Dont.register_handler(:logger, ->(object, method) {
22
+ # class_name = object.class.name
23
+ # logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
24
+ # })
25
+ # class Shouter
26
+ # include Dont.new(:logger)
27
+ #
28
+ # def shout(msg)
29
+ # msg.upcase
30
+ # end
31
+ #
32
+ # def scream(msg)
33
+ # shout(msg)
34
+ # end
35
+ # dont_use :scream
36
+ # end
37
+ #
38
+ # # This will log "Don't use `Shouter#scream`. It's deprecated.", and then
39
+ # # execute the method.
40
+ # Shouter.new.scream("hello")
41
+ # # => HELLO
42
+ #
43
+ #
44
+ class Dont < Module
45
+ Error = Class.new(StandardError)
46
+ DeprecationError = Class.new(Error)
47
+ MissingHandlerError = Class.new(Error)
48
+ WrongArityError = Class.new(Error)
49
+
50
+ HANDLERS = {
51
+ exception: -> (object, method) {
52
+ class_name = object.class.name
53
+ fail DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
54
+ },
55
+ airbrake: -> (object, method) {
56
+ class_name = object.class.name
57
+ err = DeprecationError.new("Don't use `#{class_name}##{method}`. It's deprecated.")
58
+ Airbrake.notify(err)
59
+ },
60
+ }
61
+
62
+ def initialize(key)
63
+ handler = Dont.fetch_handler(key)
64
+ @implementation = ->(method) {
65
+ old_method = instance_method(method)
66
+ define_method(method) do |*args|
67
+ handler.call(self, method)
68
+ old_method.bind(self).call(*args)
69
+ end
70
+ }
71
+ end
72
+
73
+ def included(base)
74
+ base.instance_exec(@implementation) do |impl|
75
+ define_singleton_method(:dont_use, &impl)
76
+ end
77
+ end
78
+
79
+ class << self
80
+ def handlers
81
+ @handlers ||= Dry::Container.new
82
+ end
83
+
84
+ def register_handler(key, callable)
85
+ handlers.register(key, callable)
86
+ end
87
+
88
+ def fetch_handler(key)
89
+ self.handlers.resolve(key)
90
+ rescue Dry::Container::Error => e
91
+ fail MissingHandlerError, e.message
92
+ end
93
+ end
94
+
95
+ register_handler(:exception, -> (object, method) {
96
+ class_name = object.class.name
97
+ fail Dont::DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
98
+ })
99
+ end
@@ -0,0 +1,3 @@
1
+ class Dont < Module
2
+ VERSION = "0.1.0".freeze
3
+ end
metadata ADDED
@@ -0,0 +1,113 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dont
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Maarten Claes
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: dry-container
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0.6'
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.13'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.13'
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: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Mark methods as deprecated
70
+ email:
71
+ - maartencls@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
+ - dont.gemspec
87
+ - lib/dont.rb
88
+ - lib/dont/version.rb
89
+ homepage: https://github.com/datacamp/dont
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.5.2
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: Mark methods as deprecated
113
+ test_files: []