adlint 1.18.6 → 2.0.0

data/lib/adlint/message.rb

@@ -55,10 +55,10 @@ module AdLint #:nodoc:
     # _id_:: Symbol -- Message ID symbol.
     # _location_:: Location -- Location where the message detected.
     # _parts_:: Array< Object > -- Message formatting parts.
-    def initialize(id, location, *parts)
-      @id, @location = id, location
+    def initialize(package, id, location, *parts)
+      @package, @id, @location = package, id, location
       @parts = parts
-      validate_id(@id, @location)
+      validate_id(@package, @id, @location)
     end
 
     attr_reader :id
@@ -91,17 +91,31 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # Array< Object > -- Array of message elements.
     def to_a
-      if templ = MessageCatalog.instance[@id]
+      if templ = MessageCatalog.instance.lookup(@package, @id)
         begin
-          mesg = templ.to_default_external %
-            @parts.map { |obj| obj.to_s.to_default_external }
-          [type.to_s, @location.fpath, @location.line_no, @location.column_no,
-            @id, mesg]
+          if Traits.instance.of_message.message_with_class
+            [
+              type.to_s,
+              @location.fpath, @location.line_no, @location.column_no,
+              templ.package,
+              @id,
+              templ.typical_class.category,
+              templ.typical_class.severity,
+              templ.format(@parts)
+            ]
+          else
+            [
+              type.to_s,
+              @location.fpath, @location.line_no, @location.column_no,
+              @id,
+              templ.format(@parts)
+            ]
+          end
         rescue
-          raise InvalidMessageFormatError.new(@id, @location)
+          raise InvalidMessageFormatError.new(@package, @id, @location)
         end
       else
-        raise InvalidMessageIdError.new(@id, @location)
+        raise InvalidMessageIdError.new(@package, @id, @location)
       end
     end
 
@@ -111,9 +125,21 @@ module AdLint #:nodoc:
     # === RETURN VALUE
     # String -- String representation of this message.
     def to_s
-      @location.to_s.to_default_external +
-        ":#{type_str.to_default_external}:%5$s:%6$s".to_default_external %
-          to_a.map { |obj| obj.to_s.to_default_external }
+      if templ = MessageCatalog.instance.lookup(@package, @id)
+        begin
+          "#{@location.to_s.to_default_external}:" +
+            "#{type_str.to_default_external}:" +
+            "#{templ.package}:" +
+            "#{@id.to_s.to_default_external}:" +
+            "#{templ.typical_class.category}:" +
+            "#{templ.typical_class.severity}:" +
+            "#{templ.format(@parts)}"
+        rescue
+          raise InvalidMessageFormatError.new(@package, @id, @location)
+        end
+      else
+        raise InvalidMessageIdError.new(@package, @id, @location)
+      end
     end
 
     def to_csv
@@ -142,9 +168,9 @@ module AdLint #:nodoc:
     #
     # === RETURN VALUE
     # None.
-    def validate_id(id, location)
-      MessageCatalog.instance[id] or
-        raise InvalidMessageIdError.new(id, location)
+    def validate_id(package, id, location)
+      MessageCatalog.instance.lookup(package, id) or
+        raise InvalidMessageIdError.new(package, id, location)
       nil
     end
   end
@@ -152,6 +178,10 @@ module AdLint #:nodoc:
   # == DESCRIPTION
   # Syntactical error message.
   class ErrorMessage < Message
+    def initialize(id, location, *parts)
+      super("core", id, location, *parts)
+    end
+
     # === DESCRIPTION
     # Reads the type of this message.
     #
@@ -180,7 +210,7 @@ module AdLint #:nodoc:
     # === PARAMETER
     # _exception_:: Exception -- Cause exception.
     def initialize(exception)
