formular 0.2.0

data/lib/formular/helper.rb

@@ -0,0 +1,53 @@
+module Formular
+  # TODO: indirectly tested in erb_test and slim_test. Should probably test directly
+  module Helper
+    def form(model, url, **options, &block)
+      form_options = options
+      builder_options = form_options.select { |k, v| form_options.delete(k) || true if [:builder, :model, :path_prefix, :errors, :elements].include?(k) }
+
+      form_options[:action] ||= url
+      builder(model, builder_options).form(form_options, &block)
+    end
+
+    BUILDERS = {
+      basic: 'Formular::Builders::Basic',
+      bootstrap3: 'Formular::Builders::Bootstrap3',
+      bootstrap4: 'Formular::Builders::Bootstrap4',
+      bootstrap3_inline: 'Formular::Builders::Bootstrap3Inline',
+      bootstrap4_inline: 'Formular::Builders::Bootstrap4Inline',
+      bootstrap3_horizontal: 'Formular::Builders::Bootstrap3Horizontal',
+      bootstrap4_horizontal: 'Formular::Builders::Bootstrap4Horizontal',
+      foundation6: 'Formular::Builders::Foundation6'
+    }.freeze
+
+    class << self
+      attr_writer :builder
+
+      def builder(name = nil)
+        name ||= :basic
+        require "formular/builders/#{name}"
+        self.builder = Formular::Builders.const_get(BUILDERS.fetch(name)) # Formular::Builders::Bootstrap3
+      end
+    end
+
+    private
+
+    def builder(model, **options)
+      builder = Formular::Helper.builder(options.delete(:builder))
+      options[:model] ||= model
+
+      builder.new(options)
+    end
+  end # module Helper
+
+  module RailsHelper
+    include Helper
+
+    def trb_form_for(model, url, **options, &block)
+      options[:csrf_token] ||= form_authenticity_token
+      options[:csrf_token_name] ||= request_forgery_protection_token.to_s
+
+      form(model, url, options, &block)
+    end
+  end  # module RailsHelper
+end # module Formular

data/lib/formular/html_block.rb

@@ -0,0 +1,70 @@
+module Formular
+  # the HtmlBlock class is responsible for converting an element into an html string using
+  # the provided function providing the element as a variable to that function.
+  # this class also provides some simple helpers to make it easier to define your html.
+  class HtmlBlock
+    def initialize(element, fn)
+      @fn = fn
+      @element = element
+      @context = get_context
+    end
+    attr_reader :fn, :element
+
+    # this calls our html function passing the element instance as a variable.
+    # It returns our html as a string
+    def call
+      @output = ''
+      instance_exec(element, &fn).to_s
+    end
+
+    # append a string to the output buffer.
+    # Useful when your html block is a bit more than one line
+    def concat(content)
+      @output << content.to_s
+    end
+
+    # return the start/opening tag with the element
+    # attributes hash converted into valid html attributes
+    def start_tag
+      if element.attributes.empty?
+        "<#{element.tag}>"
+      else
+        "<#{element.tag} #{element.attributes.to_html}>"
+      end
+    end
+
+    # return a closed start tag (e.g. <input name="body"/>)
+    def closed_start_tag
+      start_tag.gsub('>', '/>')
+    end
+
+    # returns the end/ closing tag for an element
+    def end_tag
+      "</#{element.tag}>"
+    end
+
+    private
+
+    # I will confess that these two come straight from Hanami
+    # https://github.com/hanami/helpers/blob/master/lib/hanami/helpers/html_helper/html_builder.rb
+
+    if RUBY_VERSION >= '2.2'# && !Utils.jruby?
+      def get_context
+        fn.binding.receiver
+      end
+    else
+      def get_context
+        eval 'self', fn.binding
+      end
+    end
+
+    # Forward missing methods to the current context.
+    # This allows to access views local variables from nested content blocks.
+    #
+    # @since 0.1.0
+    # @api private
+    def method_missing(m, *args, &blk)
+      @context.__send__(m, *args, &blk)
+    end
+  end # class HtmlBlock
+end # module Formular

