bu_pr 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d6a26d015d99b0818e94691d0c9ac8f4ec3e024
-  data.tar.gz: 42188f7945e7571011501e85fd78fc597211c5f2
+  metadata.gz: 151da8efbdea7d8e1f213c389aec5638ada216fb
+  data.tar.gz: 8ed0c5664508e90b7eeafa3f2d6830c45d6c8f17
 SHA512:
-  metadata.gz: ff2ac1be3f65db5a20da3a878686ee416b45a435bf4a66db2bdd48e08582d51a92f43c82a82bfcaa4af6261ef54b1497abea2ddcf36b7ee2cdd2bbb53693e074
-  data.tar.gz: 6c28f0f2a9bc0fcf6849c047bb00a072a3a89f85b139c0802ae4764e384de79a8cc284c06c612cf31c90078d19f3aeb0ef132772272a6b77033fb18d63b13bc7
+  metadata.gz: 57c0c8693900ff6b9ddb68eac293fd47d9927d02f758a8246b8922e0706f01407c672fd656d98740e21ba91ffe62f0dd7571a8ec67a8870cb99230f4c38c11d5
+  data.tar.gz: 253564184b645a6f4cbdffbc1387275794bea5f788ffe438259368e78e8cf178a429a1aebd9c2bf98a9692255a4f801b4d4a1cda997e8ec0406943d138d2db6f

data/README.md

@@ -22,67 +22,33 @@ Or install it yourself as:
 
 ## Usage
 
-Get Github access token from [this page](https://github.com/settings/tokens/new) with `repo` scope.
+Get GitHub access token from [this page](https://github.com/settings/tokens/new) with `repo` scope.
 
+then run
 
-### Set configuration values as Environment variables.
+```sh
+$ bundle exec bu_pr --repo=mmyoji/bu_pr --token=<the token you got above>
+```
+
+or you can just set `repo` and `token` values in your `$HOME/.profile` file.
 
 ```sh
 # .bash_profile / .profile / .zshrc / etc.
 
 export BUPR_TOKEN="xxx"
 export BUPR_REPO="mmyoji/bu_pr"
+
+# If you wanna override them:
 # export BUPR_BRANCH="develop"
 # export BUPR_TITLE="My bundle update"
 ```
 
+### Available options
 
-### Set configuration values in config file.
-
-```rb
-require 'bu_pr'
-
-# Setup
-BuPr.configure do |config|
-  config.token  = "xxx"              # Required
-  config.repo   = "mmyoji/bu_pr"     # Required
-
-  config.branch = "develop"          # Optional :: default is 'master'
-  config.title  = "My bundle update" # Optional :: default is like 'Bundle update 2016-11-13'
-end
-
-BuPr::Runner.call
-```
-
-### Rails
-
-```rb
-# config/initializers/bu_pr.rb
-
-BuPr.configure do |config|
-  config.token = "xxx"
-  config.repo  = "mmyoji/bu_pr"
-end
-```
-
-then run the following commands
-
-```sh
-# Run all tasks
-$ bin/rake bu_pr:all
-
-# If you want to execute each task,
-
-# Run `bundle update` only
-$ bin/rake bu_pr:bu
-
-# Create pull-request
-$ bin/rake bu_pr:pr
-
-# Add gem diff comment
-$ bin/rake bu_pr:diff
-```
-
+* branch: base branch name for the pull-request. Default is `master`
+* repo: your github repository name
+* title: the pull-request title. Default is `Bundle update 2017-04-04`
+* token: your GitHub access token
 
 ## Contributing
 

data/bu_pr.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "compare_linker", "~> 1.1.0"
+  spec.add_dependency "thor", "~> 0.19"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/exe/bu_pr

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "bundler/setup"
+require "bu_pr"
+
+BuPr::Command.start(ARGV)

data/lib/bu_pr/command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require "thor"
+
+module BuPr
+  class Command < ::Thor
+    default_command :all
+
+    desc "all", "Run bundle update and create pull-request"
+    method_options(
+      branch: :string,
+      title:  :string,
+      token:  :string,
+      repo:   :string,
+    )
+    def all
+      Runner.call(options)
+    end
+  end
+end

data/lib/bu_pr/configuration.rb

@@ -1,55 +1,48 @@
 # frozen_string_literal: true
-require 'singleton'
-
 module BuPr
   class Configuration
-    include Singleton
-
-    attr_accessor(
-      :branch,
-      :title,
-      :token,
-      :repo,
+    ATTRS = %i(
+      branch
+      title
+      token
+      repo
     )
 
-    # DEPRECATED
-    alias access_token token
-    alias access_token= token=
-    alias base_branch branch
-    alias base_branch= branch=
-    alias pr_title title
-    alias pr_title= title=
-    alias repo_name repo
-    alias repo_name= repo=
+    # @return [String]
+    attr_accessor(*ATTRS)
 
-    def initialize
-      @branch = ENV.fetch("BUPR_BRANCH") { "master" }
-      @title  = ENV.fetch("BUPR_TITLE")  { "Bundle update #{Time.now.strftime('%F')}" }
+    # @param opts [Hash]
+    # @option opts [String] :branch Base branch name
+    # @option opts [String] :title pull-request title
+    # @option opts [String] :token GitHub access token
+    # @option opts [String] :repo GitHub repository name
+    def initialize opts = {}
+      @branch = opts.fetch(:branch) { ENV.fetch("BUPR_BRANCH") { "master" } }
+      @title  = opts.fetch(:title)  { ENV.fetch("BUPR_TITLE")  { default_title } }
 
-      @token  = ENV["BUPR_TOKEN"]
-      @repo   = ENV["BUPR_REPO"]
+      @token  = opts.fetch(:token) { ENV["BUPR_TOKEN"] }
+      @repo   = opts.fetch(:repo)  { ENV["BUPR_REPO"] }
     end
 
+    # @return [Boolean]
     def valid?
       token? && branch? && title? && repo?
     end
 
     private
 
-    def token?
-      token && token != ""
-    end
-
-    def branch?
-      branch && branch != ""
-    end
-
-    def title?
-      title && title != ""
+    ATTRS.each do |attr|
+      # @private
+      define_method "#{attr}?" do
+        v = public_send(attr)
+        !v.nil? && v != ""
+      end
     end
 
-    def repo?
-      repo && repo != ""
+    # @private
+    # @return [String]
+    def default_title
+      "Bundle update #{Time.now.strftime('%F')}"
     end
   end
 end

data/lib/bu_pr/git.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-
 module BuPr
   class Git
     LOCKFILE = "Gemfile.lock"
 
+    # @return [String]
     def current_branch
       @current_branch ||=
         begin
@@ -16,10 +16,12 @@ module BuPr
         end
     end
 
+    # @return [Boolean]
     def diff?
       `git status`.include?(LOCKFILE)
     end
 
+    # @return [Boolean]
     def installed?
       system("git --help > /dev/null 2>&1")
     end
@@ -30,18 +32,22 @@ module BuPr
 
     private
 
+    # @private
     def add
       `git add #{LOCKFILE}`
     end
 
+    # @private
     def branches
       `git branch`.strip
     end
 
+    # @private
     def commit
       `git commit -m "bundle update"`
     end
 
+    # @private
     def _push
       `git push origin #{current_branch}`
     end

data/lib/bu_pr/handlers/github.rb

@@ -1,18 +1,29 @@
 # frozen_string_literal: true
-
 require "octokit"
 require "compare_linker"
 
 module BuPr
   module Handlers
     class Github
+      # @return [String] base branch name
       attr_reader :base
+
+      # @return [String]
       attr_reader :current_branch
+
+      # @return [String]
       attr_reader :repo
+
+      # @return [String]
       attr_reader :title
+
+      # @return [String]
       attr_reader :token
+
+      # @return [CompareLinker]
       attr_reader :linker
 
+      # @param attrs [Hash]
       def initialize attrs = {}
         config          = attrs[:config]
 
@@ -29,6 +40,7 @@ module BuPr
         diff_comment(number)
       end
 
+      # @return [Integer] pull-request ID
       def create_pull_request
         res = client.create_pull_request \
           repo,
@@ -46,16 +58,22 @@ module BuPr
 
       private
 
+      # @private
+      # @return [Octokit::Client]
       def client
         @client ||= ::Octokit::Client.new(
           access_token: token,
         )
       end
 
+      # @private
+      # @return [String]
       def comment_content
         "#{linker.make_compare_links.to_a.join("\n")}"
       end
 
+      # @private
+      # @return [CompareLinker]
       def load_linker pr_number
         ENV['OCTOKIT_ACCESS_TOKEN'] = token
 

data/lib/bu_pr/runner.rb

@@ -1,29 +1,35 @@
 # frozen_string_literal: true
-
 module BuPr
   class Runner
     class << self
-      attr_writer :config
-
-      def config
-        @config ||= Configuration.instance
-      end
-
-      def call
-        new.call
+      # @param opts [Hash]
+      # @see BuPr::Configuration#initialize
+      def call opts = {}
+        new(opts).call
       end
     end
 
+    # @private
+    # @return [BuPr::Git]
     attr_reader :git
 
-    def initialize
-      @git = Git.new
+    # @private
+    # @return [BuPr::Configuration]
+    attr_reader :config
+
+    # @private
+    # @param opts [Hash]
+    # @see BuPr::Configuration#initialize
+    def initialize opts = {}
+      @git    = Git.new
+      @config = Configuration.new(opts)
     end
 
+    # @private
     def call
       if bundle_update && !git.diff?
         puts "no update"
-        exit
+        return
       end
 
       git.push
@@ -32,14 +38,14 @@ module BuPr
       handler.call
     end
 
+    # @private
+    # @return [Boolean]
     def bundle_update
       valid? && _bundle_update
     end
 
-    def config
-      self.class.config
-    end
-
+    # @private
+    # @return [Boolean]
     def valid?
       unless config.valid?
         raise "Invalid configuration"
@@ -54,6 +60,9 @@ module BuPr
 
     private
 
+    # @private
+    # @return [Boolean]
+    # @raise RuntimeError
     def _bundle_update
       return true if system("bundle update")
 

data/lib/bu_pr/version.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module BuPr
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/bu_pr.rb

@@ -4,14 +4,4 @@ require "bu_pr/configuration"
 require "bu_pr/git"
 require "bu_pr/handlers/github"
 require "bu_pr/runner"
-require "bu_pr/railtie" if defined?(Rails::Railtie)
-
-module BuPr
-  def configure
-    conf = Configuration.instance
-    yield conf
-
-    Runner.config = conf
-  end
-  module_function :configure
-end
+require "bu_pr/command"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bu_pr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Masaya Myojin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compare_linker
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +83,8 @@ dependencies:
 description: BuPr is simple pull request creator for the daily bundle update.
 email:
 - m.myojin0425@gmail.com
-executables: []
+executables:
+- bu_pr
 extensions: []
 extra_rdoc_files: []
 files:
@@ -84,13 +99,13 @@ files:
 - bin/console
 - bin/setup
 - bu_pr.gemspec
+- exe/bu_pr
 - lib/bu_pr.rb
+- lib/bu_pr/command.rb
 - lib/bu_pr/configuration.rb
 - lib/bu_pr/git.rb
 - lib/bu_pr/handlers/github.rb
-- lib/bu_pr/railtie.rb
 - lib/bu_pr/runner.rb
-- lib/bu_pr/tasks/bu_pr.rake
 - lib/bu_pr/version.rb
 homepage: https://github.com/mmyoji/bu_pr
 licenses:
@@ -112,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple bundle update p-r creator

data/lib/bu_pr/railtie.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module BuPr
-  class Railtie < ::Rails::Railtie
-    rake_tasks do
-      load "bu_pr/tasks/bu_pr.rake"
-    end
-  end
-end

data/lib/bu_pr/tasks/bu_pr.rake

@@ -1,45 +0,0 @@
-namespace :bu_pr do
-  desc "Run `bundle update`"
-  task bu: :environment do
-    puts "Running `bundle update`..."
-
-    BuPr::Runner.new.bundle_update
-
-    puts "Finished `bundle update`"
-  end
-
-  desc "Create pull-request"
-  task pr: :environment do
-    puts "Creating pull-request..."
-
-    r       = BuPr::Runner.new
-    handler = BuPr::Handlers::Github.new \
-      config:         r.config,
-      current_branch: r.git.current_branch
-
-    pr_number = handler.create_pull_request
-
-    puts "Finished: p-r number is `#{pr_number}`"
-  end
-
-  desc "Add gem diff comment"
-  task diff: :environment do
-    pr_number = ENV.fetch("PR_NUMBER")
-
-    puts "Commenting..."
-
-    r       = BuPr::Runner.new
-    handler = BuPr::Handlers::Github.new \
-      config:         r.config,
-      current_branch: r.git.current_branch
-
-    handler.diff_comment(pr_number)
-
-    puts "Finished!"
-  end
-
-  desc "Run bu_pr all tasks"
-  task all: :environment do
-    BuPr::Runner.call
-  end
-end