overrider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54ce106b063d03de98208f4640f2d736b7f667c7b6b81e4eb64adf7456ae38b8
+  data.tar.gz: c218b9f243af271752064e0f42c4fbe179988bf7a4212a2f8b35a06a9823b902
+SHA512:
+  metadata.gz: 0b0b6be378f119d82cc7130f94be95b330ebeeef261e12b95505639b25358ef08707ecf2cf295a8e95422e564ec99938f8c8cb3719fccf2837df6c6dd12b9bb5
+  data.tar.gz: cac2068a46553296b39a0335882a17df8a90936e0d1020fa71650f032224c9ac7b5cb17c156fffa8e4ca0ab3f6f0d306cbd8b70f0fc94ddd455b1857284d61e2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in overrider.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    overrider (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  overrider!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 joker1007
+
+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,172 @@
+# Overrider
+[![Build Status](https://travis-ci.org/joker1007/overrider.svg?branch=master)](https://travis-ci.org/joker1007/overrider)
+
+This gem adds `override` syntax that is similar to Java's one.
+`override` syntax ensures that a modified method has super method.
+
+Unless the method has super method, this gem raise `Overrider::NoSuperMethodError`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'overrider'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install overrider
+
+## Usage
+
+```ruby
+class A1
+  def foo
+  end
+end
+
+class A2 < A1
+  extend Overrider
+
+  override def foo
+  end
+end
+```
+
+this is OK.
+
+```ruby
+class B1
+end
+
+class B2 < B1
+  extend Overrider
+
+  override def foo
+  end
+end # => raise
+```
+
+### Examples
+
+#### include module method after override method
+
+```ruby
+module C1
+  def foo
+  end
+end
+
+class C2
+  extend Overrider
+
+  override def foo
+  end
+
+  include C1
+end # => OK
+```
+
+#### singleton method
+
+```ruby
+class D1
+end
+
+class D2 < D1
+  extend Overrider
+
+  class << self
+    def foo
+    end
+  end
+
+  override_singleton_method :foo
+end # => raise
+```
+
+```ruby
+class D2_1
+  def self.foo
+  end
+end
+
+class D2_2 < D2_1
+  extend Overrider
+
+  class << self
+    def foo
+    end
+  end
+
+  override_singleton_method :foo
+end # => OK
+```
+
+#### extend singleton method after override method
+
+```ruby
+module E1
+  def foo
+  end
+
+  def bar
+  end
+end
+
+class E2
+  extend Overrider
+
+  class << self
+    def foo
+    end
+
+    def bar
+    end
+  end
+
+  override_singleton_method :foo
+  override_singleton_method :bar
+
+  extend E1
+end # => OK
+```
+
+#### `Class.new` style
+
+```ruby
+class A1
+  def foo
+  end
+end
+
+Class.new(A1) do
+  extend Overrider
+
+  override def foo
+  end
+end # => OK
+```
+
+## How is it implemented?
+
+Use `TracePoint` and `caller_locations` (to detect `class-end` or `Class.new { }`).
+
+## 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/joker1007/overrider.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "overrider"
+
+# 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(__FILE__)

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/lib/overrider.rb

@@ -0,0 +1,68 @@
+require "overrider/version"
+require 'set'
+
+module Overrider
+  class NoSuperMethodError < StandardError
+    attr_reader :override_class, :unbound_method
+
+    def initialize(klass, method)
+      super("#{method} requires super method.")
+      @override_class = klass
+      @unbound_method = method
+    end
+  end
+
+  private
+
+  def override(symbol)
+    caller_info = caller_locations(1, 1)[0]
+    event_type = if caller_info.label.match?(/block/)
+      :b_return
+    else
+      :end
+    end
+
+    @__overrider_trace_point ||= TracePoint.trace(event_type) do |t|
+      klass = t.self
+      if klass == self
+        @ensure_overrides.each do |n|
+          meth = klass.instance_method(n)
+          unless meth.super_method
+            raise NoSuperMethodError.new(klass, meth)
+          end
+        end
+        @__overrider_trace_point.disable
+        @__overrider_trace_point = nil
+      end
+    end
+    @ensure_overrides ||= Set.new
+    @ensure_overrides.add(symbol)
+    symbol
+  end
+
+  def override_singleton_method(symbol)
+    caller_info = caller_locations(1, 1)[0]
+    event_type = if caller_info.label.match?(/block/)
+      :b_return
+    else
+      :end
+    end
+
+    @__overrider_singleton_trace_point ||= TracePoint.trace(event_type) do |t|
+      klass = t.self
+      if klass == self
+        @ensure_overrides.each do |n|
+          meth = klass.singleton_class.instance_method(n)
+          unless meth.super_method
+            raise NoSuperMethodError.new(klass, meth)
+          end
+        end
+        @__overrider_singleton_trace_point.disable
+        @__overrider_singleton_trace_point = nil
+      end
+    end
+    @ensure_overrides ||= Set.new
+    @ensure_overrides.add(symbol)
+    symbol
+  end
+end

data/lib/overrider/version.rb

@@ -0,0 +1,3 @@
+module Overrider
+  VERSION = "0.1.0"
+end

data/overrider.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "overrider/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "overrider"
+  spec.version       = Overrider::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Add override syntax that ensures that target method has super method.}
+  spec.description   = %q{Add override syntax that ensures that target method has super method.}
+  spec.homepage      = "https://github.com/joker1007/overrider"
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: overrider
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Add override syntax that ensures that target method has super method.
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/overrider.rb
+- lib/overrider/version.rb
+- overrider.gemspec
+homepage: https://github.com/joker1007/overrider
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Add override syntax that ensures that target method has super method.
+test_files: []