erlash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3141fb9ca30266bcc7d0af47bd7eb3033f5a48e02aeae9bd0b4c7eb5aea38ced
+  data.tar.gz: c1bb0dc9ad4671409ec0fd0b8d31d45b0c97c8a6e1577f3b57af6df07b4c6aca
+SHA512:
+  metadata.gz: 1da3b16b757c08eabecd637d6429a1d91dfcf1c525f1eeb2c10933a3bc0e60f8fa15d47f47b0925074b2bd7649c95f1a0a4320acb5f078e7612007c87e1b813a
+  data.tar.gz: c53b02164e363bbc1ceb2b8a319194586a370ce5372e4589f5b87e8e5087d88a804338feb1a14cd2985de9c4d575669fef3bf2ba515e3454a841bc7a20b951c5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arturictus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in erlash.gemspec
+gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    erlash (0.1.0)
+      fusu
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    fusu (0.2.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  erlash!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Artur
+
+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,193 @@
+# Erlash
+
+Erlash is a easy way to create meaningful errors.
+The ruby implementation for errors is hard and tedious to create errors that explain
+what exactly the error was.
+In production you can find errors that do not explain the context and gives you no clue what's going on.
+
+You can find errors like:
+
+```
+ValidationError:
+  email already token
+```
+
+Wouldn't be nice to have more information about the error?
+
+example:
+```
+RequestError:
+ Problem:
+   User is unable to update his email
+ Summary:
+   Validation errors: email already token
+ Context:
+   - request_id: `123`
+   - user: { id: 1, email: `mail@example.com` }
+   - endpoint: `PUT /users/1`
+   - params: { email: `another@email.com` }
+```
+
+To build this kind of errors with the standard library is very tedious and not reusable.
+With erlash creating meaningful errors is easy.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erlash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install erlash
+
+## Usage
+
+```ruby
+class MyError < Erlash::Base; end
+
+raise Myerror, { user_id: 1, request_id: 120, controller: 'users_controller' }
+# Myerror:
+#   - user_id: 1
+#   - request_id: 120
+#   - controller: `users_controller`
+```
+
+```ruby
+class MyError < Erlash::Base;
+  problem -> { |context| "Please user `#{context[:user_id]}` be careful" }
+  summary "This error usually happens when user is desperate for the bug"
+  resolution -> { |context| "User.find(#{context[:user_id]}).fix" }
+end
+
+raise Myerror, { user_id: 1, request_id: 120, controller: 'users_controller' }
+# Myerror:
+#  Problem:
+#    Please user `1` be careful
+#  Summary:
+#    This error usually happens when user is desperate for the bug
+#  Resolution:
+#    User.find(1).fix
+#  Context:
+#    - user_id: 1
+#    - request_id: 120
+#    - controller: `users_controller`
+```
+
+### Formatters
+Erlash is fully customizable.
+You can add formatters for your objects or override the default ones.
+
+__Create your formatter:__
+
+Create a class that inherits from `Erlash::TemplateFormatter` and add a `format`
+method to it.
+
+```ruby
+class MyUserFormatter < Erlash::TemplateFormatter
+  def format
+    "And the name is: #{object.name}"
+  end
+end
+```
+
+__Register your formatter:__
+
+When registering a formatter you should provide the class is going to format as first argument.
+Arguments:
+- class to be formatted. ex: `User`
+- formatter for given class. ex: `MyUserFormatter`
+
+```ruby
+Erlash.formatters.register(User, MyUserFormatter)
+```
+
+__Erlash::TemplateFormatter__
+
+Accessible methods:
+- `object`: is an instance of the registered class. in the example `User` instance
+- `format_elem`: will try to find a formatter for given object if not will default `to_s`
+
+  * args: [object]
+
+example:
+
+```ruby
+class User
+  def email
+    "mail@example.com"
+  end
+  def id; 1 end
+  def errors
+    "email already token"
+  end
+end
+
+class Erlash::UserFormatter < Erlash::TemplateFormatter
+  def format
+    format_elem({
+      id: object.id,
+      email: object.email
+    }) # it will be formatted by the registered formatter for Hash
+  end
+end
+
+Erlash.formatters.register(User, Erlash::UserFormatter)
+
+class RequestError < Erlash::Base
+  problem "User is unable to update his email"
+  summary do |context|
+    "Validation errors: #{context[:user].errors}"
+  end
+end
+
+raise RequestError.new(request_id: '123', user: User.new, endpoint: 'PUT /users/1', params: {email: "another@email.com"})
+# RequestError:
+#   Problem:
+#     User is unable to update his email
+#   Summary:
+#     Validation errors: email already token
+#   Context:
+#     - request_id: `123`
+#     - user: { id: 1, email: `mail@example.com` }
+#     - endpoint: `PUT /users/1`
+#     - params: { email: `another@email.com` }
+```
+
+Default formatters:
+
+* `Array` => `Erlash::ArrayFormatter`
+* `Hash` => `Erlash::HashFormatter`
+* `String` => `Erlash::StringFormatter`
+
+Custom Erlash classes:
+
+* `Erlash::Tip` => `Erlash::TipFormatter`
+* `Erlash::Context` => `Erlash::ContextFormatter`
+* `Erlash::MainArray` => `Erlash::MainArrayFormatter`
+* `Erlash::MainHash` => `Erlash::MainHashFormatter`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arturictus/erlash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Erlash project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/erlash/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "erlash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/erlash.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "erlash/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "erlash"
+  spec.version       = Erlash::VERSION
+  spec.authors       = ["Artur"]
+  spec.email         = ["arturictus@gmail.com"]
+
+  spec.summary       = %q{Handle your errors gracefully.}
+  spec.description   = %q{Error abstraction to simplify the creation of descriptive errors.}
+  spec.homepage      = "https://github.com/arturictus/erlash"
+  spec.license       = "MIT"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'fusu'
+end

data/lib/erlash/base.rb

@@ -0,0 +1,90 @@
+module Erlash
+  class Base < StandardError
+    class << self
+      def problem(arg = nil, &block)
+        @problem = block || arg
+      end
+      def summary(arg = nil, &block)
+        @summary = block || arg
+      end
+      def resolution(arg = nil, &block)
+        @resolution = block || arg
+      end
+      def display_context(arg)
+        @display_context = arg
+      end
+      def _display_context
+        defined?(@display_context) ? @display_context : true
+      end
+    end
+    attr_reader :input, :opts
+
+    def initialize(input = nil, opts = {})
+      @input = input
+      @opts = default_opts.merge(opts)
+      set_formatter
+      super(formatter.to_s)
+    end
+
+    def problem
+      @problem ||= exec_config(self.class.instance_variable_get(:@problem))
+    end
+    def summary
+      @summary ||= exec_config(self.class.instance_variable_get(:@summary))
+    end
+    def resolution
+      @resolution ||= exec_config(self.class.instance_variable_get(:@resolution))
+    end
+
+    def hints?
+      !!(problem || summary || resolution)
+    end
+
+    private
+
+    def set_formatter
+      formatter.tap do |f|
+        f << Tip.new('Problem:', problem) if problem
+        f << Tip.new('Summary:', summary) if summary
+        f << Tip.new('Resolution:', resolution) if resolution
+        f << Context.new(self, context) if display_context?
+      end
+    end
+
+    def default_opts
+      {
+        display_context: self.class._display_context
+      }
+    end
+    def display_context?
+      opts[:display_context]
+    end
+
+    def registry
+      Erlash.formatters
+    end
+
+    def formatter
+      @formatter ||= Formatter.new(registry)
+    end
+
+    def context
+      @context ||= case input
+                   when Array
+                     Erlash::MainArray.build(input)
+                   when Hash
+                     Erlash::MainHash.build(input)
+                   else
+                     input
+                   end
+    end
+
+    def exec_config(val)
+      if val.is_a?(Proc)
+        val.call(context)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/erlash/context.rb

@@ -0,0 +1,9 @@
+module Erlash
+  class Context
+    attr_reader :formatter, :value
+    def initialize(formatter, value)
+      @formatter = formatter
+      @value = value
+    end
+  end
+end

data/lib/erlash/formatter.rb

@@ -0,0 +1,52 @@
+module Erlash
+  class Formatter
+    # def self.call(inst, obj)
+    #   registry = inst.registry
+    #   formatter = registry.find(obj.class)
+    #   if formatter
+    #     formatter.call(inst, obj)
+    #   elsif obj.respond_to?(:to_erlash)
+    #     obj.to_erlash
+    #   else
+    #     obj.to_s
+    #   end
+    # end
+
+    def self.format(inst, obj)
+      registry = inst.registry
+      formatter = registry.find(obj.class)
+      if formatter
+        formatter.format(inst, obj)
+      else
+        obj.to_s
+      end
+    end
+
+    attr_reader :registry, :output, :objs, :options
+    def initialize(registry, options = {})
+      @registry = registry
+      @output = StringIO.new
+      @objs = []
+      @options = options
+    end
+
+    def <<(elem)
+      objs << elem
+    end
+
+    def to_s
+      return @to_s if defined?(@to_s)
+      objs.each do |e|
+        output.puts format_elem(e)
+      end
+      @to_s = output.string
+    end
+    alias_method :string, :to_s
+
+    private
+
+    def format_elem(elem)
+      self.class.format(self, elem)
+    end
+  end
+end

data/lib/erlash/formatters/array_formatter.rb

@@ -0,0 +1,8 @@
+module Erlash
+  class ArrayFormatter < TemplateFormatter
+    def format
+      elems = object.map{ |e| format_elem(e) }
+      "[ #{elems.join(", ")} ]"
+    end
+  end
+end

data/lib/erlash/formatters/array_recursive_formatter.rb

@@ -0,0 +1,35 @@
+module Erlash
+  # Experimental
+  class ArrayRecursiveFormatter < TemplateFormatter
+    class Nested < Struct.new(:val, :offset); end
+
+    def format
+      recursive_format
+    end
+
+    private
+
+    def recursive_format
+      objs = recursive_nesting(object)
+      objs.each_with_object([]) do |n, s|
+        if n.val.is_a?(Hash)
+          format_elem(n.val).each do |fh|
+            s << "#{"  "*n.offset}#{fh}"
+          end
+        else
+          s << " #{"  "*n.offset} - #{format_elem(n.val)}"
+        end
+      end.flatten.join("\n")
+    end
+
+    def recursive_nesting(e, acc = [], offset = 0)
+      if e.is_a?(Array)
+        e.each{ |i| recursive_nesting(i, acc, offset + 1)}
+      else
+        acc << Nested.new(e, offset)
+      end
+      acc
+    end
+
+  end
+end

data/lib/erlash/formatters/context_formatter.rb

@@ -0,0 +1,10 @@
+module Erlash
+  class ContextFormatter < TemplateFormatter
+    def format
+      [].tap do |acc|
+        acc << 'Context:' if object.formatter.hints?
+        acc << format_elem(object.value)
+      end
+    end
+  end
+end

data/lib/erlash/formatters/hash_experimental_formatter.rb

@@ -0,0 +1,19 @@
+module Erlash
+  # Experimental
+  class HashExperimentalFormatter < TemplateFormatter
+    def format
+      experimental_formatting
+    end
+
+    def experimental_formatting
+      object.each_with_object([]) do |(k, v), s|
+        if v.is_a?(Array)
+          s << "  - #{k}:"
+          s << "#{format_elem(v)}"
+        else
+          s << "  - #{k}: #{format_elem(v)}"
+        end
+      end
+    end
+  end
+end

data/lib/erlash/formatters/hash_formatter.rb

@@ -0,0 +1,12 @@
+module Erlash
+  # ex:
+  #    {foo: "foo"} => { foo: `foo` }
+  class HashFormatter < TemplateFormatter
+    def format
+      elems = object.each_with_object([]) do |(k,v), o|
+                o << "#{k}: #{format_elem(v)}"
+              end
+      "{ #{elems.join(", ")} }"
+    end
+  end
+end

data/lib/erlash/formatters/main_array_formatter.rb

@@ -0,0 +1,9 @@
+module Erlash
+  class MainArrayFormatter < TemplateFormatter
+    def format
+      object.each_with_object([]) do |e, s|
+        s << "  - #{format_elem(e)}"
+      end
+    end
+  end
+end

data/lib/erlash/formatters/main_hash_formatter.rb

@@ -0,0 +1,9 @@
+module Erlash
+  class MainHashFormatter < TemplateFormatter
+    def format
+      object.each_with_object([]) do |(k, v), s|
+        s << "  - #{k}: #{format_elem(v)}"
+      end
+    end
+  end
+end

data/lib/erlash/formatters/string_formatter.rb

@@ -0,0 +1,8 @@
+module Erlash
+  # ex: `string`
+  class StringFormatter < TemplateFormatter
+    def format
+      "`#{object}`"
+    end
+  end
+end

data/lib/erlash/formatters/template_formatter.rb

@@ -0,0 +1,49 @@
+module Erlash
+  # ex:
+  #    class HelloFormatter < TemplateFormatter
+  #      def format
+  #        object.greetings
+  #      end
+  #    end
+  class TemplateFormatter
+
+    def self.call(*args)
+      new(*args).safe_call; nil
+    end
+
+    def self.format(*args)
+      new(*args).format
+    end
+
+    attr_reader :object, :opts, :output, :formatter
+    def initialize(formatter, object, opts = {})
+      @object = object
+      @opts = opts
+      @formatter = formatter
+      @output = formatter.output
+      @executed = false
+    end
+
+    def format
+      raise NotImplementedMethod
+    end
+
+    def safe_call
+      return if @executed
+      call
+      @excuted = true
+    end
+
+    def format_elem(elem)
+      Formatter.format(formatter, elem)
+    end
+
+    protected
+
+    def call
+      @call ||= Fusu::Array.wrap(format).each do |e|
+                  output.puts e
+                end
+    end
+  end
+end

data/lib/erlash/formatters/tip_formatter.rb

@@ -0,0 +1,10 @@
+module Erlash
+  class TipFormatter < TemplateFormatter
+    def format
+      [].tap do |acc|
+        acc << object.title
+        acc << "  #{object.description}"
+      end
+    end
+  end
+end

data/lib/erlash/formatters.rb

@@ -0,0 +1,30 @@
+module Erlash
+  class Formatters
+    include Enumerable
+
+    def find(klass)
+      db[klass]
+    end
+
+    def register(klass, val, opts = {})
+      db[klass] = val
+    end
+
+    def each(&block)
+      db.each(&block)
+    end
+
+    private
+
+    def db
+      @db ||= Fusu::HashWithIndifferentAccess.new
+    end
+  end
+end
+
+# first require template
+require 'erlash/formatters/template_formatter'
+# then the rest of formatters
+Dir[File.expand_path("./formatters", __dir__) + "**/*rb"].each do |f|
+  require f
+end

data/lib/erlash/main_array.rb

@@ -0,0 +1,9 @@
+module Erlash
+  class MainArray < Array
+    def self.build(ary)
+      ary.each_with_object(self.new) do |e, o|
+        o << e
+      end
+    end
+  end
+end

data/lib/erlash/main_hash.rb

@@ -0,0 +1,9 @@
+module Erlash
+  class MainHash < Hash
+    def self.build(hash)
+      hash.each_with_object(self.new) do |(k, v), o|
+        o[k] = v
+      end
+    end
+  end
+end

data/lib/erlash/testing.rb

@@ -0,0 +1,72 @@
+module Erlash
+  module Testing
+    class FileAlreadyWrittenError < Erlash::Base
+      display_context false
+      problem { |context| "File written at: #{context[:filename]}" }
+      summary "Review the file and remove second parametter to start testing"
+      resolution "expected_message('name'){ |expected| expect(message).to eq(expected) }"
+    end
+
+    class MessageNotRegisteredError < Erlash::Base
+      display_context false
+      problem { |context| "File does not exists at: #{context[:filename]}" }
+      summary "Example file is not yet registered please register content as second parametter"
+      resolution "expected_message('name', 'content'){ |expected| expect(message).to eq(expected) }"
+    end
+    class OverrideFileNotAllowedError < Erlash::Base
+      display_context false
+      problem { |context| "File already exists at: #{context[:filename]}" }
+      summary "Example file already exists if you want to override it please remove the file to create a new one"
+      resolution { |context| "Remove second parametter Or rm #{context[:filename]}" }
+    end
+
+    def self.messages_path=(path)
+      @messages_path = path
+    end
+
+    def self.messages_path
+      @messages_path
+    end
+
+    def erlash_messages_path
+      @erlash_messages_path ||= Pathname.new(Erlash::Testing.messages_path)
+    end
+
+    def expected_message(name, message = nil, &block)
+      filename = erlash_filename(name)
+      file_exists = File.exists?(filename)
+      if message
+        if file_exists
+          raise OverrideFileNotAllowedError, { filename: filename }
+        else
+          File.open(filename, 'w') { |f| f.write(message) }
+          raise FileAlreadyWrittenError, { filename: filename }
+        end
+      else
+        if file_exists
+          block.call(File.read(filename))
+        else
+          raise MessageNotRegisteredError, { filename: filename }
+        end
+      end
+    end
+
+    private
+
+    def erlash_filename(input)
+      erlash_messages_path.join("#{input}.error")
+    end
+
+    if defined?(RSpec)
+      undef :erlash_filename
+      def erlash_filename(input)
+        name = if input.is_a?(RSpec::Core::Example)
+                 input.full_description.gsub("\s", "_")
+               else
+                 input
+               end
+        erlash_messages_path.join("#{name}.error")
+      end
+    end
+  end
+end

data/lib/erlash/tip.rb

@@ -0,0 +1,3 @@
+module Erlash
+  class Tip < Struct.new(:title, :description); end
+end

data/lib/erlash/version.rb

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

data/lib/erlash.rb

@@ -0,0 +1,27 @@
+require "erlash/version"
+require "fusu"
+
+module Erlash
+  class << self
+    def formatters
+      @formatters ||= Formatters.new
+    end
+  end
+end
+require 'erlash/tip'
+require 'erlash/context'
+require 'erlash/base'
+require 'erlash/main_array'
+require 'erlash/main_hash'
+require 'erlash/formatter'
+require 'erlash/formatters'
+
+Erlash.formatters.tap do |f|
+  f.register Array, Erlash::ArrayFormatter
+  f.register Hash, Erlash::HashFormatter
+  f.register String, Erlash::StringFormatter
+  f.register Erlash::Context, Erlash::ContextFormatter
+  f.register Erlash::MainArray, Erlash::MainArrayFormatter
+  f.register Erlash::MainHash, Erlash::MainHashFormatter
+  f.register Erlash::Tip, Erlash::TipFormatter
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: erlash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fusu
+  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'
+description: Error abstraction to simplify the creation of descriptive errors.
+email:
+- arturictus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- erlash.gemspec
+- lib/erlash.rb
+- lib/erlash/base.rb
+- lib/erlash/context.rb
+- lib/erlash/formatter.rb
+- lib/erlash/formatters.rb
+- lib/erlash/formatters/array_formatter.rb
+- lib/erlash/formatters/array_recursive_formatter.rb
+- lib/erlash/formatters/context_formatter.rb
+- lib/erlash/formatters/hash_experimental_formatter.rb
+- lib/erlash/formatters/hash_formatter.rb
+- lib/erlash/formatters/main_array_formatter.rb
+- lib/erlash/formatters/main_hash_formatter.rb
+- lib/erlash/formatters/string_formatter.rb
+- lib/erlash/formatters/template_formatter.rb
+- lib/erlash/formatters/tip_formatter.rb
+- lib/erlash/main_array.rb
+- lib/erlash/main_hash.rb
+- lib/erlash/testing.rb
+- lib/erlash/tip.rb
+- lib/erlash/version.rb
+homepage: https://github.com/arturictus/erlash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Handle your errors gracefully.
+test_files: []