intello-shipit-cli 0.6.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44dd9830edd5ed4fc56bb507e655a2a29a3e63d8d494b379f6f2008cf204f2a0
+  data.tar.gz: 19ffcde87be2aaa98b6dc51f448b360b945a818494c64058b34dc9dd5ef386e2
+SHA512:
+  metadata.gz: 271391edd56d02cd68a9081c24f8f328dcd793c89c9e1444ff971958b6c78dd96eac678361a5c6b2f20b33bec27b637f02f6a2a1f16e03e955963a800594b167
+  data.tar.gz: c573f7fc35fc001271316163e5704fb01262802d682b3c7156d14b5fbebcc3cf2ee394748eacd485bc8124a58dba914dc3d5e35c99590c8ece81253454cf9c41

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+gems.tags
+tags

data/.rbenv-vars

@@ -0,0 +1,2 @@
+SHIPIT_TOKEN=e9dcf63ac25554df23fb27b8a1e3c2f43495b8a4cda1f7842ffdf05bf20d4b98c20cbf5195f5744ad0ca856b8d1f2a7ead6c214794ff9cd59f4e3e60e45910ec
+GEMFURY_TOKEN=wQUZrGXsyxMh5KMQx3W4

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .ruby-style.yml

data/.ruby-style.yml

@@ -0,0 +1,249 @@
+AllCops:
+  Exclude:
+    - "bin/**/*"
+    - "config/environments/**/*"
+    - "config/initializers/**/*"
+    - "db/migrate/**/*"
+    - "db/schema.rb"
+    - "lib/tasks/**/*"
+    - "vendor/**/*"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 100
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingComma:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/LineLength:
+  Description: Limit lines to 120 characters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#80-character-limits
+  Enabled: true
+  Max: 120
+  AllowURI: true
+  URISchemes:
+  - http
+  - https
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false
+Style/GlobalVars:
+  AllowedVariables: [ "$redis" ]

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shipit-cli.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,27 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard "ctags-bundler", src_path: ["lib", "spec/support"] do
+  watch(%r{(lib|spec\/support)\/.*\.rb$/})
+  watch("Gemfile.lock")
+end
+
+guard :rubocop do
+  watch(%r{exe/*})
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright Intello Technologies Inc, 2016-2019.
+
+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,154 @@
+# intello-shipit-cli
+
+## Description
+
+Shipit CLI is a gem created by Intello's development team.
+
+Designed to simplify collaboration with Git and Gitlab, its main purpose is to kickstart working on an issue. Here's what it does :
+
+1. Create a new branch (local & remote) using a standardized name.
+2. Add & push a first empty commit to that branch.
+3. Create a new merge request on Gitlab, with all the issue details.
+
+## Requirements
+
+- Ruby 2.5+
+- RubyGems 1.9+
+- A `gitlab` personal access token (`https://{{ YOUR_GITLAB_HOST  }}/profile/personal_access_tokens`)
+- Issues must have a label and a milestone
+
+`intello-shipit-cli` works as well on gitlab.com as on a privately hosted instance of Gitlab
+
+## Install/Update
+
+```bash
+gem install intello-shipit-cli
+```
+
+> NOTE: If you use a ruby manager, the gem has to be installed each time you want to use it in a new ruby context.
+
+### PROTIP
+
+If you use rbenv as your ruby manager, and want to easily install/update `intello-shipit-cli` across all your rubies:
+
+1. Install [rbenv-each](https://github.com/rbenv/rbenv-each)
+1. Run `rbenv each gem install intello-shipit-cli`
+
+## Setup
+
+You must first setup `intello-shipit-cli` by running:
+
+```bash
+shipit setup
+```
+
+This will interactivly ask you for:
+
+- Your Gitlab server instance API endpoint. If your using gitlab.com this endpoint is `https://gitlab.com/api/v4`
+- Your Gitlab personal API token
+
+The setup will create a file in your user root folder called `.shipit.yml` with this information.
+
+### PROTIP
+
+If you have multiple Gitlab servers or account you can manually create configuration YAML files and use the `-c` option of `intello-shipit-cli` to select the proper configuration.
+
+For example you can have a configuration file ` ~/.shipit_personal.yml` for your peronal account an to use that you would invoke `intello-shipit-cli` with: `shipit -c ~/.shipit_personal.yml work 22`.
+
+### Check your configuration
+
+```bash
+$ shipit settings
+```
+
+### Usage
+
+The most often used command is `work` this is the command that will create a branch and merge request based on a ticket in the project you are currently working.
+
+Let's take an example. We have the project 'test_shipit' already checked-out and we have issue #1 (Major bug with UI) that we want to start working on.
+
+Without `intello-shipit-cli` you would either go in the Gitlab Web UI and create a branch and then open a merge request on that branch or do the same with a bunch of git CLI commands. The resulting merge request and branch names would vary from one developer to the other and would be a pain to do things like changelogs later on.
+
+With `intello-shipit-cli` you simply run `shipit work 1` and it will do it all for you:
+
+```
+{21:40}[2.5.0]~/Documents/Intello/source/test_shipit:master ✓ ➭ shipit -c work 1
+remote:
+remote: To create a merge request for bug-ac-1-major-bug-with-ui, visit:
+remote:   https://gitlab.com/IndianaTux/test_shipit/merge_requests/new?merge_request%5Bsource_branch%5D=bug-ac-1-major-bug-with-ui
+remote:
+remote:
+remote: To create a merge request for bug-ac-1-major-bug-with-ui, visit:
+remote:   https://gitlab.com/IndianaTux/test_shipit/merge_requests/new?merge_request%5Bsource_branch%5D=bug-ac-1-major-bug-with-ui
+remote:
+
+****************************************
+*           IT'S HIP TO SHIP           *
+*                                      *
+*             |    |    |              *
+*            )_)  )_)  )_)             *
+*           )___))___))___)\           *
+*          )____)____)_____)\          *
+*        _____|____|____|____\__       *
+*--------\                   /---------*
+*       ^^^^^^^^^^^^^^^^^^^^^^         *
+****************************************
+{21:41}[2.5.0]~/Documents/Intello/source/test_shipit:bug-ac-1-major-bug-with-ui ✓ ➭
+```
+
+As you can see it created the branch `bug-ac-1-major-bug-with-ui` which corresponds to the issue label (first one selected if multiple are selected), the initials of the developper working on the issue and part of the issue title.
+
+It will also have created a matching merge request:
+
+![alt text](doc/mr.png)
+
+All you have to do is start coding.
+
+## Contributing
+
+- Create a ticket
+- Request developper access
+- Use `intello-shipit-cli` to start coding
+- When your ready, submit your merge request to one of the maintainers
+
+## Development Setup
+
+### Dependencies
+
+* rbenv or rvm
+* Ruby 2.5+
+* RubyGems 1.9+ (`gem update --system `)
+* Bundler 1.10+
+* [ctags](http://ctags.sourceforge.net/)
+
+### Setup
+
+To install or update your development environment, run `script/bootstrap`.
+
+### Install
+
+1. Clone the git repository.
+1. Run `script/bootstrap` to install the required gems.
+1. Run `script/test` to ensure your development setup is sane.
+1. Run `bundle exec guard`
+1. You can run a REPL: `script/console`
+1. Use the CLI: `bundle exec exe/shipit`
+
+### Testing
+
+You can write tests using `rspec v3+` syntax in the `spec` folder. To run the tests, run `script/test`.
+
+## License
+
+Copyright Intello Technologies Inc, 2016-2019. Licensed under the [MIT license](/LICENSE?raw=true).
+
+## About Intello Technologies Inc.
+
+Intello is sponsering this project as we believe in open-source and the open-source community.
+
+Intello Technologies was founded by experts from hotel & IT industry backgrounds in 2003. Based in Montreal, Canada, we're more than just a services company or a simple VAR: we develop our own in-house software which we integrate with existing industry-leading hardware and then support for years to come.
+
+Our team has in-depth knowledge of software development combined with years of sales and field management experience in the hospitality and lodging industries. Our solutions have been deployed throughout the United States, Canada, Mexico, the Caribbean and even in Africa, and our helpdesk ensures our customers are supported around the clock. Recognized as industry leaders in our fields of expertise, our company goal is to provide great solutions and support.
+
+Find out more ou our web site at <https://www.intello.com>
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/shipit

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+
+begin
+  require "gli"
+  require "json"
+  require "gitlab"
+  require "shipit/cli"
+rescue LoadError => e
+  puts "/!\\ Error while trying to load a dependency."
+  puts "    Try to run `gem update shipit-cli` to update your dependency version requirements"
+  puts "    Exception message: #{e.message}"
+  exit
+end
+
+include GLI::App
+
+program_desc "The best way to shipit with Gitlab"
+
+version Shipit::Cli::VERSION
+subcommand_option_handling :normal
+sort_help :manually
+
+# Flags
+flag [:c, :config], default_value: File.join(ENV["HOME"], ".shipit.yml"), desc: "Set the saved configuration path"
+flag [:e, :endpoint], desc: "Set the shipit API endpoint"
+flag [:p, :private_token], desc: "Set your private token to access the shipit API"
+
+# Switches
+switch :dry_run, default_value: false, desc: "Dry Run mode, no git or POST/PUT commands are run"
+
+pre do |global_options, command, _options, _args|
+  unless command.name.to_s == "setup"
+    config_file = Shipit::Cli::ConfigurationFile.new(global_options["config"])
+    if config_file.exist?
+      config_options = config_file.to_hash
+    else
+      config_options = {}
+    end
+
+    config_options.merge! global_options.delete_if { |_k, v| v.nil? || v == "" }
+    Shipit::Cli.configure(config_options)
+  end
+  true
+end
+
+desc "Shows current configuration settings"
+command :settings do |c|
+  c.action do |_global_options, _options, _args|
+    puts "---------------------"
+    Shipit::Cli.config.to_stdout
+    puts "---------------------"
+  end
+end
+
+desc "ASCII art FTW"
+command :ascii do |c|
+  c.action do |global_options, _options, args|
+    Shipit::Cli.ascii
+  end
+end
+
+desc "Start working on a ticket"
+command :work do |c|
+  c.action do |global_options, _options, args|
+    help_now!("Issue ID is required") if args.empty?
+    issue_id = args.shift.to_i
+    target_branch = Shipit::Cli::Git.get_current_branch
+    client = Gitlab.client(endpoint: Shipit::Cli.config.endpoint, private_token: Shipit::Cli.config.private_token)
+    opts = global_options.merge(client: client)
+
+    if global_options["dry_run"] == true
+      puts "*************************************************************************************"
+      puts "*** DRY RUN, no creation commands will be executed (local git or remote POST/PUT) ***"
+      puts "*************************************************************************************"
+      puts ""
+    end
+
+    Shipit::Cli::Work.new(issue_id, opts).perform(target_branch)
+  end
+end
+
+desc "Saves your shipit settings for later"
+command :setup do |c|
+  c.action do |global_options, _options, _args|
+    data = {}
+
+    puts "** What is your shipit endpoint? (Leave blank for default: https://gitlab.com/api/v4)"
+    choice = STDIN.gets.chomp
+    endpoint = choice == "" ? "https://gitlab.com/api/v4" : choice
+    data["endpoint"] = endpoint
+
+    puts "** What is your shipit private_token?"
+    choice = STDIN.gets.chomp
+    raise("You need to type a private token.") if choice == ""
+    data["private_token"] = choice
+
+    config_file = Shipit::Cli::ConfigurationFile.new(global_options["config"], data)
+    config_file.persist
+    puts ""
+    puts "* Your configuration data has been saved at #{global_options[:config]}"
+  end
+end
+
+desc "Clean up merged branches"
+command :prune do |c|
+  c.action do |global_options, _options, _args|
+    puts "************************"
+    puts "***    DEPRECATED    ***"
+    puts "************************"
+    puts "You can try to set an alias for the following commands :"
+    puts "* To prune the remote branches :"
+    puts "  $ git remote prune origin"
+    puts "* To prune the local branches :"
+    puts "  $ git fetch origin && git branch --merged master | grep -v \"\* master\" | xargs -n 1 git branch -d"
+  end
+end
+
+on_error do |exception|
+  data = {}
+  data[:class_name] = exception.class.name
+  data[:exception] = exception.message
+  data[:backtrace] = exception.message
+  puts data.inspect
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)