modelscope 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 797e5f9be7613c91445fe7079db6889653f1807efb0c65fd571bdd4371e3dba9
-  data.tar.gz: 12c425ccff813c02fcf3570cbb7da963da2b933397af1931460e27b51373771c
+  metadata.gz: 4e40c1dcb806b8b59a48b18a239a7160b6c816e61a173896bc1f5b233395d884
+  data.tar.gz: 3cb1b59b808eaa01eba216b5e53c4b7286a8aa145fdca08697835a8716c20621
 SHA512:
-  metadata.gz: 78a6d989e9fe646b473b2e4518152ff77dd32b4d0b3adf2d29fe8bf6d86a395d068f8f4193d484ae748d86ecc7453fc0cb8d2376e52e3972c27791a0660a9030
-  data.tar.gz: 307b3ee5b3fee4df6fcd06b7a52d4606cddf409f75faafabc1a5409bd64f892441f9742f4d22fc2009585acd5c5fd4645a2b3d45921d0c2dd19fcfbfed25bb24
+  metadata.gz: 37802c37e0d1cb44f696eaea22c8531f1433e543a15ae23a5a3e283c0bb31f5bb26b948f3558d25a37aa64a81ca9ebcb1129b18aec9a4147b04500e62812b12f
+  data.tar.gz: a1c81b68ae3d3b3dfe8ff9108216ce5ec554de75724d061b8d99d1f6b1af87956f04328bf020eb3a0a71723c82ee32e89853667b60865673a9b6311d4feca8f5

data/lib/modelscope/analyzers/callback_analyzer.rb

@@ -34,16 +34,7 @@ module ModelScope
       end
 
       def inherited?
-        owner = callback_owner
-        return false unless owner
-
-        if validator?(@filter)
-          @model != @defining_class
-        else
-          owner != @model &&
-            !rails_module?(owner) &&
-            owner != @defining_class
-        end
+        @model != @defining_class
       end
 
       def conditional?

data/lib/modelscope/callback.rb

@@ -3,7 +3,8 @@
 module ModelScope
   class Callback
     attr_reader :model, :method_name, :conditional, :origin, :inherited, :kind,
-      :association_generated, :attribute_generated
+      :association_generated, :attribute_generated, :callback, :defining_class,
+      :fingerprint
 
     def initialize(model:, rails_callback:, name:, defining_class:)
       @model = model
@@ -20,6 +21,11 @@ module ModelScope
       @inherited = analyzer.inherited?
       @association_generated = analyzer.association_generated?
       @attribute_generated = analyzer.attribute_generated?
+      # fingerprint allows us to de-duplicate callbacks/validations;
+      # in most cases, it's just an object_id, but for named validations/callbacks,
+      # it's a combination of the name, kind and the method_name.
+      # The "0" and "1" prefixes define how to handle duplicates (1 means last write wins, 0 means first write wins)
+      @fingerprint = (@method_name.is_a?(Symbol) && @origin != :rails) ? ["1", @name, @kind, @method_name].join("-") : "0-#{@callback.object_id}"
     end
 
     def callback_group
@@ -34,5 +40,17 @@ module ModelScope
     def human_method_name
       Analyzers::ValidationAnalyzer.human_method_name(@callback.filter)
     end
+
+    def to_s
+      [
+        "#{model.name}: #{human_method_name}",
+        "kind=#{kind}_#{callback_group}",
+        "origin=#{origin}",
+        inherited ? "inherited=true" : nil,
+        conditional ? "conditional=true" : nil,
+        association_generated ? "association=true" : nil,
+        attribute_generated ? "attribute=true" : nil
+      ].compact.join(" ")
+    end
   end
 end

data/lib/modelscope/collector.rb

@@ -14,8 +14,8 @@ module ModelScope
       @models = Set.new(models ? [*models] : ApplicationRecord.descendants)
     end
 
-    def collect
-      models.flat_map { |model| collect_for_model(model) }
+    def collect(select_models = models)
+      select_models.flat_map { |model| collect_for_model(model) }
     end
 
     private
@@ -27,7 +27,25 @@ module ModelScope
 
     def collect_for_model(model)
       model.ancestors.select { |ancestor| ancestor < ActiveRecord::Base }
+        # collect from parent to child to correctly handle inheritance
+        .reverse
         .flat_map { |ancestor| collect_callbacks_for_class(model, ancestor) }
+        .group_by(&:fingerprint)
+        # merge groups
+        .transform_values do |callbacks|
+          probe = callbacks.first
+          if probe.fingerprint.start_with?("1")
+            # we must keep the last non-matching callback (i.e., if all callbacks are the same,
+            # we must keep the first one)
+            callbacks.each do |clbk|
+              if clbk.callback != probe.callback
+                probe = clbk
+              end
+            end
+          end
+          probe
+        end
+        .values
     end
 
     def collect_callbacks_for_class(model, klass)

data/lib/modelscope/reports/base.rb

@@ -5,9 +5,9 @@ module ModelScope
     class Base
       attr_reader :callbacks
 
-      def initialize(callbacks)
+      def initialize(callbacks, **opts)
         @callbacks = callbacks
-        @stats = Stats.new(callbacks)
+        @stats = Stats.new(callbacks, **opts)
       end
 
       def generate

data/lib/modelscope/runner.rb

@@ -4,15 +4,17 @@ module ModelScope
   class Runner
     DEFAULT_FORMAT = :table
 
-    def self.run(format: DEFAULT_FORMAT, model: nil, paths: nil, kind: :callbacks)
-      new(format: format, model: model, paths: paths, kind: kind).run
+    def self.run(format: DEFAULT_FORMAT, model: nil, paths: nil, kind: :callbacks, **opts)
+      new(format: format, model: model, paths: paths, kind: kind, **opts).run
     end
 
-    def initialize(format:, model:, paths:, kind: :callbacks)
+    def initialize(format:, model:, paths:, kind: :callbacks, sort_by: :size, sort_order: :desc)
       @format = (format || DEFAULT_FORMAT).to_sym
       @model_name = model
       @paths = paths
       @kind = kind
+      @sort_by = sort_by
+      @sort_order = sort_order
     end
 
     def run
@@ -32,7 +34,7 @@ module ModelScope
     end
 
     def generate_report(callbacks, ckind)
-      find_reporter_class(ckind).new(callbacks).generate
+      find_reporter_class(ckind).new(callbacks, sort_by: @sort_by, sort_order: @sort_order).generate
     end
 
     def find_reporter_class(ckind)

data/lib/modelscope/stats.rb

@@ -7,15 +7,31 @@ module ModelScope
       association_generated attribute_generated
     ].freeze
 
+    SORT = %i[size name].freeze
+    SORT_ORDER = %i[desc asc].freeze
+
     attr_reader :callbacks
+    private attr_reader :sort_by, :sort_order
 
-    def initialize(callbacks)
+    def initialize(callbacks, sort_by: :size, sort_order: :desc)
       @callbacks = callbacks
       @stats_cache = {}
+      @sort_by = sort_by
+      raise ArgumentError, "Invalid sort_by: #{@sort_by}. Available: #{SORT.join(", ")}" unless SORT.include?(@sort_by)
+      @sort_order = sort_order
+      raise ArgumentError, "Invalid sort_order: #{@sort_order}. Available: #{SORT_ORDER.join(", ")}" unless SORT_ORDER.include?(@sort_order)
     end
 
     def by_model
-      @by_model ||= callbacks.group_by { |cb| cb.model.name }
+      @by_model ||= callbacks.group_by { |cb| cb.model.name }.sort_by do |name, callbacks|
+        if sort_by == :size
+          callbacks.size
+        elsif sort_by == :name
+          name
+        end
+      end.tap do |sorted|
+        sorted.reverse! if sort_order == :desc
+      end.to_h
     end
 
     def stats_for(model_name)

data/lib/modelscope/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModelScope
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/modelscope.rb

