subclass_must_implement 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be7eacd344df936c6557036eed810d353b476445
+  data.tar.gz: f7c20318294fc06bb3ff92a2776d81f7cc8fb5d6
+SHA512:
+  metadata.gz: 5de082a47ac63d76765acfa7bbb2777c7a067ba91861903862dd4b2430b380fd0addbe3d79bdf809780861b124cbbc8f9d3043dce4b8cc3814cd23925a91ebeb
+  data.tar.gz: 3aec63e7c84a7983315504ff8e0fefd81ade0bc02bf4555f2f81891e5b4ee4e97dda9a2a2157b71a36f571c2580b778aa56b80cca191c2e2a1a9ec13567e2af2

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--profile
+--backtrace
+--format documentation
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+subclass_must_implement

data/.simplecov

@@ -0,0 +1,35 @@
+require "simplecov-rcov-text"
+require "colorize"
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::RcovTextFormatter,
+  SimpleCov::Formatter::HTMLFormatter
+])
+
+SimpleCov.start do
+  add_filter "/spec/"
+
+  # Fail the build when coverage is < 100%:
+  at_exit do
+    SimpleCov.result.format!
+    actual = SimpleCov.result.covered_percent
+    if actual < 100 then # FAIL
+      msg = "\nLow coverage: "
+      msg << "#{actual}%".colorize(:red)
+      msg << " is " << "under".colorize(:red) << " the threshold: "
+      msg << "#{100}%.".colorize(:green)
+      msg << "\n"
+      $stderr.puts msg
+      exit 1
+    else # PASS
+      # Precision: three decimal places:
+      actual_trunc = (actual * 1000).floor / 1000.0
+      msg = "\nCoverage: "
+      msg << "#{actual}%".colorize(:green)
+      msg << " is " << "at".colorize(:green) << " the threshold: "
+      msg << "#{100}%.".colorize(:green)
+      msg << "\n"
+      $stdout.puts msg
+    end
+  end
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 HornsAndHooves
+
+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 @@
+# SubclassMustImplement
+
+There are circumstances when it is desirable to specify certain methods as abstract, i.e. it is the responsibility of any subclass to implement them.
+Getting a `MethodMIssing` is not helpful; an error that explicitly explains that the missing method is required by contract will save much time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'subclass_must_implement'
+
+And then execute:
+
+    $ bundle
+
+Or install yourself as:
+
+    $ gem install subclass_must_implement
+
+## Usage
+
+Either `include SubclassMustImplement` or `extend SubclassMustImplement` in your base class.
+Then call `subclass_must_implement` with a list of required method names as symbols.
+You can optionally pass in a custom error message using the `err_message` named argument.
+
+Example 1:
+
+```ruby
+class BaseFoo
+  include SubclassMustImplement
+
+  subclass_must_implement :foo, :bar, :baz
+end
+
+class Foo < BaseFoo
+  def foo
+    :foo
+  end
+end
+
+f = Foo.new
+f.foo # returns :foo
+f.bar # raises a NotImplementedError that "bar" must be implemented in the subclass
+f.baz # raises a NotImplementedError that "baz" must be implemented in the subclass
+f.qux # raises a MethodMissing
+```
+
+Example 2:
+
+```ruby
+class BaseBar
+  extend SubclassMustImplement
+
+  subclass_must_implement :foo, :bar, err_message: "Version expected!!!"
+end
+
+class Bar < BaseBar
+  def bar
+    :bar
+  end
+end
+
+b = Bar.new
+b.bar # return :bar
+b.foo # raises a NotImplementedError with the specified error message "Version expected!!!"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/subclass_must_implement/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
+6. Make sure all the test pass and your changes have test coverage!

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

data/lib/subclass_must_implement.rb

@@ -0,0 +1,74 @@
+# Either `include SubclassMustImplement` or `extend SubclassMustImplement` in your base class.
+# Then call `subclass_must_implement` with a list of required method names as symbols.
+# You can optionally pass in a custom error message using the `err_message` named argument.
+#
+# Example 1:
+#
+#   class BaseFoo
+#     include SubclassMustImplement
+#
+#     subclass_must_implement :foo, :bar, :baz
+#   end
+#
+#   class Foo < BaseFoo
+#     def foo
+#       :foo
+#     end
+#   end
+#
+#   f = Foo.new
+#   f.foo # returns :foo
+#   f.bar # raises a NotImplementedError that "bar" must be implemented in the subclass
+#   f.baz # raises a NotImplementedError that "baz" must be implemented in the subclass
+#   f.qux # raises a MethodMissing
+#
+# Example 2:
+#
+#   class BaseBar
+#     extend SubclassMustImplement
+#
+#     subclass_must_implement :foo, :bar, err_message: "Version expected!!!"
+#   end
+#
+#   class Bar < BaseBar
+#     def bar
+#       :bar
+#     end
+#   end
+#
+#   b = Bar.new
+#   b.bar # return :bar
+#   b.foo # raises a NotImplementedError with the specified error message "Version expected!!!"
+#
+module SubclassMustImplement
+
+  # Injects the `subclass_must_implement` macro
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # Injects the `subclass_must_implement` macro
+  def self.extended(base)
+    base.extend ClassMethods
+  end
+
+  # Returns the Gem version as a string
+  def self.version
+    "0.0.1"
+  end
+
+  # The class level macros are defined here.
+  module ClassMethods
+
+    # Defines a method for each method name that raises a NotImplementedError when called.
+    # Pass in a custom error message if desired using the err_message named argument.
+    def subclass_must_implement(*method_names, err_message: nil)
+      method_names.each do |method_name|
+        err = err_message.nil? ? "`#{method_name}` must be implemented in a subclass." : "#{err_message}"
+        define_method method_name do |*_|
+          raise NotImplementedError, err
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+require 'simplecov'
+SimpleCov.start
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/subclass_must_implement_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+RSpec.describe SubclassMustImplement do
+
+  class BaseFoo
+    include SubclassMustImplement
+
+    subclass_must_implement :foo, :bar, :baz
+  end
+
+  class Foo < BaseFoo
+    def foo
+      :foo
+    end
+  end
+
+  class BaseBar
+    extend SubclassMustImplement
+
+    subclass_must_implement :version, :sub_version, err_message: "Version expected!!!"
+  end
+
+  class Bar < BaseBar
+    def version
+      SubclassMustImplement.version
+    end
+  end
+
+  let(:foo) { Foo.new }
+  let(:bar) { Bar.new }
+
+  context "module included" do
+    it "will raise a not implemented error if any required method is not implemented in the subclass" do
+      expect { foo.bar }.to raise_error(NotImplementedError, "`bar` must be implemented in a subclass.")
+      expect { foo.baz }.to raise_error(NotImplementedError, "`baz` must be implemented in a subclass.")
+    end
+
+    it "will not raise an error if a requred method is implemented by the subclass" do
+      expect(foo.foo).to eq(:foo)
+    end
+  end
+
+  context "module extended" do
+    it "will raise a not implemented error if any required method is not implemented in the subclass" do
+      expect { bar.sub_version }.to raise_error(NotImplementedError, "Version expected!!!")
+    end
+
+    it "will not raise an error if a requred method is implemented by the subclass" do
+      expect(bar.version).to eq(described_class.version)
+    end
+  end
+end

data/subclass_must_implement.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subclass_must_implement'
+
+Gem::Specification.new do |spec|
+  spec.name          = "subclass_must_implement"
+  spec.version       = SubclassMustImplement.version
+  spec.authors       = ["Arthur Shagall"]
+  spec.email         = ["arthur.shagall@gmail.com"]
+  spec.summary       = %q{Make abstract methods explicit.}
+  spec.description   = %q{Auto-generate abstract method stubs to mark them as required to be implemented in subclasses.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov-text"
+  spec.add_development_dependency "colorize"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: subclass_must_implement
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arthur Shagall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov-text
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: Auto-generate abstract method stubs to mark them as required to be implemented
+  in subclasses.
+email:
+- arthur.shagall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".simplecov"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/subclass_must_implement.rb
+- spec/spec_helper.rb
+- spec/subclass_must_implement_spec.rb
+- subclass_must_implement.gemspec
+homepage: ''
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Make abstract methods explicit.
+test_files:
+- spec/spec_helper.rb
+- spec/subclass_must_implement_spec.rb