survey_on_rails 0.3.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzViYWEzNzg5ZGRkZThmZTg2NTM3MTJlNjcxOGQ3MjBmMzJlMTRhNA==
+  data.tar.gz: !binary |-
+    Y2IyMWNlNDNmNzc5ODcyMjdiNGVhNmU2MmMwNGEyZWU3NzQzMTJjMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YWMzNmQwNzQ1MzEzZjhlMGM2ZjE1Y2NhNzQ0YTRjYzYwZmMwZGVkOTk3MTI1
+    MGIzZTI3NDc1NDAyMjQyM2M5M2I4OWNlM2RlY2EzYTIxZWE3NzQxOTU5MGIw
+    NjcyYTVlODkzMTJhOTI4MWE0NWY2OTVhYWNiMmVmM2E4ZGIzYTI=
+  data.tar.gz: !binary |-
+    Njc3NGNjNDVjYzUxMzU3N2NjNDU2NzUxYzA5NGI2ZGU0MWVkNGI3NGYyNjBi
+    ZDgzZDk1ZjJhZjFiNzMxMWYyMjlkZTEzMDdkZTA2Yjc0MzNiZDE3YWJkM2Vk
+    MTIwMzA1YmY2N2RkYWE3YmViNTM4NmVkOWU4NTg3NjIxYTlmZDg=

data/lib/generators/survey/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator will generate classes for a rails application to display a survey.
+
+Example:
+    rails generate survey

data/lib/generators/survey/metamodels/app.rb

@@ -0,0 +1,88 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension  
+  class View < Base
+    contains_many 'forms', Form, 'view'
+    
+    contains_one 'header', Header, 'view'
+    contains_one 'footer', Footer, 'view'
+    contains_many 'static_pages', StaticPage, 'view'
+    contains_many 'styles', StaticStyle, 'view'
+  end
+  
+  class Model < Base
+    contains_many 'surveys', Survey, 'model'
+  end
+  
+  class Application < Element    
+    contains_one 'view', View, 'app'
+    contains_one 'model', Model, 'app'
+  end
+end
+
+module SurveyMetamodel
+  module Application::ClassModule
+    def view_forms
+      view.forms if !view.nil? and !view.forms.nil?
+    end
+    
+    def all_elements
+      elems = view.form_elements
+      all_elems = (view_forms + elems)
+      elems.each do |elem|
+        all_elems << elem.elements if ((elem.is_a?(Group) or elem.is_a?(Page)) and !elem.is_a?(Image))
+      end
+      return all_elems
+    end
+    
+    def preprocessing
+      model.survey_questions.each { |question| question.init } if !model.nil?
+      if !view.nil?
+        view.static_pages.each { |static_page| static_page.create_page_file }
+        view.header.elements.each { |element| element.init }
+        view.header.elements.each { |element| element.init }
+        view_forms.each do |form|
+          form.init
+          form.set_model_element
+          form.set_page_elements
+        end
+        view.form_elements.each do |element|
+          element.init
+          element.set_model_element
+        end
+        check_for_inconsistencies
+      end
+    end
+    
+    def check_for_inconsistencies
+      all_elements.each do |element1|
+        all_elements.each do |element2|
+          if !element1.model_element.nil? and !element2.model_element.nil?
+            if ((element1.model_element == element2.model_element) and (element1 != element2))
+              raise "View element is already associated to a model element (name='#{element1.name}')!"
+            end
+          end
+        end
+      end
+      return true
+    end
+  end
+  
+  module Model::ClassModule
+    def survey_questions
+      surveys.questions if !surveys.nil? and !surveys.questions.nil?
+    end
+    
+    def question_rules
+      survey_questions.rules if !survey_questions.nil? and !survey_questions.rules.nil?
+    end
+  end
+  
+  module View::ClassModule    
+    def form_elements
+      forms.elements if !forms.nil? and !forms.elements.nil?
+    end
+    
+    def form_inputs
+      form_elements.select { |q| q.is_a?(Input) }
+    end
+  end
+end

data/lib/generators/survey/metamodels/base.rb

@@ -0,0 +1,120 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  class Base < RGen::MetamodelBuilder::MMBase
+    abstract
+    has_attr 'class_name', String, :unsettable => true
+  end
+  
+  class Element < Base
+    abstract
+    has_attr 'name', String
+    has_attr 'title', String
+  end
+end
+
+module SurveyMetamodel
+  module Base::ClassModule
+    def class_name?
+      !class_name.blank?
+    end
+    
+    def real_class_name
+      self.class_name = snake_class if !class_name?
+      return self.class_name
+    end
+    
+    def snake_class
+      self.class.name.class_name
+    end
+    
+    def snake_base_class
+      self.class.superclass.name.class_name
+    end
+  end
+  
+  module Element::ClassModule
+    def snake_name
+      plural_name.underscore
+    end
+    
+    def snake_name_singular
+      name.underscore
+    end
+    
+    def camel_name
+      plural_name.camelize
+    end
+    
+    def file_name
+      (plural_name.split('').any? { |c| c =~ /^[0-9]$/ })? plural_name.gsub!('_', ''): plural_name
+    end
+      
+    def name?
+      !name.blank?
+    end
+    
+    def title?
+      !title.blank?
+    end
+    
+    def has_name
+      return !(self.is_a?(Group) or self.is_a?(Image) or self.is_a?(Page) or self.is_a?(SurveyManagement) or self.is_a?(UserManagement))
+    end
+    
+    def init
+      set_name
+      set_title
+      
+      if self.is_a?(ChoiceQuestion)
+        init_all(choices)
+      elsif self.is_a?(Matrix)
+        init_all(rows)
+        init_all(columns)
+      elsif self.is_a?(Group) or (self.is_a?(Page) and !self.elements.empty?)
+        init_all(elements)
+      end
+    end
+    
+    private
+      
+      def set_name
+        self.name = unique_name if !name?
+      end
+      
+      def set_title
+        self.title = unique_title if !title?
+      end
+      
+      def init_all(collection)
+        collection.each { |element| element.init } if !collection.nil?
+      end
+      
+      def plural_name
+        name.pluralize
+      end
+      
+      def unique_name
+        uuid = SecureRandom.uuid[0..4]
+        return "#{real_class_name}_#{uuid}"
+      end
+      
+      def unique_title
+        name.camelize if !name?
+      end
+      
+      def init_with(new_name)
+        { :name => "#{new_name.to_underscore}", :title => "#{new_name}" }
+      end
+      
+      def choices_by_s(string)
+        choices_by_a(string.split(","))
+      end
+      
+      def choices_by_a(array)
+        tmp_choices = Array.new
+        array.each do |choice|
+          tmp_choices << Choice.new(init_with(choice.strip))
+        end
+        return tmp_choices
+      end
+  end
+end

data/lib/generators/survey/metamodels/main.rb

@@ -0,0 +1,12 @@
+$:.unshift File.dirname(__FILE__)
+require 'rgen/metamodel_builder'
+
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  require "types"
+  require "base"
+  require "style"
+  require "validation"
+  require "model"
+  require "view"
+  require "app"
+end

data/lib/generators/survey/metamodels/model.rb

@@ -0,0 +1,140 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  class ModelElement < Element
+    abstract
+  end
+  
+  class Survey < ModelElement
+    has_attr 'author', String
+    contains_many 'questions', ModelElement, 'survey'
+  end
+  
+  class Dependency < Base
+    has_attr 'requires', String
+    has_attr 'value', String
+  end
+  
+  class Question < ModelElement
+    abstract
+    contains_many 'rules', ValidationRule, 'question'
+    contains_many 'dependencies', Dependency, 'question'
+  end
+  
+  class Text < Question
+  end
+  
+  class Choice < ModelElement
+  end
+  
+  class ChoiceQuestion < Question
+    abstract
+    has_attr 'choices_s', String
+    contains_many 'choices', Choice, 'question'
+  end
+  
+  class MultipleChoice < ChoiceQuestion
+  end
+  
+  class SingleChoice < ChoiceQuestion
+  end
+  
+  class RatingScale < ChoiceQuestion
+    has_attr 'type', RatingScaleType
+    
+    has_attr 'min', Integer
+    has_attr 'max', Integer
+  end
+  
+  class Row < ModelElement
+  end
+  
+  class Column < ModelElement
+  end
+  
+  class Matrix < Question
+    has_attr 'type', MatrixType
+    
+    has_attr 'rows_s', String
+    contains_many 'rows', Row, 'matrix'
+    has_attr 'columns_s', String
+    contains_many 'columns', Column, 'matrix'
+    
+    has_attr 'choices_s', String
+    contains_many 'choices', Choice, 'matrix'
+  end
+end
+
+module SurveyMetamodel
+  LIKERT_SCALE = ["Strongly disagree", "Disagree", "Neutral", "Agree", "Strongly Agree"]
+  
+  module Dependency::ClassModule
+    def condition
+      return "(!params[:#{requires}].blank? and params[:#{requires}][:content] == '#{value}')"
+    end
+  end
+  
+  module Question::ClassModule
+    def conditions
+      conditions_a = Array.new
+      dependencies.each do |dependency|
+        conditions_a << dependency.condition
+      end
+      return "(#{conditions_a.join(" and ")})"
+    end
+  end
+  
+  module RatingScale::ClassModule
+    def real_choices
+      if type == :numerical
+        choices2 = Array.new
+        (min..max).each { |i| choices2 << Choice.new(:name => "#{self.name}_choice_#{i}", :title => "#{i}") }
+        choices2
+      elsif type == :likert
+        choices_by_a(LIKERT_SCALE)
+      elsif self.is_a?(RatingScale)
+        choices
+      end
+    end
+  end
+  
+  module ChoiceQuestion::ClassModule
+    def real_choices
+      if self.is_a?(ChoiceQuestion)
+        if !choices_s.blank? and choices.empty?
+          choices_by_s(choices_s)
+        else
+          choices
+        end
+      end
+    end
+  end
+  
+  module Matrix::ClassModule
+    def real_rows
+      if !rows_s.blank? and rows.empty?
+        choices_by_s(rows_s)
+      else
+        rows
+      end
+    end
+    
+    def real_columns
+      if type == :likert
+        choices_by_s(LIKERT_SCALE.join(','))
+      elsif self.is_a?(Matrix)
+        if !columns_s.blank? and columns.empty?
+          choices_by_s(columns_s)
+        else
+          columns
+        end
+      end
+    end
+    
+    def real_choices
+      if !choices_s.blank? and choices.empty?
+        choices_by_s(choices_s)
+      else
+        choices
+      end
+    end
+  end
+end

data/lib/generators/survey/metamodels/style.rb

@@ -0,0 +1,202 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  class CustomStyle < Base
+    has_attr 'property', String
+    has_attr 'value', String
+  end
+  
+  class Style < Base
+    abstract
+    
+    has_attr 'margin', Integer
+    has_attr 'padding', Integer
+    has_attr 'foreground', Color
+    has_attr 'background', Color
+    has_attr 'font_size', Integer
+    has_attr 'font_style', FontStyle
+    has_attr 'font_weight', FontWeight
+    has_attr 'horizontal_alignment', HorizontalAlignment
+    has_attr 'vertical_alignment', VerticalAlignment
+    
+    contains_many 'styles', CustomStyle, 'association'
+  end
+  
+  class ElementStyle < Style
+  end
+  
+  class StaticStyle < Style
+    has_attr 'element_names', String
+    has_attr 'element_types', String
+  end
+  
+  class StyleElement < Element
+    abstract
+    contains_one 'style', ElementStyle, 'element'
+    has_attr 'custom_html', String
+  end
+end
+
+module SurveyMetamodel  
+  module CustomStyle::ClassModule
+    def property?
+      !property.blank?
+    end
+    
+    def value?
+      !value.blank?
+    end
+  end
+  
+  module Style::ClassModule
+    def margin?
+      !margin.nil? and margin != 0
+    end
+    
+    def padding?
+      !padding.nil? and margin != 0
+    end
+    
+    def foreground?
+      !foreground.nil?
+    end
+    
+    def background?
+      !background.nil?
+    end
+    
+    def font_size?
+      !font_size.nil? and margin != 0
+    end
+    
+    def font_style?
+      !font_style.nil?
+    end
+    
+    def font_weight?
+      !font_weight.nil?
+    end
+    
+    def horizontal_align?
+      !horizontal_align.nil?
+    end
+    
+    def vertical_align?
+      !vertical_align.nil?
+    end
+    
+    #See HTML color table: http://www.w3schools.com/html/html_colornames.asp
+    def color(color)
+      if color == :blue
+        "#0000FF"
+      elsif color == :red
+        "#FF0000"
+      elsif color == :yellow
+        "#FFFF00"
+      elsif color == :gray
+        "#808080"
+      elsif color == :green
+        "#008000"
+      elsif color == :white
+        "#FFFFFF"
+      elsif color == :black
+        "#000000"
+      elsif color == :lightGray
+        "#D3D3D3"
+      elsif color == :darkGray
+        "#A9A9A9"
+      else
+        "#FFFFFF"
+      end
+    end
+    
+    def style
+      if font_style == :normal
+        "normal"
+      elsif font_style == :italic
+        "italic"
+      elsif font_style == :oblique
+        "oblique"
+      end
+    end
+    
+    def weight
+      if font_weight == :normal
+        "normal"
+      elsif font_weight == :bold
+        "italic"
+      end
+    end
+    
+    def horizontal_align
+      if horizontal_alignment == :left
+        "left"
+      elsif horizontal_alignment == :center
+        "center"
+      elsif horizontal_alignment == :right
+        "right"
+      end
+    end
+    
+    def vertical_align
+      if vertical_alignment == :top
+        "top"
+      elsif vertical_alignment == :middle
+        "middle"
+      elsif vertical_alignment == :bottom
+        "bottom"
+      end
+    end
+  end
+  
+  module StaticStyle::ClassModule
+    def names
+      names = Array.new
+      if element_names? and !element_types?
+        names = self.element_names.split(',')
+      elsif !element_names? and element_types?
+        names = self.element_types.split(',')
+      elsif element_names? and element_types?
+        names = self.element_names.split(',') + self.element_types.split(',')
+      end
+      return names.each {|s| s.strip! }
+    end
+    
+    def element_names?
+      !element_names.blank?
+    end
+    
+    def element_types?
+      !element_types.blank?
+    end
+  end
+  
+  module StyleElement::ClassModule
+    def has_style?(element)
+      return true if style?
+      
+      container = nil
+      if !self.group.nil?
+        container = self.group
+      elsif self.is_a?(Input)
+        container = self
+      end
+      
+      (!container.form.view.styles.select { |s| s.element_name == element.name }.empty?)
+    end
+    
+    def style?
+      !style.nil?
+    end
+    
+    def content
+      if custom_html?
+        custom_html
+      elsif title?
+        title
+      end
+    end
+    
+    def content?
+      !content.blank?
+    end
+  end
+end

data/lib/generators/survey/metamodels/types.rb

@@ -0,0 +1,10 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  Color = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "Color", :literals => [:blue, :red, :yellow, :gray, :green, :white, :black, :lightGray, :darkGray])
+  FontStyle = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "FontStyle", :literals => [:normal, :italic, :oblique])
+  FontWeight = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "FontWeight", :literals => [:normal, :bold])
+  HorizontalAlignment = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "HorizontalAlignment", :literals => [:left, :center, :right])
+  VerticalAlignment = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "VerticalAlignment", :literals => [:top, :middle, :bottom])
+  TextFieldType = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "TextFieldType", :literals => [:small, :normal, :multiLine])
+  RatingScaleType = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "RatingScaleType", :literals => [:normal, :numerical, :likert])
+  MatrixType = RGen::MetamodelBuilder::DataTypes::Enum.new(:name => "MatrixType", :literals => [:singleChoice, :multipleChoice, :text, :likert])
+end

data/lib/generators/survey/metamodels/validation.rb

@@ -0,0 +1,28 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  class ValidationRule < Base
+    abstract
+  end
+  
+  class RegexRule < ValidationRule
+    has_attr 'regex', String
+  end
+  
+  class NumberRule < ValidationRule
+  end
+  
+  class FloatNumberRule < ValidationRule
+  end
+  
+  class PresenceRule < ValidationRule
+  end
+  
+  class LengthRule < ValidationRule
+    has_attr 'min', Integer
+    has_attr 'max', Integer
+  end
+  
+  class RangeRule < ValidationRule
+    has_attr 'min', Float
+    has_attr 'max', Float
+  end
+end