Contents

# Ruby's configuration

Inch::Config.register(:ruby) do
  codebase do
    object_provider :YARD
    include_files   ['lib/**/*.rb', 'app/**/*.rb']
    exclude_files   []
  end

  evaluation do
    schema(:ConstantObject) do
      docstring           1.0

      # optional:
      unconsidered_tag    0.2
    end

    schema(:ClassVariableObject) do
      docstring           1.0

      # optional:
      unconsidered_tag    0.2
    end

    schema(:ClassObject) do
      docstring           1.0

      # optional:
      code_example_single 0.1
      code_example_multi  0.2
      unconsidered_tag    0.2
    end

    schema(:ModuleObject) do
      docstring           1.0

      # optional:
      code_example_single 0.1
      code_example_multi  0.2
      unconsidered_tag    0.2
    end

    schema(:MethodObject) do
      docstring           0.5
      parameters          0.4
      return_type         0.1
      return_description  0.3

      if object.constructor? || object.questioning_name?
        parameters          parameters + return_type
        return_type         0.0
      end

      if object.constructor?
        return_description  0.0
      end

      if !object.has_parameters? || object.setter?
        return_description  docstring + parameters
        docstring           docstring + parameters
        parameters          0.0
      end

      # optional:
      code_example_single 0.1
      code_example_multi  0.25
      unconsidered_tag    0.2
    end
  end
end

Version data entries

29 entries across 29 versions & 1 rubygems

Version	Path
inch-0.7.0	config/ruby.rb
inch-0.6.4	config/ruby.rb
inch-0.6.3	config/ruby.rb
inch-0.6.2	config/ruby.rb
inch-0.6.1	config/ruby.rb
inch-0.6.0	config/ruby.rb
inch-0.6.0.rc6	config/ruby.rb
inch-0.6.0.rc5	config/ruby.rb
inch-0.6.0.rc4	config/ruby.rb
inch-0.6.0.rc3	config/ruby.rb
inch-0.6.0.rc2	config/ruby.rb
inch-0.6.0.rc1	config/ruby.rb
inch-0.5.10	config/ruby.rb
inch-0.5.9	config/ruby.rb
inch-0.5.8	config/ruby.rb
inch-0.5.7	config/ruby.rb
inch-0.5.6	config/ruby.rb
inch-0.5.5	config/ruby.rb
inch-0.5.4	config/ruby.rb
inch-0.5.3	config/ruby.rb