github-nippou 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f8444807461575c3b84608f70b188bafbd4af4
-  data.tar.gz: b3690ae74f197ff76922aa7e34a7aca0293aab29
+  metadata.gz: 768b205b4d75ddf857b9b1006ec95cc909169333
+  data.tar.gz: b9ea743c90af5b63a70ad2607995266496f23f81
 SHA512:
-  metadata.gz: 7bc0194bc43367138171f0d51c614a53eaf9416f15f9d062fd61e732317f907ad81f273874adff878916f39a2e7e1d7e8556c1afef16aca1c8127d9f1fb08227
-  data.tar.gz: 07501c4a023aca64c3af0fdf05fcedfb68747fd78a9981d89956a6af59d31e49e4fed28a64ce40f91e6a3e2687fa9073b7eb43d1bb8f634b47cd288d29afcc71
+  metadata.gz: b31655b73e7a38155244cee3a7d23acbe19d3c882b7a63f118e1198536f495935bababb36dc8463397cddc9c10a039114009aa276ae601bef246dd60f468b4cc
+  data.tar.gz: 07c885f154e58c58a68b651e3215956fb49ac7188d68fb8ce2dd012ccfdf7a9733f9a8a551bb804bb36341d79951b7ce7a23c3b3ee8921cf5d9e61ed3d1942f0

data/Gemfile.lock

@@ -1,30 +1,32 @@
 PATH
   remote: .
   specs:
-    github-nippou (1.0.2)
-      octokit (~> 3.7)
+    github-nippou (1.1.0)
+      octokit
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.4.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     multipart-post (2.0.0)
-    octokit (3.8.0)
-      sawyer (~> 0.6.0, >= 0.5.3)
-    rake (10.4.2)
-    sawyer (0.6.0)
-      addressable (~> 2.3.5)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    rake (11.1.1)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler
   github-nippou!
-  rake (~> 10.0)
+  rake
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -1,9 +1,9 @@
 # Github::Nippou [![Gem Version][gem-badge]][gem-link]
 
-Print today's your GitHub action.
+Displays today's your GitHub action.
 
 This is a helpful tool when you write a daily report in reference to
-GitHub. nippou is a japanese word which means a daily report.
+GitHub. Nippou is a japanese word which means a daily report.
 
 ## Installation
 
@@ -28,7 +28,17 @@ Or install it yourself as:
 
 ## Usage
 
-    $ github-nippou
+```
+$ github-nippou help
+Commands:
+  github-nippou help [COMMAND]  # Describe available commands or one specific command
+  github-nippou list            # Displays today's GitHub events formatted for Nippou
+
+Options:
+  a, [--all], [--no-all]  # Displays all events that can retrieve from GitHub
+```
+
+You can omit the sub command `list`.
 
 ## Contributing
 

data/bin/github-nippou

@@ -2,4 +2,4 @@
 
 require 'github/nippou'
 
-Github::Nippou.list
+Github::Nippou::Commands.start

data/github-nippou.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'github/nippou/version'
@@ -21,8 +20,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'octokit', '~> 3.7'
+  spec.add_dependency 'octokit'
+  spec.add_dependency 'thor'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
 end

data/lib/github/nippou.rb

@@ -1,74 +1,2 @@
+require 'github/nippou/commands'
 require 'github/nippou/version'
-require 'octokit'
-
-module Github
-  module Nippou
-    def self.list
-      user = self.user
-      client = Octokit::Client.new(login: user, access_token: self.access_token)
-      events = client.user_events(user)
-
-      url_to_detail = {}
-
-      events.each do |_|
-        break unless _.created_at.getlocal.to_date == Time.now.to_date
-        case _.type
-        when 'IssuesEvent', 'IssueCommentEvent'
-          title = _.payload.issue.title.gsub('`', '\\\`')
-          merged = client.pull_merged?(_.repo.name, _.payload.issue.number)
-          url_to_detail[_.payload.issue.html_url] ||= {title: title, repo_basename: _.repo.name, username: _.payload.issue.user.login, merged: merged}
-        when 'PullRequestEvent', 'PullRequestReviewCommentEvent'
-          title = _.payload.pull_request.title.gsub('`', '\\\`')
-          merged = client.pull_merged?(_.repo.name, _.payload.pull_request.number)
-          url_to_detail[_.payload.pull_request.html_url] ||= {title: title, repo_basename: _.repo.name, username: _.payload.pull_request.user.login, merged: merged}
-        end
-      end
-
-      url_to_detail.each do |url, detail|
-        line = "* [#{detail[:title]} - #{detail[:repo_basename]}](#{url}) by #{detail[:username]}"
-        line << ' **merged!**' if detail[:merged]
-        puts line
-      end
-    end
-
-    private
-
-    def self.user
-      case
-      when ENV['GITHUB_NIPPOU_USER']
-        ENV['GITHUB_NIPPOU_USER']
-      when !`git config github-nippou.user`.chomp.empty?
-        `git config github-nippou.user`.chomp
-      else
-        puts <<MESSAGE
-** User required.
-
-Please set github-nippou.user to your .gitconfig.
-    $ git config --global github-nippou.user [Your GitHub account]
-MESSAGE
-        exit!
-      end
-    end
-
-    def self.access_token
-      case
-      when ENV['GITHUB_NIPPOU_ACCESS_TOKEN']
-        ENV['GITHUB_NIPPOU_ACCESS_TOKEN']
-      when !`git config github-nippou.token`.chomp.empty?
-        `git config github-nippou.token`.chomp
-      else
-        puts <<MESSAGE
-** Authorization required.
-
-Please set github-nippou.token to your .gitconfig.
-    $ git config --global github-nippou.token [Your GitHub access token]
-
-To get new token, visit
-https://github.com/settings/tokens/new
-
-MESSAGE
-        exit!
-      end
-    end
-  end
-end

data/lib/github/nippou/commands.rb

@@ -0,0 +1,115 @@
+require 'octokit'
+require 'thor'
+
+module StringExMarkdown
+  refine String do
+    def markdown_escape
+      self.gsub(/([`<>])/, '\\\\\1')
+    end
+  end
+end
+
+module Github
+  module Nippou
+    class Commands < Thor
+      using StringExMarkdown
+
+      default_task :list
+      class_option :all, type: :boolean, aliases: :a, desc: 'Displays all events that can retrieve from GitHub'
+
+      desc 'list', "Displays today's GitHub events formatted for Nippou"
+      def list
+        nippous.each do |url, detail|
+          line = "* [#{detail[:title]} - #{detail[:repo_basename]}](#{url}) by #{detail[:username]}"
+          line << ' **merged!**' if detail[:merged]
+          puts line
+        end
+      end
+
+      private
+
+      def nippous
+        result = {}
+        now = Time.now
+
+        client.user_events(user).each do |event|
+          break if skip?(event, now)
+
+          case event.type
+          when 'IssuesEvent', 'IssueCommentEvent'
+            issue = event.payload.issue
+            result[issue.html_url] ||= hash_for_issue(event.repo, issue)
+          when 'PullRequestEvent', 'PullRequestReviewCommentEvent'
+            pr = event.payload.pull_request
+            result[pr.html_url] ||= hash_for_pr(event.repo, pr)
+          end
+        end
+
+        result
+      end
+
+      def skip?(event, now)
+        if options[:all]
+          false
+        else
+          event.created_at.getlocal.to_date != now.to_date
+        end
+      end
+
+      def client
+        @client ||= Octokit::Client.new(login: user, access_token: access_token)
+      end
+
+      def user
+        @user ||=
+          case
+          when ENV['GITHUB_NIPPOU_USER']
+            ENV['GITHUB_NIPPOU_USER']
+          when !`git config github-nippou.user`.chomp.empty?
+            `git config github-nippou.user`.chomp
+          else
+            puts <<MESSAGE
+** User required.
+
+Please set github-nippou.user to your .gitconfig.
+    $ git config --global github-nippou.user [Your GitHub account]
+MESSAGE
+            exit!
+          end
+      end
+
+      def access_token
+        @access_token ||=
+          case
+          when ENV['GITHUB_NIPPOU_ACCESS_TOKEN']
+            ENV['GITHUB_NIPPOU_ACCESS_TOKEN']
+          when !`git config github-nippou.token`.chomp.empty?
+            `git config github-nippou.token`.chomp
+          else
+            puts <<MESSAGE
+** Authorization required.
+
+Please set github-nippou.token to your .gitconfig.
+    $ git config --global github-nippou.token [Your GitHub access token]
+
+To get new token, visit
+https://github.com/settings/tokens/new
+MESSAGE
+            exit!
+          end
+      end
+
+      def hash_for_issue(repo, issue)
+        title = issue.title.markdown_escape
+        merged = client.pull_merged?(repo.name, issue.number)
+        {title: title, repo_basename: repo.name, username: issue.user.login, merged: merged}
+      end
+
+      def hash_for_pr(repo, pr)
+        title = pr.title.markdown_escape
+        merged = client.pull_merged?(repo.name, pr.number)
+        {title: title, repo_basename: repo.name, username: pr.user.login, merged: merged}
+      end
+    end
+  end
+end

data/lib/github/nippou/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Nippou
-    VERSION = '1.0.2'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: github-nippou
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-10 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: |2
       This is a helpful tool when you write a daily report in reference to
       GitHub. nippou is a japanese word which means a daily report.
@@ -71,6 +85,7 @@ files:
 - bin/github-nippou
 - github-nippou.gemspec
 - lib/github/nippou.rb
+- lib/github/nippou/commands.rb
 - lib/github/nippou/version.rb
 homepage: https://github.com/masutaka/github-nippou
 licenses:
@@ -92,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Print today's your GitHub action.