dio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5248afd5e7856dc4e15f32792e9da724a03a664b734b09608244eed54fc04796
+  data.tar.gz: 4149b6a58f5f62d9003a856f322bf61e0f22167bcf53d13afdef2f3262ea738b
+SHA512:
+  metadata.gz: 515b2931c3cfb2299917348e7bd143ebb705f1966d7ad771273b03b17ed4ef1ed1490bbeff36b21ea31ea9d079d1aa1484bcb02a63a285cebad52d80b2ddec4e
+  data.tar.gz: fdbeaffb6bcaaf5f380fc1834bc14ebd2ddb92a1355a91a4f3bbb2e5cda7aa054f4ba034e0beb3dd1dafce9beec4a53a23d35545b1e36e91edda007ec7fd3bd9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at keystonelemur@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dio.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    dio (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dio!
+  guard-rspec
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brandon Weaver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Dio - Dive Into Objects!
+
+Dio, or "Dive Into Objects", is a wrapper for Ruby objects that do not have a
+Pattern Matching interface defined, but have methods which make them able to
+implement an approximation of it:
+
+```ruby
+Dio[1] in { succ: { succ: { succ: 4 } } }
+# => true
+```
+
+Using this interface we can even pattern match against arbitrary objects by
+treating the pattern match keys as method calls to "dive into" an object to
+match against it.
+
+## Usage
+
+Further usage instructions will be documented at a later date, see
+`spec/dio_spec.rb` for ideas in the mean time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dio
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/baweaver/dio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dio project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/baweaver/dio/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dio.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dio/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dio"
+  spec.version       = Dio::VERSION
+  spec.authors       = ["Brandon Weaver"]
+  spec.email         = ["keystonelemur@gmail.com"]
+
+  spec.summary       = %q{Dive Into Objects - Pattern matching extension for plain old Ruby objects}
+  spec.homepage      = "https://www.github.com/baweaver/dio"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/dio.rb

@@ -0,0 +1,9 @@
+require 'dio/version'
+require 'dio/public_api'
+require 'dio/errors'
+require 'dio/dive_forwarder'
+
+module Dio
+  extend PublicApi
+  extend Errors
+end

data/lib/dio/dive_forwarder.rb

@@ -0,0 +1,129 @@
+require 'delegate'
+
+module Dio
+  # Allows for Pattern Matching against arbitrary objects by wrapping them
+  # in an interface that understands methods of deconstructing objects.
+  #
+  # **Approximating Deconstruction**
+  #
+  # As Ruby does not, by default, define `deconstruct` and `deconstruct_keys` on
+  # objects this class attempts to approximate them.
+  #
+  # This class does, however, do something unique in treating `deconstruct_keys`
+  # as a series of calls to sent to the class and its "nested" values.
+  #
+  # **Demonstrating Nested Values**
+  #
+  # Consider an integer:
+  #
+  # ```ruby
+  # Dio[1] in { succ: { succ: { succ: 4 } } }
+  # # => true
+  # ```
+  #
+  # It has no concept of deconstruction, except in that its `succ` method returns
+  # a "nested" value we can match against, allowing us to "dive into" the
+  # object, diving us our namesake Dio, or "Dive Into Object"
+  #
+  # **Delegation**
+  #
+  # As with most monadic-like design patterns that add additional behavior by
+  # wrapping objects we need to extract the value at the end to do anything
+  # particularly useful.
+  #
+  # By adding delegation to this class we have a cheat around this in that
+  # any method called on the nested DiveForwarder instances will call through
+  # to the associated base object instead.
+  #
+  # I am not 100% sold on this approach, and will consider it more in the
+  # future.
+  #
+  # @author [baweaver]
+  #
+  class DiveForwarder < ::Delegator
+    # Wrapper for creating a new DiveForwarder
+    NEW_DIVE = -> v { DiveForwarder.new(v) }
+
+    # Creates a new delegator that understands the pattern matching interface
+    #
+    # @param base_object [Any]
+    #   Any object that does not necessarily understand pattern matching
+    #
+    # @return [DiveForwarder]
+    def initialize(base_object)
+      @base_object = base_object
+    end
+
+    # Approximation of an Array deconstruction:
+    #
+    # ```ruby
+    # [1, 2, 3] in [*, 2, *]
+    # ```
+    #
+    # Attempts to find a reasonable interface by which to extract values
+    # to be matched. If an object that knows how to match already is sent
+    # through wrap its child values for deeper matching.
+    #
+    # Current interface will work with `to_a`, `to_ary`, `map`, and values
+    # that can already `deconstruct`. If others are desired please submit a PR
+    # to add them
+    #
+    # @raises [Dio::Errors::NoDeconstructionMethod]
+    #   If no method of deconstruction exists, an exception is raised to
+    #   communicate the proper interface and note the abscense of a current one.
+    #
+    # @return [Array[DiveForwarder]]
+    #   Values lifted into a Dio context for further matching
+    def deconstruct
+      return @base_object.deconstruct.map!(&NEW_DIVE) if @base_object.respond_to?(:deconstruct)
+
+      return @base_object.to_a.map!(&NEW_DIVE) if @base_object.respond_to?(:to_a)
+      return @base_object.to_ary.map!(&NEW_DIVE) if @base_object.respond_to?(:to_ary)
+      return @base_object.map(&NEW_DIVE) if @base_object.respond_to?(:map)
+
+      raise Dio::Errors::NoDeconstructionMethod
+    end
+
+    # Approximates `deconstruct_keys` for Hashes, except in adding `Qo`-like
+    # behavior that allows to treat objects as "nested values" through their
+    # method calls.
+    #
+    # **Deconstructing an Object**
+    #
+    # In `Qo` one could match against an object by calling to its methods using
+    # `public_send`. This allowed one to "dive into" an object through a series
+    # of method calls, approximating a Hash pattern match.
+    #
+    # **Native Behavior**
+    #
+    # If the object already responds to `deconstruct_keys` this method will
+    # behave similarly to `deconstruct` and wrap its values as new
+    # `DiveForwarder` contexts.
+    #
+    # @param keys [Array]
+    #   Keys to be extracted from the object
+    #
+    # @return [Hash]
+    #   Deconstructed keys pointing to associated values extracted from a Hash
+    #   or an Object. Note that these values are matched against using `===`.
+    def deconstruct_keys(keys)
+      if @base_object.respond_to?(:deconstruct_keys)
+        @base_object
+          .deconstruct_keys(*keys)
+          .transform_values!(&NEW_DIVE)
+      else
+        keys.to_h { |k| @base_object.public_send(k).then { |v| [k, NEW_DIVE[v]] } }
+      end
+    end
+
+    # Unwrapped context, aliased afterwards to use Ruby's delegator interface
+    #
+    # @return [Any]
+    #   Originally wrapped object
+    def value
+      @base_object
+    end
+
+    alias_method :__getobj__, :value
+  end
+end

data/lib/dio/errors.rb

@@ -0,0 +1,15 @@
+module Dio
+  module Errors
+    # Error raised when no deconstruction method is available on an object being
+    # treated like an Array deconstruction.
+    #
+    # @author [baweaver]
+    # @since 0.0.1
+    class NoDeconstructionMethod < StandardError
+      # Error message
+      MSG = 'Object provided no method of deconstruction (to_a, to_ary, map, Enumerable)'
+
+      def initialize(msg=MSG) = super
+    end
+  end
+end

data/lib/dio/public_api.rb

@@ -0,0 +1,12 @@
+module Dio
+  module PublicApi
+    # Treats `[]` like an alternative constructor and forwards to `DiveForwarder`
+    #
+    # @param ... [Any]
+    #   Forwarded params
+    #
+    # @return [Dio::DiveForwarder]
+    #   Dio pattern matching interface
+    def [](...) = Dio::DiveForwarder.new(...)
+  end
+end

data/lib/dio/version.rb

@@ -0,0 +1,3 @@
+module Dio
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: dio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Weaver
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- keystonelemur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dio.gemspec
+- lib/dio.rb
+- lib/dio/dive_forwarder.rb
+- lib/dio/errors.rb
+- lib/dio/public_api.rb
+- lib/dio/version.rb
+homepage: https://www.github.com/baweaver/dio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/baweaver/dio
+  source_code_uri: https://www.github.com/baweaver/dio
+  changelog_uri: https://www.github.com/baweaver/dio/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Dive Into Objects - Pattern matching extension for plain old Ruby objects
+test_files: []