#' TextFileComparator.R

#'

#' Fallback comparator for text files without any specific definied comparator.

#' This comparator contains the methods for doing basic comparisons on raw text

#' contents.

#'

#' @import stringr

#'

#' @include BinaryFileComparator.R

#'

#' @examples

#'

#' # The normal way for creating a comparator would be to call the generic

#' # factory method verifyr2::create_comparator that will automatically create

#' # the correct comparator instance based on the file types.

#'

#' file1 <- 'my_file1.txt'

#' file2 <- 'my_file2.txt'

#' comparator <- verifyr2::create_comparator(file1, file2)

#'

#' # If needed, an explicit comparator can be created as well.

#'

#' file1 <- 'my_file1.lst'

#' file2 <- 'my_file2.lst'

#' comparator <- TxtFileComparator$new(file1, file2)

#'

#' @export

#'

# Disable cyclomatic complexity lint for the R6 class definition as lintr

# considers the whole class definition as a single function.

#

# nolint start: cyclocomp_linter

TxtFileComparator <- R6::R6Class(

  "TxtFileComparator",

  inherit = BinaryFileComparator,

  public = list(

    #' @description

    #' Method for comparing the inner part for the details query. This method

    #' can be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary_inner = function(config, omit) {

      }

      }

        # all.equal returns logical vector if there are no differences

        # all.equal returns length 1/2 vector with first element comtaining text

        #  matching the pattern

        # all.equal returns length 1 vector if the number of rows are the same but

        # there are differences

      }

    },

    #' @description

    #' Method for comparing the inner part for the details query. This method

    #' can be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_details_inner = function(config, omit) {

      }

      }

      }

      }

      )

      )

        )

      )

    },

    #' @description

    #' Method for getting the inner part for the file contents query. The method

    #' returns the file contents in two separate vectors inside a list. The

    #' first vector is the file contents and the second one is the file contents

    #' processed for empty spaces and omit terms if applicable. This method can

    #' be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param contents file contents

    #' @param config   configuration values

    #' @param omit     string pattern to omit from the comparison

    #'

    vrf_contents_inner = function(contents, config, omit) {

        )

      }

      }

    },

    #' @description

    #' Inherited method for indicating whether detailed comparison is available

    #' with the current comparator. Returns an empty string if the comparator is

    #' is supported, otherwise a string that will be concatenated with the

    #' summary string.

    #'

    #' @param config configuration values

    #'

    vrf_details_supported = function(config) {

    },

    #' @description

    #' Helper for performing a binary (byte-level) summary comparison. This

    #' delegates to the BinaryFileComparator summary logic and is used by

    #' specialised comparators as a deterministic, platform-independent fallback

    #' when their detailed (text-based) comparison is disabled. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_binary_summary_inner = function(config, omit) {

    }

  )

)

# nolint end: cyclocomp_linter

#' Custom finalizer method for diffobj html content finalizing. This method is

#' used to modify the diff html output so that omitted rows have their own

#' special styling and gutters.

#'

#' @param x     comparator instance used for the comparison that is meant to

#'              be created with the factory method vrf_comparator.

#' @param x.chr character text representation of x, typically generated with

#'              the as character

#' @param omit  all lines containing the omit string will be excluded from the

#'              comparison (detaulf = NULL)

#'

#' @keywords internal

my_finalizer <- function(x, x.chr, omit) {

  # add row numbers to compare results manually for diffChr. diffobj-header

  # values need to be processed to identify the actual line numbers in summary

  # results.

    # remove the special note regarding whitespace ignoring as it is not

    # relevant with the custom whitespace ignoring supported.

      )

        )

      }

    }

    }

      } else {

      }

        ),

      )

        ),

      )

        ),

      )

    }

  }

  # custom processing for omit row styles

        # modifying maching row markup

        )

        )

        # modifying inserted row markup

        )

        )

        )

        # modifying deleted row markup

        )

        )

        )

        # highlight the ommitted part

          ),

        )

      }

    }

  }

}

#' FileComparatorFactory.R

#'

#' Factory method for creating comparator instance based on the given two files.

#'

#' @param file1 first file to compare

#' @param file2 second file to compare

#'

#' @examples

#'

#' # instantiating the compared files

#' file1 <- "file1.rtf"

#' file2 <- "file2.rtf"

#'

#' # instantiating the configuration

#' config <- Config$new()

#'

#' # instantiating a new comparator instance for every comparison:

#' comparator <- verifyr2::create_comparator(file1, file2)

#'

#' # calling the summary and details comparison methods

#' comparator$vrf_summary(config = config)

#' comparator$vrf_details(config = config)

#'

#' @include BinaryFileComparator.R

#' @include TxtFileComparator.R

#'

#' @export

#'

create_comparator <- function(file1, file2) {

  }

  # capitalize the first letter of the extension to match the comparator class

  # naming convention. tools::toTitleCase is not used here because it leaves

  # some extensions (e.g. "xlsx") untouched, which would break the lookup.

  )

  }

  # the old binary Excel format is handled by the same comparator as xlsx

  }

  # construct the comparator name

    # return the specific class instance if the class exists

    }

  }

  # generic comparator class used based on the file contents (text/binary).

  )

  # additional types that the mime::guess_type mapping doesn't handle correctly

  )

  } else {

  }

}

is_r6_class <- function(class_name) {

}

#' XlsxFileComparator.R

#'

#' Specialised comparator for Excel file comparison.

#' This comparator contains the custom handling for reading Excel file

#' contents for comparison.

#'

#' @include TxtFileComparator.R

#'

#' @examples

#'

#' # The normal way for creating a comparator would be to call the generic

#' # factory method verifyr2::create_comparator that will automatically create

#' # the correct comparator instance based on the file types.

#'

#' file1 <- 'my_file1.xlsx'

#' file2 <- 'my_file2.xlsx'

#' comparator <- verifyr2::create_comparator(file1, file2)

#'

#' # If needed, an explicit comparator can be created as well.

#'

#' file1 <- 'my_file1.xlsx'

#' file2 <- 'my_file2.xlsx'

#' comparator <- XlsxFileComparator$new(file1, file2)

#'

#' @export

#'

XlsxFileComparator <- R6::R6Class(

  "XlsxFileComparator",

  inherit = TxtFileComparator,

  public = list(

    #' @description

    #' Method for getting the single file contents for the comparison. The

    #' method returns the file contents in two separate vectors inside a list.

    #' The first vector is the file contents and the second one is the file

    #' contents with the rows matching the omit string excluded. This method

    #' is intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' For XlsxFileComparator, each sheet is read and every row is flattened to

    #' a single line. Each line is annotated with the sheet name and, when a

    #' header row is present, each cell is written as \code{Column=Value} so

    #' that any detected difference clearly indicates the sheet, the row and

    #' the column it originates from. Whether the first row is treated as a

    #' header is controlled by the \code{xlsx.header} configuration option:

    #' \code{"yes"} (default) treats it as a header, \code{"no"} treats every

    #' row as data and uses positional column names instead, flagging the

    #' sheet marker accordingly.

    #'

    #' @param file   file for which to get the contents

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_contents = function(file, config, omit) {

      }

      # whether the first row of each sheet is treated as a header is

      # controlled by config ("yes"/"no"). Fetched once as it does not change

      # between sheets.

        # Read the sheet without assuming a header. .name_repair = "minimal"

        # avoids the noisy "New names" messages readxl prints for the unnamed

        # columns.

        )

        } else {

          } else {

          }

        }

        # Sheet marker, flagging when the sheet is treated as having no header.

        } else {

        }

            # Column=Value keeps the column name next to each cell so a

            # changed cell shows which column it belongs to.

            # " | " keeps the spacing between columns consistent regardless of

            # cell content length (unlike a tab character).

        }

      }

    },

    #' @description

    #' Method for comparing the file contents on the summary level. When the

    #' detailed (readxl-based) comparison is disabled, a text-based diff of the

    #' raw xlsx bytes would give platform-dependent results, so a deterministic

    #' binary (byte-level) comparison is used instead. Otherwise the normal

    #' text-based summary comparison is used. This method is intended to be

    #' called only by the comparator classes in the processing and shouldn't be

    #' called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary_inner = function(config, omit) {

      }

    },

    #' @description

    #' Inherited method for indicating whether detailed comparison is available

    #' with the current comparator. Returns an empty string if the comparator

    #' is supported, otherwise a string that will be concatenated with the

    #' summary string.

    #'

    #' @param config configuration values

    #'

    vrf_details_supported = function(config) {

      }

    }

  )

)

generic_level_desc <- paste0(

  "Option to define whether the comparison is processed and displayed on ",

  "word or row level. Word-level processing requires additional time for ",

  "comparison calculation, so it may be advisable to disable this option ",

  "when working with large files if row-level comparison is sufficient."

)

generic_images_desc <- paste0(

  "Option to define whether embedded images should be processed for all ",

  "supported file types. Processing embedded images requires additional ",

  "time to detect and extract images from documents, so it may be ",

  "advisable to disable this option when working with large files or a ",

  "high volume of files that do not contain images."

)

generic_spaces_desc <- paste0(

  "Option to define whether differences in whitespace should be ignored ",

  "during comparison. When enabled, differences caused solely by additional ",

  "spaces or tab characters are not reported."

)

generic_debug_desc <- paste0(

  "Option to enable debugging so that the application prints diagnostic ",

  "information to the output stream. This option is available to all users ",

  "and can be enabled to include debugging details when reporting issues."

)

rtf_images_desc <- paste0(

  "Option to define whether embedded images should be processed for RTF file ",

  "types. Processing embedded images requires additional time to detect and ",

  "extract images from documents, so it may be advisable to disable this ",

  "option when working with large files or a high volume of files that do ",

  "not contain images."

)

pdf_details_desc <- paste0(

  "Option to define whether detailed PDF comparison should be performed. ",

  "Disabling this option is generally not recommended for users. However, it ",

  "may be automatically disabled by the application if the required ",

  "'pdftools' package is not available."

)

details_mode_desc <- paste0(

  "Option to define the default display mode for the details summary view. ",

  "The available options are 'full,' which displays the complete compared ",

  "file, and 'summary,' which displays only the detected differences."

)

merge_values <- function(defaults, overrides) {

      } else {

      }

    } else {

    }

  }

}

get_nested_value <- function(config, key) {

  }

}

set_nested_value <- function(config, key, value) {

  } else {

  }

}

check_magick_available <- function() {

}

check_pdftools_available <- function() {

}

check_readxl_available <- function() {

}

#' Config.R

#'

#' Class for manging the library configuration options. Creates the default

#' configuration without any source file, populates partial or missing config

#' elements, stores the config file to local machine, and provides easy access

#' methods for setting and getting config values.

#'

#' @examples

#'

#' # Creates the configuration instance. Checks automatically if there is

#' # a previously stored configuration json file available for usage. Note

#' # that you don't need to explicitly define the config file path for the

#' # Config instance - by default the config file will be searched from and

#' # written in user-specific configuration directory for the package.

#'

#' path   <- tempfile(fileext = ".json")

#' config <- Config$new(config_path = path)

#'

#' # Getting and setting configuration values

#'

#' value <- config$get("defailts.mode")

#' config$set("details.mode", "full")

#'

#' # Saving the current configuration to local machine (to tmp folder with

#' # the given explicit file path in initialization).

#'

#' config$save()

#'

#' @import jsonlite

#' @import rappdirs

#' @importFrom R6 R6Class

#'

#' @field schema configuration schema

#' @field config current configuration data

#' @field path   configuration json file path

#'

#' @export

#'

Config <- R6::R6Class(

  "Config",

  public = list(

    schema = NULL,

    config = NULL,

    path   = NULL,

    #' @description

    #' Constructor for initializing the configuration. Checks the local machine

    #' for existing configuration file is load_config = TRUE. Ensures that all

    #' the project configuration values are included.

    #'

    #' @param load_config load configuration from local machine if available

    #' @param config_path location of the used/stored configuration json file

    #'

    initialize = function(load_config = TRUE, config_path = NULL) {

      } else {

      }

      }

    },

    #' @description

    #' Method for getting schema item based on configuration key.

    #' Configuration item children are separated with a dot in the key notation.

    #'

    #' @param key configuration property key for which to get the schema item

    #'

    get_schema_item = function(key) {

    },

    #' @description

    #' Method for getting configuration value based on configuration key.

    #' Configuration item children are separated with a dot in the key notation.

    #'

    #' @param key configuration property key for which to get the value

    #'

    get = function(key) {

    },

    #' @description

    #' Method for setting configuration value based on configuration key.

    #' Configuration item children are separated with a dot in the key notation.

    #'

    #' @param key   configuration property key for which to get the value

    #' @param value value to set for the specified configuration key

    #'

    set = function(key, value) {

    },

    #' @description

    #' Method for saving the current configuration data into local machine.

    #'

    save = function() {

    },

    #' @description

    #' Helper method for getting configuration default values. These default

    #' values will be used in the configuration in case the configuration

    #' properties are not present previously.

    #'

    get_default_config = function() {

          }

        }

      }

    },

    #' @description

    #' Method for getting the full configuration schema. Apart from the

    #' configuration data, the schema contains property descriptions as well as

    #' all possible values for the configuration properties.

    #'

    get_default_schema = function() {

          ),

          ),

          ),

          )

        ),

          )

        ),

          )

        ),

          ),

            )

          )

        ),

          )

        )

      )

        )

        )

      }

        )

      }

        )

      }

    }

  )

)

#' FileComparator.R

#'

#' Comparator 'abstract' class containing the generic comparison methods and

#' handling for high level checks (like file existence). This class should never

#' be instantiated - doing that and calling the comparison methods will lead to

#' error.

#'

#' @importFrom R6 R6Class

#'

#' @field file1               file1

#' @field file2               file2

#' @field file1_contents_list file1 contents

#' @field file2_contents_list file2 contents

#' @field summary_comparison  summary comparison result

#' @field details_comparison  details comparison result

#' @field debugger            debugger instance

#'

#' @export

#'

# Disable cyclomatic complexity lint for the R6 class definition as lintr

# considers the whole class definition as a single function.

#

# nolint start: cyclocomp_linter

FileComparator <- R6::R6Class(

  "FileComparator",

  public <- list(

    file1 = NULL,

    file2 = NULL,

    file1_contents_list = NULL,

    file2_contents_list = NULL,

    summary_comparison  = NULL,

    details_comparison  = NULL,

    debugger = NULL,

    #' @description

    #' Initialize a FileComparator instance

    #'

    #' @param file1 First file to compare.

    #' @param file2 Second file to compare.

    #'

    initialize = function(file1 = NULL, file2 = NULL) {

    },

    #' @description

    #' Method for comparing the file summary information. This method is

    #' intended to be implemented only this class level. For comparator

    #' specific rules, the internal method vrf_summary_inner should be

    #' customized on lower levels instead.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary = function(config, omit = NULL) {

      }

      } else {

          }

        })

      }

    },

    #' @description

    #' Method for comparing the file details information. This method is

    #' intended to be implemented only this class level. For comparator

    #' specific rules, the internal method vrf_summary_inner should be

    #' customized on lower levels instead.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_details = function(config, omit = NULL) {

      }

      }

          )

        )

          )

        )

      } else {

            )

          )

        })

      }

    },

    #' @description

    #' "Abstract" method for comparing the inner part for the summary. This

    #' method has to be overwritten by more specialized comparator classes. This

    #' method is intended to be called only by the comparator classes in the

    #' processing and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary_inner = function(config, omit) {

    },

    #' @description

    #' "Abstract" method for comparing the inner part for the detailsThis method

    #' has to be overwritten by more specialized comparator classes. This method

    #' is intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_details_inner = function(config, omit) {

    },

    #' @description

    #' Inherited method for indicating whether detailed comparison is available

    #' with the current comparator. Returns an empty string if the comparator is

    #' is supported, otherwise a string that will be concatenated with the

    #' summary string.

    #'

    #' @param config configuration values

    #'

    vrf_details_supported = function(config) {

    },

    #' @description

    #' Method for getting specific value from the config In the initial

    #' version, returns 'NA' if null con is passed.

    #'

    #' @param config configuration values

    #' @param key    key to search from the parameters

    #'

    vrf_option_value = function(config, key) {

      }

    },

    #' @description

    #' Wrapper method for the opening a new debugging instance with Debugger

    #' class if debugging is enabled in config class. Creates the used

    #' debugger instance if needed.

    #'

    #' @param message message to debug to console

    #' @param config  configuration values

    #'

    vrf_open_debug = function(message, config) {

      }

      }

    },

    #' @description

    #' Wrapper method for the adding a new debugging message with Debugger

    #' class.

    #'

    #' @param message message to debug to console

    #'

    vrf_add_debug = function(message) {

      }

    },

    #' @description

    #' Special method for adding the compared files into debugger stack.

    #'

    vrf_add_debug_files = function() {

      }

    },

    #' @description

    #' Wrapper method for the stopping (closing) current debugging instance with

    #' Debugger class.

    #'

    vrf_close_debug = function() {

      }

    }

  )

)

# nolint end: cyclocomp_linter

#' BinaryFileComparator.R

#'

#' Fallback comparator for binary files without any specific definied

#' comparator.

#'

#' @include FileComparator.R

#'

#' @examples

#'

#' # The normal way for creating a comparator would be to call the generic

#' # factory method verifyr2::create_comparator that will automatically create

#' # the correct comparator instance based on the file types.

#'

#' file1 <- 'my_file1.bin'

#' file2 <- 'my_file2.bin'

#' comparator <- verifyr2::create_comparator(file1, file2)

#'

#' # If needed, an explicit comparator can be created as well.

#'

#' file1 <- 'my_file1.bin'

#' file2 <- 'my_file2.bin'

#' comparator <- BinaryFileComparator$new(file1, file2)

#'

#' @export

#'

BinaryFileComparator <- R6::R6Class(

  "BinaryFileComparator",

  inherit = FileComparator,

  public = list(

    #' @description

    #' Method for getting the single file contents for the comparison. This

    #' method returns the file contents in two separate vectors inside a list.

    #' The first vector is the file contents and the second one is the file

    #' contents with the rows matching the omit string excluded. This method

    #' can be overwritten by more specialized comparator classes. This method

    #' is intended to be called only by the comparator classes in the processing

    #' and shouldn not be called directly by the user.

    #'

    #' @param file   file for which to get the contents

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_contents = function(file, config, omit) {

    },

    #' @description

    #' Method for getting the inner part for the file contents query. The method

    #' returns the file contents in two separate vectors inside a list. The

    #' first vector is the file contents and the second one is the file contents

    #' with the rows matching the omit string excluded. This method can be

    #' overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn not be called directly by the user.

    #'

    #' @param contents file contents

    #' @param config   configuration values

    #' @param omit     string pattern to omit from the comparison

    #'

    vrf_contents_inner = function(contents, config, omit) {

    },

    #' @description

    #' Method for comparing the inner part for the details query. The method

    #' returns the file contents in two separate vectors inside a list. The

    #' first vector is the file contents and the second one is the file contents

    #' processed for empty spaces and omit terms if applicable. This method can

    #' be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn not be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary_inner = function(config, omit) {

      }

      }

      }

      }

    },

    #' @description

    #' Method for comparing the inner part for the details query. This method

    #' can be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_details_inner = function(config, omit) {

      )

    }

  )

)

#' TxtWithImageFileComparator.R

#'

#' "Abstract"  comparator for txt based comparator classes that can additionally

#' contain embedded images. This abstraction level contains generic logic for

#' handling embedded images and storing the related data.

#'

#' @import stringr

#'

#' @include TxtFileComparator.R

#'

#' @field file1_images_raw local property for storing image1 raw data

#' @field file2_images_raw local property for storing image2 raw data

#'

# Disable cyclomatic complexity lint for the R6 class definition as lintr

# considers the whole class definition as a single function.

#

# nolint start: cyclocomp_linter

TxtWithImagesFileComparator <- R6::R6Class(

  "TxtWithImagesFileComparator",

  inherit = TxtFileComparator,

  public = list(

    file1_images_raw = NULL,

    file2_images_raw = NULL,

    #' @description

    #' Initialize a TxtWithImagesFileComparator instance

    #'

    #' @param file1 First file to compare.

    #' @param file2 Second file to compare.

    #'

    initialize = function(file1 = NULL, file2 = NULL) {

    },

    #' @description

    #' Method for comparing the inner part for the details query. This method

    #' can be overwritten by more specialized comparator classes. This method is

    #' intended to be called only by the comparator classes in the processing

    #' and shouldn't be called directly by the user.

    #'

    #' @param config configuration values

    #' @param omit   string pattern to omit from the comparison

    #'

    vrf_summary_inner = function(config, omit) {

        }

        }

        # Generate additional summary string based on embedded image differences

        # if applicable.

            # Number of found embedded images differs between the files.