bonobot 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60d190ca5c05e4d29f7622276e6f387e53b06b87de3bfed7ed31446ac28b2fd9
-  data.tar.gz: 8a900dfeb52e73e177d02363e98ce429e0012a94f0d184048208968d9841dbbe
+  metadata.gz: c6014e196b254d2d08a4b6054cd1aba997d2fb9158ebe26cfbb897b1c29ef81c
+  data.tar.gz: 829215850c62ecb9409838362a463f6518120bc9f3209ea6ab059967c5c9b0b6
 SHA512:
-  metadata.gz: 5c72443158105126ae949850fcb70a588517837344c1b6cc4da90400da3e227dc44acb2bed7caf614fb64b9455739091882ae07177783b2a41aea6afbd5a9bd8
-  data.tar.gz: 31a93680b3b218ebda245eeeb1b97717bdc92e95727042523f85ae599b559635305bc030f996525bc70c76341e12304c2fd3b1a8ff42a4eee74a331c5d1a0540
+  metadata.gz: 451b94f8a0cffe4d1f05c7913055fa8446caaf3865d504dfd83f749e5e20413ea959db56e6ae4d1d9a066bc684cae5496bf7ca1d4e40ea4bd0f55db98226781b
+  data.tar.gz: 8401521e0421b536e30ef41683463d31544f1a9534461f90c7dc7a25b280a88053d0dddad1b4a09639dddeba2d9567aff9323a8d01035bee9c7650b043c56d66

data/README.md

@@ -1,10 +1,17 @@
-# Bonobo
-Short description and motivation.
+# Bonobot
+![ci_cd](https://github.com/armandfardeau/bonobot/actions/workflows/ci_cd.yml/badge.svg)
+[![codecov](https://codecov.io/gh/armandfardeau/bonobot/branch/master/graph/badge.svg?token=274POQGBAK)](https://codecov.io/gh/armandfardeau/bonobot)
+
+BonoBot is a Ruby gem that helps with Rails monkey patching.
 
 ## Usage
-How to use my plugin.
+
+```bash
+bundle exec rake bonobot: status
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +19,22 @@ gem 'bonobot'
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle exec rake bonobot:status
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install bonobot
+gem install bonobot
+bundle exec rake bonobot:status
 ```
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,6 +7,7 @@ rescue LoadError
 end
 
 require "rdoc/task"
+require "rspec/core/rake_task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "rdoc"
@@ -20,10 +21,8 @@ require "bundler/gem_tasks"
 
 require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = false
+Rake::TestTask.new(:test) do |_t|
+  RSpec::Core::RakeTask.new(:spec)
 end
 
 task default: :test

data/lib/bonobot/engine_file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Bonobot
+  class EngineFile
+    attr_reader :path, :engine_name, :short_path, :root_path
+
+    def initialize(path, engine)
+      @path = path
+      @root_path = engine.instance.root
+      @engine_name = engine_to_name(engine)
+      @short_path = path.sub("#{@root_path}/", "")
+    end
+
+    def fingerprint
+      Digest::MD5.hexdigest(File.read(@path))
+    end
+
+    def to_hash
+      instance_values.merge({ "fingerprint" => fingerprint })
+    end
+
+    private
+
+    def engine_to_name(engine_class)
+      if engine_class.respond_to?(:railtie_namespace) && engine_class.railtie_namespace
+        engine_class.railtie_namespace.to_s.split("::").map(&:underscore).join("/")
+      else
+        engine_class.engine_name.sub("_engine", "")
+      end
+    end
+  end
+end

data/lib/bonobot/engines_files_registry.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Bonobot
+  class EnginesFilesRegistry
+    def self.all
+      @all ||= deduplicate(generate)
+    end
+
+    def self.generate
+      Parallel.flat_map(::Rails::Engine.subclasses) do |klass|
+        Dir.glob(root(klass.instance.root).join("**", "*.{erb,rb}")).map do |path|
+          EngineFile.new(path, klass)
+        end
+      end
+    end
+
+    def self.deduplicate(engine_files)
+      engine_files.group_by(&:path).map { |_, files| files.min_by(&:engine_name) }
+    end
+
+    def self.find_by(attributes)
+      all.select do |local_file|
+        attributes.all? do |key, value|
+          local_file.try(key) == value
+        end
+      end
+    end
+
+    def self.output
+      all.map(&:as_json)
+    end
+
+    def self.root(path)
+      Pathname.new(path).join("app")
+    end
+  end
+end

data/lib/bonobot/local_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bonobot
+  class LocalFile
+    attr_reader :path
+
+    def initialize(path, root)
+      @path = path.sub("#{root}/", "")
+    end
+
+    def annotation
+      File.readlines(@path).map do |line|
+        line.sub(/# bonobot_fingerprint:/, "").sub("<%", "").sub("%>", "").strip if line.match?(/# bonobot_fingerprint:/) || line.match?(/<%# bonobot_fingerprint:/)
+      end.compact.first.presence
+    end
+  end
+end

data/lib/bonobot/local_files_registry.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "parallel"
+
+module Bonobot
+  class LocalFilesRegistry
+    def self.all
+      @all ||= Parallel.map(Dir.glob(root.join("**", "*.{erb,rb}"))) do |path|
+        LocalFile.new(path, rails_root)
+      end
+    end
+
+    def self.root
+      rails_root.join("app")
+    end
+
+    def self.rails_root
+      ::Rails.root
+    end
+
+    def self.output
+      all.map(&:as_json)
+    end
+  end
+end

data/lib/bonobot/overload.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bonobot
+  class Overload
+    attr_reader :engine_file
+
+    def initialize(local_file, engine_file)
+      @local_file = local_file
+      @engine_file = engine_file
+    end
+
+    def path
+      @local_file.path
+    end
+
+    def status
+      return :missing if @local_file.annotation.nil?
+      return :up_to_date if @local_file.annotation == @engine_file.fingerprint
+
+      :out_of_date
+    end
+
+    def to_hash
+      instance_values.merge({ "status" => status, "path" => path })
+    end
+  end
+end

data/lib/bonobot/overloads_registry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Bonobot
+  module OverloadsRegistry
+    def self.all
+      @all ||= LocalFilesRegistry.all.flat_map do |local_file|
+        EnginesFilesRegistry.find_by(short_path: local_file.path).map do |engine_file|
+          Overload.new(local_file, engine_file)
+        end
+      end
+    end
+
+    # TODO: Extract to module
+    def self.find_by(attributes)
+      all.select do |item|
+        attributes.all? do |key, value|
+          item.try(key) == value
+        end
+      end
+    end
+
+    def self.output
+      all.map(&:as_json)
+    end
+  end
+end

data/lib/bonobot/status.rb

@@ -4,126 +4,48 @@ require "json"
 
 module Bonobot
   class Status
+    STATUS = { up_to_date: "🥳", out_of_date: "😱", missing: "🤬" }.freeze
+
     def self.generate
       puts "-----"
       puts "🙈 🙉 🙊 Bonobot 🙈 🙉 🙊"
       puts "-----"
       puts "🛠 Generating status"
-      File.write("status.json", JSON.pretty_generate({ rails_files: rails_files, engines_files: engines_files, overloads: overloads }))
+      File.write("status.json", status_json)
       puts File.expand_path("status.json")
       puts "-----"
 
-      unless up_to_date.empty?
-        puts "🥳 Up to date fingerprint count: #{up_to_date.count}"
-        puts "-> Up to date fingerprint: #{present(up_to_date)}"
-        puts ""
-      end
-
-      unless out_of_date.empty?
-        puts "😱 Out of date fingerprint count: #{out_of_date.count}"
-        puts "-> Out of date fingerprint: #{present(out_of_date)}"
-        puts ""
-      end
-
-      unless missing.empty?
-        puts "🤬 Files missing fingerprint count: #{missing.count}"
-        puts "-> Missing fingerprint: #{present(missing)}"
-        puts ""
+      STATUS.each do |status, emoji|
+        generate_status(status, emoji)
       end
 
       puts "-----"
-      out_of_date.empty? && missing.empty?
+      OverloadsRegistry.find_by(status: :out_of_date).empty? && OverloadsRegistry.find_by(status: :missing).empty?
     end
 
-    def self.present(entry)
-      entries = entry.map do |(engine_name, source_path)|
-        "  - #{engine_name}: #{source_path[:short_path]} (#{source_path[:fingerprint]})"
+    def self.present(entries)
+      entries.map do |entry|
+        "  - #{entry.engine_file.engine_name}: #{entry.engine_file.short_path} (#{entry.engine_file.fingerprint})"
       end.join("\n")
-
-      "\n#{entries}"
-    end
-
-    def self.out_of_date
-      overloads.fetch(:out_of_date, [])
-    end
-
-    def self.up_to_date
-      overloads.fetch(:up_to_date, [])
-    end
-
-    def self.missing
-      overloads.fetch(:missing, [])
-    end
-
-    def self.overloads
-      @overloads ||= rails_files.each_with_object({}) do |(path, fingerprint), hash|
-        engines_files.keys.each do |engine_name|
-          next unless path.include? engine_name
-
-          source_path = engines_files[engine_name].fetch(path, nil)
-          next unless source_path
-
-          result = [engine_name, source_path.merge(short_path: path)]
-
-          key = status_key(source_path[:fingerprint], fingerprint)
-          if hash[key].nil?
-            hash[key] = [result]
-          else
-            hash[key] << result
-          end
-        end
-      end
     end
 
-    def self.rails_files
-      @rails_files ||= Dir.glob(Rails.root.join("app", "**", "*.{erb,rb}")).map { |path| path.sub("#{Rails.root}/", "") }.each_with_object({}) do |path, hash|
-        hash[path] = read_annotation(path)
-      end
-    end
+    def self.generate_status(status, emoji)
+      return if OverloadsRegistry.find_by(status: status).empty?
 
-    def self.engines_files
-      @engine_files ||= ::Rails::Engine.subclasses.each_with_object({}) do |klass, hash|
-        paths = Dir.glob("#{klass.instance.root}/app/**/*.{erb,rb}")
-        next if paths.empty?
+      overload_status = OverloadsRegistry.find_by(status: status)
+      status_to_text = status.to_s.capitalize.gsub("_", " ")
 
-        hash[engine_to_gem(klass)] = engine_paths(paths)
-      end
+      puts "-> #{emoji} #{status_to_text} fingerprint (#{overload_status.count}):"
+      puts present(OverloadsRegistry.find_by(status: status))
+      puts ""
     end
 
-    def self.engine_to_gem(engine_class)
-      if engine_class.respond_to?(:railtie_namespace) && engine_class.railtie_namespace
-        engine_class.railtie_namespace.to_s.split("::").map(&:underscore).join("/")
-      else
-        engine_class.engine_name.sub("_engine", "")
-      end
-    end
-
-    def self.engine_paths(paths)
-      paths.each_with_object({}) do |path, hash|
-        _name, *short_path = path.sub("#{gems_dir}/gems/", "").split("/")
-        hash[short_path.join("/")] = { path: path, fingerprint: fingerprint(path) }
-      end
-    end
-
-    def self.fingerprint(path)
-      Digest::MD5.hexdigest(File.read(path))
-    end
-
-    def self.gems_dir
-      @gems_dir ||= Bundler.rubygems.gem_dir
-    end
-
-    def self.read_annotation(path)
-      File.readlines(path).map do |line|
-        line.sub(/# bonobot_fingerprint:/, "").sub("<%", "").sub("%>", "").strip if line.match?(/# bonobot_fingerprint:/) || line.match?(/<%# bonobot_fingerprint:/)
-      end.compact.first
-    end
-
-    def self.status_key(source_fingerprint, target_fingerprint)
-      return :up_to_date if source_fingerprint == target_fingerprint
-      return :missing if target_fingerprint.nil?
-
-      :out_of_date
+    def self.status_json
+      JSON.pretty_generate({
+                             rails_files: LocalFilesRegistry.output,
+                             engines_files: EnginesFilesRegistry.output,
+                             overloads: OverloadsRegistry.output
+                           })
     end
   end
 end

data/lib/bonobot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bonobot
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/bonobot.rb

@@ -3,4 +3,11 @@
 require "bonobot/railtie"
 
 module Bonobot
+  autoload :Status, "bonobot/status"
+  autoload :LocalFilesRegistry, "bonobot/local_files_registry"
+  autoload :LocalFile, "bonobot/local_file"
+  autoload :EnginesFilesRegistry, "bonobot/engines_files_registry"
+  autoload :EngineFile, "bonobot/engine_file"
+  autoload :OverloadsRegistry, "bonobot/overloads_registry"
+  autoload :Overload, "bonobot/overload"
 end

data/lib/tasks/bonobot_tasks.rake

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "bonobot/status"
-
 namespace :bonobot do
   desc "Generate status"
   task status: :environment do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bonobot
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - armandfardeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-05 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: Description of Bonobot.
 email:
 - fardeauarmand@gmail.com
@@ -91,6 +161,12 @@ files:
 - README.md
 - Rakefile
 - lib/bonobot.rb
+- lib/bonobot/engine_file.rb
+- lib/bonobot/engines_files_registry.rb
+- lib/bonobot/local_file.rb
+- lib/bonobot/local_files_registry.rb
+- lib/bonobot/overload.rb
+- lib/bonobot/overloads_registry.rb
 - lib/bonobot/railtie.rb
 - lib/bonobot/status.rb
 - lib/bonobot/version.rb