needful_things 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1609e9a3c29932e2f6a9a4b40fe89c25ac9e54cd82265af67efba7144d0150f3
+  data.tar.gz: c9924bf10e755db7c8378bf6d0f63b946274ac69e0d20e91a65bb3416dd15eb4
+SHA512:
+  metadata.gz: e30dfecbda7f7aef4da658b6f16cbefab8ff9bc59c4e267b70b61fd0178704ee9ea39861d413615c3bed258bb1e2c6c6033404dd68961c32f971a7ad4deba434
+  data.tar.gz: '0968932404a844a5e52d26fe9e53b02f582214d773767ca71bfd3ce08d57e26a86937bad4ac97811fdc049b60a23253a4045deaa859a966ffc4621ac50e6d0e6'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*~
+*.swp

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in needful_things.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dennis Walters
+
+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,60 @@
+# NeedfulThings #
+
+A required hash fields checker. At present, it rolls with the assumption that not only is the hash key present, but its associated value is also non-nil.
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'needful_things'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install needful_things
+
+## Usage ##
+
+In lieu of real documentation, here's an example.
+
+```ruby
+require 'needful_things'
+
+class SomeOperation
+  include NeedfulThings
+
+  needs name: :widget_id, otherwise: :widget_id_not_present
+
+  def call(input = {})
+    neediness(input) do |needs|
+      needs.fulfilled do
+        true
+      end
+
+      needs.unmet do |reason|
+        false
+      end
+    end
+  end
+end
+```
+
+## Development ##
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/ess/needful_things.
+
+
+## License ##
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "needful_things"
+
+# 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/lib/needful_things.rb

@@ -0,0 +1,11 @@
+require 'needful_things/dsl'
+require 'needful_things/instance_methods'
+require 'needful_things/version'
+
+module NeedfulThings
+  include InstanceMethods
+
+  def self.included(base)
+    base.send :extend, DSL
+  end
+end

data/lib/needful_things/dsl.rb

@@ -0,0 +1,15 @@
+require 'needful_things/engine'
+
+module NeedfulThings
+
+  module DSL
+    def needs(name:, otherwise:)
+      needs_engine.register(name: name, otherwise: otherwise)
+    end
+
+    def needs_engine
+      @needs_engine ||= Engine.new
+    end
+  end
+
+end

data/lib/needful_things/engine.rb

@@ -0,0 +1,38 @@
+require 'dry/monads'
+require 'needful_things/matcher'
+
+module NeedfulThings
+
+  class Engine
+    include Dry::Monads[:maybe, :result, :try]
+
+    def register(name:, otherwise:)
+      requirements[name] = otherwise
+    end
+
+    def verify(input = {}, &block)
+      Matcher.(
+        Maybe(find_unmet(input)).fmap {|need| reason(need)}.to_result.flip,
+        &block
+      )
+    end
+
+    private
+    def requirements
+      @requirements ||= {}
+    end
+
+    def find_unmet(input = {})
+      needs.reject {|need| Try {input.fetch(need)}.value_or(nil)}.first
+    end
+
+    def needs
+      requirements.keys
+    end
+
+    def reason(need)
+      requirements.fetch(need)
+    end
+  end
+
+end

data/lib/needful_things/instance_methods.rb

@@ -0,0 +1,9 @@
+module NeedfulThings
+
+  module InstanceMethods
+    def neediness(input = {}, &block)
+      self.class.needs_engine.verify(input, &block)
+    end
+  end
+
+end

data/lib/needful_things/matcher.rb

@@ -0,0 +1,17 @@
+require 'dry/matcher'
+
+module NeedfulThings
+
+  Matcher = Dry::Matcher.new(
+    fulfilled: Dry::Matcher::Case.new(
+      match: -> result {result.success?},
+      resolve: -> result {result.value!}
+    ),
+
+    unmet: Dry::Matcher::Case.new(
+      match: -> result {result.failure?},
+      resolve: -> result {result.failure}
+    )
+  )
+
+end

data/lib/needful_things/version.rb

@@ -0,0 +1,3 @@
+module NeedfulThings
+  VERSION = '0.1.0'
+end

data/needful_things.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/needful_things/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "needful_things"
+  spec.version       = NeedfulThings::VERSION
+  spec.authors       = ["Dennis Walters"]
+  spec.email         = ["pooster@gmail.com"]
+
+  spec.summary       = %q{A required hash fields checker}
+  spec.homepage      = "https://github.com/ess/needful_things-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ess/needful_things-ruby"
+
+  # 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_dependency 'dry-matcher', '~> 0.8.0'
+  spec.add_dependency 'dry-monads', '~> 1.3.0'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: needful_things
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: 
+email:
+- pooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/needful_things.rb
+- lib/needful_things/dsl.rb
+- lib/needful_things/engine.rb
+- lib/needful_things/instance_methods.rb
+- lib/needful_things/matcher.rb
+- lib/needful_things/version.rb
+- needful_things.gemspec
+homepage: https://github.com/ess/needful_things-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ess/needful_things-ruby
+  source_code_uri: https://github.com/ess/needful_things-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: A required hash fields checker
+test_files: []