abstriker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58fc310fb1c93359f11f08ece41ac5447b228166230656b8a481a21efb13ff42
+  data.tar.gz: c941dc1843f1bdb93cb567fa3e2a0c7fa9379b765832a9a01ccfe19ba9dd32f7
+SHA512:
+  metadata.gz: aa481fe912ed555b398e61ab3f64b9f3a51e3cada25148143ad8e7587bceacf3fb3afb5208b0b47327c174915168d9577bcb62b87ca629719f5001f5c94cd934
+  data.tar.gz: cd96e6d7772f00590e3a260a42602d52d7e14916e32c699c82f6b22930b7b1a962e1a901bf5bcab509c59ef12d79d7111784058248f0393a60ea1833f512973e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# 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 abstriker.gemspec
+gemspec

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,131 @@
+# Abstriker
+
+This gem adds `abstract` syntax. that is similar to Java's one.
+`abstract` modified method requires subclass implementation.
+
+If subclass does not implement `abstract` method, raise `Abstriker::NotImplementedError`.
+`Abstriker::NotImplementedError` is curently subclass of `::NotImplementedError`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abstriker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abstriker
+
+## Usage
+
+```ruby
+class A1
+  extend Abstriker
+
+  abstract def foo
+  end
+end
+
+class A3 < A1
+  def foo
+  end
+end # => OK
+
+class A2 < A1
+end # => raise
+
+Class.new(A1) do
+end # => raise
+```
+
+### for Production
+If you want to disable Abstriker, write `Abstriker.disable = true` at first line.
+If Abstriker is disabled, TracePoint never runs, and so there is no overhead of VM instruction.
+
+### Examples
+
+#### include module
+
+```ruby
+module B1
+  extend Abstriker
+
+  abstract def foo
+  end
+end
+
+class B2
+  include B1
+end # => raise
+
+Module.new do
+  include B1
+end # => raise
+```
+
+#### extend module
+
+```ruby
+module C1
+  extend Abstriker
+
+  abstract def foo
+  end
+end
+
+class C3
+  extend C1
+
+  def self.foo
+  end
+end # => OK
+
+class C2
+  extend C1
+end # raise
+```
+
+#### singleton class
+
+```ruby
+class D1
+  extend Abstriker
+
+  class << self
+    abstract def foo
+    end
+  end
+end
+
+class D3 < D1
+  def self.foo
+  end
+end # => OK
+
+class D2 < D1
+end # => raise
+
+Class.new(D1) do
+end # => raise
+
+```
+
+## 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/abstriker.
+
+## 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/abstriker.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "abstriker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "abstriker"
+  spec.version       = Abstriker::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Add abstract syntax that target method requires subclass implementation.}
+  spec.description   = %q{Add abstract syntax that target method requires subclass implementation.}
+  spec.homepage      = "https://github.com/joker1007/abstriker"
+  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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abstriker"
+
+# 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/abstriker/version.rb

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

data/lib/abstriker.rb

