tinymethodwrapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4730cdae2ca1ef4a23c6a8c455a5ce40a621b45d
+  data.tar.gz: c9686bd411b0eed1fb35e6558e479bcb56900819
+SHA512:
+  metadata.gz: 0f3f1766609867cdfdb652a02234a09e42e98bd045265d46bc9f6804b4d4497f1a8feea5c6db9c38a82f25aa6ec76c0205c00e43aa269b4d81c26dc9c8e3787f
+  data.tar.gz: 3590033bef0a7c86f9200db543dc0e3c940d0f243ac737550f1aa7b061b5eb471b4181c7761f92e7a3c443f5097613f0b06ee84f67b966f188b0c3073a81cbbb

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Hendrik Kleinwaechter
+
+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,55 @@
+# Tinymethodwrapper
+
+A small gem (22 lines of code) that allows you to wrap methods with a custom
+call of another method.  Really useful for performing logging or other
+options. We use this to log deprecated methods when doing large codebase
+changes.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tinymethodwrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tinymethodwrapper
+
+## Usage
+
+    class User
+      include Tinymethodwrapper
+
+      def godzilla_rocks
+        "yes"
+      end
+
+      def say_hi_to_name(name)
+        name
+      end
+
+      wrap_methods %i[godzilla_rocks say_hi_to_name],
+        -> (method_name) { Rails.logger.info "#{method_name} was just called" }
+    end
+
+    user = User.new
+    user.godzilla_rocks
+    #=> "yes"
+
+    user.say_hi_to_name("hendrik")
+    #=> "hendrik"
+
+    #=> check the log fle, two logs were added
+
+## Contributing
+
+1. Fork it ( https://github.com/ZEITIO/tinymethodwrapper/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/lib/tinymethodwrapper.rb

@@ -0,0 +1,22 @@
+require "tinymethodwrapper/version"
+require 'active_support'
+require 'active_support/version'
+
+
+module Tinymethodwrapper
+  extend ActiveSupport::Concern
+  included do
+  end
+
+  module ClassMethods
+    def wrap_methods(method_arr, function)
+      method_arr.each do |method_name|
+        old_method = instance_method(method_name)
+        define_method(method_name) do |*args, &block|
+          function.call(method_name)
+          old_method.bind(self).call(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/tinymethodwrapper/version.rb

@@ -0,0 +1,3 @@
+module Tinymethodwrapper
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'pry'
+require 'tinymethodwrapper'

data/test/tinymethodwrapper_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+class User
+  include Tinymethodwrapper
+
+  @@custom_called = 0
+
+  def self.custom_called
+    @@custom_called
+  end
+
+  def self.set_custom_called(new_val)
+    @@custom_called = new_val
+  end
+
+  def godzilla_rocks
+    "yes"
+  end
+
+  def method_with_argument(hi)
+    hi
+  end
+
+  def method_with_keyword_arguments(age, name: "bruno")
+    age.to_s + name
+  end
+
+  def method_with_default_arguments(name = "hans")
+    name
+  end
+
+  wrap_methods %i[godzilla_rocks method_with_argument
+    method_with_keyword_arguments method_with_default_arguments],
+    -> (method_name) { @@custom_called += 1}
+end
+
+describe Tinymethodwrapper do
+  # Reset class var before each test
+  before do
+    User.set_custom_called 0
+  end
+
+  it "adds a class method" do
+    assert User.respond_to? :wrap_methods
+  end
+
+  it "wraps the method and performs something" do
+    u = User.new
+    assert u.godzilla_rocks == "yes"
+    assert User.custom_called == 1
+  end
+
+  it "works for methods with arguments" do
+    u = User.new
+    assert u.method_with_argument("hi") == "hi"
+    assert User.custom_called == 1
+  end
+
+  it "works for methods with keyword arguments" do
+    u = User.new
+    assert u.method_with_keyword_arguments(16, name: "bruno") == "16bruno"
+    assert User.custom_called == 1
+  end
+
+  it "works for methods with default arguments" do
+    u = User.new
+    assert u.method_with_default_arguments == "hans"
+    assert User.custom_called == 1
+  end
+end

data/tinymethodwrapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tinymethodwrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tinymethodwrapper"
+  spec.version       = Tinymethodwrapper::VERSION
+  spec.authors       = ["Hendrik Kleinwaechter"]
+  spec.email         = ["hendrik.kleinwaechter@gmail.com"]
+  spec.summary       = %q{Really tiny library for wrapping ruby methods with a prefix call.}
+  spec.description   = %q{Great for doing debugging and logging deprecated methods}
+  spec.homepage      = "http://zeit.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7"
+  spec.add_development_dependency "pry", '~> 0.9.12'
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: tinymethodwrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hendrik Kleinwaechter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: Great for doing debugging and logging deprecated methods
+email:
+- hendrik.kleinwaechter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tinymethodwrapper.rb
+- lib/tinymethodwrapper/version.rb
+- test/test_helper.rb
+- test/tinymethodwrapper_test.rb
+- tinymethodwrapper.gemspec
+homepage: http://zeit.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Really tiny library for wrapping ruby methods with a prefix call.
+test_files:
+- test/test_helper.rb
+- test/tinymethodwrapper_test.rb