factoryform 0.1.0

data/History.txt

@@ -0,0 +1,20 @@
+=== 0.0.1 2010-08-23
+
+* 1 major enhancement:
+  * Initial release
+
+=== 0.0.2 2010-09-08
+
+* Other fields added:
+  * included boolean field, rating field
+  * field types like select_box, check_box, radio_button are included in MultipleChoice Class
+  
+
+* TODO: Coming up for next release:
+ * Include advanced field types (priority wise)
+	* FileUploadField
+	* GoogleMapField
+	* RecordVideoField
+	* RecordAudioField
+	* TakePhotoField
+NOTE:: Look for other options as well (Ref: formtastic.com, wufoo.com)

data/README.rdoc

@@ -0,0 +1,2 @@
+= form
+This is an API for interacting with simple HTML form

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "factoryform"
+    s.summary = "This is an API for interacting with simple HTML form."
+    s.description = "This is an API for interacting with simple HTML form."
+    s.email = "info@sproutify.com"
+    s.homepage = "http://github.com/sprout/factoryform"
+    s.authors = ["sprout"]
+    s.add_development_dependency("json_pure","~> 1.4.3")
+    s.add_runtime_dependency(%q<json_pure>, "~> 1.4.3")
+  end
+  
+  Jeweler::GemcutterTasks.new
+
+  require "rake/testtask"
+  Rake::TestTask.new(:test) do |test|
+    test.libs << "test"
+    test.ruby_opts << "-rubygems"
+    test.pattern = "test/**/*_test.rb"
+    test.verbose = true
+  end
+  
+task :default  => :test
+  
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "factoryform #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/factoryform.gemspec

@@ -0,0 +1,144 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{factoryform}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sprout"]
+  s.date = %q{2010-10-01}
+  s.description = %q{This is an API for interacting with simple HTML form.}
+  s.email = %q{info@sproutify.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "factoryform.gemspec",
+     "init.rb",
+     "lib/factoryform.rb",
+     "lib/factoryform/boolean.rb",
+     "lib/factoryform/currency.rb",
+     "lib/factoryform/date_answer.rb",
+     "lib/factoryform/descriptive_content.rb",
+     "lib/factoryform/email.rb",
+     "lib/factoryform/field.rb",
+     "lib/factoryform/form.rb",
+     "lib/factoryform/image_data.rb",
+     "lib/factoryform/long_answer.rb",
+     "lib/factoryform/multiple_choice.rb",
+     "lib/factoryform/number.rb",
+     "lib/factoryform/rating.rb",
+     "lib/factoryform/short_answer.rb",
+     "lib/factoryform/text_data.rb",
+     "lib/factoryform/time_answer.rb",
+     "lib/factoryform/url.rb",
+     "lib/factoryform/utils.rb",
+     "rdoc/classes/Array.html",
+     "rdoc/classes/FactoryForm.html",
+     "rdoc/classes/FactoryForm/Boolean.html",
+     "rdoc/classes/FactoryForm/Currency.html",
+     "rdoc/classes/FactoryForm/DateAnswer.html",
+     "rdoc/classes/FactoryForm/DescriptiveContent.html",
+     "rdoc/classes/FactoryForm/DuplicateIDException.html",
+     "rdoc/classes/FactoryForm/Email.html",
+     "rdoc/classes/FactoryForm/Field.html",
+     "rdoc/classes/FactoryForm/Form.html",
+     "rdoc/classes/FactoryForm/ImageData.html",
+     "rdoc/classes/FactoryForm/LongAnswer.html",
+     "rdoc/classes/FactoryForm/MultipleChoice.html",
+     "rdoc/classes/FactoryForm/Number.html",
+     "rdoc/classes/FactoryForm/ParameterExpectedException.html",
+     "rdoc/classes/FactoryForm/Rating.html",
+     "rdoc/classes/FactoryForm/ShortAnswer.html",
+     "rdoc/classes/FactoryForm/TextData.html",
+     "rdoc/classes/FactoryForm/TimeAnswer.html",
+     "rdoc/classes/FactoryForm/Url.html",
+     "rdoc/created.rid",
+     "rdoc/files/README_rdoc.html",
+     "rdoc/files/lib/factoryform/boolean_rb.html",
+     "rdoc/files/lib/factoryform/currency_rb.html",
+     "rdoc/files/lib/factoryform/date_answer_rb.html",
+     "rdoc/files/lib/factoryform/descriptive_content_rb.html",
+     "rdoc/files/lib/factoryform/email_rb.html",
+     "rdoc/files/lib/factoryform/field_rb.html",
+     "rdoc/files/lib/factoryform/form_rb.html",
+     "rdoc/files/lib/factoryform/image_data_rb.html",
+     "rdoc/files/lib/factoryform/long_answer_rb.html",
+     "rdoc/files/lib/factoryform/multiple_choice_rb.html",
+     "rdoc/files/lib/factoryform/number_rb.html",
+     "rdoc/files/lib/factoryform/rating_rb.html",
+     "rdoc/files/lib/factoryform/short_answer_rb.html",
+     "rdoc/files/lib/factoryform/text_data_rb.html",
+     "rdoc/files/lib/factoryform/time_answer_rb.html",
+     "rdoc/files/lib/factoryform/url_rb.html",
+     "rdoc/files/lib/factoryform/utils_rb.html",
+     "rdoc/files/lib/factoryform_rb.html",
+     "rdoc/fr_class_index.html",
+     "rdoc/fr_file_index.html",
+     "rdoc/fr_method_index.html",
+     "rdoc/index.html",
+     "rdoc/rdoc-style.css",
+     "test/boolean_test.rb",
+     "test/currency_test.rb",
+     "test/date_answer_test.rb",
+     "test/descriptive_content_test.rb",
+     "test/field_test.rb",
+     "test/form_test.rb",
+     "test/image_data_test.rb",
+     "test/long_answer_test.rb",
+     "test/multiple_choice_test.rb",
+     "test/number_test.rb",
+     "test/rating_test.rb",
+     "test/short_answer_test.rb",
+     "test/test_helper.rb",
+     "test/text_data_test.rb",
+     "test/time_answer_test.rb",
+     "test/url_test.rb"
+  ]
+  s.homepage = %q{http://github.com/sprout/factoryform}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{This is an API for interacting with simple HTML form.}
+  s.test_files = [
+    "test/boolean_test.rb",
+     "test/currency_test.rb",
+     "test/date_answer_test.rb",
+     "test/descriptive_content_test.rb",
+     "test/field_test.rb",
+     "test/form_test.rb",
+     "test/image_data_test.rb",
+     "test/long_answer_test.rb",
+     "test/multiple_choice_test.rb",
+     "test/number_test.rb",
+     "test/rating_test.rb",
+     "test/short_answer_test.rb",
+     "test/test_helper.rb",
+     "test/text_data_test.rb",
+     "test/time_answer_test.rb",
+     "test/url_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<json_pure>, ["~> 1.4.3"])
+      s.add_runtime_dependency(%q<json_pure>, ["~> 1.4.3"])
+    else
+      s.add_dependency(%q<json_pure>, ["~> 1.4.3"])
+      s.add_dependency(%q<json_pure>, ["~> 1.4.3"])
+    end
+  else
+    s.add_dependency(%q<json_pure>, ["~> 1.4.3"])
+    s.add_dependency(%q<json_pure>, ["~> 1.4.3"])
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+# require 'form_library'

data/lib/factoryform.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__),'factoryform/form')
+require File.join(File.dirname(__FILE__),'factoryform/field')
+require File.join(File.dirname(__FILE__),'factoryform/short_answer')
+require File.join(File.dirname(__FILE__),'factoryform/long_answer')
+require File.join(File.dirname(__FILE__),'factoryform/multiple_choice')
+require File.join(File.dirname(__FILE__),'factoryform/utils')
+require File.join(File.dirname(__FILE__),'factoryform/text_data')
+require File.join(File.dirname(__FILE__),'factoryform/image_data')
+require File.join(File.dirname(__FILE__),'factoryform/date_answer')
+require File.join(File.dirname(__FILE__),'factoryform/email')
+require File.join(File.dirname(__FILE__),'factoryform/number')
+require File.join(File.dirname(__FILE__),'factoryform/url')
+require File.join(File.dirname(__FILE__),'factoryform/time_answer')
+require File.join(File.dirname(__FILE__),'factoryform/boolean')
+require File.join(File.dirname(__FILE__),'factoryform/currency')
+require File.join(File.dirname(__FILE__),'factoryform/rating')
+require File.join(File.dirname(__FILE__),'factoryform/descriptive_content')
+
+
+module FactoryForm
+  # Raised when FactoryForm::TextData.new doesn't include a required parameter
+  class ParameterExpectedException < RuntimeError
+
+  end
+end

data/lib/factoryform/boolean.rb

@@ -0,0 +1,17 @@
+module FactoryForm
+  class Boolean < Field
+    attr_accessor :values # True/false values
+
+    def initialize(options={})
+      self.values = options[:values] = [true, false]
+      options[:field_type] = "boolean"
+
+      super(options)
+      
+      # Unique is always false
+      self.unique = false
+
+    end
+  end
+end
+

data/lib/factoryform/currency.rb

@@ -0,0 +1,7 @@
+module FactoryForm
+  class Currency < Field 
+    # TODO: Need to think about it
+    
+    
+  end
+end

data/lib/factoryform/date_answer.rb

@@ -0,0 +1,10 @@
+module FactoryForm
+  class DateAnswer < ShortAnswer 
+    def initialize(options={})
+      options[:field_type] = "date_answer"
+      super(options)
+      @validation_format = "date"
+    end
+  end
+end
+

data/lib/factoryform/descriptive_content.rb

@@ -0,0 +1,17 @@
+module FactoryForm
+  class DescriptiveContent 
+    attr_reader :id
+    attr_accessor :label, :value
+
+    def initialize(options = {})
+      unless options.empty? || options[:id].empty? || options[:label].empty?
+        @id, @label, @value = options[:id], options[:label], options[:value] || options[:label]
+      else
+        raise(ParameterExpectedException, "Missing ID and label")
+      end
+    end
+
+  end
+end
+
+

data/lib/factoryform/email.rb

@@ -0,0 +1,11 @@
+module FactoryForm
+  class Email < ShortAnswer 
+    def initialize(options={})
+      options[:field_type] = "short_answer"      
+      super(options)
+      @validation_format = "email"
+      # extra attributes for ShortAnswer
+    end
+  end
+  
+end

data/lib/factoryform/field.rb

@@ -0,0 +1,29 @@
+module FactoryForm
+  # Field is simply a hash of different attributes 
+  class Field
+    attr_reader :id
+    attr_accessor :label, :hint, :required, :unique, :validation_format, :field_type
+
+    def initialize(options)
+      unless options.nil? || options[:id].nil? || options[:label].nil?
+        extra_options = options[:options] || { }
+        extra_options.merge!({
+          # defaults
+          :hint => extra_options[:hint] || " ",
+          :required => extra_options[:required] || true,
+          :unique => extra_options[:unique] || false,
+          :validation_format => extra_options[:validation_format] || "general",
+          })
+          options.merge!({:options => extra_options})
+
+          @id, @label, @hint, @required, @unique, @validation_format, @field_type = options[:id], options[:label],options[:options][:hint], options[:options][:required], options[:options][:unique], options[:options][:validation_format], options[:field_type]
+        else
+          raise(ParameterExpectedException, "Missing ID and label")
+        end
+      end
+  end
+end
+
+
+
+

data/lib/factoryform/form.rb

@@ -0,0 +1,127 @@
+require 'yaml'
+require 'rubygems'
+require 'json/pure' unless defined?(JSON::State)
+require File.join(File.dirname(__FILE__),'utils')
+require 'rexml/document'
+
+module FactoryForm
+  # Form is simply an ordered array of fields. Each Field is simply a hash of field options.
+  class Form 
+    attr_accessor :title, :fields
+
+    def initialize(options = {})
+      @title = options[:title] || ""
+      @fields = Array.new
+    end
+
+    # Add field object
+    def add(field, position=@fields.length)
+      # Check for duplicate ID
+      unless get_ids.include?(field.id)
+        @fields.insert(position, field)
+      else
+        raise(DuplicateIDException, "Duplicate ID")
+      end
+
+    end
+
+    # Get field object by ID  
+    # form.get(:id => "email_1")
+    # TODO:: Get element by other attributes as well
+    def get(option)
+      # @fields[@fields.index(option)]
+      @fields[get_ids.index(option[:id])]
+    end
+
+    # Remove field object
+    def remove(field)
+      @fields.delete(field)
+    end
+
+    def move_up(field, steps = 1)
+      @fields.move_object(field, @fields.index(field) - steps)
+    end
+
+    def move_down(field, steps = 1)
+      @fields.move_object(field, @fields.index(field) + steps)
+    end  
+
+    def move_to_position(field, position)
+      @fields.move_object(field, position)
+    end
+
+    def add_to_position(field, position)
+      @fields.insert(position, field)  
+    end
+
+    def to_yml
+      self.to_yaml
+    end
+
+    def to_json
+      fields = Array.new
+      @fields.each do |f|
+        attributes = f.instance_variables.map{|a| a.gsub("@","")}
+        attributes_hash = {}
+        attributes.each do |a|
+          attributes_hash[a] = f.send(a)
+        end
+        fields << {f.class.name => attributes_hash }  
+      end
+      fields
+      fields.to_json
+    end
+
+    def to_xml
+      doc = REXML::Document.new
+      root = doc.add_element("Form")
+
+      title_element = root.add_element("Title")
+      title_element.add_text("#{self.title}")
+
+      out_string = ''
+      @fields.each {|field|
+        field_element = root.add_element("Field")
+        field_type_element = field_element.add_element("#{field.class.name}")
+
+        field_type_element.add_attribute("id", field.id)
+        field_type_element.add_attribute("label", field.label)
+
+        attributes = field.instance_variables.map{|a| a.gsub("@","")}
+        attributes.each do |attrb|
+          attrb_element = field_type_element.add_element("#{attrb}")
+
+          # For option values of Multiple choice, separate them as option tags
+          if attrb == "values"
+            field.send(attrb).each do |option|
+              option_element = attrb_element.add_element("option")
+              option_element.add_text(option)
+            end
+          else
+            attrb_element.add_text(field.send(attrb).to_s)
+          end  
+        end
+
+        doc.write( out_string = "\n"+'<?xml version="1.0" encoding="UTF-8"?>'+"\n", 2 )
+
+      }
+      return out_string
+    end
+
+    private
+
+    # List of all IDs
+    def get_ids
+      @fields.map(& :id)
+    end
+
+  end
+
+  # Raised if the field with the same ID already exists
+  class DuplicateIDException < RuntimeError
+
+  end
+  
+end
+
+