error_extractor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d54c336193340a9be9623b913bbc983c11f5d51ada0396faa6afe0e74631b62
+  data.tar.gz: bc6fbda96ef8a92b3f942fab6e3bcea0ebc0b4cba356e65de2be1619ebde84da
+SHA512:
+  metadata.gz: 4ef1ae651f583db8517f1aeac0ca7a21d4e002f41698f7515aceba6fd4cca8e837b5d6d4908a3d4db4af5fc7f555d73f38022cc11d2c065615e3966ae81d8afd
+  data.tar.gz: 1cd438f7090ba162bd965d9f9d6d019212c87fe66d98d87732294d03d59d1b4deeaddf70bf60bb8f5f4798893ff6579c375365328dddfe1960a6bf6831651870

data/.ruby-gemset

@@ -0,0 +1 @@
+error_extractor

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in error_extractor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "awesome_print"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    error_extractor (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.9.2)
+    minitest (5.19.0)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  awesome_print
+  error_extractor!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Daniel P. Zepeda
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Daniel P Zepeda
+
+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,65 @@
+# ErrorExtractor
+
+ErrorExtractor is a simple utility to extract errors from exceptions objects. It handles the different common ways an
+exception message may be presented, so that you don't have to worry about how an exception object presents the information,
+you just hand it to ErrorExtractor and get back a string you can print to a log or the console, etc.
+
+## Installation
+
+### Bundler 
+
+Add to your Gemfile:  
+
+    gem "error_extractor" github: "duskhacker/error-extractor.git"
+
+Then run bundler: 
+
+    $ bundle
+
+### No Bundler 
+
+At some point I'll get this gem uploaded to rubygems.org, but in the mean time, you'll have to: 
+
+1. Clone the Git repository.
+
+    `$ git clone git://github.com/duskhacker/error-extractor.git`
+
+2. Change to the new directory.
+
+    `$ cd error-extractor`
+
+3. Build the gem 
+
+    `$ rake build` 
+
+4. Install the gem.
+   
+    `$ gem install pkg/error_extractor-[version].gem`
+
+## Usage
+
+ErrorExtractor is meant to be used in rescue blocks:
+
+```
+begin
+
+    raise "an Error!"
+
+rescue => e 
+    log "An error occurred during processing: #{extract_errors(e)}" 
+    log "An error with a backtrace: #{extract_errors_with_backtrace(e)}"
+end 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/duskhacker/error-extractor.
+
+## 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 "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/error_extractor.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/error_extractor/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "error_extractor"
+  spec.version = ErrorExtractor::VERSION
+  spec.authors = ["Daniel P Zepeda"]
+  spec.email = ["daniel@zepeda.ws"]
+
+  spec.summary = "Extract errors from multiple sources"
+  spec.description = "Extract errors from multiple sources"
+  spec.homepage = "https://github.com/duskhacker/error-extractor"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

data/lib/error_extractor/version.rb

@@ -0,0 +1,3 @@
+module ErrorExtractor
+  VERSION = "0.1.0"
+end

data/lib/error_extractor.rb

@@ -0,0 +1,43 @@
+require_relative "error_extractor/version"
+
+module ErrorExtractor
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def extract_errors(e)
+    self.class.extract_errors(e)
+  end
+
+  def extract_errors_with_backtrace(e)
+    self.class.extract_errors_with_backtrace(e)
+  end
+
+  module ClassMethods
+    def extract_errors(e)
+      if e.respond_to?(:record) && __present?(e.record) && __present?(e.record&.errors&.full_messages&.to_sentence)
+        e.record.errors.full_messages.to_sentence
+      elsif e.respond_to?(:message)
+        e.message
+      elsif e.respond_to?(:to_s)
+        e.to_s
+      else
+        e
+      end
+    end
+
+    def extract_errors_with_backtrace(e)
+        "#{extract_errors(e)}\n" +
+        "#{e.respond_to?(:backtrace) ? e.backtrace.join("\n") : ""}"
+    end
+  end
+
+  private
+
+  def __present?(o)
+    !o.nil? && o != ""
+  end
+end
+
+include ErrorExtractor

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: error_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel P Zepeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-22 00:00:00.000000000 Z
+dependencies: []
+description: Extract errors from multiple sources
+email:
+- daniel@zepeda.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- error_extractor.gemspec
+- lib/error_extractor.rb
+- lib/error_extractor/version.rb
+homepage: https://github.com/duskhacker/error-extractor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/duskhacker/error-extractor
+  source_code_uri: https://github.com/duskhacker/error-extractor
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Extract errors from multiple sources
+test_files: []