ntl-error_data 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6e0eb4aa4452b9708dc4aa0cada2507fe716d98ed510a19ee6b1c9ee697e4d5
+  data.tar.gz: 2775f7e875f61d21cb9b9a62ab000c02d3dbfb590785e34586fb33060981403c
+SHA512:
+  metadata.gz: 39f0882c396b42783d11e92e563d0d6be17f93ba243eb2728014eb7a8bdccc13e6fb0d3fbd23d46886d5a1e73d03df95aa52b7d5e269fc2e0feedfedca114ed1
+  data.tar.gz: 974e4b0fa92eb1191d5ce99a31083f547e9863f93b9dd71870cbbe8e986db25a61ead7835785a5e5bbe416f7515e9644e1f84bc8dda4fbc0727f55feca00060c

data/lib/error_data.rb

@@ -0,0 +1,10 @@
+require 'json'
+
+require 'schema'
+require 'casing'
+require 'transform'
+
+require 'error_data/error_data/backtrace/frame'
+require 'error_data/error_data/backtrace'
+require 'error_data/error_data'
+require 'error_data/convert'

data/lib/error_data/controls.rb

@@ -0,0 +1,4 @@
+require 'error_data/controls/error'
+require 'error_data/controls/error/backtrace'
+require 'error_data/controls/error/message'
+require 'error_data/controls/error_data'

data/lib/error_data/controls/error.rb

@@ -0,0 +1,23 @@
+class ErrorData
+  module Controls
+    module Error
+      Example = Class.new(RuntimeError)
+
+      OtherExample = Class.new(RuntimeError)
+
+      def self.example
+        error = Example.new(message)
+        error.set_backtrace(Backtrace.example)
+        error
+      end
+
+      def self.class_name
+        Example.name
+      end
+
+      def self.message
+        Message.example
+      end
+    end
+  end
+end

data/lib/error_data/controls/error/backtrace.rb

@@ -0,0 +1,79 @@
+class ErrorData
+  module Controls
+    module Error
+      module Backtrace
+        def self.example
+          [
+            Frames::First.text,
+            Frames::Second.text,
+            Frames::Third.text
+          ]
+        end
+
+        def self.other_example
+          [
+            Frames::First.text,
+            Frames::Third.text,
+            Frames::Second.text
+          ]
+        end
+
+        module Frames
+          module Text
+            def text
+              "#{filename}:#{line_number}:in `#{method_name}'"
+            end
+          end
+
+          module First
+            extend Text
+
+            def self.line_number
+              111
+            end
+
+            def self.filename
+              'some_file.rb'
+            end
+
+            def self.method_name
+              'some_method'
+            end
+          end
+
+          module Second
+            extend Text
+
+            def self.line_number
+              11
+            end
+
+            def self.filename
+              'some_other_file.rb'
+            end
+
+            def self.method_name
+              'some_other_method'
+            end
+          end
+
+          module Third
+            extend Text
+
+            def self.line_number
+              1
+            end
+
+            def self.filename
+              'yet_another_file.rb'
+            end
+
+            def self.method_name
+              'yet_another_method'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/error_data/controls/error/message.rb

@@ -0,0 +1,15 @@
+class ErrorData
+  module Controls
+    module Error
+      module Message
+        def self.example
+          'An example error'
+        end
+
+        def self.other_example
+          'A different error'
+        end
+      end
+    end
+  end
+end

data/lib/error_data/controls/error_data.rb

@@ -0,0 +1,167 @@
+class ErrorData
+  module Controls
+    module ErrorData
+      def self.example(class_name: nil, message: nil, backtrace: nil)
+        class_name ||= self.class_name
+        message ||= self.message
+        backtrace ||= self.backtrace
+
+        error_data = ::ErrorData.new
+
+        error_data.class_name = class_name
+        error_data.message = message
+
+        error_data.backtrace = backtrace
+
+        error_data
+      end
+
+      def self.class_name
+        Controls::Error.class_name
+      end
+
+      def self.message
+        Controls::Error.message
+      end
+
+      def self.backtrace
+        Backtrace.example
+      end
+
+      module Backtrace
+        def self.example
+          ::ErrorData::Backtrace.new.tap do |b|
+            b << Frames::First.example
+            b << Frames::Second.example
+            b << Frames::Third.example
+          end
+        end
+
+        def self.other_example
+          ::ErrorData::Backtrace.new.tap do |b|
+            b << Frames::First.example
+            b << Frames::Third.example
+            b << Frames::Second.example
+          end
+        end
+
+        module Frames
+          module First
+            def self.example
+              ::ErrorData::Backtrace::Frame.new.tap do |f|
+                f.line_number = Controls::Error::Backtrace::Frames::First.line_number
+                f.filename = Controls::Error::Backtrace::Frames::First.filename
+                f.method_name = Controls::Error::Backtrace::Frames::First.method_name
+              end
+            end
+          end
+
+          module Second
+            def self.example
+              ::ErrorData::Backtrace::Frame.new.tap do |f|
+                f.line_number = Controls::Error::Backtrace::Frames::Second.line_number
+                f.filename = Controls::Error::Backtrace::Frames::Second.filename
+                f.method_name = Controls::Error::Backtrace::Frames::Second.method_name
+              end
+            end
+          end
+
+          module Third
+            def self.example
+              ::ErrorData::Backtrace::Frame.new.tap do |f|
+                f.line_number = Controls::Error::Backtrace::Frames::Third.line_number
+                f.filename = Controls::Error::Backtrace::Frames::Third.filename
+                f.method_name = Controls::Error::Backtrace::Frames::Third.method_name
+              end
+            end
+          end
+        end
+      end
+
+      def self.data
+        data = {}
+
+        data[:class_name] = Controls::Error.class_name
+        data[:message] = Controls::Error.message
+
+        backtrace = [
+          {
+            :line_number => Controls::Error::Backtrace::Frames::First.line_number,
+            :filename => Controls::Error::Backtrace::Frames::First.filename,
+            :method_name => Controls::Error::Backtrace::Frames::First.method_name
+          },
+          {
+            :line_number => Controls::Error::Backtrace::Frames::Second.line_number,
+            :filename => Controls::Error::Backtrace::Frames::Second.filename,
+            :method_name => Controls::Error::Backtrace::Frames::Second.method_name
+          },
+          {
+            :line_number => Controls::Error::Backtrace::Frames::Third.line_number,
+            :filename => Controls::Error::Backtrace::Frames::Third.filename,
+            :method_name => Controls::Error::Backtrace::Frames::Third.method_name
+          }
+        ]
+
+        data[:backtrace] = backtrace
+
+        data
+      end
+
+      module JSON
+        def self.text
+          ::JSON.generate(data)
+        end
+
+        def self.data
+          {
+            'className' => Controls::Error.class_name,
+            'message' => Controls::Error.message,
+            'backtrace' => Backtrace.data
+          }
+        end
+
+        module Backtrace
+          def self.data
+            [
+              Frames::First.data,
+              Frames::Second.data,
+              Frames::Third.data
+            ]
+          end
+
+          module Frames
+            module First
+              def self.data
+                {
+                  'filename' => Controls::Error::Backtrace::Frames::First.filename,
+                  'lineNumber' => Controls::Error::Backtrace::Frames::First.line_number,
+                  'methodName' => Controls::Error::Backtrace::Frames::First.method_name
+                }
+              end
+            end
+
+            module Second
+              def self.data
+                {
+                  'filename' => Controls::Error::Backtrace::Frames::Second.filename,
+                  'lineNumber' => Controls::Error::Backtrace::Frames::Second.line_number,
+                  'methodName' => Controls::Error::Backtrace::Frames::Second.method_name
+                }
+              end
+            end
+
+            module Third
+              def self.data
+                {
+                  'filename' => Controls::Error::Backtrace::Frames::Third.filename,
+                  'lineNumber' => Controls::Error::Backtrace::Frames::Third.line_number,
+                  'methodName' => Controls::Error::Backtrace::Frames::Third.method_name
+                }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/error_data/convert.rb

@@ -0,0 +1,15 @@
+class ErrorData
+  module Convert
+    module Error
+      def self.call(standard_error)
+        error_data = ErrorData.build
+
+        error_data.class_name = standard_error.class.name
+        error_data.message = standard_error.message
+        error_data.set_backtrace(standard_error.backtrace)
+
+        error_data
+      end
+    end
+  end
+end

data/lib/error_data/error_data.rb

@@ -0,0 +1,67 @@
+class ErrorData
+  include Schema::DataStructure
+
+  attribute :class_name, String
+  attribute :message, String
+  attribute :backtrace, Backtrace, default: ->{ Backtrace.new }
+
+  def transform_write(data)
+    backtrace = data.delete(:backtrace)
+
+    backtrace_data = backtrace.to_a
+
+    data[:backtrace] = backtrace_data
+  end
+
+  def transform_read(data)
+    backtrace = data.delete(:backtrace)
+
+    return if backtrace.nil?
+
+    backtrace.each do |frame_data|
+      frame = Backtrace::Frame.build(frame_data)
+
+      self.backtrace.add_frame(frame)
+    end
+  end
+
+  def set_backtrace(backtrace)
+    self.backtrace = Backtrace.parse(backtrace)
+  end
+
+  def correspond?(error)
+    error_corresponds =
+      class_name == error.class.name &&
+      message == error.message
+
+    backtrace_corresponds = backtrace.text_frames == error.backtrace
+
+    error_corresponds && backtrace_corresponds
+  end
+
+  module Transform
+    def self.json
+      JSON
+    end
+
+    def self.raw_data(instance)
+      instance.attributes
+    end
+
+    def self.instance(raw_data)
+      ErrorData.build(raw_data)
+    end
+
+    module JSON
+      def self.read(text)
+        formatted_data = ::JSON.parse(text, symbolize_names: true)
+        Casing::Underscore.(formatted_data)
+      end
+
+      def self.write(raw_data)
+        formatted_data = Casing::Camel.(raw_data)
+        ::JSON.generate(formatted_data)
+      end
+    end
+  end
+end

data/lib/error_data/error_data/backtrace.rb

@@ -0,0 +1,39 @@
+class ErrorData
+  class Backtrace
+    include Schema::DataStructure
+
+    attribute :frames, Array, default: ->{ Array.new }
+
+    def add_frame(frame)
+      frames << frame
+      self
+    end
+    alias :<< :add_frame
+
+    def each(&blk)
+      frames.each &blk
+    end
+
+    def text_frames
+      frames.map do |frame|
+        frame.to_s
+      end
+    end
+
+    def to_a
+      frames.map do |frame|
+        frame.to_h
+      end
+    end
+
+    def self.parse(backtrace)
+      instance = new
+
+      backtrace.each do |frame|
+        instance.add_frame(Frame.parse(frame))
+      end
+
+      instance
+    end
+  end
+end

data/lib/error_data/error_data/backtrace/frame.rb

@@ -0,0 +1,33 @@
+class ErrorData
+  class Backtrace
+    class Frame
+      include Schema::DataStructure
+
+      attribute :filename, String
+      attribute :line_number, Integer
+      attribute :method_name, String
+
+      def to_s
+        "#{filename}:#{line_number}:in `#{method_name}'"
+      end
+
+      def correspond?(backtrace_text)
+        to_s == backtrace_text
+      end
+
+      def self.parse(frame_text)
+        filename, line_number, method_name = frame_text.split(':')
+
+        line_number = Integer(line_number)
+
+        method_name.gsub!(/^in `(.*?)'$/, "\\1")
+
+        build({
+          :filename => filename,
+          :line_number => line_number,
+          :method_name => method_name
+        })
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ntl-error_data
+version: !ruby/object:Gem::Version
+  version: 0.1.0.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-casing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: evt-transform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/error_data.rb
+- lib/error_data/controls.rb
+- lib/error_data/controls/error.rb
+- lib/error_data/controls/error/backtrace.rb
+- lib/error_data/controls/error/message.rb
+- lib/error_data/controls/error_data.rb
+- lib/error_data/convert.rb
+- lib/error_data/error_data.rb
+- lib/error_data/error_data/backtrace.rb
+- lib/error_data/error_data/backtrace/frame.rb
+homepage: https://github.com/ntl/error-data
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key:
+specification_version: 4
+summary: Representation of an error as a data structure
+test_files: []