active_interaction 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bba7422c892bf66b8115b8945c6aea7b556ba96
-  data.tar.gz: 3e5978c3cf8468a93b4355a207f50162fd819a3d
+  metadata.gz: 940655c81d5b5db1e207b9d317eee3b971ed9fbe
+  data.tar.gz: 25b6b1d2f3b217bd4e2da202765cbc3058e90da2
 SHA512:
-  metadata.gz: cf7010af04046f64237456948ec72b93daf4d18e112b4390cbf2117e25babe24513d8c9802f795a1c892a43d62e2f3b7ba1bb28f22c21afa30699f899df1112f
-  data.tar.gz: 5fe9bc9e56874a63aca92dd7b5bf43bb24c94c8049ffd51984c5bb3c53eb610f8381b95ccf126008dd0fe57eca14a4da47709494ed8237b608176fd37d0b7f20
+  metadata.gz: 7d326ebbed5ed325693ba080bf7b020e9d40d3b23ae832038880782363150af71fefb5b34ea2ac256de1a561062c3fba949be9f3c87728baff587b98ce49d899
+  data.tar.gz: 2f17941a1de3e1c4ad74c132e93c16dea5a9239bc3cfd03906953f499721c87001acf91a21cf3d89a92fb497039134667859851270781e1225a7f7b2a009d729

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # [Master][]
 
+# [1.1.0][] (2014-02-28)
+
+- Only set instance variables for attributes with readers defined.
+- Support `:only` and `:except` options simultaneously with `import_filters`.
+  Previously this raised an `ArgumentError`.
+- Support passing a single symbol to `:only` and `:except`. Previously an Array
+  was required.
+- Speed up many filters by caching class constants.
+- Add support for callbacks around `execute`.
+- Allow callable defaults.
+
 # [1.0.5][] (2014-02-25)
 
 - Rollback database changes when `compose` fails.
@@ -143,7 +154,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v1.0.5...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v1.1.0...master
+  [1.1.0]: https://github.com/orgsync/active_interaction/compare/v1.0.5...v1.1.0
   [1.0.5]: https://github.com/orgsync/active_interaction/compare/v1.0.4...v1.0.5
   [1.0.4]: https://github.com/orgsync/active_interaction/compare/v1.0.3...v1.0.4
   [1.0.3]: https://github.com/orgsync/active_interaction/compare/v1.0.2...v1.0.3

data/README.md

@@ -25,7 +25,7 @@ This project uses [semantic versioning][13].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 1.0'
+gem 'active_interaction', '~> 1.1'
 ```
 
 And then execute:
@@ -168,8 +168,8 @@ end
       boolean :smoking
       boolean :view
     end
-    date :arrives_on, default: Date.today
-    date :departs_on, default: Date.tomorrow
+    date :arrives_on, default: -> { Date.today }
+    date :departs_on, default: -> { Date.tomorrow }
     ```
 
 3. Use any additional validations you need:
@@ -284,8 +284,8 @@ work done in [Mutations][17].
   [2]: https://badge.fury.io/rb/active_interaction "Gem Version"
   [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"
+  [5]: https://coveralls.io/repos/orgsync/active_interaction/badge.png?branch=master
+  [6]: https://coveralls.io/r/orgsync/active_interaction?branch=master "Coverage Status"
   [7]: https://codeclimate.com/github/orgsync/active_interaction.png
   [8]: https://codeclimate.com/github/orgsync/active_interaction "Code Climate"
   [9]: https://gemnasium.com/orgsync/active_interaction.png

data/lib/active_interaction.rb

@@ -41,5 +41,5 @@ I18n.load_path << File.expand_path(
 #
 # @since 1.0.0
 #
-# @version 1.0.5
+# @version 1.1.0
 module ActiveInteraction end

data/lib/active_interaction/base.rb

@@ -120,20 +120,14 @@ 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)
-          fail ArgumentError, 'given both :only and :except'
-        end
-
         only = options[:only]
         except = options[:except]
 
         other_filters = klass.filters.dup
-        other_filters.select! { |k, _| only.include?(k) } if only
-        other_filters.reject! { |k, _| except.include?(k) } if except
+        other_filters.select! { |k, _| [*only].include?(k) } if only
+        other_filters.reject! { |k, _| [*except].include?(k) } if except
 
         other_filters.values.each { |filter| initialize_filter(filter) }
       end
@@ -206,7 +200,7 @@ module ActiveInteraction
       inputs.each do |key, value|
         fail InvalidValueError, key.inspect if self.class.send(:reserved?, key)
 
-        instance_variable_set("@#{key}", value)
+        instance_variable_set("@#{key}", value) if respond_to?(key)
       end
 
       self.class.filters.each do |name, filter|

data/lib/active_interaction/concerns/runnable.rb

@@ -31,6 +31,10 @@ module ActiveInteraction
     extend ActiveSupport::Concern
     include ActiveModel::Validations
 
+    included do
+      define_callbacks :execute
+    end
+
     # @return [Errors]
     def errors
       @_interaction_errors
@@ -96,7 +100,7 @@ module ActiveInteraction
 
       self.result = ActiveRecord::Base.transaction do
         begin
-          execute
+          run_callbacks(:execute) { execute }
         rescue Interrupt => interrupt
           merge_errors_onto_base(interrupt.outcome.errors)
 

data/lib/active_interaction/filter.rb

@@ -49,9 +49,7 @@ module ActiveInteraction
       #
       # @see .slug
       def factory(slug)
-        CLASSES.fetch(slug)
-      rescue KeyError
-        raise MissingFilterError, slug.inspect
+        CLASSES.fetch(slug) { fail MissingFilterError, slug.inspect }
       end
 
       # Convert the class name into a short symbol.
@@ -139,16 +137,17 @@ module ActiveInteraction
     #   ActiveInteraction::Filter.new(:example, default: 0).default
     #   # => ActiveInteraction::InvalidDefaultError: example: 0
     #
-    # @return [Object]
+    # @return (see #raw_default)
     #
     # @raise [NoDefaultError] If the default is missing.
     # @raise [InvalidDefaultError] If the default is invalid.
     def default
       fail NoDefaultError, name unless default?
 
-      cast(options[:default])
+      value = raw_default
+      cast(value)
     rescue InvalidValueError, MissingValueError
-      raise InvalidDefaultError, "#{name}: #{options[:default].inspect}"
+      raise InvalidDefaultError, "#{name}: #{value.inspect}"
     end
 
     # Get the description.
@@ -195,5 +194,18 @@ module ActiveInteraction
         fail InvalidValueError, "#{name}: #{value.inspect}"
       end
     end
+
+    private
+
+    # @return [Object]
+    def raw_default
+      value = options.fetch(:default)
+
+      if value.is_a?(Proc)
+        value.call
+      else
+        value
+      end
+    end
   end
 end

data/lib/active_interaction/filters/abstract_filter.rb

@@ -8,11 +8,14 @@ module ActiveInteraction
   #
   # @private
   class AbstractFilter < Filter
-    private
-
     # @return [Class]
-    def klass
-      self.class.slug.to_s.camelize.constantize
+    attr_reader :klass
+    private :klass
+
+    def initialize(*)
+      super
+
+      @klass = self.class.slug.to_s.camelize.constantize
     end
   end
 end

data/lib/active_interaction/filters/hash_filter.rb

@@ -35,14 +35,6 @@ module ActiveInteraction
       end
     end
 
-    def default
-      if options[:default].is_a?(Hash) && !options[:default].empty?
-        fail InvalidDefaultError, "#{name}: #{options[:default].inspect}"
-      end
-
-      super
-    end
-
     def method_missing(*args, &block)
       super(*args) do |klass, names, options|
         fail InvalidFilterError, 'missing attribute name' if names.empty?
@@ -55,6 +47,16 @@ module ActiveInteraction
 
     private
 
+    def raw_default
+      value = super
+
+      if value.is_a?(Hash) && !value.empty?
+        fail InvalidDefaultError, "#{name}: #{value.inspect}"
+      end
+
+      value
+    end
+
     # @return [Boolean]
     def strip?
       options.fetch(:strip, true)

data/lib/active_interaction/filters/model_filter.rb

@@ -18,12 +18,21 @@ module ActiveInteraction
 
   # @private
   class ModelFilter < Filter
-    def cast(value)
+    def initialize(*)
+      super
+
+      @klass = klass
+    end
+
+    def cast(value, reconstantize = true)
       case value
-      when klass
+      when @klass
         value
       else
-        super
+        return super(value) unless reconstantize
+
+        @klass = klass
+        cast(value, false)
       end
     end
 

data/lib/active_interaction/version.rb

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

data/spec/active_interaction/base_spec.rb

@@ -54,7 +54,7 @@ describe ActiveInteraction::Base do
       end
     end
 
-    context 'with an attribute' do
+    context 'with a reader' do
       let(:described_class) do
         Class.new(TestInteraction) do
           attr_reader :thing
@@ -64,6 +64,12 @@ describe ActiveInteraction::Base do
       end
       let(:thing) { SecureRandom.hex }
 
+      before { inputs.merge!(thing: thing) }
+
+      it 'sets the attribute' do
+        expect(interaction.thing).to eq thing
+      end
+
       context 'failing validations' do
         before { inputs.merge!(thing: nil) }
 
@@ -73,15 +79,9 @@ describe ActiveInteraction::Base do
       end
 
       context 'passing validations' do
-        before { inputs.merge!(thing: thing) }
-
         it 'returns a valid outcome' do
           expect(interaction).to be_valid
         end
-
-        it 'sets the attribute' do
-          expect(interaction.thing).to eq thing
-        end
       end
     end
 
@@ -391,8 +391,8 @@ describe ActiveInteraction::Base do
 
       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) }
+          .select { |k, _| only.nil? ? true : [*only].include?(k) }
+          .reject { |k, _| except.nil? ? false : [*except].include?(k) }
       end
 
       it 'does not modify the source' do
