predef 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa5c7ec0741fd0fec34e209fcc67873076662c02
+  data.tar.gz: 3e5262dd0fb9da3b0d97fdef139c19c5bf7926df
+SHA512:
+  metadata.gz: 7eefc89fdba544c33660e14769df1625752bc7b4f2f52fdc2ad5cb1652556b79e0c9b065fc0adc424c517adb1ac985f3752e5d6d0ede2482e784eb5aa4f53c2f
+  data.tar.gz: 36b57795b4426a4ac59943c60e8cfd9bf62cb0821dfbf916d4b2ad531abf5ea1e37a8ec1219c28180ac701b34eb3028bdbdefadc099e1566349d4aa4da53715e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+install:
+  - gem install bundler
+  - bundle
+rvm:
+  - ruby-head
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0
+script:
+  - bundle exec ruby test/example.rb
+notifications:
+  email:
+    recipients:
+      - whosekiteneverfly@gmail.com
+    on_success: never
+    on_failure: never
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/ChangeLog.md

@@ -0,0 +1,3 @@
+# 0.8.0 (2015-06-04)
+
+- Initial release. I think *all* of the features are complete. After trying it in my job for a while, release 1.0.0.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yuji Yamamoto
+
+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,114 @@
+# Predef
+
+Shortcut for prepend-ing Module. Maybe useful for debugging.
+
+[![Build Status](https://travis-ci.org/igrep/predef.svg?branch=master)](https://travis-ci.org/igrep/predef)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'predef'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install predef
+
+## Usage
+
+### Example: Collect All Queries Executed in a Test
+
+Given you're using some third-party database client library like this...
+
+```ruby
+class HogeSQL::Connection
+  def execute query
+    # ...
+  end
+
+  # ...
+end
+```
+
+Imagine you want to see all `SELECT` queries and the stacktrace when executed, without any change of `HogeSQL::Connection`.
+
+```ruby
+require 'predef'
+
+Predef.predef HogeSQL::Connection, :execute do|query|
+  if query.include? 'SELECT'
+    puts query
+    pp caller
+  end
+  super # call the original query method.
+end
+
+# ... your app or some test code ...
+```
+
+Then you'd get...
+
+```ruby
+SELECT * from your_apps_table WHERE ...
+["/path/to/your_app/app/models/foo.rb:355:in `some_method_in_model'",
+ "/path/to/your_app/app/controllers/foo_controller.rb:355:in `some_action_in_controller'",
+ ...]
+
+...
+```
+
+This is just a shortcut for:
+
+```ruby
+module SomeWrapper
+  def execute
+    if query.include? 'SELECT'
+      puts query
+      pp caller
+    end
+    super # call the original execute method.
+  end
+end
+
+HogeSQL::Connection.__send__(:prepend, SomeWrapper)
+```
+
+So you can more quickly inspect code you don't want to change directly!
+
+### More Ruby-ish Way
+
+Or would you like `using` this way?
+Though it's a bit more verbose to prepend only one method.
+
+```ruby
+using Predef::Refinements
+
+HogeSQL::Connection.predef :execute do|query|
+  # same here with the last example...
+end
+```
+
+## For more methods:
+
+See and/or execute [test/example.rb](test/example.rb):
+
+```bash
+$ git clone git@github.com:igrep/predef.git
+$ cd predef
+$ bundle
+$ bundle exec ruby test/example.rb
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/igrep/predef/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/predef.rb

@@ -0,0 +1,72 @@
+class Predef < Module
+  VERSION = '0.8.0'
+
+  private_class_method :new
+
+  def self.predef klass, method_name, &definition
+    unless klass.public_method_defined? method_name
+      raise ::Predef::Error, "#{klass}##{method_name} is not defined! Use `Predef.predef!` if you want to define a new method."
+    end
+
+    predef! klass, method_name, &definition
+  end
+
+  def self.predef! klass, method_name, &definition
+    if defined? klass.__PREDEF__
+      instance = klass.__PREDEF__
+    else
+      instance = new(klass)
+
+      singleton_class = class << klass; self ; end
+      singleton_class.class_eval do
+        define_method(:__PREDEF__) { instance }
+      end
+    end
+
+    instance.module_eval do
+      define_method(method_name, &definition)
+    end
+    method_name
+  end
+
+  def self.unpredef klass, method_name
+    if !(defined? klass.__PREDEF__) || !(klass.__PREDEF__.public_method_defined? method_name)
+      raise ::Predef::Error, "#{klass}##{method_name} has never been predef-ed!"
+    end
+    self.unpredef! klass, method_name
+  end
+
+  def self.unpredef! klass, method_name
+    klass.__PREDEF__.module_eval do
+      remove_method method_name
+    end
+  end
+
+  def initialize klass
+    prepend_features klass
+  end
+
+  module Refinements
+    refine Class do
+      def predef method_name, &block
+        ::Predef.predef(self, method_name, &block)
+      end
+
+      def predef! method_name, &block
+        ::Predef.predef!(self, method_name, &block)
+      end
+
+      def unpredef method_name
+        ::Predef.unpredef(self, method_name)
+      end
+
+      def unpredef! method_name
+        ::Predef.unpredef!(self, method_name)
+      end
+    end
+  end
+
+  class Error < ::Exception
+  end
+
+end

data/predef.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'predef'
+
+Gem::Specification.new do |spec|
+  spec.name          = "predef"
+  spec.version       = Predef::VERSION
+  spec.authors       = ["Yuji Yamamoto"]
+  spec.email         = ["whosekiteneverfly@gmail.com"]
+  spec.summary       = %q{Shortcut for prepend-ing Module.}
+  spec.description   = %q{Shortcut for prepend-ing Module. Maybe useful for debugging.}
+  spec.homepage      = "https://github.com/igrep/predef"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = ["test/example.rb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.required_ruby_version = '>= 2.0'
+end

data/test/example.rb

@@ -0,0 +1,135 @@
+require_relative 'test_helper'
+
+class Hoge
+  def foo arg
+    'bar ' + arg
+  end
+  def foo2
+    'original foo2'
+  end
+  def foo3
+  end
+  def never_predef_ed
+  end
+
+  def self.singleton_method arg
+    'singleton_bar ' + arg
+  end
+end
+
+example 'Predef.predef overrides a method of a class' do
+
+  note 'overridden method can use super.'
+  Predef.predef Hoge, :foo do|arg|
+    super(arg) + ' baz'
+  end
+
+  actual = Hoge.new.foo('arg')
+  expected = 'bar arg baz'
+  test(
+    (actual == expected),
+    "Expected #{actual.inspect} to equal to #{expected.inspect}."
+  )
+end
+
+example 'Predef.predef overrides a singleton method of a object' do
+
+  Predef.predef Hoge.singleton_class, :singleton_method do|arg|
+    super(arg) + ' baz'
+  end
+
+  actual = Hoge.singleton_method('arg')
+  expected = 'singleton_bar arg baz'
+  test(
+    (actual == expected),
+    "Expected #{actual.inspect} to equal to #{expected.inspect}."
+  )
+end
+
+example 'Predef.predef overrides another method of the class' do
+  Predef.predef Hoge, :foo2 do
+    'baz2'
+  end
+
+  actual = Hoge.new.foo2
+  expected = 'baz2'
+  test(
+    (actual == expected),
+    "Expected #{actual.inspect} to equal to #{expected.inspect}."
+  )
+end
+
+example 'Predef.predef raises an error given an undefined method.' do
+  actual = error_of do
+    Predef.predef Hoge, :non_defined do
+    end
+  end
+  expected = ::Predef::Error
+  test(
+    (actual.instance_of? expected),
+    "Expected an instance of #{actual.class} to be an instance of #{expected}."
+  )
+end
+
+example 'Predef.predef! does NOT raise an error given even an undefined method.' do
+  actual = error_of do
+    Predef.predef! Hoge, :non_defined do
+    end
+  end
+  test(actual.nil?, "Expected an instance of #{actual.inspect} to nil.")
+end
+
+example 'Predef.unpredef gets back orignal method.' do
+  Predef.unpredef Hoge, :foo2
+
+  actual = Hoge.new.foo2
+  expected = 'original foo2'
+  test(
+    (actual == expected),
+    "Expected #{actual.inspect} to equal to #{expected.inspect}."
+  )
+end
+
+example 'Predef.unpredef raises an error given a non predef-ed class.' do
+  class AnotherClass
+    def foo
+    end
+  end
+
+  actual = error_of { Predef.unpredef AnotherClass, :foo }
+  expected = ::Predef::Error
+  test(
+    (actual.instance_of? expected),
+    "Expected an instance of #{actual.class} to be an instance of #{expected}."
+  )
+end
+
+example 'Predef.unpredef raises an error given a non predef-ed method.' do
+  actual = error_of { Predef.unpredef Hoge, :never_predef_ed }
+  expected = ::Predef::Error
+  test(
+    (actual.instance_of? expected),
+    "Expected an instance of #{actual.class} to be an instance of #{expected}."
+  )
+end
+
+example 'Hoge.predef raises a NoMethodError without using Predef::Refinements' do
+  actual = error_of { Hoge.predef(:foo3){ :foo3 } }
+  expected = ::NoMethodError
+  test(
+    (actual.instance_of? expected),
+    "Expected an instance of #{actual.class} to be an instance of #{expected}."
+  )
+end
+
+using ::Predef::Refinements
+
+example "Hoge.predef doesn't raise an error by using Predef::Refinements" do
+  Hoge.predef(:foo3){ :foo3 }
+  actual = Hoge.new.foo3
+  expected = :foo3
+  test(
+    (actual == expected),
+    "Expected #{actual.inspect} to equal to #{expected.inspect}."
+  )
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+def example description, &block
+  puts "- #{description}"
+  block.call
+  puts
+end
+
+def note content
+  puts "-- # #{content}"
+end
+
+def test boolean_expression, on_failure
+  if boolean_expression
+    puts '=> OK'.freeze
+  else
+    fail "Assertion failed.\n\n    ==> #{on_failure}\n\n"
+  end
+end
+
+def error_of &block
+  block.call
+rescue ::Exception => e
+  return e
+else
+  return nil
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: predef
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Yuji Yamamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: Shortcut for prepend-ing Module. Maybe useful for debugging.
+email:
+- whosekiteneverfly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/predef.rb
+- predef.gemspec
+- test/example.rb
+- test/test_helper.rb
+homepage: https://github.com/igrep/predef
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.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: Shortcut for prepend-ing Module.
+test_files:
+- test/example.rb
+has_rdoc: