formwandler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1819221ed8cfcaee304d259ef15aa55aaf708048
+  data.tar.gz: 797085a3cd7806da1f9440b9a6d145648bdf840c
+SHA512:
+  metadata.gz: 0f51d5d47fc62c67637c824993fde8045e763f652ca0394eadd8b93292c1073d7bca93661e39cb2ce0818bbc8c4c226e45012a46687c103ad337b1b3b136ac27
+  data.tar.gz: d79738347d59093d801c57e56a69db4784a6cac20e0af155f2e91be8f796bc1ff1c58bfdddc8924b112d4093f9239e09d0acb705c604887c05bbd1fe01a5ab2a

data/lib/formwandler.rb

@@ -0,0 +1 @@
+require_relative 'formwandler/form'

data/lib/formwandler/field.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Formwandler
+  class Field
+    attr_reader :form, :field_definition
+
+    delegate :name, :model, :source, to: :field_definition
+
+    def initialize(form:, field_definition:)
+      @form = form
+      @field_definition = field_definition
+    end
+
+    def hidden?
+      if field_definition.hidden.respond_to?(:call)
+        form.instance_exec(&field_definition.hidden)
+      else
+        field_definition.hidden
+      end
+    end
+
+    def visible?
+      !hidden?
+    end
+
+    def disabled?
+      if field_definition.disabled.respond_to?(:call)
+        form.instance_exec(&field_definition.disabled)
+      else
+        field_definition.disabled
+      end
+    end
+
+    def options
+      all_options - hidden_options
+    end
+
+    def default?
+      !field_definition.default.nil?
+    end
+
+    def default
+      if field_definition.default.respond_to?(:call)
+        form.instance_exec(&field_definition.default)
+      else
+        field_definition.default
+      end
+    end
+
+    def delocalize
+      if field_definition.delocalize.respond_to?(:call)
+        form.instance_exec(&field_definition.delocalize)
+      else
+        field_definition.delocalize
+      end
+    end
+
+    private
+
+    def all_options
+      _evaluate_field_definition_value(:options) || options_from_model || []
+    end
+
+    def hidden_options
+      field_definition.hidden_options&.reject do |_option, value|
+        _evaluate_value(value)
+      end&.keys || []
+    end
+
+    def options_from_model
+      return unless model_instance.present? && model_instance.is_a?(ActiveRecord::Base)
+      return unless enum_field?
+      model_instance.class.public_send(name.to_s.pluralize).keys
+    end
+
+    def enum_field?
+      model_instance.class.attribute_types[name.to_s].is_a?(ActiveRecord::Enum::EnumType)
+    end
+
+    def model_instance
+      form.models[field_definition.model]
+    end
+
+    def _evaluate_field_definition_value(attr_name)
+      value = field_definition.send(attr_name)
+      _evaluate_value(value)
+    end
+
+    def _evaluate_value(value)
+      if value.respond_to?(:call)
+        form.instance_exec(&value)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/formwandler/field_definition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Formwandler
+  class FieldDefinition
+    attr_reader :name, :hidden, :disabled, :default, :delocalize, :model, :source, :options
+
+    def initialize(name, hidden: false, disabled: false, default: nil, delocalize: nil, model: nil, source: nil, options: nil)
+      @name = name
+      @hidden = hidden
+      @disabled = disabled
+      @default = default
+      @delocalize = delocalize
+      @model = model
+      @source = source || name
+      @options = options
+    end
+
+    def hide_option(name, value = true)
+      hidden_options[name.to_sym] = value
+    end
+
+    def hidden_options
+      @hidden_options ||= {}
+    end
+  end
+end

data/lib/formwandler/form.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative 'field_definition'
+require_relative 'field'
+
+module Formwandler
+  class Form
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+
+    class << self
+      def model_name
+        ActiveModel::Name.new(self, nil, name.chomp('Form').underscore)
+      end
+
+      def field_definitions
+        @field_definitions ||= {}
+      end
+
+      def field(name, opts = {})
+        field_definitions[name] = FieldDefinition.new(name, opts)
+
+        yield(field_definitions[name]) if block_given?
+
+        if field_definitions[name].model.present?
+          attribute_accessor(name, field_definitions[name])
+        else
+          attr_accessor name
+        end
+      end
+
+      def attribute_accessor(name, field_definition)
+        define_method "#{name}=" do |value|
+          models[field_definition.model].send("#{field_definition.source}=", value)
+        end
+
+        define_method name do
+          models[field_definition.model].send(field_definition.source)
+        end
+      end
+
+      def save_order(*model_names)
+        @model_save_order = model_names
+      end
+
+      attr_reader :model_save_order
+    end
+
+    attr_reader :fields, :models, :current_user
+
+    def initialize(models: {}, current_user: nil)
+      @models = models.symbolize_keys
+      @current_user = current_user
+
+      initialize_fields
+      initialize_models
+      assign_defaults
+    end
+
+    def persisted?
+      models.values.first&.persisted? || false
+    end
+
+    def to_param
+      models.values.first.to_param
+    end
+
+    def field(name)
+      fields.fetch(name)
+    end
+
+    def fields_for_model(model)
+      fields.values.select { |field| field.model == model }
+    end
+
+    def models_valid?
+      all_valid = true
+      models.each do |name, model|
+        all_valid = false if model.invalid?
+        fields_for_model(name).each do |field|
+          model.errors[field.source].each do |error_message|
+            errors.add(field.name, error_message)
+          end
+        end
+      end
+      all_valid
+    end
+
+    def submit(params)
+      assign_attributes permitted_params(params)
+
+      if valid? && models_valid?
+        save_models!
+        load_results
+      else
+        false
+      end
+    end
+
+    protected
+
+    def initialize_models
+    end
+
+    def assign_defaults
+      fields.values.each do |field|
+        next unless field.default?
+        send("#{field.name}=", field.default) if send(field.name).nil?
+      end
+    end
+
+    def save_models!
+      models.sort_by do |(name, _model)|
+        self.class.model_save_order.index(name) || self.class.model_save_order.size
+      end.map(&:last).compact.each(&:save!)
+    end
+
+    def load_results
+      true
+    end
+
+    def permitted_params(params)
+      visible_fields = fields.values.reject(&:hidden?).map(&:name)
+      delocalizations = fields.transform_values(&:delocalize).compact
+      params = ActionController::Parameters.new(params) if params.is_a?(Hash)
+      params.require(model_name.param_key).permit(*visible_fields).delocalize(delocalizations)
+    end
+
+    private
+
+    def initialize_fields
+      @fields = self.class.field_definitions.transform_values do |field_definition|
+        Field.new(form: self, field_definition: field_definition)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: formwandler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Bilharz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create form objects for multiple models, dynamically mark fields as hidden
+  or disabled and even hide select options dynamically
+email: sbilharz@heilmannsoftware.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/formwandler.rb
+- lib/formwandler/field.rb
+- lib/formwandler/field_definition.rb
+- lib/formwandler/form.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Form objects for rails
+test_files: []