formed 1.0.0

data/lib/formed/relation/delegation.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Formed
+  class Relation
+    module Delegation # :nodoc:
+      class << self
+        def delegated_classes
+          [
+            Formed::Relation,
+            Formed::Associations::CollectionProxy,
+            Formed::AssociationRelation
+          ]
+        end
+
+        def uncacheable_methods
+          @uncacheable_methods ||= (
+            delegated_classes.flat_map(&:public_instance_methods) - Formed::Relation.public_instance_methods
+          ).to_set.freeze
+        end
+      end
+
+      module DelegateCache # :nodoc:
+        def relation_delegate_class(klass)
+          @relation_delegate_cache[klass]
+        end
+
+        def initialize_relation_delegate_cache
+          @relation_delegate_cache = cache = {}
+          Delegation.delegated_classes.each do |klass|
+            delegate = Class.new(klass) do
+              include ClassSpecificRelation
+            end
+            include_relation_methods(delegate)
+            mangled_name = klass.name.gsub("::", "_")
+            const_set mangled_name, delegate
+            private_constant mangled_name
+
+            cache[klass] = delegate
+          end
+        end
+
+        def inherited(child_class)
+          child_class.initialize_relation_delegate_cache
+          super
+        end
+
+        def generate_relation_method(method)
+          generated_relation_methods.generate_method(method)
+        end
+
+        protected
+
+        def include_relation_methods(delegate)
+          superclass.include_relation_methods(delegate) unless base_class?
+          delegate.include generated_relation_methods
+        end
+
+        private
+
+        def generated_relation_methods
+          @generated_relation_methods ||= GeneratedRelationMethods.new.tap do |mod|
+            const_set(:GeneratedRelationMethods, mod)
+            private_constant :GeneratedRelationMethods
+          end
+        end
+      end
+
+      class GeneratedRelationMethods < Module # :nodoc:
+        include Mutex_m
+
+        def generate_method(method)
+          synchronize do
+            return if method_defined?(method)
+
+            if /\A[a-zA-Z_]\w*[!?]?\z/.match?(method) && !DELEGATION_RESERVED_METHOD_NAMES.include?(method.to_s)
+              module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{method}(...)
+                scoping { klass.#{method}(...) }
+              end
+              RUBY
+            else
+              define_method(method) do |*args, &block|
+                scoping { klass.public_send(method, *args, &block) }
+              end
+              ruby2_keywords(method)
+            end
+          end
+        end
+      end
+      private_constant :GeneratedRelationMethods
+
+      extend ActiveSupport::Concern
+
+      # This module creates compiled delegation methods dynamically at runtime, which makes
+      # subsequent calls to that method faster by avoiding method_missing. The delegations
+      # may vary depending on the klass of a relation, so we create a subclass of Relation
+      # for each different klass, and the delegations are compiled into that subclass only.
+
+      delegate :to_xml, :encode_with, :length, :each, :join, :intersects?,
+               :[], :&, :|, :+, :-, :sample, :reverse, :rotate, :compact, :in_groups, :in_groups_of,
+               :to_sentence, :to_fs, :to_formatted_s, :as_json,
+               :shuffle, :split, :slice, :index, :rindex, to: :records
+
+      delegate :primary_key, :connection, to: :klass
+
+      module ClassSpecificRelation # :nodoc:
+        extend ActiveSupport::Concern
+
+        module ClassMethods # :nodoc:
+          def name
+            superclass.name
+          end
+        end
+
+        private
+
+        def method_missing(method, *args, &block)
+          if @klass.respond_to?(method)
+            @klass.generate_relation_method(method) unless Delegation.uncacheable_methods.include?(method)
+            scoping { @klass.public_send(method, *args, &block) }
+          else
+            super
+          end
+        end
+        ruby2_keywords(:method_missing)
+      end
+
+      module ClassMethods # :nodoc:
+        def create(klass, *args, **kwargs)
+          relation_class_for(klass).new(klass, *args, **kwargs)
+        end
+
+        private
+
+        def relation_class_for(klass)
+          klass.relation_delegate_class(self)
+        end
+      end
+
+      private
+
+      def respond_to_missing?(method, _)
+        super || @klass.respond_to?(method)
+      end
+    end
+  end
+end

data/lib/formed/relation.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Formed
+  class Relation
+    include Enumerable
+
+    attr_reader :klass, :loaded
+    attr_accessor :skip_preloading_value
+    alias model klass
+    alias loaded? loaded
+
+    include Delegation
+
+    def initialize(klass, values: {})
+      @klass  = klass
+      @values = values
+      @loaded = true
+      @delegate_to_klass = false
+      @future_result = nil
+      @records = nil
+    end
+
+    def initialize_copy(_other)
+      @values = @values.dup
+      reset
+    end
+
+    # Initializes new record from relation while maintaining the current
+    # scope.
+    #
+    # Expects arguments in the same format as {ActiveRecord::Base.new}[rdoc-ref:Core.new].
+    #
+    #   users = User.where(name: 'DHH')
+    #   user = users.new # => #<User id: nil, name: "DHH", created_at: nil, updated_at: nil>
+    #
+    # You can also pass a block to new with the new record as argument:
+    #
+    #   user = users.new { |user| user.name = 'Oscar' }
+    #   user.name # => Oscar
+    def new(attributes = nil, &block)
+      if attributes.is_a?(Array)
+        attributes.collect { |attr| new(attr, &block) }
+      else
+        block = current_scope_restoring_block(&block)
+        scoping { _new(attributes, &block) }
+      end
+    end
+    alias build new
+
+    # Converts relation objects to Array.
+    def to_ary
+      records.dup
+    end
+    alias to_a to_ary
+
+    def records # :nodoc:
+      @records
+    end
+
+    # Serializes the relation objects Array.
+    def encode_with(coder)
+      coder.represent_seq(nil, records)
+    end
+
+    # Returns size of the records.
+    def size
+      if loaded?
+        records.length
+      else
+        count(:all)
+      end
+    end
+
+    # Returns true if there are no records.
+    def empty?
+      if loaded?
+        records.empty?
+      else
+        !exists?
+      end
+    end
+
+    # Returns true if there are no records.
+    def none?
+      return super if block_given?
+
+      empty?
+    end
+
+    # Returns true if there are any records.
+    def any?
+      return super if block_given?
+
+      !empty?
+    end
+
+    # Returns true if there is exactly one record.
+    def one?
+      return super if block_given?
+      return records.one? if loaded?
+
+      limited_count == 1
+    end
+
+    # Returns true if there is more than one record.
+    def many?
+      return super if block_given?
+      return records.many? if loaded?
+
+      limited_count > 1
+    end
+  end
+end

data/lib/formed/version.rb

@@ -0,0 +1,3 @@
+module Formed
+  VERSION = "1.0.0"
+end

data/lib/generators/active_form/form_generator.rb

@@ -0,0 +1,72 @@
+require 'rails/generators'
+
+module Formed
+  module Generators # :nodoc:
+    class FormGenerator < Rails::Generators::NamedBase # :nodoc:
+      source_root File.join(__dir__, "templates")
+
+      argument :attributes, type: :array, default: [], banner: "field[:type] field[:type]"
+      class_option :model, type: :string, desc: "The model name for the generated form"
+      class_option :parent, type: :string, default: "ApplicationForm", desc: "The parent class for the generated form"
+
+      def create_model_file
+        generate_abstract_class if !custom_parent?
+
+        template "form.rb", File.join("app/forms", class_path, "#{file_name}.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+
+        template "module.rb", File.join("app/forms", "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def create_rspec_file
+        return unless Rails.application.config.generators.test_framework == :rspec
+
+        template 'form_spec.rb',  File.join("spec/forms", class_path, "#{file_name}_spec.rb")
+      end
+
+      def file_name
+        name = super
+        unless name.end_with?("_form")
+          name += "_form"
+        end
+        name
+      end
+
+      def class_name
+        name = super
+        unless name.end_with?("Form")
+          name += "Form"
+        end
+        name
+      end
+
+      private
+
+      def parent_class_name
+        parent
+      end
+
+      def generate_abstract_class
+        path = File.join("app/forms", "application_form.rb")
+        return if File.exist?(path)
+
+        template "abstract_base_class.rb", path
+      end
+
+      def abstract_class_name
+        "ApplicationForm"
+      end
+
+      def parent
+        options[:parent]
+      end
+
+      def custom_parent?
+        parent != self.class.class_options[:parent].default
+      end
+    end
+  end
+end

data/lib/generators/active_form/templates/form.rb.tt

@@ -0,0 +1,8 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.each do |attribute| -%>
+  attribute :<%= attribute.name %>, :<%= attribute.type %>
+<% end -%>
+<%= attributes.inspect %>
+end
+<% end -%>

data/lib/generators/active_form/templates/form_spec.rb.tt

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+describe <%= class_name %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/active_form/templates/module.rb.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join("::") %>
+end
+<% end -%>

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: formed
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josh
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: factory_bot_rails
+  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: pry
+  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: pry-rails
+  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-rails
+  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: simplecov
+  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: sqlite3
+  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: timecop
+  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'
+description: A form object that really wants to be a form object.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/active_form.rb
+- lib/formed/acts_like_model.rb
+- lib/formed/association_relation.rb
+- lib/formed/associations.rb
+- lib/formed/associations/association.rb
+- lib/formed/associations/builder.rb
+- lib/formed/associations/builder/association.rb
+- lib/formed/associations/builder/collection_association.rb
+- lib/formed/associations/builder/has_many.rb
+- lib/formed/associations/builder/has_one.rb
+- lib/formed/associations/builder/singular_association.rb
+- lib/formed/associations/collection_association.rb
+- lib/formed/associations/collection_proxy.rb
+- lib/formed/associations/foreign_association.rb
+- lib/formed/associations/has_many_association.rb
+- lib/formed/associations/has_one_association.rb
+- lib/formed/associations/singular_association.rb
+- lib/formed/attributes.rb
+- lib/formed/base.rb
+- lib/formed/core.rb
+- lib/formed/from_model.rb
+- lib/formed/from_params.rb
+- lib/formed/inheritance.rb
+- lib/formed/nested_attributes.rb
+- lib/formed/reflection.rb
+- lib/formed/relation.rb
+- lib/formed/relation/delegation.rb
+- lib/formed/version.rb
+- lib/generators/active_form/form_generator.rb
+- lib/generators/active_form/templates/form.rb.tt
+- lib/generators/active_form/templates/form_spec.rb.tt
+- lib/generators/active_form/templates/module.rb.tt
+homepage: https://github.com/joshmn/formed
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: A form object that really wants to be a form object.
+test_files: []