repofetch 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad5af8ce1827ff6413451767fc8040cc710a057ecfde81d2d5db8c33282a15d
-  data.tar.gz: 3b9658cdeaf490accc551548464ea534e49b86a15dde562b16eec7da0d2d9d05
+  metadata.gz: d212500ad7536eede542d6a5c1e8e0f7cd6de302dd6508c6c279896100004b37
+  data.tar.gz: b8a63cc0c47c808f937b27041e508dbec59fee6934d6adaf2e1e4e94cbf73be5
 SHA512:
-  metadata.gz: 07a62248fa6ff9248b85b01fc7f8376ae6b17fd5b9f30fce25a7e1ad139892b4ee230e84e3eb43b1aa2d1b94c66ee0be8f330100b2949b3ba95edbe7bb7cb2b2
-  data.tar.gz: 814a0249c286baf5523a461c50acadd75c2f31149185e5c8f8886e2f48feddcc770445fac5f6441092663cd1dbdea6dd40c2a457526d2740774be67bdafdc709
+  metadata.gz: fffca813b8f21cdae1229dc8d506ff1fba2d50db37252b1403d20a327a276991567aa46e78dcd52a999d290951162886e7ad6366b930054d7553cf5516eecf92
+  data.tar.gz: 788d2d7d46db0e2ed455e170ffaa52a5b392cb87815eb09f906a92e0523d51dc81a2d8f279d850757071046ade142a29e3811734b53931ba1f63691d089746c7

data/CONTRIBUTING.md

@@ -62,14 +62,15 @@ The following requirements assume you are *not* manually implementing a plugin's
 `to_s` method, and you are inheriting from `Repofetch::Plugin`.
 
 - `ascii` should return a string for the ASCII art
-- `header` should return the header text that will be above the `---` separator on the right side.
+- `header` should return the header text or an array of header text that will be above the `---` separator on the right side.
 - `stats` should return an array of values that implement `to_s`. These will be
   the stats displayed to the right of the ASCII art. You can use`Repofetch::Stat` and
   `Repofetch::TimespanStat` to create a pretty stat.
 
-The following are optional.
+### Optional Plugin Instance Methods
 
 - `theme` can return an instance of `Repofetch::Theme` to use a different color scheme.
+- `primary_color` will set the color for the header and stat labels.
 
 ### Authoring ASCII Art
 
@@ -113,15 +114,16 @@ class MyCoolPlugin < Repofetch::Plugin
   end
 
   def header
-    # NOTE: theme is provided by the base Plugin class
-    "stats from #{theme.format(:underline, 'my plugin')}"
+    # NOTE: The inherited header_joiner method will make the final header "My Plugin @ Me"
+    # You can override this method to use a different joiner, or override formatted_header
+    # for more control.
+    ['My Plugin', 'Me']
   end
 
   def stats
-    # if theme is not passed, the stat will not be styled
     [
-      Repofetch::Stat.new('git repo detected', @detected_from_git, emoji: '📂', theme: theme),
-      Repofetch::Stat.new('args passed', @arg_count, theme: theme)
+      Repofetch::Stat.new('git repo detected', @detected_from_git, emoji: '📂'),
+      Repofetch::Stat.new('args passed', @arg_count)
     ]
   end
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    repofetch (0.4.4)
+    repofetch (0.5.0)
       actionview (~> 7.0, >= 7.0.4)
       dotenv (~> 2.8)
       faraday-retry (~> 2.0)
@@ -12,13 +12,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (7.0.4)
-      activesupport (= 7.0.4)
+    actionview (7.0.4.1)
+      activesupport (= 7.0.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.4)
+    activesupport (7.0.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -35,7 +35,7 @@ GEM
     docile (1.4.0)
     dotenv (2.8.1)
     erubi (1.12.0)
-    faraday (2.7.2)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -58,7 +58,7 @@ GEM
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     os (1.1.4)
-    overcommit (0.59.1)
+    overcommit (0.60.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
@@ -70,12 +70,12 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.4)
+    rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rchardet (1.8.0)
-    regexp_parser (2.6.1)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -86,7 +86,7 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.2)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-snapshot (2.0.1)
@@ -105,10 +105,13 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.17.0)
+    rubocop-rspec (2.18.1)
       rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
@@ -149,4 +152,4 @@ DEPENDENCIES
   yard (~> 0.9.28)
 
 BUNDLED WITH
-   2.4.3
+   2.4.4

data/README.md

@@ -4,7 +4,7 @@
 [![GitHub contributors (via allcontributors.org)](https://img.shields.io/github/all-contributors/spenserblack/repofetch)](./CREDITS.md)
 ![CI](https://github.com/spenserblack/repofetch/workflows/CI/badge.svg)
 [![CodeQL](https://github.com/spenserblack/repofetch/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/spenserblack/repofetch/actions/workflows/github-code-scanning/codeql)
-[![codecov](https://codecov.io/gh/spenserblack/repofetch/branch/master/graph/badge.svg?token=3572AEWQAY)](https://codecov.io/gh/spenserblack/repofetch)
+[![codecov](https://codecov.io/gh/spenserblack/repofetch/branch/main/graph/badge.svg?token=3572AEWQAY)](https://codecov.io/gh/spenserblack/repofetch)
 
 Fetch details about your remote repository.
 

data/RELEASE_NOTES

@@ -1,6 +1,28 @@
-Bitbucket Cloud Bugfix
+0.5.0
+
+## Added
+
+- `Stat#format(theme)` to create styled stats
+- `Stat#style_label` to style the label without mutating the original `Stat` instance
+- `Plugin#matches_path?` and `Plugin#from_path` to allow plugins to initialize from paths, not
+  just git repositories
+
+## Changed
+
+- Bitbucket Cloud header to be bold and blue
+- `Stat#style_label!` to accept one or more styles as parameters
+- `Plugin#matches_repo?` to return `false` instead of raising an error when it is not overridden
 
 ## Fixed
 
-- Bitbucket Cloud not getting automatically detected when running `repofetch` in a
-  Bitbucket Cloud repository
+- length of separator to match *visual* length of header
+
+## Potentially Breaking for 3rd-party Plugins
+
+### Changed
+
+- `Repofetch::Util` to be a module
+- `clean_s` to be called `remove_format_params`
+- Moved `default_remote` and `default_remote_url` to be in `Repofetch::Util`
+- `Stat#to_s` to return an unstyled value
+- Header text and stats will now automatically be bold and use the value returned by `Plugin#primary_color`

data/lib/repofetch/bitbucketcloud/stats.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'repofetch'
+
+class Repofetch
+  class BitbucketCloud < Repofetch::Plugin
+    # Methods to get Bitbucket Cloud stats.
+    module Stats
+      protected
+
+      def repo_data
+        @repo_data ||= agent.call(:get, "repositories/#{@repo_identifier}").data
+      end
+
+      def clone_urls
+        @clone_urls ||= repo_data['links']['clone'].to_h { |clone| [clone['name'].to_sym, clone['href']] }
+      end
+
+      def http_clone_url
+        Repofetch::Stat.new('HTTP(S)', clone_urls[:https], emoji: '🌐')
+      end
+
+      def ssh_clone_url
+        Repofetch::Stat.new('SSH', clone_urls[:ssh], emoji: '🔑')
+      end
+
+      def watchers
+        @watcher_data ||= agent.call(:get, "repositories/#{@repo_identifier}/watchers").data
+        Repofetch::Stat.new('subscribers', @watcher_data['size'], emoji: '👀')
+      end
+
+      def forks
+        @fork_data ||= agent.call(:get, "repositories/#{@repo_identifier}/forks").data
+        Repofetch::Stat.new('forks', @fork_data['size'], emoji: '🔱')
+      end
+
+      def created
+        Repofetch::TimespanStat.new('created', repo_data['created_on'], emoji: '🐣')
+      end
+
+      def updated
+        Repofetch::TimespanStat.new('updated', repo_data['updated_on'], emoji: '📤')
+      end
+
+      def size
+        # NOTE: Size is in bytes
+        # TODO: Move this somewhere else instead of using a copy-paste
+        byte_size = number_to_human_size(repo_data['size'] || 0, precision: 2, significant: false,
+                                                                 strip_insignificant_zeros: false)
+        Repofetch::Stat.new('size', byte_size, emoji: '💽')
+      end
+
+      def issues
+        @issue_data ||= agent.call(:get, "repositories/#{@repo_identifier}/issues").data
+        Repofetch::Stat.new('issues', @issue_data['size'], emoji: '❗')
+      end
+
+      def pull_requests
+        @pull_request_data ||= agent.call(:get, "repositories/#{@repo_identifier}/pullrequests").data
+        Repofetch::Stat.new('pull requests', @pull_request_data['size'], emoji: '🔀')
+      end
+    end
+  end
+end

data/lib/repofetch/bitbucketcloud.rb

@@ -2,14 +2,19 @@
 
 require 'action_view'
 require 'optparse'
-require 'repofetch'
+require 'repofetch/bitbucketcloud/stats'
 require 'repofetch/exceptions'
+require 'repofetch/plugin'
+require 'repofetch/util'
 require 'sawyer'
 
 class Repofetch
   # Adds support for Bitbucket repositories.
   class BitbucketCloud < Repofetch::Plugin
     include ActionView::Helpers::NumberHelper
+    include Repofetch::BitbucketCloud::Stats
+    include Repofetch::Util
+    extend Repofetch::Util
 
     HTTP_REMOTE_REGEX = %r{https?://bitbucket\.org/(?<owner>[\w._-]+)/(?<repo>[\w._-]+)}.freeze
     SSH_REMOTE_REGEX = %r{git@bitbucket\.org:(?<owner>[\w._-]+)/(?<repo>[\w._-]+)}.freeze
@@ -24,13 +29,15 @@ class Repofetch
     end
 
     def header
-      "#{repo_data['owner']['display_name']}/#{repo_data['name']} @ Bitbucket"
+      ["#{repo_data['owner']['display_name']}/#{repo_data['name']}", 'Bitbucket']
     end
 
-    def stats
-      stats = [http_clone_url, ssh_clone_url, watchers, forks, created, updated, size, issues, pull_requests]
+    def primary_color
+      :blue
+    end
 
-      stats.each { |stat| %i[bold blue].each { |style| stat.style_label!(style) } }
+    def stats
+      [http_clone_url, ssh_clone_url, watchers, forks, created, updated, size, issues, pull_requests]
     end
 
     def ascii
@@ -49,8 +56,7 @@ class Repofetch
 
     # Detects that the repository is a Bitbucket repository.
     def self.matches_repo?(git)
-      default_remote = Repofetch.default_remote(git)
-      matches_remote?(default_remote&.url)
+      matches_remote?(default_remote_url(git))
     end
 
     # Detects that the remote URL is for a Bitbucket Cloud repository.
@@ -60,8 +66,7 @@ class Repofetch
 
     # Gets the owner and repository from a GitHub local repository.
     def self.repo_identifiers(git)
-      default_remote = Repofetch.default_remote(git)
-      remote_identifiers(default_remote&.url)
+      remote_identifiers(default_remote_url(git))
     end
 
     # Gets the owner and repository from a GitHub remote URL.
@@ -98,60 +103,6 @@ class Repofetch
 
       new(args[0])
     end
-
-    protected
-
-    def repo_data
-      @repo_data ||= agent.call(:get, "repositories/#{@repo_identifier}").data
-    end
-
-    def clone_urls
-      @clone_urls ||= repo_data['links']['clone'].to_h { |clone| [clone['name'].to_sym, clone['href']] }
-    end
-
-    def http_clone_url
-      Repofetch::Stat.new('HTTP(S)', clone_urls[:https], emoji: '🌐')
-    end
-
-    def ssh_clone_url
-      Repofetch::Stat.new('SSH', clone_urls[:ssh], emoji: '🔑')
-    end
-
-    def watchers
-      @watcher_data ||= agent.call(:get, "repositories/#{@repo_identifier}/watchers").data
-      Repofetch::Stat.new('subscribers', @watcher_data['size'], emoji: '👀')
-    end
-
-    def forks
-      @fork_data ||= agent.call(:get, "repositories/#{@repo_identifier}/forks").data
-      Repofetch::Stat.new('forks', @fork_data['size'], emoji: '🔱')
-    end
-
-    def created
-      Repofetch::TimespanStat.new('created', repo_data['created_on'], emoji: '🐣')
-    end
-
-    def updated
-      Repofetch::TimespanStat.new('updated', repo_data['updated_on'], emoji: '📤')
-    end
-
-    def size
-      # NOTE: Size is in bytes
-      # TODO: Move this somewhere else instead of using a copy-paste
-      byte_size = number_to_human_size(repo_data['size'] || 0, precision: 2, significant: false,
-                                                               strip_insignificant_zeros: false)
-      Repofetch::Stat.new('size', byte_size, emoji: '💽')
-    end
-
-    def issues
-      @issue_data ||= agent.call(:get, "repositories/#{@repo_identifier}/issues").data
-      Repofetch::Stat.new('issues', @issue_data['size'], emoji: '❗')
-    end
-
-    def pull_requests
-      @pull_request_data ||= agent.call(:get, "repositories/#{@repo_identifier}/pullrequests").data
-      Repofetch::Stat.new('pull requests', @pull_request_data['size'], emoji: '🔀')
-    end
   end
 end
 

data/lib/repofetch/cli.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'git'
 require 'optparse'
 require 'repofetch'
 require 'repofetch/config'
@@ -56,8 +55,7 @@ class Repofetch
     def new_plugin
       return @plugin.from_args(@args) unless @plugin.nil?
 
-      git = Git.open(@repository_path)
-      Repofetch.get_plugin(git, @args)
+      Repofetch.get_plugin(@repository_path, @args)
     end
 
     private

data/lib/repofetch/github.rb

@@ -3,13 +3,16 @@
 require 'action_view'
 require 'octokit'
 require 'optparse'
-require 'repofetch'
 require 'repofetch/exceptions'
+require 'repofetch/plugin'
+require 'repofetch/util'
 
 class Repofetch
   # Adds support for GitHub repositories.
   class Github < Repofetch::Plugin
     include ActionView::Helpers::NumberHelper
+    include Repofetch::Util
+    extend Repofetch::Util
 
     HTTP_REMOTE_REGEX = %r{https?://github\.com/(?<owner>[\w.-]+)/(?<repository>[\w.-]+)}.freeze
     SSH_REMOTE_REGEX = %r{git@github\.com:(?<owner>[\w.-]+)/(?<repository>[\w.-]+)}.freeze
@@ -31,15 +34,12 @@ class Repofetch
     end
 
     def stats
-      stats = [http_clone_url, ssh_clone_url, stargazers, subscribers, forks, created, updated, size, issues,
-               pull_requests]
-      stats.each { |stat| stat.style_label!(:bold) }
+      [http_clone_url, ssh_clone_url, stargazers, subscribers, forks, created, updated, size, issues, pull_requests]
     end
 
     # Detects that the repository is a GitHub repository.
     def self.matches_repo?(git)
-      default_remote = Repofetch.default_remote(git)
-      matches_remote?(default_remote&.url)
+      matches_remote?(default_remote_url(git))
     end
 
     # Detects that the remote URL is for a GitHub repository.
@@ -49,8 +49,7 @@ class Repofetch
 
     # Gets the owner and repository from a GitHub local repository.
     def self.repo_identifiers(git)
-      default_remote = Repofetch.default_remote(git)
-      remote_identifiers(default_remote&.url)
+      remote_identifiers(default_remote_url(git))
     end
 
     # Gets the owner and repository from a GitHub remote URL.
@@ -93,7 +92,7 @@ class Repofetch
     end
 
     def header
-      "#{theme.format(:bold, "#{owner}/#{repository}")} @ #{theme.format(:bold, 'GitHub')}"
+      ["#{owner}/#{repository}", 'GitHub']
     end
 
     def ascii

data/lib/repofetch/gitlab.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
 require 'cgi'
-require 'repofetch'
 require 'repofetch/exceptions'
+require 'repofetch/plugin'
+require 'repofetch/util'
 require 'sawyer'
 
 class Repofetch
   # Adds support for GitLab repositories.
   class Gitlab < Repofetch::Plugin
+    include Repofetch::Util
+    extend Repofetch::Util
+
     HTTP_REMOTE_REGEX = %r{https?://gitlab\.com/(?<path>[\w.-][\w.\-/]+)}.freeze
     SSH_REMOTE_REGEX = %r{git@gitlab\.com:(?<path>[\w.-][\w.\-/]+)}.freeze
     ASCII = File.read(File.expand_path('gitlab/ASCII', __dir__))
@@ -22,11 +26,11 @@ class Repofetch
     end
 
     def header
-      "#{header_format(repo_data['name_with_namespace'])} @ #{header_format('GitLab')}"
+      [repo_data['name_with_namespace'], 'GitLab']
     end
 
-    def header_format(text)
-      theme.format(:bold, theme.format(:red, text))
+    def primary_color
+      :red
     end
 
     def stats
@@ -35,7 +39,7 @@ class Repofetch
       # NOTE: Stats that require authentication
       stats << open_issues unless token.nil?
 
-      stats.each { |stat| %i[bold red].each { |style| stat.style_label!(style) } }
+      stats
     end
 
     def ascii
@@ -87,9 +91,7 @@ class Repofetch
 
     # Gets the path (+owner/subproject/repo+) of the repository.
     def self.repo_identifier(git)
-      default_remote = Repofetch.default_remote(git)
-      url = default_remote&.url
-      remote_identifier(url)
+      remote_identifier(default_remote_url(git))
     end
 
     # Gets the path (+owner/subproject/repo+) of the repository.
@@ -105,9 +107,7 @@ class Repofetch
 
     # Detects that the repository is a GitHub repository.
     def self.matches_repo?(git)
-      default_remote = Repofetch.default_remote(git)
-      url = default_remote&.url
-      matches_remote?(url)
+      matches_remote?(default_remote_url(git))
     end
 
     # Detects that the remote URL is for a GitHub repository.

data/lib/repofetch/plugin.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'repofetch'
+require 'repofetch/util'
+require 'repofetch/stat'
+
+class Repofetch
+  # @abstract Subclass to create a plugin.
+  class Plugin
+    include Repofetch::Util
+
+    # Plugin intializer arguments should come from the +from_git+ or +from_args+
+    # class methods.
+    def initialize(*) end
+
+    # Registers this plugin class for repofetch.
+    def self.register
+      Repofetch.register_plugin(self)
+    end
+
+    # Tries to replace another plugin. An example use case might be if this plugin
+    # extends another registered plugin.
+    #
+    # @param [Plugin] old The plugin to replace
+    def self.replace_or_register(old)
+      Repofetch.replace_or_register_plugin(old, self)
+    end
+
+    # @abstract Detects that this plugin should be used. Should be overridden by subclasses.
+    #
+    # An example implementation is checking if +Repofetch.default_remote_url+ matches
+    # a regular expression.
+    #
+    # @param [Git::Base] _git The Git repository object
+    def self.matches_repo?(_git)
+      false
+    end
+
+    # @abstract Detects that this plugin should be used. Should be overridden by subclasses.
+    #
+    # This is intended to be more generic than +matches_repo?+, and support any path.
+    #
+    # An example implementation is checking if an expected file exists in this path.
+    # @param [String] _path The path to check
+    def self.matches_path?(_path)
+      false
+    end
+
+    # @abstract This should use a git instance and call +Plugin.new+.
+    #
+    # @param [Git::Base] _git The Git repository object to use when calling +Plugin.new+.
+    # @param [Array] _args The arguments to process.
+    #
+    # @return [Plugin]
+    def self.from_git(_git, _args)
+      raise NoMethodError, 'from_git must be overridden by the plugin subclass'
+    end
+
+    # @abstract This should use a path and call +Plugin.new+.
+    #
+    # @param [String] _path The path to use when calling +Plugin.new+.
+    # @param [Array] _args The arguments to process.
+    #
+    # @return [Plugin]
+    def self.from_path(_path, _args)
+      raise NoMethodError, 'from_path must be overridden by the plugin subclass'
+    end
+
+    # @abstract This will receive an array of strings (e.g. +ARGV+) and call +Plugin.new+.
+    #
+    # @param [Array] _args The arguments to process.
+    #
+    # @return [Plugin]
+    def self.from_args(_args)
+      raise NoMethodError, 'from_args must be overridden by the plugin subclass'
+    end
+
+    # Gets the plugin's theme. Override to use a theme besides the default.
+    def theme
+      Repofetch::DEFAULT_THEME
+    end
+
+    # @abstract The ASCII to be printed alongside the stats.
+    #
+    # This should be overridden by the plugin subclass.
+    # Should be within the bounds 40x20 (width x height).
+    def ascii
+      raise NoMethodError, 'ascii must be overridden by the plugin subclass'
+    end
+
+    # @abstract The header to show for the plugin.
+    #
+    # This should be overridden by the plugin subclass.
+    #
+    # If an array is returned, it will be joined by +header_joiner+.
+    #
+    # @return [String, Array<String>]
+    def header
+      raise NoMethodError, 'header must be overridden by the plugin subclass'
+    end
+
+    # A string to join header text.
+    #
+    # Override to use a different string.
+    # @return [String]
+    def header_joiner
+      ' @ '
+    end
+
+    # Creates the separator that appears underneath the header
+    def separator
+      return '-' * header.length unless header.is_a?(Array)
+
+      header_length = header.map(&:length).sum + ((header.length - 1) * header_joiner.length)
+
+      '-' * header_length
+    end
+
+    def to_s
+      zipped_lines.map do |ascii_line, stat_line|
+        cleaned_ascii = remove_format_params(ascii_line)
+        styled_ascii = (ascii_line % theme.to_h) + theme.style(:reset)
+        aligned_stat_line = "#{' ' * (MAX_ASCII_WIDTH + 5)}#{stat_line}"
+        "#{styled_ascii}#{aligned_stat_line.slice(cleaned_ascii.length..)}\n"
+      end.join
+    end
+
+    # @abstract An array of stats that will be displayed to the right of the ASCII art.
+    #
+    # @return [Array<Stat>]
+    def stats
+      []
+    end
+
+    # The primary color to use for the header and stats.
+    #
+    # Override to use a different color from the theme.
+    # @see Repofetch::Theme
+    #
+    # @return [Symbol]
+    def primary_color
+      :default
+    end
+
+    # Returns the header, formatted with the primary color and bold, and joined with the header joiner.
+    #
+    # @return [String]
+    def formatted_header
+      (header.is_a?(Array) ? header : [header]).map { |h| apply_styles(h, :bold, primary_color) }.join(header_joiner)
+    end
+
+    # Makes an array of stat lines, including the header and separator.
+    def stat_lines
+      styled_stats = stats.map do |stat|
+        next stat unless stat.is_a?(Repofetch::Stat)
+
+        stat.style_label(:bold, primary_color).format(theme)
+      end
+      [formatted_header, separator, *styled_stats]
+    end
+
+    # Zips ASCII lines with stat lines.
+    #
+    # If there are more of one than the other, than the zip will be padded with empty strings.
+    def zipped_lines
+      ascii_lines = ascii.lines.map(&:chomp)
+      if ascii_lines.length > stat_lines.length
+        ascii_lines.zip(stat_lines)
+      else
+        stat_lines.zip(ascii_lines).map(&:reverse)
+      end.map { |ascii, stat| [ascii.to_s, stat.to_s] }
+    end
+
+    private
+
+    def apply_styles(str, *styles)
+      styles.inject(str) { |style, s| theme.format(s, style) }
+    end
+  end
+end

data/lib/repofetch/stat.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class Repofetch
+  # Base class for stats.
+  class Stat
+    attr_reader :label, :value, :emoji
+    attr_writer :theme
+
+    # Creates a stat
+    #
+    # @param [String] label The label of the stat
+    # @param value The value of the stat
+    # @param [String] emoji An optional emoji for the stat
+    def initialize(label, value, emoji: nil)
+      @label = label
+      @value = value
+      @emoji = emoji
+      @label_styles = []
+    end
+
+    def format(theme = nil)
+      return to_s if theme.nil?
+
+      emoji = @emoji
+      emoji = nil unless Repofetch.config.nil? || Repofetch.config.emojis?
+      styled_label = @label_styles.inject(@label) { |label, style| theme.format(style, label) }
+      "#{emoji}#{styled_label}: #{format_value}"
+    end
+
+    # Formats the value of the stat
+    #
+    # Simply calls +to_s+, but can be overridden by subclasses.
+    def format_value
+      @value.to_s
+    end
+
+    def to_s
+      emoji = @emoji
+      emoji = nil unless Repofetch.config.nil? || Repofetch.config.emojis?
+      "#{emoji}#{@label}: #{@value}"
+    end
+
+    # Adds one or more styles for the label
+    #
+    # @param [Symbol] style The theme's style to add
+    # @param [Symbol] styles Additional styles to add
+    def style_label!(style, *styles)
+      @label_styles << style
+      @label_styles.concat(styles)
+    end
+
+    # Adds one or more styles for the label, returning a new stat
+    #
+    # @param [Symbol] style The theme's style to add
+    # @return [Stat] A new stat with the style added
+    def style_label(style, *styles)
+      dup.tap { |stat| stat.style_label!(style, *styles) }
+    end
+  end
+end

data/lib/repofetch/timespan_stat.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'repofetch/stat'
+
+class Repofetch
+  # Timespan stat for "x units ago" stats.
+  class TimespanStat < Stat
+    include ActionView::Helpers::DateHelper
+
+    # Formats the value as "x units ago".
+    def format_value(now = nil)
+      now = Time.now if now.nil?
+      "#{distance_of_time_in_words(@value, now)} ago"
+    end
+  end
+end

data/lib/repofetch/util.rb

@@ -2,10 +2,41 @@
 
 class Repofetch
   # Provides uncategorized utilities.
-  class Util
-    # Cleans a string with style parameters (e.g. +"%{green}OK"+ -> +"OK"+)
-    def self.clean_s(str)
+  module Util
+    # Converts a format string into a plain string (e.g. +"%{green}OK"+ -> +"OK"+)
+    def remove_format_params(str)
       str.gsub(/%{[\w\d]+?}/, '')
     end
+
+    # Removes ANSI escape sequences from +str+.
+    def clean_ansi(str)
+      str.gsub("\e", '').gsub(/\[\d+(;\d+)*m/, '')
+    end
+
+    # Gets the name of the default remote to use.
+    #
+    # Will try to pick "origin", but if that is not found then it will
+    # pick the first one found, or nil if there aren't any available.
+    #
+    # @param [Git::Base] git The repository instance.
+    #
+    # @return [Git::Remote]
+    def default_remote(git)
+      remotes = git.remotes
+      found_remote = remotes.find { |remote| remote.name == 'origin' }
+      found_remote = remotes[0] if found_remote.nil?
+      found_remote
+    end
+
+    # Just wrapper around +default_remote+ since this is likely the most common
+    # use case (and it's easier than referencing the +Git::Remote+ docs to ensure
+    # correct usage in each plugin).
+    #
+    # @param [Git::Base] git The repository instance.
+    #
+    # @return [String]
+    def default_remote_url(git)
+      default_remote(git)&.url
+    end
   end
 end

data/lib/repofetch.rb

@@ -5,6 +5,9 @@ require 'git'
 require 'repofetch/config'
 require 'repofetch/env'
 require 'repofetch/exceptions'
+require 'repofetch/plugin'
+require 'repofetch/stat'
+require 'repofetch/timespan_stat'
 require 'repofetch/theme'
 require 'repofetch/util'
 
@@ -56,230 +59,75 @@ class Repofetch
   # Raises a +Repofetch::NoPluginsError+ if no plugins are found.
   # Raises a +Repofetch::TooManyPluginsError+ if more than one plugin is found.
   #
-  # @param [Git::Base] git A repository instance.
+  # @param [String] path The path to check.
   # @param [Array<String>] args The arguments passed to the program.
   #
   # @raise [NoPluginsError] If no plugins were selected.
   # @raise [TooManyPluginsError] If more than one plugin was selected.
   #
   # @return [Plugin] A plugin to use.
-  def self.get_plugin(git, args)
-    available_plugins = @plugins.filter do |plugin_class|
-      plugin_class.matches_repo?(git)
-    rescue NoMethodError
-      warn "#{plugin_class} Does not implement +matches_repo?+"
-      false
-    end
-    raise NoPluginsError if available_plugins.empty?
+  def self.get_plugin(path, args)
+    path_plugin = get_plugin_for_path(path)
+    repo_plugin = get_plugin_for_repo(path)
+
+    raise TooManyPluginsError if path_plugin && repo_plugin
+
+    raise NoPluginsError if path_plugin.nil? && repo_plugin.nil?
 
-    raise TooManyPluginsError if available_plugins.length > 1
+    return path_plugin.from_path(path, args) unless path_plugin.nil?
 
-    available_plugins[0].from_git(git, args)
+    git = Git.open(path)
+    repo_plugin.from_git(git, args)
   end
 
-  # Gets the name of the default remote to use.
+  # Gets the plugins that matches the given path.
   #
-  # Will try to pick "origin", but if that is not found then it will
-  # pick the first one found, or nil if there aren't any available.
+  # @param [String] path The path to check.
   #
-  # @param [Git::Base] git The repository instance.
-  #
-  # @return [Git::Remote]
-  def self.default_remote(git)
-    remotes = git.remotes
-    found_remote = remotes.find { |remote| remote.name == 'origin' }
-    found_remote = remotes[0] if found_remote.nil?
-    found_remote
+  # @return [Array<Plugin>] The plugins that match the path.
+  def self.get_plugins_for_path(path)
+    @plugins.filter { |plugin_class| plugin_class.matches_path?(path) }
   end
 
-  # Just wrapper around +default_remote+ since this is likely the most common
-  # use case (and it's easier than referencing the +Git::Remote+ docs to ensure
-  # correct usage in each plugin).
+  # Gets a single plugin that matches the given path.
   #
-  # @param [String] path The path to the repository.
+  # @param [String] path The path to check.
   #
-  # @return [String]
-  def self.default_remote_url(path)
-    default_remote(path)&.url
-  end
-
-  # @abstract Subclass to create a plugin.
-  class Plugin
-    # Plugin intializer arguments should come from the +from_git+ or +from_args+
-    # class methods.
-    def initialize(*) end
-
-    # Registers this plugin class for repofetch.
-    def self.register
-      Repofetch.register_plugin(self)
-    end
-
-    # Tries to replace another plugin. An example use case might be if this plugin
-    # extends another registered plugin.
-    #
-    # @param [Plugin] old The plugin to replace
-    def self.replace_or_register(old)
-      Repofetch.replace_or_register_plugin(old, self)
-    end
-
-    # @abstract Detects that this plugin should be used. Should be overridden by subclasses.
-    #
-    # An example implementation is checking if +Repofetch.default_remote_url+ matches
-    # a regular expression.
-    #
-    # @param [Git::Base] _git The Git repository object
-    def self.matches_repo?(_git)
-      raise NoMethodError, 'matches_repo? must be overridden by the plugin subclass'
-    end
+  # @return [Plugin, nil] The plugin that matches the path.
+  def self.get_plugin_for_path(path)
+    plugins = get_plugins_for_path(path)
 
-    # @abstract This should use a git instance and call +Plugin.new+.
-    #
-    # @param [Git::Base] _git The Git repository object to use when calling +Plugin.new+.
-    # @param [Array] _args The arguments to process.
-    #
-    # @return [Plugin]
-    def self.from_git(_git, _args)
-      raise NoMethodError, 'from_git must be overridden by the plugin subclass'
-    end
-
-    # @abstract This will receive an array of strings (e.g. +ARGV+) and call +Plugin.new+.
-    #
-    # @param [Array] _args The arguments to process.
-    #
-    # @return [Plugin]
-    def self.from_args(_args)
-      raise NoMethodError, 'from_args must be overridden by the plugin subclass'
-    end
-
-    # Gets the plugin's theme. Override to use a theme besides the default.
-    def theme
-      Repofetch::DEFAULT_THEME
-    end
-
-    # @abstract The ASCII to be printed alongside the stats.
-    #
-    # This should be overridden by the plugin subclass.
-    # Should be within the bounds 40x20 (width x height).
-    def ascii
-      raise NoMethodError, 'ascii must be overridden by the plugin subclass'
-    end
-
-    # @abstract The header to show for the plugin.
-    #
-    # This should be overridden by the plugin subclass.
-    # For example, "foo/bar @ GitHub".
-    def header
-      raise NoMethodError, 'header must be overridden by the plugin subclass'
-    end
+    raise TooManyPluginsError if plugins.length > 1
 
-    # Creates the separator that appears underneath the header
-    def separator
-      '-' * Repofetch::Util.clean_s(header).length
-    end
-
-    def to_s
-      zipped_lines.map do |ascii_line, stat_line|
-        cleaned_ascii = Repofetch::Util.clean_s(ascii_line)
-        styled_ascii = (ascii_line % theme.to_h) + theme.style(:reset)
-        aligned_stat_line = "#{' ' * (MAX_ASCII_WIDTH + 5)}#{stat_line}"
-        "#{styled_ascii}#{aligned_stat_line.slice(cleaned_ascii.length..)}\n"
-      end.join
-    end
-
-    # @abstract An array of stats that will be displayed to the right of the ASCII art.
-    #
-    # @return [Array<Stat>]
-    def stats
-      []
-    end
-
-    # Adds +theme+ to the stats, mutating those stats.
-    #
-    # @return [Array<Stat>]
-    def theme_stats!
-      stats.each do |stat|
-        stat.theme = theme if stat.respond_to?(:theme=)
-      end
-    end
-
-    # Makes an array of stat lines, including the header and separator.
-    #
-    # Mutates +stats+ to add the +theme+.
-    def stat_lines!
-      [header, separator, *theme_stats!.map(&:to_s)]
-    end
-
-    # Zips ASCII lines with stat lines.
-    #
-    # If there are more of one than the other, than the zip will be padded with empty strings.
-    def zipped_lines
-      ascii_lines = ascii.lines.map(&:chomp)
-      stat_lines = stat_lines!
-      if ascii_lines.length > stat_lines.length
-        ascii_lines.zip(stat_lines)
-      else
-        stat_lines.zip(ascii_lines).map(&:reverse)
-      end.map { |ascii, stat| [ascii.to_s, stat.to_s] }
-    end
+    plugins[0]
   end
 
-  # Base class for stats.
-  class Stat
-    attr_reader :label, :value, :emoji
-    attr_writer :theme
-
-    # Creates a stat
-    #
-    # @param [String] label The label of the stat
-    # @param value The value of the stat
-    # @param [String] emoji An optional emoji for the stat
-    def initialize(label, value, emoji: nil)
-      @label = label
-      @value = value
-      @emoji = emoji
-      @label_styles = []
-    end
-
-    def to_s
-      emoji = @emoji
-      emoji = nil unless Repofetch.config.nil? || Repofetch.config.emojis?
-      "#{emoji}#{format_label}: #{format_value}"
-    end
-
-    # Adds a style for the label
-    #
-    # @param [Symbol] style The theme's style to add
-    def style_label!(style)
-      @label_styles << style
-    end
-
-    # Formats the label, including styles.
-    #
-    # @return [String]
-    def format_label
-      return @label if @theme.nil?
-
-      @label_styles.inject(@label) { |label, style| @theme.format(style, label) }
+  # Gets the plugins that matches the given repository.
+  #
+  # @param [String] path The repository to check.
+  #
+  # @return [Array<Plugin>] The plugins that match the repository.
+  def self.get_plugins_for_repo(path)
+    begin
+      git = Git.open(path)
+    rescue ArgumentError
+      return []
     end
 
-    # Formats the value
-    #
-    # This simply converts the value to a string, but can be overridden but
-    # subclasses to affect +to_s+.
-    def format_value
-      @value.to_s
-    end
+    @plugins.filter { |plugin_class| plugin_class.matches_repo?(git) }
   end
 
-  # Timespan stat for "x units ago" stats.
-  class TimespanStat < Stat
-    include ActionView::Helpers::DateHelper
+  # Gets a single plugin that matches the given repository.
+  #
+  # @param [String] path The repository to check.
+  #
+  # @return [Plugin, nil] The plugin that matches the repository.
+  def self.get_plugin_for_repo(path)
+    plugins = get_plugins_for_repo(path)
 
-    # Formats the value as "x units ago".
-    def format_value(now = nil)
-      now = Time.now if now.nil?
-      "#{distance_of_time_in_words(@value, now)} ago"
-    end
+    raise TooManyPluginsError if plugins.length > 1
+
+    plugins[0]
   end
 
   def self.clear_plugins

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repofetch
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Spenser Black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-13 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -298,6 +298,7 @@ files:
 - lib/repofetch/DEFAULT_CONFIG
 - lib/repofetch/bitbucketcloud.rb
 - lib/repofetch/bitbucketcloud/ASCII
+- lib/repofetch/bitbucketcloud/stats.rb
 - lib/repofetch/cli.rb
 - lib/repofetch/config.rb
 - lib/repofetch/env.rb
@@ -306,7 +307,10 @@ files:
 - lib/repofetch/github/ASCII
 - lib/repofetch/gitlab.rb
 - lib/repofetch/gitlab/ASCII
+- lib/repofetch/plugin.rb
+- lib/repofetch/stat.rb
 - lib/repofetch/theme.rb
+- lib/repofetch/timespan_stat.rb
 - lib/repofetch/util.rb
 homepage: https://github.com/spenserblack/repofetch
 licenses: