hungryform 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a3eb50bf1ab74b3a5540384c4985bdaa0320666
-  data.tar.gz: 97110432dcc56453c65f81b1df816fc8a4dd1019
+  metadata.gz: 4c86c2c1ea0c43d499e7e0ace99b385e64f9f907
+  data.tar.gz: f12a4223b04ba00cf056c3ec9f1ff135b4abb6c5
 SHA512:
-  metadata.gz: bb6ca009dcf1d557b5485e76810dd2d3001debea174634e125de56ceccc797a3d84153b2fe51ade45082d3d79d393c5e23d82ad2c7b5f2876e696fcdbcfc79b6
-  data.tar.gz: b63768d3bca0af1a22b5c1845f80bd5fc770f77ced167cc4d42cf62f03f75cb972f9aaebd79a31ba8c72d50bd807b36bd425d17c8fc2b2a04cb5633b2c949669
+  metadata.gz: 528cf1d7b5809415a13b518526fcef94ab2a48e379e8870b398a582694c230c3222c19ccf603d4f0c51419192a257a123086e552e426a0a92fe862b2e85f8a07
+  data.tar.gz: 37600c6257d3b50c5b456f8a534c7abde7c14a6024b19aa12d564286684f21f0c847103cf7978865ee38b96e6841f9f0f07a95ed9a3b8c4290d7b06ea85fba0e

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    hungryform (0.0.1)
+    hungryform (0.0.2)
       activesupport
-      hashie
 
 GEM
   remote: https://rubygems.org/
@@ -15,7 +14,6 @@ GEM
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     diff-lcs (1.2.5)
-    hashie (3.3.1)
     i18n (0.6.11)
     json (1.8.1)
     minitest (5.4.2)
@@ -43,4 +41,4 @@ DEPENDENCIES
   bundler (~> 1.6)
   hungryform!
   rake
-  rspec
+  rspec (~> 3.0)

data/README.md

@@ -1,24 +1,127 @@
 # HungryForm
 
-TODO: Write a gem description
+HungryForm is a gem for managing multiple page forms. The main purpose of this gem is to give developers an easy DSL to build complex forms.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+```ruby
+require 'hungryform'
 
-    gem 'hungryform'
+form = HungryForm.new do
+  page :first do
+    text_field :first_name
+    text_field :last_name
+  end
+  page :second, do 
+    text_field :address
+  end
+  page :third do 
+    text_field :occupation
+    
+    # Show this group only when the occupation field is not empty
+    group :employment_history, visible: false, dependency: '{"SET": "third_occupation"}' do
+      html :before, value: "Employment history over the last 5 years"
+      text_field :history, value: "Default value"
+    end
+  end 
+end
+```
 
-And then execute:
+To assign values to the form elements pass them as a hash on form initialization. The params hash must consist of elements names and their values. Please note, that the elements names must contain the full path to the element, starting from the page name.
 
-    $ bundle
+```ruby
+params = {
+  "first_first_name" => "John",
+  "first_last_name" => "Doe",
+  "second_address" => "John's address",
+  "third_occupation" => "Software engineer",
+  "third_employment_history_history" => "John's employment hisotory"
+}
 
-Or install it yourself as:
+form = HungryForm.new :params => params do
+...
+end
 
-    $ gem install hungryform
+```
 
-## Usage
+You can assign default value to a form element:
+
+```ruby
+text_field :email, value: "john.doe@yahoo.com"
+```
+## Dependencies
+
+Each element of HungryForm, including pages and groups, can have a dependency parameter. This parameter must be a json string with an expression, that resolves to a boolean result. Within this expression you can use and combine the following operators, creating complex dependencies that can involve multiple elements:
+
+```json
+# val1 == val2
+{"EQ": ["val1", "val2"]}
+
+# val1 > val2
+{"GT": ["val1", "val2"]}
+
+# val1 < val2
+{"LT": ["val1", "val2"]}
+
+# val1 is not empty
+{"SET": "val1"}
+
+# Get the opposite result of the expression
+{"NOT": {"EQ": ["1", "1"]}}
+
+# Check if all the expressions are true
+{"AND": [
+  {"EQ": ["1", "1"]},
+  {"EQ": ["2", "2"]}
+]}
+
+# Check if any of the expressions is true
+{"OR": [
+  {"NOT": {"EQ": ["1", "1"]}},
+  {"EQ": ["2", "2"]}
+]}
+```
+
+If the dependency is resolved positively it makes the element visible. Otherwise the element will be hidden and not required. It is allowed to use element names or params keys as parameters inside expressions.
+
+```ruby
+HungryForm.new do
+  page :about do
+    text_field :age
+    text_field :favourite_alcohol, required: true, dependency: '{"GT": ["about_age", "18"]}'
+  end
+end
+    
+```
+
+## Validation
+
+Each active element of a form can be assigned with validation rules.
+
+- required - accepts boolean or proc
+- validation - accepts proc
+
+```ruby
+text_field :name, required: true
+text_field :email, validation: ->(el) { "is unexpected email" unless el.value == "me@yahoo.com"  }
+```
+
+You can extend the list of validation rules by opening the HungryForm::Validator singleton class and creating your own validation methods:
 
-TODO: Write usage instructions here
+```ruby
+class HungryForm
+  class Validator
+    class << self
+      def my_validation_method(element, rule)
+        "is not #{rule}" unless element.value == rule
+      end
+    end
+  end
+end
+  
+  
+text_field :vegetable, value: "tomato", my_validation_method: "potato" # => is not potato
+```
 
 ## Contributing
 

data/hungryform.gemspec

@@ -2,7 +2,6 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hungryform/version'
-require 'json'
 
 Gem::Specification.new do |spec|
   spec.name          = "hungryform"
@@ -22,5 +21,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "activesupport"
-  spec.add_dependency "hashie", "~> 3.3"
 end

data/lib/hungryform.rb

@@ -1,6 +1,5 @@
-require 'active_support'
+require 'json'
 require 'active_support/core_ext/string/inflections'
-require 'hashie'
 require "hungryform/version"
 require "hungryform/resolver"
 require "hungryform/validator"
@@ -31,12 +30,14 @@ require "hungryform/elements"
 class HungryForm
   HungryFormException = Class.new(StandardError)
 
-  attr_reader :current_page, :pages
+  attr_reader :pages
 
   def initialize(options = {}, &block)
     raise HungryFormException, 'No form structure block given' unless block_given?
+
     @resolver = Resolver.new(options.slice(:params))
     @pages = []
+
     instance_eval(&block)
   end
 
@@ -49,6 +50,7 @@ class HungryForm
   # Entire form validation. Loops through the form pages and validates each page
   def valid?
     is_valid = true
+
     pages.each do |page|
       #Loop through pages to get all errors
       is_valid = false if page.invalid?
@@ -60,4 +62,20 @@ class HungryForm
   def invalid?
     !valid?
   end
+
+  # Get all the elements that the form consists of
+  def elements
+    @resolver.elements
+  end
+
+  # Create a JSON string from the form elements (name => value)
+  def to_json
+    elements_hash = {}
+
+    self.elements.each do |name, el|
+      elements_hash[name] = el.value if el.is_a?(BaseActiveElement)
+    end
+    
+    JSON.generate(elements_hash)
+  end
 end

data/lib/hungryform/elements.rb

@@ -1,7 +1,9 @@
 require_relative 'elements/base_element'
 require_relative 'elements/base_active_element'
+require_relative 'elements/base_options_element'
 require_relative 'elements/base_group'
 require_relative 'elements/page'
 require_relative 'elements/group'
 require_relative 'elements/html'
-require_relative 'elements/text_field'
+require_relative 'elements/text_field'
+require_relative 'elements/select'

data/lib/hungryform/elements/base_active_element.rb

@@ -1,21 +1,24 @@
 class HungryForm
   class BaseActiveElement < BaseElement
-    attr_accessor :error
+    
+    attr_accessor :error, :value, :required
+    alias_method :required?, :required
 
     def initialize(name, parent, resolver, options = {}, &block)
       super
+
       self.error = ''
 
       # Filter only the options that are present in the HungryForm::Validator singleton class
       @validation_rules = options.select { |key, val| HungryForm::Validator.respond_to?(key) }
 
-      self.required = false unless parent.visible?
-
-      if options.has_key?(:params)
-        self.value = options[:params][self.name] || ''
+      if parent.visible?
+        self.required = options[:required] || false
       else
-        self.value = ''
+        self.required = false 
       end
+
+      self.value = resolver.params.has_key?(self.name)? resolver.params[self.name] : options[:value]
     end
 
     def valid?
@@ -24,6 +27,7 @@ class HungryForm
       return true if !visible?
 
       is_valid = true
+
       @validation_rules.each do |key, rule|
         error = HungryForm::Validator.send(key, self, rule) || ''
         unless error.empty?
@@ -34,5 +38,7 @@ class HungryForm
 
       is_valid
     end
+
+    
   end
 end

data/lib/hungryform/elements/base_element.rb

@@ -1,22 +1,34 @@
 class HungryForm
-  class BaseElement < ::Hashie::Mash
-    attr_accessor :name, :placeholders, :resolver
+  class BaseElement
+    attr_accessor :name, :placeholders, :resolver, :visible, :label, :dependency
+    alias_method :visible?, :visible
 
     def initialize(name, parent, resolver, options = {})
-      self.placeholders ||= {}
-      self.resolver = resolver
+      @_options = options
 
-      super(options)
+      @placeholders ||= {}
+      @resolver = resolver
 
-      self.visible = true unless self.key?(:visible)
-      self.visible &&= resolver.resolve_dependency(::JSON.parse(self.dependency)) if self.key?(:dependency)
+      # The element is visible if no visible parameter passed or
+      # visible param equals true and the dependency is resolved positively
+      self.visible = options.has_key?(:visible)? options[:visible] : true
+      self.visible &&= resolver.resolve_dependency(::JSON.parse(options[:dependency])) if options[:dependency]
+      self.dependency = options[:dependency] || ''
       self.name = (parent.nil?? "" : "#{parent.name}_") + resolver.get_value(name, self)
 
-      if self.key?(:label)
-        self.label = resolver.get_value(self.label, self)
-      else
+      unless options[:label]
         self.label = resolver.get_value(name, self).humanize
+      else
+        self.label = resolver.get_value(options[:label], self)
       end
     end
+
+    def method_missing(name, *args, &block)
+      # Check if an option exists
+      return @_options.has_key?(name.to_s[0..-2].to_sym) if name.to_s[-1] == '?'
+      # Return an option
+      return @_options[name] if @_options.has_key?(name)
+      super
+    end
   end
 end

data/lib/hungryform/elements/base_group.rb

@@ -26,18 +26,13 @@ class HungryForm
       raise HungryFormException, 'No group structure block given' unless block_given?
 
       super
-
-      self.name = parent.nil?? name : "#{parent.name}_#{name}"
-      self.elements = []
-      self.errors = {}
+      
+      @elements = []
+      @errors = {}
 
       instance_eval(&block)
     end
 
-    def group(name, options = {}, &block)
-      elements << HungryForm::Group.new(name, self, @resolver, options, &block)
-    end
-
     # Validates an entire group. If a group consists of nested groups
     # they will be validated recursively
     def valid?
@@ -69,7 +64,7 @@ class HungryForm
       return super if klass.nil?
 
       # Create a new element based on a symbol provided and push it into the group elements array
-      element = HungryForm::const_get(klass).send(:new, *([args[0], self, @resolver, args[1..-1]].flatten), &block)
+      element = HungryForm::const_get(klass).send(:new, args[0], self, @resolver, *(args[1..-1]), &block)
       elements << element
 
       #Resolver keeps a hash of all elements of the form

data/lib/hungryform/elements/group.rb

@@ -1,8 +1,4 @@
 class HungryForm
   class Group < BaseGroup
-    def initialize(name, parent, resolver, options = {}, &block)
-      super
-      instance_eval(&block)
-    end
   end
 end

data/lib/hungryform/resolver.rb

@@ -2,7 +2,7 @@ class HungryForm
   # The class is responsible for dependency resolving.
   # It contains all form elements and params
   class Resolver
-    attr_accessor :elements
+    attr_accessor :elements, :params
 
     def initialize(options = {})
       @params = options[:params] || {}

data/lib/hungryform/validator.rb

@@ -1,13 +1,22 @@
 class HungryForm
   class Validator
     class << self
+      # Check if the element's value is not empty.
+      # The rule argument can be a boolean or a callable object
       def required(element, rule)
         if rule.respond_to? :call
-          return rule.call(element)
+          rule.call(element)
         else
-          return "is required" if element.value.to_s.empty? && rule
+          "is required" if element.value.to_s.empty? && rule
         end
       end
+
+      # Custom validation check
+      # Use when you need to create a custom validation in the structure
+      def validation(element, callable)
+        raise HungryFormError "Validation must respond to call" unless callable.respond_to? :call
+        callable.call(element)
+      end
     end
   end
 end

data/lib/hungryform/version.rb

@@ -1,3 +1,3 @@
 class HungryForm
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/elements/html_spec.rb

@@ -1,7 +1,9 @@
 require "spec_helper"
 
 describe HungryForm::Html do
-  it_behaves_like "an element"
+  it_behaves_like "an element" do
+    let(:element_options) { {} }
+  end
 
   describe ".new" do
     let(:resolver) { HungryForm::Resolver.new() }

data/spec/elements/text_field_spec.rb

@@ -1,5 +1,7 @@
 require "spec_helper"
 
 describe HungryForm::TextField do
-  it_behaves_like "an active element"
+  it_behaves_like "an active element" do
+    let(:active_element_options) { {} }
+  end
 end

data/spec/hungryform_spec.rb

@@ -1,17 +1,38 @@
 require "spec_helper"
 
 describe HungryForm do
-  describe ".new" do
-    subject(:form) { HungryForm.new {
-      page :first do 
+  let(:options) do
+    {
+      :params => {
+        "first_first_name" => "John", 
+        "first_last_name" => "Doe", 
+        "second_email" => "john.doe@yahoo.com", 
+        "third_occupation" => "Software developer"
+      } 
+    } 
+  end
+
+  subject(:form) do
+    HungryForm.new(options) do
+      page :first do
+        text_field :first_name
+        text_field :last_name
       end
       page :second, visible: false do 
+        text_field :email
       end
       page :third do 
+        text_field :occupation
+        group :employment_history do
+          html :before, value: "Employment history over the last 5 years"
+          text_field :history, value: "Default value"
+        end
       end
-    } }
+    end 
+  end
 
-    it "should contain 2 pages" do
+  describe ".new" do
+    it "should contain pages" do
       expect(subject.pages.size).to eq 2
     end
   end
@@ -24,4 +45,11 @@ describe HungryForm do
       expect(form.pages.first.class).to eq HungryForm::Page
     end
   end
+
+  describe "#to_json" do
+    it "should create a json string from the form objects" do
+      form_elements_hash = options[:params].merge({"third_employment_history_history" => "Default value"})
+      expect(form.to_json).to eq(JSON.generate(form_elements_hash))
+    end
+  end
 end

data/spec/resolver_spec.rb

@@ -4,7 +4,18 @@ describe HungryForm::Resolver do
   let(:resolver_params) { {:params => {}} }
   subject(:resolver) { HungryForm::Resolver.new(resolver_params) }
 
-  describe ".get_value" do
+  describe ".new" do
+    it "should initialize resolver empty params" do
+      expect(subject.params).to eq({})
+    end
+
+    it "should initialize resolver params" do
+      resolver_params[:params] = {"key" => "value"}
+      expect(subject.params).to eq({"key" => "value"})
+    end
+  end
+
+  describe "#get_value" do
     let(:element) { HungryForm::Html.new(:html_name, nil, resolver, { value: "value" }) {} }
 
     it "should get value from lambda param" do
@@ -27,7 +38,7 @@ describe HungryForm::Resolver do
     end
   end
 
-  describe ".resolve_dependency" do
+  describe "#resolve_dependency" do
     it "should resolve EQ dependency" do
       dependency = { "EQ" => ["Text", "Text"] }
       expect(subject.resolve_dependency(dependency)).to eq true

data/spec/support/shared_active_element.rb

@@ -1,13 +1,15 @@
 RSpec.shared_examples "an active element" do
-  let(:resolver) { HungryForm::Resolver.new() }
+  let(:resolver_options) { {} }
+  let(:resolver) { HungryForm::Resolver.new(resolver_options) }
   
   let(:group_options) { {} }
   let(:group) { HungryForm::Group.new(:group, nil, resolver, group_options) {} }
 
-  let(:element_options) { {} }
-  let(:element) { described_class.new(:element_name, group, resolver, element_options) {} }
+  let(:element) { described_class.new(:element_name, group, resolver, active_element_options) {} }
 
-  it_behaves_like "an element"
+  it_behaves_like "an element" do
+    let(:element_options) { active_element_options }
+  end
 
   describe ".new" do
     it "should have empty error" do
@@ -16,15 +18,29 @@ RSpec.shared_examples "an active element" do
 
     it "should not be required if its parent is not visible" do
       group_options[:visible] = false
-      element_options[:required] = true
+      active_element_options[:required] = true
       expect(element.required?).to eq false
     end
+
+    it "should have a nil value" do
+      expect(element.value).to be nil
+    end
+
+    it "should have a value from form params" do
+      resolver_options[:params]= {"group_element_name" => "element_value" }
+      expect(element.value).to eq "element_value"
+    end
+
+    it "should have a value from element structure" do
+      active_element_options[:value] = "element_value"
+      expect(element.value).to eq "element_value"
+    end
   end
 
   describe "#valid?" do
     describe "when required" do
       before(:each) do
-        element_options[:required] = true
+        active_element_options[:required] = true
       end
 
       it "is valid" do

data/spec/support/shared_element.rb

@@ -3,7 +3,6 @@ RSpec.shared_examples "an element" do
   
   let(:group) { HungryForm::Group.new(:group, nil, resolver, {}) {} }
 
-  let(:element_options) { {} }
   let(:element) { described_class.new(:element_name, group, resolver, element_options) {} }
 
   describe "#visible?" do
@@ -22,12 +21,6 @@ RSpec.shared_examples "an element" do
         expect(element.visible?).to eq false
       end
 
-      it "should never be visible" do
-        element_options[:visible] = false
-        element_options[:dependency] = '{"EQ": ["1", "1"]}'
-        expect(element.visible?).to eq false
-      end
-
       it "should be visible" do
         element_options[:dependency] = '{"EQ": ["1", "1"]}'
         expect(element.visible?).to eq true
@@ -45,4 +38,17 @@ RSpec.shared_examples "an element" do
       expect(element.label).to eq "Special Label"
     end
   end
+
+  describe "#method_missing" do
+    it "should return existing param" do
+      element_options[:html_param] = "param"
+      expect(element.html_param).to eq "param"
+    end
+
+    it "should check whether param exists" do
+      element_options[:html_param] = "param"
+      expect(element.html_param?).to eq true
+      expect(element.other_html_param?).to eq false
+    end
+  end
 end

data/spec/support/shared_group.rb

@@ -6,7 +6,9 @@ RSpec.shared_examples "a group" do
   let(:group_options) { {} }
   let(:group) { described_class.new(:name, page, resolver, group_options) {} }
 
-  it_behaves_like "an element"
+  it_behaves_like "an element" do
+    let(:element_options) { group_options }
+  end
 
   describe "#group" do
     it "creates a nested group" do

data/spec/validator_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe HungryForm::Validator do
+  let(:resolver) { HungryForm::Resolver.new() }
+  let(:group) { HungryForm::Group.new(:group, nil, resolver, {}) {} }
+
+  let(:element_options) { {} }
+  let(:element) { HungryForm::TextField.new(:element_name, group, resolver, element_options) {} }
+
+  describe "required" do
+    it "should return nil when the element's value is present" do
+      element_options[:value] = "value"
+      expect(HungryForm::Validator.required(element, true)).to be nil
+    end
+
+    it "should return error when the element's value is not present" do
+      element_options[:value] = ""
+      expect(HungryForm::Validator.required(element, true)).to eq "is required"
+    end
+
+    it "should return the result of the custom required validation" do
+      element_options[:value] = "value"
+      expect(HungryForm::Validator.required(element, ->(el) { "not ok" if el.value != "custom" })).to eq "not ok"
+    end
+  end
+
+  describe "validation" do
+    it "should return the result of the custom validation" do
+      element_options[:value] = "value"
+      expect(HungryForm::Validator.validation(element, ->(el) { "not ok" if el.value != "custom" })).to eq "not ok"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hungryform
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrey Bazhutkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
 description: 
 email:
 - andrey.bazhutkin@gmail.com
@@ -117,6 +103,7 @@ files:
 - spec/support/shared_active_element.rb
 - spec/support/shared_element.rb
 - spec/support/shared_group.rb
+- spec/validator_spec.rb
 homepage: https://github.com/andrba/hungryform
 licenses:
 - MIT
@@ -152,3 +139,4 @@ test_files:
 - spec/support/shared_active_element.rb
 - spec/support/shared_element.rb
 - spec/support/shared_group.rb
+- spec/validator_spec.rb