wireless 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15c44fc9bf9e10af9c1a9d8d0241e2a808a7dfabdadd895581271f6fa076fdbc
-  data.tar.gz: 3159342e5f335e4a9b92fd6c09556c4fbb39af17bc5fada60737e0ad3150ac0f
+  metadata.gz: ffbbea2456c108c04b1bcb959103f81a238ca8156b3d7e7390ea6c553b66dc1d
+  data.tar.gz: 6ef79cfcd3509264b9390764efbea408cfd17f098d1370808bb92eb220c65297
 SHA512:
-  metadata.gz: 0ded107266b0b9cf0d6a279a5609e102603b9e14e9a09a8b72684d5239b3bae6b61e623bf20297dba65b92d93e93f5c3a66ef5b7197b5d1030778c213eafec93
-  data.tar.gz: 22276968eb991723ced37a404b4e8aa0a805ccf3ca5b69746431712323bd3290235fd91b7535e9c59180ea82c40badfc59df8bec29ac2e93d736f2809fbf2d0d
+  metadata.gz: caf86c14536dd9ea51b3c516047f6c3c3f05d6f9dfc87e5f4c5b86d000836d5c51cc748cf2ab4771f158bdfed6413d3f580dd576b75e1a8acae75c3844360adc
+  data.tar.gz: 7508d42b402fa09f3f77c9bbed5a7c264259a536d4562746cd9e94fa666365714e38622fbe2cb22cd64b177a0da5d73c4fcd20a25a366f6f64d00377fdf049d3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.1.0 - 2020-05-18
+
+- **breaking change**: bump minimum ruby version from 2.3 -> 2.5
+- bump dependencies
+- documentation fixes
+
 ## 0.0.2 - 2018-06-17
 
 * fix import aliasing

data/README.md

