active_interaction 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4988ddb8d0259f53b92c2d8d81226902c0030d86
-  data.tar.gz: 8e36ae7a40b895596de17a7b94a5e568354dd686
+  metadata.gz: 2f6687ab2fb463ecc05f0e785e9c05cf0b5d1172
+  data.tar.gz: d75174715db45471c960c5e1bb4effffb2ab9b7d
 SHA512:
-  metadata.gz: 7af4c2ad4e2ae219859035746672c653318d7fbf9de7fe50f857c2518852cf6b78d92cbaf2161702c2c489f065f60a3af3bd2e8b9fbe205791b805cdd5b39975
-  data.tar.gz: 6454349ce56378be4373257973c4ac710712299e963ebe165828eca0ef90d5b09f257c8ca6763ea5791f2217a95f3eac5253cd9ab7b5bc5fc8c31fc418275909
+  metadata.gz: 113199ae4863c2a7d78764179c9bd5caec7d516af78c921f1e788b5e9b1a2e251814b3e82786e790facc45d616f069e8a7b4e9e226a4d96b160e98e0c019e180
+  data.tar.gz: 5fefc55875416c15613c3edf28ca86d65996404ddb297037980360bab4f27a87bba7bad61b0eb6b9d51eaebce3fb337cee7234574b31a45d3b2356ec78514ef9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [Master][]
 
+# [0.8.0][] (2013-11-14)
+
+- Add ability to document interactions and filters.
+
 # [0.7.0][] (2013-11-14)
 
 - Add ability to chain a series of interactions together with
@@ -76,7 +80,8 @@
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v0.7.0...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v0.8.0...master
+  [0.8.0]: https://github.com/orgsync/active_interaction/compare/v0.7.0...v0.8.0
   [0.7.0]: https://github.com/orgsync/active_interaction/compare/v0.6.1...v0.7.0
   [0.6.1]: https://github.com/orgsync/active_interaction/compare/v0.6.0...v0.6.1
   [0.6.0]: https://github.com/orgsync/active_interaction/compare/v0.5.0...v0.6.0

data/README.md

@@ -25,7 +25,7 @@ This project uses [semantic versioning][].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 0.7.0'
+gem 'active_interaction', '~> 0.8.0'
 ```
 
 And then execute:

data/lib/active_interaction.rb

@@ -2,10 +2,15 @@ require 'active_model'
 
 require 'active_interaction/version'
 require 'active_interaction/errors'
-require 'active_interaction/active_model'
-require 'active_interaction/method_missing'
-require 'active_interaction/overload_hash'
+
+require 'active_interaction/modules/active_model'
+require 'active_interaction/modules/core'
+require 'active_interaction/modules/method_missing'
+require 'active_interaction/modules/overload_hash'
+require 'active_interaction/modules/validation'
+
 require 'active_interaction/filter'
+require 'active_interaction/filters'
 require 'active_interaction/filters/abstract_date_time_filter'
 require 'active_interaction/filters/abstract_numeric_filter'
 require 'active_interaction/filters/array_filter'
@@ -20,9 +25,7 @@ require 'active_interaction/filters/model_filter'
 require 'active_interaction/filters/string_filter'
 require 'active_interaction/filters/symbol_filter'
 require 'active_interaction/filters/time_filter'
-require 'active_interaction/filters'
-require 'active_interaction/validation'
-require 'active_interaction/core'
+
 require 'active_interaction/base'
 require 'active_interaction/pipeline'
 

data/lib/active_interaction/base.rb

@@ -33,25 +33,15 @@ module ActiveInteraction
 
     validate :input_errors, :runtime_errors
 
-    # Returns the inputs provided to {.run} or {.run!} after being cast based
-    #   on the filters in the class.
-    #
-    # @return [Hash{Symbol => Object}] All inputs passed to {.run} or {.run!}.
-    #
-    # @since 0.6.0
-    def inputs
-      self.class.filters.reduce({}) do |h, filter|
-        h[filter.name] = send(filter.name)
-        h
-      end
-    end
-
     # @param options [Hash{Symbol => Object}] Attribute values to set.
     #
     # @private
     def initialize(options = {})
-      options = options.symbolize_keys
+      @_interaction_errors = Errors.new(self)
+      @_interaction_result = nil
+      @_interaction_runtime_errors = nil
 
+      options = options.symbolize_keys
       options.each do |key, value|
         if key.to_s.start_with?('_interaction_')
           raise InvalidValueError, key.inspect
@@ -68,6 +58,19 @@ module ActiveInteraction
       end
     end
 
+    # Returns the inputs provided to {.run} or {.run!} after being cast based
+    #   on the filters in the class.
+    #
+    # @return [Hash{Symbol => Object}] All inputs passed to {.run} or {.run!}.
+    #
+    # @since 0.6.0
+    def inputs
+      self.class.filters.reduce({}) do |h, filter|
+        h[filter.name] = send(filter.name)
+        h
+      end
+    end
+
     # 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.
@@ -86,17 +89,12 @@ module ActiveInteraction
     # @return [Nil] if there are validation errors.
     # @return [Object] if there are no validation errors.
     def result
-      symbol = :'@_interaction_result'
-      if instance_variable_defined?(symbol)
-        instance_variable_get(symbol)
-      else
-        nil
-      end
+      @_interaction_result
     end
 
     # @private
     def errors
-      @_interaction_errors ||= Errors.new(self)
+      @_interaction_errors
     end
 
     # @private
@@ -164,7 +162,7 @@ module ActiveInteraction
     end
 
     def runtime_errors
-      return unless instance_variable_defined?(:@_interaction_runtime_errors)
+      return unless @_interaction_runtime_errors
 
       @_interaction_runtime_errors.symbolic.each do |attribute, symbols|
         symbols.each { |symbol| errors.add_sym(attribute, symbol) }

data/lib/active_interaction/filter.rb

@@ -6,6 +6,7 @@ module ActiveInteraction
   #   @param options [Hash{Symbol => Object}]
   #
   #   @option options [Object] :default fallback value if `nil` is given
+  #   @option options [String] :desc human-readable description of this input
 
   # Describes an input filter for an interaction.
   #
@@ -164,6 +165,19 @@ module ActiveInteraction
       raise InvalidDefaultError, "#{name}: #{options[:default].inspect}"
     end
 
+    # Get the description.
+    #
+    # @example
+    #   ActiveInteraction::Filter.new(:example, desc: 'description').desc
+    #   # => "description"
+    #
+    # @return [String, nil] the description
+    #
+    # @since 0.8.0
+    def desc
+      options[:desc]
+    end
+
     # Tells if this filter has a default value.
     #
     # @example

data/lib/active_interaction/{core.rb → modules/core.rb}

@@ -9,6 +9,32 @@ module ActiveInteraction
   # @see Base
   # @see Pipeline
   module Core
+    # Get or set the description.
+    #
+    # @example
+    #   core.desc
+    #   # => nil
+    #   core.desc('descriptive!')
+    #   core.desc
+    #   # => "descriptive!"
+    #
+    # @param desc [String, nil] what to set the description to
+    #
+    # @return [String, nil] the description
+    #
+    # @since 0.8.0
+    def desc(desc = nil)
+      if desc.nil?
+        unless instance_variable_defined?(:@_interaction_desc)
+          @_interaction_desc = nil
+        end
+      else
+        @_interaction_desc = desc
+      end
+
+      @_interaction_desc
+    end
+
     # Like {Base.run} except that it returns the value of {Base#execute} or
     #   raises an exception if there were any validation errors.
     #

data/lib/active_interaction/pipeline.rb

@@ -60,10 +60,11 @@ module ActiveInteraction
     # @raise [EmptyPipelineError] if nothing is in the pipeline
     def run(*args)
       raise EmptyPipelineError if @steps.empty?
+
       transaction do
         function, interaction = @steps.first
         outcome = interaction.run(function.call(*args))
-        @steps[1..-1].reduce(outcome) { |o, (f, i)| bind(o, f, i) }
+        @steps.drop(1).reduce(outcome) { |o, (f, i)| bind(o, f, i) }
       end
     end
 

data/lib/active_interaction/version.rb

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

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

@@ -1,33 +1,30 @@
 require 'spec_helper'
 
 describe ActiveInteraction::ActiveModel do
-  subject(:model) do
-    Class.new do
-      include ActiveInteraction::ActiveModel
-    end
-  end
+  let(:klass) { Class.new { include ActiveInteraction::ActiveModel } }
+  subject(:instance) { klass.new }
 
-  describe '#new_record?' do
-    it 'returns true' do
-      expect(model.new).to be_new_record
+  describe '.i18n_scope' do
+    it 'returns the scope' do
+      expect(klass.i18n_scope).to eq :active_interaction
     end
   end
 
-  describe '#persisted?' do
-    it 'returns false' do
-      expect(model.new).to_not be_persisted
+  describe '#i18n_scope' do
+    it 'returns the scope' do
+      expect(instance.i18n_scope).to eq :active_interaction
     end
   end
 
-  describe '.i18n_scope' do
-    it 'returns the scope' do
-      expect(model.i18n_scope).to eq :active_interaction
+  describe '#new_record?' do
+    it 'returns true' do
+      expect(instance).to be_new_record
     end
   end
 
-  describe '#i18n_scope' do
-    it 'returns the scope' do
-      expect(model.new.i18n_scope).to eq :active_interaction
+  describe '#persisted?' do
+    it 'returns false' do
+      expect(instance).to_not be_persisted
     end
   end
 end

data/spec/active_interaction/{core_spec.rb → modules/core_spec.rb}

@@ -1,13 +1,25 @@
 require 'spec_helper'
 
 describe ActiveInteraction::Core do
-  let(:model) do
-    Class.new do
-      include ActiveInteraction::Core
+  let(:klass) { Class.new { include ActiveInteraction::Core } }
+  subject(:instance) { klass.new }
+
+  describe '#desc' do
+    let(:desc) { SecureRandom.hex }
+
+    it 'returns nil' do
+      expect(instance.desc).to be_nil
     end
-  end
 
-  subject(:instance) { model.new }
+    it 'returns the description' do
+      expect(instance.desc(desc)).to eq desc
+    end
+
+    it 'saves the description' do
+      instance.desc(desc)
+      expect(instance.desc).to eq desc
+    end
+  end
 
   describe '#run!' do
     let(:errors) { double(full_messages: []) }

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

@@ -1,13 +1,8 @@
 require 'spec_helper'
 
 describe ActiveInteraction::MethodMissing do
-  let(:model) do
-    Class.new do
-      include ActiveInteraction::MethodMissing
-    end
-  end
-
-  subject(:instance) { model.new }
+  let(:klass) { Class.new { include ActiveInteraction::MethodMissing } }
+  subject(:instance) { klass.new }
 
   describe '#method_missing' do
     context 'with invalid slug' do
@@ -16,7 +11,7 @@ describe ActiveInteraction::MethodMissing do
       it 'calls super' do
         expect {
           instance.method_missing(slug)
-        }.to raise_error NoMethodError
+        }.to raise_error NameError
       end
     end
 

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

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
 describe ActiveInteraction::OverloadHash do
-  subject { double.extend(described_class) }
+  let(:klass) { Class.new { include ActiveInteraction::OverloadHash } }
+  subject(:instance) { klass.new }
 
   describe '#hash(*args, &block)' do
     context 'with no arguments' do

data/spec/support/filters.rb

@@ -153,6 +153,24 @@ shared_examples_for 'a filter' do
     end
   end
 
+  describe '#desc' do
+    it 'returns nil' do
+      expect(filter.desc).to be_nil
+    end
+
+    context 'with a description' do
+      let(:desc) { SecureRandom.hex }
+
+      before do
+        options.merge!(desc: desc)
+      end
+
+      it 'returns the description' do
+        expect(filter.desc).to eq desc
+      end
+    end
+  end
+
   describe '#filters' do
     it 'returns Filters' do
       expect(filter.filters).to be_an ActiveInteraction::Filters

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -151,9 +151,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/active_interaction/active_model.rb
 - lib/active_interaction/base.rb
-- lib/active_interaction/core.rb
 - lib/active_interaction/errors.rb
 - lib/active_interaction/filter.rb
 - lib/active_interaction/filters/abstract_date_time_filter.rb
@@ -171,15 +169,15 @@ files:
 - lib/active_interaction/filters/symbol_filter.rb
 - lib/active_interaction/filters/time_filter.rb
 - lib/active_interaction/filters.rb
-- lib/active_interaction/method_missing.rb
-- lib/active_interaction/overload_hash.rb
+- lib/active_interaction/modules/active_model.rb
+- lib/active_interaction/modules/core.rb
+- lib/active_interaction/modules/method_missing.rb
+- lib/active_interaction/modules/overload_hash.rb
+- lib/active_interaction/modules/validation.rb
 - lib/active_interaction/pipeline.rb
-- lib/active_interaction/validation.rb
 - lib/active_interaction/version.rb
 - lib/active_interaction.rb
-- spec/active_interaction/active_model_spec.rb
 - spec/active_interaction/base_spec.rb
-- spec/active_interaction/core_spec.rb
 - spec/active_interaction/errors_spec.rb
 - spec/active_interaction/filter_spec.rb
 - spec/active_interaction/filters/array_filter_spec.rb
@@ -208,10 +206,12 @@ files:
 - spec/active_interaction/integration/string_interaction_spec.rb
 - spec/active_interaction/integration/symbol_interaction_spec.rb
 - spec/active_interaction/integration/time_interaction_spec.rb
-- spec/active_interaction/method_missing_spec.rb
-- spec/active_interaction/overload_hash_spec.rb
+- spec/active_interaction/modules/active_model_spec.rb
+- spec/active_interaction/modules/core_spec.rb
+- spec/active_interaction/modules/method_missing_spec.rb
+- spec/active_interaction/modules/overload_hash_spec.rb
+- spec/active_interaction/modules/validation_spec.rb
 - spec/active_interaction/pipeline_spec.rb
-- spec/active_interaction/validation_spec.rb
 - spec/spec_helper.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
@@ -243,9 +243,7 @@ signing_key:
 specification_version: 4
 summary: Manage application specific business logic.
 test_files:
-- spec/active_interaction/active_model_spec.rb
 - spec/active_interaction/base_spec.rb
-- spec/active_interaction/core_spec.rb
 - spec/active_interaction/errors_spec.rb
 - spec/active_interaction/filter_spec.rb
 - spec/active_interaction/filters/array_filter_spec.rb
@@ -274,10 +272,12 @@ test_files:
 - spec/active_interaction/integration/string_interaction_spec.rb
 - spec/active_interaction/integration/symbol_interaction_spec.rb
 - spec/active_interaction/integration/time_interaction_spec.rb
-- spec/active_interaction/method_missing_spec.rb
-- spec/active_interaction/overload_hash_spec.rb
+- spec/active_interaction/modules/active_model_spec.rb
+- spec/active_interaction/modules/core_spec.rb
+- spec/active_interaction/modules/method_missing_spec.rb
+- spec/active_interaction/modules/overload_hash_spec.rb
+- spec/active_interaction/modules/validation_spec.rb
 - spec/active_interaction/pipeline_spec.rb
-- spec/active_interaction/validation_spec.rb
 - spec/spec_helper.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb