deprecator 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Vasily Fedoseyev
+
+MIT License
+
+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,33 @@
+# Deprecator
+
+Yet another library for dealing with code deprecation in ruby gracefully.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deprecator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deprecator
+
+## Usage
+
+```ruby
+
+
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+
+# require 'rake/extensiontask'
+# Rake::ExtensionTask.new('deprecator')
+# task :test => :compile
+
+task :default => :test

data/deprecator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deprecator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deprecator"
+  spec.version       = Deprecator::VERSION
+  spec.authors       = ["Vasily Fedoseyev"]
+  spec.email         = ["vasilyfedoseyev@gmail.com"]
+  spec.description   = %q{Yet another library for dealing with code deprecation in ruby}
+  spec.summary       = %q{Adds some beauty and structure to code deprecation, see readme}
+  spec.homepage      = "http://github.com/Vasfed/deprecator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.1'
+  spec.add_dependency "is_a", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/deprecator.rb

@@ -0,0 +1,107 @@
+require "deprecator/version"
+require "deprecator/strategy"
+require 'is_a'
+
+module Deprecator
+
+  class DeprecatedClass
+    def self.inherited cls
+      cls.extend(Deprecated)
+    end
+  end
+
+  module Deprecated
+    def self.included cls
+      cls.extend self
+    end
+
+    def self.extended cls
+      ::Deprecator.strategy.class_found(cls, caller_line)
+      cls.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      # SMELL: initialize in module is no good, but in this case may help for some cases
+      def initialize *args
+        ::Deprecator.strategy.object_found(self, caller_line)
+      end
+    end
+    Class = DeprecatedClass
+  end
+
+
+  module ClassClassMethods
+    def deprecated reason=nil, *args
+      ::Deprecator.strategy.class_found(self, caller_line, reason, args)
+    end
+
+    def __on_next_method &blk
+      @method_added_stack ||= []
+      if self.respond_to?(:method_added) || @method_added_stack.size > 0
+        m = self.method(:method_added)
+        @method_added_stack.push(m)
+      end
+
+      define_singleton_method(:method_added, ->(name){
+        return if name == :method_added
+        super(name)
+        old = @method_added_stack.pop
+        if old
+          define_singleton_method(:method_added, old)
+        else
+          class <<self; remove_method(:method_added); end
+        end
+        blk.call(name)
+      })
+    end
+
+    def deprecated_method name=nil, reason=nil, &blk
+      where = caller_line
+      unless reason
+        if !name || name.is_a?(String)
+          reason = name
+          name = nil
+          # => take next defined method
+          __on_next_method {|name|
+            Deprecator.strategy.method_found(self, name, reason, where)
+          }
+          return
+        end
+      end
+
+      name = [name] unless name.is_a?(Array)
+      name.each{|n|
+        Deprecator.strategy.method_found(self, n, reason, where)
+      }
+    end
+  end
+
+  DefaultStrategy = Strategy::Warning
+
+  class UnknownStrategy < ArgumentError; end
+  class NotImplemented < RuntimeError; end
+
+  @@strategy = nil
+  def self.strategy
+    @@strategy ||= DefaultStrategy.new
+  end
+
+  def self.strategy= s
+    case s
+    when Class then return(@@strategy = s.new)
+    when Symbol then
+      capitalized = s.capitalize
+      if Strategy.const_defined?(capitalized)
+        self.strategy = Strategy.const_get(capitalized)
+      else
+        raise UnknownStrategy, s
+      end
+    else
+      @@strategy = s
+    end
+  end
+end
+
+
+
+require "deprecator/core_ext"

data/lib/deprecator/core_ext.rb

@@ -0,0 +1,26 @@
+# everything that goes outside of Deprecator namespace - goes here
+
+class Module
+  include Deprecator::ClassClassMethods
+end
+
+class Class
+  include Deprecator::ClassClassMethods
+end
+
+module Kernel
+  def deprecated reason=nil, *args
+    Deprecator.strategy.deprecated(reason, caller_line, args)
+  end
+  alias DEPRECATED deprecated
+
+  [:fixme!, :todo!, :not_implemented].each{|method|
+    define_method(method){|msg=nil, *args| Deprecator.strategy.send(method, msg, caller_line, args) }
+  }
+  alias FIXME fixme!
+  alias TODO todo!
+  alias NOT_IMPLEMENTED not_implemented
+end
+
+DEPRECATED = Deprecator::Deprecated
+Deprecated = DEPRECATED unless Object.const_defined?(:Deprecated)

data/lib/deprecator/strategy.rb

@@ -0,0 +1,59 @@
+module Deprecator
+  module Strategy
+
+
+    class Base
+      def class_found o, where=nil, reason=nil, args=nil
+        # msg(if reason
+        #   reason.gsub(/%{cls}/, o)
+        # else
+        #   "#{o} is deprecated!"
+        # end, where)
+      end
+      def method_found cls,name, reason, where=nil
+        this = self
+        unless cls.method_defined?(name) # also we may place stubs there for existing methods in other strategies
+          cls.send :define_method, name, ->(*args){
+            this.method_called cls,name,reason,caller_line,where
+          }
+        else
+          method = cls.instance_method(name)
+          cls.send :define_method, name, ->(*args){
+            this.method_called cls,name,reason,caller_line,where
+            method.bind(self).call(*args)
+          }
+        end
+      end
+      def fixme! msg, where, args; end
+      def todo! msg, where, args; end
+      def not_implemented msg, where, args
+        raise NotImplemented, "method at #{where} called from #{caller_line(2)}"
+      end
+    end
+
+    class Warning < Base
+      def msg msg, where=nil
+        warn "[DEPRECATED] #{msg}"
+      end
+
+      def object_found o, where=nil, reason=nil # deprecated class initialize
+        msg "deprecated class #{o.class} instantiated", where
+      end
+
+      # this is not entry point
+      def method_called cls,name,reason=nil,where,defined_at
+        msg "method #{name} is deprecated. Called from #{caller_line}"
+      end
+
+      def deprecated reason=nil, where=caller_line, args=nil
+        where =~ /in `(.+)'$/
+        method_name = $1 || '<unknown>'
+        reason ||= "%{method} is deprecated!"
+        reason.gsub!('%{method}', method_name)
+        msg reason, where
+      end
+    end
+
+
+  end
+end

data/lib/deprecator/version.rb

@@ -0,0 +1,3 @@
+module Deprecator
+  VERSION = "0.0.2"
+end

data/spec/deprecator_spec.rb

@@ -0,0 +1,96 @@
+require 'rspec/autorun'
+require 'deprecator'
+
+describe Deprecator do
+  subject{ Deprecator }
+
+  context "deprecation marking of" do
+
+    context "classes" do
+      before{
+        class DummyStrategy; end
+        subject.strategy = DummyStrategy
+      }
+      it "via inheriting" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Class), duck_type(:to_s))
+        Class.new(DEPRECATED::Class)
+      end
+      it "via extending" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Class), duck_type(:to_s))
+        Class.new{ extend DEPRECATED }
+      end
+      it "via including" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Class), duck_type(:to_s))
+        Class.new{ include DEPRECATED }
+      end
+      it "via call to deprecated" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Class), duck_type(:to_s), "abc", [])
+        Class.new{ deprecated "abc" }
+      end
+    end
+
+    context "modules" do
+      it "via extending" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Module), duck_type(:to_s))
+        Module.new{ extend DEPRECATED }
+      end
+      it "via including" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Module), duck_type(:to_s))
+        Module.new{ include DEPRECATED }
+      end
+      it "via call to deprecated" do
+        subject.strategy.should_receive(:class_found).with(kind_of(Module), duck_type(:to_s), "abc", [])
+        Module.new{ deprecated "abc" }
+      end
+    end
+
+    context "methods" do
+      before{
+        subject.strategy = :warning
+      }
+      it "simple" do
+        subject.strategy.should_receive(:deprecated).with("reason", duck_type(:to_s), [])
+        deprecated "reason"
+      end
+
+      it "marking in class" do
+        cls = Class.new{
+          deprecated_method "reason"
+          def meth; end
+          }
+        subject.strategy.should_receive(:method_called).with(cls, :meth, "reason", /#{Regexp.escape __FILE__}:#{__LINE__+1}/, /#{Regexp.escape __FILE__}:#{__LINE__-3}/)
+        cls.new.meth
+      end
+
+      it "deprecation by name defines method" do
+        cls = Class.new{
+          deprecated_method :meth, "reason"
+          }
+        subject.strategy.should_receive(:method_called).with(cls, :meth, "reason", /#{Regexp.escape __FILE__}:#{__LINE__+1}/, /#{Regexp.escape __FILE__}:#{__LINE__-2}/)
+        cls.new.meth
+      end
+    end
+  end
+
+  context "strategy" do
+    context "set" do
+      it "via object" do
+        obj = Object.new
+        subject.strategy = obj
+        subject.strategy.should == obj
+      end
+      it "via class" do
+        cls = Class.new
+        subject.strategy = cls
+        subject.strategy.should be_a cls
+      end
+      it "by symbolic name" do
+        subject.strategy = :warning
+        subject.strategy.should be_a(Deprecator::Strategy::Warning)
+      end
+      it "raises on wrong strategy name" do
+        expect{ subject.strategy = :no_such_strategy }.to raise_error(Deprecator::UnknownStrategy)
+      end
+    end
+  end
+end

data/spec/strategy/warning_spec.rb

@@ -0,0 +1,18 @@
+require 'rspec/autorun'
+require 'deprecator'
+
+describe Deprecator::Strategy::Warning do
+  before{
+    Deprecator.strategy = subject
+  }
+  it "calls warn" do
+    subject.should_receive(:warn).with("[DEPRECATED] block (2 levels) in <top (required)> is deprecated!")
+    subject.deprecated
+  end
+
+  it "raises on not implemented" do
+    expect {
+      not_implemented
+    }.to raise_error(Deprecator::NotImplemented)
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: deprecator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Vasily Fedoseyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: is_a
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Yet another library for dealing with code deprecation in ruby
+email:
+- vasilyfedoseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deprecator.gemspec
+- lib/deprecator.rb
+- lib/deprecator/core_ext.rb
+- lib/deprecator/strategy.rb
+- lib/deprecator/version.rb
+- spec/deprecator_spec.rb
+- spec/strategy/warning_spec.rb
+homepage: http://github.com/Vasfed/deprecator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2851817988265802731
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds some beauty and structure to code deprecation, see readme
+test_files:
+- spec/deprecator_spec.rb
+- spec/strategy/warning_spec.rb