bonobot 0.0.10 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb9e5c0eaac02524d810bf6f59774cd16437e09a5c0e588996aa80826d4b371
-  data.tar.gz: dc0b5858278ba66cb75db9839853bfc4a0c25a29667d768761b1ebe46b0b3d01
+  metadata.gz: a4f7b3ef84ffd8043657a8fc28a68f0f37bd0e7b7480547106a2ddef35eaf002
+  data.tar.gz: ba0ad7a0f8f10fad47a287f79a79798709b9cd3a8e40a90692a088e5215ef6c0
 SHA512:
-  metadata.gz: 9805b50c084da6db7e6b593e3e86cfe6af985f5d799355163d0239f70c9c67027a42cf4330c7736d11ebf24e38866075b5426531476f145e5178cd23fe93f4bc
-  data.tar.gz: aaf8b17b178404a4d78aa7cec759b6136245ac29b3512e01ef5bcf5663a1cd4c21895746ce3b9b8b4b558bf01ce3ef84248b85683a23dfb6ea8cccc5540c8cac
+  metadata.gz: 488337ea6b5a647c1563cec5b77864cdb3aa4bef9a50a387df0053635d9b83ccabbc796c637bbcfc02ad89b3029f5803eaf6a058dbd6d415071605570387a52f
+  data.tar.gz: d31fc7230c48c77b7de01c56bde1d64631950f64cd757b7bf28084f22e870c221a253495a2b994010dd4fa2dde7aba01ae0c2d092bc31fb44304f420f867db43

data/README.md

@@ -8,14 +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:unused
+bundle exec rake bonobot:status:out_of_date
+bundle exec rake bonobot:status:missing
+bundle exec rake bonobot:status:unused
 ```
 
 ### Add missing
@@ -28,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/config/bonobot_configuration_example.yml

@@ -0,0 +1,18 @@
+############################################
+#        Bonobot configuration file        #
+# This file is used to configure Bonobot   #
+# https://github.com/armandfardeau/bonobot #
+############################################
+
+#####    Status file configuration    ######
+# status_file_path: "" # default to Rails.root
+# status_file_name: "" # default to 'status'
+
+##### Overload matching configuration ######
+# included_dirs: [] # default to ['app']
+# files_pattern: [] # default to ['rb', 'erb']
+# excluded_files: [] # default to []
+
+# Fingerprint configuration
+# fingerprint_algorithm: "md5" # default to "md5", available: "md5", "sha1", "sha256"
+# fingerprint_human_readable: false # default to false, available: true, false

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

@@ -2,12 +2,17 @@
 
 module Bonobot
   module OverloadsRegistry
+    include Bonobot::Findable
+    include Bonobot::Outputable
+    include Bonobot::Reloadable
+
     def self.all
       @all ||= LocalFilesRegistry.all.flat_map do |local_file|
-        next if local_file.nil? || local_file.annotation.nil?
+        next if local_file.nil?
 
         engines_files = EnginesFilesRegistry.find_by(short_path: local_file.path)
-        if engines_files.empty?
+
+        if engines_files.empty? && local_file.annotation.present?
           Overload.new(local_file, nil)
         else
           engines_files.map do |engine_file|
@@ -16,22 +21,5 @@ module Bonobot
         end
       end.compact
     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
-
-    def self.reload
-      @all = nil
-    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,8 +4,9 @@ require "json"
 
 module Bonobot
   class Status
+    include Bonobot::Configuration
+
     STATUS = { up_to_date: "🥳", out_of_date: "😱", unused: "😅", missing: "🤬" }.freeze
-    STATUS_FILE_PATH = "status.json"
 
     def self.generate(status = nil)
       new(status).generate
@@ -51,7 +52,7 @@ module Bonobot
     end
 
     def generate_status_file
-      File.write(STATUS_FILE_PATH, status_json)
+      File.write(self.class.configuration.status_file, status_json)
     end
 
     def display_banner
@@ -59,7 +60,7 @@ module Bonobot
     end
 
     def display_intro
-      "-----\n🙈 🙉 🙊 Bonobot 🙈 🙉 🙊\n-----\n\n🛠 Generating status\n#{File.expand_path("status.json")}\n-----\n\n"
+      "-----\n🙈 🙉 🙊 Bonobot 🙈 🙉 🙊\n-----\n\n🛠 Generating status\n#{File.expand_path(self.class.configuration.status_file)}\n-----\n\n"
     end
 
     def display_status

data/lib/bonobot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bonobot
-  VERSION = "0.0.10"
+  VERSION = "0.1.1"
 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

@@ -45,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, "config", "bonobot_configuration_example.yml"), ".bonobot.yml"
+    puts "Bonobot configuration installed at .bonobot.yml"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bonobot
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.1
 platform: ruby
 authors:
 - armandfardeau
@@ -160,16 +160,22 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/bonobot_configuration_example.yml
 - 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