interface 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18281c8114d3b757199e7543898a927f573404884441c247621fa9c62a1b885c
-  data.tar.gz: ae6875d98a263ea3a9f4c307f387a4a08e2b0653598b8b0fd998c1edcc3830c5
+  metadata.gz: 7f12f52d0bb291fe96e86776130cfc7aedb5741520160057f675c0f04bb73e4f
+  data.tar.gz: 279405e1b859fdd0e71cf8d5cd1b253ec056eb2a80f82203b132dc4bc3d0934d
 SHA512:
-  metadata.gz: fb334ed632f47adabade8d4f7ed2735d08d36e60f8429cc1b5a84b021577fb6a639df7bb553f79a9892c62d7f21f1d53df244a974464f091dae78115cbf0020e
-  data.tar.gz: 65256c8d37452d793ad72ce10583d96dea8a32f1a9484ab53bf049e9f99e0c376352e1996989655a195352c63cd2e33ee72791cffa3e161f3bab4fd0fadb3605
+  metadata.gz: d6ca7f3b16edbe729c20ac3c62d602fa15afab6a7723ed955244c8cab8ec5272025f2663096981ff9e832199f8c477af56683ab4f3a2dcd288b329ae3a704051
+  data.tar.gz: ead9f3702e3983f4509b01ec92cc3f7326b8a80601ab03663dfa5a3ae98a5a9b81c1c790b249de2ae150734efb28913930b56fb1ff17b4f977260ba632694b33

data/{CHANGES → CHANGES.md}

@@ -1,30 +1,45 @@
-== 1.0.4 - 8-Jan-2016
-* This gem is now signed.
-* The gem related tasks in the Rakefile now assume Rubygems 2.x.
-
-== 1.0.3 - 12-Oct-2014
-* Rakefile, gemspec and README updates.
-
-== 1.0.2 - 7-Oct-2009
-* Fixed packaging bug in the gemspec, and made some other minor changes.
-* Added the 'gem' rake task.
-* Updated copyright and license in the README.
-
-== 1.0.1 - 29-Jul-2009
-* Now compatible with Ruby 1.9.x.
-* Replaced the install.rb with a Rakefile and various tasks.
-* Updated the license to Artistic 2.0.
-* Added test-unit 2.x as a development dependency and refactored the test
-  suite to take advantage of some of its features.
-* Renamed the test file to test_interface.rb.
-* Renamed the example programs to all start with 'example_' to avoid any
-  possible confusion with actual test suites.
-* Added rake tasks for running the example programs.
-* Updated and refactored the gemspec.
-
-== 1.0.0 - 5-Jun-2005
-* Re-released on RubyForge.
-* Some test suite and doc changes.
-
-== 0.1.0 - 9-May-2004
-* Initial release
+## 1.2.0 - 8-Jul-2025
+* Updated to use deferred method declaration validation. This means you
+  no longer have to define methods before including the interface.
+* Additional specs and example added.
+
+## 1.1.0 - 4-May-2022
+* Switch from test-unit to rspec.
+
+## 1.0.5 - 26-Oct-2019
+* Now assumes Ruby 2.
+* Updated cert.
+* Fixed missing hyphen in license name.
+* Added metadata to the gemspec.
+* The VERSION constant is now frozen.
+
+## 1.0.4 - 8-Jan-2016
+* This gem is now signed.
+* The gem related tasks in the Rakefile now assume Rubygems 2.x.
+
+## 1.0.3 - 12-Oct-2014
+* Rakefile, gemspec and README updates.
+
+## 1.0.2 - 7-Oct-2009
+* Fixed packaging bug in the gemspec, and made some other minor changes.
+* Added the 'gem' rake task.
+* Updated copyright and license in the README.
+
+## 1.0.1 - 29-Jul-2009
+* Now compatible with Ruby 1.9.x.
+* Replaced the install.rb with a Rakefile and various tasks.
+* Updated the license to Artistic 2.0.
+* Added test-unit 2.x as a development dependency and refactored the test
+  suite to take advantage of some of its features.
+* Renamed the test file to test_interface.rb.
+* Renamed the example programs to all start with 'example_' to avoid any
+  possible confusion with actual test suites.
+* Added rake tasks for running the example programs.
+* Updated and refactored the gemspec.
+
+## 1.0.0 - 5-Jun-2005
+* Re-released on RubyForge.
+* Some test suite and doc changes.
+
+## 0.1.0 - 9-May-2004
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,72 @@
+Copyright (c) 2000-2006, The Perl Foundation.
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
+
+Definitions
+“Copyright Holder” means the individual(s) or organization(s) named in the copyright notice for the entire Package.
+
+“Contributor” means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder’s procedures.
+
+“You” and “your” means any person who would like to copy, distribute, or modify the Package.
+
+“Package” means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
+
+“Distribute” means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
+
+“Distributor Fee” means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees.
+
+“Standard Version” refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
+
+“Modified Version” means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder.
+
+“Original License” means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future.
+
+“Source” form means the source code, documentation source, and configuration files for the Package.
+
+“Compiled” form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
+
+Permission for Use and Modification Without Distribution
+(1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
+
+Permissions for Redistribution of the Standard Version
+(2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
+
+(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
+
+Distribution of Modified Versions of the Package as Source
+(4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
+
+(a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
+(b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
+(c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
+(i) the Original License or
+(ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
+
+Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
+(5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license.
+
+(6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version.
+
+Aggregating or Linking the Package
+(7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
+
+Items That are Not Considered Part of a Modified Version
+(9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license.
+
+General Provisions
+(10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
+
+(11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
+
+(12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
+
+(13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
+
+(14) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS “AS IS’ AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/{MANIFEST → MANIFEST.md}

@@ -1,12 +1,13 @@
-* CHANGES
-* MANIFEST
-* README
-* Rakefile
-* interface.gemspec
-* certs/djberg96_pub.pem
-* examples/example_instance.rb
-* examples/example_interface.rb
-* examples/example_sub.rb
-* examples/example_unrequire.rb
-* lib/interface.rb
-* test/test_interface.rb
+* CHANGES.md
+* LICENSE
+* MANIFEST.md
+* README.md
+* Rakefile
+* interface.gemspec
+* certs/djberg96_pub.pem
+* examples/example_instance.rb
+* examples/example_interface.rb
+* examples/example_sub.rb
+* examples/example_unrequire.rb
+* lib/interface.rb
+* spec/interface_spec.rb

data/README.md

@@ -0,0 +1,91 @@
+[![Ruby](https://github.com/djberg96/interface/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/interface/actions/workflows/ruby.yml)
+
+## Description
+This library provides Java style interfaces for Ruby.
+
+## Installation
+`gem install interface`
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/interface/main/certs/djberg96_pub.pem)`
+
+## Synopsis
+```ruby
+require 'interface'
+
+MyInterface = interface do
+  required_methods :foo, :bar, :baz
+end
+
+# Raises an error until 'baz' is defined
+class MyClass
+  implements MyInterface
+
+  def foo
+    puts "foo"
+  end
+
+  def bar
+    puts "bar"
+  end
+
+  # Uncomment to work
+  # def baz; end
+end
+```
+   
+## General Notes
+Subinterfaces work as well. See the test_sub.rb file under the 'test'
+directory for a sample.
+
+## Developer's Notes
+A discussion on IRC with Mauricio Fernandez got us talking about traits.
+During that discussion I remembered a blog entry by David Naseby. I 
+revisited his blog entry and took a closer look:
+
+http://ruby-naseby.blogspot.com/2008/11/traits-in-ruby.html
+
+Keep in mind that I also happened to be thinking about Java at the moment
+because of a recent job switch that involved coding in Java. I was also
+trying to figure out what the purpose of interfaces were.
+
+As I read the first page of David Naseby's article I realized that,
+whether intended or not, he had implemented a rudimentary form of interfaces
+for Ruby. When I discovered this, I talked about it some more with Mauricio
+and he and I (mostly him) fleshed out the rest of the module, including some
+syntax improvements. The result is syntax and functionality that is nearly
+identical to Java.
+
+I should note that, although I am listed as the author, this was mostly the
+combined work of David Naseby and Mauricio Fernandez. I just happened to be
+the guy that put it all together.
+
+In more recent versions this code was enhanced with the help of AI.
+Specifically, it was updated to use the TracePoint interface so that an
+interface could be declared at the top of the class, with the method
+validations deferred.
+
+## Acknowledgements
+This module was largely inspired and somewhat copied from a post by
+David Naseby (see URL above). It was subsequently modified almost entirely
+by Mauricio Fernandez through a series of discussions on IRC, and later
+by evil AI bots that will eventually kill us all.
+
+## See Also
+The Crystal programming language, which has syntax very similar to Ruby's,
+effectively implements interfaces via the `abstract` keyword.
+	
+## Copyright
+(C) 2004-2025 Daniel J. Berger
+All rights reserved.
+	
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+	
+## License
+Artistic-2.0
+	
+## Author
+Daniel J. Berger

data/Rakefile

@@ -1,16 +1,16 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
   desc "Create the interface gem"
   task :create => [:clean] do 
     require 'rubygems/package'
-    spec = eval(IO.read('interface.gemspec'))
+    spec = Gem::Specification.load('interface.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the interface gem"
@@ -42,9 +42,12 @@ namespace :example do
   end
 end
 
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
+
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
 end
 
-task :default => :test
+task :default => :spec

data/examples/enhanced_features_demo.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative '../lib/interface'
+
+puts "=== Interface Library Improvements Demo ==="
+puts
+
+# 1. Enhanced Error Messages
+puts "1. Enhanced Error Messages:"
+puts "-" * 40
+
+PaymentInterface = interface do
+  required_methods :process_payment, :validate_payment, :send_receipt
+end
+
+class IncompletePaymentProcessor
+  def process_payment
+    puts "Processing payment..."
+  end
+  # Missing validate_payment and send_receipt methods
+end
+
+begin
+  IncompletePaymentProcessor.include PaymentInterface
+rescue Interface::MethodMissing => e
+  puts "Error caught with enhanced details:"
+  puts "  Missing methods: #{e.missing_methods.join(', ')}"
+  puts "  Target class: #{e.target_name}"
+  puts "  Interface: #{e.interface_name}"
+  puts "  Full message: #{e.message}"
+end
+
+puts
+
+# 2. Interface Introspection
+puts "2. Interface Introspection:"
+puts "-" * 40
+
+StorageInterface = interface do
+  required_methods :save, :load, :delete
+end
+
+puts "Required methods: #{StorageInterface.get_required_methods}"
+
+# 3. Sub-interface with unrequired methods
+puts "3. Sub-interface with selective requirements:"
+puts "-" * 40
+
+ReadOnlyStorageInterface = interface do
+  extend StorageInterface
+  unrequired_methods :save, :delete
+end
+
+puts "Original interface requires: #{StorageInterface.get_required_methods}"
+puts "Read-only interface requires: #{ReadOnlyStorageInterface.get_required_methods}"
+puts "Read-only interface unrequires: #{ReadOnlyStorageInterface.get_unrequired_methods}"
+
+# 4. Interface Satisfaction Checking
+puts "4. Interface Satisfaction Checking:"
+puts "-" * 40
+
+class FileStorage
+  def save; puts "Saving to file"; end
+  def load; puts "Loading from file"; end
+  def delete; puts "Deleting file"; end
+end
+
+class ReadOnlyFileStorage
+  def load; puts "Loading from file"; end
+end
+
+puts "FileStorage satisfies StorageInterface: #{StorageInterface.satisfied_by?(FileStorage)}"
+puts "ReadOnlyFileStorage satisfies StorageInterface: #{StorageInterface.satisfied_by?(ReadOnlyFileStorage)}"
+puts "ReadOnlyFileStorage satisfies ReadOnlyStorageInterface: #{ReadOnlyStorageInterface.satisfied_by?(ReadOnlyFileStorage)}"
+
+# 5. Complex inheritance hierarchy
+puts "5. Complex Interface Inheritance:"
+puts "-" * 40
+
+BaseInterface = interface do
+  required_methods :initialize_connection, :close_connection
+end
+
+AuthenticatedInterface = interface do
+  extend BaseInterface
+  required_methods :authenticate, :authorize
+end
+
+DatabaseInterface = interface do
+  extend AuthenticatedInterface
+  required_methods :query, :transaction
+  unrequired_methods :authorize  # Don't require authorization for this specific interface
+end
+
+puts "BaseInterface requires: #{BaseInterface.get_required_methods}"
+puts "AuthenticatedInterface requires: #{AuthenticatedInterface.get_required_methods}"
+puts "DatabaseInterface requires: #{DatabaseInterface.get_required_methods}"
+
+# 6. String to symbol conversion
+puts "6. Automatic String to Symbol Conversion:"
+puts "-" * 40
+
+StringInterface = interface do
+  required_methods 'string_method', 'another_string_method'
+end
+
+puts "Methods defined with strings: #{StringInterface.get_required_methods}"
+
+puts
+puts "=== Demo Complete ==="

data/examples/example_interface.rb

@@ -5,16 +5,16 @@
 # run this example via the 'rake example:interface' task. Modify this
 # code as you see fit.
 #######################################################################
-require 'interface'
+require_relative '../lib/interface'
 
 MyInterface = interface{
   required_methods :foo, :bar
 }
 
 class MyClass
+  include MyInterface
   def foo; end
   def bar; end
-  include MyInterface
 end
 
 =begin

data/interface.gemspec

@@ -1,34 +1,35 @@
-require 'rubygems'
-
-Gem::Specification.new do |spec|
-  spec.name       = 'interface'
-  spec.version    = '1.0.5'
-  spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Artistic-2.0'
-  spec.email      = 'djberg96@gmail.com'
-  spec.homepage   = 'http://github.com/djberg96/interface'
-  spec.summary    = 'Java style interfaces for Ruby'
-  spec.test_file  = 'test/test_interface.rb'
-  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
-  spec.cert_chain = Dir['certs/*']
-
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
-
-  spec.add_development_dependency('test-unit')
-  spec.add_development_dependency('rake')
-
-  spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/interface',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/interface/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/interface/blob/master/CHANGES',
-    'documentation_uri' => 'https://github.com/djberg96/interface/wiki',
-    'source_code_uri'   => 'https://github.com/djberg96/interface',
-    'wiki_uri'          => 'https://github.com/djberg96/interface/wiki'
-  }
-
-  spec.description = <<-EOF
-    The interface library implements Java style interfaces for Ruby.
-    It lets you define a set a methods that must be defined in the
-    including class or module, or an error is raised.
-  EOF
-end
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name       = 'interface'
+  spec.version    = '1.2.0'
+  spec.author     = 'Daniel J. Berger'
+  spec.license    = 'Artistic-2.0'
+  spec.email      = 'djberg96@gmail.com'
+  spec.homepage   = 'http://github.com/djberg96/interface'
+  spec.summary    = 'Java style interfaces for Ruby'
+  spec.test_file  = 'spec/interface_spec.rb'
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') || f.include?('misc') }
+  spec.cert_chain = Dir['certs/*']
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+
+  spec.metadata = {
+    'homepage_uri'          => 'https://github.com/djberg96/interface',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/interface/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/interface/blob/main/CHANGES.md',
+    'documentation_uri'     => 'https://github.com/djberg96/interface/wiki',
+    'source_code_uri'       => 'https://github.com/djberg96/interface',
+    'wiki_uri'              => 'https://github.com/djberg96/interface/wiki',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/interface',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96',
+  }
+
+  spec.description = <<-EOF
+    The interface library implements Java style interfaces for Ruby.
+    It lets you define a set a methods that must be defined in the
+    including class or module, or an error is raised.
+  EOF
+end