super_module 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 192ef511f9395d9d90d7110a154602a4c62a47c5287cfaf9662456be09c84712
-  data.tar.gz: c4233e47af1355abff03878070f2916175aa1c399deb3a2e696b5fb18351dbef
+  metadata.gz: dff7a317bbcdd55b3df13bf0a29b263708a97c52044a07df8009256cc98f5b55
+  data.tar.gz: 961629e60023945619be8b5ed0221cb6313529670dd563bc0afd8d947edc3618
 SHA512:
-  metadata.gz: f1cd9c156c81762b287a4eb67b1b0b1bff5a27cd0325e3baef9b0fe2da7b77a3ecfb948c21ed99c295e6c020858c0c2c0a507dd8c9c232f80b6abc07b539cf17
-  data.tar.gz: 11973559c530a77b64f1d04bdd15964f73549f1b3a3f7fc93d694b503f35cfcacbdacbbf74602b2ea371b02d70137ab26b663756e7ab4d753bb19f0910df752f
+  metadata.gz: 8df9bbb3bede461f3b069d37b7305c06509cfc17eb2b31117c45cccc478a0d6db8116ff7ef3abcf5312f3dfcf51570c693bb6bdfecf818c0b36061b9d2a84923
+  data.tar.gz: 882725ee1e32a31fba2801c5811051259be139028d612e45b254a1ea05fc33cbbee162c7c297826fd185a66eae364485edc43399589fae0770454168eb9b2e20

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.4.2
+
+- Relax method_source gem dependency to `">= 0.8.2", "< 2.0.0"`
+
 ## 1.4.1
 
 - Pauses singleton method recording inside a super_module_included block to avoid replaying on submodules

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Andy Maleh
+Copyright (c) 2014-2024 Andy Maleh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,12 @@
-# <img src="https://raw.githubusercontent.com/AndyObtiva/super_module/master/SuperModule.jpg" alt="SuperModule" align="left" height="50" /> &nbsp; SuperModule 1.4.0
+# <img src="https://raw.githubusercontent.com/AndyObtiva/super_module/master/SuperModule.jpg" alt="SuperModule" align="left" height="50" /> &nbsp; SuperModule 1.4.2
 [![Gem Version](https://badge.fury.io/rb/super_module.svg)](http://badge.fury.io/rb/super_module)
-[![Build Status](https://api.travis-ci.org/AndyObtiva/super_module.svg?branch=master)](https://travis-ci.org/AndyObtiva/super_module)
 [![Coverage Status](https://coveralls.io/repos/AndyObtiva/super_module/badge.svg?branch=master)](https://coveralls.io/r/AndyObtiva/super_module?branch=master)
 [![Code Climate](https://codeclimate.com/github/AndyObtiva/super_module.svg)](https://codeclimate.com/github/AndyObtiva/super_module)
 
+(Note: despite the advanced version number, the idea of super_module is highly experimental and relies heavily on meta-programming, so unless you really need it, always prefer using pure Ruby modules when sufficient)
+
+[SuperModule](https://rubygems.org/gems/super_module) enables developers to continue to use Ruby modules as first-class citizens with mixin inheritance even when wanting to inherit singleton-class methods and invocations.
+
 Calling [Ruby](https://www.ruby-lang.org/en/)'s [`Module#include`](http://ruby-doc.org/core-2.2.1/Module.html#method-i-include) to mix in a module does not bring in class methods by default. This can come as quite the surprise when attempting to include class methods via a module.
 
 Ruby offers one workaround in the form of implementing the hook method [`Module.included(base)`](http://ruby-doc.org/core-2.2.1/Module.html#method-i-included) [following a certain boilerplate code idiom](http://www.railstips.org/blog/archives/2009/05/15/include-vs-extend-in-ruby/). Unfortunately, it hinders code maintainability and productivity with extra unnecessary complexity, especially in production-environment projects employing many [mixins](http://en.wikipedia.org/wiki/Mixin) (e.g. modeling business domain models with composable object [traits](http://en.wikipedia.org/wiki/Trait_(computer_programming))).
@@ -12,12 +15,14 @@ Another workaround is [`ActiveSupport::Concern`](http://api.rubyonrails.org/clas
 
 But do not fear, [SuperModule](https://rubygems.org/gems/super_module) comes to the rescue! By declaring your module as a SuperModule, it will simply behave as one would expect and automatically include class methods along with instance methods, without any further work needed.
 
-Used in my other project: [Glimmer](https://github.com/AndyObtiva/Glimmer) (Ruby Desktop GUI Library)
+Used in my other project: [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) (JRuby Desktop Development GUI Framework)
+
+Works in both [Ruby](https://www.ruby-lang.org) and [JRuby](https://www.jruby.org).
 
 ## Introductory Comparison
 
 To introduce [SuperModule](https://rubygems.org/gems/super_module), here is a comparison of three different approaches for writing a
-<code>UserIdentifiable</code> module, which includes ActiveModel::Model module as an in-memory alternative to ActiveRecord::Base superclass (Side-note: ActiveModel::Model is not needed when extending ActiveRecord::Base to connect to database.)
+`UserIdentifiable` module, which includes ActiveModel::Model module as an in-memory alternative to `ActiveRecord::Base` superclass.
 
 #### 1) [self.included(base)](http://ruby-doc.org/core-2.2.1/Module.html#method-i-included)
 
@@ -71,7 +76,7 @@ module UserIdentifiable
 end
 ```
 
-A step forward that addresses the boiler-plate repetitive code concern, but is otherwise really just lipstick on a pig. To explain more, developer problem solving and creativity flow is still disrupted by having to think about the lower-level mechanism of running code on inclusion (using `included`) and structuring class methods in an extra sub-module (`ClassMethods`) instead of simply declaring class methods like they normally would in Ruby and staying focused on the task at hand.
+A step forward that addresses the boiler-plate repetitive code concern, but is otherwise no more than putting a band-aid on the problem. To explain more, developer problem solving and creativity flow is still disrupted by having to think about the lower-level mechanism of running code on inclusion (using `included`) and structuring class methods in an extra sub-module (`ClassMethods`) instead of simply declaring class methods like they normally would in Ruby and staying focused on the task at hand.
 
 #### 3) [SuperModule](https://github.com/AndyObtiva/super_module)
 
@@ -98,13 +103,15 @@ As a result, [SuperModule](https://rubygems.org/gems/super_module) collapses the
 
 In other words, [SuperModule](https://rubygems.org/gems/super_module) furthers Ruby's goal of making programmers happy.
 
+P.S. this library intentionally avoids bad techniques like "eval" of entire module body since they do not maintain Module mixin inheritance support. SuperModule supports full Ruby module mixin inheritance as it does not change it, yet only adds automation for singleton-class method inheritance on top of it (via surgical class_eval instead of full eval). SuperModule in fact encourages developers to continue to rely on basic Ruby code like `include SuperModule`.
+
 ## Instructions
 
 #### 1) Install and require gem
 
 <b>Using [Bundler](http://bundler.io/)</b>
 
-Add the following to Gemfile: <pre>gem 'super_module', '1.4.1'</pre>
+Add the following to Gemfile: <pre>gem 'super_module', '1.4.2'</pre>
 
 And run the following command: <pre>bundle</pre>
 
@@ -371,7 +378,7 @@ puts V1::FakeExtraSummarizedActiveRecord.fake_extra
 
 ## Limitations
 
-1) [SuperModule](https://rubygems.org/gems/super_module) by definition has been designed to be used only in the initial code declaration of a module, not later mixing or re-opening of a module.
+[SuperModule](https://rubygems.org/gems/super_module) by definition has been designed to be used only in the initial code declaration of a module, not later mixing or re-opening of a module.
 
 ## Change Log
 
@@ -382,11 +389,10 @@ puts V1::FakeExtraSummarizedActiveRecord.fake_extra
 [SuperModule](https://rubygems.org/gems/super_module) is written in a very clean and maintainable test-first approach, so you are welcome to read through the code on GitHub for more in-depth details:
 https://github.com/AndyObtiva/super_module
 
-The library is quite new and can use all the feedback and help it can get. So, please do not hesitate to add comments if you have any, and please fork [the project on GitHub](https://github.com/AndyObtiva/super_module#fork-destination-box) in order to [make contributions via Pull Requests](https://github.com/AndyObtiva/super_module/pulls).
+The library is quite novel and can use all the feedback and help it can get. So, please do not hesitate to add comments if you have any, and please fork [the project on GitHub](https://github.com/AndyObtiva/super_module#fork-destination-box) in order to [make contributions via Pull Requests](https://github.com/AndyObtiva/super_module/pulls).
 
 ## Articles, Publications, and Blog Posts
  * 2015-04-05 - [Ruby Weekly](http://rubyweekly.com): [Issue 240](http://rubyweekly.com/issues/240)
- * 2015-03-27 - [AirPair](http://www.airpair.com) Article: [Step aside ActiveSupport::Concern. SuperModule is the new sheriff in town!](https://www.airpair.com/ruby/posts/step-aside-activesupportconcern-supermodule-is-the-new-sheriff-in-town)
  * 2014-03-27 - [Code Painter](http://andymaleh.blogspot.com) Blog Post: [Ruby SuperModule Comes To The Rescue!!](http://andymaleh.blogspot.ca/2014/03/ruby-supermodule-comes-to-rescue.html)
 
 ## TODO
@@ -395,5 +401,4 @@ None
 
 ## Copyright
 
-Copyright (c) 2014-2020 Andy Maleh. See LICENSE.txt for
-further details.
+Copyright (c) 2014-2024 Andy Maleh. See [LICENSE.txt](LICENSE.txt) for further details.

data/TODO.md

@@ -0,0 +1,32 @@
+# TODO
+
+- Make replay of class method invocations optional (allow for a basic use case of simply including a module with class methods)
+- Replay class level attributes on classes
+- Fix issue with class methods including a method matching name with instance methods
+- Fix issue with class method alias as per details below
+
+```ruby
+require 'glimmer/error'
+
+module Glimmer
+  module UI
+    module CustomShell
+      include SuperModule
+      include Glimmer::UI::CustomWidget
+      
+      class << self
+        attr_reader :launched_custom_shell
+        alias launched_custom_window launched_custom_shell
+```
+
+```
+[DEVELOPMENT MODE] (detected /Users/andymaleh/code/glimmer-dsl-swt/lib/glimmer-dsl-swt.rb)
+MethodSource::SourceNotFoundError: Could not locate source for launched_custom_window!
+                         source_helper at /Users/andymaleh/.rvm/gems/jruby-9.2.14.0@glimmer-dsl-swt/gems/method_source-1.0.0/lib/method_source.rb:24
+                                source at /Users/andymaleh/.rvm/gems/jruby-9.2.14.0@glimmer-dsl-swt/gems/method_source-1.0.0/lib/method_source.rb:110
+  __build_singleton_method_body_source at /Users/andymaleh/.rvm/gems/jruby-9.2.14.0@glimmer-dsl-swt/gems/super_module-1.4.1/lib/super_module/v1/singleton_method_definition_store.rb:74
+               __singleton_method_body at /Users/andymaleh/.rvm/gems/jruby-9.2.14.0@glimmer-dsl-swt/gems/super_module-1.4.1/lib/super_module/v1/singleton_method_definition_store.rb:85
+                singleton_method_added at /Users/andymaleh/.rvm/gems/jruby-9.2.14.0@glimmer-dsl-swt/gems/super_module-1.4.1/lib/super_module/v1/singleton_method_definition_store.rb:100
+                          alias_method at org/jruby/RubyModule.java:3228
+                       singleton class at /Users/andymaleh/code/glimmer-dsl-swt/lib/glimmer/ui/custom_shell.rb:32
+```

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.4.2

data/lib/super_module.rb

@@ -1,7 +1,7 @@
 # SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base).
 #
 # Author::    Andy Maleh
-# Copyright:: Copyright (c) 2014-2015 Andy Maleh
+# Copyright:: Copyright (c) 2014-2024 Andy Maleh
 # License::   MIT License
 
 # This module allows defining class methods and method invocations the same way a super class does without using def included(base).

data/super_module.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: super_module 1.4.1 ruby lib
+# stub: super_module 1.4.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "super_module".freeze
-  s.version = "1.4.1"
+  s.version = "1.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2020-04-23"
+  s.date = "2024-07-28"
   s.description = "SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base). This also succeeds ActiveSupport::Concern by offering lighter syntax".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "SuperModule.jpg",
+    "TODO.md",
     "VERSION",
     "lib/super_module.rb",
     "lib/super_module/v1.rb",
@@ -39,44 +40,31 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/AndyObtiva/super_module".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.8".freeze
+  s.rubygems_version = "3.3.5".freeze
   s.summary = "SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base). This also succeeds ActiveSupport::Concern by offering lighter syntax".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<method_source>.freeze, [">= 0.8.2", "< 1.1.0"])
-      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.0"])
-      s.add_development_dependency(%q<rdoc>.freeze, ["~> 4.2.0"])
-      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2.0"])
-      s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.8.1"])
-      s.add_development_dependency(%q<rake>.freeze, ["~> 10.4.2"])
-      s.add_development_dependency(%q<rack>.freeze, ["~> 1.6.5"])
-      s.add_development_dependency(%q<nokogiri>.freeze, ["~> 1.6.8.1"])
-      s.add_development_dependency(%q<tins>.freeze, ["~> 1.6.0"])
-      s.add_development_dependency(%q<term-ansicolor>.freeze, ["~> 1.3.2"])
-    else
-      s.add_dependency(%q<method_source>.freeze, [">= 0.8.2", "< 1.1.0"])
-      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.0"])
-      s.add_dependency(%q<rdoc>.freeze, ["~> 4.2.0"])
-      s.add_dependency(%q<rspec>.freeze, ["~> 3.2.0"])
-      s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.8.1"])
-      s.add_dependency(%q<rake>.freeze, ["~> 10.4.2"])
-      s.add_dependency(%q<rack>.freeze, ["~> 1.6.5"])
-      s.add_dependency(%q<nokogiri>.freeze, ["~> 1.6.8.1"])
-      s.add_dependency(%q<tins>.freeze, ["~> 1.6.0"])
-      s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3.2"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<method_source>.freeze, [">= 0.8.2", "< 2.0.0"])
+    s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.0"])
+    s.add_development_dependency(%q<rdoc>.freeze, ["~> 4.2.0"])
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2.0"])
+    s.add_development_dependency(%q<puts_debuggerer>.freeze, ["> 0.8.1"])
+    s.add_development_dependency(%q<rake>.freeze, ["~> 10.4.2"])
+    s.add_development_dependency(%q<rack>.freeze, ["~> 1.6.5"])
+    s.add_development_dependency(%q<tins>.freeze, ["~> 1.6.0"])
+    s.add_development_dependency(%q<term-ansicolor>.freeze, ["~> 1.3.2"])
   else
-    s.add_dependency(%q<method_source>.freeze, [">= 0.8.2", "< 1.1.0"])
+    s.add_dependency(%q<method_source>.freeze, [">= 0.8.2", "< 2.0.0"])
     s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.0"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 4.2.0"])
     s.add_dependency(%q<rspec>.freeze, ["~> 3.2.0"])
-    s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.8.1"])
+    s.add_dependency(%q<puts_debuggerer>.freeze, ["> 0.8.1"])
     s.add_dependency(%q<rake>.freeze, ["~> 10.4.2"])
     s.add_dependency(%q<rack>.freeze, ["~> 1.6.5"])
-    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.6.8.1"])
     s.add_dependency(%q<tins>.freeze, ["~> 1.6.0"])
     s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3.2"])
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_module
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Andy Maleh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2024-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -19,7 +19,7 @@ dependencies:
         version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -76,14 +76,14 @@ dependencies:
   name: puts_debuggerer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !ruby/object:Gem::Dependency
@@ -114,20 +114,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.5
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.8.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.8.1
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +145,7 @@ dependencies:
 description: SuperModule allows defining class methods and method invocations the
   same way a super class does without using def included(base). This also succeeds
   ActiveSupport::Concern by offering lighter syntax
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -172,6 +158,7 @@ files:
 - LICENSE.txt
 - README.md
 - SuperModule.jpg
+- TODO.md
 - VERSION
 - lib/super_module.rb
 - lib/super_module/v1.rb
@@ -188,7 +175,7 @@ homepage: http://github.com/AndyObtiva/super_module
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.3.5
+signing_key:
 specification_version: 4
 summary: SuperModule allows defining class methods and method invocations the same
   way a super class does without using def included(base). This also succeeds ActiveSupport::Concern