lab42_forwarder3 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a4df121fb0576ae1e7bad90cdb6ff12b40fe8c9cf4b7ca0f26ba59abf56c5ef
+  data.tar.gz: 680b5698cb3d13062beb4ef6dd3eb92b13972277579f5a91e91b06ec68b8e7fa
+SHA512:
+  metadata.gz: 1bf1079c169db33e3693ded933c0c2c7f04a8d810617b14097e3d92c2787483bbe0da54e301f3300a50f3a04ab5c561d494fe18c58084133a285d3d7aea1c2ea
+  data.tar.gz: d088c61f2f0824530a14dcdbef9b440b2b3609a231376281e4c59d3ebd5fac63faf9b8948d5b40976d048e9829712a255a48ba906f09326caa6a5296b532bb61

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,125 @@
+
+[![Gem Version](https://badge.fury.io/rb/lab42_forwarder3.svg)](http://badge.fury.io/rb/lab42_forwarder3)
+
+# Lab42::Forwarder3 A zero cost wrapper around Forwardable, to make it readable (frankly usable).
+
+**N.B.** All these code examples are verified with [the speculate_about gem](https://rubygems.org/gems/speculate_about/)  
+
+## Quick Starting Guide
+
+Given some global data like these
+
+```ruby
+    
+    let(:a_hash) {Hash[("a".."z").zip(1..26)]}
+    let(:my_hash) {MyHash.new(a_hash)}
+```
+
+### Context The simplest case, forward without aliasing
+
+Given this nice little class
+
+```ruby
+    require "lab42/forwarder3"
+    class MyHash
+      extend Lab42::Forwarder3
+      forward :[], to: :@hash
+      def initialize hash
+        @hash = hash
+      end
+    end
+
+```
+
+Then normal `[]` access just works
+
+```ruby
+    expect(my_hash["a"]).to eq(1)
+```
+
+### Context Aliasing with `as:` 
+
+Given this extension
+
+```ruby
+    class MyHash
+      forward :fetch, to: :@hash, as: :[]
+    end
+```
+
+Then fetching works like bracket access
+
+```ruby
+    expect( my_hash.fetch("b") ).to eq(2)
+```
+
+And we get no exception in case of a missing key
+
+```ruby
+    expect( my_hash.fetch("alpha") ).to be_nil
+```
+
+## Context The very useful `def_delegators` becomes the equally useful `forward_all`
+
+Given this usage of `forward_all` 
+
+```ruby
+    class MyHash
+      forward_all :keys, :values, :size, to: :@hash
+    end
+```
+
+Then we get access to these methods as expected
+
+```ruby
+    expect( my_hash.keys ).to eq([*"a".."z"])
+    expect( my_hash.size ).to eq(26)
+    expect( my_hash.values ).to eq([*1..26])
+```
+
+## Context Of course we can delegate to methods
+
+We can also alias the rather long `Lab42::Forwarder3` into
+the global namespace as `Forwarder` as shown below
+
+Given a more complex class
+
+```ruby
+    require "lab42/forwarder3/include"
+    class Person
+      extend Forwarder
+      forward_all :[], :fetch, to: :to_h
+      forward :name_size, to: :name, as: :size
+
+      attr_reader :age, :name, :nationality
+
+      def initialize(name, age, nationality: "fr")
+        @age = age
+        @name = name
+        @nationality = nationality
+      end
+
+      def to_h
+        {
+          age: age,
+          name: name,
+          nationality: nationality
+        }
+      end
+    end
+
+    let(:myself) {Person.new("Robert", 42)}
+```
+
+Then we can access as follows:
+
+```ruby
+    expect{ myself.fetch(:gender) }.to raise_error(KeyError)
+    expect( myself.fetch(:age) ).to eq(42)
+    expect( myself.name_size ).to eq(6)
+```
+# LICENSE
+
+Copyright 2020 Robert Dober robert.dober@gmail.com
+
+Apache-2.0 [c.f LICENSE](LICENSE)

data/lib/lab42/forwarder3.rb

@@ -0,0 +1,21 @@
+require_relative "forwarder3/implementation"
+require "forwardable"
+module Lab42
+  module Forwarder3
+    def self.extended by
+      by.extend Forwardable
+    end
+
+    extend Forwardable
+    def forward(mthd_name, to:, as: nil)
+      as ||= mthd_name
+      Implementation.define_forwarder(mthd_name, to: to, as: as, receiver: self)
+    end
+
+    def forward_all(*mthd_names, to:)
+      mthd_names.each do |mthd_name|
+        forward mthd_name, to: to
+      end
+    end
+  end
+end

data/lib/lab42/forwarder3/implementation.rb

@@ -0,0 +1,12 @@
+module Lab42
+  module Forwarder3
+    module Implementation extend self
+      def define_forwarder(mthd_name, to:, as:, receiver:)
+        receiver.def_delegator to, as, mthd_name 
+      end
+
+      private
+
+    end
+  end
+end

data/lib/lab42/forwarder3/include.rb

@@ -0,0 +1,2 @@
+require_relative "../forwarder3"
+Forwarder = Lab42::Forwarder3

data/lib/lab42/forwarder3/version.rb

@@ -0,0 +1,5 @@
+module Lab42
+  module Forwarder3
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: lab42_forwarder3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Dober
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies: []
+description: Forwarder3 a readable and zero cost API around Forwardable
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/lab42/forwarder3.rb
+- lib/lab42/forwarder3/implementation.rb
+- lib/lab42/forwarder3/include.rb
+- lib/lab42/forwarder3/version.rb
+homepage: https://bitbucket.org/robertdober/lab42_forwarder3
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Forwarder3 a readable zero cost API around Forwardable
+test_files: []