surveyor 1.2.0 → 1.3.0

data/lib/surveyor/models/question_group_methods.rb

@@ -7,13 +7,13 @@ module Surveyor
         # Associations
         base.send :has_many, :questions
         base.send :has_one, :dependency
-        
+
         # Whitelisting attributes
         base.send :attr_accessible, :text, :help_text, :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier, :display_type, :custom_class, :custom_renderer
       end
 
-      include RenderText
-      
+      include MustacheContext
+
       # Instance Methods
       def initialize(*args)
         super(*args)
@@ -42,6 +42,20 @@ module Surveyor
       def css_class(response_set)
         [(dependent? ? "g_dependent" : nil), (triggered?(response_set) ? nil : "g_hidden"), custom_class].compact.join(" ")
       end
+
+      def text_for(context = nil, locale = nil)
+        return "" if display_type == "hidden_label"
+        in_context(translation(locale)[:text], context)
+      end
+      def help_text_for(context = nil, locale = nil)
+        in_context(translation(locale)[:help_text], context)
+      end
+
+      def translation(locale)
+        {:text => self.text, :help_text => self.help_text}.with_indifferent_access.merge(
+          (self.questions.first.survey_section.survey.translation(locale)[:question_groups] || {})[self.reference_identifier] || {}
+        )
+      end
     end
   end
 end

data/lib/surveyor/models/question_methods.rb

@@ -14,6 +14,9 @@ module Surveyor
         # Scopes
         base.send :default_scope, :order => "display_order ASC"
 
+        # Mustache
+        base.send :include, MustacheContext
+
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
@@ -30,8 +33,6 @@ module Surveyor
         base.send :attr_accessible, :survey_section, :question_group, :survey_section_id, :question_group_id, :text, :short_text, :help_text, :pick, :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier, :display_order, :display_type, :is_mandatory, :display_width, :custom_class, :custom_renderer, :correct_answer_id
       end
 
-      include RenderText
-
       # Instance Methods
       def initialize(*args)
         super(*args)
@@ -75,14 +76,40 @@ module Surveyor
         self.question_group.nil?
       end
 
-      def split_text(part = nil)
-        (part == :pre ? text.split("|",2)[0] : (part == :post ? text.split("|",2)[1] : text)).to_s
+      def text_for(position = nil, context = nil, locale = nil)
+        return "" if display_type == "hidden_label"
+        imaged(split(in_context(translation(locale)[:text], context), position))
+      end
+      def help_text_for(context = nil, locale = nil)
+        in_context(translation(locale)[:help_text], context)
+      end
+      def split(text, position=nil)
+        case position
+        when :pre
+          text.split("|",2)[0]
+        when :post
+          text.split("|",2)[1]
+        else
+          text
+        end.to_s
       end
-
       def renderer(g = question_group)
         r = [g ? g.renderer.to_s : nil, display_type].compact.join("_")
         r.blank? ? :default : r.to_sym
       end
+      def translation(locale)
+        {:text => self.text, :help_text => self.help_text}.with_indifferent_access.merge(
+          (self.survey_section.survey.translation(locale)[:questions] || {})[self.reference_identifier] || {}
+        )
+      end
+
+      private
+
+
+      def imaged(text)
+        self.display_type == "image" && !text.blank? ? ActionController::Base.helpers.image_tag(text) : text
+      end
+
     end
   end
 end

data/lib/surveyor/models/response_methods.rb

@@ -6,10 +6,10 @@ module Surveyor
         base.send :belongs_to, :response_set
         base.send :belongs_to, :question
         base.send :belongs_to, :answer
-        
+
         # Scopes
         base.send :default_scope, :order => "created_at ASC"
-        
+
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
@@ -21,7 +21,7 @@ module Surveyor
 
         # Whitelisting attributes
         base.send :attr_accessible, :response_set, :question, :answer, :date_value, :time_value, :response_set_id, :question_id, :answer_id, :datetime_value, :integer_value, :float_value, :unit, :text_value, :string_value, :response_other, :response_group, :survey_section_id
