alchemy-ajax-form 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45ab672b66d4ffa39f450d9a4ad2eb4f1e1b8534
+  data.tar.gz: cca6ea5eb17fac0519450621a80d96b2b4148d1d
+SHA512:
+  metadata.gz: 11917022577519167aca018ce66bd2c0192bd67dfdbd92643f6ed9986b377f77e51478d7ba16444df88468dc07829b9dde9b919ed63f47b51190995735b4d2f4
+  data.tar.gz: ccc002dd2b745626230d24a148a62bef65d8481a0c33d2af53d135e8ad1b3a8dcfd438425c1273b7fa97b7dbbdb81025cbf238183399ed2a6ddfc2a796fef771

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Alessandro Baccanelli
+
+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,310 @@
+# Alchemy::Ajax::Form
+A gem for semplify form creations in alchemy.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-ajax-form', github: "ArchimediaZerogroup/alchemy-ajax-form"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install alchemy-ajax-form
+```
+
+install mjml 4.1.0 with npm globally (with sudo if necessary)
+```bash
+$ npm install mjml@4.1.0 -g
+```
+
+
+## Usage
+Launch the generator with this command:
+```bash
+$ bin/rails generate custom_form name_of_form param:type
+```
+example:
+```bash
+$ bin/rails generate custom_form contact_form email:string firstname:string lastname:string message:text
+```
+
+Ansawer to the questions step by step
+
+Configure element in layoutpage
+
+Restart Server
+
+### How use without generator
+If you don't wont use the generator you have to follow these steps:
+
+Let's assume we want to create the form "ContactForm"
+
+#### Create Admin Controller
+
+Create Admin::ContactFormsController (/app/controllers/admin/contact_forms_controller.rb)
+
+```ruby
+class Admin::ContactFormsController < Alchemy::Admin::AjaxFormsController
+
+end
+```
+
+#### Create Controller
+Create ContactFormsController (/app/controllers/admin/contact_forms_controller.rb)
+
+```ruby
+class ContactFormsController < Alchemy::AjaxFormsController
+
+end
+```
+
+#### Create Resource
+Create ContactFormResource (app/lib/contact_form_resource.rb)
+
+```ruby
+class ContactFormResource < Alchemy::AjaxFormResource
+
+end
+```
+
+#### Create Model
+Create ContactForm (app/models/contact_form.rb)
+
+```ruby
+class ContactForm < Alchemy::AjaxForm
+
+  validates :check_privacy, inclusion: [true, '1']
+
+
+  def notify_subject
+    I18n.translate(:contact_form_notify, scope: [:ajax_form_mailer, :subjects])
+  end
+
+  def notify_user_subject
+    I18n.translate(:contact_form_user_notify, scope: [:ajax_form_mailer, :subjects])
+  end
+
+
+end
+```
+
+#### Create Ability
+Create ContactFormAbility (app/models/contact_form_ability.rb)
+
+```ruby
+class ContactFormAbility
+  include CanCan::Ability
+
+  def initialize(user)
+    if user.present? && user.is_admin?
+      can :manage, ContactForm
+      cannot :create, ContactForm
+      cannot :update, ContactForm
+      can :manage, :admin_contact_forms
+      cannot :create, :admin_contact_forms
+      cannot :update, :admin_contact_forms
+    end
+  end
+
+end
+```
+
+#### Create Migration
+Create CreateContactForm (db/migrate/%Y%m%d%H%M%Screate_contact_form.rb)
+
+```ruby
+class CreateContactForm < ActiveRecord::Migration[5.2]
+  def change
+    create_table :contact_forms do |t|
+    
+    # insert all form fields
+    
+      t.boolean :check_privacy
+      t.references :language, index: true
+      t.timestamps
+    end
+  end
+end
+```
+
+#### Create Element Configuration
+Insert into file "config/alchemy/elements.yml"
+
+```yaml
+- name: contact_form
+  hint: false
+  contents:
+  - name: privacy_page
+    type: EssenceText
+    settings:
+      linkable: true
+  - name: recipient_notification
+    type: EssenceText
+    default: "example@example.it"
+  - name: send_only
+    type: EssenceBoolean
+  - name: send_staff
+    type: EssenceBoolean
+  - name: send_user
+    type: EssenceBoolean\n
+
+```
+
+#### Create Element View
+Create contact form view "app/views/alchemy/elements/_contact_form_view.html.erb"
+
+```erbruby
+<% cache(element) do %>
+  <%= element_view_for(element) do |el| -%>
+
+
+    <%
+      privacy_link = element.content_by_name(:privacy_page).essence.link
+      privacy_title = element.content_by_name(:privacy_page).essence.body
+      @contact_form = ContactForm.new
+      @contact_form.alcm_element = element.id
+    %>
+
+
+    <div class="messages"></div>
+
+
+    <%= form_for(@contact_form, url: main_app.contact_forms_path, method: :post, remote: true, multipart: true,html:{class: "ajax_forms"}) do |f| %>
+      <%= f.hidden_field :alcm_element %>
+      <div class="row">
+      #list of attributes
+      </div>
+
+    <% if !privacy_title.blank? %>
+       <div class="privacy">
+         <div class="single_privacy">
+           <%= f.check_box :check_privacy %>
+           <%= link_to privacy_link do %>
+             <label><%= privacy_title %></label>
+           <% end %>
+         </div>
+       </div>
+     <% else %>
+       <%= f.check_box :check_privacy %>
+     <% end %>
+
+
+      <div class="submit">
+      <%= f.submit t(:submit) %>
+      </div>
+
+    <% end %>
+
+
+
+  <%- end -%>
+<%- end -%>
+```
+
+#### Create or add entry to initializer
+
+Create or edit alchemy_ahax_forms initializer ( config/initializers/alchemy_ajax_forms.rb)
+
+```ruby
+Alchemy::Modules.register_module({
+                                   name: 'alchemy_ajax_forms',
+                                   order: 1,
+                                   navigation: {
+                                     name: 'modules.contact_forms',
+                                     controller: '/admin/contact_forms',
+                                     action: 'index',
+                                     image: 'alchemy/ajax_form.png',
+                                     sub_navigation: [
+                                     {
+                                       name: 'modules.contact_forms',
+                                       controller: '/admin/contact_forms',
+                                       action: 'index'
+                                     },
+                                     ]
+                                   }
+                                 })
+
+Alchemy.register_ability(ContactFormAbility)
+
+module Alchemy
+
+EMAIL_NOTIFY= "example@example.it"
+EMAIL_NOTIFY_FROM = "no-reply@example.it"
+
+end
+```
+
+If you add multiple form add only:
+```ruby
+{
+  name: 'modules.contact_forms',
+  controller: '/admin/contact_forms',
+  action: 'index'
+}
+```
+and ability
+```ruby
+Alchemy.register_ability(ContactFormAbility)
+```
+
+#### Create Mail Template
+
+Create email template ()app/views/alchemy/ajax_forms_mailer/_contact_form.mjml)
+Create email template for user notification ()app/views/alchemy/ajax_forms_mailer/_contact_form_user.mjml)
+
+```ruby
+<mj-column>
+  <mj-text align="left" color="#55575d" font-family="Arial, sans-serif" font-size="13px" line-height="22px" padding-bottom="0px" padding-top="5px" padding="10px 25px">
+    <p style="line-height: 16px; text-align: center; margin: 10px 0;font-size:12px;color:#000;font-family:'Times New Roman',Helvetica,Arial,sans-serif">
+       <span><b>attribute name:</b></span>
+       <span><%= rec.attribute_name %></span>
+    </p>
+  </mj-text>
+</mj-column>
+```
+
+#### Add Routes
+Add right routes
+
+```ruby
+namespace :admin do
+ resources :contact_forms
+ 
+end
+resources :contact_forms , only: [:create]
+```
+
+#### Require assets
+Add to app/assets/javascripts/application.js
+
+```ruby
+//= require jquery3
+//= require ajax_forms
+```
+
+### Run Migration
+Run migration with rake task
+
+```bash
+$ bin/rake db:migrate
+```
+
+Configure element in layoutpage
+
+Restart Server
+             
+## Translations
+Remember to check translations
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alchemy::Ajax::Form'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/alchemy_ajax_form_manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/app/assets/javascripts/ajax_forms.js.erb

@@ -0,0 +1,185 @@
+(function ($) {
+
+  var recaptha_disabled = <%= Recaptcha.configuration.skip_verify_env.include?(Rails.env.to_s ) %>
+
+
+  var print_results = function (element, result) {
+    if (result instanceof Array) {
+      var resp = "";
+
+      $.each(result, function (index, value) {
+
+        resp += "<span>" + value + "</span>";
+
+      });
+
+    } else {
+      resp = result
+    }
+
+    resp = '<div class="default_message">' + resp + '</div>';
+    $(element).append(resp);
+
+  };
+
+  var add_errors = function (form, errors) {
+
+    $.each(errors, function (name, value) {
+
+      var input = $(form).find("[name*='" + name + "']");
+
+
+      $(input).addClass("invalid");
+
+      if ($(input).parent().children('.error-message').length == 0) {
+        $(input).parent().append("<span class='error-message'>" + value + "</span>");
+      } else {
+        $('.error-message').show();
+      }
+
+    });
+  };
+
+
+  var clear_deafult_message = function (form) {
+    var message_box = $(form).parent().find(".messages")[0];
+    var default_message = $(message_box).find(".default_message");
+    var custom_message = $(message_box).find(".custom_message");
+    if ($(default_message).length > 0) {
+      $(default_message).remove();
+    }
+
+    if ($(custom_message).length == 0) {
+      $(message_box).html("");
+    }
+  }
+
+
+  var add_loader = function (form) {
+    if ($(form).children('.ajax_forms_loader').length == 0) {
+      $(form).append('<div class="ajax_forms_loader"> <i class="fa fa-circle-o-notch fa-spin"></i> </div>');
+    } else {
+      $(form).children('.ajax_forms_loader').fadeIn();
+    }
+  }
+
+  var hide_loader = function (form) {
+    $(form).children('.ajax_forms_loader').fadeOut();
+  }
+
+  var submit_function = function (form, method, action) {
+    $(form).trigger("submitted");
+    add_loader(form);
+
+    if ($(form).find("[name='_dontcare']").length < 1) {
+      $(form).append("<input type=\"hidden\" name=\"_dontcare\">")
+    }
+
+    var formdata = new FormData($(form)[0])
+    $.ajax({
+      method: method,
+      url: action,
+      dataType: "json",
+      data: formdata,
+      contentType: false,
+      processData: false,
+      success: function (response, status, xhr) {
+
+        clear_deafult_message(form);
+        var message_box = $(form).parent().find(".messages")[0];
+        if (!$(message_box).find(".custom_message").length > 0) {
+          print_results(message_box, response.messages);
+        }
+
+        $(form).trigger("successed");
+        $(message_box).addClass('ok');
+        $(form).trigger("reset");
+
+      },
+      error: function (xhr, status, errorThrown) {
+        var response = JSON.parse(xhr.responseText);
+        var message_box = $(form).parent().find(".messages")[0];
+        clear_deafult_message(form);
+        print_results(message_box, response.messages);
+        $(form).trigger("failed", [xhr, status, errorThrown]);
+        $(message_box).addClass('ko');
+        add_errors(form, response.errors);
+
+      },
+      complete: function () {
+        if (!recaptha_disabled) {
+          grecaptcha.reset();
+        }
+        $(form).find("input[type='submit']").attr("disabled", false);
+        hide_loader(form);
+      }
+    });
+  }
+
+  load_invisible_recaptcha = function () {
+
+
+    $(document).ready(function () {
+
+
+
+      $(".ajax_forms").each(function (element, index) {
+
+        var form = this;
+        var action = $(this).attr("action");
+        var method = $(this).attr("method");
+        var submit_button = $(form).find(".submit").last();
+
+
+        if (!recaptha_disabled) {
+          var container_div = $('<div class="invisible_recaptcha_container"></div>');
+          $(submit_button).before(container_div);
+
+          var widget_id = grecaptcha.render(container_div[0], {
+            'sitekey': '<%= Recaptcha.configuration.site_key! %>',
+            'badge': 'inline',
+            'size': 'invisible',
+            'callback': function () {
+              submit_function(form, method, action);
+            }
+          });
+
+          $(form).data("widget-id",widget_id)
+
+        }
+
+        $(form).children('.ajax_forms_loader').fadeOut();
+      });
+
+      $(document).on("submit", ".ajax_forms", function (event) {
+
+        event.preventDefault ? event.preventDefault() : (event.returnValue = false);
+
+        var form = $(event.target);//.closest("form");
+        var action = $(form).attr("action");
+        var method = $(form).attr("method");
+        var widget_id = $(form).data("widget-id");
+        // disable all submit buttons
+        $(form).find("input[type='submit']").attr("disabled", true)
+
+
+        if (!recaptha_disabled) {
+          grecaptcha.execute(widget_id)
+        } else {
+          submit_function(form, method, action);
+        }
+
+
+      });
+
+      $('.ajax_forms').on('change', '.invalid', function () {
+        $(this).removeClass("invalid");
+        $(this).parent().children('.error-message').hide();
+      });
+
+    });
+  };
+  $.getScript("//www.google.com/recaptcha/api.js?onload=load_invisible_recaptcha&render=explicit")
+
+
+})(jQuery);