subroutine 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 7416fb00f0a0322ec831337e3afaf019d21cc83f4573afa13e8485a64ffb8e7c
-  data.tar.gz: 0d40d5a0843b57c35e046ecfcaedcbf4471386ec64a01577723c8717d98ebdc1
+SHA1:
+  metadata.gz: 7a1e060b5a23f95d926f8df63e2eb9fc12745a93
+  data.tar.gz: 1205b94faff4d024aa9670cbd0cee003ea3bff5f
 SHA512:
-  metadata.gz: 449ff84a202510087c5ab59a6f1809d1b59a1ec77f7e496fb37a6d93369bd5f1a1589fb102bc739763f3c1f3a74614558bb2c70d2ba17448f7df3398a2b1b498
-  data.tar.gz: 6e779574462dc657ce38422a094c556bcf36171698f8c02e165ce850e8aef0e79a7030e1c614332965efc4399c1fc7f8cbd33dc7570d7c92b8e8b5bb562f36a1
+  metadata.gz: c3313881107db6835f530a41b17f0702f407a2c83413cd7705c00ef4b02017b54566037ad464231651e04948a8416ad4fc02c6939e36d2ac814383fb542829ba
+  data.tar.gz: 75a5d2fe57b634ff5d4e84e105621c769679f065bc1f72c49b835b988972c39fe2d041fbda7f8c8ff99e3c51d79df51ab01ce63299a3b46d88e2a39096d73f2f

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.4.6

data/.travis.yml

@@ -2,12 +2,19 @@ language: ruby
 sudo: false
 
 rvm:
-  - 2.0.0
-  - 2.1.1
-  - 2.2.3
-  - 2.5.1
-  - jruby
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 
 gemfile:
   - gemfiles/am41.gemfile
   - gemfiles/am42.gemfile
+  - gemfiles/am50.gemfile
+  - gemfiles/am51.gemfile
+  - gemfiles/am52.gemfile
+  - gemfiles/am60.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.4.6
+      gemfile: gemfiles/am60.gemfile

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in subroutine.gemspec
 gemspec
 
-gem 'activemodel', '~> 4.2.0'
+gem 'activemodel', '~> 5.2.3'

data/gemfiles/{am32.gemfile → am50.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'activemodel', '~> 3.2.21'
+gem 'activemodel', '~> 5.0.7.2'

data/gemfiles/{am30.gemfile → am51.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'activemodel', '~> 3.0.20'
+gem 'activemodel', '~> 5.1.7'

data/gemfiles/{am31.gemfile → am52.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'activemodel', '~> 3.1.12'
+gem 'activemodel', '~> 5.2.3'

data/gemfiles/{am40.gemfile → am60.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec :path => '../'
 
-gem 'activemodel', '~> 4.0.13'
+gem 'activemodel', '~> 6.0.0.rc1'

data/lib/subroutine/fields.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/object/duplicable"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/object/deep_dup"
+
+require "subroutine/type_caster"
+require "subroutine/association"
+
+module Subroutine
+  module Fields
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_fields
+      self._fields = {}
+      attr_reader :original_params
+      attr_reader :params, :defaults
+    end
+
+    module ClassMethods
+      # fields can be provided in the following way:
+      # field :field1, :field2
+      # field :field3, :field4, default: 'my default'
+      def field(*fields)
+        options = fields.extract_options!
+
+        fields.each do |f|
+          _field(f, options)
+        end
+      end
+      alias_method :fields, :field
+
+      def inputs_from(*things)
+        options = things.extract_options!
+        excepts = options.key?(:except) ? Array(options.delete(:except)) : nil
+        onlys = options.key?(:only) ? Array(options.delete(:only)) : nil
+
+        things.each do |thing|
+          thing._fields.each_pair do |field_name, opts|
+            next if excepts && excepts.include?(field_name)
+            next if onlys && !onlys.include?(field_name)
+
+            if opts[:association]
+              include ::Subroutine::Association unless included_modules.include?(::Subroutine::Association)
+              association(field_name, opts)
+            else
+              field(field_name, opts)
+            end
+          end
+        end
+      end
+      alias_method :fields_from, :inputs_from
+
+      def respond_to_missing?(method_name, *args, &block)
+        ::Subroutine::TypeCaster.casters.key?(method_name.to_sym) || super
+      end
+
+      def method_missing(method_name, *args, &block)
+        caster = ::Subroutine::TypeCaster.casters[method_name.to_sym]
+        if caster
+          options = args.extract_options!
+          options[:type] = method_name.to_sym
+          args.push(options)
+          field(*args, &block)
+        else
+          super
+        end
+      end
+
+      protected
+
+      def _field(field_name, options = {})
+        self._fields = _fields.merge(field_name.to_sym => options)
+
+        class_eval <<-EV, __FILE__, __LINE__ + 1
+
+          def #{field_name}=(v)
+            config = #{field_name}_config
+            v = ::Subroutine::TypeCaster.cast(v, config)
+            @params["#{field_name}"] = v
+          end
+
+          def #{field_name}
+            @params.has_key?("#{field_name}") ? @params["#{field_name}"] : @defaults["#{field_name}"]
+          end
+
+          def #{field_name}_config
+            _fields[:#{field_name}]
+          end
+
+        EV
+      end
+    end
+
+    def setup_fields(inputs = {})
+      @original_params = inputs.with_indifferent_access
+      @params = sanitize_params(@original_params)
+      @defaults = sanitize_defaults
+    end
+
+    # check if a specific field was provided
+    def field_provided?(key)
+      @params.key?(key)
+    end
+
+    # if you want to use strong parameters or something in your form object you can do so here.
+    # by default we just slice the inputs to the defined fields
+    def sanitize_params(inputs)
+      out = {}.with_indifferent_access
+      _fields.each_pair do |field, config|
+        next unless inputs.key?(field)
+
+        out[field] = ::Subroutine::TypeCaster.cast(inputs[field], config)
+      end
+
+      out
+    end
+
+    def params_with_defaults
+      @defaults.merge(@params)
+    end
+
+    def sanitize_defaults
+      defaults = {}.with_indifferent_access
+
+      _fields.each_pair do |field, config|
+        next if config[:default].nil?
+
+        deflt = config[:default]
+        if deflt.respond_to?(:call)
+          deflt = deflt.call
+        elsif deflt.duplicable? # from active_support
+          # Some classes of default values need to be duplicated, or the instance field value will end up referencing
+          # the class global default value, and potentially modify it.
+          deflt = deflt.deep_dup # from active_support
+        end
+        defaults[field] = ::Subroutine::TypeCaster.cast(deflt, config)
+      end
+
+      defaults
+    end
+
+  end
+end

data/lib/subroutine/op.rb

@@ -1,50 +1,25 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/object/duplicable'
-require 'active_support/core_ext/object/deep_dup'
-require 'active_model'
+require "active_model"
 
-require 'subroutine/failure'
-require 'subroutine/type_caster'
-require 'subroutine/filtered_errors'
-require 'subroutine/output_not_set_error'
-require 'subroutine/unknown_output_error'
+require "subroutine/fields"
+require "subroutine/failure"
+require "subroutine/filtered_errors"
+require "subroutine/output_not_set_error"
+require "subroutine/unknown_output_error"
 
 module Subroutine
   class Op
+
+    include ::Subroutine::Fields
     include ::ActiveModel::Model
     include ::ActiveModel::Validations::Callbacks
 
     DEFAULT_OUTPUT_OPTIONS = {
-      required: true
+      required: true,
     }.freeze
 
     class << self
-      ::Subroutine::TypeCaster.casters.each_key do |caster|
-        next if method_defined?(caster)
-
-        class_eval <<-EV, __FILE__, __LINE__ + 1
-          def #{caster}(*args)
-            options = args.extract_options!
-            options[:type] = #{caster.inspect}
-            args.push(options)
-            field(*args)
-          end
-        EV
-      end
-
-      # fields can be provided in the following way:
-      # field :field1, :field2
-      # field :field3, :field4, default: 'my default'
-      def field(*fields)
-        options = fields.extract_options!
-
-        fields.each do |f|
-          _field(f, options)
-        end
-      end
-      alias fields field
 
       def outputs(*names)
         options = names.extract_options!
@@ -66,33 +41,6 @@ module Subroutine
       end
       alias ignore_errors ignore_error
 
-      def inputs_from(*ops)
-        options = ops.extract_options!
-        excepts = options.key?(:except) ? Array(options.delete(:except)) : nil
-        onlys = options.key?(:only) ? Array(options.delete(:only)) : nil
-
-        ops.each do |op|
-          op._fields.each_pair do |field_name, op_options|
-            next if excepts && excepts.include?(field_name)
-            next if onlys && !onlys.include?(field_name)
-
-            if op_options[:association]
-              include ::Subroutine::Association unless included_modules.include?(::Subroutine::Association)
-              association(field_name, op_options)
-            else
-              field(field_name, op_options)
-            end
-          end
-        end
-      end
-
-      def inherited(child)
-        super
-        child._fields = _fields.dup
-        child._error_map = _error_map.dup
-        child._error_ignores = _error_ignores.dup
-      end
-
       def submit!(*args)
         op = new(*args)
         op.submit!
@@ -109,59 +57,36 @@ module Subroutine
       protected
 
       def _field(field_name, options = {})
-        _fields[field_name.to_sym] = options
+        result = super(field_name, options)
 
         if options[:aka]
           Array(options[:aka]).each do |as|
-            _error_map[as.to_sym] = field_name.to_sym
+            self._error_map = _error_map.merge(as.to_sym => field_name.to_sym)
           end
         end
 
         _ignore_errors(field_name) if options[:ignore_errors]
 
-        class_eval <<-EV, __FILE__, __LINE__ + 1
-
-          def #{field_name}=(v)
-            config = #{field_name}_config
-            v = ::Subroutine::TypeCaster.cast(v, config)
-            @params["#{field_name}"] = v
-          end
-
-          def #{field_name}
-            @params.has_key?("#{field_name}") ? @params["#{field_name}"] : @defaults["#{field_name}"]
-          end
-
-          def #{field_name}_config
-            _fields[:#{field_name}]
-          end
-
-        EV
+        result
       end
 
       def _ignore_errors(field_name)
-        _error_ignores[field_name.to_sym] = true
+        self._error_ignores = _error_ignores.merge(field_name.to_sym => true)
       end
+
     end
 
     class_attribute :_outputs
     self._outputs = {}
 
-    class_attribute :_fields
-    self._fields = {}
-
     class_attribute :_error_map
     self._error_map = {}
 
     class_attribute :_error_ignores
     self._error_ignores = {}
 
-    attr_reader :original_params
-    attr_reader :params, :defaults
-
     def initialize(inputs = {})
-      @original_params = inputs.with_indifferent_access
-      @params = sanitize_params(@original_params)
-      @defaults = sanitize_defaults
+      setup_fields(inputs)
       @outputs = {}
     end
 
@@ -217,10 +142,6 @@ module Subroutine
       end
     end
 
-    def params_with_defaults
-      @defaults.merge(@params)
-    end
-
     protected
 
     # these enable you to 1) add log output or 2) add performance monitoring such as skylight.
@@ -248,11 +169,6 @@ module Subroutine
       raise NotImplementedError
     end
 
-    # check if a specific field was provided
-    def field_provided?(key)
-      @params.key?(key)
-    end
-
     # applies the errors in error_object to self
     # returns false so failure cases can end with this invocation
     def inherit_errors(error_object)
@@ -273,37 +189,5 @@ module Subroutine
       false
     end
 
-    # if you want to use strong parameters or something in your form object you can do so here.
-    # by default we just slice the inputs to the defined fields
-    def sanitize_params(inputs)
-      out = {}.with_indifferent_access
-      _fields.each_pair do |field, config|
-        next unless inputs.key?(field)
-
-        out[field] = ::Subroutine::TypeCaster.cast(inputs[field], config)
-      end
-
-      out
-    end
-
-    def sanitize_defaults
-      defaults = {}.with_indifferent_access
-
-      _fields.each_pair do |field, config|
-        next if config[:default].nil?
-
-        deflt = config[:default]
-        if deflt.respond_to?(:call)
-          deflt = deflt.call
-        elsif deflt.duplicable? # from active_support
-          # Some classes of default values need to be duplicated, or the instance field value will end up referencing
-          # the class global default value, and potentially modify it.
-          deflt = deflt.deep_dup # from active_support
-        end
-        defaults[field] = ::Subroutine::TypeCaster.cast(deflt, config)
-      end
-
-      defaults
-    end
   end
 end

data/lib/subroutine/version.rb

@@ -2,7 +2,7 @@
 
 module Subroutine
   MAJOR = 0
-  MINOR = 7
+  MINOR = 8
   PATCH = 0
   PRE   = nil
 

data/lib/subroutine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
-require 'subroutine/version'
-require 'subroutine/op'
+require "subroutine/version"
+require "subroutine/fields"
+require "subroutine/op"

data/subroutine.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activemodel", ">= 4.0.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "m"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "mocha"

data/test/subroutine/fields_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "subroutine/fields"
+
+module Subroutine
+  class FieldsTest < TestCase
+
+    class Whatever
+
+      include Subroutine::Fields
+
+      string :foo, default: "foo"
+      integer :bar, default: -> { 3 }
+
+      def initialize(options = {})
+        setup_fields(options)
+      end
+
+    end
+
+    def test_fields_are_configured
+      assert_equal 2, Whatever._fields.size
+      assert_equal :string, Whatever._fields[:foo][:type]
+      assert_equal :integer, Whatever._fields[:bar][:type]
+    end
+
+    def test_field_defaults_are_handled
+      instance = Whatever.new
+      assert_equal "foo", instance.foo
+      assert_equal 3, instance.bar
+    end
+
+    def test_fields_can_be_provided
+      instance = Whatever.new(foo: "abc", bar: nil)
+      assert_equal "abc", instance.foo
+      assert_nil instance.bar
+    end
+
+    def test_field_provided
+      instance = Whatever.new(foo: "abc")
+      assert_equal true, instance.field_provided?(:foo)
+      assert_equal false, instance.field_provided?(:bar)
+    end
+
+    def test_params
+      instance = Whatever.new(foo: "abc")
+      assert_equal({ "foo" => "abc" }, instance.params)
+      assert_equal({ "foo" => "abc", "bar" => 3 }, instance.params_with_defaults)
+      assert_equal({ "foo" => "foo", "bar" => 3 }, instance.defaults)
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subroutine
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mike Nelson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-15 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -28,30 +28,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -109,16 +123,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/am30.gemfile
-- gemfiles/am31.gemfile
-- gemfiles/am32.gemfile
-- gemfiles/am40.gemfile
 - gemfiles/am41.gemfile
 - gemfiles/am42.gemfile
+- gemfiles/am50.gemfile
+- gemfiles/am51.gemfile
+- gemfiles/am52.gemfile
+- gemfiles/am60.gemfile
 - lib/subroutine.rb
 - lib/subroutine/association.rb
 - lib/subroutine/auth.rb
 - lib/subroutine/failure.rb
+- lib/subroutine/fields.rb
 - lib/subroutine/filtered_errors.rb
 - lib/subroutine/op.rb
 - lib/subroutine/output_not_set_error.rb
@@ -129,6 +144,7 @@ files:
 - test/subroutine/association_test.rb
 - test/subroutine/auth_test.rb
 - test/subroutine/base_test.rb
+- test/subroutine/fields_test.rb
 - test/subroutine/type_caster_test.rb
 - test/support/ops.rb
 - test/test_helper.rb
@@ -152,20 +168,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Feature-driven operation objects.
 test_files:
-- gemfiles/am30.gemfile
-- gemfiles/am31.gemfile
-- gemfiles/am32.gemfile
-- gemfiles/am40.gemfile
 - gemfiles/am41.gemfile
 - gemfiles/am42.gemfile
+- gemfiles/am50.gemfile
+- gemfiles/am51.gemfile
+- gemfiles/am52.gemfile
+- gemfiles/am60.gemfile
 - test/subroutine/association_test.rb
 - test/subroutine/auth_test.rb
 - test/subroutine/base_test.rb
+- test/subroutine/fields_test.rb
 - test/subroutine/type_caster_test.rb
 - test/support/ops.rb
 - test/test_helper.rb