therefore 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b48be7ef4ee5a7ab3ace829843bc2f53129feb056f01e4697c752351aee5434c
+  data.tar.gz: 0631270b4eb1b7b3d116957083af143e1c7e7866b1717cf21101abe619ef761e
+SHA512:
+  metadata.gz: d51de8f98f23b3877165d6af60aabb12273bf8525c124eac96967e7ea95347838b165bd0788872cf6b5dc32505b88624d1a7bb286854a5cf90e818094f78b135
+  data.tar.gz: cefd3f2f6658fa5898d968f0cb32da6edd7aacb49f915ed637fd63d4d1e1a1b9f3e23be7ee81f15a471b9ff76dd8bffee8401f2a94ab14223f038cf0642a49fe

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,451 @@
+AllCops:
+  Exclude:
+    - 'bin/**'
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies:
+  Enabled: true
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/BeginEndAlignment:
+  EnforcedStyleAlignWith: begin
+
+Layout/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+
+Layout/CommentIndentation:
+  AllowForAlignment: true
+
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: true
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+  AllowBeforeTrailingComments: true
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/LineContinuationLeadingSpace:
+  Enabled: true
+
+Layout/LineContinuationSpacing:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  EnforcedStyle: same_line
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/SingleLineBlockChain:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceAroundOperators:
+  EnforcedStyleForExponentOperator: space
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+  RequireParenthesesForMethodChains: true
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+Lint/ConstantOverwrittenInRescue:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+  IgnoreLiteralBranches: true
+  IgnoreConstantBranches: true
+
+Lint/DuplicateMagicComment:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+  AllowComments: true
+
+Lint/EmptyInPattern:
+  Enabled: true
+
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: false
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NonAtomicFileOperation:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RedundantSplatExpansion:
+  AllowPercentLiteralArrayArgument: false
+
+Lint/RefinementImportMethods:
+  Enabled: true
+
+Lint/RequireRangeParentheses:
+  Enabled: true
+
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  AutoCorrect: false
+
+Lint/UnusedMethodArgument:
+  AutoCorrect: false
+
+Lint/UselessRescue:
+  Enabled: true
+
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
+Metrics:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Naming/InclusiveLanguage:
+  Enabled: false
+
+Security/CompoundHash:
+  Enabled: true
+
+Security/Eval:
+  Enabled: false
+
+Security/IoMethods:
+  Enabled: true
+
+Style/AccessorGrouping:
+  EnforcedStyle: separated
+
+Style/ArgumentsForwarding:
+  Enabled: false
+
+Style/ArrayIntersect:
+  Enabled: true
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/ComparableClamp:
+  Enabled: true
+
+Style/ConcatArrayLiterals:
+  Enabled: true
+
+Style/DirEmpty:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/DoubleNegation:
+  EnforcedStyle: forbidden
+
+Style/EmptyHeredoc:
+  Enabled: true
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/EndlessMethod:
+  Enabled: true
+  EnforcedStyle: disallow
+
+Style/EnvHome:
+  Enabled: true
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/FileEmpty:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true
+
+Style/FileWrite:
+  Enabled: true
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashConversion:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/ImplicitRuntimeError:
+  Enabled: true
+
+Style/InPatternThen:
+  Enabled: true
+
+Style/IpAddresses:
+  Enabled: true
+
+Style/MagicCommentFormat:
+  Enabled: true
+
+Style/MapCompactWithConditionalBlock:
+  Enabled: true
+
+Style/MapToHash:
+  Enabled: true
+
+Style/MapToSet:
+  Enabled: true
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: omit_parentheses
+  AllowParenthesesInMultilineCall: true
+  AllowParenthesesInChaining: true
+  AllowParenthesesInCamelCaseMethod: true
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses_except_multiline
+
+Style/MinMaxComparison:
+  Enabled: true
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MultilineInPatternThen:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NestedFileDirname:
+  Enabled: true
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/NilLambda:
+  Enabled: true
+
+Style/NonNilCheck:
+  Enabled: false
+
+Style/NumberedParameters:
+  Enabled: true
+  EnforcedStyle: disallow
+
+Style/NumberedParametersLimit:
+  Enabled: true
+
+Style/ObjectThen:
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: false
+
+Style/OperatorMethodCall:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/QuotedSymbols:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: false
+
+Style/RedundantConstantBase:
+  Enabled: false
+
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: true
+
+Style/RedundantEach:
+  Enabled: true
+
+Style/RedundantException:
+  Enabled: false
+
+Style/RedundantHeredocDelimiterQuotes:
+  Enabled: true
+
+Style/RedundantInitialize:
+  Enabled: true
+
+Style/RedundantParentheses:
+  Enabled: false
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+
+Style/RedundantStringEscape:
+  Enabled: true
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+Style/StaticClass:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/StringHashKeys:
+  Enabled: false
+
+Style/SwapValues:
+  Enabled: true
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+  AllowSafeAssignment: false
+
+Style/TopLevelMethodDefinition:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInBlockArgs:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+
+Style/UnlessLogicalOperators:
+  EnforcedStyle: forbid_logical_operators
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/YodaCondition:
+  Enabled: true
+  EnforcedStyle: forbid_for_all_comparison_operators

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 2023-05-04
+
+First release. Refer to [README.md](README.md) for the full documentation.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in therefore.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rubocop', '~> 1.21'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Moku S.r.l., Riccardo Agatea
+
+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,106 @@
+# Therefore
+
+A simple wrapper for `if` conditionals, what `each` is for `while` loops.
+
+Just like `each`, `therefore` relies on block semantics, so it's essentially an `if` conditional with a scope, a closure, and the ability to be chained with other methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'therefore', '~> 1.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or you can install the gem on its own:
+
+```bash
+gem install therefore
+```
+
+## Usage
+
+`obj.therefore {...}` will invoke the block, yielding `obj` to it, unless `obj` is either `nil` or `false`. If the block is invoked its result is returned, otherwise `obj` is returned:
+
+```ruby
+def find_user input: {}
+  input[:id].therefore do |user_id|
+    User.find user_id
+  end
+end
+
+find_user input: {id: 1} # => #<User id: 1, ...>
+find_user input: {id: nil} # => nil
+```
+
+`obj.otherwise {...}` behaves symmetrically to `therefore`: it only invokes the block, again yielding `obj`, if `obj` is either `false` or `nil`. Again, if the block is invoked its result is returned, otherwise `obj` is returned. If you chain it with `therefore`, it can work as an `else` branch:
+
+```ruby
+def find_user input: {}
+  input[:id].therefore do |user_id|
+    User.find user_id
+  end.otherwise do
+    User.default
+  end
+end
+
+find_user input: {id: 1} # => #<User id: 1, ...>
+find_user input: {id: nil} # => #<User default: true, ...>
+```
+
+You can also invoke `otherwise` with a parameter, in which case it works as an `elsif` branch:
+
+```ruby
+obj.otherwise(other_obj) do |var|
+  ...
+end
+```
+
+is equivalent to
+
+```ruby
+obj.otherwise do
+  other_obj.therefore do |var|
+    ...
+  end
+end
+```
+
+Both `therefore` and `otherwise` can be called without a block, in which case they return an enumerator. If the block would have been invoked the enumerator contains `obj`, otherwise it is empty:
+
+```ruby
+nil.therefore.to_a # => []
+nil.otherwise.to_a # => [nil]
+'string'.therefore.to_a # => ['string']
+'string'.otherwise.to_a # => []
+```
+
+## Version numbers
+
+Therefore loosely follows [Semantic Versioning](https://semver.org/), with a hard guarantee that breaking changes to the public API will always coincide with an increase to the `MAJOR` number.
+
+Version numbers are in three parts: `MAJOR.MINOR.PATCH`.
+
+- Breaking changes to the public API increment the `MAJOR`. There may also be changes that would otherwise increase the `MINOR` or the `PATCH`.
+- Additions, deprecations, and "big" non breaking changes to the public API increment the `MINOR`. There may also be changes that would otherwise increase the `PATCH`.
+- Bug fixes and "small" non breaking changes to the public API increment the `PATCH`.
+
+Notice that any feature deprecated by a minor release can be expected to be removed by the next major release.
+
+## Changelog
+
+Full list of changes in [CHANGELOG.md](CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moku-io/therefore.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/therefore/false_class_patch.rb

@@ -0,0 +1,25 @@
+class FalseClass
+  def therefore
+    if block_given?
+      self
+    else
+      Enumerator.new do
+        # Empty enumerator
+      end
+    end
+  end
+
+  def otherwise *args, &block
+    if args.empty?
+      if block_given?
+        yield self
+      else
+        Enumerator.new do |yielder|
+          yielder << self
+        end
+      end
+    else
+      args.first.therefore(&block)
+    end
+  end
+end

data/lib/therefore/kernel_patch.rb

@@ -0,0 +1,21 @@
+module Kernel
+  def therefore
+    if block_given?
+      yield self
+    else
+      Enumerator.new do |yielder|
+        yielder << self
+      end
+    end
+  end
+
+  def otherwise *_args
+    if block_given?
+      self
+    else
+      Enumerator.new do
+        # Empty enumerator
+      end
+    end
+  end
+end

data/lib/therefore/nil_class_patch.rb

@@ -0,0 +1,25 @@
+class NilClass
+  def therefore
+    if block_given?
+      self
+    else
+      Enumerator.new do
+        # Empty enumerator
+      end
+    end
+  end
+
+  def otherwise *args, &block
+    if args.empty?
+      if block_given?
+        yield self
+      else
+        Enumerator.new do |yielder|
+          yielder << self
+        end
+      end
+    else
+      args.first.therefore(&block)
+    end
+  end
+end

data/lib/therefore/version.rb

@@ -0,0 +1,3 @@
+module Therefore
+  VERSION = '1.0.0'
+end

data/lib/therefore.rb

@@ -0,0 +1,4 @@
+require_relative 'therefore/version'
+require_relative 'therefore/kernel_patch'
+require_relative 'therefore/nil_class_patch'
+require_relative 'therefore/false_class_patch'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: therefore
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Moku S.r.l.
+- Riccardo Agatea
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies: []
+description: Just like each, therefore relies on block semantics, so it's essentially
+  an if conditional with a scope, a closure, and the ability to be chained with other
+  methods.
+email:
+- info@moku.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/therefore.rb
+- lib/therefore/false_class_patch.rb
+- lib/therefore/kernel_patch.rb
+- lib/therefore/nil_class_patch.rb
+- lib/therefore/version.rb
+homepage: https://github.com/moku-io/therefore
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moku-io/therefore
+  source_code_uri: https://github.com/moku-io/therefore
+  changelog_uri: https://github.com/moku-io/therefore/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A simple wrapper for if conditionals, what each is for while loops.
+test_files: []