dont 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8df12a0318bc20065d835a2140936de4a303b0b1
+  data.tar.gz: 4ce2cae8395f12d253c9de429316a1ba60daeb2b
+SHA512:
+  metadata.gz: 24da3afc49cf4a355be86e2b716165d413164597a38650de4fdd4befb9684a608875bff42b6f9de5e44ffc46c50b18b0bacb91c5818e0fde74908551c34c25cb
+  data.tar.gz: c2deede14c9f51997d34021a5b3885566f59a7e475e6944e14c474542e12b2ce342c43cecaf2a7a5ea9f944191a17623062b0b569d91cf71bb453630137cbe8a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at maartencls@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dont.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maarten Claes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Dont
+
+Easily deprecate methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dont'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dont
+
+## Usage
+
+```ruby
+# Register custom handlers
+#
+Dont.register_handler(:logger, ->(object, method) {
+  class_name = object.class.name
+  logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
+})
+class Shouter
+  include Dont.new(:logger)
+
+  def shout(msg)
+    msg.upcase
+  end
+
+  def scream(msg)
+    shout(msg)
+  end
+  dont_use :scream
+end
+
+# This will log "Don't use `Shouter#scream`. It's deprecated.", and then
+# execute the method.
+Shouter.new.scream("hello")
+# => HELLO
+
+# There's also a builtin "exception" handler, which is handy for in development
+class Person
+  include Dont.new(:exception)
+
+  attr_accessor :firstname
+  attr_accessor :first_name
+
+  dont_use :firstname
+end
+
+Person.new.firstname # => Dont::DeprecationError
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dont"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dont.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dont/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dont"
+  spec.version       = Dont::VERSION
+  spec.authors       = ["Maarten Claes"]
+  spec.email         = ["maartencls@gmail.com"]
+
+  spec.summary       = %q{Mark methods as deprecated}
+  spec.description   = %q{Mark methods as deprecated}
+  spec.homepage      = "https://github.com/datacamp/dont"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-container", ">= 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dont.rb

@@ -0,0 +1,99 @@
+require "dont/version"
+require "dry-container"
+
+# Defines a `dont_use` method which can be used to deprecate methods.  Whenever
+# the deprecated method is used the specified handler will get triggered.
+#
+# @example
+#
+#     class Person
+#       include Dont.new(:exception)
+#
+#       attr_accessor :firstname
+#       attr_accessor :first_name
+#
+#       dont_use :firstname
+#     end
+#
+#     Person.new.firstname # => Dont::DeprecationError
+#
+#     # Register custom handlers
+#     Dont.register_handler(:logger, ->(object, method) {
+#       class_name = object.class.name
+#       logger.warn("Don't use `#{class_name}##{method}`. It's deprecated.")
+#     })
+#     class Shouter
+#       include Dont.new(:logger)
+#
+#       def shout(msg)
+#         msg.upcase
+#       end
+#
+#       def scream(msg)
+#         shout(msg)
+#       end
+#       dont_use :scream
+#     end
+#
+#     # This will log "Don't use `Shouter#scream`. It's deprecated.", and then
+#     # execute the method.
+#     Shouter.new.scream("hello")
+#     # => HELLO
+#
+#
+class Dont < Module
+  Error = Class.new(StandardError)
+  DeprecationError = Class.new(Error)
+  MissingHandlerError = Class.new(Error)
+  WrongArityError = Class.new(Error)
+
+  HANDLERS = {
+    exception: -> (object, method) {
+      class_name = object.class.name
+      fail DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
+    },
+    airbrake: -> (object, method) {
+      class_name = object.class.name
+      err = DeprecationError.new("Don't use `#{class_name}##{method}`. It's deprecated.")
+      Airbrake.notify(err)
+    },
+  }
+
+  def initialize(key)
+    handler = Dont.fetch_handler(key)
+    @implementation = ->(method) {
+      old_method = instance_method(method)
+      define_method(method) do |*args|
+        handler.call(self, method)
+        old_method.bind(self).call(*args)
+      end
+    }
+  end
+
+  def included(base)
+    base.instance_exec(@implementation) do |impl|
+      define_singleton_method(:dont_use, &impl)
+    end
+  end
+
+  class << self
+    def handlers
+      @handlers ||= Dry::Container.new
+    end
+
+    def register_handler(key, callable)
+      handlers.register(key, callable)
+    end
+
+    def fetch_handler(key)
+      self.handlers.resolve(key)
+    rescue Dry::Container::Error => e
+      fail MissingHandlerError, e.message
+    end
+  end
+
+  register_handler(:exception, -> (object, method) {
+    class_name = object.class.name
+    fail Dont::DeprecationError, "Don't use `#{class_name}##{method}`. It's deprecated."
+  })
+end

data/lib/dont/version.rb

@@ -0,0 +1,3 @@
+class Dont < Module
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: dont
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maarten Claes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Mark methods as deprecated
+email:
+- maartencls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dont.gemspec
+- lib/dont.rb
+- lib/dont/version.rb
+homepage: https://github.com/datacamp/dont
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Mark methods as deprecated
+test_files: []