survey_on_rails 0.3.2

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

@@ -0,0 +1,384 @@
+module SurveyMetamodel extend RGen::MetamodelBuilder::ModuleExtension
+  class ViewElement < StyleElement
+    abstract
+    contains_one 'model_element', ModelElement, 'element', :unsettable => true
+  end
+  
+  class Form < ViewElement
+    has_attr 'author', String
+    contains_many 'elements', ViewElement, 'form'
+    
+    has_attr 'page_elements', Object
+  end
+  
+  class Input < ViewElement
+    abstract
+    has_attr 'info', String
+    contains_one 'for', Input, 'element'
+  end
+  
+  class Textfield < Input
+    has_attr 'type', TextFieldType
+    has_attr 'prefix', String
+    has_attr 'suffix', String
+  end
+  
+  class SelectionGroup < Input
+    abstract
+    has_attr 'dropdown', Boolean
+  end
+  
+  class CheckboxGroup < SelectionGroup
+  end
+  
+  class RadioButtonGroup < SelectionGroup
+  end
+  
+  class HorizontalRadioButtonGroup < SelectionGroup
+  end
+  
+  class Image < ViewElement
+    has_attr 'source', String
+    has_attr 'url', String
+    has_attr 'width', Integer
+    has_attr 'height', Integer
+  end
+  
+  class Table < Input
+    has_attr 'dropdown', Boolean
+    
+    has_attr 'images_s', String
+    contains_many 'images', Image, 'matrix'
+  end
+  
+  class LayoutElement < ViewElement
+    abstract
+    contains_many 'elements', ViewElement, 'container'
+  end
+  
+  class Group < LayoutElement
+  end
+  
+  class Page < LayoutElement
+    has_attr 'break', Boolean
+  end
+  
+  class StaticElement < ViewElement
+    abstract
+  end
+  
+  class PageView < ViewElement
+    abstract
+    contains_many 'elements', StaticElement, 'page'
+  end
+  
+  class StaticPage < PageView
+    has_attr 'root', Boolean
+    has_attr 'file', String
+  end
+  
+  class Header < PageView
+  end
+  
+  class Footer < PageView
+  end
+  
+  class Label < StaticElement
+  end
+  
+  class Link < StaticElement
+    has_attr 'url', String
+    has_attr 'path', Boolean
+  end
+  
+  class SurveyManagement < StaticElement
+  end
+  
+  class UserManagement < StaticElement
+  end
+end
+
+module SurveyMetamodel
+  module ViewElement::ClassModule
+    def get_form
+      cont = self
+      while true
+        if !cont.container.nil?
+          cont = cont.container
+        else
+          break
+        end
+      end
+      return cont.form
+    end
+    
+    def rules
+      model_element.rules if !model_element.nil?
+    end
+    
+    def is_mandatory?
+      return (!model_element.nil? and model_element.rules.any? { |r| r.is_a?(PresenceRule) })
+    end
+    
+    def has_label?
+      return self.is_a?(Input)
+    end
+    
+    def number_title(i)
+      suffix = (is_mandatory?)? " *": ""
+      real_title = "#{title}#{suffix}"
+      num_title = (i > 0)? ("#{i}. #{real_title}"): real_title
+      return num_title
+    end
+    
+    def set_model_element
+      if self.is_a?(Group) or (self.is_a?(Page) and !self.elements.empty?)
+        elements.each do |element|
+          element.set_model_element
+        end
+      end
+      
+      if self.is_a?(Input) and !self.for.nil?
+        self.name = self.for.name
+        self.title = self.for.title
+        self.for.model_element = nil
+      end
+      
+      cont = self.get_form
+      view = cont.view
+      survey = view.app.model.surveys.select { |s| s.name == cont.name }.first
+      model_elements = survey.questions.select { |q| q.name == self.name or q.name == self.snake_class }
+      
+      if !model_elements.nil? and model_elements.count == 1
+        self.model_element = model_elements.first.dup
+        self.title = model_element.title if !title? and model_element.title?
+      end
+      if !model_element.nil? and model_element.name == self.snake_class
+        self.name = self.snake_class
+        self.class_name = self.snake_base_class
+      end
+      
+      raise "Names cannot be nil and can only consist of letters, numbers and underscore (name='#{self.name}')!" if has_name and !(self.name.scan(/\w+/).count == 1)
+    end
+    
+    def is_layout_element?
+      return (self.is_a?(Group) or self.is_a?(Page) or self.is_a?(Image))
+    end
+    
+    def model_element?
+      return !model_element.nil?
+    end
+    
+    def has_model_element?
+      return (model_element? and !is_layout_element?)
+    end
+    
+    def has_valid_model_element?
+      return (model_element? or is_layout_element?)
+    end
+        
+    private
+      
+      def custom_html?
+        !custom_html.blank?
+      end
+  end
+  
+  module Form::ClassModule
+    def author
+      model_element.author if !model_element.nil?
+    end
+    
+    def inputs
+      elements.select { |e| e.is_a?(Input) }
+    end
+    
+    def pages_number
+      pages.count
+    end
+    
+    def actual_pages_number
+      page_elements.count
+    end
+    
+    def has_multiple_pages
+      actual_pages_number > 1
+    end
+    
+    def pages
+      elements.select { |e| e.is_a?(Page) }
+    end
+    
+    def input_elements
+      page_elements = self.elements.select { |e| e.is_a?(Page) }.elements
+      other_elements = page_elements.select { |e| !e.is_a?(Group) }
+      group_elements = page_elements.select { |e| e.is_a?(Group) }.elements
+      input_elems = (inputs + other_elements + group_elements)
+      return input_elems
+    end
+    
+    def set_model_element
+      model_elements = self.view.app.model.surveys.select { |s| s.name == self.name }
+      if !model_elements.nil? and model_elements.count == 1
+        self.model_element = model_elements.first
+        self.title = model_element.title if !title? and model_element.title?
+      end
+    end
+    
+    def set_page_elements
+      _pages = pages
+      first_page_break = _pages.first
+      
+      self.page_elements = Array.new
+      self.page_elements << elements if _pages.count == 0
+      if _pages.any?
+        _pages.each do |page_break|
+          if !page_break.elements.nil? and !page_break.elements.empty?
+            self.page_elements << page_break.elements.reject { |e| e.is_a?(Page) }
+          else
+            if page_break == first_page_break
+              self.page_elements << page_elements_before_first
+              self.page_elements << page_elements_after(page_break)
+            else
+              self.page_elements << page_elements_after(page_break)
+            end
+          end
+        end
+      end
+    end
+    
+    private
+      
+      def page_elements_before_first
+        page_elements = Array.new
+        add = true
+        
+        elements.each do |elem|
+          add = false if elem.is_a?(Page)
+          page_elements << elem if add
+        end
+        return page_elements
+      end
+      
+      def page_elements_after(page)
+        page_elements = Array.new
+        add = false
+        
+        elements.each do |elem|
+          if elem.is_a?(Page) and elem == page
+            add = true
+          elsif elem.is_a?(Page) and elem != page
+            add = false
+          end
+          page_elements << elem if !elem.is_a?(Page) and add
+        end
+        return page_elements
+      end
+  end
+  
+  module Input::ClassModule
+    def info?
+      !info.blank?
+    end
+    
+    def dependencies?
+      return (!model_element.nil? and !model_element.dependencies.empty?)
+    end
+    
+    def dependencies
+      model_element.dependencies if !model_element.nil?
+    end
+    
+    def conditions
+      model_element.conditions if !model_element.nil?
+    end
+  end
+  
+  module StaticPage::ClassModule
+    def file_path
+      raise "The referenced static page does not exist. Please define it first." if !file.nil? and !File.exists?(file)
+      return (!file.nil?)? file: "gen/assets/static_pages/#{name}.html.erb"
+    end
+    
+    def create_page_file
+      File.new(file_path, 'w') unless File.exists?(file_path)
+    end
+  end
+  
+  module Textfield::ClassModule
+    def prefix?
+      !prefix.blank?
+    end
+    
+    def suffix?
+      !suffix.blank?
+    end
+  end
+  
+  module SelectionGroup::ClassModule
+    def choices
+      model_element.real_choices if !model_element.nil?
+    end
+    
+    def params_s
+      choices_string_a = Array.new
+      choices.each { |choice| choices_string_a << "params[:#{name}_#{choice.name}].to_s" }
+      return "[#{choices_string_a.join(', ')}].reject(&:empty?).join(', ')"
+    end
+  end
+  
+  module Table::ClassModule
+    def type
+      model_element.type if !model_element.nil?
+    end
+    
+    def rows
+      model_element.real_rows if !model_element.nil?
+    end
+    
+    def columns
+      model_element.real_columns if !model_element.nil?
+    end
+    
+    def choices
+      model_element.real_choices if !model_element.nil?
+    end
+    
+    def has_images?
+      return (images.any? or !images_s.blank?)
+    end
+    
+    def real_images
+      imgs = nil
+      if !images_s.blank? and images.empty?
+        imgs = Array.new
+        images_s.split(",").each { |image_s| imgs << Image.new(:source => image_s.strip) }
+      else
+        imgs = images
+      end
+      raise "The number of images cannot be more than the number of cells." if imgs.count > (rows.count * columns.count)
+      return imgs
+    end
+    
+    def params_s
+      cells_string_a = Array.new
+      rows.each do |row|
+        cells_string_a << "params[:#{name}_#{row.name}]"
+        columns.each do |column|
+          cells_string_a << "params[:#{name}_#{row.name}_#{column.name}]"
+        end
+      end
+      return "[#{cells_string_a.join(', ')}].uniq.reject(&:blank?).join(', ')"
+    end
+  end
+  
+  module Image::ClassModule
+    def source?
+      !source.blank?
+    end
+    
+    def url?
+      !url.blank?
+    end
+  end
+end

data/lib/generators/survey/survey_generator.rb

@@ -0,0 +1,276 @@
+$:.unshift File.dirname(__FILE__)
+
+class SurveyGenerator < Rails::Generators::Base
+  argument :model_path, :type => :string, :default => "#{Rails.root.to_s}/gen/models/app.rb"
+  class_option :init, :type => :boolean, :default => false, :desc => "Performs all actions"
+  class_option :dynamic, :type => :boolean, :default => true, :desc => "Generates dynamic part of the model"
+  class_option :static, :type => :boolean, :default => true, :desc => "Generates static part of the model"
+  class_option :gems, :type => :boolean, :default => false, :desc => "Initializes the application"
+  class_option :migrate, :type => :boolean, :default => false, :desc => "Performs database migrations"
+  class_option :populate, :type => :boolean, :default => false, :desc => "Populates database with users"
+  class_option :silent, :type => :boolean, :default => false, :desc => "Prevents console feedback"
+  
+  def generate_survey
+    start_time = Time.now
+    out "Initializing Survey on Rails (SoR)"
+    
+    init_app if options.gems?
+    if options.init?
+      out "Initializing the application with default configuration"
+      run 'rails g survey --gems --migrate --populate --no-static --no-dynamic --silent'
+    end
+    
+    out "Generating ruby on rails source code for the survey in '#{model_path}'"
+    
+    if File.exists?(model_path)
+      require "#{File.dirname(model_path)}/model.rb"
+      require model_path
+      
+      if !(defined?(APPLICATION)).nil?
+        if !APPLICATION.view.nil?
+          generate_all
+        else
+          init_model("Model is empty or no survey has been defined", false)
+        end
+      else
+        init_model("Model has not been defined", true)
+      end
+    else
+      init_model("Model file does not exist", true)
+    end
+    
+    migrate if options.migrate?
+    populate if options.populate?
+    
+    out "Generation process has finished after #{(Time.now - start_time).round(3).seconds.to_s} seconds"
+  end
+  
+  protected
+    
+    def init_model(error, create)
+      out(error)
+      create_model if create
+      generate_static
+    end
+    
+    def generate_all
+       generate(true, true)
+    end
+    
+    def generate_static
+      generate(true, false)
+    end
+    
+    def generate(static, dynamic)
+      load_requirements
+      remove_migrations
+      
+      templateContainer = RGen::TemplateLanguage::DirectoryTemplateContainer.new(SurveyMetamodel, Rails.root.to_s)
+      templateContainer.load(File.dirname(__FILE__) + '/templates')
+      
+      out "Preprocessing the model"
+      APPLICATION.first.preprocessing
+      
+      if options.static? and static
+        out "Generating static parts of model"
+        templateContainer.expand('main::static', :for => APPLICATION)
+      end
+      
+      if options.dynamic? and dynamic
+        out "Generating dynamic parts of model"
+        templateContainer.expand('main::dynamic', :for => APPLICATION.first)
+      end
+      
+      copy_assets
+    end
+    
+    def load_requirements
+      require 'rgen/template_language'
+      require 'rgen/array_extensions'
+      require 'metamodels/main'
+      suppress_warnings { load model_path }
+    end
+    
+    def init_app
+      out "Initializing application (adding needed gems, removing unused files, bundling)"
+      
+      file_name = "Gemfile"
+      File.new(file_name) unless File.exists?(file_name)
+      File.open(file_name, 'r+') do |file|
+        file.puts("source 'https://rubygems.org'")
+        
+        file.puts("\n#For all environments")
+        file.puts("gem 'rails', '3.2.13'")
+        file.puts("gem 'bootstrap-sass', '2.1'")
+        file.puts("gem 'bcrypt-ruby', '3.0.1'")
+        file.puts("gem 'faker', '1.0.1'")
+        file.puts("gem 'will_paginate', '3.0.3'")
+        file.puts("gem 'bootstrap-will_paginate', '0.0.6'")
+        file.puts("gem 'jquery-rails'")
+        file.puts("gem 'rgen'")
+        file.puts("gem 'survey_generator'")
+        
+        file.puts("\n#Group 'development' and 'test'")
+        file.puts("group :development, :test do")
+        file.puts("\tgem 'sqlite3'")
+        file.puts("\tgem 'rspec-rails', '2.11.0'")
+        file.puts("end")
+        
+        file.puts("\n#Group 'test'")
+        file.puts("group :test do")
+        file.puts("\tgem 'capybara', '1.1.2'")
+        file.puts("\tgem 'factory_girl_rails', '4.1.0'")
+        file.puts("\tgem 'cucumber-rails', '1.2.1', :require => false")
+        file.puts("\tgem 'database_cleaner', '0.7.0'")
+        file.puts("end")
+        
+        file.puts("\n#Group 'production'")
+        file.puts("group :production do")
+        file.puts("\tgem 'pg', '0.12.2'")
+        file.puts("end")
+        
+        file.puts("\n#Group 'assets'")
+        file.puts("group :assets do")
+        file.puts("\tgem 'sass-rails','~> 3.2.3'")
+        file.puts("\tgem 'coffee-rails', '~> 3.2.1'")
+        file.puts("\tgem 'uglifier', '>= 1.0.3'")
+        file.puts("end")
+      end
+      
+      if File.exists? "#{Rails.root.to_s}/public/index.html"
+        run "rm public/index.html"
+      end
+      
+      run "bundle install"
+    end
+    
+    def create_model
+      out "Creating model file and base definition"
+      
+      model_directory = File.dirname(model_path)
+      create_dir(model_directory)
+      
+      if create_file(model_path)
+        File.open(model_path, 'r+') do |file|
+          file.puts("Dir['#{Rails.root.to_s}/gen/models/*.rb'].each { |file| require file }")
+          file.puts("\nAPPLICATION = SurveyOnRails::Builder::build do")
+          file.puts("\tapplication do")
+          file.puts("\t\tmodel(:surveys => SURVEYS)")
+          file.puts("\n\t\t")
+          file.puts("\t\tview(:static_pages => STATIC_PAGES, :header => HEADER.first, :footer => FOOTER.first, :styles => STYLES, :forms => FORMS)")
+          file.puts("\tend")
+          file.puts("end")
+        end
+      end
+      
+      model_file_path = "#{model_directory}/model.rb"
+      if create_file(model_file_path)
+        File.open(model_file_path, 'r+') do |file|
+          file.puts("\nSURVEYS = SurveyOnRails::Builder::build do")
+          file.puts("end")
+        end
+      end
+      
+      style_file_path = "#{model_directory}/styles.rb"
+      if create_file(style_file_path)
+        File.open(style_file_path, 'r+') do |file|
+          file.puts("\nSTYLES = SurveyOnRails::Builder::build do")
+          file.puts("end")
+        end
+      end
+      
+      static_file_path = "#{model_directory}/static.rb"
+      if create_file(static_file_path)
+        File.open(static_file_path, 'r+') do |file|
+          file.puts("STATIC_PAGES = SurveyOnRails::Builder::build do")
+          file.puts("end")
+          
+          file.puts("\nHEADER = SurveyOnRails::Builder::build do")
+          file.puts("\theader do")
+          file.puts("\tend")
+          file.puts("end")
+          
+          file.puts("\nFOOTER = SurveyOnRails::Builder::build do")
+          file.puts("\tfooter do")
+          file.puts("\tend")
+          file.puts("end")
+        end
+      end
+      
+      view_file_path = "#{model_directory}/view.rb"
+      if create_file(view_file_path)
+        File.open(view_file_path, 'r+') do |file|
+          file.puts("FORMS = SurveyOnRails::Builder::build do")
+          file.puts("end")
+        end
+      end
+    end
+    
+    def migrate
+      out "Performing database migrations"
+      
+      rake "db:reset" if File.exists?("#{Rails.root.to_s}/db/schema.rb")
+      rake "db:migrate"
+    end
+    
+    def populate
+      out "Populating database with users"
+      
+      admin = User.create!(name: "Example User", email: "example@railstutorial.org", password: "foobar", password_confirmation: "foobar")
+      admin.toggle!(:admin)
+      admin2 = User.create!(name: "Daniel Kemper", email: "dkemp04@gmail.com", password: "foobar", password_confirmation: "foobar")
+      admin2.toggle!(:admin)
+      
+      99.times do |n|
+        name = Faker::Name.name
+        email = "example-#{n + 1}@railstutorial.org"
+        password = "password"
+        User.create!(name: name, email: email, password: password, password_confirmation: password)
+      end
+    end
+    
+    def copy_assets
+      out "Copying assets to target directory"
+      
+      ["images", "javascripts", "stylesheets"].each { |dir| copy_dir("gen/assets/#{dir}", "app/assets/#{dir}") }
+      copy_dir("gen/assets/static_pages", "app/views/static_pages")
+    end
+    
+    def remove_migrations
+      migrations_folder = "db/migrate"
+      FileUtils.rm_rf(migrations_folder) if File.exists?(migrations_folder)
+    end
+    
+  private
+    
+    def copy_dir(source, dest)
+      create_dir(source)
+      create_dir(dest)
+      FileUtils.cp_r(Dir["#{source}/*"], "#{dest}")
+    end
+    
+    def create_dir(dir)
+      FileUtils.mkdir_p(dir) unless File.exists?(dir)
+    end
+    
+    def create_file(file)
+      if !File.exists?(file)
+        File.new(file, 'w')
+        return true
+      else
+        return false
+      end
+    end
+    
+    def out(text)
+      puts "[SoR]: #{text}" if !options.silent?
+    end
+    
+    def suppress_warnings
+      original_verbosity = $VERBOSE
+      $VERBOSE = nil
+      result = yield
+      $VERBOSE = original_verbosity
+      return result
+    end
+end

data/lib/generators/survey/templates/app/app.tpl

@@ -0,0 +1,15 @@
+<% define 'static' do %>
+	<% expand 'assets/assets::static' %>
+	<% expand 'controllers/controllers::static' %>
+	<% expand 'helpers/helpers::static' %>
+	<% expand 'models/models::static' %>
+	<% expand 'views/views::static' %>
+<% end %>
+
+<% define 'dynamic' do %>
+	<% expand 'assets/assets::dynamic' %>
+	<% expand 'controllers/controllers::dynamic' %>
+	<% expand 'helpers/helpers::dynamic' %>
+	<% expand 'models/models::dynamic' %>
+	<% expand 'views/views::dynamic' %>
+<% end %>

data/lib/generators/survey/templates/app/assets/assets.tpl

@@ -0,0 +1,10 @@
+<% define 'static' do %>
+	<% expand 'stylesheets/static_stylesheet::application_stylesheet' %>
+	<% expand 'stylesheets/static_stylesheet::static_stylesheet' %>
+	<% expand 'javascripts/application::static' %>
+<% end %>
+
+<% define 'dynamic' do %>
+	<% expand 'stylesheets/stylesheet::stylesheet', :for => view %>
+	<% expand 'javascripts/application::dynamic', :foreach => view.forms %>
+<% end %>