active_interaction 0.1.3 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWZlM2U4M2ZiMTYwNjRkOTRkNjQwYWM4OWU5OGM2ZWFhY2FjNDBhMA==
+    ODY0YTVjYmY2YTE4MGY3NWU1OGU5NTU1YjcwZWVmNjU1NDU1OGYwMA==
   data.tar.gz: !binary |-
-    YjRjODdkZTczNWM0MWY1ZTQxMWY5NDUxMTcwNDRhYTI2YWNhYTY1MA==
+    MGYwNTY4Y2ZkMDRmNDMxZTIxNDYwMTc4YjA4YWQxN2I3ZmY2ZGIwMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWIxYmE0YzhjYzQwNGY1ZjMxY2M5ZTYyODEwYzA5N2UyYWM1ZjY5ZDIyN2Vk
-    MTM3YzY5YzZkOGQyZjZmZGQzY2VlNDJkNjBhMjQ1YzQyNGRiMmY3NzRhMDc1
-    MTQ0ZWM5Y2VhMGMxZTY1MjU4Nzg3YjQ5MzU2ZmNmMDhmZTdjNzY=
+    OWI3MDgwNGVlY2QxODU5ZGRhMjMyNDRkMzQ5YjI5YTRiM2VhMTU5N2JiYjAx
+    ZmEzNTMyODVlYjQyZGYzOWU4ZDViOGNhN2JmZWY1NDEwZTkxOGFlOTllZDAy
+    ZWZkZjQ0YmVjNmZhMzhjYTc1Mjk2ZmVlZTk2MjhmYTVmOTg0Mjc=
   data.tar.gz: !binary |-
-    ZDQ3MDUwNDVmMDA3MmIwZDJiZmE4NDYxYTQ5ODIyMjY4ZmYwYTgwMDllYjhi
-    YjZjNWNhODA2NWFhNjA0ZjY0ODliMTBhOWU3YTUzZDc5YTkyNWVmYjI2MDBl
-    ZGI2Y2UxYjhhYjVjYTVmM2RhYjBlOTBiMWZlZDdmMjQwZmRjYWE=
+    MTQ5ZGZiMTU3ZTAzMzlkNTZmNjIxMzkwN2EwZWE3ZjAzNDZhZDUzYWU3MjUy
+    ZGFhM2YxNTIzYzA4ODI2NDQ2YzE0NmNjYjU3MjI5NGM2NWU3NWVmZGJmMDI2
+    M2IxZDRlNDVjZmZkNjAxYzEyMWY5YjliNjU4NzBhZTM0ZjhmNGM=

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Master
 
+# 0.2.0
+
+- Wrap interactions in ActiveRecord transactions if they're available.
+- Add option to strip string values, which is enabled by default.
+- Add support for strptime format strings on Date, DateTime, and Time filters.
+
 # 0.1.3
 
 - Fix bug that prevented `attr_accessor`s from working.

data/README.md

@@ -22,7 +22,7 @@ This project uses [semantic versioning][].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 0.1.3'
+gem 'active_interaction', '~> 0.2.0'
 ```
 
 And then execute:
@@ -91,7 +91,9 @@ end
 You may have noticed that ActiveInteraction::Base quacks like
 ActiveRecord::Base. It can use validations from your Rails application
 and check option validity with `valid?`. Any errors are added to
-`errors` which works exactly like an ActiveRecord model.
+`errors` which works exactly like an ActiveRecord model. Additionally,
+everything within the `execute` method is run in a transaction if
+ActiveRecord is available.
 
 ## How do I call an interaction?
 

data/lib/active_interaction.rb

@@ -6,6 +6,7 @@ require 'active_interaction/overload_hash'
 require 'active_interaction/filter'
 require 'active_interaction/filter_method'
 require 'active_interaction/filter_methods'
+require 'active_interaction/filters/abstract_date_time_filter'
 require 'active_interaction/filters/array_filter'
 require 'active_interaction/filters/boolean_filter'
 require 'active_interaction/filters/date_filter'

data/lib/active_interaction/base.rb

@@ -1,5 +1,10 @@
 require 'active_support/core_ext/hash/indifferent_access'
 
+begin
+  require 'active_record'
+rescue LoadError
+end
+
 module ActiveInteraction
   # @abstract Subclass and override {#execute} to implement a custom
   #   ActiveInteraction class.
@@ -69,12 +74,25 @@ module ActiveInteraction
     # Runs the business logic associated with the interaction. The method is
     #   only run when there are no validation errors. The return value is
     #   placed into {#result}. This method must be overridden in the subclass.
+    #   This method is run in a transaction if ActiveRecord is available.
     #
     # @raise [NotImplementedError] if the method is not defined.
     def execute
       raise NotImplementedError
     end
 
+    # @private
+    def self.transaction
+      return unless block_given?
+
+      if defined?(ActiveRecord)
+        ::ActiveRecord::Base.transaction { yield }
+      else
+        yield
+      end
+    end
+    private_class_method :transaction
+
     # @!macro [new] run_attributes
     #   @param options [Hash] Attribute values to set.
 
@@ -85,11 +103,12 @@ module ActiveInteraction
     # @return [ActiveInteraction::Base] An instance of the class `run` is
     #   called on.
     def self.run(options = {})
-      me = new(options)
-
-      me.instance_variable_set(:@result, me.execute) if me.valid?
-
-      me
+      new(options).tap do |interaction|
+        if interaction.valid?
+          result = transaction { interaction.execute }
+          interaction.instance_variable_set(:@result, result)
+        end
+      end
     end
 
     # Like {.run} except that it returns the value of {#execute} or raises an

data/lib/active_interaction/filter.rb

@@ -18,24 +18,14 @@ module ActiveInteraction
     def self.prepare(key, value, options = {}, &block)
       case value
         when NilClass
-          return_nil(options[:allow_nil])
+          if options[:allow_nil]
+            nil
+          else
+            raise MissingValue
+          end
         else
-          bad_value
+          raise InvalidValue
       end
     end
-
-    def self.return_nil(allow_nil)
-      if allow_nil
-        nil
-      else
-        raise MissingValue
-      end
-    end
-    private_class_method :return_nil
-
-    def self.bad_value
-      raise InvalidValue
-    end
-    private_class_method :bad_value
   end
 end

data/lib/active_interaction/filters/abstract_date_time_filter.rb

@@ -0,0 +1,25 @@
+module ActiveInteraction
+  # @private
+  class AbstractDateTimeFilter < Filter
+    def self.prepare(key, value, options = {}, &block)
+      klass = options.delete(:class)
+
+      case value
+        when klass
+          value
+        when String
+          begin
+            if options.has_key?(:format)
+              klass.strptime(value, options[:format])
+            else
+              klass.parse(value)
+            end
+          rescue ArgumentError
+            super
+          end
+        else
+          super
+      end
+    end
+  end
+end

data/lib/active_interaction/filters/date_filter.rb

@@ -1,31 +1,26 @@
 module ActiveInteraction
   class Base
     # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Dates. String values are processed using `parse`.
+    #   the attributes are Dates. String values are processed using `parse`
+    #   unless the format option is given, in which case they will be processed
+    #   with `strptime`.
     #
     # @macro attribute_method_params
+    # @option options [String] :format Parse strings using this format string.
     #
     # @example
     #   date :birthday
     #
+    # @example
+    #   date :birthday, format: '%Y-%m-%d'
+    #
     # @method self.date(*attributes, options = {})
   end
 
   # @private
-  class DateFilter < Filter
+  class DateFilter < AbstractDateTimeFilter
     def self.prepare(key, value, options = {}, &block)
-      case value
-        when Date
-          value
-        when String
-          begin
-            Date.parse(value)
-          rescue ArgumentError
-            bad_value
-          end
-        else
-          super
-      end
+      super(key, value, options.merge(class: Date), &block)
     end
   end
 end

data/lib/active_interaction/filters/date_time_filter.rb

@@ -1,32 +1,26 @@
 module ActiveInteraction
   class Base
     # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are DateTimes. String values are processed using
-    #   `parse`.
+    #   the attributes are DateTimes. String values are processed using `parse`
+    #   unless the format option is given, in which case they will be processed
+    #   with `strptime`.
     #
     # @macro attribute_method_params
+    # @option options [String] :format Parse strings using this format string.
     #
     # @example
     #   date_time :start_date
     #
+    # @example
+    #   date_time :start_date, format: '%Y-%m-%dT%H:%M:%S'
+    #
     # @method self.date_time(*attributes, options = {})
   end
 
   # @private
-  class DateTimeFilter < Filter
+  class DateTimeFilter < AbstractDateTimeFilter
     def self.prepare(key, value, options = {}, &block)
-      case value
-        when DateTime
-          value
-        when String
-          begin
-            DateTime.parse(value)
-          rescue ArgumentError
-            bad_value
-          end
-        else
-          super
-      end
+      super(key, value, options.merge(class: DateTime), &block)
     end
   end
 end

data/lib/active_interaction/filters/float_filter.rb

@@ -22,7 +22,7 @@ module ActiveInteraction
           begin
             Float(value)
           rescue ArgumentError
-            bad_value
+            super
           end
         else
           super

data/lib/active_interaction/filters/integer_filter.rb

@@ -21,7 +21,7 @@ module ActiveInteraction
           begin
             Integer(value)
           rescue ArgumentError
-            bad_value
+            super
           end
         else
           super

data/lib/active_interaction/filters/string_filter.rb

@@ -4,6 +4,8 @@ module ActiveInteraction
     #   the attributes are Strings.
     #
     # @macro attribute_method_params
+    # @option options [Boolean] :strip (true) Strip leading and trailing
+    #   whitespace.
     #
     # @example
     #   string :first_name
@@ -16,7 +18,7 @@ module ActiveInteraction
     def self.prepare(key, value, options = {}, &block)
       case value
         when String
-          value
+          options.fetch(:strip, true) ? value.strip : value
         else
           super
       end

data/lib/active_interaction/filters/time_filter.rb

@@ -2,33 +2,30 @@ 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`. If `Time.zone` is available it
-    #   will be used so that the values are time zone aware.
+    #   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 attribute_method_params
+    # @option options [String] :format Parse strings using this format string.
     #
     # @example
     #   time :start_date
     #
+    # @example
+    #   date_time :start_date, format: '%Y-%m-%dT%H:%M:%S'
+    #
     # @method self.time(*attributes, options = {})
   end
 
   # @private
-  class TimeFilter < Filter
+  class TimeFilter < AbstractDateTimeFilter
     def self.prepare(key, value, options = {}, &block)
       case value
-        when Time
-          value
-        when String
-          begin
-            time.parse(value)
-          rescue ArgumentError
-            bad_value
-          end
         when Numeric
           time.at(value)
         else
-          super
+          super(key, value, options.merge(class: time), &block)
       end
     end
 

data/lib/active_interaction/version.rb

@@ -1,3 +1,3 @@
 module ActiveInteraction
-  VERSION = Gem::Version.new('0.1.3')
+  VERSION = Gem::Version.new('0.2.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -168,6 +168,31 @@ describe ActiveInteraction::Base do
         it 'sets the result' do
           expect(outcome.result).to eq thing
         end
+
+        it 'calls transaction' do
+          allow(described_class).to receive(:transaction)
+          outcome
+          expect(described_class).to have_received(:transaction).once.
+            with(no_args)
+        end
+
+        context 'with ActiveRecord' do
+          before do
+            ActiveRecord = Class.new
+            ActiveRecord::Base = double
+            allow(ActiveRecord::Base).to receive(:transaction)
+          end
+
+          after do
+            Object.send(:remove_const, :ActiveRecord)
+          end
+
+          it 'calls ActiveRecord::Base.transaction' do
+            outcome
+            expect(ActiveRecord::Base).to have_received(:transaction).once.
+              with(no_args)
+          end
+        end
       end
     end
 

data/spec/active_interaction/filters/date_filter_spec.rb

@@ -19,6 +19,16 @@ describe ActiveInteraction::DateFilter do
       it 'parses the String' do
         expect(result).to eql Date.parse(value)
       end
+
+      context 'with options[:format]' do
+        let(:value) { '01012001' }
+
+        before { options.merge!(format: '%m%d%Y') }
+
+        it 'parses the String' do
+          expect(result).to eql Date.strptime(value, options[:format])
+        end
+      end
     end
 
     context 'with an invalid String' do
@@ -27,6 +37,14 @@ describe ActiveInteraction::DateFilter do
       it 'raises an error' do
         expect { result }.to raise_error ActiveInteraction::InvalidValue
       end
+
+      context 'with options[:format]' do
+        before { options.merge!(format: '%m%d%Y') }
+
+        it 'raises an error' do
+          expect { result }.to raise_error ActiveInteraction::InvalidValue
+        end
+      end
     end
   end
 end

data/spec/active_interaction/filters/date_time_filter_spec.rb

@@ -19,6 +19,16 @@ describe ActiveInteraction::DateTimeFilter do
       it 'parses the String' do
         expect(result).to eql DateTime.parse(value)
       end
+
+      context 'with options[:format]' do
+        let(:value) { '01010101012001' }
+
+        before { options.merge!(format: '%S%M%H%m%d%Y') }
+
+        it 'parses the String' do
+          expect(result).to eql DateTime.strptime(value, options[:format])
+        end
+      end
     end
 
     context 'with an invalid String' do
@@ -27,6 +37,14 @@ describe ActiveInteraction::DateTimeFilter do
       it 'raises an error' do
         expect { result }.to raise_error ActiveInteraction::InvalidValue
       end
+
+      context 'with options[:format]' do
+        before { options.merge!(format: '%S%M%H%m%d%Y') }
+
+        it 'raises an error' do
+          expect { result }.to raise_error ActiveInteraction::InvalidValue
+        end
+      end
     end
   end
 end

data/spec/active_interaction/filters/string_filter_spec.rb

@@ -12,5 +12,21 @@ describe ActiveInteraction::StringFilter do
         expect(result).to eql value
       end
     end
+
+    context 'with a strippable String' do
+      let(:value) { " #{SecureRandom.hex} " }
+
+      it 'returns the stripped String' do
+        expect(result).to eql value.strip
+      end
+
+      context 'with options[:strip] as false' do
+        before { options.merge!(strip: false) }
+
+        it 'returns the String' do
+          expect(result).to eql value
+        end
+      end
+    end
   end
 end

data/spec/active_interaction/filters/time_filter_spec.rb

@@ -36,6 +36,16 @@ describe ActiveInteraction::TimeFilter do
         it 'parses the String' do
           expect(result).to eql Time.parse(value)
         end
+
+        context 'with options[:format]' do
+          let(:value) { '01010101012001' }
+
+          before { options.merge!(format: '%S%M%H%d%m%Y') }
+
+          it 'parses the String' do
+            expect(result).to eql Time.strptime(value, options[:format])
+          end
+        end
       end
 
       context 'with an invalid String' do
@@ -44,6 +54,14 @@ describe ActiveInteraction::TimeFilter do
         it 'raises an error' do
           expect { result }.to raise_error ActiveInteraction::InvalidValue
         end
+
+        context 'with options[:format]' do
+          before { options.merge!(format: '%S%M%H%d%m%Y') }
+
+          it 'raises an error' do
+            expect { result }.to raise_error ActiveInteraction::InvalidValue
+          end
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -150,6 +150,7 @@ files:
 - lib/active_interaction/filter.rb
 - lib/active_interaction/filter_method.rb
 - lib/active_interaction/filter_methods.rb
+- lib/active_interaction/filters/abstract_date_time_filter.rb
 - lib/active_interaction/filters/array_filter.rb
 - lib/active_interaction/filters/boolean_filter.rb
 - lib/active_interaction/filters/date_filter.rb