simple_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b41f5e2bc4aae37adeeafe28d802074c6275a2f2ca6f4adb8a45536f3b41e362
+  data.tar.gz: e56eb6bb951d112b7c31367ffc80b5b50e31d26b362047afa84d43ac0e33f1fb
+SHA512:
+  metadata.gz: fc6fa20a9d3e7f7b1d8e2ed06e1ca91d49c02174acdc8a2d7ce93ca375135a521e4d1fa21b4dc7011509f6f60f2e77a4b90928a2e2a669efcab212aa95fb32f9
+  data.tar.gz: 6ee47fd86e0b0e7823ddc01b6d0aa56538782f5afb174693603b8964b8d985f3051d4abda719c3aa61e825d5ee78a9ddca918c21115b5e3496e9d21ac1871769

data/Gemfile

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

data/README.md

@@ -0,0 +1,111 @@
+# SimpleTools
+
+Collection of classes which helps to organize code, increase readability and maintainability.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_tools', source: 'https://github.com/isidzukuri/simple_tools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_tools
+
+## Usage
+
+### Operation
+Inspired by trailblaizer operation.
+
+Idea is to put complex task(operation) in class, split it into commands(steps) and invoke each step one by one.
+
+```ruby
+class BasicOperation < SimpleTools::Operation
+  step :command_one
+  step :command_two
+
+  def command_one
+    p 'run some code'
+    update_context(:first_var, params[:some_value])
+  end
+
+  def command_two
+    context[:first_var]
+    p 'run other code'
+  end
+end
+```
+Example of calling operation:
+```ruby
+=> result = BasicOperation.call(some_value: 100)
+# 'run some code'
+# 'run other code'
+=> result.success?
+# true
+=> result.context[:first_var]
+# 100
+```
+
+`SimpleTools::Operation` respond to `.call` and can receive hash of parameters.
+Inside operation to share variables between steps use `update_context(:any_key, 'any value')` setter and `context[:any_key]` getter.
+
+`.call` returns object which respond to `.success?` and returns boolean value. 
+
+Also `.context` method is available which returns setted in operation values.
+
+If on some step occurs error next steps will not be invoked and current call of operation is considered as failed.
+
+```ruby
+class FailedOperation < SimpleTools::Operation
+  step :command_one
+  step :command_with_error
+  step :command_three
+
+  def command_one
+    p '1'
+  end
+
+  def command_with_error
+    p '2'
+    error!(:name, 'not valid message')
+    # or for multiple errors:
+    errors!({name: ['one more error', 'and another error']})
+    p '2.1'
+  end
+
+  def command_three
+    # will not run because :command_with_error has failed
+    p '3'
+  end
+end
+```
+`error!`, `errors!` - add new item(s) to list of errors. It do not raise exception and dont break execution of current method. 
+
+Example of calling failed operation:
+```ruby
+=> result = FailedOperation.call
+# 1
+# 2
+# 2.1
+=> result.success?
+# false
+=> result.errors
+# {name: ['error description', 'one more error', 'and another error']}
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/isidzukuri/simple_tools.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_tools"
+
+# 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/lib/simple_tools/operation.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module SimpleTools
+  class Operation
+    attr_reader :params, :errors, :context
+
+    class << self
+      attr_reader :steps
+
+      def call(params = {})
+        instance = new(params)
+        instance.call
+        instance
+      end
+
+      def step(key)
+        raise(ArgumentError, 'symbol should be given') unless key.is_a?(Symbol)
+
+        (@steps ||= []).push(key.to_sym)
+      end
+    end
+
+    def initialize(params)
+      @errors = {}
+      @context = {}
+      @params = params
+    end
+
+    def call
+      raise(ArgumentError, 'steps are not defined') unless self.class.steps
+
+      self.class.steps.each do |step|
+        public_send(step)
+        break unless success?
+      end
+    end
+
+    def success?
+      errors.empty?
+      # force developer to write descriptions of errors
+    end
+
+    def failure?
+      !success?
+    end
+
+    private
+
+    def update_context(key, value)
+      raise(ArgumentError, 'key can not be empty') unless present?(key)
+
+      @context[key] = value
+    end
+
+    def errors!(messages)
+      raise(ArgumentError, 'hash should be given') unless messages.is_a?(Hash)
+
+      messages.each do |key, value|
+        raise(ArgumentError, 'hash with array values should be given') unless value.is_a?(Array)
+
+        (@errors[key.to_sym] ||= []).push(*value)
+      end
+    end
+
+    def error!(key, message)
+      raise(ArgumentError, 'key can not be empty') unless present?(key)
+
+      raise(ArgumentError, 'message can not be empty') unless present?(message)
+
+      (@errors[key.to_sym] ||= []).push(message.to_s)
+    end
+
+    def present?(value)
+      value.respond_to?(:empty?) ? !value.empty? : !!value
+    end
+  end
+end

data/lib/simple_tools/version.rb

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

data/lib/simple_tools.rb

@@ -0,0 +1,5 @@
+require "simple_tools/version"
+require "simple_tools/operation"
+
+module SimpleTools
+end

data/simple_tools.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_tools'
+  spec.version       = SimpleTools::VERSION
+  spec.authors       = ['isidzukuri']
+  spec.email         = ['axesigon@gmail.com']
+
+  spec.summary       = 'Collection of classes which helps to organize code, increase readability and maintainability.'
+  spec.description   = 'Collection of classes which helps to organize code, increase readability and maintainability.'
+  spec.homepage      = 'https://github.com/isidzukuri/simple_tools'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) 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'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: simple_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- isidzukuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-12 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collection of classes which helps to organize code, increase readability
+  and maintainability.
+email:
+- axesigon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_tools.rb
+- lib/simple_tools/operation.rb
+- lib/simple_tools/version.rb
+- simple_tools.gemspec
+homepage: https://github.com/isidzukuri/simple_tools
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4
+signing_key: 
+specification_version: 4
+summary: Collection of classes which helps to organize code, increase readability
+  and maintainability.
+test_files: []