-      super(exception.id,
+      super("core", exception.id,
             exception.location ? exception.location : Location.new,
             *exception.parts)
       @exception = exception
@@ -249,68 +279,82 @@ module AdLint #:nodoc:
     end
   end
 
+  class MessageClass
+    def initialize(class_str)
+      @category, @severity = class_str.split(":")
+    end
+
+    def category
+      @category.to_s.to_default_external
+    end
+
+    def severity
+      @severity.to_s.to_default_external
+    end
+  end
+
   # == DESCRIPTION
   # Message catalog entry.
-  class MessageTemplate < String; end
+  class MessageTemplate
+    def initialize(package, classes, format)
+      @package = package
+      @classes = classes.map { |class_str| MessageClass.new(class_str) }
+      @format = format
+      @typical_class = @classes.sort { |mesg_class| mesg_class.severity }.first
+    end
 
-  # == DESCRIPTION
-  # Message catalog.
-  class MessageCatalog < Hash
-    include Singleton
+    attr_reader :classes
+    attr_reader :typical_class
 
-    DEFAULT_DNAME = Pathname.new("mesg.d")
-    private_constant :DEFAULT_DNAME
+    def package
+      @package.to_s.to_default_external
+    end
+
+    def format(parts)
+      @format.to_s.to_default_external %
+        parts.map { |obj| obj.to_s.to_default_external }
+    end
+  end
 
-    DEFAULT_FNAME = Pathname.new("messages.yml")
-    private_constant :DEFAULT_FNAME
+  class MessageDefinitionFile
+    MESSAGES_FNAME = Pathname.new("messages.yml")
+    private_constant :MESSAGES_FNAME
 
-    def load(fpath = nil)
-      unless fpath
-        mesg_dpath = DEFAULT_DNAME.expand_path($etcdir)
-        lang_dpath = Pathname.new(Traits.instance.of_message.language)
-        fpath = mesg_dpath.join(lang_dpath).join(DEFAULT_FNAME)
-      end
-      File.open(fpath, "r:utf-8") { |io| read_from(io) }
+    def initialize(package_name)
+      @package_name = package_name
     end
 
-    # === DESCRIPTION
-    # Loads message templates from the message definition file.
-    #
-    # === PARAMETER
-    # _io_:: IO -- I/O object for the message definition file.
-    #
-    # === RETURN VALUE
-    # MessageCatalog -- Self.
-    def read_from(io)
-      case array_or_stream = YAML.load_stream(io)
-      when Array
-        # NOTE: YAML.load_stream returns Array in Ruby 1.9.3-preview1.
-        doc = array_or_stream.first
-      when YAML::Stream
-        doc = array_or_stream.documents.first
-      end
-      version = doc["version"]
-      validate_version(version)
-      if message_definition = doc["message_definition"]
-        message_definition.each do |id, text|
-          if changed = Traits.instance.of_message.change_list[id.intern]
-            self[id.intern] = MessageTemplate.new(changed)
-          else
-            self[id.intern] = MessageTemplate.new(text)
-          end
+    attr_reader :package_name
+
+    def read_into(message_catalog)
+      File.open(fpath, "r:utf-8") do |io|
+        case array_or_stream = YAML.load_stream(io)
+        when Array
+          # NOTE: YAML.load_stream returns Array in Ruby 1.9.3-preview1.
+          doc = array_or_stream.first
+        when YAML::Stream
+          doc = array_or_stream.documents.first
+        end
+        validate_version(doc["version"])
+        if message_definition = doc["message_definition"]
+          message_catalog.merge!(package_name, message_definition)
+        else
+          raise "invalid form of the message definition file."
         end
-      else
-        raise "invalid form of the message definition file."
       end
       self
     end
 
     private
-    # === DESCRIPTION
-    # Validates the version of the message definition file.
-    #
-    # === RETURN VALUE
-    # None.
+    def base_dpath
+      subclass_responsibility
+    end
+
+    def fpath
+      lang_dpath = Pathname.new(Traits.instance.of_message.language)
+      base_dpath.join(lang_dpath).join(MESSAGES_FNAME)
+    end
+
     def validate_version(version)
       # NOTE: Version field of the message catalog does not mean the schema
       #       version of the catalog file, but a revision number of the catalog
@@ -321,51 +365,64 @@ module AdLint #:nodoc:
     end
   end
 
-  # == DESCRIPTION
-  # Base of message detection classes.
-  class MessageDetection
-    # === DESCRIPTION
-    # Constructs a message detecting object.
-    #
-    # === PARAMETER
-    # _context_:: PhaseContext -- Analysis context.
-    def initialize(context)
-      @context = context
+  class CoreMessageDefinitionFile < MessageDefinitionFile
+    def initialize
+      super("core")
     end
 
-    # === DESCRIPTION
-    # Executes a message detecting.
-    def execute
-      do_prepare(@context)
-      do_execute(@context)
+    private
+    def base_dpath
+      Pathname.new("mesg.d/core").expand_path($etcdir)
+    end
+  end
+
+  class ExamMessageDefinitionFile < MessageDefinitionFile
+    def initialize(exam_package)
+      super(exam_package.name)
+      @exam_package = exam_package
     end
 
     private
-    # === DESCRIPTION
-    # Initializes a message.
-    #
-    # Subclasses must implement this method.
-    def do_prepare(context)
-      subclass_responsibility
+    def base_dpath
+      @exam_package.catalog.message_definition_dpath
     end
+  end
 
-    # === DESCRIPTION
-    # Detects a message.
-    #
-    # Subclasses must implement this method.
-    def do_execute(context)
-      subclass_responsibility
+  # == DESCRIPTION
+  # Message catalog.
+  class MessageCatalog
+    include Singleton
+
+    def initialize
+      @hash = Hash.new
     end
 
-    def report
-      @context.report
+    def lookup(package_name, mesg_id)
+      @hash[[package_name, mesg_id]]
+    end
+
+    def merge!(package_name, message_definition)
+      message_definition.each do |id, content|
+        message_traits = Traits.instance.of_message
+        if changed = message_traits.change_list[[package_name, id.intern]]
+          content = changed
+        end
+        @hash[[package_name, id.intern]] = MessageTemplate.new(
+          package_name, content["classes"], content["format"])
+      end
+    end
+
+    def load
+      message_definition_files.each { |mdef_file| mdef_file.read_into(self) }
     end
-  end
 
-  class PassiveMessageDetection < MessageDetection
     private
-    def do_prepare(context) end
-    def do_execute(context) end
+    def message_definition_files
+      [CoreMessageDefinitionFile.new] +
+        Traits.instance.exam_packages.map { |exam_package|
+          ExamMessageDefinitionFile.new(exam_package)
+        }
+    end
   end
 
 end

data/lib/adlint/metric.rb

@@ -29,8 +29,6 @@
 #
 #++
 
-require "adlint/token"
-require "adlint/code"
 require "adlint/util"
 
 module AdLint #:nodoc:
@@ -267,31 +265,6 @@ module AdLint #:nodoc:
     end
   end
 
-  # == Base of metric measurement classes.
-  class MetricMeasurement
-    def initialize(context)
-      @context = context
-    end
-
-    def execute
-      do_prepare(@context)
-      do_execute(@context)
-    end
-
-    private
-    def do_prepare(context)
-      subclass_responsibility
-    end
-
-    def do_execute(context)
-      subclass_responsibility
-    end
-
-    def report
-      @context.report
-    end
-  end
-
   class MetricRecord < CsvRecord
     def self.of(csv_row)
       case csv_row[0]

data/lib/adlint/phase.rb

@@ -45,14 +45,19 @@ module AdLint #:nodoc:
     #
     # === PARAMETER
     # _context_:: PhaseContext -- Analysis context.
-    def initialize(context)
+    def initialize(context, package_name, phase_name)
       @context = context
+      @package_name = package_name
+      @phase_name = phase_name
     end
 
     # === DESCRIPTION
     # Executes the analysis.
     def execute
-      do_execute(@context)
+      monitored_region(@phase_name) do |monitor|
+        do_execute(@context, monitor)
+        register_examinations
+      end
     rescue Error => ex
       @context.report.add_message(Message.from_exception(ex))
       raise
@@ -63,9 +68,29 @@ module AdLint #:nodoc:
     # Executes the analysis.
     #
     # Subclasses must implement this method.
-    def do_execute(context)
+    def do_execute(context, monitor)
       subclass_responsibility
     end
+
+    def register_examinations
+      context_key = context_key_of("examinations")
+      @context[context_key] ||= []
+      Traits.instance.exam_packages.each do |exam_package|
+        exam_package.catalog.examination_classes.each do |exam_class|
+          if exam_class.registrant_phase_class == self.class
+            @context[context_key].push(exam_class.new(@context))
+          end
+        end
+      end
+    end
+
+    def examinations
+      @context[context_key_of("examinations")] || []
+    end
+
+    def context_key_of(str)
+      "#{@package_name}_#{str}".intern
+    end
   end
 
   class PhaseContext < Hash

data/lib/adlint/report.rb

@@ -29,10 +29,11 @@
 #
 #++
 
-require "adlint/token"
+require "adlint/exam"
 require "adlint/message"
 require "adlint/code"
 require "adlint/metric"
+require "adlint/util"
 
 module AdLint #:nodoc:
 
@@ -163,11 +164,16 @@ module AdLint #:nodoc:
     #
     # === RETURN VALUE
     # None.
-    def add_warning_message(id, location, *parts)
-      add_message(WarningMessage.new(id, location, *parts))
+    def add_warning_message(package, id, location, *parts)
+      add_message(WarningMessage.new(package, id, location, *parts))
     end
-    alias :W :add_warning_message
-    module_function :add_warning_message, :W
+    module_function :add_warning_message
+
+    def W(id, location, *parts)
+      add_warning_message(PackageResolver.package_name_of(self.class),
+                          id, location, *parts)
+    end
+    module_function :W
 
     # === DESCRIPTION
     # Adds a context message to the report.
@@ -182,11 +188,16 @@ module AdLint #:nodoc:
     #
     # === RETURN VALUE
     # None.
-    def add_context_message(id, location, *parts)
-      add_message(ContextMessage.new(id, location, *parts))
+    def add_context_message(package, id, location, *parts)
+      add_message(ContextMessage.new(package, id, location, *parts))
+    end
+    module_function :add_context_message
+
+    def C(id, location, *parts)
+      add_context_message(PackageResolver.package_name_of(self.class),
+                          id, location, *parts)
     end
-    alias :C :add_context_message
-    module_function :add_context_message, :C
+    module_function :C
 
     # === DESCRIPTION
     # Adds a message to the report.
@@ -610,8 +621,7 @@ module AdLint #:nodoc:
     module_function :add_code_metric
   end
 
-  CodeExtraction.class_eval { include ReportUtil }
-  MessageDetection.class_eval { extend MessageUniqueness; include ReportUtil }
-  MetricMeasurement.class_eval { include ReportUtil }
+  Examination.class_eval { include ReportUtil }
+  CodeCheck.class_eval { extend MessageUniqueness }
 
 end