active_interaction 1.2.3 → 1.3.0

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/filters/model_filter.rb

@@ -39,8 +39,8 @@ module ActiveInteraction
     #
     # @raise [InvalidClassError]
     def klass
-      klass_name = options.fetch(:class, name).to_s.classify
-      klass_name.constantize
+      klass_name = options.fetch(:class, name).to_s.camelize
+      Object.const_get(klass_name)
     rescue NameError
       raise InvalidClassError, klass_name.inspect
     end

data/lib/active_interaction/filters/time_filter.rb

@@ -26,6 +26,14 @@ module ActiveInteraction
     alias_method :_klass, :klass
     private :_klass
 
+    def initialize(name, options = {}, &block)
+      if options.key?(:format) && klass != Time
+        fail InvalidFilterError, 'format option unsupported with time zones'
+      end
+
+      super
+    end
+
     def cast(value)
       case value
       when Numeric

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.3')
+  VERSION = Gem::Version.new('1.3.0')
 end

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'
@@ -41,7 +42,6 @@ require 'active_interaction/backports'
 
 I18n.load_path += Dir[File.expand_path(
   File.join(%w[active_interaction locale *.yml]), File.dirname(__FILE__))]
-I18n.default_locale = :en
 
 # Manage application specific business logic.
 #
@@ -50,5 +50,5 @@ I18n.default_locale = :en
 #
 # @since 1.0.0
 #
-# @version 1.2.3
+# @version 1.3.0
 module ActiveInteraction end

data/spec/active_interaction/base_spec.rb

@@ -162,13 +162,15 @@ describe ActiveInteraction::Base do
       expect(described_class.desc).to be_nil
     end
 
-    it 'returns the description' do
-      expect(described_class.desc(desc)).to eql desc
-    end
+    context 'with a description' do
+      it 'returns the description' do
+        expect(described_class.desc(desc)).to eql desc
+      end
 
-    it 'saves the description' do
-      described_class.desc(desc)
-      expect(described_class.desc).to eql desc
+      it 'saves the description' do
+        described_class.desc(desc)
+        expect(described_class.desc).to eql desc
+      end
     end
   end
 
@@ -439,12 +441,12 @@ describe ActiveInteraction::Base do
     let(:described_class) { InteractionWithFilter }
 
     it 'responds to the predicate' do
-      expect(interaction.respond_to?(:thing?)).to be_true
+      expect(interaction.respond_to?(:thing?)).to be_truthy
     end
 
     context 'without a value' do
       it 'returns false' do
-        expect(interaction.thing?).to be_false
+        expect(interaction.thing?).to be_falsey
       end
     end
 
@@ -456,16 +458,14 @@ describe ActiveInteraction::Base do
       end
 
       it 'returns true' do
-        expect(interaction.thing?).to be_true
+        expect(interaction.thing?).to be_truthy
       end
     end
   end
 
   describe '.import_filters' do
-    shared_context 'import_filters context' do
+    shared_context 'import_filters context' do |only, except|
       let(:klass) { AddInteraction }
-      let(:only) { nil }
-      let(:except) { nil }
 
       let(:described_class) do
         interaction = klass
@@ -477,8 +477,8 @@ describe ActiveInteraction::Base do
       end
     end
 
-    shared_examples 'import_filters examples' do
-      include_context 'import_filters context'
+    shared_examples 'import_filters examples' do |only, except|
+      include_context 'import_filters context', only, except
 
       it 'imports the filters' do
         expect(described_class.filters).to eql klass.filters
@@ -504,42 +504,103 @@ describe ActiveInteraction::Base do
     end
 
     context 'with neither :only nor :except' do
-      include_examples 'import_filters examples'
+      include_examples 'import_filters examples', nil, nil
     end
 
     context 'with :only' do
       context 'as an Array' do
-        include_examples 'import_filters examples'
-
-        let(:only) { [:x] }
+        include_examples 'import_filters examples', [:x], nil
       end
 
       context 'as an Symbol' do
-        include_examples 'import_filters examples'
-
-        let(:only) { :x }
+        include_examples 'import_filters examples', :x, nil
       end
     end
 
     context 'with :except' do
       context 'as an Array' do
-        include_examples 'import_filters examples'
-
-        let(:except) { [:x] }
+        include_examples 'import_filters examples', nil, [:x]
       end
 
       context 'as an Symbol' do
-        include_examples 'import_filters examples'
-
-        let(:except) { :x }
+        include_examples 'import_filters examples', nil, :x
       end
     end
 
     context 'with :only & :except' do
