ninny 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff0bd65af72ed9501d51694e425da8f51dd787c71a2921a697cf6670b411e4d
-  data.tar.gz: 2e354a4951b3a7171a51b740a1c48a40ab58def31d5b1d7474a9db4d2093bb54
+  metadata.gz: e3d651b7841febd9cbba4fd31c36dcb7882b010ca193ccda73d0260e480ff76e
+  data.tar.gz: 28455776fb99b0e71d069aa1ebf27cd4fa8488723241a9a7686cc51f6ae76169
 SHA512:
-  metadata.gz: fb91d7c29d7014517d1de0378eea04978a7942aac3d954e47b1caa5183face95ce8e2c215675c81f8c2090acf56185cd9235563d23d2321fe88b6f09c1799e7a
-  data.tar.gz: 290120900419245c0049375e1f1ea83573051bcb87e3a2992a81ab9e2c9638e66da60951e0068d99b263c8ef8b461332a2b681eec021caaa5e594c57f7d0934c
+  metadata.gz: a437f827b80edb78e010deda666d4bec5ea25e5a09e5ecffdc43a44daef569038506174e37326f1da682185b119ad7c3f3e2c5707734a17a5b3f0aedb01aed18
+  data.tar.gz: 9e9d7fea9d69fe4673bcf7acac292bf4ab87a46cd685b3c1f19b02265c8c4ad65e70f3435b26fff9576618592e873fcf20395306df3989efc9bbdbbf6e9e0f4a

data/.github/pull_request_template.md

@@ -0,0 +1,47 @@
+<!--
+Your audience for this merge request description is **code reviewers**. Help them understand the technical implications involved in this change. The JIRA ticket should outline the user-facing details.
+
+Remember that Product and QA teams may have other test cases, verifications, and requirements associated with this change. Your Verification and QA plan should be directed towards Code Reviewers.
+-->
+
+## What and Why
+
+<!--
+What are you changing? Describe impact and scope. Why is this being changed? Provide some context that may help future developers understand the reasoning behind these changes. Quote and/or link to requirements, keeping in mind that JIRA links may not be available in the future.
+-->
+
+## Deploy Plan
+
+<!--
+Is there anything special about this deploy? Are migrations present? Are there other merge requests that need to be shipped before this one? Are there any manual steps required, such as data migrations, search reindexes, etc?
+-->
+
+## Rollback Plan
+
+<!--
+Is there anything special about this rollback plan? Does this merge request anything that may need to be cleaned up manually (data migrations, search reindexes, etc)? Are there other associated merge requests that would also need to be reverted?
+-->
+
+To roll back this change, revert the merge with: `git revert -m 1 MERGE_SHA` and perform another deploy.
+
+## Related URLs
+
+<!--
+Links to bug tickets, user stories, or other merge requests.
+-->
+
+## Verification and QA Plan
+
+<!--
+Fill in scenarios below in checklist format and complete them before merging. Evaluate the risk level and label this merge request or indicate risk in this description. Ensure the Verification and QA Plan matches the risk level appropriately.
+
+Consider these topics:
+* regressions (did we break something else related to this change?)
+* edge cases (weird scenarios we don't immediately think of, but could occur)
+* happy path (testing the new feature directly)
+* data model changes
+  * data elements to add or remove from indexes
+  * changes in data models requiring migrations to be performed
+-->
+
+- [ ] Example scenario

data/.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Main
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6.3, 2.6.6, 2.7.0, 2.7.2]
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 1.17.3
+        bundler-cache: true
+    - run: bundle exec rake
+  pronto:
+    if: github.EVENT_NAME == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - uses: HeRoMo/pronto-action@v1.13.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -13,3 +13,6 @@
 
 # ninny configs
 .ninny.yml*
+
+Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - vendor/**/*
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/EmptyClass:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.2

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in ninny.gemspec
 gem 'tty'

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Carl Allen
+Copyright (c) 2019 Dispatch
 
 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

data/README.md

@@ -1,12 +1,14 @@
 # Ninny
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ninny`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ninny is a command line workflow for git with GitLab. It is maintained by the engineers of Dispatch.
 
-TODO: Delete this and the text above, and describe your gem
+We use Ninny to help us automate our development pipelines. We create weekly staging branches straight from `main`, merge feature branches into the current staging branch, and deploy to our staging environment directly from the current staging branch. We date all of our staging branches with `YYYY.MM.DD` appended to the end so that if we need to recreate a new staging branch mid-week (typically if the staging branch gets very out of date from `main`), then we know exactly which branch is the latest.
+
+Ninny is based off of [SportsEngine's Octopolo](https://github.com/sportngin/octopolo) command-line tool.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use this gem with an application on GitLab, add this line to your project's Gemfile:
 
 ```ruby
 gem 'ninny'
@@ -14,30 +16,94 @@ gem 'ninny'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle install
+```
 
-Or install it yourself as:
+Then, you'll need to install the gem on your local computer:
 
-    $ gem install ninny
+```bash
+$ gem install ninny
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To use this gem with a GitLab project, you'll need to add the following information in a `.ninny.yml` file in the root directory of the project:
+
+```yml
+repo_type: gitlab
+gitlab_project_id: GITLAB_PROJECT_ID
+deploy_branch: DEPLOY_BRANCH
+```
+
+The `GITLAB_PROJECT_ID` can be found in the general settings of the entire project. The `DEPLOY_BRANCH` is most likely your project's default branch.
+
+Then, each developer on the project should set up a file at `~/.ninny.yml` on their computer. To help with this, they can run the following and follow the prompts:
+
+```bash
+$ ninny setup
+Do you have a new GitLab private token? (Y/n) y # enter 'y'
+Enter private token: abc123def456ghi789jk # enter your private token
+User config updated
+```
+
+The private token should be a personal access token for that person's GitLab account (generated [here](https://gitlab.com/-/profile/personal_access_tokens)).
+
+If that command doesn't work, then you can manually create/update that file like this:
+
+```yml
+gitlab_private_token: abc123def456ghi789jk # private token goes here
+```
+
+After the config files are set up, these commands are available:
+
+```bash
+# To create a new staging branch of this format: staging.YYYY.MM.DD
+$ ninny new_staging
+
+# To list the current/latest staging branch
+$ ninny staging_branch
+
+# To merge the current branch into the current/latest staging branch
+$ ninny stage_up
+
+```
+
+At any point, `ninny help` will show the help screen.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Making Changes
+
+1. Clone or fork the repository
+2. Create a feature branch for your changes
+3. Run `bundle install`
+4. Make your changes
+5. Run `bundle exec rake` to run the tests
+    * Run `bundle exec guard` to run tests continuously as you develop
+6. Test the gem locally
+    * Run `gem build *.gemspec` to build the gem locally
+    * Run `gem install --local ninny-x.x.x.gem` to install the gem locally
+7. Make a pull request back to this repository
+
+### Releasing
+
+1. Make sure the `lib/ninny/version.rb` file is updated with a new version
+2. Run `git tag vX.X.X && git push --tag`
+3. Run `gem build *.gemspec`
+4. Run `gem push *.gem` to push the new version to RubyGems
+5. Run `rm *.gem` to clean up your local repository
 
-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).
+To set up your local machine to push to RubyGems via the API, see the [RubyGems documentation](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ninny. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dispatchinc/ninny. 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.
 
 ## Code of Conduct
 
-Everyone interacting in the Ninny project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ninny/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ninny project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Copyright
 
-Copyright (c) 2019 Carl Allen. See [MIT License](LICENSE.txt) for further details.
+Copyright (c) 2019 Dispatch. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "ninny"
+require 'bundler/setup'
+require 'ninny'
 
 # 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.
@@ -10,5 +11,5 @@ require "ninny"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/ninny

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 lib_path = File.expand_path('../lib', __dir__)
-$:.unshift(lib_path) if !$:.include?(lib_path)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 require 'ninny'
 require 'ninny/cli'
 
@@ -12,7 +13,7 @@ end
 
 begin
   Ninny::CLI.start
-rescue Ninny::CLI::Error => err
-  puts "ERROR: #{err.message}"
+rescue Ninny::CLI::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
 end

data/lib/ninny.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ninny/git'
 require 'ninny/command'
@@ -13,15 +15,15 @@ require 'ninny/repository/pull_request'
 require 'ninny/project_config'
 require 'ninny/user_config'
 
-
 require 'git'
 require 'gitlab'
 require 'tty-config'
 
 module Ninny
   class Error < StandardError; end
+
   def self.project_config
-    @config ||= ProjectConfig.config
+    @project_config ||= ProjectConfig.config
   end
 
   def self.user_config

data/lib/ninny/cli.rb

@@ -16,11 +16,10 @@ module Ninny
       require_relative 'version'
       puts "v#{Ninny::VERSION}"
     end
-    map %w(--version -v) => :version
+    map %w[--version -v] => :version
 
     desc 'staging_branch', 'Returns the current staging branch'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
     def staging_branch(*)
       if options[:help]
         invoke :help, ['staging_branch']
@@ -31,8 +30,7 @@ module Ninny
     end
 
     desc 'stage_up [PULL_REQUEST_ID]', 'Merges PR/MR into the staging branch'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
     def stage_up(pull_request_id = nil)
       if options[:help]
         invoke :help, ['stage_up']
@@ -43,11 +41,8 @@ module Ninny
     end
 
     desc 'new_staging', 'Create a new staging branch'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    method_option :delete_old_branches, aliases: ['-d'], type: :boolean,
-                                        desc: "Should old staging branches be deleted?"
-
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+    method_option :delete_old_branches, aliases: ['-d'], type: :boolean, desc: 'Should old staging branches be deleted?'
     def new_staging(*)
       if options[:help]
         invoke :help, ['new_staging']
@@ -58,8 +53,7 @@ module Ninny
     end
 
     desc 'setup', 'Interactively setup configuration'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
     def setup(*)
       if options[:help]
         invoke :help, ['setup']

data/lib/ninny/commands/create_dated_branch.rb

@@ -4,12 +4,13 @@ module Ninny
   module Commands
     class CreateDatedBranch < Ninny::Command
       attr_reader :branch_type, :should_delete_old_branches
+
       def initialize(options)
         @branch_type = options[:branch_type] || Git::STAGING_PREFIX
         @should_delete_old_branches = options[:delete_old_branches]
       end
 
-      def execute(input: $stdin, output: $stdout)
+      def execute(output: $stdout)
         create_branch
         delete_old_branches
         output.puts "#{branch_name} created"
@@ -22,7 +23,7 @@ module Ninny
 
       # Public: The date suffix to append to the branch name
       def date_suffix
-        Date.today.strftime("%Y.%m.%d")
+        Date.today.strftime('%Y.%m.%d')
       end
 
       # Public: The name of the branch to create
@@ -35,12 +36,15 @@ module Ninny
       # Public: If necessary, and if user opts to, delete old branches of its type
       def delete_old_branches
         return unless extra_branches.any?
-        should_delete = should_delete_old_branches || prompt.yes?("Do you want to delete the old #{branch_type} branch(es)? (#{extra_branches.join(", ")})")
 
-        if should_delete
-          extra_branches.each do |extra|
-            Ninny.git.delete_branch(extra)
-          end
+        should_delete = should_delete_old_branches || prompt.yes?(
+          "Do you want to delete the old #{branch_type} branch(es)? (#{extra_branches.join(', ')})"
+        )
+
+        return unless should_delete
+
+        extra_branches.each do |extra|
+          Ninny.git.delete_branch(extra)
         end
       end
 
@@ -49,11 +53,11 @@ module Ninny
       # Returns an Array of Strings of the branch names
       def extra_branches
         with_branch_type do
-          Ninny.git.branches_for(branch_type).select{ |branch| branch.name != branch_name }
+          Ninny.git.branches_for(branch_type).reject { |branch| branch.name == branch_name }
         end
       end
 
-      def with_branch_type(&block)
+      def with_branch_type
         case branch_type
         when Git::DEPLOYABLE_PREFIX, Git::STAGING_PREFIX, Git::QAREADY_PREFIX
           yield