formstar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38aeef2c7afb9fd595c206197dccbee112de434a90eb9e248ea00ad904aed3c7
+  data.tar.gz: 4c32f1b301bc866674cbf5e72a7fe2b22846e5ab40e71c0d39e63e048b55e74d
+SHA512:
+  metadata.gz: bf3e731b37d9f73a377d7c62a85058526b43d3f9f0769833e9d9fd7ad043aeb95f2098a088c2c227f6ff8e8b84e52847ce4f4c83aeb43942736962ce68d3df3f
+  data.tar.gz: 3e0e00422dcdbbfe41b9aa64117c728abcac3c23e7c049d850e1790f380af6ee3f9bb6d9093b2f62c70237dfbe416527299e3c4d9352ebb36582aa94690958ce

data/lib/formstar/base.rb

@@ -0,0 +1,243 @@
+require "after_commit_everywhere"
+require "active_model"
+require "active_support"
+
+module Formstar
+  class Base
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Validations::Callbacks
+    include AfterCommitEverywhere
+
+    class NoModelError < StandardError; end
+
+    define_model_callbacks :initialize, only: [:after]
+    define_model_callbacks :save, only: [:after]
+    define_model_callbacks :commit, only: [:after]
+
+    attr_reader :form_succeeded
+    attr_reader :form_submitted
+
+    validate :validate_form_model, -> { form_model_defined? && !form_model.nil? }
+
+    def initialize(...)
+      raise NotImplementedError.new("`#{self.class.name}` is abstract and cannot be instantiated directly.") if ["Formstar::Base", "ApplicationForm"].include?(self.class.name)
+
+      @form_succeeded = nil
+      @form_submitted = false
+
+      run_callbacks(:initialize) do
+        super(...)
+      end
+    end
+
+    def submit
+      raise NotImplementedError
+    end
+
+    def succeeded?
+      @form_succeeded
+    end
+
+    def submitted?
+      @form_submitted
+    end
+
+    def form_attributes
+      return @form_attributes unless @form_attributes.nil?
+
+      @form_attributes = {}
+      self.class.form_attribute_names.each do |attr_name|
+        @form_attributes[attr_name] = send(attr_name)
+      end
+
+      @form_attributes
+    end
+
+    def save(**opts)
+      save!(**opts)
+    rescue
+      false
+    end
+
+    def save!(**opts)
+      @form_submitted = true
+      validate!(context: opts[:context]) unless opts[:validate] == false
+
+      perform_submit = -> do
+        run_callbacks(:save) do
+          submit
+        end
+      end
+
+      if self.class.config[:submit_within_transaction_enabled]
+        ActiveRecord::Base.transaction do
+          perform_submit.call
+        end
+      else
+        perform_submit.call
+      end
+
+      after_commit { run_callbacks(:commit) }
+
+      @form_succeeded = true
+    rescue => e
+      @form_succeeded = false
+      raise e
+    end
+
+    def model
+      raise NoModelError.new unless form_model_defined?
+      self.form_model
+    end
+
+    def model=(new_model)
+      raise NoModelError.new unless form_model_defined?
+      self.form_model = new_model
+    end
+
+    private
+
+    def form_model
+      return nil unless form_model_defined?
+      send(form_model_name)
+    end
+
+    def form_model=(new_model)
+      return nil unless form_model_defined?
+      send("#{form_model_name}=".to_sym, new_model)
+    end
+
+    def validate_form_model
+      promote_form_model_errors(form_model) if form_model&.invalid?
+    end
+
+    def promote_form_model_errors(form_model)
+      form_model.errors.each do |e|
+        errors.add(e.attribute, e.type, message: e.message)
+      end
+    end
+
+    def form_model_name
+      @form_model_name ||= self.class.config[:model].fetch(:name, nil)&.to_sym
+    end
+
+    def form_model_defined?
+      @model_defined ||= !self.class.config[:model].nil? #&&
+    end
+
+    def config
+      self.class.config
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      if form_model_defined? && name.to_sym != self.class.config[:model][:name]
+        form_model.respond_to?(name, include_private)
+      else
+        super
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if form_model_defined? && method.to_sym != self.class.config[:model][:name]
+        form_model.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    class << self
+
+      attr_reader :config
+      attr_reader :form_attribute_names
+
+      def inherited(subclass)
+        subclass.instance_variable_set(:@config, self.config.dup)
+      end
+
+      def config
+        @config ||= {
+          model_translation_fallback_enabled: true,
+          model_translation_fallback_class_name: nil,
+          submit_within_transaction_enabled: true,
+          model: nil
+        }
+      end
+
+      def model_translation_fallback(enabled, class_name: nil)
+        config[:model_translation_fallback_enabled] = enabled
+        config[:model_translation_fallback_class_name] = class_name&.safe_constantize
+      end
+
+      def submit_within_transaction(enabled)
+        config[:submit_within_transaction_enabled] = enabled
+      end
+
+      def attr_form(name, ...)
+        form_attribute_names.add(name.to_sym)
+        attribute(name, ...)
+      end
+
+      def with_model(name, class_name: name)
+        name = name.to_sym
+        class_name = class_name.to_s.classify
+        klass = Object.const_get(class_name)
+
+        # Don't accept models that are modules.
+        raise ArgumentError.new("Expected an ActiveRecord model, got `#{class_name}`") unless klass < ActiveRecord::Base
+
+        config[:model] = { name: name, klass: klass }
+      end
+
+      def model_name
+        return @model_name unless @model_name.nil?
+
+        if config[:model]
+          @model_name = ActiveModel::Name.new(config[:model][:klass])
+          @model_name.i18n_key = self.name.underscore
+        else
+          @model_name = ActiveModel::Name.new(self)
+        end
+
+        @model_name
+      end
+
+      def form_attribute_names
+        @form_attribute_names ||= Set.new
+      end
+
+      def i18n_scope
+        :form
+      end
+
+      def human_attribute_name(attribute, options = {})
+        # Base errors for a form will never fall back to the underlying model.
+        # So we can safely always delegate the translation lookup back to active model
+        # which will build up the correct lookup paths.
+        return attribute if attribute.to_sym == :base
+
+        I18n.t!("#{i18n_scope}.attributes.#{model_name.i18n_key}.#{attribute}")
+      rescue I18n::MissingTranslationData => e
+        fallback_value = nil
+
+        if config[:model_translation_fallback_enabled]
+          if config[:model]
+            form_model_klass = config[:model][:klass]
+          else
+            form_model_klass = nil
+          end
+
+          fallback_klass = config[:model_translation_fallback_class_name] || form_model_klass
+          fallback_value = fallback_klass.human_attribute_name(attribute, options) if fallback_klass
+        end
+
+        if fallback_value
+          fallback_value
+        else
+          raise e
+        end
+      end
+    end
+
+  end
+end

data/lib/formstar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Formstar
+  VERSION = "0.1.0"
+end

data/lib/formstar.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'formstar/base'
+require 'generators/formstar/install/install_generator'

data/lib/generators/formstar/install/install_generator.rb

@@ -0,0 +1,14 @@
+require "rails/generators"
+
+module Formstar
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_application_enum
+        template "app/forms/application_form.rb", "app/forms/application_form.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/formstar/install/templates/app/forms/application_form.rb

@@ -0,0 +1,4 @@
+class ApplicationForm < Formstar::Base
+  model_translation_fallback true
+  submit_within_transaction true
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: formstar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bevan Holborn
+bindir: bin
+cert_chain: []
+date: 2025-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: after_commit_everywhere
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: ActiveModel backed Form objects for Ruby on Rails applications
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/formstar.rb
+- lib/formstar/base.rb
+- lib/formstar/version.rb
+- lib/generators/formstar/install/install_generator.rb
+- lib/generators/formstar/install/templates/app/forms/application_form.rb
+homepage: https://rubygems.org/gems/formstar
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://gitlab.com/BevanHolborn/formstar
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: ActiveModel backed Form objects for Ruby on Rails applications
+test_files: []