rescue_from 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84abd11a09f6dc0dda03750944d313ab3d55573d6736aeaed334bb861380d256
+  data.tar.gz: 73d8b1c733a292b4a17d52333c63c9b78518c920b6bac340fb98a22f5643e43d
+SHA512:
+  metadata.gz: 3a4e678a97aad70d14b7893a2e942fe65c49a11f1cf540ca80e818f273f569776665ba9ef34a71f219e2626270e98120605bb9ab9424e1f1013ac8143c89ff36
+  data.tar.gz: 251097319a84dce69292693f9769c98729f49a57efa5e5ca8848abd6098878bedd8fb69cd260c68f4492a82a7019be73365e1a83bec9529d5f877382ab42e9c3

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-29
+
+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,141 @@
+# Rescue From
+
+An imitation of `ActiveSupport::Rescuable` that relies on Ruby's callbacks to reduce boilerplate code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rescue_from', '~> 1.0'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or you can install the gem on its own:
+
+```bash
+gem install rescue_from
+```
+
+## Usage
+
+Simply extend with `RescueFrom::Rescuable` any class or module that you want to use `rescue_from` in.
+
+```ruby
+class DataImporter
+  extend RescueFrom::Rescuable
+  
+  rescue_from JSON::ParserError do
+    []
+  end
+  
+  def temperature_data
+    JSON.parse File.read('temperatures.json')
+  end
+  
+  def humidity_data
+    JSON.parse File.read('humidity.json')
+  end
+end
+```
+
+Both `#temperature_data` and `#humidity_data` will return an empty array if the respective files contain JSON syntax errors.
+
+`rescue_from` can accept multiple patterns, and will associate the same handler with all of them. Handlers are looked up top to bottom, left to right, and up the ancestors chain as it is returned by `self.class.ancestors`. The lookup uses case equality to match patterns against the raised exception, so you can use less straightforward patterns instead of classes. This class will silence all exceptions the messages of which don't start with "failure":
+
+```ruby
+class Service
+  extend RescueFrom::Rescuable
+  
+  rescue_from(proc {|e| !e.message.start_with? 'failure'}) do
+    nil
+  end
+  
+  ...
+end
+```
+
+If no pattern matches the exception, it will be reraised.
+
+If you want to call a given method bypassing the automatic exception handling, you can append `_without_rescue` to its name:
+
+```ruby
+di = DataImporter.new
+di.temperature_data # => []
+di.temperature_data_without_rescue # => JSON::ParserError
+```
+
+Sometimes, instead of silencing the exception, you want to change its class, for example if you're using the same low level library in different parts of the application and you need to distinguish the exceptions coming from the different sides. In such cases, you can use `relabel`:
+
+```ruby
+class Service
+  extend RescueFrom::Rescuable
+
+  relabel pattern1, pattern2, ..., to: ExceptionClass do |e|
+    code
+  end
+
+  ...
+end
+```
+
+is equivalent to
+
+```ruby
+class Service
+  extend RescueFrom::Rescuable
+
+  rescue_from pattern1, pattern2, ... do |e|
+    message = code
+    raise ExceptionClass, message
+  end
+
+  ...
+end
+```
+
+If you want to limit automatic exception handling to only certain methods, you can override `should_rescue_in?`. It will be called every time a new method is defined, receiving its name as single argument; if it returns `false` or `nil`, the method is left untouched.
+
+```ruby
+
+class Service
+  extend RescueFrom::Rescuable
+  
+  ACTIONS = [:create, :update, :delete]
+
+  def self.should_rescue_in? method_name
+    ACTIONS.include? method_name
+  end
+
+  ...
+end
+```
+
+## Version numbers
+
+Rescue From 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/rescue_from.
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new :spec
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop]

data/lib/rescue_from/overrider.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/module/attribute_accessors'
+
+module RescueFrom
+  module Overrider
+    def handlers
+      @handlers ||= {}
+    end
+
+    # rubocop:disable Style/CaseEquality
+    def handler_for exception
+      handlers
+        .find { |pattern, _handler| pattern === exception }
+        &.last
+    end
+    # rubocop:enable Style/CaseEquality
+  end
+end

data/lib/rescue_from/rescuable.rb

@@ -0,0 +1,73 @@
+require_relative 'overrider'
+
+module RescueFrom
+  module Rescuable
+    def self.extended base
+      overrider = Module.new do
+        extend Overrider
+      end
+
+      base.const_set :RescueFrom_Overrider, overrider
+      base.prepend overrider
+    end
+
+    def inherited subclass
+      super
+
+      puts 'inside the inherited'
+
+      subclass.extend Rescuable
+    end
+
+    def rescue_from *patterns, &handler
+      raise ArgumentError, 'always provide a handler when calling rescue_from' unless block_given?
+
+      overrider = const_get :RescueFrom_Overrider
+
+      patterns.each do |pattern|
+        overrider.handlers[pattern] = handler
+      end
+    end
+
+    def relabel *patterns, to:, &message_generator
+      rescue_from(*patterns) do |e|
+        raise to, message_generator.call(e)
+      end
+    end
+
+    def should_rescue_in? _method_name
+      true
+    end
+
+    def method_added name
+      super
+
+      return unless should_rescue_in? name
+
+      overrider = const_get :RescueFrom_Overrider
+
+      return if overrider.method_defined? name
+
+      method_without_rescue = instance_method name
+
+      overrider.define_method :"#{name}_without_rescue" do |*args, **kwargs, &block|
+        method_without_rescue.bind_call(self, *args, **kwargs, &block)
+      end
+
+      # rubocop:disable Lint/RescueException
+      overrider.define_method name do |*args, **kwargs, &block|
+        super(*args, **kwargs, &block)
+      rescue Exception => e
+        self.class
+          .ancestors
+          .lazy
+          .filter_map { |mod| mod.const_get :RescueFrom_Overrider if mod.const_defined? :RescueFrom_Overrider }
+          .filter_map { |ancestor_overrider| ancestor_overrider.handler_for e }
+          .first
+          .otherwise { raise e }
+          .therefore { |handler| handler.call e }
+      end
+      # rubocop:enable Lint/RescueException
+    end
+  end
+end

data/lib/rescue_from/version.rb

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

data/lib/rescue_from.rb

@@ -0,0 +1,8 @@
+require 'therefore'
+require_relative "rescue_from/version"
+
+module RescueFrom
+  class Error < StandardError; end
+end
+
+require_relative 'rescue_from/rescuable'

data/sig/rescue_from.rbs

@@ -0,0 +1,4 @@
+module RescueFrom
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rescue_from
+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-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: therefore
+  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'
+description: An imitation of ActiveSupport::Rescuable that relies on Ruby's callbacks
+  to reduce boilerplate code.
+email:
+- info@moku.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rescue_from.rb
+- lib/rescue_from/overrider.rb
+- lib/rescue_from/rescuable.rb
+- lib/rescue_from/version.rb
+- sig/rescue_from.rbs
+homepage: https://github.com/moku-io/rescue_from
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moku-io/rescue_from
+  source_code_uri: https://github.com/moku-io/rescue_from
+  changelog_uri: https://github.com/moku-io/rescue_from/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: An imitation of ActiveSupport::Rescuable that relies on Ruby's callbacks
+  to reduce boilerplate code.
+test_files: []