data/lib/formular/path.rb

@@ -0,0 +1,30 @@
+module Formular
+  class Path < Array
+    # name #attribute without model...
+    # [User, :name] => user[name] #regular attribute
+    # [User, roles: 0, :name] => user[roles][][name]
+
+    # DISCUSS: Should we also enable the following for rails accepts_nested_attributes support
+    # [User, roles: 0, :name => user[roles_attributes][0][name]
+    def to_encoded_name
+      map.with_index do |segment, i|
+        first_or_last = i == 0 || i == size
+
+        if first_or_last
+          segment.is_a?(Array) ? "#{segment.first}[]" : segment
+        else
+          segment.is_a?(Array) ? "[#{segment.first}][]" : "[#{segment}]"
+        end
+      end.join('')
+    end
+
+    # need to inject the index in here... else we will end up with the same ids
+    # [User, :name] => user_name #regular attribute
+    # [User, roles: 0, :name] => user_roles_0_name #nested not rails
+    # DISCUSS: Should we also enable the following for rails accepts_nested_attributes support
+    # [User, roles: 0, :name => user_roles_attributes_0_name #nested rails
+    def to_encoded_id
+      map { |segment| segment.is_a?(Array) ? segment.join('_') : segment }.join('_')
+    end
+  end # class Attributes
+end # module Formular

data/lib/formular/version.rb

@@ -0,0 +1,3 @@
+module Formular
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: formular
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nick Sutterer
+- Fran Worley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: declarative
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reform
+  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: dry-validation
+  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: trailblazer-cells
+  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: cells-slim
+  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: cells-erb
+  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: minitest
+  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: minitest-line
+  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: Customizable, fast form builder based on Cells. Framework-agnostic.
+email:
+- apotonick@gmail.com
+- frances@safetytoolbox.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formular.gemspec
+- lib/formular.rb
+- lib/formular/attributes.rb
+- lib/formular/builder.rb
+- lib/formular/builders/basic.rb
+- lib/formular/builders/bootstrap3.rb
+- lib/formular/builders/bootstrap3_horizontal.rb
+- lib/formular/builders/bootstrap3_inline.rb
+- lib/formular/builders/bootstrap4.rb
+- lib/formular/builders/bootstrap4_horizontal.rb
+- lib/formular/builders/bootstrap4_inline.rb
+- lib/formular/builders/foundation6.rb
+- lib/formular/element.rb
+- lib/formular/element/bootstrap3.rb
+- lib/formular/element/bootstrap3/checkable_control.rb
+- lib/formular/element/bootstrap3/column_control.rb
+- lib/formular/element/bootstrap3/horizontal.rb
+- lib/formular/element/bootstrap3/input_group.rb
+- lib/formular/element/bootstrap4.rb
+- lib/formular/element/bootstrap4/checkable_control.rb
+- lib/formular/element/bootstrap4/custom_control.rb
+- lib/formular/element/bootstrap4/horizontal.rb
+- lib/formular/element/foundation6.rb
+- lib/formular/element/foundation6/checkable_control.rb
+- lib/formular/element/foundation6/input_group.rb
+- lib/formular/element/foundation6/wrapped_control.rb
+- lib/formular/element/module.rb
+- lib/formular/element/modules/checkable.rb
+- lib/formular/element/modules/collection.rb
+- lib/formular/element/modules/container.rb
+- lib/formular/element/modules/control.rb
+- lib/formular/element/modules/error.rb
+- lib/formular/element/modules/hint.rb
+- lib/formular/element/modules/label.rb
+- lib/formular/element/modules/wrapped_control.rb
+- lib/formular/elements.rb
+- lib/formular/helper.rb
+- lib/formular/html_block.rb
+- lib/formular/path.rb
+- lib/formular/version.rb
+homepage: http://trailblazer.to/gems/formular.html
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Form builder based on Cells. Fast, Furious, and Framework-Agnostic.
+test_files: []