active_interaction 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ebbd60d2d495d3011785f7fb78478f6b6b4a2d9
-  data.tar.gz: e52b7f93aff786d4a8be65e36121ecc5b30eaf3b
+  metadata.gz: 1c1d5b914798cc9b8b70729d645f8ef4a0d4031f
+  data.tar.gz: ae3a8b0db8afdd311a44d9c73e1fcb2788d11086
 SHA512:
-  metadata.gz: b9b58d141cca46ad7b9b0dba1373c9e0cb159cc04d9831b0660df7d1941347d94b1e63b8f9f063d0425240173757f4fff00453650299d46f52059b5d49ccb1f9
-  data.tar.gz: 14bee4cebb9847f4eb759016e9846e7171d6a7647b78516c4389686dbb1e6ed7f8e94438a63d1a83c028f446c86d4289f57ededca0af5afaabc0887ff742d60f
+  metadata.gz: 95496b5a5f1b4d837b7d2e1231c38ae6522aac69fd0bcc5f5c70739f26428299e4aaf89d43791558b97c5f90b5e4e422b9ade2db76aec0371da27fcb078a9fa8
+  data.tar.gz: 7fcb37ddb4a3bd9beb005401448304314a6996fe99c0b4e6ddcb1f684c456cd861fcfdaddc75aa7a7ff24571f1a52f2783406c6ff8af519d5295d6c1287df61d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # [Master][]
 
+# [1.2.0][] (2014-04-30)
+
+- Add a decimal filter.
+- Add support for disabling and modifying transactions through the
+  `transaction` helper method.
+- Add support for `column_for_attribute` which provides better interoperability with gems like Formtastic and Simple Form.
+
 # [1.1.7][] (2014-04-30)
 
 - Fix a bug that leaked validators among all child classes.
@@ -186,7 +193,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v1.1.7...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v1.2.0...master
+  [1.2.0]: https://github.com/orgsync/active_interaction/compare/v1.1.7...v1.2.0
   [1.1.7]: https://github.com/orgsync/active_interaction/compare/v1.1.6...v1.1.7
   [1.1.6]: https://github.com/orgsync/active_interaction/compare/v1.1.5...v1.1.6
   [1.1.5]: https://github.com/orgsync/active_interaction/compare/v1.1.4...v1.1.5

data/README.md

@@ -25,7 +25,7 @@ This project uses [semantic versioning][13].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 1.1'
+gem 'active_interaction', '~> 1.2'
 ```
 
 And then execute:
@@ -94,7 +94,7 @@ 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. Additionally,
+`errors` which works exactly like an ActiveRecord model. By default,
 everything within the `execute` method is run in a transaction if
 ActiveRecord is available.
 
@@ -247,6 +247,7 @@ hsilgne:
       boolean: naeloob
       date: etad
       date_time: emit etad
+      decimal: lamiced
       file: elif
       float: taolf
       hash: hsah

data/lib/active_interaction.rb

@@ -8,10 +8,15 @@ require 'active_interaction/errors'
 require 'active_interaction/concerns/active_modelable'
 require 'active_interaction/concerns/hashable'
 require 'active_interaction/concerns/missable'
+require 'active_interaction/concerns/transactable'
 require 'active_interaction/concerns/runnable'
 
+require 'active_interaction/grouped_input'
+
+require 'active_interaction/modules/input_processor'
 require 'active_interaction/modules/validation'
 
+require 'active_interaction/filter_column'
 require 'active_interaction/filter'
 require 'active_interaction/filters/abstract_filter'
 require 'active_interaction/filters/abstract_date_time_filter'
@@ -20,6 +25,7 @@ require 'active_interaction/filters/array_filter'
 require 'active_interaction/filters/boolean_filter'
 require 'active_interaction/filters/date_filter'
 require 'active_interaction/filters/date_time_filter'
+require 'active_interaction/filters/decimal_filter'
 require 'active_interaction/filters/file_filter'
 require 'active_interaction/filters/float_filter'
 require 'active_interaction/filters/hash_filter'
@@ -41,5 +47,5 @@ I18n.load_path << File.expand_path(
 #
 # @since 1.0.0
 #
-# @version 1.1.7
+# @version 1.2.0
 module ActiveInteraction end

data/lib/active_interaction/base.rb

@@ -58,6 +58,28 @@ module ActiveInteraction
       #
       #   @raise (see ActiveInteraction::Runnable::ClassMethods#run!)
 
+      # @!method transaction(enable, options = {})
+      #   Configure transactions by enabling or disabling them and setting
+      #   their options.
+      #
+      #   @example Disable transactions
+      #     Class.new(ActiveInteraction::Base) do
+      #       transaction false
+      #     end
+      #
+      #   @example Use different transaction options
+      #     Class.new(ActiveInteraction::Base) do
+      #       transaction true, isolation: :serializable
+      #     end
+      #
+      #   @param enable [Boolean] Should transactions be enabled?
+      #   @param options [Hash] Options to pass to
+      #     `ActiveRecord::Base.transaction`.
+      #
+      #   @return [nil]
+      #
+      #   @since 1.2.0
+
       # Get or set the description.
       #
       # @example
@@ -104,7 +126,7 @@ module ActiveInteraction
       # @param name [Symbol]
       # @param options [Hash]
       def add_filter(klass, name, options, &block)
-        fail InvalidFilterError, name.inspect if reserved?(name)
+        fail InvalidFilterError, name.inspect if InputProcessor.reserved?(name)
 
         initialize_filter(klass.new(name, options, &block))
       end
@@ -148,13 +170,6 @@ module ActiveInteraction
 
         filter.default if filter.default?
       end
-
-      # @param symbol [Symbol]
-      #
-      # @return [Boolean]
-      def reserved?(symbol)
-        symbol.to_s.start_with?('_interaction_')
-      end
     end
 
     # @param inputs [Hash{Symbol => Object}] Attribute values to set.
@@ -166,6 +181,31 @@ module ActiveInteraction
       process_inputs(inputs.symbolize_keys)
     end
 
+    # Returns the column object for the named filter.
+    #
+    # @param name [Symbol] The name of a filter.
+    #
+    # @example
+    #   class Interaction < ActiveInteraction::Base
+    #     string :email, default: nil
+    #
+    #     def execute; end
+    #   end
+    #
+    #   Interaction.new.column_for_attribute(:email)
+    #   # => #<ActiveInteraction::FilterColumn:0x007faebeb2a6c8 @type=:string>
+    #
+    #   Interaction.new.column_for_attribute(:not_a_filter)
+    #   # => nil
+    #
+    # @return [FilterColumn, nil]
+    #
+    # @since 1.2.0
+    def column_for_attribute(name)
+      filter = self.class.filters[name]
+      FilterColumn.intern(filter.database_column_type) if filter
+    end
+
     # @!method compose(other, inputs = {})
     #   Run another interaction and return its result. If the other interaction
     #     fails, halt execution.
@@ -179,9 +219,9 @@ module ActiveInteraction
     #   @abstract
     #
     #   Runs the business logic associated with the interaction. This method is
-    #     only run when there are no validation errors. The return value is
-    #     placed into {#result}. This method is run in a transaction if
-    #     ActiveRecord is available.
+    #   only run when there are no validation errors. The return value is
+    #   placed into {#result}. By default, this method is run in a transaction
+    #   if ActiveRecord is available (see {.transaction}).
     #
     #   @raise (see ActiveInteraction::Runnable#execute)
 
@@ -200,11 +240,19 @@ module ActiveInteraction
     # @param inputs [Hash{Symbol => Object}]
     def process_inputs(inputs)
       inputs.each do |key, value|
-        fail InvalidValueError, key.inspect if self.class.send(:reserved?, key)
+        fail InvalidValueError, key.inspect if InputProcessor.reserved?(key)
 
-        instance_variable_set("@#{key}", value) if respond_to?(key)
+        populate_reader(key, value)
       end
 
+      populate_filters(InputProcessor.process(inputs))
+    end
+
+    def populate_reader(key, value)
+      instance_variable_set("@#{key}", value) if respond_to?(key)
+    end
+
+    def populate_filters(inputs)
       self.class.filters.each do |name, filter|
         begin
           public_send("#{name}=", filter.clean(inputs[name]))

data/lib/active_interaction/concerns/runnable.rb

@@ -1,22 +1,5 @@
 # coding: utf-8
 
-begin
-  require 'active_record'
-rescue LoadError
-  # rubocop:disable Documentation
-  module ActiveRecord
-    Rollback = Class.new(ActiveInteraction::Error)
-
-    class Base
-      def self.transaction(*)
-        yield
-      rescue Rollback
-        # rollbacks are silently swallowed
-      end
-    end
-  end
-end
-
 module ActiveInteraction
   # @abstract Include and override {#execute} to implement a custom Runnable
   #   class.
@@ -30,6 +13,7 @@ module ActiveInteraction
   module Runnable
     extend ActiveSupport::Concern
     include ActiveModel::Validations
+    include ActiveInteraction::Transactable
 
     included do
       define_callbacks :execute
@@ -98,7 +82,7 @@ module ActiveInteraction
     def run
       return unless valid?
 
-      self.result = ActiveRecord::Base.transaction do
+      self.result = transaction do
         begin
           run_callbacks(:execute) { execute }
         rescue Interrupt => interrupt

data/lib/active_interaction/concerns/transactable.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+begin
+  require 'active_record'
+rescue LoadError
+  module ActiveRecord # rubocop:disable Documentation
+    Rollback = Class.new(ActiveInteraction::Error)
+
+    class Base # rubocop:disable Documentation
+      def self.transaction(*)
+        yield
+      rescue Rollback
+      end
+    end
+  end
+end
+
+module ActiveInteraction
+  # @private
+  #
+  # Execute code in a transaction. If ActiveRecord isn't available, don't do
+  # anything special.
+  #
+  # @since 1.2.0
+  module Transactable
+    extend ActiveSupport::Concern
+
+    # @yield []
+    def transaction
+      return unless block_given?
+
+      if self.class.transaction?
+        ActiveRecord::Base.transaction(self.class.transaction_options) do
+          yield
+        end
+      else
+        yield
+      end
+    end
+
+    module ClassMethods # rubocop:disable Documentation
+      # @param enable [Boolean]
+      # @param options [Hash]
+      #
+      # @return [nil]
+      def transaction(enable, options = {})
+        @_interaction_transaction_enabled = enable
+        @_interaction_transaction_options = options
+
+        nil
+      end
+
+      # @return [Boolean]
+      def transaction?
+        unless defined?(@_interaction_transaction_enabled)
+          @_interaction_transaction_enabled = true
+        end
+
+        @_interaction_transaction_enabled
+      end
+
+      # @return [Hash]
+      def transaction_options
+        unless defined?(@_interaction_transaction_options)
+          @_interaction_transaction_options = {}
+        end
+
+        @_interaction_transaction_options
+      end
+    end
+  end
+end

data/lib/active_interaction/errors.rb

@@ -47,6 +47,13 @@ module ActiveInteraction
   # @return [Class]
   NoDefaultError = Class.new(Error)
 
+  # Raised if a reserved name is used.
+  #
+  # @return [Class]
+  #
+  # @since 1.2.0
+  ReservedNameError = Class.new(Error)
+
   # Raised if a user-supplied value to a nested hash input is invalid.
   #
   # @return [Class]

data/lib/active_interaction/filter.rb

@@ -67,9 +67,11 @@ module ActiveInteraction
       #
       # @see .factory
       def slug
-        match = CLASS_REGEXP.match(name)
+        return @slug if defined?(@slug)
+
+        match = name[CLASS_REGEXP, 1]
         fail InvalidClassError, name unless match
-        match.captures.first.underscore.to_sym
+        @slug = match.underscore.to_sym
       end
 
       # @param klass [Class]
@@ -145,6 +147,8 @@ module ActiveInteraction
       fail NoDefaultError, name unless default?
 
       value = raw_default
+      fail InvalidValueError if value.is_a?(GroupedInput)
+
       cast(value)
     rescue InvalidValueError, MissingValueError
       raise InvalidDefaultError, "#{name}: #{value.inspect}"
@@ -195,6 +199,23 @@ module ActiveInteraction
       end
     end
 
+    # Gets the type of database column that would represent the filter data.
+    #
+    # @example
+    #   ActiveInteraction::TimeFilter.new(Time.now).database_column_type
+    #   # => :datetime
+    # @example
+    #   ActiveInteraction::Filter.new(:example).database_column_type
+    #   # => :string
+    #
+    # @return [Symbol] A database column type. If no sensible mapping exists,
+    #   returns `:string`.
+    #
+    # @since 1.2.0
+    def database_column_type
+      :string
+    end
+
     private
 
     # @return [Object]

data/lib/active_interaction/filter_column.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+module ActiveInteraction
+  # A minimal implementation of an `ActiveRecord::ConnectionAdapters::Column`.
+  #
+  # @since 1.2.0
+  class FilterColumn
+    # @return [nil]
+    attr_reader :limit
+
+    # @return [Symbol]
+    attr_reader :type
+
+    class << self
+      # Find or create the `FilterColumn` for a specific type.
+      #
+      # @param type [Symbol] A database column type.
+      #
+      # @example
+      #   FilterColumn.intern(:string)
+      #   # => #<ActiveInteraction::FilterColumn:0x007feeaa649c @type=:string>
+      #
+      #   FilterColumn.intern(:string)
+      #   # => #<ActiveInteraction::FilterColumn:0x007feeaa649c @type=:string>
+      #
+      #   FilterColumn.intern(:boolean)
+      #   # => #<ActiveInteraction::FilterColumn:0x007feeab8a08 @type=:boolean>
+      #
+      # @return [FilterColumn]
+      def intern(type)
+        @columns ||= {}
+        @columns[type] ||= new(type)
+      end
+
+      private :new
+    end
+
+    # @param type [type] The database column type.
+    #
+    # @private
+    def initialize(type)
+      @type = type
+    end
+
+    # Returns `true` if the column is either of type :integer or :float.
+    #
+    # @return [Boolean]
+    def number?
+      [:integer, :float].include?(type)
+    end
+
+    # Returns `true` if the column is of type :string.
+    #
+    # @return [Boolean]
+    def text?
+      type == :string
+    end
+  end
+end

data/lib/active_interaction/filters/abstract_date_time_filter.rb

@@ -17,11 +17,17 @@ module ActiveInteraction
         value
       when String
         convert(value)
+      when GroupedInput
+        convert(stringify(value))
       else
         super
       end
     end
 
+    def database_column_type
+      self.class.slug
+    end
+
     private
 
     def convert(value)
@@ -49,5 +55,13 @@ module ActiveInteraction
     def klasses
       [klass]
     end
+
+    # @return [String]
+    def stringify(value)
+      date = %w[1 2 3].map { |key| value[key] }.join('-')
+      time = %w[4 5 6].map { |key| value[key] }.join(':')
+
+      "#{date} #{time}"
+    end
   end
 end