-        
+
         # Class methods
         base.instance_eval do
           def applicable_attributes(attrs)
@@ -45,7 +45,7 @@ module Surveyor
       def default_args
         self.api_id ||= Surveyor::Common.generate_api_id
       end
-      
+
       def answer_id=(val)
         write_attribute :answer_id, (val.is_a?(Array) ? val.detect{|x| !x.to_s.blank?} : val)
       end
@@ -58,7 +58,7 @@ module Surveyor
       end
 
       def time_value=(val)
-        self.datetime_value = Time.zone.parse("#{Date.today.to_s} #{val}").to_datetime
+        self.datetime_value = Time.zone.parse("#{Date.today.to_s} #{val}") ? Time.zone.parse("#{Date.today.to_s} #{val}").to_datetime : nil
       end
 
       def date_value
@@ -66,7 +66,7 @@ module Surveyor
       end
 
       def date_value=(val)
-        self.datetime_value = Time.zone.parse(val).to_datetime
+        self.datetime_value = Time.zone.parse(val) ? Time.zone.parse(val).to_datetime : nil
       end
 
       def time_format
@@ -99,7 +99,7 @@ module Surveyor
         }
 
         found = formats[answer.response_class]
-        found ?  datetime_value.strftime(found) : as(answer.response_class)
+        found ?  datetime_value.try(:strftime, found) : as(answer.response_class)
       end
     end
   end

data/lib/surveyor/models/survey_methods.rb

@@ -9,19 +9,20 @@ module Surveyor
         base.send :has_many, :sections, :class_name => "SurveySection", :order => 'display_order', :dependent => :destroy
         base.send :has_many, :sections_with_questions, :include => :questions, :class_name => "SurveySection", :order => 'display_order'
         base.send :has_many, :response_sets
+        base.send :has_many, :translations, :class_name => "SurveyTranslation"
 
         # Scopes
         base.send :scope, :with_sections, {:include => :sections}
-        
+
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
           base.send :validates_presence_of, :title
           base.send :validates_uniqueness_of, :survey_version, :scope => :access_code, :message => "survey with matching access code and version already exists"
-          
+
           @@validations_already_included = true
         end
-        
+
         # Whitelisting attributes
         base.send :attr_accessible, :title, :description, :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier, :css_url, :custom_class, :display_order
 
@@ -63,9 +64,17 @@ module Surveyor
         self.inactive_at = DateTime.now
         self.active_at = nil
       end
+
       def as_json(options = nil)
         template_paths = ActionController::Base.view_paths.collect(&:to_path)
-        Rabl.render(self, 'surveyor/export.json', :view_path => template_paths, :format => "hash")
+        Rabl.render(filtered_for_json, 'surveyor/export.json', :view_path => template_paths, :format => "hash")
+      end
+
+      ##
+      # A hook that allows the survey object to be modified before it is
+      # serialized by the #as_json method.
+      def filtered_for_json
+        self
       end
 
       def default_access_code
@@ -82,6 +91,13 @@ module Surveyor
 
         self.survey_version = next_version
       end
+
+      def translation(locale_symbol)
+        t = self.translations.where(:locale => locale_symbol.to_s).first
+        {:title => self.title, :description => self.description}.with_indifferent_access.merge(
+          t ? YAML.load(t.translation || "{}").with_indifferent_access : {}
+        )
+      end
     end
   end
 end

data/lib/surveyor/models/survey_section_methods.rb

@@ -7,19 +7,18 @@ module Surveyor
         base.send :belongs_to, :survey
 
         # Scopes
-        base.send :default_scope, :order => "display_order ASC"
         base.send :scope, :with_includes, { :include => {:questions => [:answers, :question_group, {:dependency => :dependency_conditions}]}}
-        
+
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
           base.send :validates_presence_of, :title, :display_order
           # this causes issues with building and saving
           #, :survey
-          
+
           @@validations_already_included = true
         end
-        
+
         # Whitelisting attributes
         base.send :attr_accessible, :survey, :survey_id, :title, :description, :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier, :display_order, :custom_class
       end
@@ -33,7 +32,7 @@ module Surveyor
       def default_args
         self.data_export_identifier ||= Surveyor::Common.normalize(title)
       end
-      
+
       def questions_and_groups
         qs = []
         questions.each_with_index.map do |q,i|
@@ -46,6 +45,12 @@ module Surveyor
           end
         end.compact
       end
+
+      def translation(locale)
+        {:title => self.title, :description => self.description}.with_indifferent_access.merge(
+          (self.survey.translation(locale)[:survey_sections] || {})[self.reference_identifier] || {}
+        )
+      end
     end
   end
 end

data/lib/surveyor/models/survey_translation_methods.rb

@@ -0,0 +1,33 @@
+module Surveyor
+  module Models
+    module SurveyTranslationMethods
+      def self.included(base)
+        # Associations
+        base.send :belongs_to, :survey
+
+        @@validations_already_included ||= nil
+        unless @@validations_already_included
+          # Validations
+          base.send :validates_presence_of, :locale, :translation
+          base.send :validates_uniqueness_of, :locale, :scope => :survey_id
+          # this causes issues with building and saving
+          #, :survey
+
+          @@validations_already_included = true
+        end
+
+        # Whitelisting attributes
+        base.send :attr_accessible, :survey, :survey_id, :locale, :translation
+      end
+
+      # Instance Methods
+      def initialize(*args)
+        super(*args)
+        default_args
+      end
+
+      def default_args
+      end
+    end
+  end
+end

data/lib/surveyor/mustache_context.rb

@@ -0,0 +1,11 @@
+module Surveyor
+  module MustacheContext
+    def in_context(text, context=nil)
+      case context
+      when NilClass then text
+      when Hash     then Mustache.render(text, context)
+      else               context.render(text)
+      end
+    end
+  end
+end

data/lib/surveyor/parser.rb

@@ -1,4 +1,4 @@
-%w(survey survey_section question_group question dependency dependency_condition answer validation validation_condition).each {|model| require model }
+%w(survey survey_translation survey_section question_group question dependency dependency_condition answer validation validation_condition).each {|model| require model }
 module Surveyor
   class ParserError < StandardError; end
   class Parser
@@ -63,7 +63,7 @@ module Surveyor
     def method_missing(missing_method, *args, &block)
       method_name, reference_identifier = missing_method.to_s.split("_", 2)
       type = full(method_name)
-      Surveyor::Parser.raise_error( "\"#{type}\" is not a surveyor method." )if !%w(survey survey_section question_group question dependency dependency_condition answer validation validation_condition).include?(type)
+      Surveyor::Parser.raise_error( "\"#{type}\" is not a surveyor method." )if !%w(survey survey_translation survey_section question_group question dependency dependency_condition answer validation validation_condition).include?(type)
 
       Surveyor::Parser.rake_trace(reference_identifier.blank? ? "#{type} #{args.map(&:inspect).join ', '}" : "#{type}_#{reference_identifier} #{args.map(&:inspect).join ', '}",
                                   block_models.include?(type) ? 2 : 0)
@@ -100,6 +100,7 @@ module Surveyor
 
     def full(method_name)
       case method_name.to_s
+      when /^translations$/; "survey_translation"
       when /^section$/; "survey_section"
       when /^g$|^grid$|^group$|^repeater$/; "question_group"
       when /^q$|^label$|^image$/; "question"
@@ -173,6 +174,16 @@ module SurveyorParserSurveyMethods
   end
 end
 
+# SurveySection model
+module SurveyorParserSurveyTranslationMethods
+  def parse_and_build(context, args, original_method, reference_identifier)
+    # build, no change in context
+    args[0].each do |k,v|
+      context[:survey].translations << self.class.new(:locale => k.to_s, :translation => File.read(Rails.root.join("surveys", v)))
+    end
+  end
+end
+
 # SurveySection model
 module SurveyorParserSurveySectionMethods
   def parse_and_build(context, args, original_method, reference_identifier)
@@ -183,6 +194,7 @@ module SurveyorParserSurveySectionMethods
     title = args[0]
     self.attributes = ({
       :title => title,
+      :reference_identifier => reference_identifier,
       :display_order => context[:survey].sections.size }.merge(args[1] || {}))
     context[:survey].sections << context[:survey_section] = self
   end
@@ -208,6 +220,7 @@ module SurveyorParserQuestionGroupMethods
     # build and set context
     self.attributes = ({
       :text => args[0] || "Question Group",
+      :reference_identifier => reference_identifier,
       :display_type => (original_method =~ /grid|repeater/ ? original_method : "default")}.merge(args[1] || {}))
     context[:question_group] = self
   end

data/lib/surveyor/surveyor_controller_methods.rb

@@ -9,19 +9,12 @@ module Surveyor
       base.send :before_filter, :determine_if_javascript_is_enabled, :only => [:create, :update]
       base.send :before_filter, :set_response_set_and_render_context, :only => [:edit, :show]
       base.send :layout, 'surveyor_default'
+      base.send :before_filter, :set_locale
     end
 
     # Actions
     def new
-      @surveys = Survey.find(:all)
-      @codes = @surveys.inject({}) do |codes,s|
-        codes[s.access_code] ||= {}
-        codes[s.access_code][:title] = s.title
-        codes[s.access_code][:survey_versions] ||= []
-        codes[s.access_code][:survey_versions] << s.survey_version
-        codes
-      end
-      @title = "You can take these surveys"
+      @surveys_by_access_code = Survey.order("created_at DESC, survey_version DESC").all.group_by(&:access_code)
       redirect_to surveyor_index unless surveyor_index == available_surveys_path
     end
 
@@ -80,6 +73,7 @@ module Surveyor
     end
 
     def update
+      question_ids_for_dependencies = (params[:r] || []).map{|k,v| v["question_id"] }.compact.uniq
       saved = load_and_update_response_set_with_retries
 
       return redirect_with_message(surveyor_finish, :notice, t('surveyor.completed_survey')) if saved && params[:finish]
@@ -96,7 +90,7 @@ module Surveyor
         end
         format.js do
           if @response_set
-            render :json => @response_set.reload.all_dependencies
+            render :json => @response_set.reload.all_dependencies(question_ids_for_dependencies)
           else
             render :text => "No response set #{params[:response_set_code]}",
               :status => 404
@@ -140,12 +134,9 @@ module Surveyor
 
     def export
       surveys = Survey.where(:access_code => params[:survey_code]).order("survey_version DESC")
-      if params[:survey_version].blank?
-        @survey = surveys.first
-      else
-        @survey = surveys.where(:survey_version => params[:survey_version]).first
-      end
-      render_404 and return if @survey.blank?
+      s = params[:survey_version].blank? ? surveys.first : surveys.where(:survey_version => params[:survey_version]).first
+      render_404 and return if s.blank?
+      @survey = s.filtered_for_json
     end
 
     def render_404
@@ -153,6 +144,10 @@ module Surveyor
       true
     end
 
+    def url_options
+      ((I18n.locale == I18n.default_locale) ? {} : {:locale => I18n.locale}).merge(super)
+    end
+
     private
 
     # This is a hook method for surveyor-using applications to override and provide the context object
@@ -171,6 +166,14 @@ module Surveyor
       @render_context = render_context
     end
 
+     def set_locale
+       if params[:locale]
+         I18n.locale = params[:locale]
+       else
+         I18n.locale = I18n.default_locale
+       end
+    end
+
     # Params: the name of some submit buttons store the section we'd like to go
     # to. for repeater questions, an anchor to the repeater group is also stored
     # e.g. params[:section] = {"1"=>{"question_group_1"=>"<= add row"}}
@@ -227,6 +230,5 @@ module Surveyor
         session[:surveyor_javascript] = "not_enabled"
       end
     end
-
   end
 end

data/lib/surveyor/version.rb

@@ -1,3 +1,3 @@
 module Surveyor
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end