github-nippou 2.1.0.beta1 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ef358687064ffbca6c80ab96136c0a81c36e154
-  data.tar.gz: adddcb9ff77d0afddfa4da8c177d10e0f8cb7bab
+  metadata.gz: bfc8acb06e7f4d5971323ca515e9c6395e2f0e15
+  data.tar.gz: f17aca19e5918f47a96447e184ced1d51a8166de
 SHA512:
-  metadata.gz: 1ff50591fd5d01d3c6ca25fcc5818e6ece3576f907ab92e671f8a96294840cfa1bab5f9ed6a562532ee6c803dec0c2af1134710febc1514aa4e68aa2950a73ed
-  data.tar.gz: b5461b0c1b574930aa9b3add56abd818292a38f55a7def443c96fe8483f47db9595bfc0fd04a20191bc15a05f49a083e8de6ceb7bc1c25d497767042f78d3c53
+  metadata.gz: d5598fbc8daf144ef77bc82ff48812d1f219dbd61491d987817b23ab470ca55caebf2596eb038873ad026eca4866c64aacc212771c05dbda30e2aba63fe717db
+  data.tar.gz: 4ec3ecf571db54972a3f768d2278778aa560d3e3697f6957b066a1a77a0892d525783b191c3561b99387dc0b8ed88d876c0c5c1d818e812630fefd8e07ccaad9

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github-nippou (2.1.0.beta1)
+    github-nippou (3.0.0.beta1)
       activesupport
       octokit
       parallel
@@ -17,6 +17,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     concurrent-ruby (1.0.2)
+    diff-lcs (1.3)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     i18n (0.7.0)
@@ -26,6 +27,19 @@ GEM
       sawyer (~> 0.7.0, >= 0.5.3)
     parallel (1.9.0)
     rake (11.2.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     sawyer (0.7.0)
       addressable (>= 2.3.5, < 2.5)
       faraday (~> 0.8, < 0.10)
@@ -41,6 +55,7 @@ DEPENDENCIES
   bundler
   github-nippou!
   rake
+  rspec
 
 BUNDLED WITH
-   1.12.5
+   1.15.3

data/README.md

@@ -65,5 +65,11 @@ You can omit the sub command `list`.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## External article
+
+In Japanese
+
+[github-nippou - GitHubから日報を作成 MOONGIFT](http://www.moongift.jp/2016/06/github-nippou-github%E3%81%8B%E3%82%89%E6%97%A5%E5%A0%B1%E3%82%92%E4%BD%9C%E6%88%90/)
+
 [gem-badge]: https://badge.fury.io/rb/github-nippou.svg
 [gem-link]: http://badge.fury.io/rb/github-nippou

data/config/settings.yml

@@ -0,0 +1,7 @@
+format:
+  subject: '### %{subject}'
+  line: '* [%{title}](%{url}) by %{user} %{status}'
+dictionary:
+  status:
+    merged: '**merged!**'
+    closed: '**closed!**'

data/github-nippou.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/github/nippou/commands.rb

@@ -1,5 +1,6 @@
 require 'parallel'
 require 'thor'
+require 'yaml'
 
 module Github
   module Nippou
@@ -16,8 +17,8 @@ module Github
       desc 'list', "Displays today's GitHub events formatted for Nippou"
       def list
         lines = []
-        mutex = Mutex::new
-        format = Format.new(client, thread_num, debug)
+        mutex = Mutex.new
+        format = Format.new(client, thread_num, settings, debug)
 
         Parallel.each_with_index(user_events, in_threads: thread_num) do |user_event, i|
           # Contain GitHub access.
@@ -29,6 +30,41 @@ module Github
         puts format.all(lines)
       end
 
+      desc 'init', 'Synchronize github-nippou settings on your gist'
+      def init
+        unless client.scopes.include? 'gist'
+          puts <<~MESSAGE
+            ** Gist scope required.
+
+            You need personal access token which has gist scope.
+            Please add gist scope on your personal access token if you use this command.
+          MESSAGE
+          exit!
+        end
+        unless `git config github-nippou.settings-gist-id`.chomp.empty?
+          puts <<~MESSAGE
+            ** Already initialized.
+
+            It already have gist id that github-nippou.settings-gist-id on your .gitconfig.
+          MESSAGE
+          exit!
+        end
+
+        result = client.create_gist(
+          description: 'github-nippou settings',
+          public: true,
+          files: { 'settings.yml' => { content: settings.to_yaml }}
+        ).to_h
+        `git config --global github-nippou.settings-gist-id #{result[:id]}`
+
+        puts <<~MESSAGE
+          The github-nippou settings was created on following url: #{result[:html_url]}
+          And the gist id was set your .gitconfig
+          You can check the gist id with following command
+              $ git config --global github-nippou.settings-gist-id
+        MESSAGE
+      end
+
       desc 'version', 'Displays version'
       def version
         puts VERSION
@@ -54,12 +90,12 @@ module Github
           when !`git config github-nippou.user`.chomp.empty?
             `git config github-nippou.user`.chomp
           else
-            puts <<MESSAGE
-** User required.
+            puts <<~MESSAGE
+              ** User required.
 
-Please set github-nippou.user to your .gitconfig.
-    $ git config --global github-nippou.user [Your GitHub account]
-MESSAGE
+              Please set github-nippou.user to your .gitconfig.
+                  $ git config --global github-nippou.user [Your GitHub account]
+            MESSAGE
             exit!
           end
       end
@@ -72,19 +108,50 @@ MESSAGE
           when !`git config github-nippou.token`.chomp.empty?
             `git config github-nippou.token`.chomp
           else
-            puts <<MESSAGE
-** Authorization required.
+            puts <<~MESSAGE
+              ** Authorization required.
 
-Please set github-nippou.token to your .gitconfig.
-    $ git config --global github-nippou.token [Your GitHub access token]
+              Please set github-nippou.token to your .gitconfig.
+                  $ git config --global github-nippou.token [Your GitHub access token]
 
-To get new token with `repo` scope, visit
-https://github.com/settings/tokens/new
-MESSAGE
+              To get new token with `repo` scope, visit
+              https://github.com/settings/tokens/new
+            MESSAGE
             exit!
           end
       end
 
+      def settings
+        return @settings if @settings.present?
+
+        yaml_data =
+          case
+          when ENV['GITHUB_NIPPOU_SETTINGS']
+            ENV['GITHUB_NIPPOU_SETTINGS'].chomp
+          when !`git config github-nippou.settings`.chomp.empty?
+            `git config github-nippou.settings`.chomp
+          when !`git config github-nippou.settings-gist-id`.chomp.empty?
+            gist_id = `git config github-nippou.settings-gist-id`.chomp
+            gist = client.gist(gist_id)
+            gist[:files][:'settings.yml'][:content]
+          end
+
+        @settings =
+          if yaml_data
+            YAML.load(yaml_data).deep_symbolize_keys
+          else
+            YAML.load_file(File.expand_path('../../../config/settings.yml', __dir__)).deep_symbolize_keys
+          end
+      rescue Psych::SyntaxError => e
+        puts <<~MESSAGE
+          ** YAML syntax error.
+
+          #{e.message}
+          #{yaml_data}
+        MESSAGE
+        exit
+      end
+
       def thread_num
         @thread_num ||=
           case

data/lib/github/nippou/format.rb

@@ -4,9 +4,12 @@ module Github
       using SawyerResourceGithub
       using StringMarkdown
 
-      def initialize(client, thread_num, debug)
+      attr_reader :settings
+
+      def initialize(client, thread_num, settings, debug)
         @client = client
         @thread_num = thread_num
+        @settings = settings
         @debug = debug
       end
 
@@ -34,18 +37,17 @@ module Github
       def all(lines)
         result = ""
         prev_repo_name = nil
-        curr_repo_name = nil
+        current_repo_name = nil
 
         sort(lines).each do |line|
           current_repo_name = line[:repo_name]
 
           unless current_repo_name == prev_repo_name
             prev_repo_name = current_repo_name
-            result << "\n### #{current_repo_name}\n\n"
+            result << "\n#{format_subject(current_repo_name)}\n\n"
           end
 
-          result << "* [%s](%s) by %s%s\n" %
-            [line[:title].markdown_escape, line[:url], line[:user], format_status(line[:status])]
+          result << "#{format_line(line)}\n"
         end
 
         result
@@ -70,14 +72,21 @@ module Github
       end
 
       def format_status(status)
-        case status
-        when :merged
-          ' **merged!**'
-        when :closed
-          ' **closed!**'
-        else
-          ''
-        end
+        settings[:dictionary][:status][status]
+      end
+
+      def format_subject(subject)
+        sprintf(settings[:format][:subject], subject: subject)
+      end
+
+      def format_line(line)
+        sprintf(
+          settings[:format][:line],
+          title: line[:title].markdown_escape,
+          url: line[:url],
+          user: line[:user],
+          status: format_status(line[:status])
+        ).strip
       end
     end
   end

data/lib/github/nippou/version.rb

@@ -1,5 +1,5 @@
 module Github
   module Nippou
-    VERSION = '2.1.0.beta1'
+    VERSION = '3.0.0.beta1'
   end
 end

data/spec/github/nippou/commands_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Github::Nippou::Commands do
+  let(:commands) { described_class.new }
+
+  describe '#settings' do
+    subject(:execute) { commands.send(:settings) }
+
+    let(:settings) do
+      {
+        format: {
+          subject: '### %{subject}',
+          line: '* [%{title}](%{url}) by %{user} %{status}',
+        },
+      }
+    end
+
+    let(:yaml) { settings.to_yaml }
+
+    context "when ENV['GITHUB_NIPPOU_SETTINGS'] present" do
+      before { ENV['GITHUB_NIPPOU_SETTINGS'] = yaml }
+
+      context 'given valid YAML syntax' do
+        it 'should set YAML value to @settings' do
+          expect { execute }
+            .to change { commands.instance_variable_get(:@settings) }
+            .to settings
+        end
+      end
+
+      context 'given invalid YAML syntax' do
+        before do
+          ENV['GITHUB_NIPPOU_SETTINGS'] = <<~INVALID_YAML
+            format:
+              **!!invalid!!**
+              line: '* [%{title}](%{url}) by %{user} %{status}'
+          INVALID_YAML
+        end
+
+        it 'should output YAML syntax error message' do
+          expect {
+            begin
+              execute
+            rescue SystemExit
+              nil
+            end
+          }.to output(<<~ERROR).to_stdout
+            ** YAML syntax error.
+
+            (<unknown>): did not find expected alphabetic or numeric character while scanning an alias at line 2 column 3
+            format:
+              **!!invalid!!**
+              line: '* [%{title}](%{url}) by %{user} %{status}'
+          ERROR
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+
+require 'github/nippou'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-nippou
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta1
+  version: 3.0.0.beta1
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2017-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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.
@@ -105,12 +119,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/github-nippou
+- config/settings.yml
 - github-nippou.gemspec
 - lib/github/nippou.rb
 - lib/github/nippou/commands.rb
@@ -119,6 +135,8 @@ files:
 - lib/github/nippou/format.rb
 - lib/github/nippou/user_events.rb
 - lib/github/nippou/version.rb
+- spec/github/nippou/commands_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/masutaka/github-nippou
 licenses:
 - MIT
@@ -139,8 +157,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Print today's your GitHub action.
-test_files: []
+test_files:
+- spec/github/nippou/commands_spec.rb
+- spec/spec_helper.rb