tinymethodwrapper 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 4730cdae2ca1ef4a23c6a8c455a5ce40a621b45d
4
+ data.tar.gz: c9686bd411b0eed1fb35e6558e479bcb56900819
5
+ SHA512:
6
+ metadata.gz: 0f3f1766609867cdfdb652a02234a09e42e98bd045265d46bc9f6804b4d4497f1a8feea5c6db9c38a82f25aa6ec76c0205c00e43aa269b4d81c26dc9c8e3787f
7
+ data.tar.gz: 3590033bef0a7c86f9200db543dc0e3c940d0f243ac737550f1aa7b061b5eb471b4181c7761f92e7a3c443f5097613f0b06ee84f67b966f188b0c3073a81cbbb
data/.gitignore ADDED
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in tinymethodwrapper.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Hendrik Kleinwaechter
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # Tinymethodwrapper
2
+
3
+ A small gem (22 lines of code) that allows you to wrap methods with a custom
4
+ call of another method. Really useful for performing logging or other
5
+ options. We use this to log deprecated methods when doing large codebase
6
+ changes.
7
+
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ gem 'tinymethodwrapper'
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install tinymethodwrapper
22
+
23
+ ## Usage
24
+
25
+ class User
26
+ include Tinymethodwrapper
27
+
28
+ def godzilla_rocks
29
+ "yes"
30
+ end
31
+
32
+ def say_hi_to_name(name)
33
+ name
34
+ end
35
+
36
+ wrap_methods %i[godzilla_rocks say_hi_to_name],
37
+ -> (method_name) { Rails.logger.info "#{method_name} was just called" }
38
+ end
39
+
40
+ user = User.new
41
+ user.godzilla_rocks
42
+ #=> "yes"
43
+
44
+ user.say_hi_to_name("hendrik")
45
+ #=> "hendrik"
46
+
47
+ #=> check the log fle, two logs were added
48
+
49
+ ## Contributing
50
+
51
+ 1. Fork it ( https://github.com/ZEITIO/tinymethodwrapper/fork )
52
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
53
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
54
+ 4. Push to the branch (`git push origin my-new-feature`)
55
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,9 @@
1
+ require "bundler/gem_tasks"
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new do |t|
5
+ t.libs << 'test'
6
+ t.pattern = "test/*_test.rb"
7
+ end
8
+
9
+ task :default => :test
@@ -0,0 +1,22 @@
1
+ require "tinymethodwrapper/version"
2
+ require 'active_support'
3
+ require 'active_support/version'
4
+
5
+
6
+ module Tinymethodwrapper
7
+ extend ActiveSupport::Concern
8
+ included do
9
+ end
10
+
11
+ module ClassMethods
12
+ def wrap_methods(method_arr, function)
13
+ method_arr.each do |method_name|
14
+ old_method = instance_method(method_name)
15
+ define_method(method_name) do |*args, &block|
16
+ function.call(method_name)
17
+ old_method.bind(self).call(*args, &block)
18
+ end
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,3 @@
1
+ module Tinymethodwrapper
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,5 @@
1
+ require 'minitest/spec'
2
+ require 'minitest/autorun'
3
+ require 'minitest/pride'
4
+ require 'pry'
5
+ require 'tinymethodwrapper'
@@ -0,0 +1,70 @@
1
+ require 'test_helper'
2
+
3
+ class User
4
+ include Tinymethodwrapper
5
+
6
+ @@custom_called = 0
7
+
8
+ def self.custom_called
9
+ @@custom_called
10
+ end
11
+
12
+ def self.set_custom_called(new_val)
13
+ @@custom_called = new_val
14
+ end
15
+
16
+ def godzilla_rocks
17
+ "yes"
18
+ end
19
+
20
+ def method_with_argument(hi)
21
+ hi
22
+ end
23
+
24
+ def method_with_keyword_arguments(age, name: "bruno")
25
+ age.to_s + name
26
+ end
27
+
28
+ def method_with_default_arguments(name = "hans")
29
+ name
30
+ end
31
+
32
+ wrap_methods %i[godzilla_rocks method_with_argument
33
+ method_with_keyword_arguments method_with_default_arguments],
34
+ -> (method_name) { @@custom_called += 1}
35
+ end
36
+
37
+ describe Tinymethodwrapper do
38
+ # Reset class var before each test
39
+ before do
40
+ User.set_custom_called 0
41
+ end
42
+
43
+ it "adds a class method" do
44
+ assert User.respond_to? :wrap_methods
45
+ end
46
+
47
+ it "wraps the method and performs something" do
48
+ u = User.new
49
+ assert u.godzilla_rocks == "yes"
50
+ assert User.custom_called == 1
51
+ end
52
+
53
+ it "works for methods with arguments" do
54
+ u = User.new
55
+ assert u.method_with_argument("hi") == "hi"
56
+ assert User.custom_called == 1
57
+ end
58
+
59
+ it "works for methods with keyword arguments" do
60
+ u = User.new
61
+ assert u.method_with_keyword_arguments(16, name: "bruno") == "16bruno"
62
+ assert User.custom_called == 1
63
+ end
64
+
65
+ it "works for methods with default arguments" do
66
+ u = User.new
67
+ assert u.method_with_default_arguments == "hans"
68
+ assert User.custom_called == 1
69
+ end
70
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'tinymethodwrapper/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "tinymethodwrapper"
8
+ spec.version = Tinymethodwrapper::VERSION
9
+ spec.authors = ["Hendrik Kleinwaechter"]
10
+ spec.email = ["hendrik.kleinwaechter@gmail.com"]
11
+ spec.summary = %q{Really tiny library for wrapping ruby methods with a prefix call.}
12
+ spec.description = %q{Great for doing debugging and logging deprecated methods}
13
+ spec.homepage = "http://zeit.io"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_runtime_dependency "activesupport"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.6"
24
+ spec.add_development_dependency "rake"
25
+ spec.add_development_dependency "minitest", "~> 4.7"
26
+ spec.add_development_dependency "pry", '~> 0.9.12'
27
+
28
+ end
metadata ADDED
@@ -0,0 +1,126 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: tinymethodwrapper
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Hendrik Kleinwaechter
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-07-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
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.6'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.6'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '4.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '4.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.9.12
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.9.12
83
+ description: Great for doing debugging and logging deprecated methods
84
+ email:
85
+ - hendrik.kleinwaechter@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - Gemfile
92
+ - LICENSE.txt
93
+ - README.md
94
+ - Rakefile
95
+ - lib/tinymethodwrapper.rb
96
+ - lib/tinymethodwrapper/version.rb
97
+ - test/test_helper.rb
98
+ - test/tinymethodwrapper_test.rb
99
+ - tinymethodwrapper.gemspec
100
+ homepage: http://zeit.io
101
+ licenses:
102
+ - MIT
103
+ metadata: {}
104
+ post_install_message:
105
+ rdoc_options: []
106
+ require_paths:
107
+ - lib
108
+ required_ruby_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ required_rubygems_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ requirements: []
119
+ rubyforge_project:
120
+ rubygems_version: 2.2.2
121
+ signing_key:
122
+ specification_version: 4
123
+ summary: Really tiny library for wrapping ruby methods with a prefix call.
124
+ test_files:
125
+ - test/test_helper.rb
126
+ - test/tinymethodwrapper_test.rb