formalist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 372c76aa3a3991513336c9b742aa6c5fd3d45b9b
+  data.tar.gz: 44cf4056ec9617c63d2ae9829bbed28013977e2d
+SHA512:
+  metadata.gz: b72e88f632bb792ac8b6356020215968013cfd1b4370f03f5fd78e527c996b71d143ec6470a67be3a2eb1077d5be49ff67bbd4e822ece0a483c20f203c9c49d6
+  data.tar.gz: 5420b73a92b48894ddd9ff798b11c334bd4d728e9281ca16f17b031e22833e122da5d6cac520d59ee9c542a90d35c96cdd55eba2e58a803cba2c7bd50c419a36

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Gem dependencies are specified in formalist.gemspec
+gemspec
+
+group :tools do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    formalist (0.1.0)
+      dry-configurable
+      dry-container
+      dry-data (>= 0.4.2)
+      dry-validation
+      inflecto
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    byebug (8.2.1)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dry-configurable (0.1.2)
+      thread_safe
+    dry-container (0.2.7)
+      dry-configurable (= 0.1.2)
+      thread_safe
+    dry-data (0.4.2)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.2)
+      dry-equalizer (~> 0.2)
+      inflecto (~> 0.0.0, >= 0.0.2)
+      kleisli (~> 0.2)
+      thread_safe (~> 0.3)
+    dry-equalizer (0.2.0)
+    dry-validation (0.4.1)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-data (~> 0.4, >= 0.4.2)
+      dry-equalizer (~> 0.2)
+    inflecto (0.0.2)
+    json (1.8.3)
+    kleisli (0.2.7)
+    method_source (0.8.2)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    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)
+    rubocop (0.34.2)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    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)
+    thread_safe (0.3.5)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  byebug
+  formalist!
+  pry
+  rake (~> 10.4.2)
+  rspec (~> 3.3.0)
+  rubocop (~> 0.34.2)
+  simplecov (~> 0.10.0)
+  yard
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2015-2016 [Icelab](http://icelab.com.au/).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+[travis]: https://travis-ci.org/icelab/formalist
+
+# Formalist
+
+[![Build Status](https://travis-ci.org/icelab/formalist.svg?branch=master)][travis]
+
+## Installation
+
+Add this line to your application’s `Gemfile`:
+
+```ruby
+gem "formalist"
+```
+
+Run `bundle` to install the gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](http://github.com/icelab/formalist).
+
+## Credits
+
+Formalist is developed and maintained by [Icelab](http://icelab.com.au/).
+
+## License
+
+Copyright © 2015-2016 [Icelab](http://icelab.com.au/). Formalist is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: :spec
+# task default: :ci
+
+desc "Run the test suite"
+task ci: %w(rubocop spec)

data/lib/formalist/definition_compiler.rb

@@ -0,0 +1,61 @@
+require "formalist/form/definition/attr"
+require "formalist/form/definition/component"
+require "formalist/form/definition/field"
+require "formalist/form/definition/group"
+require "formalist/form/definition/many"
+require "formalist/form/definition/section"
+
+module Formalist
+  class DefinitionCompiler
+    attr_reader :display_adapters
+
+    def initialize(display_adapters)
+      @display_adapters = display_adapters
+    end
+
+    def call(ast)
+      ast.map { |node| visit(node) }
+    end
+
+    private
+
+    def visit(node)
+      name, attrs = node
+      send(:"visit_#{name}", attrs)
+    end
+
+    def visit_attr(attrs)
+      name, children = attrs
+      Form::Definition::Attr.new(name, call(children))
+    end
+
+    def visit_component(attrs)
+      display, config, children = attrs
+
+      component = Form::Definition::Component.new(config, call(children))
+      display_adapters[display].call(component)
+    end
+
+    def visit_field(attrs)
+      name, type, display, config = attrs
+
+      field = Form::Definition::Field.new(name, type, display, config)
+      display_adapters[display].call(field)
+    end
+
+    def visit_group(attrs)
+      config, children = attrs
+      Form::Definition::Group.new(config, call(children))
+    end
+
+    def visit_many(attrs)
+      name, config, children = attrs
+      Form::Definition::Many.new(name, config, call(children))
+    end
+
+    def visit_section(attrs)
+      name, config, children = attrs
+      Form::Definition::Section.new(name, config, call(children))
+    end
+  end
+end

data/lib/formalist/display_adapters/default.rb

@@ -0,0 +1,9 @@
+module Formalist
+  class DisplayAdapters
+    class Default
+      def call(field)
+        field
+      end
+    end
+  end
+end

data/lib/formalist/display_adapters/radio.rb

@@ -0,0 +1,19 @@
+module Formalist
+  class DisplayAdapters
+    class Radio
+      PERMITTED_TYPES = %w[
+        decimal
+        float
+        int
+        string
+      ].freeze
+
+      def call(field)
+        raise ArgumentError, "field type must be one of #{PERMITTED_TYPES.join(', ')}" unless PERMITTED_TYPES.include?(field.type)
+        raise ArgumentError, "field must have +option_values+ config" unless field.config.keys.include?(:option_values)
+
+        field.to_display_variant("radio")
+      end
+    end
+  end
+end

data/lib/formalist/display_adapters/select.rb

@@ -0,0 +1,19 @@
+module Formalist
+  class DisplayAdapters
+    class Select
+      PERMITTED_TYPES = %w[
+        decimal
+        float
+        int
+        string
+      ].freeze
+
+      def call(field)
+        raise ArgumentError, "field type must be one of #{PERMITTED_TYPES.join(', ')}" unless PERMITTED_TYPES.include?(field.type)
+        raise ArgumentError, "field must have +option_values+ config" unless field.config.keys.include?(:option_values)
+
+        field.to_display_variant("select")
+      end
+    end
+  end
+end

data/lib/formalist/display_adapters.rb

@@ -0,0 +1,12 @@
+require "dry-container"
+require "formalist/display_adapters/default"
+require "formalist/display_adapters/select"
+
+module Formalist
+  class DisplayAdapters
+    extend Dry::Container::Mixin
+
+    register DEFAULT_DISPLAY_ADAPTER, Default.new
+    register "select", Select.new
+  end
+end

data/lib/formalist/form/definition/attr.rb

@@ -0,0 +1,20 @@
+require "formalist/form/result/attr"
+
+module Formalist
+  class Form
+    module Definition
+      class Attr
+        attr_reader :name, :children
+
+        def initialize(name, children)
+          @name = name
+          @children = children
+        end
+
+        def call(input, rules, errors)
+          Result::Attr.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition/component.rb

@@ -0,0 +1,32 @@
+require "dry-data"
+require "formalist/form/result/component"
+
+module Formalist
+  class Form
+    module Definition
+      class Component
+        ALLOWED_CHILDREN = %w[field].freeze
+
+        attr_reader :config
+        attr_reader :children
+
+        def initialize(config = {}, children = [])
+          unless children.all? { |c| ALLOWED_CHILDREN.include?(Inflecto.underscore(c.class.name).split("/").last) }
+            raise ArgumentError, "children must be +#{ALLOWED_CHILDREN.join(', ')}+"
+          end
+
+          @config = config
+          @children = children
+        end
+
+        def with(new_config = {})
+          self.class.new(config.merge(new_config), children)
+        end
+
+        def call(input, rules, errors)
+          Result::Component.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition/field.rb

@@ -0,0 +1,43 @@
+require "dry-data"
+require "formalist/form/result/field"
+
+module Formalist
+  class Form
+    module Definition
+      class Field
+        TYPES = %w[
+          bool
+          date
+          date_time
+          decimal
+          float
+          int
+          string
+          time
+        ].freeze
+
+        attr_reader :name
+        attr_reader :type
+        attr_reader :display_variant
+        attr_reader :config
+
+        def initialize(name, type, display_variant, config)
+          raise ArgumentError, "type +#{type}+ not supported" unless TYPES.include?(type)
+
+          @name = name
+          @type = type
+          @display_variant = display_variant
+          @config = config
+        end
+
+        def to_display_variant(display_variant, new_config = {})
+          self.class.new(name, type, display_variant, config.merge(new_config))
+        end
+
+        def call(input, rules, errors)
+          Result::Field.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition/group.rb

@@ -0,0 +1,31 @@
+require "formalist/form/result/group"
+
+module Formalist
+  class Form
+    module Definition
+      class Group
+        ALLOWED_CHILDREN = %w[
+          attr
+          component
+          field
+          many
+        ].freeze
+
+        attr_reader :config, :children
+
+        def initialize(config = {}, children = [])
+          unless children.all? { |c| ALLOWED_CHILDREN.include?(Inflecto.underscore(c.class.name).split("/").last) }
+            raise ArgumentError, "children must be +#{ALLOWED_CHILDREN.join(', ')}+"
+          end
+
+          @config = config
+          @children = children
+        end
+
+        def call(input, rules, errors)
+          Result::Group.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition/many.rb

@@ -0,0 +1,41 @@
+require "formalist/form/result/many"
+
+module Formalist
+  class Form
+    module Definition
+      class Many
+        ALLOWED_CHILDREN = %w[
+          attr
+          component
+          group
+          field
+        ].freeze
+
+        DEFAULT_CONFIG = {
+          allow_create: true,
+          allow_update: true,
+          allow_destroy: true,
+          allow_reorder: true
+        }.freeze
+
+        attr_reader :name
+        attr_reader :config
+        attr_reader :children
+
+        def initialize(name, config = {}, children = [])
+          unless children.all? { |c| ALLOWED_CHILDREN.include?(Inflecto.underscore(c.class.name).split("/").last) }
+            raise ArgumentError, "children must be +#{ALLOWED_CHILDREN.join(', ')}+"
+          end
+
+          @name = name
+          @config = DEFAULT_CONFIG.merge(config)
+          @children = children
+        end
+
+        def call(input, rules, errors)
+          Result::Many.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition/section.rb

@@ -0,0 +1,23 @@
+require "formalist/form/result/section"
+
+module Formalist
+  class Form
+    module Definition
+      class Section
+        attr_reader :name
+        attr_reader :config
+        attr_reader :children
+
+        def initialize(name, config = {}, children = [])
+          @name = name
+          @config = config
+          @children = children
+        end
+
+        def call(input, rules, errors)
+          Result::Section.new(self, input, rules, errors)
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/definition.rb

@@ -0,0 +1,37 @@
+require "formalist/form/definition_context"
+
+module Formalist
+  class Form
+    module Definition
+      def attr(name, &block)
+        elements << [:attr, [name, define_children(&block)]]
+      end
+
+      def component(display: DEFAULT_DISPLAY_ADAPTER, **config, &block)
+        elements << [:component, [display, config, define_children(&block)]]
+      end
+
+      def field(name, type:, display: DEFAULT_DISPLAY_ADAPTER, **config)
+        elements << [:field, [name, type, display, config]]
+      end
+
+      def group(**config, &block)
+        elements << [:group, [config, define_children(&block)]]
+      end
+
+      def many(name, **config, &block)
+        elements << [:many, [name, config, define_children(&block)]]
+      end
+
+      def section(name, **config, &block)
+        elements << [:section, [name, config, define_children(&block)]]
+      end
+
+      private
+
+      def define_children(&block)
+        block ? DefinitionContext.new(&block).elements : []
+      end
+    end
+  end
+end

data/lib/formalist/form/definition_context.rb

@@ -0,0 +1,15 @@
+module Formalist
+  class Form
+    # @api private
+    class DefinitionContext
+      include Definition
+
+      attr_reader :elements
+
+      def initialize(&block)
+        @elements = []
+        yield(self)
+      end
+    end
+  end
+end

data/lib/formalist/form/result/attr.rb

@@ -0,0 +1,82 @@
+require "formalist/validation/collection_rules_compiler"
+require "formalist/validation/value_rules_compiler"
+require "formalist/validation/predicate_list_compiler"
+
+module Formalist
+  class Form
+    class Result
+      class Attr
+        attr_reader :definition, :input, :value_rules, :value_predicates, :collection_rules, :errors
+        attr_reader :children
+
+        def initialize(definition, input, rules, errors)
+          value_rules_compiler = Validation::ValueRulesCompiler.new(definition.name)
+          value_predicates_compiler = Validation::PredicateListCompiler.new
+          collection_rules_compiler = Validation::CollectionRulesCompiler.new(definition.name)
+
+          @definition = definition
+          @input = input.fetch(definition.name, {})
+          @value_rules = value_rules_compiler.(rules)
+          @value_predicates = value_predicates_compiler.(@value_rules)
+          @collection_rules = collection_rules_compiler.(rules)
+          @errors = errors.fetch(definition.name, [])[0] || []
+          @children = build_children
+        end
+
+        # Converts the attribute into an array format for including in a
+        # form's abstract syntax tree.
+        #
+        # The array takes the following format:
+        #
+        # ```
+        # [:attr, [params]]
+        # ```
+        #
+        # With the following parameters:
+        #
+        # 1. Attribute name
+        # 1. Validation rules (if any)
+        # 1. Validation error messages (if any)
+        # 1. Child form elements
+        #
+        # @example "metadata" attr
+        #   attr.to_ary # =>
+        #   # [:attr, [
+        #   #   :metadata,
+        #   #   [
+        #   #     [:predicate, [:hash?, []]],
+        #   #   ],
+        #   #   ["metadata is missing"],
+        #   #   [
+        #   #     ...child elements...
+        #   #   ]
+        #   # ]]
+        #
+        # @return [Array] the attribute as an array.
+        def to_ary
+          # Errors, if the attr hash is present and its members have errors:
+          # {:meta=>[[{:pages=>[["pages is missing"], nil]}], {}]}
+
+          # Errors, if the attr hash hasn't been provided
+          # {:meta=>[["meta is missing"], nil]}
+
+          local_errors = errors[0].is_a?(Hash) ? [] : errors
+
+          [:attr, [
+            definition.name,
+            value_predicates,
+            local_errors,
+            children.map(&:to_ary),
+          ]]
+        end
+
+        private
+
+        def build_children
+          child_errors = errors[0].is_a?(Hash) ? errors[0] : {}
+          definition.children.map { |el| el.(input, collection_rules, child_errors) }
+        end
+      end
+    end
+  end
+end

data/lib/formalist/form/result/component.rb

@@ -0,0 +1,51 @@
+module Formalist
+  class Form
+    class Result
+      class Component
+        attr_reader :definition, :input, :rules, :errors
+        attr_reader :children
+
+        def initialize(definition, input, rules, errors)
+          @definition = definition
+          @input = input
+          @rules = rules
+          @errors = errors
+          @children = definition.children.map { |el| el.(input, rules, errors) }
+        end
+
+        # Converts the component into an array format for including in a
+        # form's abstract syntax tree.
+        #
+        # The array takes the following format:
+        #
+        # ```
+        # [:component, [params]]
+        # ```
+        #
+        # With the following parameters:
+        #
+        # 1. Component configuration
+        # 1. Child form elements
+        #
+        # @example
+        #   component.to_ary # =>
+        #   # [:component, [
+        #   #   [
+        #   #     [:some_config_name, :some_config_value]
+        #   #   ],
+        #   #   [
+        #   #     ...child elements...
+        #   #   ]
+        #   # ]]
+        #
+        # @return [Array] the component as an array.
+        def to_ary
+          [:component, [
+            definition.config.to_a,
+            children.map(&:to_ary),
+          ]]
+        end
+      end
+    end
+  end
+end