Contents

module Inch
  module Language
    module Elixir
      module Evaluation
        module Role
          # @abstract
          class Base < Inch::Evaluation::Role
            # Returns the type of the +object+ that is being evaluated.
            def object_type
              object.class.to_s.split("::").last.gsub(/Object$/, "").downcase
            end
          end

          # Missing is the base class for things that can be improved in the doc
          #
          class Missing < Base
            def score
              nil
            end

            # @return [Fixnum]
            #  a score that can be achieved by adding the missing thing mentioned
            #  by the role
            def potential_score
              @value.to_i
            end
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
inch-0.5.0.rc5	lib/inch/language/elixir/roles/base.rb
inch-0.5.0.rc4	lib/inch/language/elixir/roles/base.rb