bonobot 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e09dd5420ba03ab108dd23316f5171ad5f402d0075af929391b40b6ca4cf066c
-  data.tar.gz: 6ec4202d42ee696375c4377da3c957ff1b67fe4a92dbe8c2a3361a523e21cf64
+  metadata.gz: 541fce28b33f9efe5631c3ee2c91b7e5ee61c5cf2b9d33913790d6575fd46388
+  data.tar.gz: 306f344425e0f65aa3e19b30fa721bdbf91b561e56f68fd4e07273a861140c46
 SHA512:
-  metadata.gz: b37d57570d73e78dfecb0a5e65ed4171552593b81f1588418cc3653d24133aff4468831cda0a293c3b249d2faebd5cdcd2ae7632af6ca7ad3e6f79805979c0cb
-  data.tar.gz: a368a1f128a152fd0928057a6b4e564b1a79d3913a80db48bb8a05b2a14a25c9c0bb5c630722668cd22f87cfaf80c34309bd37dae98da3d335f493e3bba4f0a4
+  metadata.gz: b3a503f11f950f2e8f0e241555a71308024a1a7a18a9d0808887a81cf49d6f3d8a9ec1fab38eff9578d73af6f83b7c6a5811d85f342df8dfe9209517bb0c18af
+  data.tar.gz: 68c51c580b004f6de15cfc2568b412312e5195cb317d271061b4717e75b943f09ba2da3cea4df959559357e14c1437ef8f6883d70f84d1ee80c07e8f6e05277a

data/README.md

@@ -8,13 +8,14 @@ BonoBot is a Ruby gem that helps with Rails monkey patching.
 ### Status
 #### Generate all status:
 ```bash
-bundle exec rake bonobot: status
+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
+bundle exec rake bonobot:status:out_of_date
+bundle exec rake bonobot:status:missing
+bundle exec rake bonobot:status:unused
 ```
 
 ### Add missing
@@ -27,6 +28,11 @@ bundle exec rake bonobot:add_missing
 bundle exec rake bonobot:update_out_of_date
 ```
 
+### Customization
+```bash
+bundle exec rake bonobot:install
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/bonobot/annotator.rb

@@ -21,7 +21,7 @@ module Bonobot
       if f.first == "# frozen_string_literal: true"
         f.insert(1, "\n#{annotation}")
       else
-        f.insert(0, "\n#{annotation}")
+        f.insert(0, annotation)
       end
 
       File.write(@path, "#{f.join("\n")}\n")
@@ -39,7 +39,7 @@ module Bonobot
 
     def annotation
       if @path.to_s.end_with?(".erb")
-        "<%# bonobot_fingerprint: #{@fingerprint} %>"
+        "<%# bonobot_fingerprint: #{@fingerprint} %>\n"
       else
         "# bonobot_fingerprint: #{@fingerprint}"
       end

data/lib/bonobot/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Bonobot::Configuration
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :included_dirs, :files_pattern, :excluded_files, :fingerprint_algorithm, :fingerprint_human_readable
+
+    def initialize
+      @status_file_path = config_value_for("status_file_path", Rails.root)
+      @status_file_name = "#{config_value_for("status_file_name", "status")}.json"
+      @included_dirs = "{#{config_value_for("included_dirs", ["app"]).join(",")}}"
+      @files_pattern = "{#{config_value_for("files_pattern", %w(rb erb)).join(",")}}"
+      @excluded_files = config_value_for("excluded_files", [])
+      @fingerprint_algorithm = config_value_for("fingerprint_algorithm", "md5")
+      @fingerprint_human_readable = config_value_for("fingerprint_human_readable", false)
+    end
+
+    def status_file
+      File.join(@status_file_path, @status_file_name)
+    end
+
+    def self.config_file
+      @config_file ||= File.exist?(Rails.root.join(".bonobot.yml")) ? YAML.load_file(Rails.root.join(".bonobot.yml")) : {}
+    end
+
+    def config_value_for(key, default_value)
+      self.class.config_file.fetch(key, default_value)
+    end
+  end
+end

data/lib/bonobot/engine_file.rb

@@ -2,17 +2,14 @@
 
 module Bonobot
   class EngineFile
-    attr_reader :path, :engine_name, :short_path, :root_path
+    attr_reader :path, :engine_name, :short_path, :root_path, :fingerprint
 
     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))
+      @fingerprint = Bonobot::Fingerprint.calculate(path)
     end
 
     def to_hash

data/lib/bonobot/engines_files_registry.rb

@@ -2,13 +2,18 @@
 
 module Bonobot
   class EnginesFilesRegistry
+    include Bonobot::Configuration
+    include Bonobot::Findable
+    include Bonobot::Outputable
+    include Bonobot::Reloadable
+
     def self.all
-      @all ||= deduplicate(generate)
+      @all ||= deduplicate(generate).reject { |engine_file| configuration.excluded_files.include?(engine_file.short_path) }
     end
 
     def self.generate
       Parallel.flat_map(::Rails::Engine.subclasses) do |klass|
-        Dir.glob(root(klass.instance.root).join("**", "*.{erb,rb}")).map do |path|
+        Dir.glob(root(klass.instance.root).join("**", "*.#{file_pattern}")).map do |path|
           EngineFile.new(path, klass)
         end
       end
@@ -18,20 +23,12 @@ module Bonobot
       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)
+    def self.root(path)
+      Pathname.new(path).join(configuration.included_dirs)
     end
 
-    def self.root(path)
-      Pathname.new(path).join("app")
+    def self.file_pattern
+      configuration.files_pattern
     end
   end
 end

data/lib/bonobot/files_op.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "bonobot/overloads_registry"
-require "bonobot/annotator"
-
 module Bonobot
   class FilesOp
     def self.missing

data/lib/bonobot/findable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bonobot::Findable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def find_by(attributes)
+      all.select do |local_file|
+        attributes.all? do |key, value|
+          local_file.try(key) == value
+        end
+      end
+    end
+  end
+end

data/lib/bonobot/fingerprint.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "digest"
+require "digest/bubblebabble"
+
+module Bonobot::Fingerprint
+  include Bonobot::Configuration
+  ALGORITHM = { "md5" => Digest::MD5, "sha1" => Digest::SHA1, "sha256" => Digest::SHA256 }.freeze
+
+  def self.calculate(path)
+    algorithm.send(method, File.read(path))
+  end
+
+  def self.method
+    if configuration.fingerprint_human_readable
+      :bubblebabble
+    else
+      :hexdigest
+    end
+  end
+
+  def self.algorithm
+    ALGORITHM.fetch(configuration.fingerprint_algorithm, Digest::MD5)
+  end
+end

data/lib/bonobot/local_files_registry.rb

@@ -1,25 +1,22 @@
 # frozen_string_literal: true
 
-require "parallel"
-
 module Bonobot
   class LocalFilesRegistry
+    include Bonobot::Configuration
+    include Bonobot::Outputable
+    include Bonobot::Reloadable
+
     def self.all
-      @all ||= Parallel.map(Dir.glob(root.join("**", "*.{erb,rb}"))) do |path|
-        LocalFile.new(path, rails_root)
-      end
+      @all ||= Parallel.map(Dir.glob(root.join("**", "*.#{file_pattern}"))) { |path| LocalFile.new(path, ::Rails.root) }
+                       .reject { |local_file| configuration.excluded_files.include?(local_file.path) }
     end
 
     def self.root
-      rails_root.join("app")
-    end
-
-    def self.rails_root
-      ::Rails.root
+      ::Rails.root.join(configuration.included_dirs)
     end
 
-    def self.output
-      all.map(&:as_json)
+    def self.file_pattern
+      configuration.files_pattern
     end
   end
 end

data/lib/bonobot/outputable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bonobot::Outputable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def output
+      all.map(&:as_json)
+    end
+  end
+end

data/lib/bonobot/overload.rb

@@ -14,6 +14,7 @@ module Bonobot
     end
 
     def status
+      return :unused if @engine_file.nil?
       return :missing if @local_file.annotation.nil?
       return :up_to_date if @local_file.annotation == @engine_file.fingerprint
 

data/lib/bonobot/overloads_registry.rb

@@ -2,25 +2,24 @@
 
 module Bonobot
   module OverloadsRegistry
+    include Bonobot::Findable
+    include Bonobot::Outputable
+    include Bonobot::Reloadable
+
     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
+        next if local_file.nil?
 
-    # 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
+        engines_files = EnginesFilesRegistry.find_by(short_path: local_file.path)
 
-    def self.output
-      all.map(&:as_json)
+        if engines_files.empty? && local_file.annotation.present?
+          Overload.new(local_file, nil)
+        else
+          engines_files.map do |engine_file|
+            Overload.new(local_file, engine_file)
+          end
+        end
+      end.compact
     end
   end
 end

data/lib/bonobot/reloadable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bonobot::Reloadable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def reload
+      @all = nil
+    end
+  end
+end

data/lib/bonobot/status.rb

@@ -4,52 +4,81 @@ require "json"
 
 module Bonobot
   class Status
-    STATUS = { up_to_date: "🥳", out_of_date: "😱", missing: "🤬" }.freeze
+    include Bonobot::Configuration
+
+    STATUS = { up_to_date: "🥳", out_of_date: "😱", unused: "😅", missing: "🤬" }.freeze
 
     def self.generate(status = nil)
-      puts "-----"
-      puts "🙈 🙉 🙊 Bonobot 🙈 🙉 🙊"
-      puts "-----"
-      puts "🛠 Generating status"
-      File.write("status.json", status_json)
-      puts File.expand_path("status.json")
-      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
+      new(status).generate
+    end
 
