bonobot 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ccb8b5b500887ae4d039b56d507d9c4c3b949ebf82c0b9213f154689832354
-  data.tar.gz: 725a0102e557cde864e780396d2ac713ac6446059ab049a9c8acd555c9ea4e00
+  metadata.gz: 043e3c7bff916ce8127eb9e341d98f1749cd309fb76c0cabd279c3e0dc05c720
+  data.tar.gz: cc48089c16b0a0a6848b003206746b00afa45976c155845084c209d11ba03e6e
 SHA512:
-  metadata.gz: 108229c0e785c832dbc0cc727348b6586ca860d110bf06e8f300b3658b9774c1edc15de024e63f0877328846c682484697998db3633422ea8e95d9ee9f2f480d
-  data.tar.gz: 749c8b17db41e4c317dbaf5adca0ea13d770f09345e8fc787c7121c34d50c76a6f2eb357c42d4483189170e30e92f8a1d686651cf4b73151f82dffd569b0f54e
+  metadata.gz: ceaaab01aa8335bcf7b74cdea321e3f13c50b2cd1f69ac8fedebce56aa136b4da4957ac2a17da2d9def1f0c2227902d0fc39a9cad6a9ebfb3bc4d99a1e58e58d
+  data.tar.gz: 81e78cd4498b5eb12bbcdaeea95149adf7f4e5b0d95c3ec2ab518595b992f3c311100a3db4612ca555796263ab2833b1a8c0af28e3c5aa7254cfb190a00c9b68

data/README.md

@@ -1,8 +1,31 @@
-# 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.
+### Status
+#### Generate all status:
+```bash
+bundle exec rake bonobot: status
+```
+#### Generate a specific status:
+```bash    
+bundle exec rake bonobot:status:out_of_date
+bundle exec rake bonobot:status:up_to_date 
+bundle exec rake bonobot:update_out_of_date
+```
+
+### Add missing
+```bash
+bundle exec rake bonobot:add_missing
+```
+
+### Update out of date
+```bash
+bundle exec rake bonobot:update_out_of_date
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -11,18 +34,16 @@ Add this line to your application's Gemfile:
 gem 'bonobot'
 ```
 
-And then execute:
-```bash
-$ bundle
-```
-
 Or install it yourself as:
+
 ```bash
-$ gem install bonobot
+gem install bonobot
 ```
 
 ## 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/lib/bonobot/annotator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Bonobot
+  class Annotator
+    def self.add_annotation(path, fingerprint)
+      new(path, fingerprint).add_annotation
+    end
+
+    def self.update_annotation(path, fingerprint)
+      new(path, fingerprint).update_annotation
+    end
+
+    def initialize(path, fingerprint)
+      @path = path
+      @fingerprint = fingerprint
+    end
+
+    def add_annotation
+      f = File.read(@path).split("\n")
+
+      if f.first == "# frozen_string_literal: true"
+        f.insert(1, "\n#{annotation}")
+      else
+        f.insert(0, "\n#{annotation}")
+      end
+
+      File.write(@path, "#{f.join("\n")}\n")
+    end
+
+    def update_annotation
+      f = File.read(@path).split("\n")
+
+      f.each_with_index do |line, index|
+        f[index] = annotation if match_line(line)
+      end
+
+      File.write(@path, "#{f.join("\n")}\n")
+    end
+
+    def annotation
+      if @path.to_s.end_with?(".erb")
+        "<%# bonobot_fingerprint: #{@fingerprint} %>"
+      else
+        "# bonobot_fingerprint: #{@fingerprint}"
+      end
+    end
+
+    def match_line(line)
+      line.include?("# bonobot_fingerprint") || line.include?("<%# bonobot_fingerprint")
+    end
+  end
+end

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/files_op.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "bonobot/overloads_registry"
+require "bonobot/annotator"
+
+module Bonobot
+  class FilesOp
+    def self.missing
+      OverloadsRegistry.find_by(status: :missing)
+    end
+
+    def self.out_of_date
+      OverloadsRegistry.find_by(status: :out_of_date)
+    end
+
+    def self.add_missing
+      missing.each do |overload|
+        Annotator.annotate(root.join(overload.path), overload.engine_file.fingerprint)
+      end
+    end
+
+    def self.update_out_of_date
+      out_of_date.each do |overload|
+        Annotator.update_annotation(root.join(overload.path), overload.engine_file.fingerprint)
+      end
+    end
+
+    def self.root
+      ::Rails.root
+    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,43 +4,52 @@ require "json"
 
 module Bonobot
   class Status
-    def self.generate
+    STATUS = { up_to_date: "🥳", out_of_date: "😱", missing: "🤬" }.freeze
+
+    def self.generate(status = nil)
       puts "-----"
       puts "🙈 🙉 🙊 Bonobot 🙈 🙉 🙊"
       puts "-----"
       puts "🛠 Generating status"
-      File.write("status.json", JSON.pretty_generate({ rails_files: LocalFiles.files, engines_files: EnginesFiles.files, overloads: Overloads.files }))
+      File.write("status.json", status_json)
       puts File.expand_path("status.json")
       puts "-----"
 
-      unless Overloads.status(:up_to_date).empty?
-        puts "🥳 Up to date fingerprint count: #{Overloads.status(:up_to_date).count}"
-        puts "-> Up to date fingerprint: #{present(Overloads.status(:up_to_date))}"
-        puts ""
-      end
-
-      unless Overloads.status(:out_of_date).empty?
-        puts "😱 Out of date fingerprint count: #{Overloads.status(:out_of_date).count}"
-        puts "-> Out of date fingerprint: #{present(Overloads.status(:out_of_date))}"
-        puts ""
-      end
-
-      unless Overloads.status(:missing).empty?
-        puts "🤬 Files missing fingerprint count: #{Overloads.status(:missing).count}"
-        puts "-> Missing fingerprint: #{present(Overloads.status(:missing))}"
-        puts ""
+      if status
+        generate_status(status.to_sym, STATUS[status.to_sym])
+      else
+        STATUS.each do |status_type, emoji|
+          generate_status(status_type, emoji)
+        end
       end
 
       puts "-----"
-      Overloads.status(:out_of_date).empty? && Overloads.status(: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")
+    end
+
+    def self.generate_status(status, emoji)
+      return if OverloadsRegistry.find_by(status: status).empty?
+
+      overload_status = OverloadsRegistry.find_by(status: status)
+      status_to_text = status.to_s.capitalize.gsub("_", " ")
+
+      puts "-> #{emoji} #{status_to_text} fingerprint (#{overload_status.count}):"
+      puts present(OverloadsRegistry.find_by(status: status))
+      puts ""
+    end
 
-      "\n#{entries}"
+    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.5"
+  VERSION = "0.0.7"
 end

data/lib/bonobot.rb

@@ -4,7 +4,12 @@ require "bonobot/railtie"
 
 module Bonobot
   autoload :Status, "bonobot/status"
-  autoload :LocalFiles, "bonobot/local_files"
-  autoload :EnginesFiles, "bonobot/engines_files"
-  autoload :Overloads, "bonobot/overloads"
+  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"
+  autoload :FilesOp, "bonobot/files_op"
+  autoload :Annotator, "bonobot/annotator"
 end

data/lib/tasks/bonobot_tasks.rake

@@ -6,4 +6,38 @@ namespace :bonobot do
     status = Bonobot::Status.generate
     exit 1 unless status
   end
+
+  namespace :status do
+    desc "Generate status for out of date"
+    task out_of_date: :environment do
+      Bonobot::Status.generate(:out_of_date)
+    end
+
+    task outdated: :out_of_date
+
+    desc "Generate status for missing"
+    task missing: :environment do
+      Bonobot::Status.generate(:missing)
+    end
+
+    desc "Generate status for up to date"
+    task up_to_date: :environment do
+      Bonobot::Status.generate(:up_to_date)
+    end
+
+    task uptodate: :up_to_date
+  end
+
+  desc "Add missing fingerprint to local files"
+  task add_missing: :environment do
+    Bonobot::FilesOp.add_missing
+  end
+
+  desc "Update out of date fingerprint to local files"
+  task update_out_of_date: :environment do
+    Bonobot::FilesOp.update_out_of_date
+  end
+
+  task update_outdated: :update_out_of_date
+  task update: :update_out_of_date
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bonobot
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - armandfardeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-06 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,20 +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: '0'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +126,30 @@ dependencies:
   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: '0'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 description: Description of Bonobot.
 email:
 - fardeauarmand@gmail.com
@@ -119,9 +161,14 @@ files:
 - README.md
 - Rakefile
 - lib/bonobot.rb
-- lib/bonobot/engines_files.rb
-- lib/bonobot/local_files.rb
-- lib/bonobot/overloads.rb
+- lib/bonobot/annotator.rb
+- lib/bonobot/engine_file.rb
+- lib/bonobot/engines_files_registry.rb
+- lib/bonobot/files_op.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

data/lib/bonobot/engines_files.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module EnginesFiles
-  def self.files
-    @files ||= ::Rails::Engine.subclasses.each_with_object({}) do |klass, hash|
-      paths = Dir.glob("#{klass.instance.root}/app/**/*.{erb,rb}")
-      next if paths.empty?
-
-      hash[engine_to_name(klass)] = engine_paths(paths)
-    end
-  end
-
-  def self.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
-
-  def self.engine_paths(paths)
-    paths.each_with_object({}) do |path, hash|
-      _name, *short_path = path.sub(gems_dir, "").split("/")
-      hash[short_path.join("/")] = { path: path, fingerprint: fingerprint(path) }
-    end
-  end
-
-  def self.gems_dir
-    @gems_dir ||= "#{Bundler.rubygems.gem_dir}/gems/"
-  end
-
-  def self.fingerprint(path)
-    Digest::MD5.hexdigest(File.read(path))
-  end
-end

data/lib/bonobot/local_files.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module LocalFiles
-  def self.files
-    @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.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.presence
-  end
-end

data/lib/bonobot/overloads.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Overloads
-  def self.files
-    @files ||= LocalFiles.files.each_with_object({}) do |(path, fingerprint), hash|
-      EnginesFiles.files.keys.each do |engine_name|
-        next unless path.include? engine_name
-
-        source_path = EnginesFiles.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.status_key(source_fingerprint, target_fingerprint)
-    return :up_to_date if source_fingerprint == target_fingerprint
-    return :missing if target_fingerprint.nil?
-
-    :out_of_date
-  end
-
-  def self.status(status)
-    files.fetch(status, [])
-  end
-end