active_interaction 0.10.2 → 1.0.0

data/lib/active_interaction/filters/integer_filter.rb

@@ -2,25 +2,18 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Integers. String values are converted into Integers.
+    # @!method self.integer(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Integers. String values are converted into
+    #     Integers.
     #
-    # @macro filter_method_params
+    #   @!macro filter_method_params
     #
-    # @example
-    #   integer :quantity
-    #
-    # @since 0.1.0
-    #
-    # @method self.integer(*attributes, options = {})
+    #   @example
+    #     integer :quantity
   end
 
   # @private
   class IntegerFilter < AbstractNumericFilter
-    private
-
-    def klass
-      Integer
-    end
   end
 end

data/lib/active_interaction/filters/model_filter.rb

@@ -2,22 +2,18 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are the correct class.
+    # @!method self.model(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are the correct class.
     #
-    # @macro filter_method_params
-    # @option options [Class, String, Symbol] :class (use the attribute name)
-    #   Class name used to ensure the value.
+    #   @!macro filter_method_params
+    #   @option options [Class, String, Symbol] :class (use the attribute name)
+    #     Class name used to ensure the value.
     #
-    # @example Ensures that the class is `Account`
-    #   model :account
-    #
-    # @example Ensures that the class is `User`
-    #   model :account, class: User
-    #
-    # @since 0.1.0
-    #
-    # @method self.model(*attributes, options = {})
+    #   @example
+    #     model :account
+    #   @example
+    #     model :account, class: User
   end
 
   # @private
@@ -33,6 +29,9 @@ module ActiveInteraction
 
     private
 
+    # @return [Class]
+    #
+    # @raise [InvalidClassError]
     def klass
       klass_name = options.fetch(:class, name).to_s.classify
       klass_name.constantize

data/lib/active_interaction/filters/string_filter.rb

@@ -2,22 +2,18 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Strings.
+    # @!method self.string(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Strings.
     #
-    # @macro filter_method_params
-    # @option options [Boolean] :strip (true) strip leading and trailing
-    #   whitespace
+    #   @!macro filter_method_params
+    #   @option options [Boolean] :strip (true) strip leading and trailing
+    #     whitespace
     #
-    # @example
-    #   string :first_name
-    #
-    # @example
-    #   string :first_name, strip: false
-    #
-    # @since 0.1.0
-    #
-    # @method self.string(*attributes, options = {})
+    #   @example
+    #     string :first_name
+    #   @example
+    #     string :first_name, strip: false
   end
 
   # @private
@@ -33,6 +29,7 @@ module ActiveInteraction
 
     private
 
+    # @return [Boolean]
     def strip?
       options.fetch(:strip, true)
     end

data/lib/active_interaction/filters/symbol_filter.rb

@@ -2,17 +2,14 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Symbols. Strings will be converted to Symbols.
+    # @!method self.symbol(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Symbols. Strings will be converted to Symbols.
     #
-    # @macro filter_method_params
+    #   @!macro filter_method_params
     #
-    # @example
-    #   symbol :condiment
-    #
-    # @since 0.6.0
-    #
-    # @method self.symbol(*attributes, options = {})
+    #   @example
+    #     symbol :condiment
   end
 
   # @private

data/lib/active_interaction/filters/time_filter.rb

@@ -2,24 +2,21 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Times. Numeric values are processed using `at`.
-    #   Strings are processed using `parse` unless the format option is given,
-    #   in which case they will be processed with `strptime`. If `Time.zone` is
-    #   available it will be used so that the values are time zone aware.
+    # @!method self.time(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Times. Numeric values are processed using `at`.
+    #     Strings are processed using `parse` unless the format option is
+    #     given, in which case they will be processed with `strptime`. If
+    #     `Time.zone` is available it will be used so that the values are time
+    #     zone aware.
     #
-    # @macro filter_method_params
-    # @option options [String] :format parse strings using this format string
+    #   @!macro filter_method_params
+    #   @option options [String] :format parse strings using this format string
     #
-    # @example
-    #   time :start_date
-    #
-    # @example
-    #   time :start_date, format: '%Y-%m-%dT%H:%M:%S%z'
-    #
-    # @since 0.1.0
-    #
-    # @method self.time(*attributes, options = {})
+    #   @example
+    #     time :start_date
+    #   @example
+    #     time :start_date, format: '%Y-%m-%dT%H:%M:%S%Z'
   end
 
   # @private

data/lib/active_interaction/modules/validation.rb

@@ -1,22 +1,27 @@
 # coding: utf-8
 
 module ActiveInteraction
+  # Validates inputs using filters.
+  #
   # @private
   module Validation
+    # @param filters [Hash{Symbol => Filter}]
+    # @param inputs [Hash{Symbol => Object}]
     def self.validate(filters, inputs)
-      filters.each_with_object([]) do |filter, errors|
+      filters.each_with_object([]) do |(name, filter), errors|
         begin
-          filter.cast(inputs[filter.name])
+          filter.cast(inputs[name])
         rescue InvalidValueError
-          errors << [filter.name, :invalid, nil, type: type(filter)]
+          errors << [name, :invalid, nil, type: type(filter)]
         rescue MissingValueError
-          errors << [filter.name, :missing]
+          errors << [name, :missing]
         end
       end
     end
 
     private
 
+    # @param filter [Filter]
     def self.type(filter)
       I18n.translate("#{Base.i18n_scope}.types.#{filter.class.slug}")
     end

data/lib/active_interaction/version.rb

@@ -1,6 +1,9 @@
 # coding: utf-8
 
-# rubocop:disable Documentation
+#
 module ActiveInteraction
-  VERSION = Gem::Version.new('0.10.2')
+  # The version number.
+  #
+  # @return [Gem::Version]
+  ActiveInteraction::VERSION = Gem::Version.new('1.0.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -118,6 +118,23 @@ describe ActiveInteraction::Base do
     end
   end
 
+  describe '.desc' do
+    let(:desc) { SecureRandom.hex }
+
+    it 'returns nil' do
+      expect(described_class.desc).to be_nil
+    end
+
+    it 'returns the description' do
+      expect(described_class.desc(desc)).to eq desc
+    end
+
+    it 'saves the description' do
+      described_class.desc(desc)
+      expect(described_class.desc).to eq desc
+    end
+  end
+
   describe '.method_missing(filter_type, *args, &block)' do
     it 'raises an error for an invalid filter type' do
       expect do
@@ -246,10 +263,10 @@ describe ActiveInteraction::Base do
           expect(result[:thing]).to eq thing
         end
 
-        it 'calls transaction' do
-          allow(described_class).to receive(:transaction)
+        it 'calls ActiveRecord::Base.transaction' do
+          allow(ActiveRecord::Base).to receive(:transaction)
           outcome
-          expect(described_class).to have_received(:transaction).once
+          expect(ActiveRecord::Base).to have_received(:transaction)
             .with(no_args)
         end
       end
@@ -331,7 +348,7 @@ describe ActiveInteraction::Base do
     let(:described_class) { InteractionWithFilter }
 
     def filters(klass)
-      klass.filters.map(&:name)
+      klass.filters.keys
     end
 
     it 'includes the filters from the superclass' do
@@ -344,4 +361,92 @@ describe ActiveInteraction::Base do
       expect(filters(described_class)).to_not include :other_thing
     end
   end
+
+  context 'predicates' do
+    let(:described_class) { InteractionWithFilter }
+
+    it 'responds to the predicate' do
+      expect(interaction.respond_to?(:thing?)).to be_true
+    end
+
+    context 'without a value' do
+      it 'returns false' do
+        expect(interaction.thing?).to be_false
+      end
+    end
+
+    context 'with a value' do
+      let(:thing) { rand }
+
+      before do
+        inputs.merge!(thing: thing)
+      end
+
+      it 'returns true' do
+        expect(interaction.thing?).to be_true
+      end
+    end
+  end
+
+  describe '.import_filters' do
+    let(:described_class) do
+      Class.new(TestInteraction) do
+        import_filters AddInteraction
+      end
+    end
+
+    it 'imports the filters' do
+      expect(described_class.filters).to eq AddInteraction.filters
+    end
+
+    context 'with :only' do
+      let(:described_class) do
+        Class.new(TestInteraction) do
+          import_filters AddInteraction, only: [:x]
+        end
+      end
+
+      it 'does not modify the source' do
+        filters = AddInteraction.filters.dup
+        described_class
+        expect(AddInteraction.filters).to eq filters
+      end
+
+      it 'imports the filters' do
+        expect(described_class.filters).to eq AddInteraction.filters
+          .select { |k, _| k == :x }
+      end
+    end
+
+    context 'with :except' do
+      let(:described_class) do
+        Class.new(TestInteraction) do
+          import_filters AddInteraction, except: [:x]
+        end
+      end
+
+      it 'does not modify the source' do
+        filters = AddInteraction.filters.dup
+        described_class
+        expect(AddInteraction.filters).to eq filters
+      end
+
+      it 'imports the filters' do
+        expect(described_class.filters).to eq AddInteraction.filters
+          .reject { |k, _| k == :x }
+      end
+    end
+
+    context 'with :only & :except' do
+      let(:described_class) do
+        Class.new(TestInteraction) do
+          import_filters AddInteraction, only: nil, except: nil
+        end
+      end
+
+      it 'raises an error' do
+        expect { described_class }.to raise_error ArgumentError
+      end
+    end
+  end
 end

data/spec/active_interaction/{modules/active_model_spec.rb → concerns/active_modelable_spec.rb}

@@ -1,10 +1,22 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'test/unit/assertions'
 
-describe ActiveInteraction::ActiveModel do
-  let(:klass) { Class.new { include ActiveInteraction::ActiveModel } }
-  subject(:instance) { klass.new }
+shared_examples_for 'ActiveModel' do
+  include ActiveModel::Lint::Tests
+  include Test::Unit::Assertions
+
+  let(:model) { subject }
+
+  ActiveModel::Lint::Tests.public_instance_methods
+    .grep(/\Atest/) { |m| example(m) { public_send(m) } }
+end
+
+describe ActiveInteraction::ActiveModelable do
+  include_context 'concerns', ActiveInteraction::ActiveModelable
+
+  it_behaves_like 'ActiveModel'
 
   describe '.i18n_scope' do
     it 'returns the scope' do

data/spec/active_interaction/{modules/overload_hash_spec.rb → concerns/hashable_spec.rb}

@@ -2,9 +2,8 @@
 
 require 'spec_helper'
 
-describe ActiveInteraction::OverloadHash do
-  let(:klass) { Class.new { include ActiveInteraction::OverloadHash } }
-  subject(:instance) { klass.new }
+describe ActiveInteraction::Hashable do
+  include_context 'concerns', ActiveInteraction::Hashable
 
   describe '#hash(*args, &block)' do
     context 'with no arguments' do

data/spec/active_interaction/{modules/method_missing_spec.rb → concerns/missable_spec.rb}

@@ -2,9 +2,44 @@
 
 require 'spec_helper'
 
-describe ActiveInteraction::MethodMissing do
-  let(:klass) { Class.new { include ActiveInteraction::MethodMissing } }
-  subject(:instance) { klass.new }
+describe ActiveInteraction::Missable do
+  include_context 'concerns', ActiveInteraction::Missable
+
+  describe '#respond_to?(slug, include_all = false)' do
+    context 'with invalid slug' do
+      let(:slug) { :slug }
+
+      it 'returns false' do
+        expect(instance.respond_to?(slug)).to be_false
+      end
+    end
+
+    context 'with valid slug' do
+      let(:slug) { :boolean }
+
+      it 'returns true' do
+        expect(instance.respond_to?(slug)).to be_true
+      end
+    end
+  end
+
+  describe '#method(sym)' do
+    context 'with invalid slug' do
+      let(:slug) { :slug }
+
+      it 'returns false' do
+        expect { instance.method(slug) }.to raise_error NameError
+      end
+    end
+
+    context 'with valid slug' do
+      let(:slug) { :boolean }
+
+      it 'returns true' do
+        expect(instance.method(slug)).to be_a Method
+      end
+    end
+  end
 
   describe '#method_missing' do
     context 'with invalid slug' do