fewald-worklog 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a506272e4cd5333bf7cde0d53485b610824df90266582bea673c80b21d068cb8
-  data.tar.gz: 8370a7e86257ffe693ad26f43814a35c78d0196e6594e0987e4b7242c75b0dad
+  metadata.gz: f4b6b051e9dd15f4588ddcff4a3f23686077c3b6fa8c8fda053cd6187a91a34c
+  data.tar.gz: 7a3b6ff79f314e30016776efed9fbe2a76b68e46658c4658185577f27a7cf3bf
 SHA512:
-  metadata.gz: 9e53674d918ee23dd49e66a833c2d86f8653d5ff84db5833bcf13864b121d843c09b2dfc94f4c92c38f5cd485d977fbc1f68a53efc71f9cb755589ac83e96552
-  data.tar.gz: 56d7e076bef0e561e1c4b1adf26c4b04c4a781bdc36f159460e4972f5645d7ea868de7df5625e7bb640377cee640be71f658cb5c0cd65e1d003f1dc1fcf26384
+  metadata.gz: 23c300fa90069057589a947ff9da63db056f28bc7021ba7a9a19cfd28dbf424ed1ada21a24a76cd29b72f1810a7f7c14bdd9c4547b84e330ef96e99b1dbfd640
+  data.tar.gz: 627e537ca0e1530d64bf7b4a1c78709f9910bcec382ed8c1dba43d7a0c35bc32f1488f45490d8432d5aae0cf4db1e8692982a46416821b8afe7bf8108738f58f

data/.version

@@ -1 +1 @@
-0.3.3
+0.3.5

data/lib/cli.rb

@@ -110,6 +110,7 @@ class WorklogCLI < Thor
   end
 
   desc 'people', 'Show all people mentioned in the work log'
+  option :inactive, type: :boolean, default: false, desc: 'Include inactive people in the list'
   def people(person = nil)
     worklog = Worklog::Worklog.new
     worklog.people(person, options)

data/lib/person.rb

@@ -1,57 +1,78 @@
 # frozen_string_literal: true
 
-# Represents a person at work.
-#
-# !attribute [r] handle
-#  @return [String] The person's handle (username)
-# !attribute [r] name
-#  @return [String] The person's full name
-# !attribute [r] email
-#  @return [String, nil] The person's email address, can be nil
-# !attribute [r] team
-#  @return [String, nil] The team the person belongs to, can be nil
-# !attribute [r] notes
-#  @return [Array<String>] An array of notes about the person
-class Person
-  attr_reader :handle, :name, :email, :team, :notes
-
-  def initialize(handle:, name:, email:, team:, notes: [])
-    @handle = handle
-    @name = name
-    @email = email
-    @team = team
-    @notes = notes
-  end
+module Worklog
+  # Represents a person at work.
+  #
+  # !attribute [r] handle
+  #  @return [String] The person's handle (username)
+  # !attribute [r] name
+  #  @return [String] The person's full name
+  # !attribute [r] email
+  #  @return [String, nil] The person's email address, can be nil
+  # !attribute [r] team
+  #  @return [String, nil] The team the person belongs to, can be nil
+  # !attribute [r] notes
+  #  @return [Array<String>] An array of notes about the person
+  #  !attribute [r] inactive
+  #  @return [Boolean] Whether the person is inactive (for example left the company)
+  class Person
+    attr_reader :handle, :github_username, :name, :email, :team, :notes, :inactive
 
-  # Creates a new Person instance from a hash of attributes.
-  # @param hash [Hash] A hash containing person attributes
-  # @option hash [String] :handle The person's handle (username)
-  # @option hash [String] :name The person's full name
-  # @option hash [String, nil] :email The person's email address, can be nil
-  # @option hash [String, nil] :team The team the person belongs to, can be nil
-  # @option hash [Array<String>] :notes An array of notes about the person
-  # @return [Person] A new Person instance
-  def self.from_hash(hash)
-    raise ArgumentError, 'Person handle is required' unless hash[:handle] || hash['handle']
-    raise ArgumentError, 'Person name is required' unless hash[:name] || hash['name']
-
-    handle = hash[:handle] || hash['handle']
-    name = hash[:name] || hash['name']
-    email = hash[:email] || hash['email']
-    team = hash[:team] || hash['team']
-    notes = hash[:notes] || hash['notes'] || []
-    Person.new(handle: handle, name: name, email: email, team: team, notes: notes)
-  end
+    def initialize(handle:, name:, **params)
+      # params to symbol keys
+      params = params.transform_keys(&:to_sym)
 
-  def to_s
-    return "#{name} (~#{handle})" if @email.nil?
+      @handle = handle
+      @name = name
+      @github_username = params[:github_username]
+      @email = params[:email]
+      @team = params[:team]
+      @notes = params[:notes] || []
+      @inactive = params[:inactive] || false
+    end
 
-    "#{name} (~#{handle}) <#{email}>"
-  end
+    # Returns true if the person is active (not inactive).
+    # If not specified, persons are active by default.
+    # @return [Boolean] true if active, false otherwise
+    def active?
+      !@inactive
+    end
+
+    # Returns true if the person is marked as inactive.
+    # @return [Boolean] true if inactive, false otherwise
+    def inactive?
+      @inactive
+    end
+
+    # Creates a new Person instance from a hash of attributes.
+    # @param hash [Hash] A hash containing person attributes
+    # @option hash [String] :handle The person's handle (username)
+    # @option hash [String] :name The person's full name
+    # @option hash [String, nil] :email The person's email address, can be nil
+    # @option hash [String, nil] :team The team the person belongs to, can be nil
+    # @option hash [Array<String>] :notes An array of notes about the person
+    # @return [Person] A new Person instance
+    def self.from_hash(hash)
+      hash = hash.transform_keys(&:to_sym)
+
+      raise ArgumentError, 'Person handle is required' unless hash[:handle]
+      raise ArgumentError, 'Person name is required' unless hash[:name]
+
+      handle = hash[:handle]
+      name = hash[:name]
+      Person.new(handle: handle, name: name, **hash)
+    end
+
+    def to_s
+      return "#{name} (~#{handle})" if @email.nil?
+
+      "#{name} (~#{handle}) <#{email}>"
+    end
 
-  def ==(other)
-    return false unless other.is_a?(Person)
+    def ==(other)
+      return false unless other.is_a?(Person)
 
-    handle == other.handle && name == other.name && email == other.email && team == other.team && notes == other.notes
+      handle == other.handle && name == other.name && email == other.email && team == other.team && notes == other.notes
+    end
   end
 end

data/lib/worklog.rb

@@ -157,7 +157,7 @@ module Worklog
     end
 
     # Show all known people and details about a specific person.
-    def people(person = nil, _options = {})
+    def people(person = nil, options = {})
       all_logs = @storage.all_days
 
       if person
@@ -180,6 +180,8 @@ module Worklog
 
         mentions.each do |handle, v|
           if @people.key?(handle)
+            next unless @people[handle].active? || options[:inactive]
+
             person = @people[handle]
             print "#{Rainbow(person.name).gold} (#{handle})"
             print " (#{person.team})" if person.team
@@ -195,6 +197,8 @@ module Worklog
       printer = Printer.new(@config, all_people)
       puts "All interactions with #{Rainbow(person.name).gold}"
 
+      puts "GitHub: #{Rainbow(person.github_username).blue}" if person.github_username
+
       if person.notes
         puts 'Notes:'
         person.notes.each do |note|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fewald-worklog
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Friedrich Ewald