lab42_open_map 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48f632ae67cd9d116fb9bc918c1f24f6eacccf50629b2cfb74251887aab3797c
+  data.tar.gz: fef6938854f3895786503f0b13e78c84be136f31cfcd7cf06650a621c87e1e88
+SHA512:
+  metadata.gz: b9407f0c3a9aadecee79621cd64e214c1b73a75d1f912ab822ea688eb6135869f1b2e135c3cef408c8d61ad26b044c82a2ee3aaaa434b989bbffa8dd68c32a31
+  data.tar.gz: d7e8b2fc4fc217640995e4af1b10d5de504d1b17bb13a87abafa3aa51e962162d6719876518b6adb31b5259a0369c2b128e2a3280af3bc7ba8afc9eab9ae7de5

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,131 @@
+[![Gem Version](https://badge.fury.io/rb/lab42_open_map.svg)](http://badge.fury.io/rb/lab42_open_map)
+
+# Lab42::OpenMap
+
+OpenMap = OpenStruct with a rich Map API
+
+**N.B.** All these code examples are verified with [the speculate_about gem](https://rubygems.org/gems/speculate_about/)  
+
+## Context Quick Starting Guide
+
+Given an `OpenMap` 
+```ruby
+    require "lab42/open_map/include" # aliases Lab42::OpenMap as OpenMap
+    let(:pet) { OpenMap.new }
+```
+
+Then we can see that it can be empty
+```ruby
+    expect( pet ).to be_empty
+```
+
+And that we can add fields like to a hash
+
+```ruby
+    pet[:name] = "Furfur"
+    expect( pet[:name] ).to eq("Furfur")
+```
+
+However we are **not** a hash.
+
+Example: Only Symbol Keys please
+
+```ruby
+    expect{ pet["name"] = nil }.to raise_error(ArgumentError, %{"name" is not a symbol})
+```
+
+And that holds for construction too
+
+```ruby
+    expect{ OpenMap.new("verbose" => false) }
+      .to raise_error(ArgumentError, %{the following keys are not symbols: ["verbose"]})
+```
+
+But many `Hash` methods are applicable to `OpenMap` 
+
+Given that
+
+```ruby
+    let (:dog) {OpenMap.new(name: "Rantanplan", breed: "You are kidding?")}
+```
+Then we can access it like a hash
+```ruby
+    expect( dog.keys ).to eq(%i[name breed])
+    expect( dog.values ).to eq(["Rantanplan", "You are kidding?"])
+    expect( dog.size ).to eq(2)
+    expect( dog.map.to_a ).to eq([[:name, "Rantanplan"], [:breed, "You are kidding?"]])
+```
+
+And we can use slice and get a nice counterpart `without` 
+
+```ruby
+    expect( dog.slice(:name) ).to eq(name: "Rantanplan")
+    expect( dog.slice(:name, :breed) ).to eq(name: "Rantanplan", breed: "You are kidding?")
+    expect( dog.without(:breed) ).to eq(name: "Rantanplan")
+    expect( dog.without(:name, :breed) ).to eq({})
+```
+
+And last, but certainly not least: _Named Access_
+```ruby
+    expect(dog.name).to eq("Rantanplan") 
+    dog.breed = "still unknown"
+    expect( dog.values ).to eq(["Rantanplan", "still unknown"])
+```
+
+## Context All About Named Access
+
+Given the same dog again
+```ruby
+    let (:dog) {OpenMap.new(name: "Rantanplan", breed: "You are kidding?")}
+```
+
+Then we cannot access a nonexistant field by name
+```ruby
+    expect{ dog.age }.to raise_error(NoMethodError, %r{\Aundefined method `age' for})
+```
+
+And we cannot create a new one either
+```ruby
+    expect{ dog.age = 10 }.to raise_error(NoMethodError, %r{\Aundefined method `age' for})
+```
+
+But we still can create new fields with `[]=` or update
+```ruby
+    dog.update( age: 10 ) 
+    expect( dog.age ).to eq(10)
+```
+And of course the `update` method preserves our symbol keys only property
+```ruby
+    expect{ dog.update("verbose" => true)  } 
+      .to raise_error(ArgumentError, %{the following keys are not symbols: ["verbose"]})
+```
+
+## Context Methods that create new `OpenMap` objects
+
+Given a cat now, cannot risk losing half of the pet loving community ;)
+```ruby
+  let(:garfield) {OpenMap.new(name: "Garfield", yob: 1976, creator: "Jim Davis")} # Yes under a differnt name, but still
+  let!(:nermal) { garfield.merge(name: "Nermal", yob: 1979)}
+```
+Then exactly the following can be certified
+```ruby
+    expect( nermal ).to be_kind_of(OpenMap)
+    expect( garfield.values ).to eq(["Garfield", 1976, "Jim Davis"])
+    expect( nermal.values ).to eq(["Nermal", 1979, "Jim Davis"])
+```
+
+We also have a counterpart to `without`, called `sans`
+And with `sans` we get this
+
+```ruby
+    partial_garfield = garfield.sans(:yob, :creator) 
+    expect( partial_garfield.to_h ).to eq(name: "Garfield")
+    expect( garfield.values ).to eq(["Garfield", 1976, "Jim Davis"])
+```
+
+
+# LICENSE
+
+Copyright 2020 Robert Dober robert.dober@gmail.com
+
+Apache-2.0 [c.f LICENSE](LICENSE)

data/lib/lab42/open_map.rb

@@ -0,0 +1,18 @@
+require "lab42/forwarder3/include"
+require_relative "./open_map/implementation"
+module Lab42
+  class OpenMap
+    extend Forwarder
+    forward_all :[], :empty?, :has_key?, :inject, :keys, :map, :reduce, :size, :slice, :values, to: :@hash
+
+    include Implementation
+
+    private
+
+    def initialize(**kwds)
+      _check_symbolic_keys!(kwds)
+      @hash = kwds 
+    end
+  end
+end
+

data/lib/lab42/open_map/implementation.rb

@@ -0,0 +1,56 @@
+
+module Lab42
+  class OpenMap
+    module Implementation
+      def []=(key, value)
+        raise ArgumentError, "#{key.inspect} is not a symbol" unless Symbol === key
+        @hash[key] = value
+      end
+
+      def merge(**kwds)
+        _check_symbolic_keys!(kwds)
+        self.class.new(**@hash.merge(kwds))
+      end
+
+      def sans(*keys)
+        self.class.new(without(*keys))
+      end
+
+      def update(**kwds)
+        _check_symbolic_keys!(kwds)
+        @hash.update(kwds)
+      end
+
+      def to_h
+        @hash.clone
+      end
+
+      def without(*keys)
+        ( self.keys - keys.flatten )
+          .inject( {} ) do |r, k|
+            r.update(k => self[k])
+          end
+      end
+
+      private
+
+      def _check_symbolic_keys!(kwds)
+        invalid_kwds = kwds.keys.reject{Symbol === _1}
+        raise ArgumentError, "the following keys are not symbols: #{invalid_kwds.inspect}" unless
+          invalid_kwds.empty?
+      end
+
+      def method_missing(name, *args)
+        assignment = name[-1] == "="
+        name = name[0..-2].to_sym if assignment
+        super unless has_key?(name)
+        if assignment
+          raise ArgumentError, "assignment needs a value" if args.empty?
+          self[name] = args.first
+        else
+          self[name]
+        end
+      end
+    end
+  end
+end

data/lib/lab42/open_map/include.rb

@@ -0,0 +1,2 @@
+require_relative "../open_map"
+OpenMap = Lab42::OpenMap

data/lib/lab42/open_map/version.rb

@@ -0,0 +1,7 @@
+module Lab42
+  class OpenMap
+    class << self
+      def version; "0.1.0" end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: lab42_open_map
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Dober
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lab42_result
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: lab42_forwarder3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: 'OpenMap = OpenStruct with a rich API, e.g. #merge, #slice, #without,...'
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/lab42/open_map.rb
+- lib/lab42/open_map/implementation.rb
+- lib/lab42/open_map/include.rb
+- lib/lab42/open_map/version.rb
+homepage: https://bitbucket.org/robertdober/lab42_open_map
+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: OpenMap = OpenStruct with rich Map API
+test_files: []