much-not-given 0.0.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b47f0b147fde4e559900f48979c58df4e27a424245ed33342dcc9dc3497fdd64
-  data.tar.gz: d766db817beddbbd238cb1a4a9316c49bfcf0fea25a77c5f0c9de404a712151a
+  metadata.gz: 24237e22126fd91569e93c9fd01dee60219eb037b33ed21a8dc88ba2e5ff40fe
+  data.tar.gz: f9b5bbdf08003852b3b2b753180ab9ae25f59143f2922dca4bf8f06f7b3325d3
 SHA512:
-  metadata.gz: 2665a670c0d0e3ff04f6ddd0a29e0673df2c79c77d4376a90e5371b90cd47b01835949c607e51ea9331d279e55e4000060925056bd08b0a9a6339cc599546550
-  data.tar.gz: baea314fb721a130ead0301dd85ef3ac1b0db4d849d2a5f0b9f4eecb78c62664dc7bca9e2b9edcd8690434b8c6205c01df9e73a2ae71fe85ee48c9f092cd29c6
+  metadata.gz: cdf3b636f3e06a76c5fee1008e4b01eecd388271a6972f9d0955727c157ca067ea2d4375ce3724e703208e7139909591f352b4a51017ab7f8df27ad7246f789d
+  data.tar.gz: d250aa63a62be14d8c51babc540719d3af5db776127c69b049a0fa15d28f148945e72477dfd5667ad060f10cf205d47eb181c4e7a0d705c2a94b697d30810345

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-ruby "~> 2.5"
+ruby ">= 2.5"
 
 gemspec
 
-gem "pry", "~> 0.12.2"
+gem "pry"

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/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MuchNotGiven
-  VERSION = "0.0.1"
+  VERSION = "0.1.3"
 end

data/lib/much-not-given.rb

@@ -1,4 +1,53 @@
+# frozen_string_literal: true
+
 require "much-not-given/version"
+require "much-mixin"
 
 module MuchNotGiven
+  include MuchMixin
+
+  mixin_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(inspect)
+        end
+    end
+
+    def not_given?(value)
+      value == not_given
+    end
+
+    def given?(value)
+      value != not_given
+    end
+  end
 end

data/much-not-given.gemspec

@@ -1,4 +1,6 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "much-not-given/version"
@@ -13,12 +15,16 @@ Gem::Specification.new do |gem|
   gem.homepage    = "https://github.com/redding/much-not-given"
   gem.license     = "MIT"
 
-  gem.files         = `git ls-files | grep "^[^.]"`.split($/)
+  gem.files = `git ls-files | grep "^[^.]"`.split($INPUT_RECORD_SEPARATOR)
+
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = "~> 2.5"
+  gem.required_ruby_version = ">= 2.5"
+
+  gem.add_development_dependency("assert",           ["~> 2.19.2"])
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.0"])
 
-  gem.add_development_dependency("assert", ["~> 2.18.4"])
+  gem.add_dependency("much-mixin", ["~> 0.2.4"])
 end

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this file is automatically required when you run `assert`
 # put any test helpers here
 

data/test/support/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "assert/factory"
 
 module Factory

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "assert"
+require "much-not-given"
+
+module MuchNotGiven
+  class UnitTests < Assert::Context
+    desc "MuchNotGiven"
+    subject{ unit_module }
+
+    let(:unit_module){ MuchNotGiven }
+
+    should "inlcude MuchMixin" do
+      assert_that(unit_module).includes(MuchMixin)
+    end
+  end
+
+  class ReceiverTests < UnitTests
+    desc "reciver"
+    subject{ receiver_class }
+
+    let(:receiver_class) do
+      Class.new do
+        include MuchNotGiven
+      end
+    end
+
+    let(:value1) do
+      Factory.public_send(
+        [:integer, :string, :float, :time, :path, :boolean].sample,
+      )
+    end
+
+    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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: much-not-given
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Kelly Redding
 - Collin Redding
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: assert
@@ -17,14 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.4
+        version: 2.19.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.4
+        version: 2.19.2
+- !ruby/object:Gem::Dependency
+  name: much-style-guide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: much-mixin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 description: Add "not given" default values to your objects.
 email:
 - kelly@kellyredding.com
@@ -43,19 +71,19 @@ files:
 - test/helper.rb
 - 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -64,12 +92,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: Add "not given" default values to your objects.
 test_files:
 - test/helper.rb
 - test/support/factory.rb
 - test/system/.keep
-- test/unit/.keep
+- test/unit/much-not-given_tests.rb