@@ -0,0 +1,160 @@
+require "abstriker/version"
+require "set"
+
+module Abstriker
+  class NotImplementedError < NotImplementedError
+    attr_reader :subclass, :abstract_method
+
+    def initialize(klass, abstract_method)
+      super("#{abstract_method} is abstract, but not implemented by #{klass}")
+      @subclass = klass
+      @abstract_method = abstract_method
+    end
+  end
+
+  @disable = false
+
+  def self.disable=(v)
+    @disable = v
+  end
+
+  def self.disabled?
+    @disable
+  end
+
+  def self.enabled?
+    !disabled?
+  end
+
+  def self.abstract_methods
+    @abstract_methods ||= {}
+  end
+
+  def self.extended(base)
+    base.extend(SyntaxMethods)
+    base.singleton_class.extend(SyntaxMethods)
+    if enabled?
+      base.extend(ModuleMethods) if base.is_a?(Module)
+      base.extend(ClassMethods) if base.is_a?(Class)
+    end
+  end
+
+  module SyntaxMethods
+    private
+
+    def abstract(symbol)
+      method_set = Abstriker.abstract_methods[self] ||= Set.new
+      method_set.add(symbol)
+    end
+  end
+
+  module HookBase
+    private
+
+    def detect_event_type
+      caller_info = caller_locations(3, 1)[0]
+      if caller_info.label.match?(/block/)
+        [:end, :raise]
+      elsif caller_info.label.match?(/initialize/) || caller_info.label.match?(/new/)
+        [:b_call, :b_return, :raise]
+      end
+    end
+
+    def check_abstract_methods(klass, block_count_offset = 0)
+      return if Abstriker.disabled?
+
+      event_type = detect_event_type
+
+      unless klass.instance_variable_get("@__abstract_trace_point")
+        block_count = block_count_offset
+
+        tp = TracePoint.trace(*event_type) do |t|
+          if t.event == :raise
+            tp.disable
+            next
+          end
+
+          block_count += 1 if t.event == :b_call
+          block_count -= 1 if t.event == :b_return
+
+          if t.self == klass && (t.event == :end || t.event == :b_return && block_count.zero?)
+            klass.ancestors.drop(1).each do |mod|
+              Abstriker.abstract_methods[mod]&.each do |fmeth_name|
+                meth = klass.instance_method(fmeth_name)
+                unless meth&.owner == klass
+                  tp.disable
+                  klass.instance_variable_set("@__abstract_trace_point", nil)
+                  raise Abstriker::NotImplementedError.new(klass, meth)
+                end
+              end
+            end
+            tp.disable
+            klass.instance_variable_set("@__abstract_trace_point", nil)
+          end
+        end
+        klass.instance_variable_set("@__abstract_trace_point", tp)
+      end
+    end
+
+    def check_abstract_singleton_methods(klass, block_count_offset = 0)
+      return if Abstriker.disabled?
+
+      event_type = detect_event_type
+
+      unless klass.instance_variable_get("@__abstract_singleton_trace_point")
+        block_count = block_count_offset
+
+        tp = TracePoint.trace(*event_type) do |t|
+          if t.event == :raise
+            tp.disable
+            next
+          end
+
+          block_count += 1 if t.event == :b_call
+          block_count -= 1 if t.event == :b_return
+
+          if t.self == klass && (t.event == :end || t.event == :b_return && block_count.zero?)
+            klass.singleton_class.ancestors.drop(1).each do |mod|
+              Abstriker.abstract_methods[mod]&.each do |fmeth_name|
+                meth = klass.singleton_class.instance_method(fmeth_name)
+                unless meth&.owner == klass.singleton_class
+                  tp.disable
+                  klass.instance_variable_set("@__abstract_singleton_trace_point", nil)
+                  raise Abstriker::NotImplementedError.new(klass, meth)
+                end
+              end
+            end
+            tp.disable
+            klass.instance_variable_set("@__abstract_singleton_trace_point", nil)
+          end
+        end
+        klass.instance_variable_set("@__abstract_singleton_trace_point", tp)
+      end
+    end
+  end
+
+  module ClassMethods
+    include HookBase
+
+    private
+
+    def inherited(subclass)
+      check_abstract_methods(subclass)
+      check_abstract_singleton_methods(subclass)
+    end
+  end
+
+  module ModuleMethods
+    include HookBase
+
+    private
+
+    def included(base)
+      check_abstract_methods(base, 1)
+    end
+
+    def extended(base)
+      check_abstract_singleton_methods(base, 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: abstriker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-25 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 abstract syntax that target method requires subclass implementation.
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- abstriker.gemspec
+- bin/console
+- bin/setup
+- lib/abstriker.rb
+- lib/abstriker/version.rb
+homepage: https://github.com/joker1007/abstriker
+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 abstract syntax that target method requires subclass implementation.
+test_files: []