spell-checker-procs.tcl

Automated tests for spell-checker

Location:

packages/acs-templating/tcl/test/spell-checker-procs.tcl

Created:

28 September 2003

Author:

Ola Hansson <ola@polyxena.net>

CVS Identification:

$Id: spell-checker-procs.tcl,v 1.15 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

• _acs-templating__spellcheck__get_element_formtext (private)
• _acs-templating__spellcheck__spellcheck_properties (private)

Detailed information

 _acs-templating__spellcheck__get_element_formtext

 _acs-templating__spellcheck__spellcheck_properties

Content File Source

ad_library {
    Automated tests for spell-checker

    @author Ola Hansson (ola@polyxena.net)
    @creation-date 28 September 2003
    @cvs-id $Id: spell-checker-procs.tcl,v 1.15 2024/09/11 06:15:48 gustafn Exp $
}

aa_register_case \
    -cats { api } \
    -procs {
        parameter::get_from_package_key
        template::util::spellcheck::get_element_formtext
        util_sets_equal_p
    } \
    spellcheck__get_element_formtext {
    Test the spell-check proc that does the actual spell-checking.
} {    
    

    set SpellcheckFormWidgets [parameter::get_from_package_key \
                   -package_key acs-templating \
                   -parameter SpellcheckFormWidgets]
    set enabled 0
    foreach {widget value} $SpellcheckFormWidgets {
    if {!$value} continue
    set enabled 1
    break
    }

    if {!$enabled} {
    aa_log "Spell checking is not enabled.\
        If you want to enable it, specify it via package parameter SpellcheckFormWidgets"
    return
    }

    set base_command [list template::util::spellcheck::get_element_formtext \
              -var_to_spellcheck var_to_spellcheck \
              -error_num_ref error_num \
              -no_abort \
              -formtext_to_display_ref formtext_to_display \
              -just_the_errwords_ref just_the_errwords]
    
    #####
    #
    # Plain text without spelling mistakes
    #
    #####

    set command $base_command
    lappend command -text "This sentence does not contain any misspelled words. What we have here is plain text."
    
    aa_log "--- Correct text --- $command"

    if {[catch {eval $command} errorMsg]} {
    aa_false $errorMsg 1
    aa_log "Have you installed aspell and aspell-dict-en ?"
    return
    }
    aa_true "True statement: Text contains no misspelled words" {$error_num == 0}
    
    aa_log "Number of miss-spelled words found in text: $error_num"
    aa_false "False statement: Text contains misspelled word(s)" {$error_num > 0}
    
    aa_equals "Number of misspelled words found in text" $error_num 0
    aa_log "Returned string: $formtext_to_display"
    
    aa_true "The returned string contains a hidden var named 'var_to_spellcheck.merge_text'" \
    [regexp "var_to_spellcheck.merge_text" $formtext_to_display]

    aa_true "The returned string contains no hidden var(s) named 'var_to_spellcheck.error_N', where N is the error number." \
    ![regexp "var_to_spellcheck.error_\[0-9\]*" $formtext_to_display]

    aa_true "just_the_errwords is empty" {$just_the_errwords eq ""}
    
    #####
    #
    # Plain text with spelling mistakes
    #
    #####
    
    set command $base_command
    lappend command -text "I obviosly can't spel very well ..."
    set errwords {obviosly spel}
    
    aa_log "--- Incorrect text --- $command"

    if {[catch {eval $command} errorMsg]} {
    aa_false $errorMsg 1
    return
    }
 
    aa_true "True statement: Text contains misspelled words" {$error_num > 0}
    
    aa_log "Number of misspelled words found in text: $error_num"
    aa_false "False statement: Text contains no misspelled word(s)" {$error_num == 0}
    
    aa_log "Returned string: $formtext_to_display"
    aa_true "The returned string contains a hidden var named 'var_to_spellcheck.merge_text'" \
    [regexp "var_to_spellcheck.merge_text" $formtext_to_display]

    aa_true "The returned string contains $error_num hidden var(s) named 'var_to_spellcheck.error_N', where N is a number between 0 and [expr {$error_num - 1}]." \
    [regexp "var_to_spellcheck.error_\[0-9\]*" $formtext_to_display]

    aa_equals "The number of misspelled words matches the number of error placeholders in the merge_text" \
        [regexp -all "var_to_spellcheck.error_\[0-9\]*" $formtext_to_display] \
        [regexp -all "\#\[0-9\]*\#" $formtext_to_display]

    aa_true "just_the_errwords contains the errwords we expected: '[join $errwords ", "]'" \
        [util_sets_equal_p $just_the_errwords $errwords]

    #####
    #
    # HTML without spelling mistakes
    #
    #####

    set command $base_command
    lappend command -text "This <i>sentence</i> does <b>not</b> contain <u>any</u> misspelled words. What we have here is <a href=\"\#\">HTML</a>."
    lappend command -html
    
    aa_log "--- Correctly spelled HTML fragment --- $command"

    if {[catch {eval $command} errorMsg]} {
    aa_false $errorMsg 1
    aa_log "Maybe you have to install aspell and aspell-dict-en?"
    return
    }
    
    aa_true "True statement: HTML fragment contains no misspelled words" {$error_num == 0}
    
    aa_log "Number of miss-spelled words found in HTML fragment: $error_num"
    aa_false "False statement: HTML fragment contains misspelled word(s)" {$error_num > 0}
    
    aa_equals "Number of misspelled words found in HTML fragment" $error_num 0
    
    aa_log "Returned string: $formtext_to_display"
    aa_true "The returned string contains a hidden var named 'var_to_spellcheck.merge_text'" \
    [regexp "var_to_spellcheck.merge_text" $formtext_to_display]

    aa_true "The returned string contains no hidden var(s) named 'var_to_spellcheck.error_N', where N is the error number." \
    ![regexp "var_to_spellcheck.error_\[0-9\]*" $formtext_to_display]

    aa_true "just_the_errwords is empty" {$just_the_errwords eq ""}

    #####
    #
    # HTML with spelling mistakes
    #
    #####

    set command $base_command
    lappend command -text "This <i>sentence</i> <b>does</b> contain misspelled worrds. What we have here is <a href=\"\#\">HTML</a>."
    lappend command -html
    set errwords {misspelled worrds}
    
    aa_log "--- Incorrectly spelled HTML fragment --- $command"

    if {[catch {eval $command} errorMsg]} {
    aa_false $errorMsg 1
    return
    }

    aa_true "True statement: HTML fragment contains misspelled words" {$error_num > 0}
    
    aa_log "Number of miss-spelled words found in HTML fragment: $error_num"
    
    aa_false "False statement: HTML fragment contains no misspelled word(s)" {$error_num == 0}
    
    aa_log "Returned string: $formtext_to_display"
    
    aa_true "The returned string contains a hidden var named 'var_to_spellcheck.merge_text'" \
    [regexp "var_to_spellcheck.merge_text" $formtext_to_display]

    aa_true "The returned string contains hidden var(s) named 'var_to_spellcheck.error_N', where N is the error number." \
    [regexp "var_to_spellcheck.error_\[0-9\]*" $formtext_to_display]

    aa_true "just_the_errwords contains the errwords we expected: '[join $errwords ", "]'" \
        [util_sets_equal_p $just_the_errwords $errwords]

}


aa_register_case \
    -cats { api } \
    -procs {
        parameter::get_from_package_key
        template::util::spellcheck::spellcheck_properties
    } \
    spellcheck__spellcheck_properties {
    Test the proc that knows if spell-checking is activated, if it should be performed,
    and which value the pull-down menu should default to.
} {
    array set element {
    id test_element
    mode edit
    }

    set command {template::util::spellcheck::spellcheck_properties -element_ref element}

    # text
    set element(widget) text
    # text widget doesn't support spellcheck
    set spellcheck_p false
    aa_log "--- Spell-checking enabled on widget \"$element(widget)\"? --- $command"

    array set spellcheck [{*}$command]
    aa_false "Spell-checking disabled" $spellcheck(render_p)

    if { $spellcheck(render_p) } {
    aa_log "$spellcheck(selected_option) is the default"
    }

    # formwidgets where spellcheck is enabled
    array set widget_info [string trim [parameter::get_from_package_key \
                                            -package_key acs-templating \
                                            -parameter SpellcheckFormWidgets \
                                            -default ""]]

    # textarea
    set element(widget) textarea
    # spellcheck conf from parameter
    set spellcheck_p [expr {
                            [info exists widget_info($element(widget))]
                            && $widget_info($element(widget))
                        }]
    aa_log "--- Spell-checking enabled on widget \"$element(widget)\"? --- $command"

    array set spellcheck [{*}$command]
    aa_true "Spell-checking as configured in acs-templating.SpellcheckFormWidgets parameter" \
        {!($spellcheck(render_p) ^ $spellcheck_p)}

    if { $spellcheck(render_p) } {
    aa_log "$spellcheck(selected_option) is the default"
    }


    # richtext
    set element(widget) richtext
    # spellcheck conf from parameter
    set spellcheck_p [expr {
                            [info exists widget_info($element(widget))]
                            && $widget_info($element(widget))
                        }]
    aa_log "--- Spell-checking enabled on widget \"$element(widget)\"? --- $command"

    array set spellcheck [{*}$command]
    aa_true "Spell-checking as configured in acs-templating.SpellcheckFormWidgets parameter" \
        {!($spellcheck(render_p) ^ $spellcheck_p)}

    if { $spellcheck(render_p) } {
    aa_log "$spellcheck(selected_option) is the default"
    }

}

# Local variables:
#    mode: tcl
#    tcl-indent-level: 4
#    indent-tabs-mode: nil
# End: