activeinteractor 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7136d8728ef016a9041ff462d8874af56028432ab839e8b7dab707b3ad1c59
-  data.tar.gz: 04f08a4985a45385885b165f26fb65a93f9952ea4d2c0849312d5ff63075770a
+  metadata.gz: 8990e7455e8d135a08b562e71a81bc6ca0e14b4b98f25505d73c6b02e2638466
+  data.tar.gz: cf16acdae03eb8a3d15808fd4a01a112143878e502c20dd3a9d4dfc6396ebc09
 SHA512:
-  metadata.gz: a6148b98fb26e34891e81fa84243f21d4db8460be907f69bae1a082ebce941ae3112c031aaba03086bba52b729fe358833b3a5fcbabb7e5fad505f29114eca6c
-  data.tar.gz: daa7e71d54dfd86195e0487ef4f0da05df2cd3a47e4067e520a86876d87492dd04bcc406157214c55434404d82dfb5c4358adc24546e6f7e60998d6e2f562a9a
+  metadata.gz: ed677499ed9140e3dffedcee26f77f3b2967b51d24b7eabf594cacbfb1bf0f3a1bb9bd76f6a94a1a5d0ac61dd190380871391b76fc1afa29f65ae44fa57c1a75
+  data.tar.gz: 874df56e5d15a5bcdda48c4297c5b5b64feed016d9c0ea84ac450b907569d49f8298e1b1d49929cac7e949522c31f94ef7a5f64426b5ad4ffbc70e1a2ccddb14

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [v0.1.5] - 2019-06-30
+
+### Added
+
+- [#39] `ActiveInteractor::Error` module
+
+### Deprecated
+
+- [#39] `ActiveInteractor::Context::Failure` in favor of `ActiveInteractor::Error::ContextFailure`
+
+### Security
+
+- [#33], [#37] Update rubocop: 0.67.2 → 0.72.0 (major)
+- [#34] Various dependency updates
+- [#38] Update yard: 0.9.19 → 0.9.20 (minor)
+
 ## [v0.1.4] - 2019-04-12
 
 ### Added
@@ -41,7 +57,8 @@ and this project adheres to [Semantic Versioning].
 
 <!-- versions -->
 
-[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.4..HEAD
+[Unreleased]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.5..HEAD
+[v0.1.5]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.4...v0.1.5
 [v0.1.4]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.3...v0.1.4
 [v0.1.3]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.2...v0.1.3
 [v0.1.2]: https://github.com/aaronmallen/activeinteractor/compare/v0.1.1...v0.1.2
@@ -54,3 +71,8 @@ and this project adheres to [Semantic Versioning].
 [#22]: https://github.com/aaronmallen/activeinteractor/pull/22
 [#25]: https://github.com/aaronmallen/activeinteractor/pull/25
 [#28]: https://github.com/aaronmallen/activeinteractor/pull/28
+[#33]: https://github.com/aaronmallen/activeinteractor/pull/33
+[#34]: https://github.com/aaronmallen/activeinteractor/pull/34
+[#37]: https://github.com/aaronmallen/activeinteractor/pull/37
+[#38]: https://github.com/aaronmallen/activeinteractor/pull/38
+[#39]: https://github.com/aaronmallen/activeinteractor/pull/39

data/README.md

@@ -124,7 +124,7 @@ context.success? # => false
 
 #### Dealing with Failure
 
-`context.fail!` always throws an exception of type `ActiveInteractor::Context::Failure`.
+`context.fail!` always throws an exception of type `ActiveInteractor::Error::ContextFailure`.
 
 Normally, however, these exceptions are not seen. In the recommended usage, the consuming
 object invokes the interactor using the class method call, then checks the `success?` method of
@@ -180,7 +180,7 @@ context.occupation #=> nil
 
 #### Aliasing Attributes
 
-Some times you may want to use the same interactor functionality with different
+Sometimes you may want to use the same interactor functionality with different
 model types having different naming conventions for similar attributes.  We can
 inform the interactors context of these aliases with the `context_attribute_aliases`
 method on our interactors.
@@ -192,7 +192,7 @@ class MyInteractor < ActiveInteractor::Base
 end
 
 context = MyInteractor.perform(first_name: 'Aaron', sir_name: 'Allen')
-# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'
+# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'>
 ```
 
 We can also pass an array of aliases to the attribute like this:
@@ -204,10 +204,10 @@ class MyInteractor < ActiveInteractor::Base
 end
 
 context = MyInteractor.perform(first_name: 'Aaron', sir_name: 'Allen')
-# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'
+# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'>
 
 context = MyInteractor.perform(first_name: 'Aaron', sirname: 'Allen')
-# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'
+# => <#MyInteractor::Context first_name='Aaron', last_name='Allen'>
 ```
 
 #### Validating the Context

data/lib/active_interactor/context/attributes.rb

@@ -4,11 +4,6 @@ require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/class/attribute'
 
 module ActiveInteractor
-  # ActiveInteractor::Context module
-  #
-  # @author Aaron Allen <hello@aaronmallen.me>
-  # @since 0.0.1
-  # @version 0.1
   module Context
     # Provides Context Attribute methods to included classes
     #

data/lib/active_interactor/context/errors.rb

@@ -4,6 +4,8 @@ module ActiveInteractor
   module Context
     # Raised when an interactor context fails
     #
+    # @deprecated Use {#ActiveInteractor::Error::ContextFailure} instead
+    #
     # @author Aaron Allen <hello@aaronmallen.me>
     # @since 0.0.1
     # @version 0.2

data/lib/active_interactor/context.rb

@@ -49,15 +49,15 @@ module ActiveInteractor
       #  #=> <#MyInteractor name='Aaron'>
       #
       #  interactor.context.fail!
-      #  #=> ActiveInteractor::Context::Failure: <#MyInteractor::Context name='Aaron'>
+      #  #=> ActiveInteractor::Error::ContextFailure: <#MyInteractor::Context name='Aaron'>
       #
       # @param errors [ActiveModel::Errors, Hash] errors to add to the context on failure
       # @see https://api.rubyonrails.org/classes/ActiveModel/Errors.html ActiveModel::Errors
-      # @raise [Failure]
+      # @raise [Error::ContextFailure]
       def fail!(errors = {})
         self.errors.merge!(errors) unless errors.empty?
         @_failed = true
-        raise Failure, self
+        raise Error::ContextFailure, self
       end
 
       # Whether the context instance has failed. By default, a new
@@ -73,7 +73,7 @@ module ActiveInteractor
       #  false
       #
       #  context.fail!
-      #  #=> ActiveInteractor::Context::Failure: <#MyInteractor::Context>
+      #  #=> ActiveInteractor::Error::ContextFailure: <#MyInteractor::Context>
       #
       #  context.failure?
       #  #=> true
@@ -138,7 +138,7 @@ module ActiveInteractor
       #  true
       #
       #  context.fail!
-      #  #=> ActiveInteractor::Context::Failure: <#MyInteractor::Context>
+      #  #=> ActiveInteractor::Error::ContextFailure: <#MyInteractor::Context>
       #
       #  context.success?
       #  #=> false

data/lib/active_interactor/error.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveInteractor
+  # ActiveInteractor::Error module
+  #
+  # @author Aaron Allen <hello@aaronmallen.me>
+  # @since 0.1.5
+  # @version 0.1
+  module Error
+    # Raised when an interactor context fails
+    #
+    # @author Aaron Allen <hello@aaronmallen.me>
+    # @since 0.1.5
+    # @version 0.1
+    #
+    # @!attribute [r] context
+    #  @return [Base] an instance of {Base}
+    class ContextFailure < StandardError
+      attr_reader :context
+
+      # A new instance of {ContextFailure}
+      # @param context [ActiveInteractor::Context::Base] an
+      #  instance of {ActiveInteractor::Context::Base}
+      # @return [ContextFailure] a new instance of {ContextFailure}
+      def initialize(context = nil)
+        @context = context
+        super
+      end
+    end
+  end
+end

data/lib/active_interactor/interactor/worker.rb

@@ -18,17 +18,17 @@ module ActiveInteractor
         @interactor = clone_interactor(interactor)
       end
 
-      # Calls {#execute_perform!} and rescues {ActiveInteractor::Context::Failure}
+      # Calls {#execute_perform!} and rescues {ActiveInteractor::Error::ContextFailure}
       # @return [ActiveInteractor::Context::Base] an instance of {ActiveInteractor::Context::Base}
       def execute_perform
         execute_perform!
-      rescue ActiveInteractor::Context::Failure => exception
-        ActiveInteractor.logger.error("ActiveInteractor: #{exception}")
+      rescue ActiveInteractor::Error::ContextFailure => e
+        ActiveInteractor.logger.error("ActiveInteractor: #{e}")
         context
       end
 
       # Calls {Interactor#perform} with callbacks and context validation
-      # @raise [ActiveInteractor::Context::Failure] if the context fails
+      # @raise [ActiveInteractor::Error::ContextFailure] if the context fails
       # @return [ActiveInteractor::Context::Base] an instance of {ActiveInteractor::Context::Base}
       def execute_perform!
         run_callbacks :perform do

data/lib/active_interactor/interactor.rb

@@ -36,7 +36,7 @@ module ActiveInteractor
 
       # Invoke an Interactor. The {.perform!} method behaves identically to
       #  the {.perform} method with one notable exception. If the context is failed
-      #  during invocation of the interactor, the {ActiveInteractor::Context::Failure}
+      #  during invocation of the interactor, the {ActiveInteractor::Error::ContextFailure}
       #  is raised.
       #
       # @example Run an interactor

data/lib/active_interactor/version.rb

@@ -3,5 +3,5 @@
 module ActiveInteractor
   # The ActiveInteractor gem version
   # @return [String] the gem version
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/active_interactor.rb

@@ -36,6 +36,10 @@ module ActiveInteractor
   autoload :Interactor
   autoload :Organizer
 
+  eager_autoload do
+    autoload :Error
+  end
+
   class << self
     # The ActiveInteractor configuration
     # @return [ActiveInteractor::Configuration] the configuration instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeinteractor
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Aaron Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -154,14 +154,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '0.67'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '0.67'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -222,6 +222,7 @@ files:
 - lib/active_interactor/context.rb
 - lib/active_interactor/context/attributes.rb
 - lib/active_interactor/context/errors.rb
+- lib/active_interactor/error.rb
 - lib/active_interactor/interactor.rb
 - lib/active_interactor/interactor/callbacks.rb
 - lib/active_interactor/interactor/context.rb
@@ -246,10 +247,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/aaronmallen/activeinteractor/issues
-  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v0.1.4/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/0.1.4
+  changelog_uri: https://github.com/aaronmallen/activeinteractor/blob/v0.1.5/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/activeinteractor/0.1.5
   hompage_uri: https://github.com/aaronmallen/activeinteractor
-  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v0.1.4
+  source_code_uri: https://github.com/aaronmallen/activeinteractor/tree/v0.1.5
   wiki_uri: https://github.com/aaronmallen/activeinteractor/wiki
 post_install_message: 
 rdoc_options: []
@@ -266,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby interactors with ActiveModel::Validations