-      puts "-----"
-      OverloadsRegistry.find_by(status: :out_of_date).empty? && OverloadsRegistry.find_by(status: :missing).empty?
+    def initialize(status)
+      @status = status
     end
 
-    def self.present(entries)
+    def generate
+      generate_status_file
+      puts display_banner
+      return_status_code
+    end
+
+    def present(entries)
       entries.map do |entry|
-        "  - #{entry.engine_file.engine_name}: #{entry.engine_file.short_path} (#{entry.engine_file.fingerprint})"
+        if entry.engine_file.nil?
+          "  - #{entry.path} (unused)"
+        else
+          "  - #{entry.engine_file.engine_name}: #{entry.engine_file.short_path} (#{entry.engine_file.fingerprint})"
+        end
       end.join("\n")
     end
 
-    def self.generate_status(status, emoji)
-      return if OverloadsRegistry.find_by(status: status).empty?
-
+    def generate_status(status, emoji)
       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 ""
+      if overload_status.empty?
+        ["-> #{emoji} #{status_to_text} : All good! \n"]
+      else
+        ["-> #{emoji} #{status_to_text} fingerprint (#{overload_status.count}):", present(OverloadsRegistry.find_by(status: status)), ""]
+      end
     end
 
-    def self.status_json
+    def status_json
       JSON.pretty_generate({
                              rails_files: LocalFilesRegistry.output,
                              engines_files: EnginesFilesRegistry.output,
                              overloads: OverloadsRegistry.output
                            })
     end
+
+    def generate_status_file
+      File.write(self.class.configuration.status_file, status_json)
+    end
+
+    def display_banner
+      [display_intro + display_status.join("\n") + display_outro].join("\n")
+    end
+
+    def display_intro
+      "-----\n🙈 🙉 🙊 Bonobot 🙈 🙉 🙊\n-----\n\n🛠 Generating status\n#{File.expand_path(self.class.configuration.status_file)}\n-----\n\n"
+    end
+
+    def display_status
+      if @status
+        generate_status(@status.to_sym, STATUS[@status.to_sym])
+      else
+        STATUS.map do |status_type, emoji|
+          generate_status(status_type, emoji)
+        end
+      end
+    end
+
+    def display_outro
+      "\n-----"
+    end
+
+    def return_status_code
+      OverloadsRegistry.find_by(status: :out_of_date).empty? && OverloadsRegistry.find_by(status: :missing).empty?
+    end
   end
 end

data/lib/bonobot/version.rb

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

data/lib/bonobot.rb

@@ -12,4 +12,9 @@ module Bonobot
   autoload :Overload, "bonobot/overload"
   autoload :FilesOp, "bonobot/files_op"
   autoload :Annotator, "bonobot/annotator"
+  autoload :Configuration, "bonobot/configuration"
+  autoload :Findable, "bonobot/findable"
+  autoload :Outputable, "bonobot/outputable"
+  autoload :Reloadable, "bonobot/reloadable"
+  autoload :Fingerprint, "bonobot/fingerprint"
 end

data/lib/tasks/bonobot_tasks.rake

@@ -26,6 +26,11 @@ namespace :bonobot do
     end
 
     task uptodate: :up_to_date
+
+    desc "Generate status for unused"
+    task unused: :environment do
+      Bonobot::Status.generate(:unused)
+    end
   end
 
   desc "Add missing fingerprint to local files"
@@ -40,4 +45,11 @@ namespace :bonobot do
 
   task update_outdated: :update_out_of_date
   task update: :update_out_of_date
+
+  desc "Install bonobot"
+  task install: :environment do
+    dir = Gem::Specification.find_by_name("bonobot").gem_dir
+    FileUtils.cp_r File.join(dir, "bonobot_configuration_example.yml"), ".bonobot.yml"
+    puts "Bonobot configuration installed at .bonobot.yml"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bonobot
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - armandfardeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -162,22 +162,26 @@ files:
 - Rakefile
 - lib/bonobot.rb
 - lib/bonobot/annotator.rb
+- lib/bonobot/configuration.rb
 - lib/bonobot/engine_file.rb
 - lib/bonobot/engines_files_registry.rb
 - lib/bonobot/files_op.rb
+- lib/bonobot/findable.rb
+- lib/bonobot/fingerprint.rb
 - lib/bonobot/local_file.rb
 - lib/bonobot/local_files_registry.rb
+- lib/bonobot/outputable.rb
 - lib/bonobot/overload.rb
 - lib/bonobot/overloads_registry.rb
 - lib/bonobot/railtie.rb
+- lib/bonobot/reloadable.rb
 - lib/bonobot/status.rb
 - lib/bonobot/version.rb
 - lib/tasks/bonobot_tasks.rake
 homepage: https://github.com/armandfardeau/bonobo
 licenses:
 - MIT
-metadata:
-  documentation_uri: https://github.com/armandfardeau/bonobo
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths: