adhearsion/ruby_speech

View on GitHub

Showing 13 of 13 total issues

Method repeat= has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

      def repeat=(r)
        r = "#{r.min}-#{r.max unless r.max == Inf}" if r.is_a?(Range)
        r = r.to_s
        error = ArgumentError.new "A Item's repeat must be 0 or a positive integer"

Severity: Minor
Found in lib/ruby_speech/grxml/item.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

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

  def self.phone(options = nil)
    RubySpeech::GRXML.draw mode: :dtmf, root: 'number' do
      rule id: 'number', scope: 'public' do
        item repeat: '1-' do
          ruleref uri: '#digit'
Severity: Major
Found in lib/ruby_speech/grxml/builtins.rb and 1 other location - About 1 hr to fix
lib/ruby_speech/grxml/builtins.rb on lines 91..107

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

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

  def self.currency(options = nil)
    RubySpeech::GRXML.draw mode: :dtmf, root: 'currency' do
      rule id: 'currency', scope: 'public' do
        item repeat: '0-' do
          ruleref uri: '#digit'
Severity: Major
Found in lib/ruby_speech/grxml/builtins.rb and 1 other location - About 1 hr to fix
lib/ruby_speech/grxml/builtins.rb on lines 152..168

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

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

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

      def inline!
        previous_uris = {}
        loop do
          rule = nil
          uris = {}
Severity: Minor
Found in lib/ruby_speech/grxml/grammar.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 + has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def +(other)
      new_doc = Nokogiri::XML::Document.new
      self.class.new(new_doc).tap do |new_element|
        new_doc.root = new_element.node
        string_types = [String, Nokogiri::XML::Text]
Severity: Minor
Found in lib/ruby_speech/generic_element.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 children has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def children(type = nil, attributes = nil)
      if type
        expression = namespace_href ? 'ns:' : ''
        expression << type.to_s

Severity: Minor
Found in lib/ruby_speech/generic_element.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 inline! has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      def inline!
        previous_uris = {}
        loop do
          rule = nil
          uris = {}
Severity: Minor
Found in lib/ruby_speech/grxml/grammar.rb - About 1 hr to fix

    Method element_children_key_value has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

          def element_children_key_value(element)
            return element.children.first.content if element.children.first.is_a?(Nokogiri::XML::Text)
            element.children.inject({}) do |acc, child|
              acc[child.node_name.to_sym] = case child.children.count
              when 0
    Severity: Minor
    Found in lib/ruby_speech/nlsml/document.rb - About 55 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

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

      def self.date(options = nil)
        RubySpeech::GRXML.draw mode: :dtmf, root: 'date' do
          rule id: 'date', scope: 'public' do
            item repeat: '8' do
              one_of do
    Severity: Minor
    Found in lib/ruby_speech/grxml/builtins.rb and 1 other location - About 40 mins to fix
    lib/ruby_speech/grxml/builtins.rb on lines 179..184

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

    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

      def self.time(options = nil)
        RubySpeech::GRXML.draw mode: :dtmf, root: 'time' do
          rule id: 'time', scope: 'public' do
            item repeat: '1-4' do
              one_of do
    Severity: Minor
    Found in lib/ruby_speech/grxml/builtins.rb and 1 other location - About 40 mins to fix
    lib/ruby_speech/grxml/builtins.rb on lines 40..45

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

    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

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

          def import(node)
            node = Nokogiri::XML.parse(node, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root unless node.is_a?(Nokogiri::XML::Node) || node.is_a?(GenericElement)
            return node.content if node.is_a?(Nokogiri::XML::Text)
            klass = class_from_registration node.node_name
            if klass && klass != self
    Severity: Minor
    Found in lib/ruby_speech/generic_element.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 tokenize! has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

          def tokenize!
            traverse do |element|
              next unless element.is_a? Nokogiri::XML::Text
    
              element_type = self.class.import(element.parent).class
    Severity: Minor
    Found in lib/ruby_speech/grxml/grammar.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 from_uri has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        def self.from_uri(uri)
          match = uri.match(URI_REGEX)
          raise ArgumentError, "Only builtin grammars are supported" unless match
          raise ArgumentError, "Only DTMF builtins are supported" unless match[:class] == 'dtmf'
          type = match[:type]
    Severity: Minor
    Found in lib/ruby_speech/grxml.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