-      include_examples 'import_filters examples'
+      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
 
-      let(:only) { [:x] }
-      let(:except) { [:x] }
+      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/concerns/missable_spec.rb

@@ -10,7 +10,7 @@ describe ActiveInteraction::Missable do
       let(:slug) { :slug }
 
       it 'returns false' do
-        expect(instance.respond_to?(slug)).to be_false
+        expect(instance.respond_to?(slug)).to be_falsey
       end
     end
 
@@ -18,7 +18,7 @@ describe ActiveInteraction::Missable do
       let(:slug) { :boolean }
 
       it 'returns true' do
-        expect(instance.respond_to?(slug)).to be_true
+        expect(instance.respond_to?(slug)).to be_truthy
       end
     end
   end

data/spec/active_interaction/concerns/runnable_spec.rb

@@ -57,7 +57,7 @@ describe ActiveInteraction::Runnable do
               }
 
               klass.run
-              expect(has_run).to be_true
+              expect(has_run).to be_truthy
             end
           end
         end
@@ -141,7 +141,10 @@ describe ActiveInteraction::Runnable do
 
       it 'does not duplicate errors on subsequent calls' do
         instance.valid?
-        expect { instance.valid? }.to_not change { instance.errors.count }.by 1
+        count = instance.errors.count
+        instance.valid?
+
+        expect(instance.errors.count).to eql count
       end
     end
   end

data/spec/active_interaction/concerns/transactable_spec.rb

@@ -47,25 +47,46 @@ describe ActiveInteraction::Transactable do
 
   describe '.transaction?' do
     it 'defaults to true' do
-      expect(klass.transaction?).to be_true
+      expect(klass.transaction?).to be_truthy
     end
 
     it 'returns the stored value' do
       klass.transaction(false)
-      expect(klass.transaction?).to be_false
+      expect(klass.transaction?).to be_falsey
+    end
+
+    context 'with a subclass' do
+      before { klass.transaction(false) }
+
+      let(:subclass) { Class.new(klass) }
+
+      it 'inherits from the superclass' do
+        expect(subclass.transaction?).to be_falsey
+      end
     end
   end
 
   describe '.transaction_options' do
+    let(:h) { { rand => rand } }
+
     it 'defaults to an empty hash' do
       expect(klass.transaction_options).to eql({})
     end
 
     it 'returns the stored value' do
-      h = { rand => rand }
       klass.transaction(klass.transaction?, h)
       expect(klass.transaction_options).to eql h
     end
+
+    context 'with a subclass' do
+      before { klass.transaction(klass.transaction?, h) }
+
+      let(:subclass) { Class.new(klass) }
+
+      it 'inherits from the superclass' do
+        expect(subclass.transaction_options).to eql h
+      end
+    end
   end
 
   describe '#transaction' do

data/spec/active_interaction/errors_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe ActiveInteraction::Errors do
   let(:klass) do
     Class.new do
-      include ActiveModel::Model
+      include ActiveInteraction::ActiveModelable
 
       attr_reader :attribute
 

data/spec/active_interaction/filter_column_spec.rb

@@ -42,7 +42,7 @@ describe ActiveInteraction::FilterColumn do
         let(:type) { :integer }
 
         it 'returns true' do
-          expect(number?).to be_true
+          expect(number?).to be_truthy
         end
       end
 
@@ -50,7 +50,7 @@ describe ActiveInteraction::FilterColumn do
         let(:type) { :float }
 
         it 'returns true' do
-          expect(number?).to be_true
+          expect(number?).to be_truthy
         end
       end
 
@@ -58,7 +58,7 @@ describe ActiveInteraction::FilterColumn do
         let(:type) { :string }
 
         it 'returns false' do
-          expect(number?).to be_false
+          expect(number?).to be_falsey
         end
       end
     end
@@ -72,7 +72,7 @@ describe ActiveInteraction::FilterColumn do
         let(:type) { :string }
 
         it 'returns true' do
-          expect(text?).to be_true
+          expect(text?).to be_truthy
         end
       end
 
@@ -80,7 +80,7 @@ describe ActiveInteraction::FilterColumn do
         let(:type) { :float }
 
         it 'returns false' do
-          expect(text?).to be_false
+          expect(text?).to be_falsey
         end
       end
     end

data/spec/active_interaction/filters/boolean_filter_spec.rb

@@ -10,7 +10,7 @@ describe ActiveInteraction::BooleanFilter, :filter do
     context 'falsey' do
       [false, '0', 'false', 'FALSE'].each do |value|
         it "returns false for #{value.inspect}" do
-          expect(filter.cast(value)).to be_false
+          expect(filter.cast(value)).to be_falsey
         end
       end
     end
@@ -18,7 +18,7 @@ describe ActiveInteraction::BooleanFilter, :filter do
     context 'truthy' do
       [true, '1', 'true', 'TRUE'].each do |value|
         it "returns true for #{value.inspect}" do
-          expect(filter.cast(value)).to be_true
+          expect(filter.cast(value)).to be_truthy
         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/filters/model_filter_spec.rb

@@ -3,6 +3,7 @@
 require 'spec_helper'
 
 class Model; end
+class Things; end
 
 describe ActiveInteraction::ModelFilter, :filter do
   include_context 'filters'
@@ -118,6 +119,16 @@ describe ActiveInteraction::ModelFilter, :filter do
       end
     end
 
+    context 'with a plural class' do
+      let(:value) { Things.new }
+
+      before { options[:class] = Things }
+
+      it 'returns the instance' do
+        expect(result).to eql value
+      end
+    end
+
     context 'with class as an invalid String' do
       before do
         options.merge!(class: 'invalid')

data/spec/active_interaction/filters/time_filter_spec.rb

@@ -14,6 +14,26 @@ describe ActiveInteraction::TimeFilter, :filter do
     end
   end
 
+  describe '#initialize' do
+    context 'with a format' do
+      before { options[:format] = '%T' }
+
+      context 'with a time zone' do
+        before do
+          time_zone = double
+          allow(Time).to receive(:zone).and_return(time_zone)
+
+          time_with_zone = double
+          allow(time_zone).to receive(:at).and_return(time_with_zone)
+        end
+
+        it 'raises an error' do
+          expect { filter }.to raise_error(ActiveInteraction::InvalidFilterError)
+        end
+      end
+    end
+  end
+
   describe '#cast' do
     let(:result) { filter.cast(value) }
 

data/spec/active_interaction/i18n_spec.rb

@@ -54,8 +54,11 @@ describe I18nInteraction do
     include_examples 'translation'
 
     before do
+      @locale = I18n.locale
       I18n.locale = :en
     end
+
+    after { I18n.locale = @locale }
   end
 
   context 'hsilgne' do
@@ -75,7 +78,10 @@ describe I18nInteraction do
         }
       )
 
+      @locale = I18n.locale
       I18n.locale = 'hsilgne'
     end
+
+    after { I18n.locale = @locale }
   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

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, -> { Object }, class: Class
+  it_behaves_like 'an interaction', :model, -> { // }, class: Regexp
 end

data/spec/active_interaction/modules/input_processor_spec.rb

@@ -5,11 +5,11 @@ require 'spec_helper'
 describe ActiveInteraction::InputProcessor do
   describe '.reserved?(name)' do
     it 'returns true for anything starting with "_interaction_"' do
-      expect(described_class.reserved?('_interaction_')).to be_true
+      expect(described_class.reserved?('_interaction_')).to be_truthy
     end
 
     it 'returns false for anything else' do
-      expect(described_class.reserved?(SecureRandom.hex)).to be_false
+      expect(described_class.reserved?(SecureRandom.hex)).to be_falsey
     end
   end
 

data/spec/active_interaction/modules/validation_spec.rb

@@ -21,7 +21,7 @@ describe ActiveInteraction::Validation do
       let(:inputs) { { name: 1 } }
 
       before do
-        filter.stub(:cast).and_return(1)
+        allow(filter).to receive(:cast).and_return(1)
       end
 
       it 'returns no errors' do
@@ -31,7 +31,7 @@ describe ActiveInteraction::Validation do
 
     context 'filter throws' do
       before do
-        filter.stub(:cast).and_raise(exception)
+        allow(filter).to receive(:cast).and_raise(exception)
       end
 
       context 'InvalidValueError' do

data/spec/spec_helper.rb

@@ -3,14 +3,17 @@
 require 'coveralls'
 Coveralls.wear!
 
+require 'i18n'
+if I18n.config.respond_to?(:enforce_available_locales)
+  I18n.config.enforce_available_locales = true
+  I18n.config.available_locales = %w[en hsilgne]
+end
+
 require 'active_interaction'
 
 Dir['./spec/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run_including :focus
 end
-
-I18n.config.enforce_available_locales = true