bountiful_blocks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 931ac5652dcb409ecd827ff2f7adb6daf3e102b344fe8d382ac636641bff7312
+  data.tar.gz: 7f3ad476b417b2fc042491d103943a5ccb57fbe8da3b4b1b39c0cc44617382bc
+SHA512:
+  metadata.gz: 563b2ed6adb3987cd598edbf28affcc7b72b143867110ebe52a64a5f6604fc5f8daff13460d067c566452764cf8d625d7dc4400d5486da73a24f0f40a21febf2
+  data.tar.gz: 5136107120ac4e8b8d8f4e7fd244d8e18594da36aa6dfa2b6eee40a00ebaf2ee15ce9b8ac9c9c4c067ae10a70aa23564a728c6cbdc3b07085f4662f617b870bd

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-30
+
+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,119 @@
+# BountifulBlocks
+
+A simple and idiomatic way to pass multiple blocks to a method. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bountiful_blocks', '~> 1.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or you can install the gem on its own:
+
+```bash
+gem install bountiful_blocks
+```
+
+## Usage
+
+Bountiful Blocks allows you to pass multiple arbitrary blocks to a method:
+
+```ruby
+def deliver message, &block
+  mb = Multiblock(&block)
+  
+  ...
+  
+  if response.success?
+    mb.on_success response.body
+  else
+    mb.on_error response.code
+  end
+end
+
+deliver('Hello World!') do
+  on_success do |body|
+    puts body
+  end
+  
+  on_error do |code|
+    raise ClientError, code
+  end
+end
+```
+
+`Kernel#Multiblock` is a simple wrapper for `BountifulBlocks::Multiblock.new`.
+
+You can provide names for required blocks, which will be checked on creation of the multiblock:
+
+```ruby
+def deliver message, &block
+  mb = Multiblock(:on_success, :on_error, &block)
+  
+  ...
+  
+  if response.success?
+    mb.on_success response.body
+  else
+    mb.on_error response.code
+  end
+end
+
+deliver('Hello World!') do
+  on_success do |body|
+    puts body
+  end
+end
+
+# => Block required for on_error (ArgumentError)
+```
+
+Alternatively, you can check whether a block with a given name was provided with `Multiblock#given?`:
+
+```ruby
+def deliver message, &block
+  mb = Multiblock(:on_success, &block)
+  
+  ...
+  
+  if response.success?
+    mb.on_success response.body
+  elsif mb.given? :on_error
+    mb.on_error response.code
+  else
+    'Fallback'
+  end
+end
+```
+
+## Version numbers
+
+BountifulBlocks 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/bountiful_blocks.
+
+## 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,7 @@
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/bountiful_blocks/kernel_patch.rb

@@ -0,0 +1,7 @@
+module Kernel
+  # rubocop:disable Naming/MethodName
+  def Multiblock *args, **kwargs, &block
+    BountifulBlocks::Multiblock.new(*args, **kwargs, &block)
+  end
+  # rubocop:enable Naming/MethodName
+end

data/lib/bountiful_blocks/multiblock.rb

@@ -0,0 +1,28 @@
+module BountifulBlocks
+  class Multiblock
+    def initialize *required_blocks, &block
+      instance_exec(&block)
+
+      missing_blocks = required_blocks.reject { |method_name| given? method_name }
+
+      raise ArgumentError, "Block required for #{missing_blocks.join ', '}" unless missing_blocks.empty?
+    end
+
+    def method_missing(name, *args, **kwargs, &block)
+      super unless args.empty? && kwargs.empty?
+      super if name.end_with? '!', '?', '='
+
+      define_singleton_method name, &block
+    end
+
+    def respond_to_missing?(name, *args, **kwargs, &block)
+      super if name.end_with? '!', '?', '='
+
+      true
+    end
+
+    def given? name
+      singleton_class.method_defined? name
+    end
+  end
+end

data/lib/bountiful_blocks/version.rb

@@ -0,0 +1,3 @@
+module BountifulBlocks
+  VERSION = '1.0.0'.freeze
+end

data/lib/bountiful_blocks.rb

@@ -0,0 +1,8 @@
+require_relative 'bountiful_blocks/version'
+
+module BountifulBlocks
+  class Error < StandardError; end
+end
+
+require_relative 'bountiful_blocks/multiblock'
+require_relative 'bountiful_blocks/kernel_patch'

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bountiful_blocks
+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-30 00:00:00.000000000 Z
+dependencies: []
+description: A simple and idiomatic way to pass multiple blocks to a method.
+email:
+- info@moku.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/bountiful_blocks.rb
+- lib/bountiful_blocks/kernel_patch.rb
+- lib/bountiful_blocks/multiblock.rb
+- lib/bountiful_blocks/version.rb
+homepage: https://github.com/moku-io/bountiful_blocks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moku-io/bountiful_blocks
+  source_code_uri: https://github.com/moku-io/bountiful_blocks
+  changelog_uri: https://github.com/moku-io/bountiful_blocks/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.1.6
+signing_key:
+specification_version: 4
+summary: A simple and idiomatic way to pass multiple blocks to a method.
+test_files: []