active_interaction 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dfc633bc6a2816016866f2a1a61c2a20805c28a
-  data.tar.gz: 53931759d4d2158be56ada22b2398a7ab539f119
+  metadata.gz: ec03f8a492e5db88366e50b9a918ff40a4e008b3
+  data.tar.gz: 356b91990bfac14981a6d36dffcaafb4e3dd2d33
 SHA512:
-  metadata.gz: 8c1a71ae668feffea91020d19b0c48633efd39c15404e6a3bfdbcaf6edef9a5f278402c7504ca77141ce761864a32ec09f8c2f6aab8b1b5b8a7951be9a132f74
-  data.tar.gz: bc56f77840ac9e9aace55893e73b4746bd0b95de9eb2e755648101f152fdd861ebfd6f4f786c6bb2e892a57604095a67c0ed0400a0ba1bf084cd40e5c67c798d
+  metadata.gz: a68094094d6dbf8a395a3f709ffd993944512c6edc921ce36f99b4383792de041954cc2d73271a0748102782f89c4e457bb63288ee56eb34e42ff6cb38fbcbd5
+  data.tar.gz: d682f33e94ea7bd25f4f9cf89e2fe3924bc501e608c6d32f469da42d92782f88aca01b43605c69adb5de62e36b2cafe3857307ff927a2306dbbb25ef334c4f93

data/CHANGELOG.md

@@ -1,8 +1,20 @@
-# [1.6.1][] (2015-10-02)
+# [2.0.0][] (2015-05-06)
 
-## Fixed
+## Changed
+
+- [#250][]: Replaced symbolic errors with Rails 5-style detailed errors.
+- [#269][]: Prevented proc defaults from being eagerly evaluated.
+- [#264][]: Renamed `model` filter to `object`.
+- [#213][]: Remove transaction support. Database transactions will need to be
+  handled manually now.
+- [#214][]: Results are returned from invalid outcomes.
+- [#164][]: Changed the `hash` filter to use hashes with indifferent access.
+- [#236][]: Changed the `file` filter to accept anything that responds to `eof?`.
+
+## Security
 
-- [#303][]: Allowed ActiveRecord associations as inputs to array filters.
+- [#215][]: Rather than symbolizing keys all hashes now use indifferent access.
+  This takes care of potential but unlikely DoS attacks noted in [#163][].
 
 # [1.6.0][] (2015-05-06)
 
@@ -402,7 +414,7 @@
 
 - Initial release.
 
-  [1.6.1]: https://github.com/orgsync/active_interaction/compare/v1.6.0...v1.6.1
+  [2.0.0]: https://github.com/orgsync/active_interaction/compare/v1.6.0...v2.0.0
   [1.6.0]: https://github.com/orgsync/active_interaction/compare/v1.5.1...v1.6.0
   [1.5.1]: https://github.com/orgsync/active_interaction/compare/v1.5.0...v1.5.1
   [1.5.0]: https://github.com/orgsync/active_interaction/compare/v1.4.1...v1.5.0
@@ -505,6 +517,7 @@
   [#155]: https://github.com/orgsync/active_interaction/issues/155
   [#156]: https://github.com/orgsync/active_interaction/issues/156
   [#163]: https://github.com/orgsync/active_interaction/issues/163
+  [#164]: https://github.com/orgsync/active_interaction/issues/164
   [#165]: https://github.com/orgsync/active_interaction/issues/165
   [#173]: https://github.com/orgsync/active_interaction/issues/173
   [#174]: https://github.com/orgsync/active_interaction/issues/174
@@ -517,11 +530,17 @@
   [#203]: https://github.com/orgsync/active_interaction/issues/203
   [#206]: https://github.com/orgsync/active_interaction/issues/206
   [#207]: https://github.com/orgsync/active_interaction/issues/207
+  [#213]: https://github.com/orgsync/active_interaction/issues/213
+  [#214]: https://github.com/orgsync/active_interaction/issues/214
+  [#215]: https://github.com/orgsync/active_interaction/issues/215
   [#224]: https://github.com/orgsync/active_interaction/issues/224
   [#235]: https://github.com/orgsync/active_interaction/issues/235
+  [#236]: https://github.com/orgsync/active_interaction/issues/236
   [#239]: https://github.com/orgsync/active_interaction/issues/239
   [#244]: https://github.com/orgsync/active_interaction/issues/244
   [#248]: https://github.com/orgsync/active_interaction/issues/248
+  [#250]: https://github.com/orgsync/active_interaction/issues/250
   [#256]: https://github.com/orgsync/active_interaction/issues/256
+  [#264]: https://github.com/orgsync/active_interaction/issues/264
   [#265]: https://github.com/orgsync/active_interaction/issues/265
-  [#303]: https://github.com/orgsync/active_interaction/issues/303
+  [#269]: https://github.com/orgsync/active_interaction/issues/269

data/README.md

@@ -39,7 +39,7 @@ Read more on [the project page][] or check out [the full documentation][].
   - [File](#file)
   - [Hash](#hash)
   - [Interface](#interface)
-  - [Model](#model)
+  - [Object](#object)
   - [String](#string)
   - [Symbol](#symbol)
   - [Dates and times](#dates-and-times)
@@ -75,13 +75,13 @@ Read more on [the project page][] or check out [the full documentation][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 1.6'
+gem 'active_interaction', '~> 2.0'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 1.6'
+$ gem install active_interaction --version '~> 2.0'
 ```
 
 This project uses [Semantic Versioning][]. Check out [the change log][] for a
@@ -124,8 +124,8 @@ end
 Call `.run` on your interaction to execute it. You must pass a single hash to
 `.run`. It will return an instance of your interaction. By convention, we call
 this an outcome. You can use the `#valid?` method to ask the outcome if it's
-valid. If it's invalid, take a look at its errors with `#errors`. If it's
-valid, `#result` will be the value returned from `#execute`.
+valid. If it's invalid, take a look at its errors with `#errors`. In either
+case, the value returned from `#execute` will be stored in `#result`.
 
 ``` rb
 outcome = Square.run(x: 'two point one')
@@ -379,11 +379,11 @@ InterfaceInteraction.run!(serializer: JSON)
 # => "{\"is_json\":true}"
 ```
 
-### Model
+### Object
 
-Model filters allow you to require an instance of a particular class. It checks
-either `#is_a?` on the instance or `.===` on the class. Because of that, it
-also works with classes that have mixed modules in with `include`.
+Object filters allow you to require an instance of a particular class. It
+checks either `#is_a?` on the instance or `.===` on the class. Because of that,
+it also works with classes that have mixed modules in with `include`.
 
 ``` rb
 class Cow
@@ -392,17 +392,17 @@ class Cow
   end
 end
 
-class ModelInteraction < ActiveInteraction::Base
-  model :cow
+class ObjectInteraction < ActiveInteraction::Base
+  object :cow
 
   def execute
     cow.moo
   end
 end
 
-ModelInteraction.run!(cow: Object.new)
-# ActiveInteraction::InvalidInteractionError: Cow is not a valid model
-ModelInteraction.run!(cow: Cow.new)
+ObjectInteraction.run!(cow: Object.new)
+# ActiveInteraction::InvalidInteractionError: Cow is not a valid object
+ObjectInteraction.run!(cow: Cow.new)
 # => "Moo!"
 ```
 
@@ -411,11 +411,11 @@ name is different than your class name, use the `class` option. It can be
 either the class, a string, or a symbol.
 
 ``` rb
-model :dolly1,
+object :dolly1,
   class: Sheep
-model :dolly2,
+object :dolly2,
   class: 'Sheep'
-model :dolly3,
+object :dolly3,
   class: :Sheep
 ```
 
@@ -788,7 +788,7 @@ spot.
 
 ``` rb
 class DestroyAccount < ActiveInteraction::Base
-  model :account
+  object :account
 
   def execute
     account.destroy
@@ -822,7 +822,7 @@ Skip to [the predicates section](#predicates) for more information about them.
 
 ``` rb
 class UpdateAccount < ActiveInteraction::Base
-  model :account
+  object :account
 
   string :first_name, :last_name,
     default: nil
@@ -1004,14 +1004,14 @@ end
 
 ### Errors
 
-ActiveInteraction provides symbolic errors for easier introspection and testing
-of errors. Symbolic errors improve on regular errors by adding a symbol that
+ActiveInteraction provides detailed errors for easier introspection and testing
+of errors. Detailed errors improve on regular errors by adding a symbol that
 represents the type of error that has occurred. Let's look at an example where
 an item is purchased using a credit card.
 
 ``` rb
 class BuyItem < ActiveInteraction::Base
-  model :credit_card, :item
+  object :credit_card, :item
   hash :options do
     boolean :gift_wrapped
   end
@@ -1034,28 +1034,30 @@ errors.
 ``` rb
 outcome = BuyItem.run(item: 'Thing', options: { gift_wrapped: 'yes' })
 outcome.errors.messages
-# => {:credit_card=>["is required"], :item=>["is not a valid model"], :options=>["has an invalid nested value (\"gift_wrapped\" => \"yes\")"]}
+# => {:credit_card=>["is required"], :item=>["is not a valid object"], :options=>["has an invalid nested value (\"gift_wrapped\" => \"yes\")"]}
 ```
 
 Determining the type of error based on the string is difficult if not
-impossible. Calling `#symbolic` instead of `#messages` on `errors` gives you
+impossible. Calling `#details` instead of `#messages` on `errors` gives you
 the same list of errors with a testable label representing the error.
 
 ``` rb
-outcome.errors.symbolic
-# => {"credit_card"=>[:missing], "item"=>[:invalid_type], "options"=>[:invalid_nested]}
+outcome.errors.details
+# => {:credit_card=>[{:error=>:missing}], :item=>[{:type=>"object", :error=>:invalid_type}], :options=>[{:name=>"\"gift_wrapped\"", :value=>"\"yes\"", :error=>:invalid_nested}]}
 ```
 
-Symbolic errors can also be manually added during the execute call by calling
-`#add_sym` instead of `#add` on `errors`. It works the same way as `add` except
-that the second argument is the error label.
+Detailed errors can also be manually added during the execute call by passing a
+symbol to `#add` instead of a string.
 
 ``` rb
 def execute
-  errors.add_sym(:monster, :no_passage, 'You shall not pass!')
+  errors.add(:monster, :no_passage)
 end
 ```
 
+These types of errors will become standard with Rails 5. ActiveInteraction's
+implementation is based off of [active_model-errors_details][].
+
 ActiveInteraction also supports merging errors. This is useful if you want to
 delegate validation to some other object. For example, if you have an
 interaction that updates a record, you might want that record to validate
@@ -1063,7 +1065,7 @@ itself. By using the `#merge!` helper on `errors`, you can do exactly that.
 
 ``` rb
 class UpdateThing < ActiveInteraction::Base
-  model :thing
+  object :thing
 
   def execute
     unless thing.save
@@ -1180,7 +1182,7 @@ hsilgne:
       hash: hsah
       integer: regetni
       interface: ecafretni
-      model: ledom
+      object: tcejbo
       string: gnirts
       symbol: lobmys
       time: emit
@@ -1225,6 +1227,7 @@ Logo design by [Tyler Lee][].
 [the full documentation]: http://rubydoc.info/github/orgsync/active_interaction
 [semantic versioning]: http://semver.org/spec/v2.0.0.html
 [the change log]: CHANGELOG.md
+[active_model-errors_details]: https://github.com/cowbell/active_model-errors_details
 [aaron lasseigne]: https://github.com/AaronLasseigne
 [taylor fausak]: https://github.com/tfausak
 [orgsync]: https://github.com/orgsync

data/lib/active_interaction.rb

@@ -9,7 +9,7 @@ require 'active_model'
 #
 # @since 1.0.0
 #
-# @version 1.6.1
+# @version 2.0.0
 module ActiveInteraction
   DEPRECATOR =
     if ::ActiveSupport::Deprecation.respond_to?(:new)
@@ -31,7 +31,6 @@ require 'active_interaction/concerns/active_modelable'
 require 'active_interaction/concerns/active_recordable'
 require 'active_interaction/concerns/hashable'
 require 'active_interaction/concerns/missable'
-require 'active_interaction/concerns/transactable'
 require 'active_interaction/concerns/runnable'
 
 require 'active_interaction/grouped_input'
@@ -42,6 +41,7 @@ require 'active_interaction/modules/validation'
 require 'active_interaction/filter_column'
 require 'active_interaction/filter'
 require 'active_interaction/filters/abstract_filter'
+require 'active_interaction/filters/interface_filter'
 require 'active_interaction/filters/abstract_date_time_filter'
 require 'active_interaction/filters/abstract_numeric_filter'
 require 'active_interaction/filters/array_filter'
@@ -53,8 +53,7 @@ require 'active_interaction/filters/file_filter'
 require 'active_interaction/filters/float_filter'
 require 'active_interaction/filters/hash_filter'
 require 'active_interaction/filters/integer_filter'
-require 'active_interaction/filters/interface_filter'
-require 'active_interaction/filters/model_filter'
+require 'active_interaction/filters/object_filter'
 require 'active_interaction/filters/string_filter'
 require 'active_interaction/filters/symbol_filter'
 require 'active_interaction/filters/time_filter'

data/lib/active_interaction/backports.rb

@@ -16,6 +16,53 @@ module ActiveInteraction
   class Errors # rubocop:disable Style/Documentation
     # Required for Rails < 3.2.13.
     protected :initialize_dup
+
+    # Required for Rails < 5.
+    #
+    # Extracted from active_model-errors_details 1.2.0. Modified to add support
+    # for ActiveModel 3.2.0.
+    module Details
+      extend ActiveSupport::Concern
+
+      CALLBACKS_OPTIONS = ::ActiveModel::Errors::CALLBACKS_OPTIONS
+      private_constant :CALLBACKS_OPTIONS
+
+      included do
+        attr_reader :details
+
+        %w[initialize initialize_dup add clear delete].each do |method|
+          alias_method_chain method, :details
+        end
+      end
+
+      def initialize_with_details(base)
+        @details = Hash.new { |details, attribute| details[attribute] = [] }
+        initialize_without_details(base)
+      end
+
+      def initialize_dup_with_details(other)
+        @details = other.details.deep_dup
+        initialize_dup_without_details(other)
+      end
+
+      def add_with_details(attribute, message = :invalid, options = {})
+        message = message.call if message.respond_to?(:call)
+        error = options.except(*CALLBACKS_OPTIONS).merge(error: message)
+        details[attribute].push(error)
+        add_without_details(attribute, message, options)
+      end
+
+      def clear_with_details
+        details.clear
+        clear_without_details
+      end
+
+      def delete_with_details(attribute)
+        details.delete(attribute)
+        delete_without_details(attribute)
+      end
+    end
+    include Details unless method_defined?(:details)
   end
 
   class HashFilter # rubocop:disable Style/Documentation

data/lib/active_interaction/base.rb

@@ -59,28 +59,6 @@ module ActiveInteraction
       #
       #   @raise (see ActiveInteraction::Runnable::ClassMethods#run!)
 
-      # @!method transaction(enable, options = {})
-      #   Configure transactions by enabling or disabling them and setting
-      #   their options.
-      #
-      #   @example Disable transactions
-      #     Class.new(ActiveInteraction::Base) do
-      #       transaction false
-      #     end
-      #
-      #   @example Use different transaction options
-      #     Class.new(ActiveInteraction::Base) do
-      #       transaction true, isolation: :serializable
-      #     end
-      #
-      #   @param enable [Boolean] Should transactions be enabled?
-      #   @param options [Hash] Options to pass to
-      #     `ActiveRecord::Base.transaction`.
-      #
-      #   @return [nil]
-      #
-      #   @since 1.2.0
-
       # Get or set the description.
       #
       # @example
@@ -174,7 +152,13 @@ module ActiveInteraction
         attr_accessor filter.name
         define_method("#{filter.name}?") { !public_send(filter.name).nil? }
 
-        filter.default if filter.default?
+        eagerly_evaluate_default(filter)
+      end
+
+      # @param filter [Filter]
+      def eagerly_evaluate_default(filter)
+        default = filter.options[:default]
+        filter.default if default && !default.is_a?(Proc)
       end
     end
 
@@ -201,8 +185,7 @@ module ActiveInteraction
     #
     #   Runs the business logic associated with the interaction. This method is
     #   only run when there are no validation errors. The return value is
-    #   placed into {#result}. By default, this method is run in a transaction
-    #   if ActiveRecord is available (see {.transaction}).
+    #   placed into {#result}.
     #
     #   @raise (see ActiveInteraction::Runnable#execute)
 

data/lib/active_interaction/concerns/runnable.rb

@@ -6,14 +6,12 @@ module ActiveInteraction
   #
   # @note Must be included after `ActiveModel::Validations`.
   #
-  # Runs code in transactions and only provides the result if there are no
-  #   validation errors.
+  # Runs code and provides the result.
   #
   # @private
   module Runnable
     extend ActiveSupport::Concern
     include ActiveModel::Validations
-    include ActiveInteraction::Transactable
 
     included do
       define_callbacks :execute
@@ -41,13 +39,8 @@ module ActiveInteraction
     #
     # @return (see #result)
     def result=(result)
-      if errors.empty?
-        @_interaction_result = result
-        @_interaction_valid = true
-      else
-        @_interaction_result = nil
-        @_interaction_valid = false
-      end
+      @_interaction_result = result
+      @_interaction_valid = errors.empty?
     end
 
     # @return [Boolean]
@@ -82,15 +75,12 @@ module ActiveInteraction
     def run
       return unless valid?
 
-      self.result = transaction do
+      self.result =
         begin
           run_callbacks(:execute) { execute }
         rescue Interrupt => interrupt
           merge_errors_onto_base(interrupt.outcome.errors)
-
-          raise ActiveRecord::Rollback if self.class.transaction?
         end
-      end
     end
 
     def merge_errors_onto_base(new_errors)