active_interaction 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86843e7e3d2f88ef4972b87361eab66961892eeb
-  data.tar.gz: dc9517aa3246d6310f114a3cb9ee3055f33a4e6c
+  metadata.gz: ddc5d64fad3052b09b16259d6aae6760411b384b
+  data.tar.gz: 1c3569cfc819b0153c2c875cf5674c29382fc956
 SHA512:
-  metadata.gz: 38e2212cb6e9a0ae10687cc07533e28406ca15d09c918fe5b7bf29202a4c384cf8179701878b360deaa17aa6d64965f65eeb9122292027553a1e7a075c6be936
-  data.tar.gz: 8049e3bab1696a64021bb89e37c5106351332b2eafb73d73c44bf62b6328fd3567ff0e0403c987a10e023386ba057be2c2906b9ad079701184ee76584570afc9
+  metadata.gz: 399f01cd79b55412083c29364afa80e53660e28ccbfc9d01788a138e30152ee61f4e6307e7a8f496a1b058557555ece132bf496b9e7d623b580e9414e203b030
+  data.tar.gz: c25734f3428395f3c063c7a6b1f867b65107dc806a7e5a391b38d8692fcd46a391cc8f3259aca4df2911bfb377fe45adb96393f7738eb2cfc7acde95cf401d86

data/CHANGELOG.md

@@ -1,11 +1,33 @@
 # [Master][]
 
-# [0.5.0][]
+# [0.6.1][] (2013-11-14)
+
+- Re-release. Forgot to merge into master.
+
+# [0.6.0][] (2013-11-14)
+
+- Error class now end with `Error`.
+- By default, strip unlisted keys from hashes. To retain the old behavior, set
+  `strip: false` on a hash filter.
+- Prevent specifying defaults (other than `nil` or `{}`) on hash filters. Set
+  defaults on the nested filters instead.
+- Add ability to introspect interactions with `filters`.
+- Fix bug that prevented listing multiple attributes in a hash filter.
+- Allow getting all of the user-supplied inputs in an interaction with
+  `inputs`.
+- Fix bug that prevented hash filters from being nested in array filters.
+- Replace `allow_nil: true` with `default: nil`.
+- Refactor internals.
+- Add a symbol filter.
+- Allow adding symbolic errors with `errors.add_sym` and retrieving them with
+  `errors.symbolic`.
+
+# [0.5.0][] (2013-10-16)
 
 - Allow adding errors in `execute` method with `errors.add`.
 - Prevent manually setting the outcome's result.
 
-# [0.4.0][]
+# [0.4.0][] (2013-08-15)
 
 - Support i18n translations.
 
@@ -48,7 +70,9 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v0.5.0...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v0.6.1...master
+  [0.6.1]: https://github.com/orgsync/active_interaction/compare/v0.6.0...v0.6.1
+  [0.6.0]: https://github.com/orgsync/active_interaction/compare/v0.5.0...v0.6.0
   [0.5.0]: https://github.com/orgsync/active_interaction/compare/v0.4.0...v0.5.0
   [0.4.0]: https://github.com/orgsync/active_interaction/compare/v0.3.0...v0.4.0
   [0.3.0]: https://github.com/orgsync/active_interaction/compare/v0.2.2...v0.3.0

data/README.md

@@ -15,7 +15,8 @@ to this.
 Take back control. Slim down models and wrangle monstrous controller
 methods with ActiveInteraction.
 
-Check out the full [documentation][] on RubyDoc.info.
+Read more on the [project page][] or check out the full [documentation][]
+on RubyDoc.info.
 
 ## Installation
 
@@ -24,7 +25,7 @@ This project uses [semantic versioning][].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 0.5.0'
+gem 'active_interaction', '~> 0.6.1'
 ```
 
 And then execute:
@@ -46,7 +47,7 @@ models ensure that certain options are provided and that those
 options are in the format you want them in. If the options are valid
 it will call `execute`, store the return value of that method in
 `result`, and return an instance of your ActiveInteraction::Base
-subclass. Let's looks at a simple example:
+subclass. Let's look at a simple example:
 
 ```ruby
 # Define an interaction that signs up a user.
@@ -55,7 +56,7 @@ class UserSignup < ActiveInteraction::Base
   string :email, :name
 
   # optional
-  boolean :newsletter_subscribe, allow_nil: true
+  boolean :newsletter_subscribe, default: nil
 
   # ActiveRecord validations
   validates :email, format: EMAIL_REGEX
@@ -160,10 +161,10 @@ end
     integer :age
     boolean :is_special
     model :account
-    array :tags, allow_nil: true do
+    array :tags, default: nil do
       string
     end
-    hash :prefs, allow_nil: true do
+    hash :prefs, default: nil do
       boolean :smoking
       boolean :view
     end
@@ -258,4 +259,5 @@ This project was inspired by the fantastic work done in [Mutations][].
   [documentation]: http://rubydoc.info/github/orgsync/active_interaction
   [gem version]: https://badge.fury.io/rb/active_interaction.png
   [mutations]: https://github.com/cypriss/mutations
+  [project page]: http://orgsync.github.io/active_interaction/
   [semantic versioning]: http://semver.org

data/lib/active_interaction.rb

@@ -2,11 +2,10 @@ require 'active_model'
 
 require 'active_interaction/version'
 require 'active_interaction/errors'
+require 'active_interaction/active_model'
+require 'active_interaction/method_missing'
 require 'active_interaction/overload_hash'
 require 'active_interaction/filter'
-require 'active_interaction/filter_method'
-require 'active_interaction/filter_methods'
-require 'active_interaction/filters/abstract_date_time_filter'
 require 'active_interaction/filters/array_filter'
 require 'active_interaction/filters/boolean_filter'
 require 'active_interaction/filters/date_filter'
@@ -17,7 +16,10 @@ require 'active_interaction/filters/hash_filter'
 require 'active_interaction/filters/integer_filter'
 require 'active_interaction/filters/model_filter'
 require 'active_interaction/filters/string_filter'
+require 'active_interaction/filters/symbol_filter'
 require 'active_interaction/filters/time_filter'
+require 'active_interaction/filters'
+require 'active_interaction/validation'
 require 'active_interaction/base'
 
 I18n.backend.load_translations(

data/lib/active_interaction/active_model.rb

@@ -0,0 +1,29 @@
+module ActiveInteraction
+  # @private
+  module ActiveModel
+    extend ::ActiveSupport::Concern
+
+    extend ::ActiveModel::Naming
+    include ::ActiveModel::Conversion
+    include ::ActiveModel::Validations
+
+    def new_record?
+      true
+    end
+
+    def persisted?
+      false
+    end
+
+    def i18n_scope
+      self.class.i18n_scope
+    end
+
+    # @private
+    module ClassMethods
+      def i18n_scope
+        :active_interaction
+      end
+    end
+  end
+end

data/lib/active_interaction/base.rb

@@ -15,7 +15,7 @@ module ActiveInteraction
   #     integer :a, :b
   #
   #     # Optional
-  #     integer :c, allow_nil: true
+  #     integer :c, default: nil
   #
   #     def execute
   #       sum = a + b
@@ -30,53 +30,59 @@ module ActiveInteraction
   #     p outcome.errors
   #   end
   class Base
-    extend ::ActiveModel::Naming
-    include ::ActiveModel::Conversion
-    include ::ActiveModel::Validations
+    include ActiveModel
+    extend MethodMissing
+    extend OverloadHash
 
-    # @private
-    def new_record?
-      true
+    validate do
+      Validation.validate(self.class.filters, inputs).each do |error|
+        errors.add_sym(*error)
+      end
     end
 
-    # @private
-    def persisted?
-      false
-    end
+    validate do
+      return unless instance_variable_defined?(:@_interaction_runtime_errors)
 
-    # @private
-    def self.i18n_scope
-      :active_interaction
-    end
+      @_interaction_runtime_errors.symbolic.each do |attribute, symbols|
+        symbols.each { |symbol| errors.add_sym(attribute, symbol) }
+      end
 
-    # @private
-    def i18n_scope
-      self.class.i18n_scope
+      @_interaction_runtime_errors.messages.each do |attribute, messages|
+        messages.each { |message| errors.add(attribute, message) }
+      end
     end
 
-    extend OverloadHash
-
-    validate do
-      return unless @_interaction_errors
-      @_interaction_errors.each do |attribute, message|
-        errors.add(attribute, message)
+    # Returns the inputs provided to {.run} or {.run!} after being cast based
+    #   on the filters in the class.
+    #
+    # @return [Hash{Symbol => Object}] All inputs passed to {.run} or {.run!}.
+    #
+    # @since 0.6.0
+    def inputs
+      self.class.filters.reduce({}) do |h, filter|
+        h[filter.name] = send(filter.name)
+        h
       end
     end
 
+    # @param options [Hash{Symbol => Object}] Attribute values to set.
+    #
     # @private
     def initialize(options = {})
-      options = options.with_indifferent_access
+      options = options.symbolize_keys
+
+      options.each do |key, value|
+        if key.to_s.start_with?('_interaction_')
+          raise InvalidValueError, key.inspect
+        end
 
-      if options.has_key?(:result)
-        raise ArgumentError, ':result is reserved and can not be used'
+        instance_variable_set("@#{key}", value)
       end
 
-      options.each do |attribute, value|
-        method = "_filter__#{attribute}="
-        if respond_to?(method, true)
-          send(method, value)
-        else
-          instance_variable_set("@#{attribute}", value)
+      self.class.filters.each do |filter|
+        begin
+          send("#{filter.name}=", filter.clean(options[filter.name]))
+        rescue InvalidValueError, MissingValueError
         end
       end
     end
@@ -87,6 +93,8 @@ module ActiveInteraction
     #   This method is run in a transaction if ActiveRecord is available.
     #
     # @raise [NotImplementedError] if the method is not defined.
+    #
+    # @abstract
     def execute
       raise NotImplementedError
     end
@@ -97,12 +105,22 @@ module ActiveInteraction
     # @return [Nil] if there are validation errors.
     # @return [Object] if there are no validation errors.
     def result
-      @_interaction_result
+      symbol = :'@_interaction_result'
+      if instance_variable_defined?(symbol)
+        instance_variable_get(symbol)
+      else
+        nil
+      end
+    end
+
+    # @private
+    def errors
+      @_interaction_errors ||= Errors.new(self)
     end
 
     # @private
     def valid?(*args)
-      super || instance_variable_set(:@_interaction_result, nil)
+      super || @_interaction_result = nil
     end
 
     # @private
@@ -115,27 +133,32 @@ module ActiveInteraction
         yield
       end
     end
-    private_class_method :transaction
 
-    # @!macro [new] run_attributes
-    #   @param options [Hash] Attribute values to set.
+    # Get all the filters defined on this interaction.
+    #
+    # @return [Filters]
+    #
+    # @since 0.6.0
+    def self.filters
+      @_interaction_filters ||= Filters.new
+    end
 
     # Runs validations and if there are no errors it will call {#execute}.
     #
-    # @macro run_attributes
+    # @param (see #initialize)
     #
     # @return [ActiveInteraction::Base] An instance of the class `run` is
     #   called on.
-    def self.run(options = {})
-      new(options).tap do |interaction|
+    def self.run(*args)
+      new(*args).tap do |interaction|
         if interaction.valid?
           result = transaction { interaction.execute }
 
           if interaction.errors.empty?
             interaction.instance_variable_set(:@_interaction_result, result)
           else
-            interaction.instance_variable_set(:@_interaction_errors,
-              interaction.errors.dup)
+            interaction.instance_variable_set(
+              :@_interaction_runtime_errors, interaction.errors.dup)
           end
         end
       end
@@ -144,93 +167,36 @@ module ActiveInteraction
     # Like {.run} except that it returns the value of {#execute} or raises an
     #   exception if there were any validation errors.
     #
-    # @macro run_attributes
-    #
-    # @raise [InteractionInvalid] if there are any errors on the model.
+    # @param (see .run)
     #
     # @return The return value of {#execute}.
-    def self.run!(options = {})
-      outcome = run(options)
+    #
+    # @raise [InteractionInvalidError] if there are any errors on the model.
+    def self.run!(*args)
+      outcome = run(*args)
       if outcome.invalid?
-        raise InteractionInvalid, outcome.errors.full_messages.join(', ')
+        raise InteractionInvalidError, outcome.errors.full_messages.join(', ')
       end
       outcome.result
     end
 
     # @private
-    def self.method_missing(type, *args, &block)
-      filter = Filter.factory(type)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      args.each do |attribute|
-        set_up_reader(attribute, filter, options, &block)
-        set_up_writer(attribute, filter, options, &block)
-        set_up_validator(attribute, type, filter, options, &block)
-      end
-    end
-    private_class_method :method_missing
-
-    # @private
-    def self.set_up_reader(attribute, filter, options, &block)
-      default = nil
-      if options.has_key?(:default)
-        begin
-          default = filter.
-            prepare(attribute, options[:default], options, &block)
-        rescue InvalidNestedValue, InvalidValue
-          raise InvalidDefaultValue
-        end
-      end
+    def self.method_missing(*args, &block)
+      super do |klass, names, options|
+        raise InvalidFilterError, 'no name' if names.empty?
 
-      define_method(attribute) do
-        symbol = "@#{attribute}"
-        if instance_variable_defined?(symbol)
-          instance_variable_get(symbol)
-        else
-          default
-        end
-      end
-    end
-    private_class_method :set_up_reader
-
-    # @private
-    def self.set_up_writer(attribute, filter, options, &block)
-      attr_writer attribute
-
-      writer = "_filter__#{attribute}="
-
-      define_method(writer) do |value|
-        value =
-          begin
-            filter.prepare(attribute, value, options, &block)
-          rescue InvalidNestedValue, InvalidValue, MissingValue
-            value
+        names.each do |attribute|
+          if attribute.to_s.start_with?('_interaction_')
+            raise InvalidFilterError, attribute.inspect
           end
-        instance_variable_set("@#{attribute}", value)
-      end
-      private writer
-    end
-    private_class_method :set_up_writer
 
-    # @private
-    def self.set_up_validator(attribute, type, filter, options, &block)
-      validator = "_validate__#{attribute}__#{type}"
-
-      validate validator
+          filter = klass.new(attribute, options, &block)
+          filters.add(filter)
+          attr_accessor filter.name
 
-      define_method(validator) do
-        begin
-          filter.prepare(attribute, send(attribute), options, &block)
-        rescue InvalidNestedValue
-          errors.add(attribute, :invalid_nested)
-        rescue InvalidValue
-          errors.add(attribute, :invalid,
-                     type: I18n.translate("#{i18n_scope}.types.#{type.to_s}"))
-        rescue MissingValue
-          errors.add(attribute, :missing)
+          filter.default if filter.has_default?
         end
       end
-      private validator
     end
-    private_class_method :set_up_validator
   end
 end