demand 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71d2de856e8b5dbde272a052c9469dede2c60e3632330b6e8e7a271879189ac4
+  data.tar.gz: fe01af992413ecf449cf06a85c445f750c947d9a6aa388aa8d5ac6a160726048
+SHA512:
+  metadata.gz: 6b493b5e0c1a82496d6c4f4b941386d48c25be30c45075f8b0fab7d4b172963d69c9a46626fbc49f5bb53bf39837459f3d8754e8a11a06e11173dbb23c36b37b
+  data.tar.gz: d95a634315032d81f718704890d2260dbbf9ddc89edb07b09a6536a31b06ac8faf8f95db48de7e276cbe68bcbc08bc5a01aa0b7688e9545e990453c18999d595

data/.gitignore

@@ -0,0 +1,17 @@
+.git
+.env
+*.lnk
+*.db
+*.ini
+
+/.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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in demand.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    demand (0.1.0)
+      boolean (~> 1.0)
+      facets (~> 3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    boolean (1.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    facets (3.1.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  demand!
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,73 @@
+# Demand (Ruby Gem)
+
+**Adds a top level `demand(variable)` method to return a variable if it's present** and optionally of the right type. Otherwise, a default or nil is returned.
+
+**`demand()` replaces long lines of repetitive code** to check for `nil?`/`present?`/`empty?`, etc., hard-to-read ternary operators (`?:`) and chunky `if` statements. Instead you can make a simple method call.
+
+| So, you can...              | ...instead of stuff like                       |
+| --------------------------- | ---------------------------------------------- |
+| `demand(x)`                 | `(x.present? ? x : nil)`                       |
+| `a = demand(x, [0], Array)` | `a = (x.is_a?(Array) && !x.empty?) ? x : [0]`  |
+| `demand(x) {\|x\| a = x}`   | `a = x if !x.nil? && x.strip.length > 0`       |
+
+## Usage
+
+```ruby
+require 'demand'
+```
+
+### If variable present, return it
+
+```ruby
+x = false
+y = '   '
+
+demand(x) #=> false (that is, x)
+demand(y) #=> nil
+demand(y, 'Not present') #=> 'Not present'
+```
+
+By *present* here we mean that:
+
+* The variable is not equal to `nil`
+* If it is an Array or Hash, it isn't empty
+* If it is a String, it isn't empty or just whitespace
+
+(This uses the [Facets](https://github.com/rubyworks/facets) gem's `blank?` method, but overrides it evaluating `false` as blank.)
+
+If you actually want your variable to be `nil` (i.e. you want the default value when the variable is *not* nil), specify the class you're looking for as `NilClass`):
+
+```ruby
+expected_to_be_nil = nil
+
+demand(expected_to_be_nil, 'Not nil') #=> 'Not nil'
+demand(expected_to_be_nil, 'Not nil', NilClass) #=> nil (that is, expected_to_be_nil)
+```
+
+If you want an Array or Hash and don't mind if an empty one is passed, just specify an empty Array or Hash as the default value.
+
+### If variable present and of type, return it
+
+If you specify a Class or Module in the third parameter, the variable must be of this Class or include this Module.
+
+```ruby
+x = 'Hello world'
+y = false
+
+demand(x, 'Not the right type', String) #=> 'Hello world' (that is, x)
+demand(y, 'Not the right type', String) #=> 'Not the right type'
+demand(y, 'Not the right type', Boolean) #=> false (that is, y)
+```
+
+The type `Boolean` is also made available when using this gem (via the [Boolean](https://github.com/RISCfuture/boolean) gem). This has the effect that `true` and `false` include `Boolean`, so we can check if something `is_a?(Boolean)` which will pass just for `true` and `false` values.
+
+### If variable, yield and run block
+
+If a block is specified, this will run only if the variable passes all the conditions. The variable is yielded to the block and also still returned by the method.
+
+```ruby
+x = 5
+
+demand(x, nil, Integer) {|x| puts x * 2 } #=> returns: 5; puts: 10
+demand(x, nil, String) {|x| puts 'Hello' } #=> nil; puts is not run
+```

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 "demand"
+
+# 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/demand.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "demand/version"
+
+Gem::Specification.new do |spec|
+    spec.name          = "demand"
+    spec.version       = Demand::VERSION
+    spec.authors       = ["Convincible"]
+    spec.email         = ["development@convincible.media"]
+
+    spec.summary       = "Adds a top level demand(variable) method to return a variable if it's present and optionally of the right type. Otherwise, a default or nil is returned."
+    spec.description   = "Adds a top level demand(variable) method to return a variable if it's present and optionally of the right type. Otherwise, a default or nil is returned. demand() replaces long lines of repetitive code to check for nil?/present?/empty?, etc., hard-to-read ternary operators (?:) and if statements. A block can also be specified, which only runs (with the variable) if the checks pass."
+    spec.homepage      = "https://github.com/ConvincibleMedia/ruby-gem-demand"
+
+    # 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 "facets", "~> 3.1"
+    spec.add_dependency "boolean", "~> 1.0"
+
+    spec.add_development_dependency "pry", "~> 0.12"
+    spec.add_development_dependency "bundler", "~> 1.17"
+    spec.add_development_dependency "rake", "~> 10.0"
+    spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/demand.rb

@@ -0,0 +1,66 @@
+require 'demand/version'
+require 'facets/kernel/blank'
+require 'boolean'
+# require 'pry'
+
+module Demand
+
+    # Make Demand::demand() available
+    extend self
+
+    # Checks if a passed variable is present and as expected. If so, returns and optionally yields it. Otherwise, a default is returned. The check will fail for empty arrays, hashes and strings (including whitespace strings).
+    #
+    # @param var The variable you wish to check.
+    # @param default The return value you want if the check fails.
+    # @param type [Class, Module] Variable must be of this class or include this module for the check to pass. The module 'Boolean' can be used, to mean the value must be true or false.
+    #
+    # @return The original variable if the check passes. Otherwise, the default value is returned.
+    # @yield [var] If a block is given and the check passes, the original variable is also yielded to the block.
+    #
+    # @note If you want the check to pass just if the variable is nil, specify type = NilClass
+    #
+    def demand(var, default = nil, type = nil)
+
+        # If type specified, must either be a class or module
+        # Otherwise, get the class of whatever was passed
+        if (type != nil)
+            if (type.is_a?(Class) || type.is_a?(Module))
+                t = type
+            else
+                t = type.class
+            end
+        end
+
+        # Check the var
+        begin
+            # Edge case - you want the variable to be of type NilClass
+            if var == nil
+                unless t == NilClass
+                    return default
+                end
+            # Is the variable blank? - not including false
+            elsif !(var.present? || var == false) # Override false == blank
+                return default
+            # Variable is not blank
+            # Do we need to check its class too?
+            elsif (t != nil)
+                unless var.is_a?(t)
+                    return default
+                end
+            end
+        rescue
+            return default
+        end
+
+        # All checks have passed by this point
+        yield(var) if block_given?
+
+        # Original variable returned
+        return var
+
+    end
+
+end
+
+# Make demand() available at top level when requiring this gem
+extend Demand

data/lib/demand/version.rb

@@ -0,0 +1,3 @@
+module Demand
+    VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: demand
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Convincible
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: boolean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: Adds a top level demand(variable) method to return a variable if it's
+  present and optionally of the right type. Otherwise, a default or nil is returned.
+  demand() replaces long lines of repetitive code to check for nil?/present?/empty?,
+  etc., hard-to-read ternary operators (?:) and if statements. A block can also be
+  specified, which only runs (with the variable) if the checks pass.
+email:
+- development@convincible.media
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demand.gemspec
+- lib/demand.rb
+- lib/demand/version.rb
+homepage: https://github.com/ConvincibleMedia/ruby-gem-demand
+licenses: []
+metadata: {}
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Adds a top level demand(variable) method to return a variable if it's present
+  and optionally of the right type. Otherwise, a default or nil is returned.
+test_files: []