Sign upLogin

BBC-News/wraith

View on GitHub
Star

Showing 12 of 12 total issues

Class Wraith has 34 methods (exceeds 20 allowed). Consider refactoring.
Open

class Wraith::Wraith
  include Logging
  attr_accessor :config

  def initialize(config, options = {})
Severity: Minor
Found in lib/wraith/wraith.rb - About 4 hrs to fix

    Method capture_image_selenium has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

      def capture_image_selenium(screen_sizes, url, file_name, selector, global_before_capture, path_before_capture)
    driver = get_driver
    driver.manage.timeouts.implicit_wait = 10;
    screen_sizes.to_s.split(",").each do |screen_size|
      for attempt in 1..3 do
    Severity: Minor
    Found in lib/wraith/save_images.rb - About 2 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      if (globalBeforeCaptureJS && pathBeforeCaptureJS) {
    require(globalBeforeCaptureJS)(self, function thenExecuteOtherBeforeCaptureFile() {
      require(pathBeforeCaptureJS)(self, captureImage);
    });
  }
    Severity: Major
    Found in lib/wraith/javascript/casper.js and 1 other location - About 2 hrs to fix
    lib/wraith/javascript/phantom.js on lines 97..110

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 92.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

      if (globalBeforeCaptureJS && pathBeforeCaptureJS) {
    require(globalBeforeCaptureJS)(page, function thenExecuteOtherBeforeCaptureFile() {
      require(pathBeforeCaptureJS)(page, callback);
    });
  }
    Severity: Major
    Found in lib/wraith/javascript/phantom.js and 1 other location - About 2 hrs to fix
    lib/wraith/javascript/casper.js on lines 61..74

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 92.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Function exports has 34 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    module.exports = function (commandLineDimensions) {

    commandLineDimensions = '' + commandLineDimensions; // cast to string

    function getWidthAndHeight(dimensions) {
    Severity: Minor
    Found in lib/wraith/javascript/_helper.js - About 1 hr to fix

      Method threshold_rate has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

        def threshold_rate(dirs)
    dirs.each do |_folder_name, shot_info|
      shot_info.each do |_k, v|
        begin
          return false unless v.include?(:diff)
      Severity: Minor
      Found in lib/wraith/folder.rb - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Method construct_command has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

        def construct_command(width, url, file_name, selector, global_before_capture, path_before_capture)
      Severity: Minor
      Found in lib/wraith/save_images.rb - About 45 mins to fix

        Method check_failed_shots has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

          def check_failed_shots
    if @multi
      return false
    elsif @failed_shots == false
      logger.warn "Failures detected:"
        Severity: Minor
        Found in lib/wraith/gallery.rb - About 45 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method capture_image_selenium has 6 arguments (exceeds 4 allowed). Consider refactoring.
        Open

          def capture_image_selenium(screen_sizes, url, file_name, selector, global_before_capture, path_before_capture)
        Severity: Minor
        Found in lib/wraith/save_images.rb - About 45 mins to fix

          Method generate_html has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

            def generate_html(location, directories, template, destination, path)
          Severity: Minor
          Found in lib/wraith/gallery.rb - About 35 mins to fix

            Method initialize has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
            Open

              def initialize(config, options = {})
    options = {
      yaml_passed: false,
      imports_must_resolve: true,
    }.merge(options)
            Severity: Minor
            Found in lib/wraith/wraith.rb - About 35 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Method logger has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

              def self.logger
    unless @logger
      @logger = Logger.new(STDOUT)
      @logger.formatter = proc do |severity, _datetime, _progname, msg|
        (severity == "INFO") ? "#{msg}\n" : "#{severity}: #{msg}\n"
            Severity: Minor
            Found in lib/wraith/helpers/logger.rb - About 25 mins to fix

            Cognitive Complexity

            Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

            A method's cognitive complexity is based on a few simple rules:

            • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
            • Code is considered more complex for each "break in the linear flow of the code"
            • Code is considered more complex when "flow breaking structures are nested"

            Further reading

            Severity
            Category
            Status
            Source
            Language