spaced 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ee2fb1875b3430e05c8c415823ae7ea872a15a515b1a9c2516e0f641e85951
-  data.tar.gz: 659031771e54f892c823e65f1b3fab58eb2ada0ceec407dbcaec146497a1062d
+  metadata.gz: 496fc25b4cc4a7b4d8332661ace97b36a26ee5cb9592bfeb06e1743483c47c3b
+  data.tar.gz: 96b4ddf6c1c5e89ead4f894ced1f71c2b2a671c7838766572f94f85462bedf82
 SHA512:
-  metadata.gz: 212bae85a0fdcf3dbdfc717e29328fd7fd8f8401b80082fec88464e03efe1d9adf07e24bb156f9b850c65104807d7cddf53343ea2582c30d8eb164b5b3cc921f
-  data.tar.gz: 979e2988cdefc614aeb3ff884434f747fa1e5ebce38bb1de9212695ea9b53410e60b0cd72a4ba28054ce6d4689ee4088c3e4d7e9c3053124eb819f19f663b028
+  metadata.gz: 4751df5962de7c88361b534dff26007baeed5a91bd8a4f796aa75d6ff31f5a48c10c8b9dc8d53528af00f9089cc8bc8865b3c97b209227cb5c9dab96f84f4c33
+  data.tar.gz: eb9fd26c2e44f605bf9c9f733b22263ff86a0f5fd4d8003fe1457544b3a4b2a7f08ac13b3132a7447230c3017aab6c1c4bce5d407ee4bc56d53a6fc4dd86f8ef

data/.rubocop.yml

@@ -14,6 +14,6 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
 Style/Documentation:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spaced (0.1.1)
+    spaced (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,24 +1,32 @@
 # 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
-    namespace :twitter do
-        def create(msg)
-            api.create_tweet msg
-        end
-
-        def read(id)
-            api.read_tweet id
-        end
+  include Spaced
 
-        private
+  # Pass a black with a bunch of methods.
+  namespace :twitter do
+    def create(msg)
+      api.create_tweet msg
+    end
 
-            def api
-                @api ||= TwitterClient.new(api_token: parent.api_token)
-            end
+    def read(id)
+      api.read_tweet id
     end
+
+    private
+
+      def api
+        @api ||= TwitterClient.new(api_token: parent.api_token)
+      end
+  end
+
+  # Or pass a predefined class, which should subclass `Spaced::Base`.
+  namespace :facebook, Facebook::Api
 end
 
 user = User.new
@@ -28,6 +36,37 @@ user.twitter.read(id)
 
 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 `call` method in your namespaced class, you can then conveniently call that with a bang method:
+
+```ruby
+class User < Spaced::Base
+  include Spaced
+
+  namespace :tweet do
+    def call(content)
+      create_tweet content
+    end
+  end
+end
+
+user = User.new
+user.tweet!('my new tweet') # Will call the `#call` method with whatever arguments you give it.
+```
+
+There is also an equivalent `predicate` method:
+
+```ruby
+namespace :tweet do
+  def predicate
+    false
+  end
+end
+user = User.new
+user.tweet? # Will call the `#predicate` method.
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/spaced/version.rb

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

data/lib/spaced.rb

@@ -15,14 +15,18 @@ module Spaced
 
   module ClassMethods
     def namespace(name, klass = nil, &)
-      unless klass
+      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
 
       inst_name = :"@#{name}"
+
+      # Define the memoized namespace method.
       define_method name do
         if instance_variable_defined?(inst_name)
           instance_variable_get inst_name
@@ -32,6 +36,28 @@ module Spaced
           instance_variable_set inst_name, cls
         end
       end
+
+      # Define the bang and predicate methods.
+      methods = klass.instance_methods(false)
+
+      if methods.include?(:call)
+        module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}!(...); #{name}.call(...); end # def user!(...); user.call(...); end
+        RUBY
+      else
+        define_method :"#{name}!" do
+          raise NoMethodError, "undefined method `#{name}!' for #<#{klass}>. Have you defined `#{klass}#call`?", caller
+        end
+      end
+
+      if methods.include?(:predicate)
+        define_method(:"#{name}?") { send(name).predicate }
+      else
+        define_method :"#{name}?" do
+          raise NoMethodError, "undefined method `#{name}?' for #<#{klass}>. Have you defined `#{klass}#predicate`?",
+                caller
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spaced
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email: