finalist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3bd9a7da2ed1299669acc5b20b76439dc8f565c31fc2bae0915daa7153473eb
+  data.tar.gz: 316c0f335739c061c4d469a99ef23827ca87d53caa427bb6499585d4391d5dd3
+SHA512:
+  metadata.gz: a5240bd27a734c12653d32afe824391d99f64ae06aac4e3254f1248d79287b031ccbd00bab12ae1cba4b60a7005862d855c3d86d9e34dd66f9f9a0837fe44bca
+  data.tar.gz: 98632cd634b0d6748c8b73591292ef9c63b979f5a1016185f9c5468227493218e89e1ca3130aac0208f873bc9ab6fabf1d5ee50144d627b1d2a005eecb565ff4

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 finalist.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    finalist (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    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)
+  byebug
+  finalist!
+  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,200 @@
+# Finalist
+[![Build Status](https://travis-ci.org/joker1007/finalist.svg?branch=master)](https://travis-ci.org/joker1007/finalist)
+
+Finalist adds `final` method modifier.
+`final` forbids method override.
+
+Simple case is following.
+
+```ruby
+class A1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+class A2 < A1
+  def foo
+  end
+end
+```
+
+This case raises `Finalist::OverrideFinalMethodError` at `def foo in A2 class`.
+
+This gem supports other cases.
+(see [finalist_spec.rb](https://github.com/joker1007/finalist/blob/master/spec/finalist_spec.rb))
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'finalist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install finalist
+
+## Usage
+
+A class or module extends `Finalist` module
+And add `final` modifier to target method.
+(`final` can accept symbol as method name.)
+
+### Examples
+
+#### include module
+
+```ruby
+module E1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+module E2
+  include E1
+end
+
+module E3
+  include E2
+
+  def foo # => raise
+  end
+end
+```
+
+#### include module after override
+
+```ruby
+module F1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+class F2
+  def foo
+  end
+
+  include F1 # => raise
+end
+```
+
+#### class method
+
+```ruby
+class J1
+  extend Finalist
+
+  class << self
+    final def foo
+    end
+  end
+end
+
+class J2 < J1
+  class << self
+    def foo # => raise
+    end
+  end
+end
+```
+
+#### extend object
+
+```ruby
+module H1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+a = "str"
+a.extend(H1)
+def a.foo # => raise
+end
+```
+
+#### extend object after override
+
+```ruby
+module I1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+a = "str"
+def a.foo
+end
+a.extend(I1) # => raise
+```
+
+#### class method by extend module
+
+```ruby
+module K1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+class K2
+  extend K1
+
+  class << self
+    def foo # => raise
+    end
+  end
+end
+```
+
+#### class method by extend module after override
+
+```ruby
+module L1
+  extend Finalist
+
+  final def foo
+  end
+end
+
+class L2
+  class << self
+    def foo
+    end
+  end
+
+  extend L1 # => raise
+end
+```
+
+## How is this implemented?
+
+Use so many ruby hooks. `TracePoint` and `method_added` and `singleton_method_added` and `included` and `extended`.
+
+## 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/finalist.
+
+## 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 "finalist"
+
+# 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/finalist.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "finalist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "finalist"
+  spec.version       = Finalist::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Add final syntax which forbids method override}
+  spec.description   = %q{Add final syntax which forbids method override}
+  spec.homepage      = "https://github.com/joker1007/finalist"
+  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"
+  spec.add_development_dependency "byebug"
+end

data/lib/finalist.rb

@@ -0,0 +1,130 @@
+require "finalist/version"
+require "set"
+
+module Finalist
+  class OverrideFinalMethodError < StandardError
+    attr_reader :override_class, :origin_class, :unbound_method, :detect_type
+
+    def initialize(message, klass, origin, meth, detect_type)
+      super(message)
+      @override_class = klass
+      @origin_class = origin
+      @unbound_method = meth
+      @detect_type = detect_type # for debug
+    end
+  end
+
+  def self.extended(base)
+    super
+    base.extend(SyntaxMethods)
+    base.singleton_class.extend(SyntaxMethods)
+    base.extend(ModuleMethods) if base.instance_of?(Module)
+  end
+
+  def self.finalized_methods
+    @finalized_methods ||= {}
+  end
+
+  module ModuleMethods
+    def included(base)
+      super
+
+      base.extend(Finalist)
+
+      tp = TracePoint.new(:end) do |ev|
+        if ev.self == base
+          base.ancestors.drop(1).each do |mod|
+            Finalist.finalized_methods[mod]&.each do |fmeth_name|
+              if meth = base.instance_method(fmeth_name)
+                super_method = meth.super_method
+                while super_method
+                  if Finalist.finalized_methods[super_method.owner]&.member?(super_method.name)
+                    tp.disable
+                    base.instance_variable_set("@__finalist_tp", nil)
+                    raise OverrideFinalMethodError.new("#{super_method} at #{super_method.source_location.join(":")} is overrided\n  by #{meth} at #{meth.source_location.join(":")}", base, super_method.owner, meth, :trace_point)
+                  end
+
+                  super_method = super_method.super_method
+                end
+              end
+            end
+          end
+          tp.disable
+        end
+      end
+      tp.enable
+      base.instance_variable_set("@__finalist_tp", tp)
+    end
+
+    def extended(base)
+      def base.singleton_method_added(symbol)
+        super
+
+        meth = singleton_class.instance_method(symbol)
+        super_method = meth.super_method
+        while super_method
+          if Finalist.finalized_methods[super_method.owner]&.member?(super_method.name)
+            @__finalist_tp&.disable
+            @__finalist_tp = nil
+            raise OverrideFinalMethodError.new("#{super_method} at #{super_method.source_location.join(":")} is overrided\n  by #{meth} at #{meth.source_location.join(":")}", singleton_class, super_method.owner, meth, :extended_singleton_method_added)
+          end
+          super_method = super_method.super_method
+        end
+      end
+
+      base.singleton_class.ancestors.drop(1).each do |mod|
+        Finalist.finalized_methods[mod]&.each do |fmeth_name|
+          if meth = base.singleton_class.instance_method(fmeth_name)
+            super_method = meth.super_method
+            while super_method
+              if Finalist.finalized_methods[super_method.owner]&.member?(super_method.name)
+                base.instance_variable_get("@__finalist_tp")&.disable
+                base.instance_variable_set("@__finalist_tp", nil)
+
+                raise OverrideFinalMethodError.new("#{super_method} at #{super_method.source_location.join(":")} is overrided\n  by #{meth} at #{meth.source_location.join(":")}", base.singleton_class, super_method.owner, meth, :extended)
+              end
+              super_method = super_method.super_method
+            end
+          end
+        end
+      end
+    end
+  end
+
+  module SyntaxMethods
+    def final(symbol)
+      method_set = Finalist.finalized_methods[self] ||= Set.new
+      method_set.add(symbol)
+    end
+  end
+
+  def method_added(symbol)
+    super
+
+    meth = instance_method(symbol)
+    super_method = meth.super_method
+    while super_method
+      if Finalist.finalized_methods[super_method.owner]&.member?(super_method.name)
+        @__finalist_tp&.disable
+        @__finalist_tp = nil
+        raise OverrideFinalMethodError.new("#{super_method} at #{super_method.source_location.join(":")} is overrided\n  by #{meth} at #{meth.source_location.join(":")}", self, super_method.owner, meth, :method_added)
+      end
+      super_method = super_method.super_method
+    end
+  end
+
+  def singleton_method_added(symbol)
+    super
+
+    meth = singleton_class.instance_method(symbol)
+    super_method = meth.super_method
+    while super_method
+      if Finalist.finalized_methods[super_method.owner]&.member?(super_method.name)
+        @__finalist_tp&.disable
+        @__finalist_tp = nil
+        raise OverrideFinalMethodError.new("#{super_method} at #{super_method.source_location.join(":")} is overrided\n  by #{meth} at #{meth.source_location.join(":")}", self, super_method.owner, meth, :singleton_method_added)
+      end
+      super_method = super_method.super_method
+    end
+  end
+end

data/lib/finalist/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: finalist
+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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+description: Add final syntax which forbids method override
+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
+- finalist.gemspec
+- lib/finalist.rb
+- lib/finalist/version.rb
+homepage: https://github.com/joker1007/finalist
+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 final syntax which forbids method override
+test_files: []