active_form_objects 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1277569aeb69dcb5cf7505976dbea68d1f6083aaa2df4574e5dc7937890eaff2
-  data.tar.gz: 16f628ba1c7206c8f22b419499dd517f434c0f56720aafc27830da498dca66ee
+  metadata.gz: 8b5ee38f5092d2cb6590e7fb237b5c578e62cef571cb677257304a6c7f72f271
+  data.tar.gz: f6391721dc190de74fdf20e3a7d08a018dbdb6cc96dd460fe5eaf20c0df0836a
 SHA512:
-  metadata.gz: 5dc8b54bc4e427b897d45131d57d2e72014b6f1baf64b48f72d33933ae1b8c537b8d5b94fd4c3e77b73e382f1ef1a1df97310307ccafee99e0263528e52470dc
-  data.tar.gz: 1dde523dcf396183a2b8f946992c0ee9f5ce70fcecc5770eec05b080e0f974d687dfe4794f93bd3bfe59581405e4431594d14a07c29e9b26f8d4db73e84a1cb6
+  metadata.gz: de2a9c8359c493a530c48a37a5db6e226ae6e7c75fdb4833f029c88fd0be2ae09646bb66acc08477a897bc2ee51057685fdb117f8e21c61f1baf9b3d15b70336
+  data.tar.gz: de1dcfd0387febc4f01aa471248d150790039e10349e0f3d57ceec3c4b8e6e96ad80f336b9d56e2fc7e97dca53c70cd4941821676ed21d4058f4954fc6b5ed4d

data/lib/active_form_objects.rb

@@ -1,46 +1,52 @@
 require 'active_model'
 require 'active_support/core_ext/hash/indifferent_access'
 
-
+require_relative 'dsl/debug'
 require_relative 'dsl/relations'
 require_relative 'dsl/attributes'
 require_relative 'dsl/delegates'
 require_relative 'dsl/savings'
 require_relative 'dsl/resource'
-require_relative 'dsl/associates'
 require_relative 'dsl/polymorphs'
+require_relative 'dsl/scopes'
+require_relative 'dsl/hooks'
 
+require_relative 'handlers/base'
 require_relative 'handlers/initializer'
+require_relative 'handlers/debug'
 require_relative 'handlers/inheritance'
 require_relative 'handlers/relations'
 require_relative 'handlers/resource'
 require_relative 'handlers/attributes'
-require_relative 'handlers/associates'
 
 module ActiveFormObjects
   class Base
     include ActiveModel::Model
 
+    include Dsl::Debug
     include Dsl::Resource
     include Dsl::Attributes
     include Dsl::Relations
     include Dsl::Polymorphs
     include Dsl::Delegates
-    include Dsl::Associates
     include Dsl::Savings
+    include Dsl::Scopes
+    include Dsl::Hooks
 
     def self.inherited(subclass)
       Handlers::Inheritance.handle(subclass, self)
     end
 
     def initialize(params, resource = nil)
+      raise ActiveFormObjects::HandlerError, "[#{self.class.name}] params were not correclty declared" unless params.is_a?(Hash)
+
       @params = params.with_indifferent_access
       @resource = resource
 
       Handlers::Initializer.handle(self)
-      Handlers::Associates.handle(self)
       Handlers::Resource.handle(self)
       Handlers::Attributes.handle(self)
+      Handlers::Debug.handle(self)
       super(@params)
     end
   end

data/lib/dsl/attributes.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
+require_relative 'errors'
 
 module Dsl
   module Attributes
@@ -22,11 +23,15 @@ module Dsl
       attr_accessor :params
 
       def self.attributes(*params)
+        raise ActiveFormObjects::DslError.new("[#{self.name}] attributes must not be empty") if params.empty?
+
         @@attributes[name] = (@@attributes[name] || []) + params
         attr_accessor(*params)
       end
 
       def self.set_default(params)
+        raise ActiveFormObjects::DslError.new("[#{self.name}] set_default must be declared like { value: 'the default', to: :the_attribute }") if params[:to].nil? || params[:value].nil?
+
         [params[:to]].flatten.each do |param|
           @@default_params[name] ||= {}
           @@default_params[name][param] = params[:value]
@@ -42,10 +47,12 @@ module Dsl
       end
 
       def self.prepare(*params)
-        method_to_call = params.last[:with]
+        raise ActiveFormObjects::DslError.new("[#{self.name}] prepare takes a lambda as second argument, not a #{params.last.class.name}") if !params.last.respond_to?(:call)
+
+        lambda_to_call = params.last
         @@preparers[name] = (@@preparers[name] || []) + [{
           key: params.first,
-          method_to_call: method_to_call
+          lambda: lambda_to_call
         }]
       end
     end

data/lib/dsl/debug.rb

@@ -0,0 +1,14 @@
+require 'active_support'
+
+module Dsl
+  module Debug
+    extend ActiveSupport::Concern
+
+    @@debug = {}
+    included do
+      def self.debug
+        @@debug[name] = true
+      end
+    end
+  end
+end

data/lib/dsl/errors.rb

@@ -0,0 +1,4 @@
+module ActiveFormObjects
+  class DslError < RuntimeError
+  end
+end

data/lib/dsl/hooks.rb

@@ -0,0 +1,29 @@
+require 'active_support'
+require 'active_model'
+
+module Dsl
+  module Hooks
+    extend ActiveSupport::Concern
+
+    @@before_save = {}
+    @@after_save = {}
+    @@after_validation = {}
+
+    class_methods do
+      def before_save(*params, &block)
+        hooks = block.present? ? [block] : params
+        @@before_save[name] = (@@before_save[name] || []) + hooks
+      end
+
+      def after_save(*params, &block)
+        hooks = block.present? ? [block] : params
+        @@after_save[name] = (@@after_save[name] || []) + hooks
+      end
+
+      def after_validation(*params, &block)
+        hooks = block.present? ? [block] : params
+        @@after_validation[name] = (@@after_validation[name] || []) + hooks
+      end
+    end
+  end
+end

data/lib/dsl/resource.rb

@@ -8,8 +8,10 @@ module Dsl
 
     included do
       attr_reader :resource
-      
+
       def self.resource(resource = nil, &block)
+        raise ActiveFormObjects::DslError.new("[#{self.name}] resource has been incorrectly declared") if (resource.nil? && block.nil?) || (block.nil? && !resource.respond_to?(:all))
+
         bloc_to_call = block || proc { resource }
         @@resource[name] = bloc_to_call
       end

data/lib/dsl/scopes.rb

@@ -0,0 +1,33 @@
+require 'active_support'
+require 'rubygems'
+require 'method_source'
+require 'ruby2ruby'
+require 'ruby_parser'
+
+module Dsl
+  module Scopes
+    extend ActiveSupport::Concern
+
+    @@scopes = {}
+
+    included do
+      def self.scope(*params, &block)
+        raise(ActiveFormObjects::DslError, "[#{name}] scope must be a bloc") if block.nil? || !block.respond_to?(:call)
+
+        params.each do |param|
+          block_content = Ruby2Ruby.new.process(RubyParser.new.process(block.source).to_a.last)
+          eval("class ::#{name}Scope#{param.capitalize} < #{name} ; #{block_content}; end")
+        end
+      end
+
+      def self.new(params, resource = nil, options = {})
+        if options[:scope].present?
+          class_to_call = "::#{name}Scope#{options[:scope].capitalize}".constantize rescue raise(ActiveFormObjects::DslError, "[#{name}] No scope named #{options[:scope]} found")
+          return class_to_call.new(params, resource)
+        end
+
+        super(params, resource)
+      end
+    end
+  end
+end

data/lib/handlers/attributes.rb

@@ -23,7 +23,7 @@ module Handlers
     # DSL method : prepare
     def affect_prepared_values!
       (upper(:@@preparers) || []).each do |preparer|
-        @params[preparer[:key]] = @params[preparer[:key]].try(preparer[:method_to_call])
+        @params[preparer[:key]] = preparer[:lambda].try(:call, @params[preparer[:key]])
       end
     end
 

data/lib/handlers/base.rb

@@ -16,12 +16,12 @@ module Handlers
     end
 
     def raise_error(string)
-      raise ActiveFormObjects::Error.new("[#{@klass.class.name}] #{string}")
+      raise ActiveFormObjects::HandlerError.new("[#{@klass.class.name}] #{string}")
     end
   end
 end
 
 module ActiveFormObjects
-  class Error < RuntimeError
+  class HandlerError < RuntimeError
   end
 end

data/lib/handlers/debug.rb

@@ -0,0 +1,24 @@
+require_relative 'base'
+
+module Handlers
+  class Debug < Base
+    def handle
+      return unless upper(:@@debug)
+      @output = []
+
+      build_output
+    end
+
+    def build_output
+      puts "\n==== ActiveFormObjects Debugger #{@klass.class.name} ===="
+      puts "\n👉   Called with\n #{@klass.class.name}.new(#{@raw_params}, #{@resource || 'nil'})"
+
+      if upper(:@@resource).nil? && @resource.nil?
+        puts "\n👉   No resource has been declared or given, calling save! will most likely fail."
+      elsif !@resource.nil?
+        puts "\n👉   The resource is a #{@resource.class.name}"
+      end
+      puts " @resource.update!(#{@params})\n\n"
+    end
+  end
+end

data/lib/handlers/delegates.rb

@@ -28,8 +28,18 @@ module Handlers
         @foreign_key => @resource.id
       })
 
+      proceed_debug
+
       @form.new(@attributes, @resource.send(@relation)).save!
       @resource.reload
     end
+
+    def proceed_debug
+      return unless upper(:@@debug)
+
+      puts '👉   Processing delegate' 
+      puts "#{@form}.new(#{@attributes}, #{@resource.send(@relation) || "nil"}).save!"
+      puts ""
+    end
   end
 end

data/lib/handlers/hooks.rb

@@ -0,0 +1,42 @@
+require_relative 'base'
+
+module Handlers
+  class BeforeSaveHooks < Base
+    def handle
+      handle_hooks('before_save')
+    end
+
+    def handle_hooks(hook_name)
+      (upper("@@#{hook_name}") || []).each do |method_or_block|
+        handle_single(method_or_block)
+      end
+    end
+
+    def handle_single(method_or_block)
+      raise_error('a hook seems to be nil') if method_or_block.nil?
+
+      method_or_block.respond_to?(:call) ? handle_block(method_or_block) : handle_method(method_or_block)
+    end
+
+    def handle_block(block)
+      @klass.instance_eval(&block)
+    end
+
+    def handle_method(method)
+      raise_error("could not find hook method named #{method}") unless @klass.respond_to?(method)
+      @klass.send(method)
+    end
+  end
+
+  class AfterSaveHooks < BeforeSaveHooks
+    def handle
+      handle_hooks('after_save')
+    end
+  end
+
+  class AfterValidationsHooks < BeforeSaveHooks
+    def handle
+      handle_hooks('after_validation')
+    end
+  end
+end

data/lib/handlers/relations.rb

@@ -5,7 +5,11 @@ module Handlers
     def affect_relation_values!
       relation_keys = upper(:@@relation_keys) || {}
       {}.merge(@params).each_key do |key|
-        @params["#{key}_id"] = @params[key].id if relation_keys.include?(key.to_sym)
+        if relation_keys.include?(key.to_sym)
+          raise_error("relation named :#{key} must be an ActiveRecord instance not a #{@params[key].class}. Check the params you sent to this form.") unless @params[key].respond_to?(:id)
+
+          @params["#{key}_id"] = @params[key].id
+        end
       end
     end
   end

data/lib/handlers/savings.rb

@@ -4,15 +4,15 @@ require 'active_record'
 require_relative 'base'
 require_relative 'polymorphs'
 require_relative 'delegates'
-require_relative 'associates'
+require_relative 'hooks'
 
 module Handlers
   class Savings < Base
     def save!(&block)
       ActiveRecord::Base.transaction do
-        return save_associated_forms! unless upper('@@associated_forms').nil?
-        @klass.validate!
         before_save_hooks!
+        @klass.validate!
+        after_validations_hooks!
         block ? save_with_block!(block) : save_without_block!
         after_save_hooks!
         @resource
@@ -22,8 +22,13 @@ module Handlers
       raise ActiveRecord::RecordInvalid.new(e.record)
     end
 
+    def before_save_hooks!
+      BeforeSaveHooks.handle(@klass)
+    end
+
     def after_save_hooks!
       Delegates.handle(@klass)
+      AfterSaveHooks.handle(@klass)
     end
 
     def save_with_block!(block)
@@ -36,12 +41,9 @@ module Handlers
       @resource.update!(@params)
     end
 
-    def before_save_hooks!
+    def after_validations_hooks!
+      AfterValidationsHooks.handle(@klass)
       Polymorphs.handle(@klass)
     end
-
-    def save_associated_forms!
-      Associates.new(@klass).save_associated_forms!
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_form_objects
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Michaël Villeneuve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: ruby2ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 description: Clean up your controller, slim up your models, handle more use cases
 email: contact@michaelvilleneuve.fr
 executables: []
@@ -59,17 +87,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/active_form_objects.rb
-- lib/dsl/associates.rb
 - lib/dsl/attributes.rb
+- lib/dsl/debug.rb
 - lib/dsl/delegates.rb
+- lib/dsl/errors.rb
+- lib/dsl/hooks.rb
 - lib/dsl/polymorphs.rb
 - lib/dsl/relations.rb
 - lib/dsl/resource.rb
 - lib/dsl/savings.rb
-- lib/handlers/associates.rb
+- lib/dsl/scopes.rb
 - lib/handlers/attributes.rb
 - lib/handlers/base.rb
+- lib/handlers/debug.rb
 - lib/handlers/delegates.rb
+- lib/handlers/hooks.rb
 - lib/handlers/inheritance.rb
 - lib/handlers/initializer.rb
 - lib/handlers/polymorphs.rb

data/lib/dsl/associates.rb

@@ -1,18 +0,0 @@
-require 'active_support'
-
-module Dsl
-  module Associates
-    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
-    end
-  end
-end

data/lib/handlers/associates.rb

@@ -1,23 +0,0 @@
-require 'active_support/core_ext/hash/reverse_merge'
-require_relative 'base'
-
-module Handlers
-  class Associates < Base
-    def handle
-      (upper('@@associated_forms') || []).each do |form|
-        @klass.instance_variable_set("@#{form[:name]}_form", form[:form])
-      end
-    end
-
-    def save_associated_forms!
-      (upper('@@associated_forms') || []).each do |associated|
-        params = associated[:params].nil? ? @params[associated[:name]] : @klass.send(associated[:params])
-        resource_to_save = @klass.send("#{associated[:name]}_to_update") rescue nil
-        the_form = associated[:form]
-
-        saved_form = the_form.new(params, resource_to_save).save!
-        @klass.instance_variable_set("@#{associated[:name]}", saved_form)
-      end
-    end
-  end
-end