gem_bench 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47591b1b5f1880cbb2c40be1199aa7fa65a25d2c32ca52131ba54e0e89d8b6b7
-  data.tar.gz: 93aad6d4e020398b93ffdaa2e8fddfce5b5e5cc4fa08854f22850dcccee9f0ee
+  metadata.gz: 26701ac598126aaa38d326332e6f826c62bc7e69b6ac1e34fde7f1568269143c
+  data.tar.gz: e75766ba0541b15924fce9a1703632a115f09b4226bc90970c98ff49e2bd423a
 SHA512:
-  metadata.gz: 47827b59b13ee527cecfc8db349437c0fc416aa53fa83b4138a6c1884652d857ce9be708ec534e099b8a41f47914b831d8f73e09e430134f4deb050714a1925a
-  data.tar.gz: 9ae3067637e3293209bde40127e55ad42882b075ca71fc65e7b025ec5dd4e160f5669767e6990a8a0db915ff6031f1555e432cc6a110e32b09346a710fd304bf
+  metadata.gz: d505382f0219e9ddb9a80418529ecdd35afa34f4f04be0d548bd07876f7b8f3b95ff0c71941e4880d69d5cb6e4f9550db25a0cf43723a7fd720620b580e38c90
+  data.tar.gz: 808ca57545b51ec424234c50714e82e528aa9897e432edf8b40074488143fd0730879180e26d3cfdaa06992393e61bc20e8a10578bbed38ec9dab34f281af7f0

checksums.yaml.gz.sig

@@ -1 +1,3 @@
-dBR���*1xw�{�\�>��zg�q�}��1rS�(m`��x��<R�k�
�5.g,�ŧ��I%Q�M��`�_�����^���lڐ�Vq�=��/q����,0�'rD��恶|�y�7G�=�{�z�a7�̳6��<��=��oP�7�h�f+����Y��
+2?5��?�n�g�`�Q�B��T��W�rl:��5��q�o�(���P*z��1Y���@u%���B��(��?��q��W��3�/�uh�E�#��T�_��\�h����K
w5�%i�[�@��ڡ��,q*���j��េ��i��4�?��Gq�<Z��d$���>��hi��{:
+A]��a�v�YȴCp�2[���t�E��ϱ�kE�����E�+C�ݒ��<w�(=L���s�u�݄�)�#扸�$�Z��FDp3�Aʢ�3V�T�
+�gu��/�s6�aa�����_g

data/CHANGELOG.md

@@ -11,15 +11,28 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
 ### Fixed
 ### Removed
 
+## [2.0.5] SEP.21.2024
+- COVERAGE:  99.80% -- 495/496 lines in 9 files
+- BRANCH COVERAGE:  94.35% -- 167/177 branches in 9 files
+- 58.87% documented
+### Added
+- More specs
+- More documentation
+- 0.2% remaining to 100% test coverage (line)
+### Fixed
+- Documentation errors
+- Minor improvements to logic and performance (a bit more idiomatic Ruby)
+
 ## [2.0.4] SEP.20.2024
 - COVERAGE:  98.19% -- 488/497 lines in 9 files
 - BRANCH COVERAGE:  88.95% -- 161/181 branches in 9 files
 - 58.06% documented
 ### Added
-- More Documentation
-- Almost 100% test coverage
-- Thread Safety (removed `GemBench.roster`, which was effectively never used internally)
+- More documentation
+- 1.81% remaining to 100% test coverage (line)
+- Thread safety (removed `GemBench.roster`, which was effectively never used internally)
 - Performance improvements
+- Support for specifying arbitrary `:gemfile_path` in most class initializers
 ### Fixed
 - Can now handle more variations of Ruby syntax in the Gemfile analyzer
 - `require_relative` > `require` for internal files (except for `spec` => `lib`)

data/lib/gem_bench/jersey.rb

@@ -136,10 +136,10 @@ module GemBench
       end
       files.each do |filepath|
         # But files required here may not load their own internal files properly if they are still using `require`.
-        # Since Ruby 2.2, best practice for ruby libraries is to use require_relative for internal files,
-        #   and require for external files and dependencies.
-        # Ref: https://github.com/panorama-ed/memo_wise/issues/349
-        # We *can* use `require` *here*, because filepath here is an absolute paths
+        # Since Ruby 1.9.2, best practice for ruby libraries is to use require_relative for internal files,
+        #   and require for external files and dependencies, generally, and oversimplified.
+        # Ref: https://github.com/rubocop/rubocop/issues/8748#issuecomment-2363327346
+        # However, We *can* use `require` *here*, because filepath here is an absolute paths
         require filepath
       end
 

data/lib/gem_bench/team.rb

@@ -6,6 +6,13 @@ module GemBench
   #   - if you are in a rails console, and want to evaluate the Gemfile of the Rails app, that's great!
   #   - if you are in a context with no Gemfile loaded, or a different Gemfile loaded than the one you want to evaluate,
   #     this class may not give sensible results. This is because it checks loaded gems via RubyGems and Bundler.
+  #
+  # Terminology:
+  #
+  # starter: a gem that needs to be loaded when bundler normally loads gems
+  #
+  # bencher: a gem that can, or should, have require: false to delay loading until after bootstrap
+  #
   class Team
     EXCLUDE = %w[
       bundler
@@ -53,8 +60,8 @@ module GemBench
       )
       @exclude_file_pattern_regex_proc = options[:exclude_file_pattern_regex_proc].respond_to?(:call) ? options[:exclude_file_pattern_regex_proc] : GemBench::EXCLUDE_FILE_PATTERN_REGEX_PROC
       # Among the loaded gems there may be some that did not need to be.
-      @excluded, @all = @scout.loaded_gems.partition { |x| EXCLUDE.include?(x[0]) }
-      exclusions = " + #{excluded.length} loaded gems which GemBench is configured to ignore.\n" if @excluded.length > 0
+      exclude!
+      exclusions = " + #{excluded.length} loaded gems which GemBench is configured to ignore.\n" if excluded.any?
       @starters = []
       @benchers = []
       @current_gemfile_suggestions = []
@@ -70,11 +77,11 @@ module GemBench
         false
       end
       puts "[GemBench] Will search for gems in #{gem_paths.inspect}\n#{if benching?
-                                                                         @scout.check_gemfile? ? "[GemBench] Will check Gemfile at #{gemfile_path}.\n" : "[GemBench] No Gemfile found.\n"
+                                                                         check_gemfile? ? "[GemBench] Will check Gemfile at #{gemfile_path}.\n" : "[GemBench] No Gemfile found.\n"
                                                                        else
                                                                          ""
                                                                        end}#{bad_ideas ? "[GemBench] Will show bad ideas.  Be Careful.\n" : ""}[GemBench] Detected #{all.length} loaded gems#{exclusions}"
-      compare_gemfile if benching? && @scout.check_gemfile?
+      compare_gemfile if benching? && check_gemfile?
       self.print if verbose
     end
 
@@ -82,6 +89,7 @@ module GemBench
       starters.map { |starter| starter.to_s(format) }
     end
 
+    # @return void
     def print
       string = ""
       if all.empty?
@@ -92,7 +100,7 @@ module GemBench
         else
           "[GemBench] Found no gems containing #{look_for_regex} in Ruby code.\n"
         end
-      elsif starters.length > 0
+      else
         string << "\n#{GemBench::USAGE}" unless check_gemfile?
         string << if benching?
           "[GemBench] We found a Rails::Railtie or Rails::Engine in the following files. However, it is possible that there are false positives, so you may want to verify that this is the case.\n\n"
@@ -116,18 +124,15 @@ module GemBench
         starters.each_with_index do |starter, index|
           string << "#{starter.info(index + 1)}\n"
         end
-        if extra_verbose? && !benching? && benchers.length > 0
+        if extra_verbose? && !benching? && benchers.any?
           string << "[GemBench] #{benchers.length} out of #{all.length} evaluated gems did not contain #{look_for_regex}. They are:\n"
           benchers.each_with_index do |bencher, index|
             string << "#{bencher.info(index + 1)}\n"
           end
         end
-      else
-        string << "[GemBench] Congrats! All gems appear clean.\n"
-        string << "\n#{GemBench::USAGE}" unless check_gemfile?
       end
       if check_gemfile? && benching?
-        if current_gemfile_suggestions.length > 0
+        if current_gemfile_suggestions.any?
           string << "[GemBench] Evaluated #{all.length} gems and Gemfile at #{gemfile_path}.\n[GemBench] Here are #{current_gemfile_suggestions.length} suggestions for improvement:\n"
           current_gemfile_suggestions.each_with_index do |player, index|
             string << "#{player.suggest(index + 1)}\n"
@@ -159,7 +164,7 @@ module GemBench
 
     def prepare_bad_ideas
       string = ""
-      if benchers.length > 0
+      if benchers.any?
         gemfile_instruction = check_gemfile? ? "" : "To safely evaluate a Gemfile:\n\t1. Make sure you are in the root of a project with a Gemfile\n\t2. Make sure the gem is actually a dependency in the Gemfile\n"
         string << "[GemBench] Evaluated #{all.length} loaded gems and found #{benchers.length} which may be able to skip boot loading (require: false).\n*** => WARNING <= ***: Be careful adding non-primary dependencies to your Gemfile as it is generally a bad idea.\n#{gemfile_instruction}"
         benchers.each_with_index do |player, index|
@@ -223,6 +228,10 @@ module GemBench
 
     private
 
+    def exclude!
+      self.excluded, self.all = loaded_gems.partition { |x| EXCLUDE.include?(x[0]) }
+    end
+
     def extra_verbose?
       verbose == "extra"
     end

data/lib/gem_bench/version.rb

@@ -1,6 +1,6 @@
 module GemBench
   # Version is enhanced by VersionGem::Basic once the gem is loaded.
   module Version
-    VERSION = "2.0.4"
+    VERSION = "2.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_bench
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Peter Boling
@@ -36,7 +36,7 @@ cert_chain:
   I5o+DRfXQHqKucx1ldFHvI2rE/kSCWqGTHN2eyu1sqCPeOoIMxrltJhaejKPkxqj
   zaF9Og==
   -----END CERTIFICATE-----
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,20 +126,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -296,10 +282,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://railsbling.com/tags/gem_bench/
-  source_code_uri: http://github.com/pboling/gem_bench/tree/v2.0.4
-  changelog_uri: http://github.com/pboling/gem_bench/blob/v2.0.4/CHANGELOG.md
+  source_code_uri: http://github.com/pboling/gem_bench/tree/v2.0.5
+  changelog_uri: http://github.com/pboling/gem_bench/blob/v2.0.5/CHANGELOG.md
   bug_tracker_uri: http://github.com/pboling/gem_bench/issues
-  documentation_uri: https://www.rubydoc.info/gems/gem_bench/2.0.4
+  documentation_uri: https://www.rubydoc.info/gems/gem_bench/2.0.5
   wiki_uri: http://github.com/pboling/gem_bench/wiki
   funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'