sakanax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d166a1dab45a55ebbd464dddec5f4aac26d89236
+  data.tar.gz: 52648fc73bad16199fc63cbbb71b8c243444f017
+SHA512:
+  metadata.gz: a01d8aa57f2464cf68b6a8bd31586ef1595603bdf83b28190173cf8d35fa536b15dce39e97657fb9f69b60a353ccf0961b20f59a19e0792659cd73e213b77a0b
+  data.tar.gz: 9d98dccef5ee793fc383667173d98b9397038b9f40f917a57b414181c74550daaa7ff5ccb38d7f7e67e28cf1141abb3813c0759a7165ac46cd50577bfd808df1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/

data/.sakanax.yml

@@ -0,0 +1,4 @@
+# List of search target files
+detect_files:
+  - lib/sakanax.rb
+  - lib/sakanax/cli.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daisuke.awaji@i.softbank.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gem 'thor', '~> 0.19.1'
+gem "octokit", "~> 4.0"
+gem 'tty-spinner'
+
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sakanax.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    sakanax (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    thor (0.19.4)
+    tty-cursor (0.6.0)
+    tty-spinner (0.8.0)
+      tty-cursor (>= 0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  octokit (~> 4.0)
+  rake (~> 10.0)
+  sakanax!
+  thor (~> 0.19.1)
+  tty-spinner
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 daisuke-awaji
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+# Sakanax <img class="avatar" src="https://user-images.githubusercontent.com/20736455/48205670-effe4300-e3af-11e8-8cfd-7078f8965e1f.png" width="44" height="44">
+
+Sakanax is a CLI tool for identifying files that are up in Github PullRequest. For example, specifying a commit ID specifies a PullRequest including the commit ID, and also acquires a list of files included in the PullRequest.
+
+
+## Usage
+
+First, Specify Github's access token and repository name as an environment variable and put .sakanax.yml in your project root directory.
+
+##### Github token / repository
+
+```bash
+$ export GITHUB_TOKEN=<personal access token>
+$ export GITHUB_REPOSITORY=<your repository name>
+```
+
+##### .sakanax.yml
+
+```yaml
+detect_files:
+  - "src/main/file.rb"
+  - "lib/etc.rb"
+  - ....
+```
+
+### help
+
+```bash
+$ sakanax help
+Commands:
+  sakanax diff_files --sha=SHA     # Detect files included in the PullRequests containing the target commit ID (sha).
+  sakanax help [COMMAND]           # Describe available commands or one specific command
+  sakanax pull_requests --sha=SHA  # A list of PullRequests containing the target commit ID (sha).
+```
+
+### pull_requests
+A list of PullRequests containing the target commit ID (sha).
+```bash
+$ sakanax pull_requests --sha 536ad1c5c6e5a675122eb0fdcb4ac5da06def098
+[3, 2, 1]
+```
+
+### diff_files
+Detect files included in the PullRequests containing the target commit ID (sha).
+```bash
+$ sakanax diff_files --sha c5c6e5a6756def0986ad1122eb0a0fdcb4ac5d53
+"PullRequest: 32, diff files: ['diff file1', 'diff file2', ...]"
+```  
+
+### detect_file
+Put .sakanax.yml in your project root directory. Detect file in .sakanax.yml.
+
+```bash
+$ sakanax detect_file --sha aed28c5aa60398fda946878978168890b0x0007a
+"[INFO] detected [[\"lib/sakanax/cli.rb\"]]"
+
+$ sakanax detect_file --sha 17ff60e38f98aed28c5aa60398fda94687897816
+"[INFO] target commit ID (sha: 17ff60e38f98aed28c5aa60398fda94687897816) does not exist in the currently open PullRequests."
+"[INFO] Anything detcted.
+```
+
+### Actual Usage
+Based on the result of sakanax detect_files command, it judges whether to test the target file.
+
+```bash
+#!/bin/bash
+
+RESULT=$(sakanax detect_files --sha <COMMIT ID> --config .sakanax.yml)
+
+if [ "${RESULT}" == false ]; then
+  echo "Could not find the file contained in .sakanax.yml."
+else
+  echo "Test the detected file"
+  # ...
+  # ...
+fi
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sakanax'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sakanax
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sakanax. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sakanax project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sakanax/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sakanax"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path vendor/bundle
+
+# Do any other automated setup that you need to do here

data/exe/sakanax

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "sakanax"
+
+Sakanax::CLI.start

data/lib/sakanax/cli.rb

@@ -0,0 +1,58 @@
+require 'sakanax'
+require 'thor'
+require 'octokit'
+require 'tty-spinner'
+require_relative 'github'
+
+module Sakanax
+  # CLI Class
+  class CLI < Thor
+    class_option :help, type: :boolean, aliases: '-h', desc: 'help message.'
+    class_option 'config', type: :string, required: false
+
+    def initialize(*args)
+      super
+      config = File.join(Dir.pwd, '.sakanax.yml') if config.nil?
+      @github = Github.new(config)
+      @sha = options['sha']
+      spinner = TTY::Spinner.new(':spinner ', format: :dots_2)
+      spinner.auto_spin
+    end
+
+    desc 'version', 'version'
+    def version
+      puts "sakanax #{Sakanax::VERSION}"
+    end
+
+    option 'sha', type: :string, required: true
+    desc 'pull_requests', \
+         'A list of PullRequests containing the target commit ID (sha).'
+    def pull_requests
+      puts @github.get_pr_including_target_commit(options['sha'])
+    end
+
+    option 'sha', type: :string, required: true
+    desc 'diff_files', \
+         'Detect files included in the PullRequests ' \
+         'containing the target commit ID (sha).'
+    def diff_files
+      pull_requests = @github.get_pr_including_target_commit(@sha)
+      pull_requests.each do |pr|
+        puts "PR: #{pr}, Diff files: #{@github.get_files_with_changes(pr)}"
+      end
+    end
+
+    desc 'detect_files', \
+         'It judges whether there is a file to be searched in PullRequest. '
+    long_desc <<-LONGDESC
+      If the file exists, it will return the list of the specified file.
+
+      If the file can not be found, false is returned.
+    LONGDESC
+    option 'sha', type: :string, required: true
+    def detect_files
+      detect_files = @github.detect_files(@sha)
+      puts detect_files.empty? ? false : "Detected files: #{detect_files}"
+    end
+  end
+end

data/lib/sakanax/github.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+
+# Github
+class Github
+  def initialize(config)
+    @client = Octokit::Client.new(access_token: ENV['GITHUB_TOKEN'])
+    @repository = ENV['GITHUB_REPOSITORY']
+    @yaml = load_config(config)
+  end
+
+  # Get a list of PullRequests including commit ID (sha) as an array
+  def get_pr_including_target_commit(sha)
+    pr_including_target_commit = []
+    fetch_opened_pull_requests.each do |pr|
+      @client.pull_request_commits(@repository, pr).each do |commit|
+        pr_including_target_commit.push(pr) if sha == commit[:sha]
+      end
+    end
+    puts "[INFO] Target sha: #{sha} is not exist in open PullRequests" \
+          if pr_including_target_commit.empty?
+    pr_including_target_commit
+  end
+
+  # Extract the changed file from the number of PR to be tested
+  def get_files_with_changes(pull_request)
+    files = []
+    @client.pull_request_files(@repository, pull_request).each do |file|
+      files.push(file[:filename])
+    end
+    puts '[INFO] No file changed in the specified PullRequest' if files.empty?
+    files
+  end
+
+  # Checks whether the file to be searched exists
+  # in the pull request including the specified commit ID.
+  def detect_files(sha)
+    duplicated_files = []
+    get_pr_including_target_commit(sha).each do |pr|
+      duplicated_files.push(get_files_with_changes(pr) & @yaml['detect_files'])
+      duplicated_files.flatten!
+    end
+    duplicated_files
+  end
+
+  private
+
+  def load_config(config)
+    return YAML.load_file(config) if File.exist?(config)
+
+    puts "[INFO] Config file #{config} does not exist"
+    exit 0
+  end
+
+  # Get a list of open state PullRequests as an array
+  def fetch_opened_pull_requests
+    opened_pull_requests = []
+    @client.pull_requests(@repository).each do |pr|
+      opened_pull_requests.push(pr[:number])
+    end
+    opened_pull_requests
+  end
+end

data/lib/sakanax/version.rb

@@ -0,0 +1,3 @@
+module Sakanax
+  VERSION = '0.1.0'
+end

data/lib/sakanax.rb

@@ -0,0 +1,6 @@
+require 'sakanax/version'
+require 'sakanax/cli'
+
+module Sakanax
+  # Your code goes here...
+end

data/sakanax.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sakanax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sakanax'
+  spec.version       = Sakanax::VERSION
+  spec.authors       = ['daisuke-awaji']
+  spec.email         = ['gee.awa@gmail.com']
+
+  spec.summary       = 'Sakanax is simple cli tool to detect github pull request files.'
+  spec.description   = 'Sakanax is a CLI tool for identifying files that are up in Github PullRequest. For example, specifying a commit ID specifies a PullRequest including the commit ID, and also acquires a list of files included in the PullRequest.'
+  spec.homepage      = 'https://github.com/sakanax/sakanax'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sakanax
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- daisuke-awaji
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sakanax is a CLI tool for identifying files that are up in Github PullRequest.
+  For example, specifying a commit ID specifies a PullRequest including the commit
+  ID, and also acquires a list of files included in the PullRequest.
+email:
+- gee.awa@gmail.com
+executables:
+- sakanax
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".sakanax.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sakanax
+- lib/sakanax.rb
+- lib/sakanax/cli.rb
+- lib/sakanax/github.rb
+- lib/sakanax/version.rb
+- sakanax.gemspec
+homepage: https://github.com/sakanax/sakanax
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Sakanax is simple cli tool to detect github pull request files.
+test_files: []