use_context 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fefdb2f5210efd1e2cc56fe41dc465cb61aa711fc658f29d606221335dfcaa51
-  data.tar.gz: 4e429a7afe8d22962dc58109379fbf85cc8135d1713ed1d30b25ce7f16fa1222
+  metadata.gz: f4c30166e7e8f3c7a661205455d9095e632f31a349ed72213b80876730c89ab9
+  data.tar.gz: 7e38977774ad56f2ab3465088fb800137553b7d97037b126cb548fc64218fb1e
 SHA512:
-  metadata.gz: c05082dfc9a79b6f92504d2f1a5928abae3b3fb7d2c38fba6c8c617031d80e0afe5d93dd21c4fe2d07e8fef00420c68fc6e3da824813e762f6f8cae439ce1ad1
-  data.tar.gz: fe5474e402f9bf88b3d1f9738c46b2cb07884adee0cfd9314c5a6273a959a93169375b7097a068b867f30bf421e86af447393ec43756a6b2a0e3cab583616358
+  metadata.gz: 01ec5bb17b6bf570b9114a482180b8b3946f902fae756670d457803fd2b9b067d1cf1999138c97d214e0a46fbdeadc170b0a7acea140f9f2209d84bc6b36fadf
+  data.tar.gz: 216cfa9b71450937b76c00513f08901cf22c6b5744fde6df9978592fbc530328aa7c0cbeaf92230b03a53a21408ef5a20ae455d16193d5f9c69d1063bbaab94b

data/CHANGELOG.md

@@ -1,2 +1,11 @@
+# 1.1.0
+* `use_context` now treats all argments after the context name as context keys to extract and yield to the block:
+    ```ruby
+    use_context(:foo, :bar, :baz) do |bar, baz|
+      # ...
+    end
+    ```
+* Documentation updated to describe the new behavior of `use_context` as well as how to use the library as a mixin on a per-class or per-module basis.
+
 # 1.0.0
 * Birthday!

data/README.md

@@ -10,7 +10,7 @@ use_context was inspired by this use-case, and originally proposed as an additio
 
 ## Usage
 
-There are three ways to use this gem. As some folks are understandably uncomfortable using monkeypatches - especially ones applied to core classes and modules - you are free to choose the one that fits your preferences.
+There are four ways to use this gem. As some folks are understandably uncomfortable using monkeypatches - especially ones applied to core classes and modules - you are free to choose the one that fits your preferences.
 
 ### As a monkeypatch
 
@@ -55,6 +55,28 @@ provide_context(:welcome, { salutation: "Hello, world!" }) do
 end
 ```
 
+### As a mixin
+
+If you'd rather opt-in to use_context's methods on a per-class or per-module basis, you can include the `ContextMethods` mixin:
+
+```ruby
+require "use_context"
+
+class MyClass
+  include UseContext::ContextMethods
+
+  def speak
+    use_context(:welcome) do |context|
+      puts context[:salutation]
+    end
+  end
+end
+
+UseContext.provide_context(:welcome, { salutation: "Hello, world!" }) do
+  MyClass.new.speak  # prints "Hello, world!"
+end
+```
+
 ### No magic
 
 If you'd rather avoid modifying `Kernel` altogether, use_context can also be used via the `UseContext` constant.
@@ -89,6 +111,18 @@ provide_context(:welcome, { salutation: "Hello, world!" }) do
 end
 ```
 
+## Extracting individual keys
+
+The `use_context` method allows extracting individual keys from the current context. All arguments after the context name are treated as keys to extract. The extracted values are passed to the block in the order they are specified:
+
+```ruby
+provide_context(:welcome, { salutation: "Hello", recipient: "world" }) do
+  use_context(:welcome, :salutation, :recipient) do |salutation, recipient|
+    puts "#{salutation}, #{recipient}!"  # prints "Hello, world!"
+  end
+end
+```
+
 ## Running Tests
 
 `bundle exec rake` should do the trick.

data/lib/use_context/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UseContext
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/use_context.rb

@@ -21,6 +21,14 @@ module UseContext
     def [](_key)
       nil
     end
+
+    def empty?
+      true
+    end
+
+    def present?
+      false
+    end
   end
 
   class Context
@@ -37,6 +45,14 @@ module UseContext
 
       nil
     end
+
+    def empty?
+      false
+    end
+
+    def present?
+      true
+    end
   end
 
   class ContextStack
@@ -65,8 +81,14 @@ module UseContext
       context.pop if context
     end
 
-    def use_context(name)
-      yield UseContext.context[name]&.context || EmptyContext.instance
+    def use_context(name, *keys)
+      context = UseContext.context[name]&.context || EmptyContext.instance
+
+      if keys.empty?
+        yield context
+      else
+        yield keys.map { |key| context[key] }
+      end
     end
   end
 

data/test/kernel_test.rb

@@ -100,4 +100,13 @@ class KernelTest < Minitest::Test
       end
     end
   end
+
+  def test_use_context_can_extract_given_keys
+    provide_context(:test, { setting1: :a, setting2: :b }) do
+      use_context(:test, :setting1, :setting2) do |setting1, setting2|
+        assert_equal :a, setting1
+        assert_equal :b, setting2
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: use_context
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Cameron Dutro