steppy 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b128da90504e724d13b80d528e0b2a6ae30ca2e4c66e4cdd73469fd39ada2d7
-  data.tar.gz: 0a0a54f5c5998e49b36dc72dfae5187e3a091d2196cb3480cb4b24208127c6c4
+  metadata.gz: 30867b1459b5e8f622fab73e25889a6fe09d208be7ffbf7cb5690ca084db7663
+  data.tar.gz: 7be40ff6c8e140c27249ab0722b90ddcab93ab5a01a12665f00ea6caddcd6293
 SHA512:
-  metadata.gz: 3fff21268b6b4c85f470ff3bf15560a33431c76b4ef18cc587253d2a011e3d1934d6264ca064724aca96385f38081065b833ce6a2907f44a453aaf70e3c30b30
-  data.tar.gz: 243916f06fcd329bd99ce81969a24d2ba38abe2da50c62d1f48f9d918b9862a75c474be08a851fb8f9825af1ea6ca731aa79c5829588aa3d4d41b3a230599ba7
+  metadata.gz: b081ebbfd0946d7a7ad50f98c52f81009cf26d8deeaf472ac41e2d96c36b8fc3bf98467d9be740bd8dac11389f512e77555e5450d6f45b3a3b2c713bba37d1e5
+  data.tar.gz: f7bd1e7b9fedd99b7067da79bb7c0303581bbc7623874f42ce5462a3cb8e25303abdf4f66a6c012053a88cd00670ed502e5f3fb403db6219ba8c93034245b5be

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+tags
 .*
 # allow these files/folders
 !.gitignore

data/.rubocop.yml

@@ -1,3 +1,4 @@
+---
 inherit_from:
   - .rubocop_airbnb.yml
 
@@ -11,9 +12,6 @@ Style/FrozenStringLiteralComment:
   SupportedStyles:
     - always
 
-Style/StringLiterals:
-  Enabled: true
-
 AllCops:
   TargetRubyVersion: 2.5
 
@@ -23,5 +21,14 @@ Airbnb/ClassOrModuleDeclaredInWrongFile:
 Airbnb/ModuleMethodInWrongFile:
   Enabled: false
 
+Airbnb/OptArgParameters:
+  Enabled: false
+
 Lint/EndAlignment:
   EnforcedStyleAlignWith: variable
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes

data/.rubocop_airbnb.yml

@@ -1,2 +1,3 @@
+---
 require:
   - rubocop-airbnb

data/Gemfile

@@ -7,4 +7,4 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in steppy.gemspec
 gemspec
 
-gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+gem 'byebug', platforms: %i(mri mingw x64_mingw)

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    steppy (0.8.0)
+    steppy (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    awesome_print (1.8.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
@@ -14,6 +15,7 @@ GEM
     byebug (10.0.2)
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
+    coderay (1.1.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
@@ -22,11 +24,15 @@ GEM
     equalizer (0.0.11)
     ice_nine (0.11.2)
     json (2.1.0)
+    method_source (0.9.2)
     minitest (5.11.3)
     parallel (1.12.1)
     parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
     reek (4.8.2)
@@ -51,6 +57,8 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    super_awesome_print (0.2.5)
+      awesome_print
     thread_safe (0.3.6)
     unicode-display_width (1.4.0)
     virtus (1.0.5)
@@ -66,12 +74,14 @@ DEPENDENCIES
   bundler (~> 1.16)
   byebug
   minitest (~> 5.1)
+  pry
   rake (~> 10.0)
   reek (~> 4.8.1)
   rubocop (~> 0.52.1)
   rubocop-airbnb
   simplecov (~> 0.16.1)
   steppy!
+  super_awesome_print
 
 BUNDLED WITH
-   1.16.2
+   1.17.2

data/Rakefile

@@ -9,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/lib/steppy.rb

@@ -12,14 +12,10 @@ module Steppy
   end
 
   # :reek:TooManyStatements
-  def self.parse_step(method:, args:, block:)
-    if args.key?(:if)
-      args[:condition] = args.delete(:if)
-    end
+  def self.parse_step(method:, args:, block: nil)
+    args[:condition] = -> { steppy_run_condition(args[:if]) } if args.key?(:if)
 
-    if args.key?(:unless)
-      args[:condition] = -> { !steppy_run_condition(args.delete(:unless)) }
-    end
+    args[:condition] = -> { !steppy_run_condition(args[:unless]) } if args.key?(:unless)
 
     args[:prefix] = :step unless args.key?(:prefix)
 
@@ -41,31 +37,84 @@ module Steppy
       steppy_cache[:sets] += sets
     end
 
-    def step(method = nil, args = {}, &block) # rubocop:disable Airbnb/OptArgParameters
-      steppy_cache[:steps].push(
-        Steppy.parse_step({ method: method, args: args, block: block })
+    def step(method = nil, args = {}, &block)
+      steps.push(
+        Steppy.parse_step(method: method, args: args, block: block)
       )
       self
     end
+
     alias step_return step
 
     def step_if(condition, &block)
-      steppy_cache[:steps].push(condition: condition, block: block)
+      steps.push(condition: condition, block: block)
       self
     end
 
     def step_unless(condition, &block)
-      steppy_cache[:steps].push(condition: -> { !steppy_run_condition(condition) }, block: block)
+      steps.push(condition: -> { !steppy_run_condition(condition) }, block: block)
       self
     end
 
-    def step_rescue(exceptions = nil, &block) # rubocop:disable Airbnb/OptArgParameters
+    def step_rescue(exceptions = nil, &block)
       steppy_cache[:rescues].push(exceptions: exceptions, block: block)
       self
     end
 
+    def step_if_else(condition_block, step_steps, args = {})
+      if_step, else_step = step_steps
+
+      steps.push Steppy.parse_step(
+        method: if_step,
+        args: {
+          if: condition_block,
+        }.merge(args)
+      )
+
+      steps.push Steppy.parse_step(
+        method: else_step,
+        args: {
+          unless: condition_block,
+        }.merge(args)
+      )
+    end
+
+    def step_after(key = nil, &block)
+      step_add_callback(:after, block, key)
+    end
+
+    def step_before(key = nil, &block)
+      step_add_callback(:before, block, key)
+    end
+
+    def step_add_callback(type, block, key)
+      callback_key = key ? key.to_sym : :global
+      callbacks = step_callbacks[type][callback_key] ||= []
+      callbacks.push(block)
+    end
+
+    def steps
+      steppy_cache[:steps]
+    end
+
+    def step_callbacks
+      steppy_cache[:callbacks]
+    end
+
     def steppy_cache
-      @steppy_cache ||= SteppyCache.new(steps: [], sets: [], rescues: [])
+      @steppy_cache ||= SteppyCache.new(
+        steps: [],
+        sets: [],
+        rescues: [],
+        callbacks: {
+          before: {
+            global: [],
+          },
+          after: {
+            global: [],
+          },
+        }
+      )
     end
   end
 
@@ -73,7 +122,7 @@ module Steppy
   module InstanceMethods
     attr_reader :steppy_cache
 
-    def steppy(attributes, cache = {})
+    def steppy(attributes = {}, cache = {})
       steppy_initialize_cache({ attributes: attributes, prefix: :step }.merge(cache))
 
       if steppy_cache.key?(:block)
@@ -81,7 +130,7 @@ module Steppy
       else
         steppy_run(steppy_cache)
       end
-    rescue => exception
+    rescue StandardError => exception
       steppy_rescue exception, steppy_cache[:rescues]
     end
 
@@ -89,9 +138,10 @@ module Steppy
       steppy_sets(sets)
     end
 
-    def step(method = nil, args = {}, &block) # rubocop:disable Airbnb/OptArgParameters
-      steppy_run_step Steppy.parse_step({ method: method, args: args, block: block })
+    def step(method = nil, args = {}, &block)
+      steppy_run_step Steppy.parse_step(method: method, args: args, block: block)
     end
+
     alias step_return step
 
     def step_if(condition, &block)
@@ -137,10 +187,9 @@ module Steppy
 
     def steppy_rescue(exception, rescues)
       exception_class = exception.class
+      has_exception = exception_class == SteppyError || rescues.empty?
 
-      if exception_class == SteppyError || rescues.empty?
-        raise exception
-      end
+      raise exception if has_exception
 
       rescues.each do |exceptions:, block:|
         if !exceptions || (exceptions && !exceptions.include?(exception_class))
@@ -152,9 +201,7 @@ module Steppy
     end
 
     def steppy_run_condition_block(condition, block)
-      if steppy_run_condition(condition)
-        steppy_run(steppy_cache_from_block(block))
-      end
+      steppy_run(steppy_cache_from_block(block)) if steppy_run_condition(condition)
     end
 
     def steppy_run_condition(condition)
@@ -168,23 +215,34 @@ module Steppy
     end
 
     def steppy_run_step(method:, args:, block:)
-      if !steppy_run_condition(args[:condition]) || (
-          steppy_cache[:prefix] != args[:prefix]
-      )
+      if !steppy_run_condition(args[:condition]) || (steppy_cache[:prefix] != args[:prefix])
         return steppy_result
       end
 
+      step_callbacks(:before, method, args, args)
+
       result = if block
         instance_exec(steppy_attributes, &block)
       else
         steppy_run_method(method, steppy_attributes)
       end
 
+      step_callbacks(:after, method, result, args)
+
       steppy_set(args[:set], result)
 
       result
     end
 
+    def step_callbacks(type, method, result, args)
+      callbacks = steppy_cache[:callbacks][type]
+      method_callbacks = (callbacks[method] || [])
+
+      callbacks[:global].concat(method_callbacks).each do |callback|
+        instance_exec(result, args, &callback)
+      end
+    end
+
     def steppy_run_method(method_name, attributes)
       method = "#{steppy_cache[:prefix]}_#{method_name}"
 

data/lib/steppy/error.rb

@@ -3,9 +3,8 @@
 # Incase you need to throw an error related to steppy
 class SteppyError < StandardError
   attr_reader :steppy
-  # rubocop:disable Airbnb/OptArgParameters
+
   def initialize(steppy = nil)
-    # rubocop:enable Airbnb/OptArgParameters
     if steppy
       @steppy = steppy
       message = steppy.is_a?(String) ? steppy : steppy.to_json

data/lib/steppy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Steppy
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 end

data/steppy.gemspec

@@ -5,28 +5,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'steppy/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'steppy'
-  spec.version       = Steppy::VERSION
-  spec.authors       = ['cj']
-  spec.email         = ['cjlazell@gmail.com']
+  spec.name = 'steppy'
+  spec.version = Steppy::VERSION
+  spec.authors = ['cj']
+  spec.email = ['cjlazell@gmail.com']
 
-  spec.summary       = %q()
-  spec.description   = %q()
-  spec.homepage      = 'https://github.com/cj/steppy'
-  spec.license       = 'MIT'
+  spec.summary = ''
+  spec.description = ''
+  spec.homepage = 'https://github.com/cj/steppy'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 'minitest', '~> 5.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'reek', '~> 4.8.1'
   spec.add_development_dependency 'rubocop', '~> 0.52.1'
   spec.add_development_dependency 'rubocop-airbnb'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'super_awesome_print'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steppy
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - cj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,33 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: super_awesome_print
+  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:
 - cjlazell@gmail.com
@@ -153,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: ''