Sign upLogin

TMCee/tmc-client

View on GitHub
Star
lib/tmc-client/client.rb

Summary

Maintainability
F
3 days
Test Coverage

Method update_from_zip has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

  def update_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
    zip = fetch_zip(zip_url)
    output.puts "URL: #{zip_url}"
    work_dir = Dir.pwd
    to_dir = if Dir.pwd.chomp("/").split("/").last == exercise_dir_name
Severity: Minor
Found in lib/tmc-client/client.rb - About 5 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

File client.rb has 350 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'rubygems'
require 'highline/import'
require 'json'
require 'faraday'
require 'yaml'
Severity: Minor
Found in lib/tmc-client/client.rb - About 4 hrs to fix

    Class Client has 32 methods (exceeds 20 allowed). Consider refactoring.
    Open

    class Client
  attr_accessor :courses, :config, :conn, :output, :input
  def initialize(output=$stdout, input=$stdin)
    @config = MyConfig.new
    @output = output
    Severity: Minor
    Found in lib/tmc-client/client.rb - About 4 hrs to fix

      Method update_automatically_detected_project_from_zip has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

        def update_automatically_detected_project_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
    zip = fetch_zip(exercise['zip_url'])
    work_dir = Dir.pwd
    to_dir = if Dir.pwd.chomp("/").split("/").last == exercise_dir_name
      work_dir
      Severity: Minor
      Found in lib/tmc-client/client.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

      Method update_from_zip has 40 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        def update_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
    zip = fetch_zip(zip_url)
    output.puts "URL: #{zip_url}"
    work_dir = Dir.pwd
    to_dir = if Dir.pwd.chomp("/").split("/").last == exercise_dir_name
      Severity: Minor
      Found in lib/tmc-client/client.rb - About 1 hr to fix

        Method submit_exercise has 35 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          def submit_exercise(*args)
    # Initialize course and exercise names to identify exercise to submit (from json)
    if args.count == 0 or args.all? { |arg| arg.start_with? "-" }
      exercise_dir_name = current_directory_name
      course_dir_name = previous_directory_name
        Severity: Minor
        Found in lib/tmc-client/client.rb - About 1 hr to fix

          Method status has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
          Open

            def status(submission_id_or_url)
    url = (submission_id_or_url.include? "submissions") ? submission_id_or_url : "/submissions/#{submission_id_or_url}.json?api_version=5"
    json = JSON.parse(@conn.get(url).body)
    if json['status'] != 'processing'
      puts "Status: #{json['status']}"
          Severity: Minor
          Found in lib/tmc-client/client.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 update_automatically_detected_project_from_zip has 31 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            def update_automatically_detected_project_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
    zip = fetch_zip(exercise['zip_url'])
    work_dir = Dir.pwd
    to_dir = if Dir.pwd.chomp("/").split("/").last == exercise_dir_name
      work_dir
          Severity: Minor
          Found in lib/tmc-client/client.rb - About 1 hr to fix

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

              def submit_exercise(*args)
    # Initialize course and exercise names to identify exercise to submit (from json)
    if args.count == 0 or args.all? { |arg| arg.start_with? "-" }
      exercise_dir_name = current_directory_name
      course_dir_name = previous_directory_name
            Severity: Minor
            Found in lib/tmc-client/client.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 update_exercise has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

              def update_exercise(exercise_dir_name=nil)
    # Initialize course and exercise names to identify exercise to submit (from json)
    is_universal = false
    if exercise_dir_name.nil?
      exercise_dir_name = current_directory_name
            Severity: Minor
            Found in lib/tmc-client/client.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 update_from_zip has 5 arguments (exceeds 4 allowed). Consider refactoring.
            Open

              def update_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
            Severity: Minor
            Found in lib/tmc-client/client.rb - About 35 mins to fix

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

                def update_automatically_detected_project_from_zip(zip_url, exercise_dir_name, course_dir_name, exercise, course)
              Severity: Minor
              Found in lib/tmc-client/client.rb - About 35 mins to fix

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

                  def setup_client
    begin
      @config.server_url ||= request_server_url
    rescue
      request_server_url
                Severity: Minor
                Found in lib/tmc-client/client.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

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

                          begin
            to = File.join(to_dir,file.split("/")[1..-1].join("/"))
            output.puts "copying #{file} to #{to}"
            unless File.directory? to
              FileUtils.mkdir_p(to.split("/")[0..-2].join("/"))
                Severity: Major
                Found in lib/tmc-client/client.rb and 1 other location - About 1 hr to fix
                lib/tmc-client/client.rb on lines 200..211

                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 51.

                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

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

                            begin
              to = File.join(to_dir,file.split("/")[1..-1].join("/"))
              output.puts "copying #{file} to #{to}"
              unless File.directory? to
                FileUtils.mkdir_p(to.split("/")[0..-2].join("/"))
                Severity: Major
                Found in lib/tmc-client/client.rb and 1 other location - About 1 hr to fix
                lib/tmc-client/client.rb on lines 239..250

                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 51.

                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

                There are no issues that match your filters.

                Category
                Status