active_interaction 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02f4ec454ba99aa3327ab6d539a8dd2f6e9b8622
-  data.tar.gz: e20fe1fb15d09040a7c00379962f53ac41d26cf1
+  metadata.gz: 152f0300bf27243acb0d7f0068b44a8b7c66fa8c
+  data.tar.gz: d2741f24682a5ede49215e0ddb7191625f27e189
 SHA512:
-  metadata.gz: ab410e55639bb75899387091d50213f0b53b4d58de8b4cc0c3cc36d9c0f2acdc247bfe88662d276ed635a3fc695631a291c6c1f6234a7a46c38b4615127b3c7f
-  data.tar.gz: f48693acfcc32d503fdc03af08cad9b2ed1a4c7fb32b7dac467f30e325ab97f3647c7b79d865686d26a1cd93fb04ca9b449e52a8d247086a3bd1cb27ab85aad2
+  metadata.gz: b2976e0ff9e7b3ad09181672922fad54b821b46f8e4380afa1eb6579121f4b7cc6fc854cd59bdbf983c5ab0047dc56744ebb010585016511cd8ea193a13b733c
+  data.tar.gz: a2f08efa2b55ebb4ebbc86f1ea51cce4d5adc465fe6d5cc8d2c6667a4aebeac40e87041d8690fd94b36a6f753b541ee58e70662c1836a56269fe71c932413a8d

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # [Master][]
 
-# [1.0.0][]
+# [1.0.1][] (2014-02-04)
+
+- Short circuit `valid?` after successfully running an interaction.
+- Fix a bug that prevented merging interpolated symbolic errors.
+- Use `:invalid_type` instead of `:invalid` as I18n key for type errors.
+- Fix a bug that skipped setting up accessors for imported filters.
+
+# [1.0.0][] (2014-01-21)
 
 - **Replace `Filters` with a hash.** To iterate over `Filter` objects, use
   `Interaction.filters.values`.
@@ -118,7 +125,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v1.0.0...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v1.0.1...master
+  [1.0.0]: https://github.com/orgsync/active_interaction/compare/v1.0.0...v1.0.1
   [1.0.0]: https://github.com/orgsync/active_interaction/compare/v0.10.2...v1.0.0
   [0.10.2]: https://github.com/orgsync/active_interaction/compare/v0.10.1...v0.10.2
   [0.10.1]: https://github.com/orgsync/active_interaction/compare/v0.10.0...v0.10.1

data/README.md

@@ -208,27 +208,26 @@ called it with `run!`). If something went wrong, execution will halt
 immediately and the errors will be moved onto the caller.
 
 ```ruby
-class DoSomeMath < ActiveInteraction::Base
-  integer :x, :y
+class AddThree < ActiveInteraction::Base
+  integer :x
   def execute
-    sum = compose(Add, inputs)
-    square = compose(Square, x: sum)
-    compose(Add, x: square, y: square)
+    compose(Add, x: x, y: 3)
   end
 end
-DoSomeMath.run!(x: 3, y: 5)
-# 128 => ((3 + 5) ** 2) * 2
+AddThree.run!(x: 5)
+# => 8
 ```
 
+To bring in filters from another interaction, use `import_filters`. Combined
+with `inputs`, delegating to another interaction is a piece of cake.
+
 ```ruby
-class AddThree < ActiveInteraction::Base
-  integer :y
+class AddAndDouble < ActiveInteraction::Base
+  import_filters Add
   def execute
-    compose(Add, x: 3, y: y)
+    compose(Add, inputs) * 2
   end
 end
-AddThree.run!(y: nil)
-# => ActiveInteraction::InvalidInteractionError: Y is required
 ```
 
 ## How do I translate an interaction?
@@ -258,7 +257,7 @@ hsilgne:
     errors:
       messages:
         invalid: dilavni si
-        invalid_nested: '%{type} dilav a ton si'
+        invalid_type: '%{type} dilav a ton si'
         missing: deriuqer si
 ```
 
@@ -283,7 +282,7 @@ work done in [Mutations][17].
   [0]: https://github.com/orgsync/active_interaction
   [1]: https://badge.fury.io/rb/active_interaction.png
   [2]: https://badge.fury.io/rb/active_interaction "Gem Version"
-  [3]: https://travis-ci.org/orgsync/active_interaction.png
+  [3]: https://travis-ci.org/orgsync/active_interaction.png?branch=master
   [4]: https://travis-ci.org/orgsync/active_interaction "Build Status"
   [5]: https://coveralls.io/repos/orgsync/active_interaction/badge.png
   [6]: https://coveralls.io/r/orgsync/active_interaction "Coverage Status"

data/lib/active_interaction.rb

@@ -42,5 +42,5 @@ I18n.backend.load_translations(
 #
 # @since 1.0.0
 #
-# @version 1.0.0
+# @version 1.0.1
 module ActiveInteraction end

data/lib/active_interaction/base.rb

@@ -37,6 +37,27 @@ module ActiveInteraction
       include Hashable
       include Missable
 
+      # @!method run(inputs = {})
+      #   @note If the interaction inputs are valid and there are no runtime
+      #     errors and execution completed successfully, {#valid?} will always
+      #     return true.
+      #
+      #   Runs validations and if there are no errors it will call {#execute}.
+      #
+      #   @param (see ActiveInteraction::Base#initialize)
+      #
+      #   @return [Base]
+
+      # @!method run!(inputs = {})
+      #   Like {.run} except that it returns the value of {#execute} or raises
+      #     an exception if there were any validation errors.
+      #
+      #   @param (see ActiveInteraction::Base.run)
+      #
+      #   @return (see ActiveInteraction::Runnable::ClassMethods#run!)
+      #
+      #   @raise (see ActiveInteraction::Runnable::ClassMethods#run!)
+
       # Get or set the description.
       #
       # @example
@@ -77,25 +98,6 @@ module ActiveInteraction
         end
       end
 
-      # @!method run(inputs = {})
-      #   Runs validations and if there are no errors it will call {#execute}.
-      #
-      #   @param (see ActiveInteraction::Base#initialize)
-      #
-      #   @return [Base]
-      loop
-
-      # @!method run!(inputs = {})
-      #   Like {.run} except that it returns the value of {#execute} or raises
-      #     an exception if there were any validation errors.
-      #
-      #   @param (see ActiveInteraction::Base.run)
-      #
-      #   @return (see ActiveInteraction::Runnable::ClassMethods#run!)
-      #
-      #   @raise (see ActiveInteraction::Runnable::ClassMethods#run!)
-      loop
-
       private
 
       # @param klass [Class]
@@ -104,12 +106,7 @@ module ActiveInteraction
       def add_filter(klass, name, options, &block)
         fail InvalidFilterError, name.inspect if reserved?(name)
 
-        filter = klass.new(name, options, &block)
-        filters[name] = filter
-        attr_accessor name
-        define_method("#{name}?") { !public_send(name).nil? }
-
-        filter.default if filter.default?
+        initialize_filter(klass.new(name, options, &block))
       end
 
       # Import filters from another interaction.
@@ -123,6 +120,8 @@ module ActiveInteraction
       #
       # @return (see .filters)
       #
+      # @raise [ArgumentError] If both `:only` and `:except` are given.
+      #
       # @!visibility public
       def import_filters(klass, options = {})
         if options.key?(:only) && options.key?(:except)
@@ -136,7 +135,7 @@ module ActiveInteraction
         other_filters.select! { |k, _| only.include?(k) } if only
         other_filters.reject! { |k, _| except.include?(k) } if except
 
-        filters.merge!(other_filters)
+        other_filters.values.each { |filter| initialize_filter(filter) }
       end
 
       # @param klass [Class]
@@ -144,6 +143,16 @@ module ActiveInteraction
         klass.instance_variable_set(:@_interaction_filters, filters.dup)
       end
 
+      # @param filter [Filter]
+      def initialize_filter(filter)
+        filters[filter.name] = filter
+
+        attr_accessor filter.name
+        define_method("#{filter.name}?") { !public_send(filter.name).nil? }
+
+        filter.default if filter.default?
+      end
+
       # @param symbol [Symbol]
       #
       # @return [Boolean]
@@ -169,7 +178,6 @@ module ActiveInteraction
     #   @param inputs (see ActiveInteraction::Base#initialize)
     #
     #   @return (see ActiveInteraction::Base.run!)
-    loop
 
     # @!method execute
     #   @abstract
@@ -180,7 +188,6 @@ module ActiveInteraction
     #     ActiveRecord is available.
     #
     #   @raise (see ActiveInteraction::Runnable#execute)
-    loop
 
     # Returns the inputs provided to {.run} or {.run!} after being cast based
     #   on the filters in the class.

data/lib/active_interaction/concerns/runnable.rb

@@ -56,15 +56,21 @@ module ActiveInteraction
       if errors.empty?
         @_interaction_result = result
         @_interaction_runtime_errors = nil
+        @_interaction_valid = true
       else
         @_interaction_result = nil
         @_interaction_runtime_errors = errors.dup
+        @_interaction_valid = false
       end
     end
 
     # @return [Boolean]
     def valid?(*)
-      super || (self.result = nil)
+      unless instance_variable_defined?(:@_interaction_valid)
+        @_interaction_valid = false
+      end
+
+      @_interaction_valid || super || (self.result = nil)
     end
 
     private

data/lib/active_interaction/errors.rb

@@ -90,15 +90,14 @@ module ActiveInteraction
     def add_sym(attribute, symbol = :invalid, message = nil, options = {})
       add(attribute, message || symbol, options)
 
-      symbolic[attribute] ||= []
-      symbolic[attribute] << symbol
+      symbolic[attribute] += [symbol]
     end
 
     # @see ActiveModel::Errors#initialize
     #
     # @private
     def initialize(*)
-      @symbolic = {}.with_indifferent_access
+      @symbolic = Hash.new([]).with_indifferent_access
 
       super
     end
@@ -128,7 +127,7 @@ module ActiveInteraction
     # @return [Errors]
     def merge!(other)
       other.symbolic.each do |attribute, symbols|
-        symbols.each { |s| add_sym(attribute, s) }
+        symbols.each { |s| symbolic[attribute] += [s] }
       end
 
       other.messages.each do |attribute, messages|

data/lib/active_interaction/filters/time_filter.rb

@@ -21,6 +21,9 @@ module ActiveInteraction
 
   # @private
   class TimeFilter < AbstractDateTimeFilter
+    alias_method :_klass, :klass
+    private :_klass
+
     def cast(value)
       case value
       when Numeric
@@ -41,7 +44,7 @@ module ActiveInteraction
     end
 
     def klasses
-      [Time, klass.at(0).class]
+      [_klass, klass.at(0).class]
     end
   end
 end

data/lib/active_interaction/modules/validation.rb

@@ -12,7 +12,7 @@ module ActiveInteraction
         begin
           filter.cast(inputs[name])
         rescue InvalidValueError
-          errors << [name, :invalid, nil, type: type(filter)]
+          errors << [name, :invalid_type, nil, type: type(filter)]
         rescue MissingValueError
           errors << [name, :missing]
         end

data/lib/active_interaction/version.rb

@@ -5,5 +5,5 @@ module ActiveInteraction
   # The version number.
   #
   # @return [Gem::Version]
-  ActiveInteraction::VERSION = Gem::Version.new('1.0.0')
+  VERSION = Gem::Version.new('1.0.1')
 end

data/spec/active_interaction/base_spec.rb

@@ -389,60 +389,68 @@ describe ActiveInteraction::Base do
   end
 
   describe '.import_filters' do
-    let(:described_class) do
-      Class.new(TestInteraction) do
-        import_filters AddInteraction
+    shared_context 'import_filters context' do
+      let(:klass) { AddInteraction }
+      let(:only) { nil }
+      let(:except) { nil }
+
+      let(:described_class) do
+        interaction = klass
+        options = {}
+        options[:only] = only unless only.nil?
+        options[:except] = except unless except.nil?
+
+        Class.new(TestInteraction) { import_filters interaction, options }
       end
     end
 
-    it 'imports the filters' do
-      expect(described_class.filters).to eq AddInteraction.filters
-    end
+    shared_examples 'import_filters examples' do
+      include_context 'import_filters context'
 
-    context 'with :only' do
-      let(:described_class) do
-        Class.new(TestInteraction) do
-          import_filters AddInteraction, only: [:x]
-        end
+      it 'imports the filters' do
+        expect(described_class.filters).to eq klass.filters
+          .select { |k, _| only.nil? ? true : only.include?(k) }
+          .reject { |k, _| except.nil? ? false : except.include?(k) }
       end
 
       it 'does not modify the source' do
-        filters = AddInteraction.filters.dup
+        filters = klass.filters.dup
         described_class
-        expect(AddInteraction.filters).to eq filters
+        expect(klass.filters).to eq filters
       end
 
-      it 'imports the filters' do
-        expect(described_class.filters).to eq AddInteraction.filters
-          .select { |k, _| k == :x }
-      end
-    end
+      it 'responds to readers, writers, and predicates' do
+        instance = described_class.new
 
-    context 'with :except' do
-      let(:described_class) do
-        Class.new(TestInteraction) do
-          import_filters AddInteraction, except: [:x]
+        described_class.filters.keys.each do |name|
+          [name, "#{name}=", "#{name}?"].each do |method|
+            expect(instance).to respond_to method
+          end
         end
       end
+    end
 
-      it 'does not modify the source' do
-        filters = AddInteraction.filters.dup
-        described_class
-        expect(AddInteraction.filters).to eq filters
-      end
+    context 'with neither :only nor :except' do
+      include_examples 'import_filters examples'
+    end
 
-      it 'imports the filters' do
-        expect(described_class.filters).to eq AddInteraction.filters
-          .reject { |k, _| k == :x }
-      end
+    context 'with :only' do
+      include_examples 'import_filters examples'
+
+      let(:only) { [:x] }
+    end
+
+    context 'with :except' do
+      include_examples 'import_filters examples'
+
+      let(:except) { [:x] }
     end
 
     context 'with :only & :except' do
-      let(:described_class) do
-        Class.new(TestInteraction) do
-          import_filters AddInteraction, only: nil, except: nil
-        end
-      end
+      include_context 'import_filters context'
+
+      let(:only) { [] }
+      let(:except) { [] }
 
       it 'raises an error' do
         expect { described_class }.to raise_error ArgumentError

data/spec/active_interaction/concerns/runnable_spec.rb

@@ -123,12 +123,6 @@ describe ActiveInteraction::Runnable do
       it 'returns false' do
         expect(instance).to_not be_valid
       end
-
-      it 'sets the result to nil' do
-        instance.result = result
-        instance.valid?
-        expect(instance.result).to be_nil
-      end
     end
   end
 
@@ -162,6 +156,29 @@ describe ActiveInteraction::Runnable do
         end
       end
     end
+
+    context 'with invalid post-execution state' do
+      before do
+        klass.class_exec do
+          attr_accessor :attribute
+
+          validate { errors.add(:attribute) if attribute }
+
+          def execute
+            self.attribute = true
+          end
+        end
+      end
+
+      it 'is valid' do
+        expect(outcome).to be_valid
+      end
+
+      it 'stays valid' do
+        outcome.attribute = true
+        expect(outcome).to be_valid
+      end
+    end
   end
 
   describe '.run!' do

data/spec/active_interaction/errors_spec.rb

@@ -10,7 +10,7 @@ describe ActiveInteraction::Errors do
       attr_reader :attribute
 
       def self.name
-        SecureRandom.hex
+        @name ||= SecureRandom.hex
       end
     end
   end
@@ -129,5 +129,21 @@ describe ActiveInteraction::Errors do
         expect(errors.symbolic[:attribute]).to eq [:invalid]
       end
     end
+
+    context 'with an interpolated symbolic error' do
+      before do
+        I18n.backend.store_translations('en', activemodel: {
+          errors: { models: { klass.name => { attributes: { attribute: {
+            invalid_type: 'is not a valid %{type}'
+          } } } } }
+        })
+
+        other.add_sym(:attribute, :invalid_type, type: nil)
+      end
+
+      it 'does not raise an error' do
+        expect { errors.merge!(other) }.to_not raise_error
+      end
+    end
   end
 end

data/spec/active_interaction/filters/model_filter_spec.rb

@@ -19,6 +19,26 @@ describe ActiveInteraction::ModelFilter, :filter do
       it 'returns the instance' do
         expect(filter.cast(value)).to eq value
       end
+
+      it 'handles reconstantizing' do
+        expect(filter.cast(value)).to eq value
+
+        Object.send(:remove_const, :Model)
+        Model = Class.new
+        value = Model.new
+
+        expect(filter.cast(value)).to eq value
+      end
+    end
+
+    context 'with class as a superclass' do
+      before do
+        options.merge!(class: Model.superclass)
+      end
+
+      it 'returns the instance' do
+        expect(filter.cast(value)).to eq value
+      end
     end
 
     context 'with class as a String' do

data/spec/active_interaction/i18n_spec.rb

@@ -39,30 +39,24 @@ describe I18nInteraction do
       let(:translation) { I18n.translate(key, type: type, raise: true) }
       let(:type) { I18n.translate("#{described_class.i18n_scope}.types.hash") }
 
-      context ':invalid' do
-        let(:key) { "#{described_class.i18n_scope}.errors.messages.invalid" }
+      shared_examples 'translations' do |key, value|
+        context key.inspect do
+          let(:key) { "#{described_class.i18n_scope}.errors.messages.#{key}" }
 
-        it 'has a translation' do
-          expect { translation }.to_not raise_error
-        end
-
-        it 'returns the translation' do
-          inputs.merge!(a: Object.new)
-          expect(outcome.errors[:a]).to eq [translation]
-        end
-      end
+          before { inputs[:a] = value }
 
-      context ':missing' do
-        let(:key) { "#{described_class.i18n_scope}.errors.messages.missing" }
+          it 'has a translation' do
+            expect { translation }.to_not raise_error
+          end
 
-        it 'has a translation' do
-          expect { translation }.to_not raise_error
-        end
-
-        it 'returns the translation' do
-          expect(outcome.errors[:a]).to eq [translation]
+          it 'returns the translation' do
+            expect(outcome.errors[:a]).to include translation
+          end
         end
       end
+
+      include_examples 'translations', :invalid_type, Object.new
+      include_examples 'translations', :missing, nil
     end
   end
 
@@ -80,8 +74,8 @@ describe I18nInteraction do
     before do
       I18n.backend.store_translations('hsilgne', active_interaction: {
         errors: { messages: {
-          invalid: "%{type} #{'invalid'.reverse}",
-          invalid_nested: 'invalid_nested'.reverse,
+          invalid: 'is invalid'.reverse,
+          invalid_type: "%{type} #{'is not a valid'.reverse}",
           missing: 'missing'.reverse
         } },
         types: TYPES.each_with_object({}) { |e, a| a[e] = e.reverse }

data/spec/active_interaction/integration/time_interaction_spec.rb

@@ -71,6 +71,12 @@ describe TimeInteraction do
       it 'returns the correct value' do
         expect(result[:a]).to eq a
       end
+
+      it 'handles time zone changes' do
+        outcome
+        allow(Time).to receive(:zone).and_return(nil)
+        expect(described_class.run(inputs)).to be_invalid
+      end
     end
   end
 end

data/spec/active_interaction/modules/validation_spec.rb

@@ -38,18 +38,18 @@ describe ActiveInteraction::Validation do
         let(:exception) { ActiveInteraction::InvalidValueError }
         let(:filter) { ActiveInteraction::FloatFilter.new(:name, {}) }
 
-        it 'returns an :invalid_nested error' do
+        it 'returns an :invalid_type error' do
           type = I18n.translate(
             "#{ActiveInteraction::Base.i18n_scope}.types.#{filter.class.slug}")
 
-          expect(result).to eq [[filter.name, :invalid, nil, type: type]]
+          expect(result).to eq [[filter.name, :invalid_type, nil, type: type]]
         end
       end
 
       context 'MissingValueError' do
         let(:exception) { ActiveInteraction::MissingValueError }
 
-        it 'returns an :invalid_nested error' do
+        it 'returns an :msising error' do
           expect(result).to eq [[filter.name, :missing]]
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel