fi_form 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e355461d23423b6c38f917a181c47a296cecf16b33108cb95699c1067c361c9a
+  data.tar.gz: abcee254f77abbe066b788ddcdd5cb5c76fe573001b31c155292f17494cbef50
+SHA512:
+  metadata.gz: 58a730b2b834ccf624be68cf8c4318e3cbea8056c35a856f9fc4cfd0e76d2a18b44706b15c9cb39349cffc694ad79e2b165d363b904bf1b3f2d2ea5678baf6a3
+  data.tar.gz: d55eb3e743efcbec8e73ed433b0a6859ffb9267297b1febef077f733d259c3902ad3670168c235aaaabb317e65ba633f3187d7dd7624cf8ce3069dac5069cec0

data/lib/fi_form/builder.rb

@@ -0,0 +1,117 @@
+class FiForm::Builder # PORO \o/
+
+  attr_reader :resource, :form, :options, :indentation
+  attr_accessor :validation_errors
+
+  def initialize(resource, options={}, template, &block)
+    @resource = resource
+    @template = template
+    @options = options.dup
+
+    @validation_errors = {}
+
+    @form = build_form
+    @target = @form
+    @indentation = options[:indentation] || 0
+    @renderer = options.delete(:renderer)
+  end
+
+  alias_method :object, :resource
+
+  def add(kind, options={})
+    @target << build(kind, options)
+    self # allow chaining
+  end
+
+  def group(title=nil, &block)
+    add(:group, title: title, indentation: indentation).add_children do
+      @template.capture(self, &block)
+    end
+  end
+
+  def input(field, options={})
+    input_options = {
+      value: options[:value] || resource_value(field),
+      field: field,
+      label: options[:label],
+    }
+
+    input_options[:hint] = options[:hint] if options[:hint]
+
+    html_options = options.except(:as, :label, :hint, :value)
+    input_options[:input] = html_options if html_options.any?
+
+    add(:input, input_options)
+  end
+
+  def render(*args)
+    content = @template.capture(self) do
+      @template.render *args
+    end
+    add :raw, content: content
+  end
+
+  def hint(hint, options={})
+    add(:hint, options.merge(hint: hint, indentation: indentation))
+  end
+
+  def title(title, options={})
+    add(:title, options.merge(title: title, indentation: indentation))
+  end
+
+  def submit(label=nil, options={})
+    add(:submit, options.merge(label: label, indentation: indentation))
+  end
+
+  def to_html
+    FiForm.configuration.get_renderer(@renderer).new(@template).render(@form)
+  end
+
+  def add_children(indent: true, &block)
+    with_target last_item, indent: indent, &block
+  end
+
+private
+  def resource_value(field)
+  end
+
+  def build(kind, options)
+    FiForm::Item.build(kind, form: @form, **options)
+  end
+
+  def sub_builder(resource, &block)
+    FiForm::Builder.new(resource, @options.merge(indentation: indentation), @template, &block)
+  end
+
+  def last_item
+    @target.last_child
+  end
+
+  def with_target(target_list, indent: true, &block)
+    previous_target = @target
+    @indentation += 1 if indent
+    @target = target_list
+    yield
+    @indentation -= 1 if indent
+    @target = previous_target
+  end
+
+  def capture_target(options={}, &block)
+    indent = !!options.delete(:indent)
+
+    target_list = []
+    with_target(target_list, indent: indent, &block)
+
+    single_target = target_list.first
+    single_target.options.merge! options
+    single_target
+  end
+
+  def build_form
+    FiForm::Item.build(:form,
+      resource: @resource,
+      errors: validation_errors,
+      form_options: @options
+    )
+  end
+end

data/lib/fi_form/builder_extensions/active_record.rb

@@ -0,0 +1,36 @@
+module FiForm::BuilderExtensions
+  module ActiveRecord
+
+    def fields_for(field, options={}, &block)
+      indent = options[:indent]
+      indent = true if indent.nil?
+
+      # build a new record for that association without adding it to the internal collection
+      blue_print = capture_target(indent: indent) do
+        association = @resource.public_send(field)
+        record      = association.klass.new(association.scope_attributes).tap(&:readonly!)
+        builder     = sub_builder(record, &block)
+        instance_exec(builder, &block)
+
+        add(:blue_print, items: builder.form.items)
+      end
+
+      add(:fields_for, field: field, blue_print: blue_print).add_children(indent: indent) do
+        # capture fields for every existing record
+        resource.public_send(field).each do |sub_resource|
+          builder = sub_builder(sub_resource, &block)
+          instance_exec(builder, &block)
+          @target << builder.form
+        end
+      end
+    end
+
+  private
+    def resource_value(field)
+      return unless @resource.respond_to?(field)
+      @resource.public_send(field)
+    end
+
+  end
+
+end

data/lib/fi_form/configuration.rb

@@ -0,0 +1,45 @@
+module FiForm
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :renderers, :default
+
+    def initialize
+      @renderers = {}
+    end
+
+    # Register a renderer. The last added renderer will be the default if not specified
+    def register(options)
+      self.renderers.merge! options
+    end
+
+    # add custom behaviour
+    def add_builder_method(name, &block)
+      FiForm::Builder.define_method name, &block
+    end
+
+    # fetch a renderer. if none is specified, the default or debug renderer will be returned
+    def get_renderer(identifier=nil)
+      identifier ||= default_renderer
+      self.renderers[identifier] || DebugRenderer
+    end
+
+    # reload renderer classes in development
+    def reload!
+      self.renderers = self.renderers.map{|k, klass| [k, klass.to_s.constantize] }.to_h
+    end
+
+  protected
+    def default_renderer
+      @default || self.renderers.keys.last
+    end
+  end
+
+end

data/lib/fi_form/debug_renderer.rb

@@ -0,0 +1,11 @@
+module FiForm
+
+  class DebugRenderer < Renderer
+    def render(form)
+      template.content_tag :pre do
+        JSON.pretty_generate form.as_json
+      end
+    end
+  end
+
+end

data/lib/fi_form/item.rb

@@ -0,0 +1,80 @@
+class FiForm::Item < Struct.new(:kind, :options)
+
+  class Input < FiForm::Item
+    def initialize(*args)
+      super
+      if form.errors.key?(self.field)
+        self.options[:errors] = self.form.errors[self.field]
+      end
+    end
+  end
+
+  class Form < FiForm::Item
+    def as_json(*args)
+      super(except: :resource)
+    end
+  end
+
+  def self.build(kind, options)
+    case kind
+    when :input
+      Input
+    when :form
+      Form
+    else
+      self
+    end.new(kind, options)
+  end
+
+  attr_reader :resource, :form, :field
+  alias_method :object, :resource
+  def initialize(*args)
+    super
+    @form = self.options.delete(:form)
+
+    @resource = if self.options.key? :resource
+      self.options.delete(:resource)
+    else
+      @form.resource
+    end
+  end
+
+  def errors
+    self.options.fetch(:errors)
+  end
+
+  def items
+    self.options&.dig(:items) || []
+  end
+  alias_method :children, :items
+
+  def field
+    self.options.fetch(:field)
+  end
+
+  def value
+    self.options.fetch(:value)
+  end
+
+  def input
+    self.options&.dig(:input)
+  end
+
+  def <<(item)
+    self.options[:items] ||= []
+    self.options[:items] << item
+  end
+
+  def add_items(items)
+    self.options[:items] += items
+  end
+
+  def last_child
+    self.options[:items].last
+  end
+
+  def as_json(*args)
+    super(except: :resource)
+  end
+
+end

data/lib/fi_form/railtie.rb

@@ -0,0 +1,24 @@
+module FiForm
+
+  module ViewHelper
+    def fi_form_for(resource, options={}, &block)
+      builder = FiForm::Builder.new(resource, options, self, &block)
+      builder.validation_errors = resource&.errors&.details
+
+      capture(builder, &block)
+
+      builder.to_html
+    end
+  end
+
+  class Railtie < Rails::Railtie
+    initializer 'fi_form.helper' do |_app|
+      ActionView::Base.send :include, FiForm::ViewHelper
+    end
+
+    config.to_prepare do
+      FiForm.configuration.reload!
+    end if Rails.env.development?
+  end
+
+end

data/lib/fi_form/renderer.rb

@@ -0,0 +1,14 @@
+module FiForm
+
+  class Renderer
+    attr_reader :template
+    def initialize(template)
+      @template = template
+    end
+
+    def render(*args)
+      warn "Please Override render method"
+    end
+  end
+
+end

data/lib/fi_form/setup.rb

@@ -0,0 +1,5 @@
+FiForm.configure do |config|
+  config.register debug: FiForm::DebugRenderer
+
+  #config.register foundation5: FiForm::Foundation5
+end

data/lib/fi_form/version.rb

@@ -0,0 +1,3 @@
+module FiForm
+  VERSION = '0.0.2'
+end

data/lib/fi_form.rb

@@ -0,0 +1,22 @@
+require 'fi_form/version'
+require 'fi_form/configuration'
+
+require 'fi_form/renderer'
+require 'fi_form/debug_renderer'
+require 'fi_form/builder'
+require 'fi_form/item'
+
+require 'fi_form/setup'
+
+module FiForm
+end
+
+require 'fi_form/railtie' if defined?(Rails)
+
+
+# load extensions
+if Gem.loaded_specs['activerecord']
+  require 'active_record'
+  require 'fi_form/builder_extensions/active_record'
+  FiForm::Builder.prepend FiForm::BuilderExtensions::ActiveRecord
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: fi_form
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexander Pauly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !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: awesome_print
+  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: byebug
+  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: wwtd
+  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: single_cov
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: 
+email: alex.pauly+git@posteo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fi_form.rb
+- lib/fi_form/builder.rb
+- lib/fi_form/builder_extensions/active_record.rb
+- lib/fi_form/configuration.rb
+- lib/fi_form/debug_renderer.rb
+- lib/fi_form/item.rb
+- lib/fi_form/railtie.rb
+- lib/fi_form/renderer.rb
+- lib/fi_form/setup.rb
+- lib/fi_form/version.rb
+homepage: https://github.com/apauly/fi_form
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Frontend Independant Forms.
+test_files: []