github_members 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f27c99dd181831eb919dead2f515dbdfe8677732df33a529681f3218523fd045
-  data.tar.gz: 2a8315bd3492878505168b9d6bb1b77f58e5aa50cd7780eece32d48c8fd0e45c
+  metadata.gz: b3252336e573db141cb2b04483678c6265eef27c14935fac81f5fc11764c3d68
+  data.tar.gz: e7fd29914612158a441f083af6a0a382287b1bf07c56fee013de1d5226a70136
 SHA512:
-  metadata.gz: ad928b3fad1ff61336a0c435e113ab534538465144c38f0bd056898018d2ee29b98d52cd63f75191610af477e548cbb197894d159a2f3f0c422f07086ec4a736
-  data.tar.gz: 90a313c90fa74106671683b6143e84c7189bee49b1262df2ba88062a4b3a7ee6ebb119df07a2255675adb53bdbe2f3e60c15748c7c4a0f0e118ec73d63a195c3
+  metadata.gz: 82fb677c50b06554eceb70fa95c798e26f8236aa47ed4af5cc3a82a382d357139f0073852676b456fd48494fb19a8eed42d853789253d6a5da5588884bb544b0
+  data.tar.gz: 00b2bd9ad58d25d21a9f4a4cb197d5efa6816cb5a1388418c632fd4996b4271c0cb00d54e54ca4aa0dde2516dc5ed0f16ca9bf1b82de675f352961357ab8a978

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/github_members.svg)](https://badge.fury.io/rb/github_members)
+
 # GitHub Members
 
 Manage GitHub members who belong to an organization.
@@ -43,6 +45,8 @@ Examples:
 
 <!-- HELP:END -->
 
+You can use also the `github-members` command instead of `github_members`.
+
 ### Prepare GitHub access token
 
 By default, only public members of a specified organization is fetched.
@@ -70,3 +74,8 @@ When running `github_members`, a table of a specified organization members is in
 
 <!-- GITHUB_MEMBERS:END -->
 ```
+
+## Releasing
+
+1. Update [`GithubMembers::VERSION`](lib/github_members/version.rb) and commit the updated file.
+2. Run workflow on [Actions](https://github.com/ybiquitous/github_members/actions/workflows/release.yml).

data/exe/github-members

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/github_members"
+
+exit GithubMembers::CLI.new(ARGV).run

data/lib/github_members/cli.rb

@@ -1,5 +1,7 @@
 module GithubMembers
   class CLI
+    class RequiredMemberAttributes < Error; end
+
     EXIT_SUCCESS = 0
     EXIT_FAILURE = 1
 
@@ -32,9 +34,18 @@ module GithubMembers
         return EXIT_FAILURE
       end
 
-      members = read_members
+      org = Organization.new(client.fetch_organization(options.github_org))
+
+      yaml_file = options.yaml_file
+      members =
+        begin
+          read_members(yaml_file)
+        rescue RequiredMemberAttributes => e
+          warn e.message
+          return EXIT_FAILURE
+        end
 
-      Client.new(options).fetch_members(options.github_org).each do |new_member|
+      client.fetch_members(org.name).each do |new_member|
         github = new_member.fetch(:github)
         fullname = new_member.fetch(:fullname)
         avatar = new_member.fetch(:avatar)
@@ -57,29 +68,44 @@ module GithubMembers
 
       members.delete_if { |_, m| !m.updated }
 
-      write_members(members.values)
+      write_members(members.values, yaml_file)
+      puts "Updated: #{yaml_file}"
 
-      MarkdownWriter.new.write(members: members.values, file: options.markdown_file)
+      markdown_file = options.markdown_file
+      MarkdownWriter.new.write(org: org, members: members.values, file: markdown_file)
+      puts "Updated: #{markdown_file}"
 
       EXIT_SUCCESS
     end
 
-    private def member_class
+    private
+
+    def client
+      @client ||= Client.new(options)
+    end
+
+    def member_class
       @member_class ||= Member.new.define_class(*options.fields)
     end
 
-    private def read_members
-      file = options.yaml_file
+    def read_members(file)
       return {} unless file.exist?
 
-      YAML.safe_load(File.read(file)).each_with_object({}) do |member, hash|
-        m = member_class.new(**member, updated: false)
-        hash[m.github] = m
+      YAML.safe_load(File.read(file)).each_with_object({}) do |member_attrs, hash|
+        member = member_class.new(updated: false)
+
+        required_attrs = member_attrs.keys.map(&:to_sym) - member.members
+        unless required_attrs.empty?
+          raise RequiredMemberAttributes, "Needed to specify the option: --fields #{required_attrs.join(",")}"
+        end
+
+        member_attrs.each { |key, value| member[key] = value }
+        hash[member.github] = member
       end
     end
 
-    private def write_members(members)
-      options.yaml_file.write(members.map(&:to_h).to_yaml)
+    def write_members(members, file)
+      file.write(members.map(&:to_h).to_yaml)
     end
   end
 end

data/lib/github_members/client.rb

@@ -27,5 +27,15 @@ module GithubMembers
         }
       end
     end
+
+    def fetch_organization(org)
+      Octokit.organization(org).then do |gh_org|
+        {
+          name: gh_org.login,
+          fullname: gh_org.name,
+          url: gh_org.html_url
+        }
+      end
+    end
   end
 end

data/lib/github_members/markdown_writer.rb

@@ -5,7 +5,7 @@ module GithubMembers
     TAG_BEGIN = "<!-- GITHUB_MEMBERS:BEGIN -->"
     TAG_END = "<!-- GITHUB_MEMBERS:END -->"
 
-    def write(members:, file:)
+    def write(org:, members:, file:)
       unless file.exist?
         file.write(<<~MARKDOWN)
           # Members
@@ -16,14 +16,14 @@ module GithubMembers
       end
 
       table = render_table(members)
-      write_file(table, members.size, file)
+      write_file(table, members.size, org, file)
     end
 
     private def render_table(members)
       return "" if members.empty?
 
       fields = members.first.additional_fields
-      labels = ["", "GitHub", "Fullname"]
+      labels = [" ", "GitHub", "Fullname"]
       align = ["c", "l", "l"]
 
       fields.each do |field|
@@ -48,7 +48,7 @@ module GithubMembers
       MarkdownTables.make_table(labels, data, is_rows: true, align: align)
     end
 
-    private def write_file(table, member_count, file)
+    private def write_file(table, member_count, org, file)
       content = file.read
 
       unless content.include?(TAG_BEGIN)
@@ -61,7 +61,7 @@ module GithubMembers
 
       content.sub!(/#{TAG_BEGIN}.+#{TAG_END}/mo, <<~MARKDOWN.strip)
         #{TAG_BEGIN}
-        **#{member_count}** member#{member_count == 1 ? "" : "s"}
+        **#{member_count}** member#{member_count == 1 ? "" : "s"} of [#{org.name}](#{org.url})
 
         #{table}
         #{TAG_END}

data/lib/github_members/options.rb

@@ -17,7 +17,7 @@ module GithubMembers
       self.github_token = ENV["GITHUB_TOKEN"].to_s
 
       args = parser.parse!(argv)
-      self.help = parser.help + help_examples
+      self.help = parser.help + help_examples(parser.program_name)
       self.github_org = args.first
       self.markdown_file = Pathname(markdown_file || Defaults::MARKDOWN_FILE)
       self.yaml_file = Pathname(yaml_file || Defaults::YAML_FILE)
@@ -27,7 +27,7 @@ module GithubMembers
 
     private def parser
       @parser ||= OptionParser.new do |opts|
-        opts.banner = "Usage: github_members [options] <org>"
+        opts.banner = "Usage: #{opts.program_name} [options] <org>"
 
         opts.on("-g", "--github-token GITHUB_TOKEN",
           "A GitHub access token. The `GITHUB_TOKEN` environment variable",
@@ -57,22 +57,22 @@ module GithubMembers
       end
     end
 
-    private def help_examples
+    private def help_examples(program_name)
       <<~HELP
 
         Examples:
             # By default
-            github_members <org>
+            #{program_name} <org>
 
             # Set a token
-            GITHUB_TOKEN=*** github_members <org>
-            github_members <org> -g ***
+            GITHUB_TOKEN=*** #{program_name} <org>
+            #{program_name} <org> -g ***
 
             # Specify files
-            github_members <org> -m README.md -y company_members.yml
+            #{program_name} <org> -m README.md -y company_members.yml
 
             # Add fields
-            github_members <org> -f slack,note
+            #{program_name} <org> -f slack,note
       HELP
     end
   end

data/lib/github_members/organization.rb

@@ -0,0 +1,3 @@
+module GithubMembers
+  Organization = Struct.new(:name, :fullname, :url, keyword_init: true)
+end

data/lib/github_members/version.rb

@@ -1,3 +1,3 @@
 module GithubMembers
-  VERSION = "0.0.1"
+  VERSION = "0.0.2".freeze
 end

data/lib/github_members.rb

@@ -9,6 +9,7 @@ require_relative "github_members/defaults"
 require_relative "github_members/markdown_writer"
 require_relative "github_members/member"
 require_relative "github_members/options"
+require_relative "github_members/organization"
 require_relative "github_members/version"
 
 require_relative "github_members/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_members
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Masafumi Koba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markdown-tables
@@ -43,12 +43,14 @@ email:
 - ybiquitous@gmail.com
 executables:
 - github_members
+- github-members
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- exe/github-members
 - exe/github_members
 - lib/github_members.rb
 - lib/github_members/cli.rb
@@ -58,6 +60,7 @@ files:
 - lib/github_members/markdown_writer.rb
 - lib/github_members/member.rb
 - lib/github_members/options.rb
+- lib/github_members/organization.rb
 - lib/github_members/version.rb
 homepage: https://github.com/ybiquitous/github_members
 licenses: