neewom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0ffd96cee9a740737d32948b45474858e28444c138e8a748f457985c5029541
+  data.tar.gz: fa6e08472a06a00da8dfda822b815031ac25a4773d0181fb91b1b2e00b365d7a
+SHA512:
+  metadata.gz: 59d8669ecadba1e83624b7edd69eeb907b9e2b2c75dad39ccfc91e02dac790dd94ee6fe80695f1e11ac32b04b0768520555e1530bc0ad113c5e3e18b83506b93
+  data.tar.gz: e030a33140221b88e775d1db3612cb233c35e03c204885ca6d47ac9c54f44d1e1d6f4217d70c02c0262ae58c26649a955cb911ac15c0e700404053330d79fdac

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at olegz@jetruby.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development, :test do
+  gem 'rails-dummy'
+  gem 'pg'
+  gem 'rails'
+  gem 'byebug'
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec-rails'
+  gem 'database_cleaner'
+  gem 'simplecov'
+end
+
+
+# Specify your gem's dependencies in neewom.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,189 @@
+PATH
+  remote: .
+  specs:
+    neewom (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.5.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    pg (1.1.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-dummy (0.1.0)
+      railties
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  database_cleaner
+  neewom!
+  pg
+  pry
+  rails
+  rails-dummy
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 KnightWhoSayNi
+
+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,318 @@
+# Neewom
+
+Rails custom form builder. Was designed to solve general issues about dynamic attributes:
+
+ - Ability to have different fields on the same form for different users
+ - Ability to allow your users to add a custom fields on forms they need
+ - Ability to search by custom data.
+
+ # Custom fields for different users.
+
+ Before building a custom attributes system (which is usually takes about 60 hours), developers goes by a simple way and just add new column to the database.
+ It's a common use case, when some customer is ready to pay for  your service, but if you will add some specific fields on some forms. And often other users doesn't need those fields.
+
+ This approach still a good one and the most simplest and cheapest. But, with growing a number of users, who needs their own custom fields, it becomes a pain.
+
+ Neewom is a flexible solution which allows to organize your custom forms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'neewom'
+```
+
+Copy a default form template
+
+**app/views/neewom_forms/form.html.erb**
+
+```ruby
+<%= form_for @resource, url: form_url, method: form_method do |f| %>
+  <% form.fields.each do |field| %>
+    <div>
+      <% unless field.input == Neewom::AbstractField::SUBMIT %>
+        <%= f.label field.name, field.label %>
+      <% end %>
+      <% case field.input %>
+      <% when Neewom::AbstractField::EMAIL %>
+        <%= f.email_field field.name, field.input_html %>
+      <% when Neewom::AbstractField::HIDDEN %>
+        <%= f.hidden_field field.name, field.input_html %>
+      <% when Neewom::AbstractField::NUMBER %>
+        <%= f.number_field field.name, field.input_html %>
+      <% when Neewom::AbstractField::PASSWORD %>
+        <%= f.password_field field.name, field.input_html %>
+      <% when Neewom::AbstractField::PHONE %>
+        <%= f.phone_field field.name, field.input_html %>
+      <% when Neewom::AbstractField::SELECT %>
+        <% if field.collection.present? %>
+          <% collection = field.collection %>
+        <% else %>
+          <% method_params = field.collection_params.map { |method_name| public_send(method_name) } %>
+          <% collection = field.collection_klass.constintize.public_send(field.collection_method, *method_params) %>
+        <% end %>
+
+        <% options = collection.map { |i| [i.public_send(field.label_method), i.public_send(field.value_method)] } %>
+
+        <%= f.select field.name, options, field.input_html %>
+      <% when Neewom::AbstractField::SUBMIT %>
+        <%= f.submit field.label, {name: field.name}.merge(field.input_html) %>
+      <% when Neewom::AbstractField::TEXTAREA %>
+        <%= f.text_area field.name, field.input_html %>
+      <% when Neewom::AbstractField::TEXT %>
+        <%= f.text_field field.name, field.input_html %>
+      <% end %>
+      <% if @resource.errors[field.name].any? %>
+        <span class="errors"><%= @resource.errors[field.name].join(', ')%></span>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+## Usage
+
+Add a jsonb field, which will store the custom attributes
+
+```ruby
+class AddAttributesToUsers < ActiveRecord::Migration[5.1]
+  def change
+    add_column :users, :data, :jsonb
+  end
+end
+```
+
+Configure your model to work with that field
+
+```ruby
+class User < ApplicationRecord
+  include Neewom::Model
+
+  has_neewom_attributes :data
+end
+```
+
+Next you need to describe the form. Please note, that by default you need to describe all fields, not just a custom ones. But, you can generate another template and predefine some fields there.
+
+```ruby
+Neewom::AbstractForm.build(
+  id: :custom_user_form,
+  repository_klass: 'User',
+  fields: {
+    name: {
+      virtual: true
+    },
+    email: {
+      virtual: false,
+      input: 'email_field'
+    },
+    password: {
+      virtual: false,
+      input: 'password_field',
+      validations: {presence: true, confirmation: true}
+    },
+    password_confirmation: {
+      virtual: false,
+      input: 'password_field'
+    },
+    commit: {
+      label: 'Save',
+      input: 'submit'
+    }
+  }
+)
+```
+
+### Form attributes
+
+1. **id** (*required*) - An unique form id
+2. **repository_klass** (*required*) - An active record model name with configured neewom attributes
+3. **fields** (*required*) - A hash with fields config.
+4. **template** - form template name ("form" by default)
+
+### Field attrbutes
+
+The hash keys are also a names.
+
+1. **label** - Input label. By default it's `name.to_s.humanize`
+2. **input** - Field input. By default it's 'text_field'. Check the `Neewom::AbstractField::SUPPORTED_FIELDS` to get the list of supported inputs
+3. **virtual** - Boolean, true by default. Should be false if you need to store data in a real column instead of the jsonb one
+4. **validations** - Hash, by default an empty one. Should be the standard rails validations
+5. **collection** - Collection of objects for the select input. Can not be stored to the database
+6. **label_method** - A label method for collection. Used while building options for select
+7. **value_method** - A value method for collection. Used while building options for select. It's 'id' by default
+8. **input_html** - A hash with the HTML attributes
+
+Another way to define a collection is to pass three params
+
+1. **collection_klass** - A class which contain the specific logic
+2. **collection_method** - A class method of the `collection_class`
+3. **collection_params** - A view context methods. Will pass to `collection_method`
+
+So, the `{collection_klass: 'EmployeesCollections', collection_method: 'managers_for_user', collection_params: [:current_user]}` will call the
+
+```ruby
+EmployeesCollections.managers_for_user(current_user)
+```
+
+inside the view.
+
+## Defining a controller
+
+You need to define the next methods as a helper_methods: `form_url`, `form_method`, `form`
+
+An instance of the `Neewom::AbstractForm` will have a set of usefull methods you need to use in the controller
+
+1. `form.build_resource(permitted_params)` - will build a new ActiveRecord model
+2. `form.find(id)`
+3. `form.find_by(id: 1)`
+4. `form.find_by!(id: 1)`
+5. `form.repository_klass.constantize` - get a ActiveRecord model class
+6. `form.strong_params_require` - the require part for strong params
+7. `form.strong_params_permit` - the permit part for strong params
+
+
+It's more easy to use an existing methods, because there are an existing neewom initialization inside
+
+```ruby
+def build_resource(params)
+  resource = repository_klass.constantize.new
+  resource.initialize_neewom_attributes(self)
+  resource.assign_attributes(params) if params.present?
+
+  resource
+end
+```
+
+### The complete controller example
+
+```ruby
+class CustomController < ApplicationController
+  def new
+    @resource = form.build_resource
+    render "neewom_forms/#{form.template}"
+  end
+
+  def create
+    @resource = form.build_resource permitted_params
+
+    if @resource.save
+      redirect_to root_path
+    else
+      render "neewom_forms/#{form.template}"
+    end
+  end
+
+  private
+
+  def permitted_params
+    params.require(form.strong_params_require).permit(form.strong_params_permit)
+  end
+
+  def form_url
+    custom_index_path
+  end
+  helper_method :form_url
+
+  def form_method
+    :post
+  end
+  helper_method :form_method
+
+  def form
+    @form ||= Neewom::AbstractForm.build(
+      id: :custom_user_form,
+      repository_klass: 'User',
+      fields: {
+        name: {
+          virtual: true
+        },
+        email: {
+          virtual: false,
+          input: 'email_field'
+        },
+        password: {
+          virtual: false,
+          input: 'password_field',
+          validations: {presence: true, confirmation: true}
+        },
+        password_confirmation: {
+          virtual: false,
+          input: 'password_field'
+        },
+        commit: {
+          label: 'Save',
+          input: 'submit'
+        }
+      }
+    )
+  end
+  helper_method :form
+end
+```
+
+## Storing forms in the database.
+
+If you didn't used a `collection` in any field, you can store the form to the database.
+
+Add a neewom tables first
+
+```ruby
+def change
+  create_table :neewom_forms do |t|
+    t.string :key, null: false, index: { unique: true }
+    t.string :description
+    t.string :crc32, null: false, index: { unique: true }
+    t.string :repository_klass, null: false
+    t.string :template, null: false
+
+    t.timestamps null: false
+  end
+
+  create_table :neewom_fields do |t|
+    t.integer :form_id, null: false
+    t.string  :label
+    t.string  :name, null: false
+    t.string  :input
+    t.boolean :virtual
+    t.string  :validations
+    t.string  :collection_klass
+    t.string  :collection_method
+    t.string  :collection_params
+    t.string  :label_method
+    t.string  :value_method
+    t.string  :input_html
+
+    t.timestamps null: false
+  end
+
+  add_index :neewom_fields, [:form_id, :name], unique: true
+end
+```
+
+Then you can store and fetch forms.
+
+```ruby
+
+form.store!
+restored_form = Neewom::CustomForm.find_by!(key: form.id).to_form
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/neewom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Neewom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/neewom/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rails/dummy/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "neewom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/neewom/abstract_field.rb

@@ -0,0 +1,68 @@
+module Neewom
+  class AbstractField
+    # This constant can be changed OUTSIDE !!!
+    SUPPORTED_FIELDS = [
+      # 'check_box_collection',
+      EMAIL               = 'email_field',
+      HIDDEN              = 'hidden_field',
+      NUMBER              = 'number_field',
+      PASSWORD            = 'password_field',
+      PHONE               = 'phone_field',
+      # 'radio_button_collection',
+      SELECT              = 'select_field',
+      MULTIPLE_SELECT     = 'multiple_select_field',
+      SUBMIT              = 'submit',  
+      TEXTAREA            = 'text_area',
+      TEXT                = 'text_field',
+      CHECKBOX            = 'checkbox',
+      FILE                = 'file',
+      DATEPICKER          = 'datepicker',
+      TIMEPICKER          = 'timepicker',
+      DATETIMEPICKER      = 'datetimepicker'
+    ]
+
+    attr_accessor :label, :name, :input, :virtual, :validations,
+      :collection, :collection_klass, :collection_method, :collection_params,
+      :label_method, :value_method, :input_html, :custom_options
+
+    def submit?
+      input == SUBMIT
+    end
+
+    def label
+      @label || name.to_s.humanize
+    end
+    
+    def input
+      @input || 'text_field'
+    end  
+
+    def virtual
+      @virtual.nil? ? true : @virtual
+    end
+
+    def input_html
+      @input_html || {}
+    end
+
+    def validations
+      @validations || {}
+    end
+
+    def custom_options
+      @custom_options || {}
+    end
+
+    def build_validations
+      validations
+    end
+
+    def label_method
+      @label_method || :name
+    end
+
+    def value_method
+      @value_method || :id
+    end
+  end
+end

data/lib/neewom/abstract_form.rb

@@ -0,0 +1,65 @@
+module Neewom
+  class AbstractForm
+    include Neewom::Proxies::BuildersAndFinders
+
+    include Neewom::Serializer
+    
+    attr_accessor :id, :repository_klass, :template, :fields, :persist_submit_controls
+
+    def self.build(config)
+      form = self.new
+      form.id = config[:id]
+      form.repository_klass = config[:repository_klass]
+      form.template = config[:template]
+      form.persist_submit_controls = config[:persist_submit_controls]
+
+      form.fields = config[:fields].map do |name, field_config|
+        field = Neewom::AbstractField.new
+
+        field_config = { input: field_config } if field_config.is_a?(String)
+
+        field.name              = name
+        field.label             = field_config[:label]        
+        field.input             = field_config[:input]
+        field.virtual           = field_config[:virtual]
+        field.validations       = field_config[:validations]
+        field.collection        = field_config[:collection]
+        field.collection_klass  = field_config[:collection_klass]
+        field.collection_method = field_config[:collection_method]
+        field.collection_params = field_config[:collection_params]
+        field.label_method      = field_config[:label_method]
+        field.value_method      = field_config[:value_method]
+        field.input_html        = field_config[:input_html]
+        field.custom_options    = field_config[:custom_options]
+
+        field
+      end
+
+      form
+    end
+
+    def fields
+      @fields || []
+    end
+
+    def template
+      @template || 'form'
+    end  
+
+    def virtual_fields
+      fields.select(&:virtual)
+    end
+
+    def submit_fields
+      fields.select(&:submit?)
+    end
+
+    def persisted_fields
+      persist_submit_controls ? fields : fields.reject(&:submit?)
+    end
+
+    def store!
+      Neewom::Repository.new.store!(self)
+    end  
+  end
+end

data/lib/neewom/custom_field.rb

@@ -0,0 +1,10 @@
+module Neewom
+  class CustomField < ActiveRecord::Base
+    self.table_name = 'neewom_fields'
+
+    belongs_to :custom_form, foreign_key: :form_id
+
+    validates :name, presence: true
+    validates :input, inclusion: { in: Neewom::AbstractField::SUPPORTED_FIELDS }
+  end
+end

data/lib/neewom/custom_form.rb

@@ -0,0 +1,14 @@
+module Neewom
+  class CustomForm < ActiveRecord::Base
+    self.table_name = 'neewom_forms'
+
+    has_many :custom_fields, -> { order(order: :asc) }, foreign_key: :form_id
+
+    validates :key, :repository_klass, :template, presence: true
+    validates :description, length: {minimum: 3, maximum: 255}, allow_blank: true
+
+    def to_form
+      Neewom::Repository.new.fetch!(self)
+    end
+  end
+end

data/lib/neewom/model.rb

@@ -0,0 +1,51 @@
+module Neewom
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :neewom_form
+
+      def initialize_neewom_attributes(key_or_form)
+        data_column = self.class.neewom_attributes_column
+
+        self.neewom_form = 
+          case key_or_form
+          when Neewom::AbstractForm
+            key_or_form
+          when Neewom::CustomForm
+            key_or_form.to_form
+          else  
+            Neewom::CustomForm.find_by!(key: key_or_form).to_form
+          end
+
+        neewom_form.virtual_fields.map do |field|
+          name = field.name.to_sym
+          
+          singleton_class.class_eval do
+            store_accessor data_column, name
+          end
+        end
+
+        neewom_form.fields.map do |field|
+          name = field.name.to_sym
+          validations_config = field.validations
+          
+          singleton_class.class_eval do
+            if validations_config.present?
+              validates [name, validations_config].flatten
+            end
+          end
+        end
+      end  
+    end
+
+    module ClassMethods
+      attr_accessor :neewom_attributes_column
+
+      def has_neewom_attributes(column)
+        self.neewom_attributes_column = column
+        serialize column, Hash
+      end
+    end
+  end
+end

data/lib/neewom/proxies/builders_and_finders.rb

@@ -0,0 +1,87 @@
+module Neewom
+  module Proxies
+    module BuildersAndFinders
+      def build_resource(controller_params=nil, initial_values: {})
+        resource = repository_klass.constantize.new
+        apply_inputs(resource, controller_params, initial_values: initial_values)
+      end
+  
+      def apply_inputs(resource, controller_params, initial_values: {})
+        return unless resource.present?
+
+        resource.initialize_neewom_attributes(self) if resource.respond_to?(:initialize_neewom_attributes)        
+
+        if controller_params.present?
+          params = permit_params(controller_params)
+
+          initial_values.each do |field, value|
+            if resource.respond_to?(:"#{field}=")
+              resource.public_send(:"#{field}=", value)
+            else
+              raise "The form trying to setup the #{field} field from an initial data, but the #{resource.class.name} can't accept it"
+            end
+          end
+
+          data = persisted_fields.each_with_object({}) do |field, acc| 
+            acc[field.name.to_sym] = params[field.name.to_sym] if params.has_key?(field.name.to_sym) 
+          end
+
+          resource.assign_attributes(data) 
+        end
+  
+        resource
+      end  
+
+      def parse_submit_control_value(controller_params)
+        submit_fields.each_with_object({}) do |field, acc| 
+          acc[field.name.to_sym] = controller_params[field.name.to_sym] if controller_params.has_key?(field.name.to_sym)
+        end
+      end
+      
+      def find(id)
+        resource = repository_klass.constantize.find(id)
+        resource.initialize_neewom_attributes(self)
+  
+        resource
+      end
+  
+      def find_by(options)
+        resource = repository_klass.constantize.find_by(options)
+        resource.initialize_neewom_attributes(self) if resource.present?
+  
+        resource
+      end
+  
+      def find_by!(options)
+        resource = repository_klass.constantize.find_by!(options)
+        resource.initialize_neewom_attributes(self)
+  
+        resource
+      end
+
+      def find_and_apply_inputs(id, form_params, initial_values: {})
+        apply_inputs(find(id), form_params, initial_values: initial_values)
+      end
+
+      def find_by_and_apply_inputs(options, form_params, initial_values: {})
+        apply_inputs(find_by(options), form_params, initial_values: initial_values)
+      end
+
+      def find_by_and_apply_inputs!(options, form_params, initial_values: {})
+        apply_inputs(find_by!(options), form_params, initial_values: initial_values)
+      end
+
+      def permit_params(controller_params)
+        controller_params.require(strong_params_require).permit(strong_params_permit)
+      end
+
+      def strong_params_require
+        repository_klass.constantize.model_name.param_key.to_sym
+      end
+  
+      def strong_params_permit
+        fields.map(&:name)
+      end
+    end
+  end
+end  

data/lib/neewom/repository.rb

@@ -0,0 +1,110 @@
+require 'zlib'
+
+module Neewom
+  class Repository
+    def store!(abstract_form)
+      form_record = Neewom::CustomForm.find_by key: abstract_form.id
+      current_crc = calculate_crc32(abstract_form)
+
+      return if form_record.present? && form_record.crc32 == current_crc
+
+      form_record ||= Neewom::CustomForm.new(key: abstract_form.id)
+
+      form_record.transaction do
+        form_record.assign_attributes(
+          repository_klass: abstract_form.repository_klass, 
+          template: abstract_form.template, 
+          crc32: current_crc, 
+          persist_submit_controls: (abstract_form.persist_submit_controls || false)
+        )
+        existing_fields = form_record.custom_fields.to_a
+
+        abstract_form.fields.each_with_index do |field, index|
+          if field.collection.present?
+            raise "Form with specified collection could not be stored."  
+          end
+                    
+          field_record = existing_fields.find { |item| item.name.to_s == field.name.to_s }
+          field_record ||= Neewom::CustomField.new(custom_form: form_record, name: field.name)
+
+          field_record.update!(
+            order:             index,
+            label:             field.label,
+            input:             field.input,
+            virtual:           field.virtual,
+            validations:       field.validations.to_json,
+            collection_klass:  field.collection_klass,
+            collection_method: field.collection_method,
+            collection_params: field.collection_params.to_json,
+            label_method:      field.label_method,
+            value_method:      field.value_method,
+            input_html:        field.input_html.to_json,
+            custom_options:    field.custom_options.to_json
+          )
+
+          form_record.custom_fields << field_record
+        end
+
+        removable_fields = existing_fields.select { |item| abstract_form.fields.none? { |f| f.name.to_s == item.name.to_s } }
+        removable_fields.each(&:destroy)
+        
+        form_record.save!
+      end
+
+      form_record
+    end
+
+    def fetch!(form_record)
+      form = Neewom::AbstractForm.new
+      form.id                      = form_record.key
+      form.repository_klass        = form_record.repository_klass
+      form.template                = form_record.template
+      form.persist_submit_controls = form_record.persist_submit_controls
+
+      form.fields = form_record.custom_fields.map do |field_record|
+        field = Neewom::AbstractField.new
+        field.label             = field_record.label
+        field.name              = field_record.name
+        field.input             = field_record.input
+        field.virtual           = field_record.virtual
+        field.validations       = JSON.parse(field_record.validations, symbolize_names: true)
+        field.collection_klass  = field_record.collection_klass
+        field.collection_method = field_record.collection_method
+        field.collection_params = JSON.parse(field_record.collection_params)&.map(&:to_sym)
+        field.label_method      = field_record.label_method
+        field.value_method      = field_record.value_method
+        field.input_html        = JSON.parse(field_record.input_html, symbolize_names: true)
+        field.custom_options    = JSON.parse(field_record.custom_options, symbolize_names: true)
+
+        field
+      end
+
+      form
+    end
+
+    private 
+
+    def calculate_crc32(abstract_form)
+      buff = [abstract_form.id, abstract_form.repository_klass, abstract_form.template, abstract_form.persist_submit_controls].join(':')
+
+      buff += abstract_form.fields.map do |field|
+        [
+          field.label,
+          field.name,
+          field.input,
+          field.virtual,
+          field.validations.to_json,
+          field.collection_klass,
+          field.collection_method,
+          field.collection_params.to_json,
+          field.label_method,
+          field.value_method,
+          field.input_html.to_json,
+          field.custom_options.to_json
+        ].map(&:to_s)
+      end.flatten.join(':')
+      
+      Zlib::crc32(buff).to_s
+    end 
+  end  
+end

data/lib/neewom/serializer.rb

@@ -0,0 +1,38 @@
+require 'zlib'
+
+module Neewom
+  module Serializer
+    # It looks like it may have sense to store an input config and return it.
+    # However theare some fields are not serializable and also there are default values.
+
+    def to_h
+      result = {}
+      result[:id] = id
+      result[:repository_klass] = repository_klass
+      result[:template] = template
+      result[:fields] = {}
+
+      fields.each do |field|
+        field_data = {}
+        field_data[:label]              = field.label
+        field_data[:input]              = field.input
+        field_data[:validations]        = field.validations
+        field_data[:collection_klass]   = field.collection_klass
+        field_data[:collection_method]  = field.collection_method
+        field_data[:collection_params]  = field.collection_params
+        field_data[:label_method]       = field.label_method
+        field_data[:value_method]       = field.value_method
+        field_data[:input_html]         = field.input_html
+        field_data[:custom_options]     = field.custom_options
+
+        result[:fields][field.name.to_sym] = field_data 
+      end
+
+      result
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+  end  
+end

data/lib/neewom/version.rb

@@ -0,0 +1,3 @@
+module Neewom
+  VERSION = "0.1.0"
+end

data/lib/neewom.rb

@@ -0,0 +1,16 @@
+require "neewom/version"
+
+require "neewom/proxies/builders_and_finders"
+require "neewom/serializer"
+require "neewom/abstract_field"
+require "neewom/abstract_form"
+require "neewom/custom_field"
+require "neewom/custom_form"
+require "neewom/model"
+require "neewom/repository"
+
+
+module Neewom
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/neewom.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "neewom/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "neewom"
+  spec.version       = Neewom::VERSION
+  spec.authors       = ["Oleg Zaporozhchenko"]
+  spec.email         = ["olegz@jetruby.com"]
+
+  spec.summary       = %q{Rails ActiveRecord custom fields and forms based on Postgres json fields}
+  spec.description   = %q{The most flexible solution for organizing custom fields for Rails ActiveRecord}
+  spec.homepage      = "https://github.com/trueknightwhosayni/neewom"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/trueknightwhosayni/neewom"
+    spec.metadata["changelog_uri"] = "https://github.com/trueknightwhosayni/neewom/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: neewom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleg Zaporozhchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The most flexible solution for organizing custom fields for Rails ActiveRecord
+email:
+- olegz@jetruby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/neewom.rb
+- lib/neewom/abstract_field.rb
+- lib/neewom/abstract_form.rb
+- lib/neewom/custom_field.rb
+- lib/neewom/custom_form.rb
+- lib/neewom/model.rb
+- lib/neewom/proxies/builders_and_finders.rb
+- lib/neewom/repository.rb
+- lib/neewom/serializer.rb
+- lib/neewom/version.rb
+- neewom.gemspec
+homepage: https://github.com/trueknightwhosayni/neewom
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trueknightwhosayni/neewom
+  source_code_uri: https://github.com/trueknightwhosayni/neewom
+  changelog_uri: https://github.com/trueknightwhosayni/neewom/blob/master/CHANGELOG.md
+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.0.4
+signing_key: 
+specification_version: 4
+summary: Rails ActiveRecord custom fields and forms based on Postgres json fields
+test_files: []