formalist 0.3.0 → 0.4.0

data/lib/formalist/rich_text/rendering/html_renderer.rb

@@ -0,0 +1,186 @@
+module Formalist
+  module RichText
+    module Rendering
+      class HTMLRenderer
+        # A DraftJS HTML renderer must have the following rendering methods implemented:
+        #  1. inline
+        #  2. block
+        #  3. entity
+        #  4. wrapper
+        #  5. nodes
+
+        # block and entity must iterate over the children and yield each of the children back to the compiler
+
+        BLOCK_ELEMENTS_MAP = {
+          "header-one" => "h1",
+          "header-two" => "h2",
+          "header-three" => "h3",
+          "header-four" => "h4",
+          "header-five" => "h5",
+          "header-six" => "h6",
+          "unordered-list-item" => "li",
+          "ordered-list-item" => "li",
+          "blockquote" => "blockquote",
+          "pullquote" => "aside",
+          "code-block" => "pre",
+          "horizontal-rule" => "hr",
+        }.freeze
+
+        DEFAULT_BLOCK_ELEMENT = "p".freeze
+
+        INLINE_ELEMENTS_MAP = {
+          "bold" => "strong",
+          "italic" => "em",
+          "strikethrough" => "del",
+          "code" => "code",
+          "underline" => "u",
+        }
+
+        DEFAULT_INLINE_ELEMENT = "span".freeze
+
+        def initialize(options = {})
+          @options = options
+        end
+
+        # Defines how to handle a list of nodes
+        def nodes(nodes)
+          nodes = nodes.map { |node| yield(node) } if block_given?
+          nodes.join
+        end
+
+        # Defines how to handle a block node
+        def block(type, key, children)
+          rendered_children = children.map { |child| yield(child) }
+
+          if type == 'atomic'
+            block_atomic(key, rendered_children)
+          else
+            render_block_element(type, rendered_children)
+          end
+        end
+
+         # Defines how to handle a list of blocks with a list type
+        def wrapper(type, children)
+          type_for_method = type.gsub("-", "_")
+
+          rendered_children = children.map { |child| yield(child) }
+
+          send(:"wrapper_#{type_for_method}", rendered_children)
+        end
+
+        def inline(styles, content)
+          return content if styles.nil? || styles.empty?
+          out = content
+          styles.each do |style|
+            out = render_inline_element(style, out)
+          end
+          out
+        end
+
+        def entity(type, key, data, children)
+          rendered_children = children.map { |child| yield(child) }
+
+          handler = :"entity_#{type.downcase}"
+          if respond_to?(handler, _include_private=true)
+            send(handler, data, rendered_children)
+          else
+            rendered_children
+          end
+        end
+
+        private
+
+        def block_atomic(key, children)
+          children.join
+        end
+
+        def wrapper_unordered_list_item(children)
+          html_tag(:ul) do
+            children.join
+          end
+        end
+
+        def wrapper_ordered_list_item(children)
+          html_tag(:ol) do
+            children.join
+          end
+        end
+
+        def entity_link(data, children)
+          link_attrs = {
+            href: data[:url]
+          }
+          link_attrs = link_attrs.merge(
+            target: "_blank",
+            rel: "noopener"
+          ) if data[:newWindow]
+          html_tag(:a, link_attrs) do
+            children.join
+          end
+        end
+
+        def entity_image(data, children)
+          html_tag(:img, src: data[:src])
+        end
+
+        def entity_video(data, children)
+           html_tag(:video, src: data[:src])
+        end
+
+        def entity_default(attrs, children)
+          html_tag(:div, attrs) do
+            children.join
+          end
+        end
+
+        def render_block_element(type, content)
+          elem = BLOCK_ELEMENTS_MAP.fetch(type.downcase, DEFAULT_BLOCK_ELEMENT)
+
+          html_tag(elem) do
+            if content.is_a?(Array)
+              content.join
+            else
+              content
+            end
+          end
+        end
+
+        def render_inline_element(type, content)
+          elem = INLINE_ELEMENTS_MAP.fetch(type.downcase, DEFAULT_INLINE_ELEMENT)
+
+          html_tag(elem, class: "inline--#{type.downcase}") do
+            if content.is_a?(Array)
+              content.join
+            else
+              content
+            end
+          end
+        end
+
+        def html_tag(tag, options = {})
+          options_string = html_options_string(options)
+          out = "<#{tag} #{options_string}".strip
+
+          content = block_given? ? yield : ""
+
+          if content.nil? || content.empty?
+            out << "/>"
+          else
+            out << ">#{replace_soft_newlines(content)}</#{tag}>"
+          end
+        end
+
+        def html_options_string(options)
+          opts = options.map do |key, val|
+            "#{key}='#{val}'"
+          end
+          opts.join(" ")
+        end
+
+        def replace_soft_newlines(content)
+          content.gsub(/\n/, '<br/>')
+        end
+      end
+    end
+  end
+end

data/lib/formalist/rich_text/validity_check.rb

@@ -0,0 +1,48 @@
+require "formalist/form/validity_check"
+
+module Formalist
+  module RichText
+    class ValidityCheck
+      AST = Struct.new(:ast)
+
+      def call(ast)
+        forms = ast.map { |node| visit(node) }.flatten
+
+        form_validity_check = Form::ValidityCheck.new
+        forms.all? { |form_ast| form_validity_check.(form_ast.ast) }
+      end
+      alias_method :[], :call
+
+      private
+
+      def visit(node)
+        name, nodes = node
+
+        handler = :"visit_#{name}"
+
+        if respond_to?(handler, true)
+          send(handler, nodes)
+        else
+          []
+        end
+      end
+
+      # We need to visit blocks in order to get to the formalist entities nested within them
+      def visit_block(node)
+        type, id, children = node
+
+        children.map { |child| visit(child) }
+      end
+
+      def visit_entity(node)
+        type, key, mutability, entity_data, children = node
+
+        if type == "formalist"
+          [AST.new(entity_data["form"])]
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/formalist/types.rb

@@ -1,7 +1,8 @@
-require "dry-types"
-require "dry-logic"
+# coding: utf-8
+require "dry/types"
 
-Dry::Types::Predicates.predicate :respond_to? do |method_name, value|
+# TODO: Find a way to avoid registering this globally
+Dry::Logic::Predicates.predicate :respond_to? do |method_name, value|
   value.respond_to?(method_name)
 end
 
@@ -9,8 +10,8 @@ module Formalist
   module Types
     include Dry::Types.module
 
-    ElementName = Types::Strict::Symbol.constrained(min_size: 1)
-    OptionsList = Types::Array.member(Formalist::Types::Array.member(Formalist::Types::Strict::String).constrained(size: 2)).constrained(min_size: 1)
+    ElementName = Types::Strict::Symbol.constrained(min_size: 1).optional
+    OptionsList = Types::Array.of(Formalist::Types::Array.of(Formalist::Types::Strict::String).constrained(size: 2))
 
     # The SelectionField and MultiSelectionField require a _somewhat_ specific
     # data structure:
@@ -20,11 +21,11 @@ module Formalist
     # It’s expected that `id` is the relational representation of the object.
     # And label could/should be optional if the form defines a custom
     # `render_as` attribute
-    SelectionsList = Formalist::Types::Strict::Array.member(Formalist::Types::Strict::Hash)
+    SelectionsList = Formalist::Types::Strict::Array.of(Formalist::Types::Strict::Hash)
 
     Validation = Types::Strict::Hash
 
-    Dependency = Dry::Types::Definition[Object].new(Object)
+    Dependency = Types::Object
     Function = Dependency.constrained(respond_to: :call)
   end
 end

data/lib/formalist/version.rb

@@ -1,3 +1,3 @@
 module Formalist
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: formalist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: dry-container
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: inflecto
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -143,17 +157,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/console
+- formalist.gemspec
 - lib/formalist.rb
+- lib/formalist/definition.rb
 - lib/formalist/element.rb
 - lib/formalist/element/attributes.rb
 - lib/formalist/element/class_interface.rb
-- lib/formalist/element/definition.rb
-- lib/formalist/element/permitted_children.rb
 - lib/formalist/elements.rb
 - lib/formalist/elements/attr.rb
 - lib/formalist/elements/compound_field.rb
@@ -170,22 +189,27 @@ files:
 - lib/formalist/elements/standard/multi_upload_field.rb
 - lib/formalist/elements/standard/number_field.rb
 - lib/formalist/elements/standard/radio_buttons.rb
+- lib/formalist/elements/standard/rich_text_area.rb
+- lib/formalist/elements/standard/search_multi_selection_field.rb
+- lib/formalist/elements/standard/search_selection_field.rb
 - lib/formalist/elements/standard/select_box.rb
 - lib/formalist/elements/standard/selection_field.rb
+- lib/formalist/elements/standard/tags_field.rb
 - lib/formalist/elements/standard/text_area.rb
 - lib/formalist/elements/standard/text_field.rb
 - lib/formalist/elements/standard/upload_field.rb
 - lib/formalist/form.rb
-- lib/formalist/form/definition_context.rb
-- lib/formalist/form/result.rb
+- lib/formalist/form/validity_check.rb
+- lib/formalist/rich_text/embedded_form_compiler.rb
+- lib/formalist/rich_text/embedded_forms_container.rb
+- lib/formalist/rich_text/embedded_forms_container/mixin.rb
+- lib/formalist/rich_text/embedded_forms_container/registration.rb
+- lib/formalist/rich_text/rendering/embedded_form_renderer.rb
+- lib/formalist/rich_text/rendering/html_compiler.rb
+- lib/formalist/rich_text/rendering/html_renderer.rb
+- lib/formalist/rich_text/validity_check.rb
 - lib/formalist/types.rb
 - lib/formalist/version.rb
-- spec/examples.txt
-- spec/integration/dependency_injection_spec.rb
-- spec/integration/form_spec.rb
-- spec/spec_helper.rb
-- spec/support/constants.rb
-- spec/unit/elements/standard/check_box_spec.rb
 homepage: https://github.com/icelab/formalist
 licenses:
 - MIT
@@ -198,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -206,9 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Flexible form builder
 test_files: []
-has_rdoc: 

data/Gemfile.lock

@@ -1,105 +0,0 @@
-GIT
-  remote: https://github.com/dryrb/dry-types
-  revision: 56eba433b066c5f8839e5a81cddc7c955056a71e
-  branch: master
-  specs:
-    dry-types (0.7.1)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1)
-      dry-container (~> 0.3)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.2, >= 0.2.0)
-      inflecto (~> 0.0.0, >= 0.0.2)
-      kleisli (~> 0.2)
-
-GIT
-  remote: https://github.com/dryrb/dry-validation
-  revision: 2f2ab25b871dde41d4c0f2b259f0c09989f4176b
-  branch: master
-  specs:
-    dry-validation (0.7.4)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-      dry-container (~> 0.2, >= 0.2.8)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.2, >= 0.2.2)
-      dry-types (~> 0.7, >= 0.7.1)
-
-PATH
-  remote: .
-  specs:
-    formalist (0.3.0)
-      dry-configurable
-      dry-container
-      dry-types
-      inflecto
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (8.2.4)
-    codeclimate-test-reporter (0.5.0)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    dry-auto_inject (0.2.0)
-    dry-configurable (0.1.4)
-      concurrent-ruby (~> 1.0)
-    dry-container (0.3.1)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-equalizer (0.2.0)
-    dry-logic (0.2.2)
-      dry-container (~> 0.2, >= 0.2.6)
-      dry-equalizer (~> 0.2)
-    inflecto (0.0.2)
-    json (1.8.3)
-    kleisli (0.2.7)
-    method_source (0.8.2)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    yard (0.8.7.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.10)
-  byebug
-  codeclimate-test-reporter
-  dry-auto_inject
-  dry-types!
-  dry-validation!
-  formalist!
-  pry
-  rake (~> 10.4.2)
-  rspec (~> 3.3.0)
-  simplecov (~> 0.10.0)
-  yard
-
-BUNDLED WITH
-   1.10.6

data/lib/formalist/element/definition.rb

@@ -1,55 +0,0 @@
-require "formalist/types"
-
-module Formalist
-  class Element
-    class Definition
-      Deferred = Struct.new(:name)
-
-      attr_reader :type
-      attr_reader :args
-      attr_reader :attributes
-      attr_reader :children
-
-      def initialize(type, *args, attributes, children)
-        @type = type
-        @args = args
-        @attributes = attributes
-        @children = children
-      end
-
-      def ==(other)
-        # Require a matching type.
-        return false if type != other.type
-
-        # If there are no primary args, it means that the element has no real
-        # "identifier" that requires uniqueness, so it's safe to say they don't
-        # match here.
-        return false if args.empty?
-
-        # Otherwise, use the primary args as a marker of a definitions
-        # uniqueness. With the current set of base form elements, the primary
-        # args only ever contains a name, so this is effectively a uniqueness
-        # check on the element's name.
-        args == other.args
-      end
-
-      def resolve(scope)
-        resolved_args = args.map { |arg|
-          arg.is_a?(Deferred) ? scope.send(arg.name) : arg
-        }
-
-        resolved_attributes = attributes.each_with_object({}) { |(key, val), hsh|
-          hsh[key] = val.is_a?(Deferred) ? scope.send(val.name) : val
-        }
-
-        resolved_children = children.map { |c| c.resolve(scope) }
-
-        self.class.new(type, *resolved_args, resolved_attributes, resolved_children)
-      end
-
-      def call(input, messages)
-        type.new(*args, attributes, children, input, messages)
-      end
-    end
-  end
-end

data/lib/formalist/element/permitted_children.rb

@@ -1,46 +0,0 @@
-require "inflecto"
-
-module Formalist
-  class Element
-    class PermittedChildren
-      All = Class.new do
-        def permitted?(*)
-          true
-        end
-      end.new
-
-      None = Class.new do
-        def permitted?(*)
-          false
-        end
-      end.new
-
-      class Some
-        attr_reader :permitted_children
-
-        def initialize(children)
-          @permitted_children = children
-        end
-
-        def permitted?(child)
-          permitted_children.any? { |permitted_child|
-            permitted_child_class = Elements.const_get(Inflecto.camelize(permitted_child))
-            child.ancestors.include?(permitted_child_class)
-          }
-        end
-      end
-
-      def self.all
-        All
-      end
-
-      def self.none
-        None
-      end
-
-      def self.[](children)
-        Some.new(children)
-      end
-    end
-  end
-end