@@ -3,8 +3,7 @@
 [![Build Status](https://travis-ci.org/chocolateboy/wireless.svg)](https://travis-ci.org/chocolateboy/wireless)
 [![Gem Version](https://img.shields.io/gem/v/wireless.svg)](https://rubygems.org/gems/wireless)
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<!-- toc -->
 
 - [NAME](#name)
 - [INSTALLATION](#installation)
@@ -13,6 +12,7 @@
 - [WHY?](#why)
   - [Why Wireless?](#why-wireless)
   - [Why Service Locators?](#why-service-locators)
+- [COMPATIBILITY](#compatibility)
 - [VERSION](#version)
 - [SEE ALSO](#see-also)
   - [Gems](#gems)
@@ -20,7 +20,7 @@
 - [AUTHOR](#author)
 - [COPYRIGHT AND LICENSE](#copyright-and-license)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- tocstop -->
 
 # NAME
 
@@ -87,51 +87,59 @@ which has the following features:
 
 * Simplicity
 
-    It's just an object which dependencies can be added to and retrieved from. It can
-    be passed around and stored like any other object. No "injection", no containers,
-    no framework, no dependencies.
+    It's just an object which dependencies can be added to and retrieved from.
+    It can be passed around and stored like any other object. No "injection",
+    containers, framework, or dependencies.
 
-* Inclusion
+* Convenience
 
-    Inclusion of dependency getters into a class or module with control over their visibility.
+    Include dependency getters into a class or module with control over their
+    visibility.
 
 * Laziness
 
-    As well as dependencies being resolved lazily, they can also be *registered* lazily i.e.
-    at the point of creation, rather than forcing everything to be declared up-front.
+    As well as being resolved lazily, dependencies can also be *registered*
+    lazily, i.e. at the point of creation. There's no need to declare
+    everything up front.
 
 * Safety
 
-    Dependency resolution is thread-safe. Dependency cycles are checked and raise a fatal
-    error as soon as they are detected.
+    Dependency resolution is thread-safe. Dependency cycles are checked and
+    raise a fatal error as soon as they are detected.
 
 # WHY?
 
 ## Why Wireless?
 
-I wanted a simple service locator like [DiFtw](https://github.com/jhollinger/ruby-diftw),
-with cycle detection and control over the [visibility of getters](https://github.com/jhollinger/ruby-diftw/issues/1).
+I wanted a simple service locator like
+[DiFtw](https://github.com/jhollinger/ruby-diftw), with cycle detection and
+control over the [visibility of getters](https://github.com/jhollinger/ruby-diftw/issues/1).
 
 ## Why Service Locators?
 
 Service locators make it easy to handle shared (AKA
-[cross-cutting](https://en.wikipedia.org/wiki/Cross-cutting_concern)) dependencies i.e.
-values and services that are required by multiple otherwise-unrelated parts of a system.
-Examples include:
+[cross-cutting](https://en.wikipedia.org/wiki/Cross-cutting_concern))
+dependencies i.e. values and services that are required by multiple
+otherwise-unrelated parts of a system. Examples include:
 
 * logging
 * configuration data
 * storage backends
 * authorisation
 
-Rather than wiring these dependencies together manually, service locators allow them to be
-registered and retrieved in a declarative way. This is similar to the difference between
-imperative build tools like Ant or Gulp and declarative build tools like Make or Rake, which
-allow prerequisites to be acquired on-demand, without micromanaging their construction or connections.
+Rather than wiring these dependencies together manually, service locators allow
+them to be registered and retrieved in a declarative way. This is similar to
+the difference between imperative build tools like Ant or Gulp, and declarative
+build tools like Make or Rake, which allow prerequisites to be acquired without
+coordinating their construction.
+
+# COMPATIBILITY
+
+- [Maintained ruby versions](https://www.ruby-lang.org/en/downloads/branches/)
 
 # VERSION
 
-0.0.2
+0.1.0
 
 # SEE ALSO
 
@@ -139,6 +147,7 @@ allow prerequisites to be acquired on-demand, without micromanaging their constr
 
 - [Canister](https://github.com/mlibrary/canister) - a simple service-locator inspired by Jim Weirich's [article](https://archive.li/shxeA) on Dependency Injection
 - [DiFtw](https://github.com/jhollinger/ruby-diftw) - the original inspiration for this module: a similar API with a focus on testing/mocking
+- [dry-container](https://github.com/dry-rb/dry-container) - a standalone service-locator which can also be paired with a [dependency injector](https://github.com/dry-rb/dry-auto_inject)
 
 ## Articles
 
@@ -151,7 +160,7 @@ allow prerequisites to be acquired on-demand, without micromanaging their constr
 
 # COPYRIGHT AND LICENSE
 
-Copyright © 2018 by chocolateboy.
+Copyright © 2018-2020 by chocolateboy.
 
 This is free software; you can redistribute it and/or modify it under the
-terms of the [Artistic License 2.0](http://www.opensource.org/licenses/artistic-license-2.0.php).
+terms of the [Artistic License 2.0](https://www.opensource.org/licenses/artistic-license-2.0.php).

data/lib/wireless.rb

@@ -12,7 +12,7 @@ module Wireless
   #   - retrieve a value from a key-indexed store when the key doesn't exist
   #   - write a value when the key exists and the store doesn't allow replacements
   #
-  # Can be passed a message, the receiver the lookup failed on and the key. All
+  # Can be passed a message, the receiver the lookup failed on, and the key. All
   # are optional and default to nil.
   #
   # XXX eventually (i.e. in ruby 2.6), this can be a subclass of (or replaced by)

data/lib/wireless/registry.rb

@@ -9,7 +9,7 @@ module Wireless
   # which either resolve the dependency every time (factory) or once (singleton).
   #
   # A class can be supplied instead of the block, in which case it is equivalent to
-  # a block which calls +new+ on the class e.g.:
+  # a block which calls +new+ on the class, e.g.:
   #
   #   WL = Wireless.new do
   #     on(:foo, Foo)
@@ -39,8 +39,8 @@ module Wireless
       @registry[name.to_sym] = Resolver::Factory.new(block || klass)
     end
 
-    # Returns true if a service with the specified name has been registered, false
-    # otherwise
+    # Returns true if a dependency with the specified name has been registered,
+    # false otherwise
     def include?(key)
       @registry.include?(key)
     end
@@ -52,7 +52,7 @@ module Wireless
     end
 
     # Takes an array or hash specifying the dependencies to export, and returns
-    # a module which exposes those dependencies as getters.
+    # a module which defines getters for those dependencies.
     #
     #   class Test
     #     # hash (specify visibilities)
@@ -70,7 +70,7 @@ module Wireless
     # with { visibility => imports } pairs, where imports is an array of import
     # specifiers. An import specifier is a symbol (method name == dependency name)
     # or a hash with { dependency_name => method_name } pairs (aliases). If
-    # there's only one import specifier, its enclosing array can be omitted e.g.:
+    # there's only one import specifier, its enclosing array can be omitted, e.g.:
     #
     #   include Services.mixin(private: :foo, protected: { :baz => :quux })
     #
@@ -88,8 +88,9 @@ module Wireless
         raise ArgumentError, "invalid mixin argument: expected array or hash, got: #{args.class}"
       end
 
-      # slurp each array of name (symbol) or name => alias (hash) imports into
-      # a normalized hash of { dependency_name => method_name } pairs e.g.:
+      # slurp each array of name (symbol) or name => alias (hash) import
+      # specifiers into a normalized hash of { dependency_name => method_name }
+      # pairs, e.g.:
       #
       # before:
       #
@@ -99,19 +100,10 @@ module Wireless
       #
       #   { :foo => :foo, :bar => :baz, :quux => :quux }
 
-      # XXX transform_values isn't available in ruby 2.3 and we don't want to
-      # pull in ActiveSupport just for one method (on this occasion)
-      #
-      # args = DEFAULT_EXPORTS.merge(args).transform_values do |exports|
-      #     exports = [exports] unless exports.is_a?(Array)
-      #     exports.reduce({}) do |a, b|
-      #         a.merge(b.is_a?(Hash) ? b : { b => b })
-      #     end
-      # end
-
-      args = DEFAULT_EXPORTS.merge(args).each_with_object({}) do |(key, exports), merged|
+      # XXX transform_values requires ruby >= 2.5
+      args = DEFAULT_EXPORTS.merge(args).transform_values do |exports|
         exports = [exports] unless exports.is_a?(Array)
-        merged[key] = exports.reduce({}) do |a, b|
+        exports.reduce({}) do |a, b|
           a.merge(b.is_a?(Hash) ? b : { b => b })
         end
       end

data/lib/wireless/resolver.rb

@@ -4,7 +4,7 @@ module Wireless
   # The registry is a key/value store (Hash) whose keys are symbols and whose values
   # are instances of this class. Resolvers are responsible for returning their
   # dependencies, which they do by calling their corresponding blocks. They can wrap
-  # additional behaviors around this call e.g. singletons (Wireless::Resolver::Singleton)
+  # additional behaviors around this call, e.g. singletons (Wireless::Resolver::Singleton)
   # cache the result so that the block is only called once.
   class Resolver
     def initialize(block = nil)

data/lib/wireless/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wireless
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wireless
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - chocolateboy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-17 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-power_assert
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0.83'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0.83'
 description: 
 email: chocolate@cpan.org
 executables: []
@@ -128,15 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A lightweight, declarative dependency-provider