hungryform-rails 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a38fbe1effb02a387bf5119e4db7a89eb3aaf878
-  data.tar.gz: ebc355dc8c070ef660fb45891b927602aac42ce3
+  metadata.gz: 5e1dbc3db77663b5d70ffed6dc331c8567ddb438
+  data.tar.gz: 68cb11ae8193f7047e1a4cd74b6c2ac0fe481f26
 SHA512:
-  metadata.gz: a2027d47d9bf11c2b46e2b424f282644cef5180d41cbe3f385cb1f80d1656fda846dfe82b8a46119a9f0a3b3a24d9bb835e660a6bc81aa9f075fd674d2fe5c77
-  data.tar.gz: e23f29f6152a65c01c219105d4aacf7124958ae4fa6a134faff741a38e76cb82ac1c1d279276446e476e27c21477d1cb188901a2f9d04bf53d3b9b00a80437e7
+  metadata.gz: 61346d2de43d07701d7375cb85f0982e789e90d752060ae205fadfc8a37b84fb947a898d5935bfdb83fd10148d0e2eb950372212222403b86d90c02df6c19337
+  data.tar.gz: 3b4da5e9334f8d65bf48a78fee4aa2fe873256fb245d1630ed5febe67a9d9709960dc56098e8d136f154fdc9bd47b0d5f1122de2b1ef61520a61553f063144cd

data/.gitignore

@@ -1,10 +1,12 @@
 *.gem
 *.rbc
+*.log
 /.config
 /coverage/
 /InstalledFiles
 /pkg/
 /spec/reports/
+/spec/dummy/tmp/
 /test/tmp/
 /test/version_tmp/
 /tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+install:
+  - 'travis_retry bundle install'
+
+gemfile:
+  - gemfiles/rails3
+  - gemfiles/rails4
+  - gemfiles/rails41
+  - gemfiles/rails42
+
+sudo: false
+
+cache: bundler
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hungryform-rails.gemspec
+gemspec

data/README.md

@@ -1 +1,37 @@
-# hungryform-rails
+#Hungryform Rails [![Build Status](https://travis-ci.org/andrba/hungryform-rails.svg?branch=master)](https://travis-ci.org/andrba/hungryform-rails)
+
+This gem is an adaptor between the HungryForm gem and Rails. 
+
+##Installation:
+
+Add the hungryform gem to your Gemfile:
+```ruby
+gem "hungryform-rails"
+```
+
+Add the Hungryform require to your application.js:
+```
+//= require hungryform
+```
+
+Add the Hungryform require to your application.css:
+```
+//= require hungryform
+```
+
+Use the following helper to generate the form in your views:
+
+```ruby
+<%= hungry_form_for(@form) %>
+```
+
+##Configuration
+
+This gem extends the configuration options provided by Hungryform. Create initializer in ```config/initializers/hungryform.rb``` and place the configuration code inside:
+
+```ruby
+Hungryform.configure do |config|
+  config.rails.elements_templates = 'hungryform'
+end
+```
+

data/Rakefile

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"

data/app/assets/javascripts/hungryform.js

@@ -0,0 +1,145 @@
+// Module to handle form interactions such as
+// prev, next links and dependency resolution
+(function($) {
+
+  function HungryForm(form) {
+    this.form = form;
+    this.$form = $(form);
+
+    this.init();
+  }
+
+  HungryForm.prototype = {
+    init: function() {
+      this.bindEvents();
+    },
+
+    bindEvents: function() {
+      var form_action = this.$form.find("input[name='form_action']"),
+          that = this;
+
+      this.$form.find(':input').on('change select', function() {
+        that.updateVisibility();
+      });
+
+      this.$form.find('input, select').keypress(function(event) { 
+        return event.keyCode !== 13; 
+      });
+
+      $("a[data-rel='" + this.$form.data('rel') + "'][data-form-action]").on('click', function(event) {
+        if ($(this).data('form-method') === 'get') {
+          return true;
+        }
+
+        event.preventDefault();
+
+        var action = $(this).data('form-action');
+        form_action.val(action);
+        that.$form.attr('action', $(this).attr('href'));
+        
+        that.$form.submit();
+      });
+    },
+
+    updateVisibility: function() {
+      var that = this;
+      this.$form.find('div[data-dependency], fieldset[data-dependency]').each(function() {
+        var obj = $(this);
+        var dependency = obj.data('dependency');
+        
+        if (that.resolveDependency(dependency)) {
+          that._setObjectVisibility(obj, true);
+        } else {
+          that._setObjectVisibility(obj, false);
+        }
+      });
+    },
+
+    resolveDependency: function(dependency) {
+      var isDependent = false;
+      var that = this;
+
+      $.each(dependency, function(operator, args) {
+        if (operator === 'eq') {
+          isDependent = that._isEqual(args);
+          return false;
+        } else if (operator === 'lt') {
+          isDependent = that._isLessThan(args);
+          return false;
+        } else if (operator === 'gt') {
+          isDependent = that._isGreaterThan(args);
+          return false;
+        } else if (operator === 'not') {
+          isDependent = !that.resolveDependency(args);
+          return false;
+        } else if (operator === 'is') {
+          isDependent = that._isSet(args);
+          return false;
+        } else if (operator === 'and') {
+          isDependent = true;
+          $.each(args, function(index, argument) {
+              isDependent = that.resolveDependency(argument) && isDependent;
+              if (isDependent === false) {
+                  //No need to check the rest of the dependencies
+                  return false;
+              }
+          });
+          return false;
+        } else if (operator === 'or') {
+          $.each(args, function(index, argument) {
+              isDependent = that.resolveDependency(argument) || isDependent;
+              if (isDependent === true) {
+                  //No need to check the rest of the dependencies
+                  return false;
+              }
+          });
+          return false;
+        }
+      });
+      
+      return isDependent;
+    },
+    _isEqual: function(args) {
+      return args.length > 1 && this._getArgument(args[0]).toString() === this._getArgument(args[1]).toString();
+    },
+    _isLessThan: function(args) {
+      return args.length > 1 && parseFloat(this._getArgument(args[0])) < parseFloat(this._getArgument(args[1]));
+    },
+    _isGreaterThan: function(args) {
+      return args.length > 1 && parseFloat(this._getArgument(args[0])) > parseFloat(this._getArgument(args[1]));
+    },
+    _isSet: function(args) {
+      return typeof(args[0]) !== 'undefined' && this._getArgument(args[0]).length > 0;
+    },
+    _getArgument: function(argument) {
+      var input = this.$form.find("input[name='" + argument + "'], textarea[name='" + argument + "'], select[name='" + argument + "']");
+      
+      if (input.length > 0) {
+        if (input.filter(':radio').length > 0) {
+          return input.filter(':radio:checked').length > 0? input.filter(':radio:checked').val() : '';
+        } else if (input.filter(':checkbox').length > 0) {
+          return input.filter(':checkbox:checked').length > 0? input.filter(':checkbox:checked').val() : '';
+        } else {
+          return input.val();
+        }
+      }
+      else {
+        return argument;
+      }
+    },
+    _setObjectVisibility: function(obj, visible) {
+      if (visible) {
+        obj.removeClass('hidden');
+      }
+      else {
+        obj.addClass('hidden');
+      }
+    }
+  };
+
+  $(function() {
+    $('form.hungryform').each(function() {
+      new HungryForm(this);
+    });
+  });
+}(jQuery));

data/app/assets/stylesheets/hungryform.css

@@ -0,0 +1,8 @@
+.hungryform .hidden {
+  display: none;
+}
+
+.hungryform .invalid span.error {
+  display: block;
+  color: #dc0024;
+}

data/app/views/hungryform/_checkbox_field.html.erb

@@ -0,0 +1,12 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+
+  concat label_tag field.name, field.label << ("*" if field.required?).to_s
+  concat hidden_field_tag field.name, 0
+  concat check_box_tag field.name, 1, field.checked?, field.attributes.except(:class, :checked)
+  unless field.error.empty?
+    concat content_tag :span, field.error, class: 'error' 
+  end
+  
+end %>
+
+<%= field.attributes.inspect %>

data/app/views/hungryform/_form.html.erb

@@ -0,0 +1,11 @@
+<%= hidden_field_tag :form_action %>
+
+<h1><%= form.current_page.label %></h1>
+
+<% form.current_page.elements.each do |el| %>
+  <%= render partial: "#{views_prefix}/#{el.class.name.demodulize.underscore}", locals: { field: el, views_prefix: views_prefix } %>
+<% end %>
+
+<%= hungry_link_to_prev_page(form, "Prev", method: :post) if form.prev_page %>
+<%= hungry_link_to_next_page(form, "Next", method: :post) if form.next_page %>
+<%= hungry_link_to_submit(form, "Submit") if form.current_page == form.pages.last %>

data/app/views/hungryform/_group.html.erb

@@ -0,0 +1,7 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+
+  field.elements.each do |el|
+    concat render partial: "#{views_prefix}/#{el.class.name.demodulize.underscore}", locals: { field: el, views_prefix: views_prefix }
+  end
+  
+end %>

data/app/views/hungryform/_html.html.erb

@@ -0,0 +1,5 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do -%>
+
+  <%= field.value.html_safe %>
+  
+<% end -%>

data/app/views/hungryform/_radio_group.html.erb

@@ -0,0 +1,11 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+
+  concat label_tag field.name, field.label << ("*" if field.required?).to_s
+  field.options.each do |key, value|
+    concat radio_button_tag key, value, field.value == value, field.attributes.except(:class)
+  end
+  unless field.error.empty?
+    concat content_tag :span, field.error, class: 'error' 
+  end
+
+end %>

data/app/views/hungryform/_select_field.html.erb

@@ -0,0 +1,9 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+
+  concat label_tag field.name, field.label << ("*" if field.required?).to_s
+  concat select_tag field.name, options_for_select(field.options.invert, field.value), field.attributes.except(:class)
+  unless field.error.empty?
+    concat content_tag :span, field.error, class: 'error' 
+  end
+
+end %>

data/app/views/hungryform/_text_area.html.erb

@@ -0,0 +1,9 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+    
+  concat label_tag field.name, field.label << ("*" if field.required?).to_s
+  concat text_area_tag field.name, field.value, field.attributes.except(:class)
+  unless field.error.empty?
+    concat content_tag :span, field.error, class: 'error' 
+  end
+    
+end %>

data/app/views/hungryform/_text_field.html.erb

@@ -0,0 +1,9 @@
+<%= content_tag :div, id: "#{field.name}_wrapper", class: field.html_class, 'data-dependency' => field.dependency_json do
+
+  concat label_tag field.name, field.label << ("*" if field.required?).to_s
+  concat text_field_tag field.name, field.value, field.attributes.except(:class)
+  unless field.error.empty?
+    concat content_tag :span, field.error, class: 'error' 
+  end
+  
+end %>

data/gemfiles/rails3.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.19'
+
+gemspec :path => '../'

data/gemfiles/rails4.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0.9'
+
+gemspec :path => '../'

data/gemfiles/rails41.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.5'
+
+gemspec :path => '../'

data/gemfiles/rails42.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+
+gemspec :path => '../'

data/hungryform-rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hungryform/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hungryform-rails"
+  spec.version       = HungryForm::Rails::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Andrey Bazhutkin"]
+  spec.email         = ["andrey.bazhutkin@gmail.com"]
+  spec.summary       = "Use HungryForm with Rails"
+  spec.description   = "A gem to automate using HungryForm with Rails"
+  spec.homepage      = "https://github.com/andrba/hungryform-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+  
+  spec.add_dependency 'hungryform',   '~> 0.0', '>= 0.0.9'
+  spec.add_dependency 'rails',        '>= 3.2.1'
+
+  spec.add_development_dependency "rspec",       '~> 3.0'
+  spec.add_development_dependency "rspec-rails", '~> 3.0'
+  spec.add_development_dependency "capybara",    '~> 2.4'
+  spec.add_development_dependency "poltergeist", '~> 1.6'
+end

data/lib/hungryform/rails/action_view.rb

@@ -0,0 +1,90 @@
+module HungryForm
+  module Rails
+    module ActionView
+      # Render a form
+      def hungry_form_for(form, options = {})
+        options[:data] ||= {}
+        options[:data][:rel] ||= form_rel(form)
+        options[:class] = [options[:class], "hungryform"].compact.join(' ')
+
+        views_prefix = options.delete(:views_prefix) || HungryForm.configuration.rails.elements_templates
+
+        form_tag('', options) do
+          render partial: "#{views_prefix}/form", locals: {
+            form: form,
+            views_prefix: views_prefix
+          }
+        end
+      end
+
+      # Render a link to the next page
+      def hungry_link_to_next_page(form, name, options = {}, &block)
+        link_to name, *link_params(form, options, action: :next), &block
+      end
+
+      # Render a link to the previous page
+      def hungry_link_to_prev_page(form, name, options = {}, &block)
+        link_to name, *link_params(form, options, action: :prev), &block
+      end
+
+      # Render a link to a provided page
+      def hungry_link_to_page(form, page, options = {}, &block)
+        link_to page.label, *link_params(form, options, action: :page, page: page), &block
+      end
+
+      # Render a link that submits the form
+      def hungry_link_to_submit(form, name, options = {}, &block)
+        params = clean_params(form, options.delete(:params))
+
+        link_to name, url_for(params), options.reverse_merge(
+          data: { form_method: :post, form_action: :submit, rel: form_rel(form) }
+        ), &block
+      end
+
+      private
+
+      # Form ralation attribute is used to streamline js selection of a form
+      # and its navigational elements like next/prev buttons and pages lists
+      def form_rel(form)
+        "hungry-form-#{form.__id__}"
+      end
+
+       # Builds link_to params except for the link's name
+      def link_params(form, options, action_options = {})
+        method = options.delete(:method) || 'get'
+        params = clean_params(form, options.delete(:params))
+
+        params[:page] = method.to_s == 'get' ? get_page(form, action_options) : form.current_page.name
+
+        options.reverse_merge!(
+          data: {
+            form_method: method,
+            form_action: action_options[:action],
+            rel: form_rel(form)
+          }
+        )
+
+        [url_for(params), options]
+      end
+
+      # Find the name of the page to go to when the 'get' method is used in a
+      # form navigation
+      def get_page(form, action_options)
+        case action_options[:action]
+        when :page
+          action_options[:page].name
+        when :next, :prev
+          form.send("#{action_options[:action]}_page").try(:name) || ''
+        end
+      end
+
+      # Remove Rails specific params from the params hash as well as
+      # all the form params
+      def clean_params(form, params)
+        rails_params = [:authenticity_token, :commit, :utf8, :_method]
+        form_params = form.elements.keys + [:form_action, :errors]
+        self.params.except(*(rails_params + form_params)).merge(params || {})
+      end
+    end
+  end
+end

data/lib/hungryform/rails/engine.rb

@@ -0,0 +1,6 @@
+module HungryForm
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/hungryform/rails/railtie.rb

@@ -0,0 +1,24 @@
+module HungryForm
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+      module Configuration
+        attr_accessor :rails
+      end
+
+      initializer 'hungryform', before: :load_config_initializers do
+        HungryForm::Elements::Base::Element.send :include, Renderable
+
+        HungryForm.configuration.extend Configuration
+        HungryForm.configuration.rails = ActiveSupport::OrderedOptions.new
+        HungryForm.configuration.rails.elements_templates = 'hungryform'
+      end
+
+      initializer 'active_support' do
+        ActiveSupport.on_load(:action_view) do
+          ::ActionView::Base.send :include, ActionView
+        end
+      end
+    end
+  end
+end

data/lib/hungryform/rails/renderable.rb

@@ -0,0 +1,13 @@
+module HungryForm
+  module Rails
+    module Renderable
+      def html_class
+        classes = []
+        classes << attributes[:class] if attributes[:class]
+        classes << 'hidden' unless visible?
+        classes << 'invalid' if self.is_a?(HungryForm::Elements::Base::ActiveElement) && self.error.present?
+        classes.join(' ') if classes.any?
+      end
+    end
+  end
+end

data/lib/hungryform/rails/version.rb

@@ -0,0 +1,5 @@
+module HungryForm
+  module Rails
+    VERSION = "0.0.3"
+  end
+end

data/lib/hungryform/rails.rb

@@ -0,0 +1,11 @@
+module HungryForm
+  module Rails
+  end
+end
+
+require 'hungryform'
+require 'hungryform/rails/version'
+require 'hungryform/rails/railtie'
+require 'hungryform/rails/engine'
+require 'hungryform/rails/action_view'
+require 'hungryform/rails/renderable'

data/lib/hungryform-rails.rb

@@ -0,0 +1 @@
+require 'hungryform/rails'

data/spec/action_view_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe HungryForm::Rails::ActionView, :type => :helper do
+  let(:form_params) { {} }
+  let(:form) do 
+    HungryForm::Form.new params: form_params do
+      page :first do
+        text_field :first_name
+        text_field :last_name
+      end
+
+      page :second do
+        text_field :email
+      end
+    end
+  end
+
+  before { helper.params.merge!(controller: 'hungry_form', action: 'show') }
+
+  describe '#hungry_link_to_next_page' do
+    let(:params) { {} }
+    subject { helper.hungry_link_to_next_page(form, "Next", params) }
+
+    it { is_expected.to include("data-rel=\"hungry-form-#{form.__id__}\"") }
+    it { is_expected.to include('data-form-action="next"') }
+
+    context 'when method is GET' do
+      it { is_expected.to include('/hungryform/second') }
+      it { is_expected.to include('data-form-method="get"') }
+    end
+
+    context 'when method is POST' do
+      before { params[:method] = :post }
+
+      it { is_expected.to include('/hungryform/first') }
+      it { is_expected.to include('data-form-method="post"') }
+    end
+  end
+
+  describe '#hungry_link_to_prev_page' do
+    let(:form_params) { { page: 'second' } }
+    let(:params) { {} }
+    subject { helper.hungry_link_to_prev_page(form, "Prev", params) }
+
+    it { is_expected.to include("data-rel=\"hungry-form-#{form.__id__}\"") }
+    it { is_expected.to include('data-form-action="prev"') }
+
+    context 'when method is GET' do
+      it { is_expected.to include('/hungryform/first') }
+      it { is_expected.to include('data-form-method="get"') }
+    end
+
+    context 'when method is POST' do
+      before { params[:method] = :post }
+      
+      it { is_expected.to include('/hungryform/second') }
+      it { is_expected.to include('data-form-method="post"') }
+    end
+  end
+
+  describe '#hungry_link_to_page' do
+    let(:params) { {} }
+    subject { helper.hungry_link_to_page(form, form.pages.last, params) }
+
+    it { is_expected.to include("data-rel=\"hungry-form-#{form.__id__}\"") }
+    it { is_expected.to include('data-form-action="page"') }
+
+    context 'when method is GET' do
+      it { is_expected.to include('/hungryform/second') }
+      it { is_expected.to include('data-form-method="get"') }
+    end
+
+    context 'when method is POST' do
+      before { params[:method] = :post }
+      
+      it { is_expected.to include('/hungryform/first') }
+      it { is_expected.to include('data-form-method="post"') }
+    end
+  end
+
+  describe '#hungry_form_for' do
+    subject { helper.hungry_form_for(form) }
+
+    it 'renders a form' do
+      expect(subject).to include('<form')
+      expect(subject).to include("data-rel=\"hungry-form-#{form.__id__}\"")
+      expect(subject).to match /<input(?=.*name="form_action")(?=.*id="form_action")/ #Mandatory hidden action field
+      expect(subject).to include('First name')
+      expect(subject).to include('Last name')
+      expect(subject).to include('Next')
+    end
+
+    it 'renders only a current page' do
+      expect(subject).to include('<h1>First</h1>')
+      expect(subject).not_to include('<h1>Second</h1>')
+    end
+  end
+
+  describe '#hungry_link_to_submit' do
+    let(:params) { {} }
+    subject { helper.hungry_link_to_submit(form, "Submit", params) }
+
+    it { is_expected.to include("data-rel=\"hungry-form-#{form.__id__}\"") }
+    it { is_expected.to include('data-form-action="submit"') }
+  end
+end