formalizer 1.0.0

data/test/dummy/app/assets/stylesheets/fill_details.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/form.css

@@ -0,0 +1,20 @@
+html, body {
+  font-family: Arial, sans-serif;
+}
+
+p, div {
+  line-height: 1.5;
+}
+
+p {
+  clear: left;
+}
+
+h1, h2, h3 {
+  text-align: center;
+}
+
+.columns div.column {
+  width: 400px;
+  float: left;
+}

data/test/dummy/app/assets/stylesheets/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/about_controller.rb

@@ -0,0 +1,6 @@
+class AboutController < ApplicationController
+
+  def show
+    @page = 'about'
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/demo_controller.rb

@@ -0,0 +1,103 @@
+class DemoController < ApplicationController
+
+  # Holds the main demo activity control
+  # Will generate a user-input form fill it with user input and export HTML/PDF
+
+
+  # Formalizer's generated form has no authenticity_token field. 
+  # This field can (and should) be used, either manually or automatically,
+  # by replacing the generated <form> tag with Rails form_tag or form_for(active_record model) helper.
+  # To skip authenticity protection in this controller, uncomment the following line at your own risk:
+  # protect_from_forgery :only => [:index]
+
+  def index
+
+    # deault root view
+
+    # navbar current view:
+    @page = 'demo'
+
+    # the form is submitted to the same page, handling the POST method first:
+    fill_form and return if request.method == 'POST'
+
+    # Letting Formalizer generate a user input form
+    # We limit fields only to 'nda' tag. Other config tags relate to unit tests,
+    # and are not relevant to the demo's nda form
+
+    fill_form = Formalizer.new.generate_fields_form(I18n.locale, '', 'nda')
+
+    # The generated form is ready to use as is, but we're spicing it up a bit with Bootswatch classes:
+    fill_form_html = Nokogiri::HTML(fill_form)
+    auth_token_field = Nokogiri::XML::Node.new('input', fill_form_html)
+    fill_form_html.css('div').each{|div| div['class'] = 'form-group'}
+    fill_form_html.css('label').each{|label| label['class'] = 'col-lg-4 control-label'}
+    fill_form_html.css('div.form-group input:not([type="reset"]):not([type="submit"])').wrap('<div class="col-lg-8">')
+    fill_form_html.css('div.form-group select').wrap('<div class="col-lg-8">')
+    fill_form_html.css('div.form-group input').each{|input| input['class'] = 'form-control'}
+    fill_form_html.css('div.form-group select').each{|select| select['class'] = 'form-control'}
+    fill_form_html.css('input[type="reset"]').each{|input| input['class'] = 'btn btn-default'}
+    fill_form_html.css('input[type="submit"]').each{|input| input['class'] = 'btn btn-primary'}
+    fill_form_html.css('div.form-group:last-child').wrap('<div class="form-buttons form-group">')
+    fill_form_html.at_css('div.form-buttons > div')['class'] = 'col-lg-8 col-lg-offset-2'
+
+    # Adding authenticity token. The following lines can be commented out if
+    # the protect_from_forgery line is uncommented (see comments at the top)
+    form_tag = fill_form_html.at_css('form')
+    form_tag['class'] = 'form-horizontal'
+    auth_token_field = Nokogiri::XML::Node.new('input', fill_form_html)
+    auth_token_field['type'] = 'hidden'
+    auth_token_field['name'] = 'authenticity_token'
+    auth_token_field['value'] = form_authenticity_token
+    auth_token_field.parent = form_tag
+
+    # Finalizing and wrapping the form for view
+    @fill_details = fill_form_html.at_css('form').to_s
+
+  end
+
+
+  # Form POSTed and processed here
+
+  def fill_form
+    # How do you want your filled form served?
+    export_to = :pdf unless params['export_PDF'].nil?
+    export_to = :html unless params['export_HTML'].nil?
+
+    # Keeping only necessary params key/values
+    params.reject!{|key, value| %w(authenticity_token controller action export_PDF export_HTML).include?key}
+
+    # Sanitizing
+    sanitized_params = params.inject({}) do |hash, (k, v)|
+      begin
+        v = ActionController::Base.helpers.sanitize(v.to_s)
+        v = ActionController::Base.helpers.strip_tags(v)
+        hash.merge(k => v)
+      rescue
+        puts "Could not sanitize: #{hash}"
+        return
+      end
+    end
+
+    # Filling and exporting
+    formalizer = Formalizer.new
+    formalizer.fill_fields(sanitized_params.symbolize_keys)
+    case export_to
+      when :pdf
+        # pdf will be downloaded at client
+        pdf_stream = formalizer.export_form_to_pdf(:form1, 'nda')
+        send_data pdf_stream, {filename: 'demo.pdf', disposition: 'attachment'}
+      when :html
+        # html will be rendered inline
+        render html: formalizer.export_form_to_html(:form1, 'nda').html_safe
+    end
+  end
+
+
+  # Demo page has a link to this action.
+  # Renders the empty, unfilled demo template
+
+  def html_template
+    render html: File.read('config/form1.html').html_safe
+  end
+
+end

data/test/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,6 @@
+class HomeController < ApplicationController
+
+  def show
+    @page = 'home'
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/fill_details_helper.rb

@@ -0,0 +1,2 @@
+module FillDetailsHelper
+end

data/test/dummy/app/helpers/home_helper.rb

@@ -0,0 +1,2 @@
+module HomeHelper
+end

data/test/dummy/app/views/about/show.html.erb

@@ -0,0 +1,6 @@
+<ul>
+  <li><strong>Initial version code:</strong> Tal Yaniv</li>
+  <li><strong>Licence:</strong> <a href="https://en.wikipedia.org/wiki/MIT_License" target="_blank">MIT</a></li>
+  <li><a href="https://github.com/talyaniv/formalizer" target="_blank">Git and Documentation</a></li>
+  <li><strong>Contact me:</strong> <a href="mailto:talyaniv@gmail.com">talyaniv@gmail.com</a></li>
+</ul>

data/test/dummy/app/views/demo/index.html.erb

@@ -0,0 +1,7 @@
+<h1> Formalizer gem - Demo </h1>
+<p>
+  The following form takes raw user input and binds it to an empty <a href="demo/html_template" target="blank">HTML template</a>.<br />Fill and submit the form, then export as HTML or PDF.
+</p>
+<p>
+  <%= @fill_details.html_safe %>
+</p>

data/test/dummy/app/views/home/show.html.erb

@@ -0,0 +1,22 @@
+      <p>
+        <h1> Formalizer gem</h1>
+        <%= image_tag asset_path('formalizer.png'), class: 'scheme-container' %>
+      </p>
+
+      <p>
+      Formalizer is an open-source gem for simplifying HTML-form filling and exporting:
+      </p>
+      <ul>
+        <li>Store blank contracts, agreements, disclosure sheets etc. as HTML templates.</li>
+        <li>Wrap blank data with &lt;formalizer&gt; tags:<br /> 
+            before: &nbsp; <span class="code">name: ________</span><br />
+            after: &nbsp; <span class="code">name: &lt;formalizer id="name"&gt;________&lt;/formalizer&gt;</span>
+        </li>
+        <li>Get user data from any source, or simply let Formalizer generate user-input forms for you</li>
+        <li>Formalizer will replace the &lt;formalizer&gt; tags with user data:<br />
+        <span class="code">name: &lt;formalizer id="name"&gt;John D.&lt;/formalizer&gt;</span>
+        <li>Filled forms can be exported to PDF using <a href="https://github.com/mileszs/wicked_pdf">Wicked PDF</a> gem, or to raw html, for additional styling.</li>
+      </ul>
+      <p>
+      <a href="demo">See the demo</a>
+      </p>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Formalizer Demo</title>
+  <%= stylesheet_link_tag    'bootstrap_yeti', media: 'all', 'data-turbolinks-track' => false %>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => false %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<div class="container">
+  <div class="row">
+    <div class="col-md-1"></div>
+    <div class="col-md-10">
+
+      <%= render partial: 'shared/navbar' %>
+      <%= yield %>
+
+    </div>
+    <div class="col-md-1"></div>
+  </div>
+</div>
+
+</body>
+</html>

data/test/dummy/app/views/shared/_navbar.html.erb

@@ -0,0 +1,16 @@
+<nav class="navbar navbar-inverse">
+  <div class="container-fluid">
+    <div class="navbar-header">
+      <a class="navbar-brand" href="/">Formalizer Gem</a>
+    </div>
+
+    
+      <ul class="nav navbar-nav">
+        <li class="<%= 'active' if @page == 'home' %>"><a href="/">Home</a></li>
+        <li class="<%= 'active' if @page == 'demo' %>"><a href="demo">See a Demo</a></li>
+      </ul>
+      <ul class="nav navbar-nav navbar-right">
+        <li class="<%= 'active' if @page == 'about' %>"><a href="about">About</a></li>
+      </ul>
+  </div>
+</nav>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/_formalizer.yml

@@ -0,0 +1,102 @@
+form_fields:
+  day:
+    name: Day of month
+    field_type: number
+    tags: nda
+  month:
+    name: Month
+    field_type: enum
+    tags: nda
+    enumeration:
+     - January
+     - February
+     - March
+     - April
+     - May
+     - June
+     - July
+     - August
+     - September
+     - October
+     - November
+     - December
+  year:
+    name: Year (YYYY)
+    field_type: number
+    tags: nda
+  recipient:
+    name: Recipient
+    tags: nda
+  recipient_address:
+    name: "Recipient's address"
+    tags: nda
+  recipient_title:
+    name: Recipient Title
+    tags: nda
+  discloser:
+    name: Discloser
+    tags: nda
+  discloser_address:
+    name: "Discloser's address"
+    tags: nda
+  discloser_title:
+    name: Discloser Title
+    tags: nda
+  confidential_information_subject:
+    name: "Confidential information subject (title of what is being none-disclosed)"
+    tags: nda
+  non_disclosure_purpose:
+    name: "Non-Disclosure purpose (why the recipient needs the information)"
+    tags: nda
+  recipient_signed_date:
+    name: "Recipient signed (date)"
+    tags: nda
+  discloser_signed_date:
+    name: "Discloser signed (date)"
+    tags: nda
+  test1:
+    name:
+      en: Test One
+      es: Testo Uno
+    field_type: number
+    default_value: 1
+    tags:
+      - test_tag_1
+      - test_tag_2
+  test2:
+    name:
+      en: Test Two
+      es: Prueba de dos
+    field_type: enum
+    enumeration:
+      en:
+        - One
+        - Two
+        - Three
+      es:
+        - Uno
+        - Dos
+        - Tres
+    default_value: 0
+    tags:
+      - test_tag_1
+      - test_tag_2
+  test3:
+    name:
+      en: Test Three
+      es: Prueba de tres
+    field_type: text
+    default_value:
+      en: John
+      es: Juan
+    tags:
+      - test_tag_1
+forms:
+  form1:
+    path: form1.html
+    tags: nda
+  test1:
+    path: '<formalizer id="test1">___</formalizer><formalizer id="test2" required>___</formalizer><formalizer id="test3">___</formalizer>'
+    tags: 
+      - test_tag_1
+      - test_tag_2

data/test/dummy/config/alternative_invalid_config1.yml

@@ -0,0 +1,41 @@
+  test1:
+    name:
+      en: Test One
+      es: Testo Uno
+    field_type: number
+    default_value: 1
+    tags:
+      - tag1
+      - tag2
+  test2:
+    name:
+      en: Test Two
+      es: Prueba de dos
+    field_type: enum
+    enumeration:
+      en:
+        - One
+        - Two
+        - Three
+      es:
+        - Uno
+        - Dos
+        - Tres
+    default_value: 0
+    tags:
+      - tag1
+  test3:
+    name:
+      en: Test Three
+      es: Prueba de tres
+    field_type: text
+    default_value:
+      en: John
+      es: Juan
+    tags:
+      - tag2
+      - tag3
+forms:
+  form1:
+    path: form1.html
+    tags: nda

data/test/dummy/config/alternative_invalid_config2.yml

@@ -0,0 +1 @@
+this is not a YAML file

data/test/dummy/config/alternative_valid_config.yml

@@ -0,0 +1,42 @@
+form_fields:
+  test1:
+    name:
+      en: Test One
+      es: Testo Uno
+    field_type: number
+    default_value: 1
+    tags:
+      - tag1
+      - tag2
+  test2:
+    name:
+      en: Test Two
+      es: Prueba de dos
+    field_type: enum
+    enumeration:
+      en:
+        - One
+        - Two
+        - Three
+      es:
+        - Uno
+        - Dos
+        - Tres
+    default_value: 0
+    tags:
+      - tag1
+  test3:
+    name:
+      en: Test Three
+      es: Prueba de tres
+    field_type: text
+    default_value:
+      en: John
+      es: Juan
+    tags:
+      - tag2
+      - tag3
+forms:
+  form1:
+    path: form1.html
+    tags: nda

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "formalizer"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end