repofetch 0.4.2.pre.rc.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f023092a0a4175633900e4bd9da512c5287a781be907cf57a8971a1fdd7fda6c
-  data.tar.gz: 6d1a8f7e801bf4f4e228249a650f5270dc38153bdfa9a7c32771dd02d01c098b
+  metadata.gz: a76fb4a912612b2c1c549434f7cfae5fbb88728d036a17f77060e5ae868eebaa
+  data.tar.gz: 01c3fefe7a5799a65e5a078bbb6d3ca891fe56c8db3b38a9f4989b8cd0336bf7
 SHA512:
-  metadata.gz: 3fc54f3354a0f0b531eea8a183391ac839244c714546439f4e21d5d42e4d9233ffc17150149b8c48c29fa1adcb21b7c5d46a504855daffbf9e36c10ab8710d1a
-  data.tar.gz: 29a97740e37ea30bd2f5017f42a0647c3cb944bd811e4d17831fb1d9fc55fe125c9db1d54aa4c9c4c14bef271ae850e2a6b0af067c78604006cc3aa5b939fd25
+  metadata.gz: 7190241c2007f706a366628ff13d1aeea7c64a2c37fc54b335d20eca2d3697a640dfd6cef50192d551dab8712e9abb4ca52a9cd0d43044922ca8f7fce6cb4eea
+  data.tar.gz: '0295d4dbc84815a2037dc239cbfcbfd2d3062d1d8ceb8fb17b9990744a67923c5310ddb5bfa9a6515eb723d981bca6b8e4a8394b63aa3c520d49254d43bdba49'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    repofetch (0.4.2.pre.rc.3)
+    repofetch (0.4.2)
       actionview (~> 7.0, >= 7.0.4)
       dotenv (~> 2.8)
       faraday-retry (~> 2.0)
       git (~> 1.12)
       octokit (~> 6.0, >= 6.0.1)
+      sawyer (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
@@ -33,7 +34,7 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
-    erubi (1.11.0)
+    erubi (1.12.0)
     faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
@@ -46,18 +47,19 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
-    json (2.6.2)
+    json (2.6.3)
     loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mini_portile2 (2.8.0)
-    minitest (5.16.3)
+    mini_portile2 (2.8.1)
+    minitest (5.17.0)
     nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     octokit (6.0.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
+    os (1.1.4)
     overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -66,7 +68,7 @@ GEM
     parser (3.1.3.0)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
-    racc (1.6.1)
+    racc (1.6.2)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -93,28 +95,28 @@ GEM
       awesome_print (> 1.0.0)
       rspec (> 3.0.0)
     rspec-support (3.12.0)
-    rubocop (1.39.0)
+    rubocop (1.42.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.15.0)
+    rubocop-rspec (2.16.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -135,6 +137,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  os (~> 1.1)
   overcommit (~> 0.59)
   rake (~> 13.0)
   repofetch!

data/README.md

@@ -33,6 +33,14 @@ gem install repofetch
 
 If you are using an Arch machine, you can install repofetch from the [Aur](https://aur.archlinux.org).
 
+#### Stable
+
+```
+yay -S ruby-repofetch-bin
+```
+
+#### Development
+
 ```
 yay -S ruby-repofetch
 ```

data/RELEASE_NOTES

@@ -1,6 +1,18 @@
-0.4.2-rc.3
+0.4.2
+
+## Added
+
+- GitLab plugin
+  - Enable by adding `- repofetch/gitlab` to your config file
 
 ## Other
 
-- Deploy built gem as GitHub release asset for each release
 - Publish gem with GitHub Actions
+
+## Breaking for 3rd-party plugins
+
+### Changed
+
+- Configuration to be a class variable on `Repofetch` instead of a value that's
+  passed to various instantiation and rendering methods
+- Stats to automatically receive theme from the base `Plugin` class

data/Rakefile

@@ -3,11 +3,18 @@
 require 'bundler/setup'
 require 'rake'
 
+require 'os'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yard'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = if OS.windows?
+                   '--exclude-pattern spec/**/*_unix_spec.rb'
+                 else
+                   '--exclude-pattern spec/**/*_windows_spec.rb'
+                 end
+end
 RuboCop::RakeTask.new(:format) do |t|
   t.requires << 'rubocop-rspec'
 end

data/lib/repofetch/DEFAULT_CONFIG

@@ -2,4 +2,5 @@
 # vim: set ft=yaml:
 plugins:
   - 'repofetch/github'
+  - 'repofetch/gitlab'
 emojis: true

data/lib/repofetch/github.rb

@@ -30,7 +30,8 @@ class Repofetch
     end
 
     def stats
-      [url, stargazers, subscribers, forks, created, updated, size, issues, pull_requests]
+      stats = [url, stargazers, subscribers, forks, created, updated, size, issues, pull_requests]
+      stats.each { |stat| stat.style_label!(:bold) }
     end
 
     # Detects that the repository is a GitHub repository.
@@ -109,27 +110,27 @@ class Repofetch
     end
 
     def url
-      Repofetch::Stat.new('URL', repo_stats['clone_url'], emoji: '🌐', theme: theme)
+      Repofetch::Stat.new('URL', repo_stats['clone_url'], emoji: '🌐')
     end
 
     def stargazers
-      Repofetch::Stat.new('stargazers', repo_stats['stargazers_count'], emoji: '⭐', theme: theme)
+      Repofetch::Stat.new('stargazers', repo_stats['stargazers_count'], emoji: '⭐')
     end
 
     def subscribers
-      Repofetch::Stat.new('subscribers', repo_stats['subscribers_count'], emoji: '👀', theme: theme)
+      Repofetch::Stat.new('subscribers', repo_stats['subscribers_count'], emoji: '👀')
     end
 
     def forks
-      Repofetch::Stat.new('forks', repo_stats['forks_count'], emoji: '🔱', theme: theme)
+      Repofetch::Stat.new('forks', repo_stats['forks_count'], emoji: '🔱')
     end
 
     def created
-      Repofetch::TimespanStat.new('created', repo_stats['created_at'], emoji: '🐣', theme: theme)
+      Repofetch::TimespanStat.new('created', repo_stats['created_at'], emoji: '🐣')
     end
 
     def updated
-      Repofetch::TimespanStat.new('updated', repo_stats['updated_at'], emoji: '📤', theme: theme)
+      Repofetch::TimespanStat.new('updated', repo_stats['updated_at'], emoji: '📤')
     end
 
     def size
@@ -139,17 +140,17 @@ class Repofetch
         significant: false,
         strip_insignificant_zeros: false
       )
-      Repofetch::Stat.new('size', byte_size, emoji: '💽', theme: theme)
+      Repofetch::Stat.new('size', byte_size, emoji: '💽')
     end
 
     def issues
       @issue_search = @client.search_issues("repo:#{repo_id} is:issue", per_page: 1, page: 0) if @issue_search.nil?
-      Repofetch::Stat.new('issues', @issue_search['total_count'], emoji: '❗', theme: theme)
+      Repofetch::Stat.new('issues', @issue_search['total_count'], emoji: '❗')
     end
 
     def pull_requests
       @pr_search = @client.search_issues("repo:#{repo_id} is:pr", per_page: 1, page: 0) if @pr_search.nil?
-      Repofetch::Stat.new('pull requests', @pr_search['total_count'], emoji: '🔀', theme: theme)
+      Repofetch::Stat.new('pull requests', @pr_search['total_count'], emoji: '🔀')
     end
   end
 end

data/lib/repofetch/gitlab/ASCII

@@ -0,0 +1,17 @@
+%{red}          OOO                  OOO           
+%{red}        OOOOOO                OOOOOO         
+%{red}       OOOOOOOO              OOOOOOOO        
+%{red}      OOOOOOOOOO            OOOOOOOOOO       
+%{red}     OOOOOOOOOOOO          OOOOOOOOOOOO      
+%{red}    OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO     
+%{red}   OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO    
+%{yellow}   ...%{red}OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO%{yellow}...    
+%{yellow}   ......%{red}OOOOOOOOOOOOOOOOOOOOOOOOOO%{yellow}......    
+%{yellow}    ........%{red}OOOOOOOOOOOOOOOOOOOO%{yellow}........     
+%{yellow}     ..........%{red}OOOOOOOOOOOOOO%{yellow}..........      
+%{yellow}      ............%{red}OOOOOOOO%{yellow}............       
+%{yellow}        .............%{red}OO%{yellow}..............        
+%{yellow}           .......%{yellow}@@@@@@@@%{yellow}........           
+%{yellow}             ..%{yellow}@@@@@@@@@@@@@@@%{yellow}..             
+%{yellow}                @@@@@@@@@@@@@                
+%{yellow}                   @@@@@@@                   

data/lib/repofetch/gitlab.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'repofetch'
+require 'sawyer'
+
+class Repofetch
+  # Adds support for GitLab repositories.
+  class Gitlab < Repofetch::Plugin
+    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__))
+
+    attr_reader :repo_identifier
+
+    # @param repo_identifier [String] The repository identifier (either the ID number or the namespaced repo name).
+    def initialize(repo_identifier)
+      super
+
+      @repo_identifier = CGI.escape(repo_identifier)
+    end
+
+    def header
+      "#{repo_data['name_with_namespace']} @ GitLab"
+    end
+
+    def stats
+      stats = [url, stars, forks, created, updated]
+
+      # NOTE: Stats that require authentication
+      stats << open_issues unless token.nil?
+
+      stats.each { |stat| %i[bold red].each { |style| stat.style_label!(style) } }
+    end
+
+    def ascii
+      ASCII
+    end
+
+    def agent
+      @agent ||= Sawyer::Agent.new('https://gitlab.com/api/v4', links_parser: Sawyer::LinkParsers::Simple.new) do |http|
+        http.headers['Authorization'] = "Bearer #{token}" unless token.nil?
+      end
+    end
+
+    def token
+      ENV.fetch('GITLAB_TOKEN', nil)
+    end
+
+    def repo_data
+      @repo_data ||= agent.call(:get, "projects/#{@repo_identifier}").data
+    end
+
+    def url
+      Repofetch::Stat.new('URL', repo_data['http_url_to_repo'], emoji: '🌐')
+    end
+
+    def stars
+      Repofetch::Stat.new('stars', repo_data['star_count'], emoji: '⭐')
+    end
+
+    def forks
+      Repofetch::Stat.new('forks', repo_data['forks_count'], emoji: '🔱')
+    end
+
+    def created
+      Repofetch::TimespanStat.new('created', repo_data['created_at'], emoji: '🐣')
+    end
+
+    def updated
+      Repofetch::TimespanStat.new('updated', repo_data['last_activity_at'], emoji: '📤')
+    end
+
+    def open_issues
+      # NOTE: It seems like the auth token must be set to get the open issues count.
+      Repofetch::Stat.new('open issues', repo_data['open_issues_count'], emoji: '❗')
+    end
+
+    # 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)
+    end
+
+    # Gets the path (+owner/subproject/repo+) of the repository.
+    #
+    # Returns nil if there is no match.
+    def self.remote_identifier(remote)
+      match = HTTP_REMOTE_REGEX.match(remote)
+      match = SSH_REMOTE_REGEX.match(remote) if match.nil?
+      raise "Remote #{remote.inspect} doesn't look like a GitLab remote" if match.nil?
+
+      match[:path].delete_suffix('.git')
+    end
+
+    # 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)
+    end
+
+    # Detects that the remote URL is for a GitHub repository.
+    def self.matches_remote?(remote)
+      HTTP_REMOTE_REGEX.match?(remote) || SSH_REMOTE_REGEX.match?(remote)
+    end
+
+    # Creates an instance from a +Git::Base+ instance.
+    #
+    # @raise [ArgumentError] if this plugin was selected *and* arguments were passed.
+    def self.from_git(git, args)
+      # TODO: Raise a better exception than ArgumentError
+      raise ArgumentError, 'Explicitly activate this plugin to CLI arguments' unless args.empty?
+
+      path = repo_identifier(git)
+
+      new(path)
+    end
+
+    def self.from_args(args)
+      new(args[0])
+    end
+  end
+end
+
+Repofetch::Gitlab.register

data/lib/repofetch/theme.rb

@@ -28,6 +28,9 @@ class Repofetch
 
     attr_reader :styles
 
+    # Initializes a new theme.
+    #
+    # @param [Hash] styles A Hash of styles to use. Is merged with the default styles.
     def initialize(styles = {})
       @styles = DEFAULT_STYLES.merge(styles)
     end

data/lib/repofetch.rb

@@ -193,9 +193,20 @@ class Repofetch
       []
     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.
-    def stat_lines
-      [header, separator, *stats.map(&:to_s)]
+    #
+    # Mutates +stats+ to add the +theme+.
+    def stat_lines!
+      [header, separator, *theme_stats!.map(&:to_s)]
     end
 
     # Zips ASCII lines with stat lines.
@@ -203,6 +214,7 @@ class Repofetch
     # 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
@@ -214,23 +226,40 @@ 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, theme: nil)
+    def initialize(label, value, emoji: nil)
       @label = label
       @value = value
       @emoji = emoji
-      @theme = theme
+      @label_styles = []
     end
 
     def to_s
       emoji = @emoji
       emoji = nil unless Repofetch.config.nil? || Repofetch.config.emojis?
-      "#{emoji}#{@theme.nil? ? @label : @theme.format(:bold, @label)}: #{format_value}"
+      "#{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) }
     end
 
     # Formats the value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repofetch
 version: !ruby/object:Gem::Version
-  version: 0.4.2.pre.rc.3
+  version: 0.4.2
 platform: ruby
 authors:
 - Spenser Black
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -92,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -274,6 +302,8 @@ files:
 - lib/repofetch/exceptions.rb
 - lib/repofetch/github.rb
 - lib/repofetch/github/ASCII
+- lib/repofetch/gitlab.rb
+- lib/repofetch/gitlab/ASCII
 - lib/repofetch/theme.rb
 - lib/repofetch/util.rb
 homepage: https://github.com/spenserblack/repofetch
@@ -297,9 +327,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: