active_interaction 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d65a75d08fc8be7355ec025ebaed8b08873819c0
-  data.tar.gz: 3d75fd27e50013507a73176b40ba466e949b937f
+  metadata.gz: eac224974be5bdaafca02a1266a62b5a7d18e835
+  data.tar.gz: f6224fbee6808c51696a42af86a4138d20d6bd56
 SHA512:
-  metadata.gz: d807465b1015098c9c77c33c4429cd685fdf2eb268c83388ecd8b57110f12d1716309f1100c42fd2fda9b4bbefc9c612545c74905e6a17117fed45710ad5925c
-  data.tar.gz: 10c78c1906541dc8b89060c16bc957a44a9cd9519988e0633382c9609d4b101fa82ce9420df5fbf8b83a6f7ae9db4f76549c7075f5656d41a9423a52becd89db
+  metadata.gz: b816a2a4b4c463e5cc208862950d5b789c4d20c70df9a2cb98c7a8013b78a734426709d5e08587d2daea14034860521fb6286893e45c05418fab08331e3076be
+  data.tar.gz: fa0ec07a406a4c4d8c0d22270abaf05e2eb17bb3bd64a1590112fcca26649817a08aa48ad25f6785fc7caefd1e835eed14e4b4a8d613587cc4bb9f841c173e95

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [2.1.0][] (2015-07-30)
+
+## Added
+
+- [#295][]: Added `given?` predicate method to see if an input was passed to
+  `run`.
+
 # [2.0.1][] (2015-05-27)
 
 ## Fixed
@@ -423,6 +430,7 @@ For help upgrading to version 2, please read [the announcement post][].
 
 - Initial release.
 
+  [2.1.0]: https://github.com/orgsync/active_interaction/compare/v2.0.1...v2.1.0
   [2.0.1]: https://github.com/orgsync/active_interaction/compare/v2.0.0...v2.0.1
   [2.0.0]: https://github.com/orgsync/active_interaction/compare/v1.6.0...v2.0.0
   [1.6.0]: https://github.com/orgsync/active_interaction/compare/v1.5.1...v1.6.0
@@ -556,5 +564,6 @@ For help upgrading to version 2, please read [the announcement post][].
   [#269]: https://github.com/orgsync/active_interaction/issues/269
   [#286]: https://github.com/orgsync/active_interaction/issues/286
   [#289]: https://github.com/orgsync/active_interaction/issues/289
+  [#295]: https://github.com/orgsync/active_interaction/issues/295
 
   [the announcement post]: http://devblog.orgsync.com/2015/05/06/announcing-active-interaction-2/

data/README.md

@@ -1,7 +1,3 @@
-<p align="center">
-  <img alt="" src="https://a.pomf.se/auvctt.svg" width="250">
-</p>
-
 <h1 align="center">
   <a href="https://github.com/orgsync/active_interaction">
     ActiveInteraction
@@ -66,6 +62,7 @@ Read more on [the project page][] or check out [the full documentation][].
   - [Descriptions](#descriptions)
   - [Errors](#errors)
   - [Forms](#forms)
+  - [Optional inputs](#optional-inputs)
   - [Predicates](#predicates)
   - [Translations](#translations)
 - [Credits](#credits)
@@ -75,13 +72,13 @@ Read more on [the project page][] or check out [the full documentation][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 2.0'
+gem 'active_interaction', '~> 2.1'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 2.0'
+$ gem install active_interaction --version '~> 2.1'
 ```
 
 This project uses [Semantic Versioning][]. Check out [the change log][] for a
@@ -257,8 +254,14 @@ array :birthdays do
 end
 ```
 
-Note that filters inside an array block don't have names. Also you can only
-have one filter inside an array block.
+Note that you can only have one filter inside an array block, and it must not
+have a name.
+
+``` rb
+array :cows do
+  object class: Cow
+end
+```
 
 ### Boolean
 
@@ -1161,6 +1164,44 @@ used to define the inputs on your interaction will relay type information to
 these gems. As a result, form fields will automatically use the appropriate
 input type.
 
+### Optional inputs
+
+Optional inputs can be defined by using the `:default` option as described in
+[the Filters section][]. Within the interaction, provided and default values
+are merged to create `inputs`. There are times where it is useful to know
+whether a value was passed to `run` or the result of a filter default. In
+particular, it is useful when `nil` is an acceptable value. For example, you
+may optionally track your users' birthdays. You can use the `given?` predicate
+to see if an input was even passed to `run`.
+
+``` rb
+class UpdateUser < ActiveInteraction::Base
+  object :user
+  date :birthday,
+    default: nil
+
+  def execute
+    user.birthday = birthday if given?(:birthday)
+    errors.merge!(user) unless user.save
+    user
+  end
+end
+```
+
+Now you have a few options. If you don't want to update their birthday, leave
+it out of the hash. If you want to remove their birthday, set `birthday: nil`.
+And if you want to update it, pass in the new value as usual.
+
+``` rb
+user = User.find(...)
+# Don't update their birthday.
+UpdateUser.run!(user: user)
+# Remove their birthday.
+UpdateUser.run!(user: user, birthday: nil)
+# Update their birthday.
+UpdateUser.run!(user: user, birthday: Date.new(2000, 1, 2))
+```
+
 ### Predicates
 
 ActiveInteraction creates a predicate method for every input defined by a filter. So if you have an input called `foo`, there will be a predicate method called `#foo?`. That method will tell you if the input was given (that is, if it was not `nil`).
@@ -1265,4 +1306,5 @@ Logo design by [Tyler Lee][].
 [the mit license]: LICENSE.md
 [formtastic]: https://rubygems.org/gems/formtastic
 [simple_form]: https://rubygems.org/gems/simple_form
+[the filters section]: #filters
 [tyler lee]: https://github.com/tylerlee

data/lib/active_interaction/base.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 require 'active_support/core_ext/hash/indifferent_access'
+require 'set'
 
 module ActiveInteraction
   # @abstract Subclass and override {#execute} to implement a custom
@@ -194,6 +195,28 @@ module ActiveInteraction
       end
     end
 
+    # Returns `true` if the given key was in the hash passed to {.run}.
+    # Otherwise returns `false`. Use this to figure out if an input was given,
+    # even if it was `nil`.
+    #
+    # @example
+    #   class Example < ActiveInteraction::Base
+    #     integer :x, default: nil
+    #     def execute; given?(:x) end
+    #   end
+    #   Example.run!()        # => false
+    #   Example.run!(x: nil)  # => true
+    #   Example.run!(x: rand) # => true
+    #
+    # @param input [#to_sym]
+    #
+    # @return [Boolean]
+    #
+    # @since 2.1.0
+    def given?(input)
+      @_interaction_keys.include?(input.to_sym)
+    end
+
     protected
 
     def run_validations!
@@ -206,6 +229,8 @@ module ActiveInteraction
 
     # @param inputs [Hash{Symbol => Object}]
     def process_inputs(inputs)
+      @_interaction_keys = inputs.keys.to_set & self.class.filters.keys
+
       inputs.each do |key, value|
         fail InvalidValueError, key.inspect if InputProcessor.reserved?(key)
 

data/lib/active_interaction/version.rb

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

data/lib/active_interaction.rb

@@ -9,7 +9,7 @@ require 'active_model'
 #
 # @since 1.0.0
 #
-# @version 2.0.1
+# @version 2.1.0
 module ActiveInteraction
 end
 

data/spec/active_interaction/base_spec.rb

@@ -365,6 +365,55 @@ describe ActiveInteraction::Base do
     end
   end
 
+  describe '#given?' do
+    let(:described_class) do
+      Class.new(TestInteraction) do
+        float :x,
+          default: nil
+
+        def execute
+          given?(:x)
+        end
+      end
+    end
+
+    it 'is false when the input is not given' do
+      expect(result).to be false
+    end
+
+    it 'is true when the input is nil' do
+      inputs[:x] = nil
+      expect(result).to be true
+    end
+
+    it 'is true when the input is given' do
+      inputs[:x] = rand
+      expect(result).to be true
+    end
+
+    it 'symbolizes its argument' do
+      described_class.class_exec do
+        def execute
+          given?('x')
+        end
+      end
+
+      inputs[:x] = rand
+      expect(result).to be true
+    end
+
+    it 'only tracks inputs with filters' do
+      described_class.class_exec do
+        def execute
+          given?(:y)
+        end
+      end
+
+      inputs[:y] = rand
+      expect(result).to be false
+    end
+  end
+
   context 'inheritance' do
     context 'filters' do
       let(:described_class) { InteractionWithFilter }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -141,28 +141,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.32'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -291,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Manage application specific business logic.