much-not-given 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47f0b147fde4e559900f48979c58df4e27a424245ed33342dcc9dc3497fdd64
-  data.tar.gz: d766db817beddbbd238cb1a4a9316c49bfcf0fea25a77c5f0c9de404a712151a
+  metadata.gz: 7555cfcec030086658ffb01b7f307c95d83255e6ae83c781814644ec4e1d84ca
+  data.tar.gz: 5a2b58ad8bc2dc1327b7fc6d9071465b889d72f57896ffda98723216c0cf8252
 SHA512:
-  metadata.gz: 2665a670c0d0e3ff04f6ddd0a29e0673df2c79c77d4376a90e5371b90cd47b01835949c607e51ea9331d279e55e4000060925056bd08b0a9a6339cc599546550
-  data.tar.gz: baea314fb721a130ead0301dd85ef3ac1b0db4d849d2a5f0b9f4eecb78c62664dc7bca9e2b9edcd8690434b8c6205c01df9e73a2ae71fe85ee48c9f092cd29c6
+  metadata.gz: 6959d530476fd6745fdbbf3e53e9080da811d3fc8ace494489d01ccdc429fa16fe50ed1388aaaf54042d02ae3ab990f2ea10d3f5b48db6fda0f5dd088f675298
+  data.tar.gz: 6438f7633f583ecaeb17a5b3c311baf89efeba546312d22c734dd3a9925297c2261298ef304c3e079460eea621b802591890af8e24cff4298acd41019441d2c3

data/README.md

@@ -1,10 +1,33 @@
 # MuchNotGiven
 
-Add "not given" default values to your objects.
+Add "not given" default values to your objects. This allows you to safely detect whether a method has been given argument values or not.
 
 ## Usage
 
-TODO: Write code samples and usage instructions here
+```ruby
+module MyNamespace
+  include MuchNotGiven
+end
+
+MyNamespace.not_given                           # => MyNamespace.not_given
+"some value" == MyNamespace.not_given           # => false
+MyNamespace.not_given?("some value")            # => false
+MyNamespace.not_given?(MyNamespace.not_given?)  # => true
+MyNamespace.given?("some value")                # => true
+MyNamespace.given?(MyNamespace.not_given?)      # => false
+
+def my_method(value = MyNamespace.not_given)
+  if MyNamespace.given?(value)
+    # do something with the given value
+  end
+end
+
+def my_method(arg_value = MyNamespace.not_given)
+  value = MyNamespace.given?(value) ? value : "some default value"
+
+  # do something with the optionally defaulted value
+end
+```
 
 ## Installation
 

data/lib/much-not-given.rb

@@ -1,4 +1,51 @@
 require "much-not-given/version"
+require "much-plugin"
 
 module MuchNotGiven
+  include MuchPlugin
+
+  plugin_class_methods do
+    def not_given
+      @not_given ||=
+        begin
+          Class.new {
+            def initialize(receiver_name)
+              @receiver_name = receiver_name
+            end
+
+            def blank?
+              true
+            end
+
+            def present?
+              false
+            end
+
+            def to_s
+              "#{@receiver_name}.not_given"
+            end
+
+            def inspect
+              to_s
+            end
+
+            def ==(other)
+              if other.is_a?(self.class)
+                true
+              else
+                super
+              end
+            end
+          }.new(self.inspect)
+        end
+    end
+
+    def not_given?(value)
+      value == not_given
+    end
+
+    def given?(value)
+      value != not_given
+    end
+  end
 end

data/lib/much-not-given/version.rb

@@ -1,3 +1,3 @@
 module MuchNotGiven
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/much-not-given.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = "~> 2.5"
 
   gem.add_development_dependency("assert", ["~> 2.18.4"])
+
+  gem.add_dependency("much-plugin", ["~> 0.2.2"])
 end

data/test/unit/much-not-given_tests.rb

@@ -0,0 +1,55 @@
+require "assert"
+require "much-not-given"
+
+module MuchNotGiven
+  class UnitTests < Assert::Context
+    desc "MuchNotGiven"
+    subject { unit_module }
+
+    let(:unit_module) { MuchNotGiven }
+
+    should "inlcude MuchPlugin" do
+      assert_that(unit_module).includes(MuchPlugin)
+    end
+  end
+
+  class ReceiverTests < UnitTests
+    desc "reciver"
+    subject { receiver_class }
+
+    let(:receiver_class) {
+      Class.new do
+        include MuchNotGiven
+      end
+    }
+
+    let(:value1) {
+      Factory.public_send(
+        [:integer, :string, :float, :data, :time, :path, :boolean].sample
+      )
+    }
+
+    should have_imeths :not_given, :not_given?, :given?
+
+    should "have a not_given singleton value" do
+      not_given = subject.not_given
+
+      assert_that(not_given.blank?).is_true
+      assert_that(not_given.present?).is_false
+      assert_that(not_given.to_s).equals("#{subject.inspect}.not_given")
+      assert_that(not_given.inspect).equals(not_given.to_s)
+
+      assert_that(subject.not_given).is_the_same_as(not_given)
+      assert_that(subject.not_given == not_given).is_true
+      assert_that(value1 == not_given).is_false
+    end
+
+    should "know if values are given or not" do
+      assert_that(subject.given?(value1)).is_true
+      assert_that(subject.given?(subject.not_given)).is_false
+
+      assert_that(subject.not_given?(value1)).is_false
+      assert_that(subject.not_given?(subject.not_given)).is_true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: much-not-given
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kelly Redding
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: assert
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.18.4
+- !ruby/object:Gem::Dependency
+  name: much-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 description: Add "not given" default values to your objects.
 email:
 - kelly@kellyredding.com
@@ -44,6 +58,7 @@ files:
 - test/support/factory.rb
 - test/system/.keep
 - test/unit/.keep
+- test/unit/much-not-given_tests.rb
 - tmp/.keep
 homepage: https://github.com/redding/much-not-given
 licenses:
@@ -73,3 +88,4 @@ test_files:
 - test/support/factory.rb
 - test/system/.keep
 - test/unit/.keep
+- test/unit/much-not-given_tests.rb