@@ -417,26 +417,38 @@ describe ActiveInteraction::Base do
     end
 
     context 'with :only' do
-      include_examples 'import_filters examples'
+      context 'as an Array' do
+        include_examples 'import_filters examples'
 
-      let(:only) { [:x] }
+        let(:only) { [:x] }
+      end
+
+      context 'as an Symbol' do
+        include_examples 'import_filters examples'
+
+        let(:only) { :x }
+      end
     end
 
     context 'with :except' do
-      include_examples 'import_filters examples'
+      context 'as an Array' do
+        include_examples 'import_filters examples'
 
-      let(:except) { [:x] }
+        let(:except) { [:x] }
+      end
+
+      context 'as an Symbol' do
+        include_examples 'import_filters examples'
+
+        let(:except) { :x }
+      end
     end
 
     context 'with :only & :except' do
-      include_context 'import_filters context'
-
-      let(:only) { [] }
-      let(:except) { [] }
+      include_examples 'import_filters examples'
 
-      it 'raises an error' do
-        expect { described_class }.to raise_error ArgumentError
-      end
+      let(:only) { [:x] }
+      let(:except) { [:x] }
     end
   end
 end

data/spec/active_interaction/concerns/runnable_spec.rb

@@ -61,6 +61,39 @@ describe ActiveInteraction::Runnable do
     end
   end
 
+  context 'callbacks' do
+    describe '.set_callback' do
+      include_context 'with #execute defined'
+
+      shared_examples 'set_callback examples' do |name|
+        context name do
+          it 'does not raise an error' do
+            expect do
+              klass.set_callback name, :before, -> _ {}
+            end.to_not raise_error
+          end
+
+          [:after, :around, :before].each do |type|
+            it type do
+              has_run = false
+
+              klass.set_callback name, type, lambda { |_, &block|
+                has_run = true
+                block.call unless block.nil?
+              }
+
+              klass.run
+              expect(has_run).to be_true
+            end
+          end
+        end
+      end
+
+      include_examples 'set_callback examples', :validate
+      include_examples 'set_callback examples', :execute
+    end
+  end
+
   describe '#errors' do
     it 'returns the errors' do
       expect(instance.errors).to be_an ActiveInteraction::Errors

data/spec/active_interaction/filters/model_filter_spec.rb

@@ -29,6 +29,29 @@ describe ActiveInteraction::ModelFilter, :filter do
 
         expect(filter.cast(value)).to eq value
       end
+
+      it 'handles reconstantizing subclasses' do
+        filter
+
+        Object.send(:remove_const, :Model)
+        Model = Class.new
+        Submodel = Class.new(Model)
+        value = Submodel.new
+
+        expect(filter.cast(value)).to eq value
+      end
+
+      it 'does not overflow the stack' do
+        klass = Class.new do
+          def self.name
+            Model.name
+          end
+        end
+
+        expect do
+          filter.cast(klass.new)
+        end.to raise_error ActiveInteraction::InvalidValueError
+      end
     end
 
     context 'with class as a superclass' do

data/spec/active_interaction/integration/model_interaction_spec.rb

@@ -3,5 +3,5 @@
 require 'spec_helper'
 
 describe 'ModelInteraction' do
-  it_behaves_like 'an interaction', :model, -> { proc {} }, class: Proc
+  it_behaves_like 'an interaction', :model, -> { Object }, class: Class
 end

data/spec/support/filters.rb

@@ -153,6 +153,19 @@ shared_examples_for 'a filter' do
         end.to raise_error ActiveInteraction::InvalidDefaultError
       end
     end
+
+    context 'with a callable default' do
+      include_context 'optional'
+
+      before do
+        default = options[:default]
+        options[:default] = -> { default }
+      end
+
+      it 'returns the default' do
+        expect(filter.default).to eq options[:default].call
+      end
+    end
   end
 
   describe '#desc' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,124 +9,124 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Manage application specific business logic.
@@ -137,10 +137,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- LICENSE.txt
-- README.md
-- lib/active_interaction.rb
 - lib/active_interaction/base.rb
 - lib/active_interaction/concerns/active_modelable.rb
 - lib/active_interaction/concerns/hashable.rb
@@ -163,9 +159,9 @@ files:
 - lib/active_interaction/filters/string_filter.rb
 - lib/active_interaction/filters/symbol_filter.rb
 - lib/active_interaction/filters/time_filter.rb
-- lib/active_interaction/locale/en.yml
 - lib/active_interaction/modules/validation.rb
 - lib/active_interaction/version.rb
+- lib/active_interaction.rb
 - spec/active_interaction/base_spec.rb
 - spec/active_interaction/concerns/active_modelable_spec.rb
 - spec/active_interaction/concerns/hashable_spec.rb
@@ -206,6 +202,10 @@ files:
 - spec/support/concerns.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/active_interaction/locale/en.yml
 homepage: http://orgsync.github.io/active_interaction/
 licenses:
 - MIT
@@ -216,17 +216,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Manage application specific business logic.