@@ -12,6 +12,16 @@ module ModelScope
       loader.setup
     end
   end
+
+  def self.collect_callbacks(*models)
+    collector = Collector.new
+    collector.collect(models)
+  end
+
+  def self.collect_validations(*models)
+    collector = Collector.new(kind: :validations)
+    collector.collect(models)
+  end
 end
 
 ModelScope.loader

data/lib/tasks/modelscope.rake

@@ -13,6 +13,7 @@ namespace :modelscope do
                                  specified as constant
                                  name (MessageThread) or file path
                                  (message_thread, admin/message_thread)
+      sort=total|name            Sort by score or name (default: score:desc)
       path=DIR1,DIR2             Additional model directories (comma-separated)
 
     Examples:
@@ -20,14 +21,24 @@ namespace :modelscope do
       rake modelscope:callbacks
   DESC
   task callbacks: :environment do
-    paths = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
-
-    puts ModelScope::Runner.run(
+    opts = {
+      kind: :callbacks,
       format: ENV["format"],
-      model: ENV["model"],
-      paths: paths,
-      kind: :callbacks
-    )
+      model: ENV["model"]
+    }.compact
+
+    if ENV["path"]
+      opts[:paths] = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
+    end
+
+    if ENV["sort"]
+      sort_by, sort_order = ENV["sort"].split(":")
+      opts[:sort_by] = sort_by.to_sym
+      sort_order ||= ((sort_by == "size") ? :desc : :asc)
+      opts[:sort_order] = sort_order.to_sym
+    end
+
+    puts ModelScope::Runner.run(**opts)
   end
 
   desc <<~DESC
@@ -39,6 +50,7 @@ namespace :modelscope do
                                  specified as constant
                                  name (MessageThread) or file path
                                  (message_thread, admin/message_thread)
+      sort=total|name            Sort by score or name (default: score:desc)
       path=DIR1,DIR2             Additional model directories (comma-separated)
 
     Examples:
@@ -46,14 +58,24 @@ namespace :modelscope do
       rake modelscope:validations
   DESC
   task validations: :environment do
-    paths = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
-
-    puts ModelScope::Runner.run(
+    opts = {
+      kind: :validations,
       format: ENV["format"],
-      model: ENV["model"],
-      paths: paths,
-      kind: :validations
-    )
+      model: ENV["model"]
+    }.compact
+
+    if ENV["path"]
+      opts[:paths] = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
+    end
+
+    if ENV["sort"]
+      sort_by, sort_order = ENV["sort"].split(":")
+      opts[:sort_by] = sort_by.to_sym
+      sort_order ||= ((sort_by == "size") ? :desc : :asc)
+      opts[:sort_order] = sort_order.to_sym
+    end
+
+    puts ModelScope::Runner.run(**opts)
   end
 
   desc <<~DESC
@@ -65,16 +87,27 @@ namespace :modelscope do
                                  specified as constant
                                  name (MessageThread) or file path
                                  (message_thread, admin/message_thread)
+      sort=total|name            Sort by score or name (default: score:desc)
       path=DIR1,DIR2             Additional model directories (comma-separated)
   DESC
   task report: :environment do
-    paths = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
-
-    puts ModelScope::Runner.run(
+    opts = {
+      kind: :report,
       format: ENV["format"],
-      model: ENV["model"],
-      paths: paths,
-      kind: :report
-    )
+      model: ENV["model"]
+    }.compact
+
+    if ENV["path"]
+      opts[:paths] = ENV["path"]&.split(",")&.map { |p| Rails.root.join(p) }
+    end
+
+    if ENV["sort"]
+      sort_by, sort_order = ENV["sort"].split(":")
+      opts[:sort_by] = sort_by.to_sym
+      sort_order ||= ((sort_by == "size") ? :desc : :asc)
+      opts[:sort_order] = sort_order.to_sym
+    end
+
+    puts ModelScope::Runner.run(**opts)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modelscope
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vladimir Dementyev