cofiem/clearly-query

View on GitHub
lib/clearly/query/composer.rb

Summary

Maintainability
B
4 hrs
Test Coverage

Class has too many lines. [189/100]
Open

    class Composer
      include Clearly::Query::Compose::Conditions
      include Clearly::Query::Validate

      # All text fields operator.
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length a class exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for subquery is too high. [52.86/15]
Open

      def subquery(definition, other_definition, conditions)
        validate_definition_instance(definition)
        validate_definition_instance(other_definition)
        [conditions].flatten.each { |c| validate_node_or_attribute(c) }

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [37/10]
Open

      def subquery(definition, other_definition, conditions)
        validate_definition_instance(definition)
        validate_definition_instance(other_definition)
        [conditions].flatten.each { |c| validate_node_or_attribute(c) }

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for parse_custom is too high. [33/15]
Open

      def parse_custom(definition, field, value)
        validate_definition_instance(definition)
        validate_symbol(field)
        fail Clearly::Query::QueryArgumentError.new('field name must contain a dot (.)') unless field.to_s.include?('.')

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [27/10]
Open

      def parse_conditions(definition, query_key, query_value)
        if query_value.blank? || query_value.size < 1
          msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
          fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
        end
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for parse_conditions is too high. [32.39/15]
Open

      def parse_conditions(definition, query_key, query_value)
        if query_value.blank? || query_value.size < 1
          msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
          fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
        end
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for from_active_record is too high. [22.18/15]
Open

      def self.from_active_record
        models = ActiveRecord::Base
                     .descendants
                     .reject { |d| d.name == 'ActiveRecord::SchemaMigration' }
                     .sort { |a, b| a.name <=> b.name }
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method has too many lines. [16/10]
Open

      def parse_custom(definition, field, value)
        validate_definition_instance(definition)
        validate_symbol(field)
        fail Clearly::Query::QueryArgumentError.new('field name must contain a dot (.)') unless field.to_s.include?('.')

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [15/10]
Open

      def parse_all_text_fields(definition, value)
        validate_definition_instance(definition)
        validate_not_blank(value)
        validate_hash(value)

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [14/10]
Open

      def self.from_active_record
        models = ActiveRecord::Base
                     .descendants
                     .reject { |d| d.name == 'ActiveRecord::SchemaMigration' }
                     .sort { |a, b| a.name <=> b.name }
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Cyclomatic complexity for parse_conditions is too high. [8/6]
Open

      def parse_conditions(definition, query_key, query_value)
        if query_value.blank? || query_value.size < 1
          msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
          fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
        end
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Cyclomatic complexity for subquery is too high. [8/6]
Open

      def subquery(definition, other_definition, conditions)
        validate_definition_instance(definition)
        validate_definition_instance(other_definition)
        [conditions].flatten.each { |c| validate_node_or_attribute(c) }

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Perceived complexity for subquery is too high. [9/7]
Open

      def subquery(definition, other_definition, conditions)
        validate_definition_instance(definition)
        validate_definition_instance(other_definition)
        [conditions].flatten.each { |c| validate_node_or_attribute(c) }

Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Perceived complexity for parse_conditions is too high. [9/7]
Open

      def parse_conditions(definition, query_key, query_value)
        if query_value.blank? || query_value.size < 1
          msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
          fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
        end
Severity: Minor
Found in lib/clearly/query/composer.rb by rubocop

This cop tries to produce a complexity score that's a measure of the complexity the reader experiences when looking at a method. For that reason it considers when nodes as something that doesn't add as much complexity as an if or a &&. Except if it's one of those special case/when constructs where there's no expression after case. Then the cop treats it as an if/elsif/elsif... and lets all the when nodes count. In contrast to the CyclomaticComplexity cop, this cop considers else nodes as adding complexity.

Example:

def my_method                   # 1
  if cond                       # 1
    case var                    # 2 (0.8 + 4 * 0.2, rounded)
    when 1 then func_one
    when 2 then func_two
    when 3 then func_three
    when 4..10 then func_other
    end
  else                          # 1
    do_something until a && b   # 2
  end                           # ===
end                             # 7 complexity points

Method subquery has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def subquery(definition, other_definition, conditions)
        validate_definition_instance(definition)
        validate_definition_instance(other_definition)
        [conditions].flatten.each { |c| validate_node_or_attribute(c) }

Severity: Minor
Found in lib/clearly/query/composer.rb - About 1 hr to fix

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

          def subquery(definition, other_definition, conditions)
            validate_definition_instance(definition)
            validate_definition_instance(other_definition)
            [conditions].flatten.each { |c| validate_node_or_attribute(c) }
    
    
    Severity: Minor
    Found in lib/clearly/query/composer.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 parse_conditions has 27 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def parse_conditions(definition, query_key, query_value)
            if query_value.blank? || query_value.size < 1
              msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
              fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
            end
    Severity: Minor
    Found in lib/clearly/query/composer.rb - About 1 hr to fix

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

            def parse_conditions(definition, query_key, query_value)
              if query_value.blank? || query_value.size < 1
                msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
                fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
              end
      Severity: Minor
      Found in lib/clearly/query/composer.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

      Use sort_by(&:name) instead of sort { |a, b| a.name <=> b.name }.
      Open

                           .sort { |a, b| a.name <=> b.name }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop identifies places where sort { |a, b| a.foo <=> b.foo } can be replaced by sort_by(&:foo). This cop also checks max and min methods.

      Example:

      # bad
      array.sort { |a, b| a.foo <=> b.foo }
      array.max { |a, b| a.foo <=> b.foo }
      array.min { |a, b| a.foo <=> b.foo }
      array.sort { |a, b| a[:foo] <=> b[:foo] }
      
      # good
      array.sort_by(&:foo)
      array.sort_by { |v| v.foo }
      array.sort_by do |var|
        var.foo
      end
      array.max_by(&:foo)
      array.min_by(&:foo)
      array.sort_by { |a| a[:foo] }

      Space inside } missing.
      Open

                  Clearly::Query::Definition.new({table: d.arel_table})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Space inside { missing.
      Open

                fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Use empty? instead of size < 1.
      Open

              if query_value.blank? || query_value.size < 1
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for numeric comparisons that can be replaced by a predicate method, such as receiver.length == 0, receiver.length > 0, receiver.length != 0, receiver.length < 1 and receiver.size == 0 that can be replaced by receiver.empty? and !receiver.empty.

      Example:

      # bad
      [1, 2, 3].length == 0
      0 == "foobar".length
      array.length < 1
      {a: 1, b: 2}.length != 0
      string.length > 0
      hash.size > 0
      
      # good
      [1, 2, 3].empty?
      "foobar".empty?
      array.empty?
      !{a: 1, b: 2}.empty?
      !string.empty?
      !hash.empty?

      Extra empty line detected at block body end.
      Open

      
              end
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cops checks if empty lines around the bodies of blocks match the configuration.

      Example: EnforcedStyle: empty_lines

      # good
      
      foo do |bar|
      
        # ...
      
      end

      Example: EnforcedStyle: noemptylines (default)

      # good
      
      foo do |bar|
        # ...
      end

      Line is too long. [120/80]
      Open

              fail Clearly::Query::QueryArgumentError.new('field name must contain a dot (.)') unless field.to_s.include?('.')
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [95/80]
      Open

                arel_table = join_table.respond_to?(:arel_table) ? join_table.arel_table : join_table
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [85/80]
      Open

                field_conditions = parse_standard_field(definition, query_key, query_value)
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Always use raise to signal exceptions.
      Open

              fail Clearly::Query::QueryArgumentError.new('field name must contain a dot (.)') unless field.to_s.include?('.')
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for uses of fail and raise.

      Example: EnforcedStyle: only_raise (default)

      # The `only_raise` style enforces the sole use of `raise`.
      # bad
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail
      
      # good
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise

      Example: EnforcedStyle: only_fail

      # The `only_fail` style enforces the sole use of `fail`.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail

      Example: EnforcedStyle: semantic

      # The `semantic` style enforces the use of `fail` to signal an
      # exception, then will use `raise` to trigger an offense after
      # it has been rescued.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        # Error thrown
      rescue Exception
        fail
      end
      
      Kernel.fail
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        raise 'Preferably with descriptive message'
      end
      
      explicit_receiver.fail
      explicit_receiver.raise

      Align .sort with ActiveRecord::Base on line 31.
      Open

                           .sort { |a, b| a.name <=> b.name }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the indentation of the method name part in method calls that span more than one line.

      Example: EnforcedStyle: aligned

      # bad
      while myvariable
      .b
        # do something
      end
      
      # good
      while myvariable
            .b
        # do something
      end
      
      # good
      Thing.a
           .b
           .c

      Example: EnforcedStyle: indented

      # good
      while myvariable
        .b
      
        # do something
      end

      Example: EnforcedStyle: indentedrelativeto_receiver

      # good
      while myvariable
              .a
              .b
      
        # do something
      end
      
      # good
      myvariable = Thing
                     .a
                     .b
                     .c

      Line is too long. [85/80]
      Open

                join_path_current_index = item.find_index { |j| j[:join] == current_model }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Provide an exception class and message as arguments to fail.
      Open

              fail Clearly::Query::QueryArgumentError.new('field name must contain a dot (.)') unless field.to_s.include?('.')
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the args passed to fail and raise. For exploded style (default), it recommends passing the exception class and message to raise, rather than construct an instance of the error. It will still allow passing just a message, or the construction of an error with more than one argument.

      The exploded style works identically, but with the addition that it will also suggest constructing error objects when the exception is passed multiple arguments.

      Example: EnforcedStyle: exploded (default)

      # bad
      raise StandardError.new("message")
      
      # good
      raise StandardError, "message"
      fail "message"
      raise MyCustomError.new(arg1, arg2, arg3)
      raise MyKwArgError.new(key1: val1, key2: val2)

      Example: EnforcedStyle: compact

      # bad
      raise StandardError, "message"
      raise RuntimeError, arg1, arg2, arg3
      
      # good
      raise StandardError.new("message")
      raise MyCustomError.new(arg1, arg2, arg3)
      fail "message"

      Align .reject with ActiveRecord::Base on line 31.
      Open

                           .reject { |d| d.name == 'ActiveRecord::SchemaMigration' }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the indentation of the method name part in method calls that span more than one line.

      Example: EnforcedStyle: aligned

      # bad
      while myvariable
      .b
        # do something
      end
      
      # good
      while myvariable
            .b
        # do something
      end
      
      # good
      Thing.a
           .b
           .c

      Example: EnforcedStyle: indented

      # good
      while myvariable
        .b
      
        # do something
      end

      Example: EnforcedStyle: indentedrelativeto_receiver

      # good
      while myvariable
              .a
              .b
      
        # do something
      end
      
      # good
      myvariable = Thing
                     .a
                     .b
                     .c

      Space inside { missing.
      Open

                  Clearly::Query::Definition.new({model: d, hash: d.clearly_query_def})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Extra empty line detected at class body end.
      Open

      
          end
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cops checks if empty lines around the bodies of classes match the configuration.

      Example: EnforcedStyle: empty_lines

      # good
      
      class Foo
      
        def bar
          # ...
        end
      
      end

      Example: EnforcedStyle: emptylinesexcept_namespace

      # good
      
      class Foo
        class Bar
      
          # ...
      
        end
      end

      Example: EnforcedStyle: emptylinesspecial

      # good
      class Foo
      
        def bar; end
      
      end

      Example: EnforcedStyle: noemptylines (default)

      # good
      
      class Foo
        def bar
          # ...
        end
      end

      Align .uniq with ActiveRecord::Base on line 31.
      Open

                           .uniq { |d| d.arel_table.name }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the indentation of the method name part in method calls that span more than one line.

      Example: EnforcedStyle: aligned

      # bad
      while myvariable
      .b
        # do something
      end
      
      # good
      while myvariable
            .b
        # do something
      end
      
      # good
      Thing.a
           .b
           .c

      Example: EnforcedStyle: indented

      # good
      while myvariable
        .b
      
        # do something
      end

      Example: EnforcedStyle: indentedrelativeto_receiver

      # good
      while myvariable
              .a
              .b
      
        # do something
      end
      
      # good
      myvariable = Thing
                     .a
                     .b
                     .c

      Space inside } missing.
      Open

                fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Line is too long. [81/80]
      Open

                  Clearly::Query::Definition.new({model: d, hash: d.clearly_query_def})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Shadowing outer local variable - value.
      Open

              conditions = value.map { |key, value| parse_conditions(definition, key, value) }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop looks for use of the same name as outer local variables for block arguments or block local variables. This is a mimic of the warning "shadowing outer local variable - foo" from ruby -cw.

      Example:

      # bad
      
      def some_method
        foo = 1
      
        2.times do |foo| # shadowing outer `foo`
          do_something(foo)
        end
      end

      Example:

      # good
      
      def some_method
        foo = 1
      
        2.times do |bar|
          do_something(bar)
        end
      end

      Line is too long. [102/80]
      Open

                fail Clearly::Query::QueryArgumentError.new("unrecognised operator or field '#{query_key}'")
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [82/80]
      Open

            # Build a subquery restricting definition to conditions on other_definition.
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [83/80]
      Open

                msg = "filter hash must have at least 1 entry, got '#{query_value.size}'"
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Always use raise to signal exceptions.
      Open

                fail Clearly::Query::QueryArgumentError, "exactly one definition must match, found '#{matches.size}'"
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for uses of fail and raise.

      Example: EnforcedStyle: only_raise (default)

      # The `only_raise` style enforces the sole use of `raise`.
      # bad
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail
      
      # good
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise

      Example: EnforcedStyle: only_fail

      # The `only_fail` style enforces the sole use of `fail`.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail

      Example: EnforcedStyle: semantic

      # The `semantic` style enforces the use of `fail` to signal an
      # exception, then will use `raise` to trigger an offense after
      # it has been rescued.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        # Error thrown
      rescue Exception
        fail
      end
      
      Kernel.fail
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        raise 'Preferably with descriptive message'
      end
      
      explicit_receiver.fail
      explicit_receiver.raise

      Line is too long. [83/80]
      Open

            # Create an instance of Composer using a set of model query spec definitions.
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [88/80]
      Open

              conditions = value.map { |key, value| parse_conditions(definition, key, value) }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Space inside { missing.
      Open

                  Clearly::Query::Definition.new({table: d.arel_table})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Space inside } missing.
      Open

                  Clearly::Query::Definition.new({model: d, hash: d.clearly_query_def})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Checks that braces used for hash literals have or don't have surrounding space depending on configuration.

      Example: EnforcedStyle: space

      # The `space` style enforces that hash literals have
      # surrounding space.
      
      # bad
      h = {a: 1, b: 2}
      
      # good
      h = { a: 1, b: 2 }

      Example: EnforcedStyle: no_space

      # The `no_space` style enforces that hash literals have
      # no surrounding space.
      
      # bad
      h = { a: 1, b: 2 }
      
      # good
      h = {a: 1, b: 2}

      Example: EnforcedStyle: compact

      # The `compact` style normally requires a space inside
      # hash braces, with the exception that successive left
      # braces or right braces are collapsed together in nested hashes.
      
      # bad
      h = { a: { b: 2 } }
      
      # good
      h = { a: { b: 2 }}

      Line is too long. [111/80]
      Open

                fail Clearly::Query::QueryArgumentError, "exactly one definition must match, found '#{matches.size}'"
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Missing space after #.
      Open

              #other_joins = other_definition.joins
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, =begin- and =end comments, "shebang" directives, or rackup options.

      Example:

      # bad
      #Some comment
      
      # good
      # Some comment

      Line is too long. [81/80]
      Open

                join_path_other_index = item.find_index { |j| j[:join] == other_model }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Redundant curly braces around a hash parameter.
      Open

                  Clearly::Query::Definition.new({table: d.arel_table})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for braces around the last parameter in a method call if the last parameter is a hash. It supports braces, no_braces and context_dependent styles.

      Example: EnforcedStyle: braces

      # The `braces` style enforces braces around all method
      # parameters that are hashes.
      
      # bad
      some_method(x, y, a: 1, b: 2)
      
      # good
      some_method(x, y, {a: 1, b: 2})

      Example: EnforcedStyle: no_braces (default)

      # The `no_braces` style checks that the last parameter doesn't
      # have braces around it.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      
      # good
      some_method(x, y, a: 1, b: 2)

      Example: EnforcedStyle: context_dependent

      # The `context_dependent` style checks that the last parameter
      # doesn't have braces around it, but requires braces if the
      # second to last parameter is also a hash literal.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
      
      # good
      some_method(x, y, a: 1, b: 2)
      some_method(x, y, {a: 1, b: 2}, {a: 1, b: 2})

      Redundant curly braces around a hash parameter.
      Open

                fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for braces around the last parameter in a method call if the last parameter is a hash. It supports braces, no_braces and context_dependent styles.

      Example: EnforcedStyle: braces

      # The `braces` style enforces braces around all method
      # parameters that are hashes.
      
      # bad
      some_method(x, y, a: 1, b: 2)
      
      # good
      some_method(x, y, {a: 1, b: 2})

      Example: EnforcedStyle: no_braces (default)

      # The `no_braces` style checks that the last parameter doesn't
      # have braces around it.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      
      # good
      some_method(x, y, a: 1, b: 2)

      Example: EnforcedStyle: context_dependent

      # The `context_dependent` style checks that the last parameter
      # doesn't have braces around it, but requires braces if the
      # second to last parameter is also a hash literal.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
      
      # good
      some_method(x, y, a: 1, b: 2)
      some_method(x, y, {a: 1, b: 2}, {a: 1, b: 2})

      Line is too long. [115/80]
      Open

                    condition_components(operator, definition.table, text_field, definition.text_fields, operation_value)
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Redundant curly braces around a hash parameter.
      Open

                  Clearly::Query::Definition.new({model: d, hash: d.clearly_query_def})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for braces around the last parameter in a method call if the last parameter is a hash. It supports braces, no_braces and context_dependent styles.

      Example: EnforcedStyle: braces

      # The `braces` style enforces braces around all method
      # parameters that are hashes.
      
      # bad
      some_method(x, y, a: 1, b: 2)
      
      # good
      some_method(x, y, {a: 1, b: 2})

      Example: EnforcedStyle: no_braces (default)

      # The `no_braces` style checks that the last parameter doesn't
      # have braces around it.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      
      # good
      some_method(x, y, a: 1, b: 2)

      Example: EnforcedStyle: context_dependent

      # The `context_dependent` style checks that the last parameter
      # doesn't have braces around it, but requires braces if the
      # second to last parameter is also a hash literal.
      
      # bad
      some_method(x, y, {a: 1, b: 2})
      some_method(x, y, {a: 1, b: 2}, a: 1, b: 2)
      
      # good
      some_method(x, y, a: 1, b: 2)
      some_method(x, y, {a: 1, b: 2}, {a: 1, b: 2})

      Extra empty line detected at module body beginning.
      Open

      
          # Class that composes a query from a filter hash.
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cops checks if empty lines around the bodies of modules match the configuration.

      Example: EnforcedStyle: empty_lines

      # good
      
      module Foo
      
        def bar
          # ...
        end
      
      end

      Example: EnforcedStyle: emptylinesexcept_namespace

      # good
      
      module Foo
        module Bar
      
          # ...
      
        end
      end

      Example: EnforcedStyle: emptylinesspecial

      # good
      module Foo
      
        def bar; end
      
      end

      Example: EnforcedStyle: noemptylines (default)

      # good
      
      module Foo
        def bar
          # ...
        end
      end

      Extra blank line detected.
      Open

      
              which_joins = current_joins
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cops checks for two or more consecutive blank lines.

      Example:

      # bad - It has two empty lines.
      some_method
      # one empty line
      # two empty lines
      some_method
      
      # good
      some_method
      # one empty line
      some_method

      Align .descendants with ActiveRecord::Base on line 31.
      Open

                           .descendants
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the indentation of the method name part in method calls that span more than one line.

      Example: EnforcedStyle: aligned

      # bad
      while myvariable
      .b
        # do something
      end
      
      # good
      while myvariable
            .b
        # do something
      end
      
      # good
      Thing.a
           .b
           .c

      Example: EnforcedStyle: indented

      # good
      while myvariable
        .b
      
        # do something
      end

      Example: EnforcedStyle: indentedrelativeto_receiver

      # good
      while myvariable
              .a
              .b
      
        # do something
      end
      
      # good
      myvariable = Thing
                     .a
                     .b
                     .c

      self used in void context.
      Open

              self
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for operators, variables and literals used in void context.

      Example:

      # bad
      
      def some_method
        some_num * 10
        do_something
      end

      Example:

      # bad
      
      def some_method(some_var)
        some_var
        do_something
      end

      Example:

      # good
      
      def some_method
        do_something
        some_num * 10
      end

      Example:

      # good
      
      def some_method(some_var)
        do_something
        some_var
      end

      Line is too long. [82/80]
      Open

              logical_operators = Clearly::Query::Compose::Conditions::OPERATORS_LOGICAL
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Missing space after #.
      Open

              #current_table = definition.table
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks whether comments have a leading space after the # denoting the start of the comment. The leading space is not required for some RDoc special syntax, like #++, #--, #:nodoc, =begin- and =end comments, "shebang" directives, or rackup options.

      Example:

      # bad
      #Some comment
      
      # good
      # Some comment

      Line is too long. [90/80]
      Open

              matches = @definitions.select { |definition| definition.table.name == table.name }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Line is too long. [105/80]
      Open

                condition_components(operator, definition.table, field, definition.all_fields, operation_value)
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Always use raise to signal exceptions.
      Open

                fail Clearly::Query::QueryArgumentError.new(msg, {hash: query_value})
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for uses of fail and raise.

      Example: EnforcedStyle: only_raise (default)

      # The `only_raise` style enforces the sole use of `raise`.
      # bad
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail
      
      # good
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise

      Example: EnforcedStyle: only_fail

      # The `only_fail` style enforces the sole use of `fail`.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail

      Example: EnforcedStyle: semantic

      # The `semantic` style enforces the use of `fail` to signal an
      # exception, then will use `raise` to trigger an offense after
      # it has been rescued.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        # Error thrown
      rescue Exception
        fail
      end
      
      Kernel.fail
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        raise 'Preferably with descriptive message'
      end
      
      explicit_receiver.fail
      explicit_receiver.raise

      Extra blank line detected.
      Open

      
              relevant_joins.each do |j|
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cops checks for two or more consecutive blank lines.

      Example:

      # bad - It has two empty lines.
      some_method
      # one empty line
      # two empty lines
      some_method
      
      # good
      some_method
      # one empty line
      some_method

      Line is too long. [89/80]
      Open

              table_names = definition.associations_flat.map { |a| a[:join].table_name.to_sym }
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Provide an exception class and message as arguments to fail.
      Open

                fail Clearly::Query::QueryArgumentError.new("unrecognised operator or field '#{query_key}'")
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks the args passed to fail and raise. For exploded style (default), it recommends passing the exception class and message to raise, rather than construct an instance of the error. It will still allow passing just a message, or the construction of an error with more than one argument.

      The exploded style works identically, but with the addition that it will also suggest constructing error objects when the exception is passed multiple arguments.

      Example: EnforcedStyle: exploded (default)

      # bad
      raise StandardError.new("message")
      
      # good
      raise StandardError, "message"
      fail "message"
      raise MyCustomError.new(arg1, arg2, arg3)
      raise MyKwArgError.new(key1: val1, key2: val2)

      Example: EnforcedStyle: compact

      # bad
      raise StandardError, "message"
      raise RuntimeError, arg1, arg2, arg3
      
      # good
      raise StandardError.new("message")
      raise MyCustomError.new(arg1, arg2, arg3)
      fail "message"

      Line is too long. [83/80]
      Open

                field_conditions = parse_mapped_field(definition, query_key, query_value)
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      Always use raise to signal exceptions.
      Open

                fail Clearly::Query::QueryArgumentError.new("unrecognised operator or field '#{query_key}'")
      Severity: Minor
      Found in lib/clearly/query/composer.rb by rubocop

      This cop checks for uses of fail and raise.

      Example: EnforcedStyle: only_raise (default)

      # The `only_raise` style enforces the sole use of `raise`.
      # bad
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail
      
      # good
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise

      Example: EnforcedStyle: only_fail

      # The `only_fail` style enforces the sole use of `fail`.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        raise
      rescue Exception
        # handle it
      end
      
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        # handle it
      end
      
      Kernel.fail

      Example: EnforcedStyle: semantic

      # The `semantic` style enforces the use of `fail` to signal an
      # exception, then will use `raise` to trigger an offense after
      # it has been rescued.
      # bad
      begin
        raise
      rescue Exception
        # handle it
      end
      
      def watch_out
        # Error thrown
      rescue Exception
        fail
      end
      
      Kernel.fail
      Kernel.raise
      
      # good
      begin
        fail
      rescue Exception
        # handle it
      end
      
      def watch_out
        fail
      rescue Exception
        raise 'Preferably with descriptive message'
      end
      
      explicit_receiver.fail
      explicit_receiver.raise

      There are no issues that match your filters.

      Category
      Status