spaced 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be5f8b778afea6200764ac30e9588cd76ebedd1e6414c3abf7c2b57fadf9fc1
-  data.tar.gz: 01de2584949b4f50211847ba3a2fd11081f7d2e8b30769117d6016ed665596c7
+  metadata.gz: a2da420b63a66615b4f9227fb1064c16e443b120ac506b1ebaeb820ddfb80216
+  data.tar.gz: 0b52d7dd0de000a0895a98f42d1cac4e1a5fb426b1865eb48c923fecc40c4654
 SHA512:
-  metadata.gz: 29031788d5ab97c24364206b47583f63d37ed9f2186b541cd10003d7cdfd94f96711d638b485823085d400301d4e8c37302b587f40d4ee1e2cb4a674c2a3e6b6
-  data.tar.gz: f0854fa0e2813f899fc32b85e57c72b1f44845aa4574f7c419ce5e7ba5f65ad0dfd5b07e4c6de55f2514b95da1abd51627bbec0c0363e936a650a0ace847e06b
+  metadata.gz: e5c2ebb06e5298dcdfb3e9d4654fb3397e5d91c32cfd7a2bac1f2426f23d7f256fba70f948a7ccc5adcbb9dd5728db76acec16b05b7803f07f18f33a997d8326
+  data.tar.gz: 5e745b116152c80528a3f3c2c585a826925edff33458a368188d992ba3f86883950f2016c53d5fb9e8cf1d7e47d222d5ccda0c8910545562e1c3436263e9ba57

data/.rubocop.yml

@@ -1,6 +1,5 @@
 AllCops:
   TargetRubyVersion: 3.1.0
-  SuggestExtensions: false
   NewCops: enable
 
 Style/StringLiterals:
@@ -15,5 +14,8 @@ Layout/LineLength:
   Max: 120
 Metrics/MethodLength:
   Max: 20
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*
 Style/Documentation:
-  Enabled: false
+  Enabled: false

data/Gemfile

@@ -5,8 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in spaced.gemspec
 gemspec
 
-gem "minitest", "~> 5.0"
-gem "minitest-focus"
 gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-minitest"
+gem "rubocop-rake"
+gem "sus", group: :test

data/Gemfile.lock

@@ -1,48 +1,55 @@
 PATH
   remote: .
   specs:
-    spaced (0.2.0)
+    spaced (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    minitest (5.15.0)
-    minitest-focus (1.3.1)
-      minitest (>= 4, < 6)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.4.0)
-    rexml (3.2.5)
-    rubocop (1.30.0)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rubocop (1.58.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
-      rubocop (>= 0.90, < 2.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.33.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    sus (0.24.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
-  minitest (~> 5.0)
-  minitest-focus
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-minitest
+  rubocop-rake
   spaced!
+  sus
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,6 +1,8 @@
 # Spaced
 
-Spaced is a super simple and convenient way to isolate and namespace a collection of related methods.
+Spaced is a super simple and convenient way to isolate and namespace a collection of related methods into any class.
+
+## Usage
 
 ```ruby
 class User
@@ -16,14 +18,6 @@ class User
       api.read_tweet id
     end
 
-    def call(msg)
-      create msg
-    end
-
-    def predicate
-      subject.twitter_id?
-    end
-
     private
 
       def api
@@ -38,12 +32,58 @@ end
 user = User.new
 id = user.twitter.create("Spaced man!")
 user.twitter.read(id)
-user.twitter!("Spaced man!") # calls the `call` method.
-user.twitter? # calls the `predicate` method.
 ```
 
 In the example above, `namespace` creates and initializes a new class `Twitter` and returns it from the `#twitter` method. The parent class - in this case `User` - is available at `#parent` and `@parent` from within the namespace.
 
+## Magic bang and predicate methods
+
+If you define a `#_!` or `#call` method in your namespaced class, you can then conveniently call that with a bang method:
+
+```ruby
+class User
+  include Spaced
+
+  namespace :tweet do
+    def _!(content)
+      create_tweet content
+    end
+  end
+end
+
+user = User.new
+user.tweet!('my new tweet') # Will call the `#_!` method with whatever arguments you give it.
+```
+
+There is also an equivalent predicate method:
+
+```ruby
+namespace :tweet do
+  def _?
+    false
+  end
+end
+user = User.new
+user.tweet? # Will call the `#predicate` method.
+```
+
+Both bang and predicate methods can be defined using identically named methods:
+
+```ruby
+namespace :tweet do
+  def tweet?
+    false
+  end
+
+  def tweet!
+    # ...
+  end
+end
+user = User.new
+user.tweet? # Will call the `#tweet?` method on `:tweet` namespace.
+user.tweet! # Will call the `#tweet!` method on `:tweet` namespace.
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rubocop/rake_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+task :test do
+  sh "bundle exec sus"
 end
 
-require "rubocop/rake_task"
-
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]

data/fixtures/daddy.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Daddy < Spaced::Base
+  def full_name
+    "Kevin Moss"
+  end
+end

data/fixtures/test_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "spaced"
+require "bundler"
+
+Bundler.require :test
+
+require "daddy"
+require "user"

data/fixtures/user.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class User
+  include Spaced
+
+  namespace :mum do
+    def full_name
+      "Lesley Moss"
+    end
+  end
+
+  namespace :dad, Daddy
+  namespace :brother do
+    def call(append = nil)
+      "Andy Moss#{append}"
+    end
+
+    def predicate
+      true
+    end
+  end
+
+  namespace :sister do
+    def sister!(append = nil)
+      "Alex Moss#{append}"
+    end
+
+    def sister?
+      true
+    end
+  end
+
+  namespace :mother do
+    def _!(append = nil)
+      "Lesley Moss#{append}"
+    end
+
+    def _?
+      true
+    end
+  end
+end

data/lib/spaced/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spaced
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/spaced.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "spaced/version"
-require "forwardable"
 
 module Spaced
   def self.included(base)
@@ -15,12 +14,12 @@ module Spaced
   end
 
   module ClassMethods
-    def namespace(name, klass = nil, &)
+    def namespace(name, klass = nil, &) # rubocop:disable Metrics/*
       if klass
         raise "#{klass} must be a subclass of Spaced::Base" unless klass < Spaced::Base
       else
         class_name = name.to_s.split("_").collect(&:capitalize).join
-        klass = eval <<-RUBY, binding, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
+        klass = module_eval <<-RUBY, __FILE__, __LINE__ + 1
         #{self}::#{class_name} = Class.new(Base, &)  # Parent::Namespace = Class.new(Base, &)
         RUBY
       end
@@ -41,21 +40,42 @@ module Spaced
       # Define the bang and predicate methods.
       methods = klass.instance_methods(false)
 
-      if methods.include?(:call) || methods.include?(:predicate)
-        extend Forwardable
-        def_delegator :"#{name}", :call, :"#{name}!" if methods.include?(:call)
-        def_delegator :"#{name}", :predicate, :"#{name}?" if methods.include?(:predicate)
+      if methods.include?(:_!)
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}!(...); #{name}._!(...); end # def user!; user._!; end
+        RUBY
+      elsif methods.include?(:"#{name}!")
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}!(...); #{name}.#{name}!(...); end # def user!; user.user!; end
+        RUBY
+      elsif methods.include?(:call) # DEPRECATED
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}!(...); #{name}.call(...); end # def user!(...); user.call(...); end
+        RUBY
       else
-        unless methods.include?(:call)
-          define_method :"#{name}!" do
-            raise NoMethodError, "undefined method `#{name}!' for #<#{klass}>. Have you defined `#{klass}#call`?"
-          end
+        define_method :"#{name}!" do
+          raise NoMethodError,
+                "undefined method `#{name}!' for #<#{klass}>. Have you defined `#{klass}#_!`?", caller
         end
+      end
 
-        unless methods.include?(:predicate)
-          define_method :"#{name}?" do
-            raise NoMethodError, "undefined method `#{name}?' for #<#{klass}>. Have you defined `#{klass}#predicate`?"
-          end
+      if methods.include?(:_?)
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}?; #{name}._?; end # def user?; user._?; end
+        RUBY
+      elsif methods.include?(:"#{name}?")
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}?; #{name}.#{name}?; end # def user?; user.user?; end
+        RUBY
+      elsif methods.include?(:predicate) # DEPRECATED
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}?; #{name}.predicate; end # def user?; user.predicate; end
+        RUBY
+      else
+        define_method :"#{name}?" do
+          raise NoMethodError,
+                "undefined method `#{name}?' for #<#{klass}>. Have you defined `#{klass}#_?`?",
+                caller
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spaced
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -24,6 +24,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fixtures/daddy.rb
+- fixtures/test_helper.rb
+- fixtures/user.rb
 - lib/spaced.rb
 - lib/spaced/version.rb
 - sig/spaced.rbs
@@ -50,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Super simple and convenient way to isolate and namespace a collection of