finalizable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdd7523fe757dc528ba201a7777c37d370d620b5460754a185295df64bb95965
+  data.tar.gz: 2e6d093cb023f73e7c5557bd5c8762de0226396d176c4261ebf308b8fca6dff7
+SHA512:
+  metadata.gz: b249ca916b58b19e8d9ac5dbf85262ea78b3b49b39f6fe7d8d4dd76c640643f588fc641d56a2a4d29cfd6cdbb9473d365595a7e9993e13025be470c66f0f2279
+  data.tar.gz: 79a62f09e55d32f0fa6211fdba5bdf1f9abbc34018b8db899a0ad803622fc0587832546a292ba07ffac4115ea1ba617812892b992e81f89ab919fe795338cef0

data/.gitignore

@@ -0,0 +1,16 @@
+/vendor/bundle
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status
+
+*~
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'spec/**/*'
+    - 'vendor/bundle/**/*'
+
+Lint/Debugger:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+  AllowURI: true
+  Exclude:
+    - config/routes.rb
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in finalizable.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    finalizable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  finalizable!
+  pry-byebug (~> 3.8.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Shigeru Hagiwara
+
+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,75 @@
+[![Build Status](https://travis-ci.com/hgwr/finalizable.svg?branch=master)](https://travis-ci.com/hgwr/finalizable) 
+[![Gem Version](https://badge.fury.io/rb/finalizable.svg)](https://badge.fury.io/rb/finalizable)
+
+# Finalizable
+
+This gem makes the specified method non-overridable in Ruby.
+
+- I found [the awesome question in stack overflow](https://stackoverflow.com/questions/708642/how-to-make-a-base-class-method-non-overridable-in-ruby).
+- In the answer section, [Original page](http://www.thesorensens.org/2006/10/06/final-methods-in-ruby-prevent-method-override/) is intrudoced.
+- [Original page](http://www.thesorensens.org/2006/10/06/final-methods-in-ruby-prevent-method-override/) is not accessible now (2020-02-23).
+- I refered [the page in WayBack Machine](https://web.archive.org/web/20080226085648/http://www.thesorensens.org/2006/10/06/final-methods-in-ruby-prevent-method-override/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'finalizable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install finalizable
+
+## Usage
+
+see `lib/finalizable/example/`
+
+Example of parent class which is using `final` and `somewhat_final`.
+
+```ruby
+class ParentClass
+  include ::Finalizable
+  final :final_method_defined_in_parent_class
+  somewhat_final :somewhat_final_method_defined_in_parent_class
+
+  def final_method_defined_in_parent_class
+    :return_value_from_parent_class
+  end
+
+  def somewhat_final_method_defined_in_parent_class
+    :return_value_from_parent_class
+  end
+
+  def overridable_method_defined_in_parent_class
+    :return_value_from_parent_class
+  end
+end
+```
+
+- If subclass overrides the method `final_method_defined_in_parent_class`, you will get `Finalizable::OverrideError` on loading time not runtime.
+- If subclass overrides the method `somewhat_final_method_defined_in_parent_class`, you will get a `Kernel#.warn` message. 
+
+```
+WARNING: Child class 'Finalizable::Example::AClassSomeMethodsAreNotAllowedOverriding' should not override parent class method 'Finalizable::Example::ParentClass.somewhat_final_method_defined_in_parent_class'.
+```
+
+## 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/[USERNAME]/finalizable.
+
+
+## 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 'finalizable'
+
+# 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/finalizable.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'finalizable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'finalizable'
+  spec.version       = Finalizable::VERSION
+  spec.authors       = ['Shigeru Hagiwara']
+  spec.email         = ['hgwrsgr@gmail.com']
+
+  spec.summary       = %q{Preventing overriding specific methods.}
+  spec.description   = %q{This gem makes the specified method non-overridable in Ruby.}
+  spec.homepage      = 'https://rubygems.org/gems/finalizable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+   spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hgwr/finalizable/'
+  spec.metadata['changelog_uri'] = 'https://github.com/hgwr/finalizable/'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.required_ruby_version = '>= 2.4'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80.0'
+end

data/lib/finalizable.rb

@@ -0,0 +1,9 @@
+require 'finalizable/version'
+require 'finalizable/finalization'
+
+# Finalizable module
+module Finalizable
+  def self.included(klass)
+    klass.extend(Finalization)
+  end
+end

data/lib/finalizable/finalization.rb

@@ -0,0 +1,47 @@
+module Finalizable
+  # Finalizable Error class
+  class OverrideError < StandardError; end
+
+  # Class methods
+  module Finalization
+    @@final_methods = {}
+    @@somewhat_final_methods = {}
+
+    def final(*names)
+      @@final_methods[self] = names
+    end
+
+    def somewhat_final(*names)
+      @@somewhat_final_methods[self] = names
+    end
+
+    def method_added(method_name)
+      prevent_override?(method_name)
+    end
+
+    def prevent_override?(method_name)
+      raise_error_if_prohibited_methods_are_overridden(method_name)
+      warn_if_prohibited_methods_are_overridden(method_name)
+    end
+
+    def raise_error_if_prohibited_methods_are_overridden(method_name)
+      @@final_methods.each do |class_name, final_methods|
+        ancestors = self.ancestors.dup
+        ancestors.shift # remove myself from the list
+        if ancestors.include?(class_name) && final_methods.include?(method_name)
+          raise Finalizable::OverrideError, "Child class '#{self}' should not override parent class method '#{class_name}.#{method_name}'."
+        end
+      end
+    end
+
+    def warn_if_prohibited_methods_are_overridden(method_name)
+      @@somewhat_final_methods.each do |class_name, final_methods|
+        ancestors = self.ancestors.dup
+        ancestors.shift # remove myself from the list
+        if ancestors.include?(class_name) && final_methods.include?(method_name)
+          warn "WARNING: Child class '#{self}' should not override parent class method '#{class_name}.#{method_name}'."
+        end
+      end
+    end
+  end
+end

data/lib/finalizable/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: finalizable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shigeru Hagiwara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+description: This gem makes the specified method non-overridable in Ruby.
+email:
+- hgwrsgr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- finalizable.gemspec
+- lib/finalizable.rb
+- lib/finalizable/finalization.rb
+- lib/finalizable/version.rb
+- log/.keep
+homepage: https://rubygems.org/gems/finalizable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/finalizable
+  source_code_uri: https://github.com/hgwr/finalizable/
+  changelog_uri: https://github.com/hgwr/finalizable/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Preventing overriding specific methods.
+test_files: []