deconstructable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5952379b5d8b241865bf23ef9b5489a0ea4b4891aa7e8b6a5eaf6c48e26311d9
+  data.tar.gz: 1ccac725c212feba2181e8aaeb43439d6374653b275362915f85fad908e46a35
+SHA512:
+  metadata.gz: ac3cc004eb2aafcba212a68d488a0b7f1a453a77be633136769551865b4423ec29a9269873fd5ebf18ac554fbc18d201ca2e77cdbdda4cf4d852f948a0980b1b
+  data.tar.gz: bd41333c129900c88a9b516c0450a192f6a6a7969261fc6375ee3cf6d8c7fa94ab0af6f64fd89c710c51061c8e5fdcaf014979db8e4fde78366b8df9f8052c94

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: "ruby:2.7"
+
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/Encoding:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 99
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.0

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 alex.kalderimis@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deconstructable.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rubocop', '~> 0.82.0', require: false

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    deconstructable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deconstructable!
+  rake (~> 12.0)
+  rspec (~> 3.2)
+  rubocop (~> 0.82.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alex Kalderimis
+
+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,85 @@
+# Deconstructable
+
+This gem provides Deconstructable, a mixin module that helps you to support
+pattern-matching over your types.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deconstructable'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install deconstructable
+
+
+## Usage
+
+```
+class Thing
+    include Deconstructable
+
+    ...
+
+    # Mark some methods as deconstructable
+    deconstructable :x, :y
+
+    # Shortcut for attr_reader + deconstructable
+    attr_deconstructable :readable_and_matchable
+
+    # Using deconstructable as a method modifier
+    deconstructable def foo
+      do_the_foo
+    end
+end
+```
+
+This class provides a single DSL method `deconstructable` which helps you to mark
+methods and attributes as deconstructable. Deconstructable attributes will be made
+available in pattern matching, e.g.: 
+
+```
+thing in Thing(foo:, x: 100, y:)
+```
+
+Classes that include `Deconstructable` gain an implementation of `deconstruct_keys` that permits
+hash-style key based pattern matching. Positional array-style patterns are not supported.
+All deconstructable methods must support being called with no parameters.
+
+## 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).
+
+This Gem requires the new pattern matching features introduced in Ruby 2.7.0, so
+we need at least that version. I use `asdf`, and have supplied a suitable
+`.tool-versions` file. You can use this, or any other Ruby version manager.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at
+https://gitlab.com/alexkalderimis/deconstructable. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [code of conduct](https://gitlab.com/alexkalderimis/deconstructable/-/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Deconstructable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/alexkalderimis/deconstructable/-/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'deconstructable'
+
+# 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/deconstructable.gemspec

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'lib/deconstructable/version'
+
+SUMMARY = <<~SUMMARY
+  Mixin to help implement deconstructable types
+SUMMARY
+
+DESCRIPTION = <<~DESC
+  This gem provides Deconstructable, a mixin module that helps you to support
+  pattern-matching over your types.
+
+  Usage
+  --------
+
+  ```
+  class Thing
+    include Deconstructable
+
+    ...
+
+    deconstructable :x, :y
+
+    deconstructable def foo
+      do_the_foo
+    end
+  end
+  ```
+
+  This class provides a single DSL method `deconstructable` which helps you to mark
+  methods and attributes as deconstructable. Deconstructable attributes will be made
+  available in pattern matching, e.g.:
+
+  ```
+  thing in Thing(foo:, x: 100, y:)
+  ```
+
+  Classes that include `Deconstructable` gain an implementation of `deconstruct_keys` that permits
+  hash-style key based pattern matching. Positional array-style patterns are not supported.
+DESC
+
+Gem::Specification.new do |s|
+  s.name        = 'deconstructable'
+  s.version     = Deconstructable::VERSION
+  s.date        = '2020-04-07'
+  s.summary     = SUMMARY
+  s.description = DESCRIPTION
+  s.authors     = ['Alexis Kalderimis']
+  s.email       = ['alex.kalderimis@gmail.com']
+  s.homepage    = 'https://rubygems.org/gems/deconstructable'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 2.7.0'
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://gitlab.com/alexkalderimis/deconstructable'
+  s.metadata['changelog_uri'] = 'https://gitlab.com/alexkalderimis/deconstructable/-/blob/master/CHANGELOG.md'
+
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

data/lib/deconstructable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Helpers to implement pattern match-able classes
+module Deconstructable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # DSL methods made available to the including class:
+  module ClassMethods
+    # Method names that represent attributes that should be exposed in patterns
+    def deconstructable(*keys)
+      @deconstructable ||= (superclass&.instance_variable_get(:@deconstructable)&.dup || [])
+      @deconstructable.concat(keys)
+    end
+
+    # Sugar defining readable attributes (as per `attr_reader`) that are
+    # deconstructable
+    def attr_deconstructable(*keys)
+      attr_reader(*keys)
+      deconstructable(*keys)
+    end
+  end
+
+  def deconstruct_keys(keys)
+    keys = keys ? (deconstructable & keys) : deconstructable
+
+    keys.map { |k| [k, send(k)] }.to_h
+  end
+
+  private
+
+  def deconstructable
+    self.class.deconstructable
+  end
+end

data/lib/deconstructable/version.rb

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: deconstructable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexis Kalderimis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |
+  This gem provides Deconstructable, a mixin module that helps you to support
+  pattern-matching over your types.
+
+  Usage
+  --------
+
+  ```
+  class Thing
+    include Deconstructable
+
+    ...
+
+    deconstructable :x, :y
+
+    deconstructable def foo
+      do_the_foo
+    end
+  end
+  ```
+
+  This class provides a single DSL method `deconstructable` which helps you to mark
+  methods and attributes as deconstructable. Deconstructable attributes will be made
+  available in pattern matching, e.g.:
+
+  ```
+  thing in Thing(foo:, x: 100, y:)
+  ```
+
+  Classes that include `Deconstructable` gain an implementation of `deconstruct_keys` that permits
+  hash-style key based pattern matching. Positional array-style patterns are not supported.
+email:
+- alex.kalderimis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.rubocop.yml
+- bin/console
+- bin/setup
+- deconstructable.gemspec
+- lib/deconstructable.rb
+- lib/deconstructable/version.rb
+homepage: https://rubygems.org/gems/deconstructable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/deconstructable
+  source_code_uri: https://gitlab.com/alexkalderimis/deconstructable
+  changelog_uri: https://gitlab.com/alexkalderimis/deconstructable/-/blob/master/CHANGELOG.md
+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: Mixin to help implement deconstructable types
+test_files: []