active_interaction 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f91c5498e12a8463f75e69ddc0b07f8b5b851e
-  data.tar.gz: 8336e72d5e12d0a793d3c7e188ab3eafb031df07
+  metadata.gz: 20cc4b1b768b7f7dddca393b9554a664bb23010a
+  data.tar.gz: c746e003137672689025a54a9245330527088366
 SHA512:
-  metadata.gz: 47efce81ccf4286b2906b5d79d438f6f69fc6ff76aecfb975544fb64599350d320c1728b9e43fde6ef59f976c95d577676d6b9cea8614eb8603b1b95e5f6c8ea
-  data.tar.gz: 2593157f8acc004d26a92b5c69fafb2034fd03abc6717034d34fcc0b34a69acf8f5e629716c905702d17421b815ab7152c8fa18ceb41491243afb1c4d4377d8c
+  metadata.gz: 678d8066fa76930180a241ab069617a46d083ac2ca558a4cfee8cb4e6a76131e907ed486ddbd898be89d4f513c74a5799169ba556d24240deb9ad005748c7bcd
+  data.tar.gz: ac3d346048c4744d9b2ca25f91b2f719d0b3fcec609671feaf94353e00d4717c147c6e9b47a669cf37d39d327b8c9352e4ac6f9f78cd8d3106235c44e5ede6d2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # [Master][]
 
+# [1.3.0][] (2014-08-15)
+
+## Added
+
+- [#178][]: Add an interface filter.
+- [#196][]: Add a `type_check` callback that happens before the `validation`
+  callback.
+
 # [1.2.5][] (2014-08-15)
 
 ## Fixed
@@ -338,7 +346,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v1.2.5...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v1.3.0...master
+  [1.3.0]: https://github.com/orgsync/active_interaction/compare/v1.2.5...v1.3.0
   [1.2.5]: https://github.com/orgsync/active_interaction/compare/v1.2.4...v1.2.5
   [1.2.4]: https://github.com/orgsync/active_interaction/compare/v1.2.3...v1.2.4
   [1.2.3]: https://github.com/orgsync/active_interaction/compare/v1.2.2...v1.2.3
@@ -438,8 +447,10 @@
   [#173]: https://github.com/orgsync/active_interaction/issues/173
   [#174]: https://github.com/orgsync/active_interaction/issues/174
   [#175]: https://github.com/orgsync/active_interaction/issues/175
+  [#178]: https://github.com/orgsync/active_interaction/issues/178
   [#179]: https://github.com/orgsync/active_interaction/issues/179
   [#192]: https://github.com/orgsync/active_interaction/issues/192
+  [#196]: https://github.com/orgsync/active_interaction/issues/196
   [#201]: https://github.com/orgsync/active_interaction/issues/201
   [#203]: https://github.com/orgsync/active_interaction/issues/203
   [#206]: https://github.com/orgsync/active_interaction/issues/206

data/README.md

@@ -25,7 +25,7 @@ This project uses [semantic versioning][13].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 1.2'
+gem 'active_interaction', '~> 1.3'
 ```
 
 And then execute:

data/lib/active_interaction.rb

@@ -30,6 +30,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/string_filter'
 require 'active_interaction/filters/symbol_filter'
@@ -49,5 +50,5 @@ I18n.load_path += Dir[File.expand_path(
 #
 # @since 1.0.0
 #
-# @version 1.2.5
+# @version 1.3.0
 module ActiveInteraction end

data/lib/active_interaction/base.rb

@@ -31,7 +31,7 @@ module ActiveInteraction
     include ActiveModelable
     include Runnable
 
-    validate :input_errors
+    define_callbacks :type_check
 
     class << self
       include Hashable
@@ -235,6 +235,14 @@ module ActiveInteraction
       end
     end
 
+    protected
+
+    def run_validations!
+      type_check
+
+      super if errors.empty?
+    end
+
     private
 
     # @param inputs [Hash{Symbol => Object}]
@@ -257,16 +265,16 @@ module ActiveInteraction
         begin
           public_send("#{name}=", filter.clean(inputs[name]))
         rescue InvalidValueError, MissingValueError, InvalidNestedValueError
-          # Validators (#input_errors) will add errors if appropriate.
+          # #type_check will add errors if appropriate.
         end
       end
     end
 
-    # @!group Validations
-
-    def input_errors
-      Validation.validate(self.class.filters, inputs).each do |error|
-        errors.add_sym(*error)
+    def type_check
+      run_callbacks(:type_check) do
+        Validation.validate(self.class.filters, inputs).each do |error|
+          errors.add_sym(*error)
+        end
       end
     end
   end

data/lib/active_interaction/filters/interface_filter.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+module ActiveInteraction
+  class Base
+    # @!method self.interface(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #   the attributes implement an interface.
+    #
+    #   @!macro filter_method_params
+    #   @option options [Array<Symbol>] :methods ([]) the methods that objects
+    #     conforming to this interface should respond to
+    #
+    #   @example
+    #     interface :anything
+    #   @example
+    #     interface :serializer,
+    #       methods: [:dump, :load]
+  end
+
+  # @private
+  class InterfaceFilter < Filter
+    register :interface
+
+    def cast(value)
+      matches?(value) ? value : super
+    end
+
+    private
+
+    # @param object [Object]
+    #
+    # @return [Boolean]
+    def matches?(object)
+      methods.all? { |method| object.respond_to?(method) }
+    rescue NoMethodError
+      false
+    end
+
+    # @return [Array<Symbol>]
+    def methods
+      options.fetch(:methods, [])
+    end
+  end
+end

data/lib/active_interaction/locale/en.yml

@@ -16,6 +16,7 @@ en:
       float: float
       hash: hash
       integer: integer
+      interface: interface
       model: model
       string: string
       symbol: symbol

data/lib/active_interaction/version.rb

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

data/spec/active_interaction/base_spec.rb

@@ -531,4 +531,76 @@ describe ActiveInteraction::Base do
       include_examples 'import_filters examples', [:x], [:x]
     end
   end
+
+  context 'callbacks' do
+    let(:described_class) { Class.new(TestInteraction) }
+
+    %w[type_check validate execute].each do |name|
+      %w[before after around].map(&:to_sym).each do |type|
+        it "runs the #{type} #{name} callback" do
+          called = false
+          described_class.set_callback(name, type) { called = true }
+          outcome
+          expect(called).to be_truthy
+        end
+      end
+    end
+
+    context 'with errors during type_check' do
+      before do
+        described_class.set_callback(:type_check, :before) do
+          errors.add(:base)
+        end
+      end
+
+      it 'is invalid' do
+        expect(outcome).to be_invalid
+      end
+
+      it 'does not run validate callbacks' do
+        called = false
+        described_class.set_callback(:validate, :before) { called = true }
+        outcome
+        expect(called).to be_falsey
+      end
+
+      it 'does not run execute callbacks' do
+        called = false
+        described_class.set_callback(:execute, :before) { called = true }
+        outcome
+        expect(called).to be_falsey
+      end
+    end
+
+    context 'with errors during validate' do
+      before do
+        described_class.set_callback(:validate, :before) do
+          errors.add(:base)
+        end
+      end
+
+      it 'is invalid' do
+        expect(outcome).to be_invalid
+      end
+
+      it 'does not run execute callbacks' do
+        called = false
+        described_class.set_callback(:execute, :before) { called = true }
+        outcome
+        expect(called).to be_falsey
+      end
+    end
+
+    context 'with errors during execute' do
+      before do
+        described_class.set_callback(:execute, :before) do
+          errors.add(:base)
+        end
+      end
+
+      it 'is invalid' do
+        expect(outcome).to be_invalid
+      end
+    end
+  end
 end

data/spec/active_interaction/filters/interface_filter_spec.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'json'
+require 'yaml'
+
+describe ActiveInteraction::InterfaceFilter, :filter do
+  include_context 'filters'
+  it_behaves_like 'a filter'
+
+  before { options[:methods] = [:dump, :load] }
+
+  describe '#cast' do
+    let(:result) { filter.cast(value) }
+
+    context 'with an Object' do
+      let(:value) { Object.new }
+
+      it 'raises an error' do
+        expect { result }.to raise_error ActiveInteraction::InvalidValueError
+      end
+    end
+
+    context 'with JSON' do
+      let(:value) { JSON }
+
+      it 'returns an Array' do
+        expect(result).to eql value
+      end
+    end
+
+    context 'with YAML' do
+      let(:value) { YAML }
+
+      it 'returns an Hash' do
+        expect(result).to eql value
+      end
+    end
+  end
+
+  describe '#database_column_type' do
+    it 'returns :string' do
+      expect(filter.database_column_type).to eql :string
+    end
+  end
+end

data/spec/active_interaction/integration/interface_interaction_spec.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'json'
+require 'yaml'
+
+describe 'InterfaceInteraction' do
+  it_behaves_like 'an interaction',
+    :interface,
+    -> { [JSON, YAML].sample },
+    methods: [:dump, :load]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -187,6 +187,7 @@ files:
 - lib/active_interaction/filters/float_filter.rb
 - lib/active_interaction/filters/hash_filter.rb
 - lib/active_interaction/filters/integer_filter.rb
+- lib/active_interaction/filters/interface_filter.rb
 - lib/active_interaction/filters/model_filter.rb
 - lib/active_interaction/filters/string_filter.rb
 - lib/active_interaction/filters/symbol_filter.rb
@@ -217,6 +218,7 @@ files:
 - spec/active_interaction/filters/float_filter_spec.rb
 - spec/active_interaction/filters/hash_filter_spec.rb
 - spec/active_interaction/filters/integer_filter_spec.rb
+- spec/active_interaction/filters/interface_filter_spec.rb
 - spec/active_interaction/filters/model_filter_spec.rb
 - spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/symbol_filter_spec.rb
@@ -231,6 +233,7 @@ files:
 - spec/active_interaction/integration/float_interaction_spec.rb
 - spec/active_interaction/integration/hash_interaction_spec.rb
 - spec/active_interaction/integration/integer_interaction_spec.rb
+- spec/active_interaction/integration/interface_interaction_spec.rb
 - spec/active_interaction/integration/model_interaction_spec.rb
 - spec/active_interaction/integration/string_interaction_spec.rb
 - spec/active_interaction/integration/symbol_interaction_spec.rb
@@ -291,6 +294,7 @@ test_files:
 - spec/active_interaction/filters/float_filter_spec.rb
 - spec/active_interaction/filters/hash_filter_spec.rb
 - spec/active_interaction/filters/integer_filter_spec.rb
+- spec/active_interaction/filters/interface_filter_spec.rb
 - spec/active_interaction/filters/model_filter_spec.rb
 - spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/symbol_filter_spec.rb
@@ -305,6 +309,7 @@ test_files:
 - spec/active_interaction/integration/float_interaction_spec.rb
 - spec/active_interaction/integration/hash_interaction_spec.rb
 - spec/active_interaction/integration/integer_interaction_spec.rb
+- spec/active_interaction/integration/interface_interaction_spec.rb
 - spec/active_interaction/integration/model_interaction_spec.rb
 - spec/active_interaction/integration/string_interaction_spec.rb
 - spec/active_interaction/integration/symbol_interaction_spec.rb