active_form_objects 0.1.2 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daff81f1e757efcd09b602052b01108e5975ec4afdbc23eb990d9fd4fad28067
-  data.tar.gz: bd751ee1875ac9ff54e70d107106cbc041e499dedd9bb8b44147c0f902ea44eb
+  metadata.gz: '03871811ee607637a50a7c85d85985dea846a563709f4d1b803aa681589e5517'
+  data.tar.gz: d6fb754563a486d09e99cb09dc183dc276d83f0d1ab9b8a11c83003a8920340e
 SHA512:
-  metadata.gz: 23909b529fe45a1de257f237698b6be281d1ef4d8ec8d7f09a588783ced45552e4373ca185e6787a23f3be2552a3a8c3b08477b14daef69dc8082ebd1e026a60
-  data.tar.gz: 3ed88b54b54be83db842ebb37565eecfe194bc12c970b01b26871ef0d95c0364705ea6b01e376ea6d584fb6877025c34ad6143e23902dc3cb6fb8c9c63ae80e7
+  metadata.gz: f041ee7728861ab7112f9202284bb1d133c877fe42def63e9ba437efb2ebc87efb8ffab77f5a7d519001eba7639c51b03b87371e5c35d5586bde821dc7a18ce4
+  data.tar.gz: 362e0149393a0fd88f129e4169e16c3f037ec506610de8469fe6d33a5478f540c7fda66da8aafebe8be0981f17a200c58a011c94f0d695925ec1a5ff565bf194

data/lib/active_form_objects.rb

@@ -1,97 +1,36 @@
-require 'active_support'
 require 'active_model'
-require 'active_support/core_ext/object/instance_variables'
-require 'active_support/core_ext/hash/indifferent_access'
-require_relative 'concerns/relations'
-require_relative 'concerns/savings'
+
+require_relative 'dsl/relations'
+require_relative 'dsl/attributes'
+require_relative 'dsl/delegates'
+require_relative 'dsl/savings'
+require_relative 'dsl/resource'
+require_relative 'dsl/polymorphs'
+
+require_relative 'handlers/initializer'
+require_relative 'handlers/relations'
+require_relative 'handlers/resource'
+require_relative 'handlers/attributes'
 
 module ActiveFormObjects
   class Base
     include ActiveModel::Model
-    include Relations
-    include Savings
-
-    @@authorized_params = {}
-    @@overrided_params = {}
-    @@default_params = {}
-    @@preparers = {}
-    @@resource = {}
-
-    attr_reader :resource
-
-    def self.resource(resource = nil, &block)
-      bloc_to_call = block || proc { resource }
-      @@resource[name] = bloc_to_call
-    end
-
-    def self.prepare(*params)
-      method_to_call = params.last[:with]
-      @@preparers[name] = (@@preparers[name] || []) + [{
-        key: params.first,
-        method_to_call: method_to_call
-      }]
-    end
-
-    def self.attributes(*params)
-      @@authorized_params[name] = (@@authorized_params[name] || []) + params
-      send(:attr_accessor, *params)
-    end
-
-    def self.delegate(*params)
-      delegator = params.last
-      params.pop
-      send(:attributes, *params)
-      define_method("#{delegator[:to]}_params") do
-        attrs_only(params)
-      end
-    end
 
-    def self.set_default(params)
-      [params[:to]].flatten.each do |param|
-        @@default_params[name] ||= {}
-        @@default_params[name][param] = params[:value]
-      end
-      send(:attributes, *params[:to])
-    end
-
-    def self.ensure_value(param, value)
-      @@overrided_params[name] ||= {}
-      @@overrided_params[name][param] = value
-
-      send(:attributes, param)
-    end
+    include Dsl::Resource
+    include Dsl::Attributes
+    include Dsl::Relations
+    include Dsl::Polymorphs
+    include Dsl::Delegates
+    include Dsl::Savings
 
     def initialize(params, resource = nil)
-      @resource = resource || @@resource[self.class.name].try(:call, params).try(:new)
-      set_associated_forms
-      params = affect_relation_values(params)
-      resource_params(params || {})
-
-      params_with_resource_attrs = @resource.respond_to?(:attributes) ? @resource.attributes.symbolize_keys.slice(*@authorized_params).merge(@params) : @params
-      params_with_preprared_value = affect_prepared_values(params_with_resource_attrs)
-      super(params_with_preprared_value)
-    end
-
-    def affect_prepared_values(params)
-      (@@preparers[self.class.name] || []).each do |preparer|
-        params[preparer[:key]] = params[preparer[:key]].try(preparer[:method_to_call])
-      end
-      params
-    end
-
-    def resource_params(params)
-      @default_params = @@default_params[self.class.name] || {}
-      @overrided_params = @@overrided_params[self.class.name] || {}
-      @authorized_params = @@authorized_params[self.class.name] || {}
-      @params = @default_params.merge(params.to_h.symbolize_keys).merge(@overrided_params).slice(*@authorized_params)
-    end
-
-    def attrs_only(params)
-      attributes.slice(*params)
-    end
+      @params = params
+      @resource = resource
 
-    def attributes
-      instance_values.with_indifferent_access.symbolize_keys
+      Handlers::Initializer.handle(self)
+      Handlers::Resource.handle(self)
+      Handlers::Attributes.handle(self)
+      super(@params)
     end
   end
 end

data/lib/dsl/attributes.rb

@@ -0,0 +1,44 @@
+require 'active_support'
+
+module Dsl
+  module Attributes
+    extend ActiveSupport::Concern
+
+    @@attributes = {}
+    @@overrided_params = {}
+    @@default_params = {}
+    @@preparers = {}
+
+    included do
+      attr_accessor :params
+
+      def self.attributes(*params)
+        @@attributes[name] = (@@attributes[name] || []) + params
+        attr_accessor(*params)
+      end
+
+      def self.set_default(params)
+        [params[:to]].flatten.each do |param|
+          @@default_params[name] ||= {}
+          @@default_params[name][param] = params[:value]
+        end
+        send(:attributes, *params[:to])
+      end
+
+      def self.ensure_value(param, value)
+        @@overrided_params[name] ||= {}
+        @@overrided_params[name][param] = value
+
+        send(:attributes, param)
+      end
+
+      def self.prepare(*params)
+        method_to_call = params.last[:with]
+        @@preparers[name] = (@@preparers[name] || []) + [{
+          key: params.first,
+          method_to_call: method_to_call
+        }]
+      end
+    end
+  end
+end

data/lib/dsl/delegates.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+
+module Dsl
+  module Delegates
+    extend ActiveSupport::Concern
+
+    @@delegators = {}
+
+    included do
+      def self.delegate(*params)
+        delegator = params.last[:to].merge(attributes: params)
+        params.pop
+
+        @@delegators[name] = (@@delegators[name] || []) << delegator
+      end
+    end
+  end
+end

data/lib/dsl/polymorphs.rb

@@ -0,0 +1,35 @@
+require 'active_support'
+require 'active_model'
+
+module Dsl
+  module Polymorphs
+    extend ActiveSupport::Concern
+
+    @@polymorphic_keys = {}
+
+    class_methods do
+      # Allows to declare a polymorphic relationship
+      #
+      # Params:
+      # +key+:: the corresponding key in the params hash
+      # +possible_types+:: A hash that follows the below format
+      #
+      # polymorph(:content, :program_id, {
+      #   foo: Bar
+      # })
+      #
+      # Int the above example the possible_types hash :
+      #   scannable => key
+      #   Scannable => model class
+      #
+      def polymorph(key, possible_types)
+        @@polymorphic_keys[name] ||= []
+        @@polymorphic_keys[name] << {
+          key: key,
+          types: possible_types
+        }
+        send(:attributes, key)
+      end
+    end
+  end
+end

data/lib/dsl/relations.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'active_model'
+
+module Dsl
+  module Relations
+    extend ActiveSupport::Concern
+
+    @@relation_keys = {}
+
+    class RelationValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, _)
+        record.errors.add(attribute, "#{attribute} or #{attribute}_id is required") unless record.try(attribute).present? || record.try("#{attribute}_id".to_sym).present?
+      end
+    end
+
+    class_methods do
+      # Allows to receive a relation as an input params.
+      # Relation can then be received either as :
+      #   - relation_id => The key to the corresponding relation
+      #   - relation    => An instance of the object
+      #
+      # Params:
+      # +params+:: the list of relations to declare
+      #
+      # Example :
+      #   relations(:entity, :user)
+      #
+      def relations(*params)
+        validates(*params, relation: true)
+
+        params.each do |param|
+          relation_key = "#{param}_id".to_sym
+          send(:attributes, param, relation_key)
+          @@relation_keys[name] = (@@relation_keys[name] || []) + [param]
+        end
+      end
+    end
+  end
+end

data/lib/dsl/resource.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+
+module Dsl
+  module Resource
+    extend ActiveSupport::Concern
+
+    @@resource = {}
+
+    included do
+      attr_reader :resource
+      
+      def self.resource(resource = nil, &block)
+        bloc_to_call = block || proc { resource }
+        @@resource[name] = bloc_to_call
+      end
+    end
+  end
+end

data/lib/dsl/savings.rb

@@ -0,0 +1,27 @@
+require 'active_support'
+require 'active_record'
+require_relative '../handlers/savings'
+
+module Dsl
+  module Savings
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def save(&block)
+        define_method(:save!) do
+          Handlers::Savings.new(self).save!(&block)
+        end
+      end
+    end
+
+    def save!
+      Handlers::Savings.new(self).save!
+    end
+
+    def save
+      save!
+    rescue
+      false
+    end
+  end
+end

data/lib/handlers/attributes.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/hash/reverse_merge'
+require_relative 'base'
+require_relative 'relations'
+require_relative 'delegates'
+
+module Handlers
+  class Attributes < Base
+    def handle
+      start_with_default_params!
+      affect_prepared_values!
+      merge_with_resource_attributes!
+      affect_relation_values!
+      merge_overrided_params!
+      slice_unauthorized_attributes!
+    end
+
+    # DSL method : set_default
+    def start_with_default_params!
+      default_params = upper(:@@default_params) || {}
+      @params.reverse_merge!(default_params)
+    end
+
+    # DSL method : prepare
+    def affect_prepared_values!
+      (upper(:@@preparers) || []).each do |preparer|
+        @params[preparer[:key]] = @params[preparer[:key]].try(preparer[:method_to_call])
+      end
+    end
+
+    def merge_with_resource_attributes!
+      return unless @resource.respond_to?(:attributes)
+      @params.reverse_merge!(@resource.attributes.symbolize_keys)
+    end
+
+    # DSL method : ensure_value
+    def merge_overrided_params!
+      overrided_params = upper(:@@overrided_params) || {}
+      @params.merge!(overrided_params)
+    end
+
+    # DSL method : relation
+    def affect_relation_values!
+      Relations.new(@klass).affect_relation_values!
+    end
+
+    # DSL method : attributes
+    def slice_unauthorized_attributes!
+      authorized_attributes = upper(:@@attributes) || {}
+      @params.slice!(*authorized_attributes)
+    end
+  end
+end

data/lib/handlers/base.rb

@@ -0,0 +1,18 @@
+module Handlers
+  class Base
+    def initialize(klass)
+      @klass = klass
+      @raw_params = @klass.instance_variable_get(:@raw_params)
+      @params = @klass.instance_variable_get(:@params)
+      @resource = @klass.instance_variable_get(:@resource)
+    end
+
+    def self.handle(klass)
+      new(klass).handle
+    end
+
+    def upper(var)
+      @klass.class.class_variable_get(var)[@klass.class.name]
+    end
+  end
+end

data/lib/handlers/delegates.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+
+module Handlers
+  class Delegates < Base
+    def handle
+      delegates = upper :@@delegators
+      (delegates || []).each do |delegate|
+        Delegate.new(@klass, delegate).handle
+      end
+    end
+  end
+
+  class Delegate < Base
+    def initialize(klass, delegate)
+      @delegate = delegate
+
+      @form = @delegate[:form]
+      @foreign_key = @delegate[:foreign_key]
+      @relation = @delegate[:relation]
+      @attributes = @delegate[:attributes]
+
+      super(klass)
+    end
+
+    def handle
+      @attributes = @raw_params.slice(*@attributes).merge({
+        @foreign_key => @resource.id
+      })
+
+      @form.new(@attributes, @resource.send(@relation)).save!
+    end
+  end
+end

data/lib/handlers/initializer.rb

@@ -0,0 +1,8 @@
+module Handlers
+  class Initializer
+    def self.handle(klass)
+      params = klass.instance_variable_get(:@params)
+      klass.instance_variable_set('@raw_params', {}.merge(params).freeze)
+    end
+  end
+end

data/lib/handlers/polymorphs.rb

@@ -0,0 +1,53 @@
+require_relative 'base'
+
+module Handlers
+  class Polymorphs < Base
+    def handle
+      polymorphs = upper :@@polymorphic_keys
+      (polymorphs || []).each do |polymorph|
+        Polymorph.new(@klass, polymorph).handle
+      end
+    end
+  end
+
+  class Polymorph < Base
+    # Handle either the retrieving of the associated relation
+    # or
+    # the creation of the resource based on this possible input and the params
+    #
+    # Params:
+    # +klass+:: ActiveFormObject::Base instance
+    # +polymorph+:: The param specified in the dsl, example :
+    #  {
+    #      key: :content,
+    #      foreign_key: :program_id,
+    #      types: {
+    #        polymorph: Dsl::PolymorphsTest::PolymorphForeignForm
+    #      }
+    #    }
+    #
+    def initialize(klass, polymorph)
+      @polymorph = polymorph
+      super(klass)
+    end
+
+    def handle
+      @params_to_send = @params[@polymorph[:key]] || {}
+      polymorph_instance = form_class.new(@params_to_send, @resource.try(@polymorph[:key])).save!
+
+      @params["#{@polymorph[:key]}_id".to_sym] = polymorph_instance.id
+      @params["#{@polymorph[:key]}_type".to_sym] = polymorph_instance.class.name
+      @params.delete(@polymorph[:key])
+    end
+
+    def form_class
+      @polymorph[:types][
+        @resource.try("#{@polymorph[:key]}_type".to_sym) || clean_params.try(:to_sym)
+      ]
+    end
+
+    def clean_params
+      @params_to_send.delete(:type)
+    end
+  end
+end

data/lib/handlers/relations.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module Handlers
+  class Relations < Base
+    def affect_relation_values!
+      relation_keys = upper(:@@relation_keys) || {}
+      {}.merge(@params).each_key do |key|
+        @params["#{key}_id".to_sym] = @params[key.to_sym].id if relation_keys.include?(key)
+      end
+    end
+  end
+end

data/lib/handlers/resource.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module Handlers
+  class Resource < Base
+    def handle
+      class_resource = upper(:@@resource)
+      @resource ||= class_resource.try(:call, @params).try(:new)
+
+      @klass.instance_variable_set(:@resource, @resource)
+    end
+  end
+end

data/lib/handlers/savings.rb

@@ -0,0 +1,42 @@
+require 'active_support'
+require 'active_record'
+
+require_relative 'base'
+require_relative 'polymorphs'
+require_relative 'delegates'
+
+module Handlers
+  class Savings < Base
+    def save!(&block)
+      # ActiveRecord::Base.transaction do
+        @klass.validate!
+
+        before_save_hooks!
+        block ? save_with_block!(block) : save_without_block!
+        after_save_hooks!
+
+        @resource
+      # end
+    rescue ActiveRecord::RecordInvalid => e
+      e.record.errors.add(e.record.class.name, '')
+      raise ActiveRecord::RecordInvalid.new(e.record)
+    end
+
+    def after_save_hooks!
+      Delegates.handle(@klass)
+    end
+
+    def save_with_block!(block)
+      @klass.instance_eval(&block)
+      @resource.try(:save!)
+    end
+
+    def save_without_block!
+      @resource.update!(@params)
+    end
+
+    def before_save_hooks!
+      Polymorphs.handle(@klass)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_form_objects
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Michaël Villeneuve
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -45,8 +59,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/active_form_objects.rb
-- lib/concerns/relations.rb
-- lib/concerns/savings.rb
+- lib/dsl/attributes.rb
+- lib/dsl/delegates.rb
+- lib/dsl/polymorphs.rb
+- lib/dsl/relations.rb
+- lib/dsl/resource.rb
+- lib/dsl/savings.rb
+- lib/handlers/attributes.rb
+- lib/handlers/base.rb
+- lib/handlers/delegates.rb
+- lib/handlers/initializer.rb
+- lib/handlers/polymorphs.rb
+- lib/handlers/relations.rb
+- lib/handlers/resource.rb
+- lib/handlers/savings.rb
 homepage: https://github.com/fidme/active_form_objects
 licenses:
 - MIT
@@ -62,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3

data/lib/concerns/relations.rb

@@ -1,35 +0,0 @@
-require 'active_support'
-require 'active_model'
-
-module Relations
-  extend ActiveSupport::Concern
-
-  @@relation_keys = {}
-
-  class RelationValidator < ActiveModel::EachValidator
-    def validate_each(record, attribute, value)
-      record.errors.add(attribute, "#{attribute} or #{attribute}_id is required") unless record.try(attribute).present? || record.try("#{attribute}_id".to_sym).present?
-    end
-  end
-
-  def affect_relation_values(params)
-    @relation_keys = @@relation_keys[self.class.name] || []
-    params.keys.each do |key|
-      params["#{key}_id".to_sym] = params[key.to_sym].id if @relation_keys.include?(key)
-    end
-
-    params
-  end
-
-  class_methods do
-    def relations(*params)
-      validates *params, relation: true
-
-      params.each do |param|
-        relation_key = "#{param}_id".to_sym
-        send(:attributes, param, relation_key)
-        @@relation_keys[name] = (@@relation_keys[name] || []) + [param]
-      end
-    end
-  end
-end

data/lib/concerns/savings.rb

@@ -1,71 +0,0 @@
-require 'active_support'
-
-module Savings
-  extend ActiveSupport::Concern
-
-  @@associated_forms = {}
-
-  class_methods do
-    def associated(key, form, params = nil)
-      @@associated_forms[name] ||= []
-      @@associated_forms[name] << { name: key, form: form, params: params }
-
-      set_default value: {}, to: key
-    end
-
-    def save(&block)
-      define_method(:save!) do
-        with_rescue do
-          ActiveRecord::Base.transaction do
-            validate!
-            instance_eval(&block)
-            @resource.try(:save!)
-          end
-          @resource
-        end
-      end
-    end
-  end
-
-  def save!
-    with_rescue do
-      if @@associated_forms[self.class.name].nil?
-        validate!
-        @resource.update!(@params)
-        @resource
-      else
-        save_associated_forms!
-      end
-    end
-  end
-
-  def save
-    save!
-  rescue
-    false
-  end
-
-  def save_associated_forms!
-    (@@associated_forms[self.class.name] || []).each do |associated|
-      params = associated[:params].nil? ? @params[associated[:name]] : send(associated[:params])
-      resource_to_save = send("#{associated[:name]}_to_update") rescue nil
-      @TheForm = associated[:form]
-
-      saved_form = @TheForm.new(params, resource_to_save).save!
-      instance_variable_set("@#{associated[:name]}", saved_form)
-    end
-  end
-
-  def set_associated_forms
-    (@@associated_forms[self.class.name] || []).each do |form|
-      instance_variable_set("@#{form[:name]}_form", form[:form])
-    end
-  end
-
-  def with_rescue
-    yield
-  rescue ActiveRecord::RecordInvalid => e
-    e.record.errors.add(e.record.class.name, '')
-    raise ActiveRecord::RecordInvalid.new(e.record)
-  end
-end