story_branch 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0adf65a12d1ab52998ada7760645345d76c1dbe817ce52724005a71cf1b7bb30
-  data.tar.gz: 63a19f6f253be9459618ecfb8d23f099c1e2ea5c65b3152394b49a6dce335094
+  metadata.gz: 4196567f738d9eefe7e9b689bba4a082f3604d41c7e4b198f10295e3f867a0ba
+  data.tar.gz: 4bd0f419c7fce7703c1b5df98d906137bfd6b3c53e400273c59caf8bea923d26
 SHA512:
-  metadata.gz: c7a2c1923c37f423f7f2a946e6ecf19371cae814b33489ec59069567711b3de50a3c49e054d4c30042c04ebfe4b16c032584f854a758ab1f0871bb7f27d67ca7
-  data.tar.gz: a59cb14660ed656598170978e63ccc2e51e414028d28a6af35c3e0de82d96fd9cea10c93e033c4c9a12850b880fbd922b1b60a035e700fea8b73ee292b59ad11
+  metadata.gz: 60993c9099b5112018ea6949ad47901bc27349473296ba96590bed89b499d96eea9ad185623d66d16ba28216b71d8efcbbd91131e89cb51e17da370037416eca
+  data.tar.gz: 0a5154411fdb3c53b5efc0e444af8383b9a197e241bb0ffbe0322c38ccf56d92ee5501e1f3b25026aa1b181b10c66736f9fce90fb25a1a3df1d0530defea7729

data/.circleci/config.yml

@@ -27,13 +27,21 @@ workflows:
 jobs:
   test:
     <<: *defaults
+
     steps:
       - checkout
 
+      - run:
+          name: Install Code Climate Test Reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+      - run: ./cc-test-reporter before-build
+
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          - v1-dependencies-
+          - v2-dependencies-{{ checksum "Gemfile.lock" }}
+          - v2-dependencies-
 
       - run:
           name: install dependencies
@@ -44,7 +52,7 @@ jobs:
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          key: v2-dependencies-{{ checksum "Gemfile.lock" }}
 
       - run:
           name: run tests
@@ -61,7 +69,16 @@ jobs:
           path: /tmp/test-results
       - store_artifacts:
           path: /tmp/test-results
-          destination: test-results
+
+      - run:
+          name: Code Climate Test Coverage convert to json
+          command: |
+            ./cc-test-reporter format-coverage -t simplecov
+
+      - run:
+          name: Code Climate Test Coverage upload results
+          command: |
+            ./cc-test-reporter after-build -t simplecov --exit-code $?
 
   publish:
     <<: *defaults
@@ -70,8 +87,8 @@ jobs:
 
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          - v1-dependencies-
+          - v2-dependencies-{{ checksum "Gemfile.lock" }}
+          - v2-dependencies-
 
       - run:
           name: install dependencies
@@ -82,7 +99,7 @@ jobs:
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+          key: v2-dependencies-{{ checksum "Gemfile.lock" }}
 
       - run:
           name: Setup Rubygems

data/.github/weekly-digest.yml

@@ -0,0 +1,7 @@
+# Configuration for weekly-digest - https://github.com/apps/weekly-digest
+publishDay: sun
+canPublishIssues: true
+canPublishPullRequests: true
+canPublishContributors: true
+canPublishStargazers: true
+canPublishCommits: true

data/.gitignore

@@ -2,3 +2,5 @@
 story_branch-*.gem
 /.pairs
 .byebug_history
+coverage
+tools/release*.*

data/.rubocop.yml

@@ -7,3 +7,45 @@ AllCops:
     - 'exe/*'
     - '**/Gemfile'
     - '.github/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.7.1

data/Gemfile.lock

@@ -1,81 +1,108 @@
 PATH
   remote: .
   specs:
-    story_branch (0.6.1)
+    story_branch (1.0.0)
       blanket_wrapper (~> 3.0)
       damerau-levenshtein (~> 1.3)
       jira-ruby (~> 1.7)
-      thor (~> 0.20.0)
-      tty-command (~> 0.8.2)
-      tty-config (~> 0.2.0)
+      thor (~> 0.20)
+      tty-command (~> 0.8)
+      tty-config (~> 0.2)
       tty-pager (~> 0.12)
       tty-prompt (~> 0.18)
+      xdg (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
     atlassian-jwt (0.2.0)
       jwt (~> 2.1.0)
     blanket_wrapper (3.0.2)
       httparty
       recursive-open-struct
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     damerau-levenshtein (1.3.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     equatable (0.6.1)
     fakefs (0.20.1)
     git (1.5.0)
-    httparty (0.17.3)
+    httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.7.0)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jira-ruby (1.7.1)
+    jira-ruby (1.8.0)
       activesupport
       atlassian-jwt
       multipart-post
       oauth (~> 0.5, >= 0.5.0)
+    json (2.1.0)
     jwt (2.1.0)
     method_source (0.9.2)
-    mime-types (3.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    minitest (5.13.0)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     necromancer (0.5.1)
     oauth (0.5.4)
     ostruct (0.1.0)
-    pastel (0.7.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pastel (0.7.4)
       equatable (~> 0.6)
       tty-color (~> 0.5)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
-    recursive-open-struct (1.1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    recursive-open-struct (1.1.2)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     strings (0.1.8)
       strings-ansi (~> 0.1)
       unicode-display_width (~> 1.5)
@@ -83,16 +110,15 @@ GEM
     strings-ansi (0.2.0)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tty-color (0.5.0)
-    tty-command (0.8.2)
+    tty-color (0.5.1)
+    tty-command (0.9.0)
       pastel (~> 0.7.0)
-    tty-config (0.2.0)
-    tty-cursor (0.7.0)
-    tty-pager (0.12.1)
-      strings (~> 0.1.4)
-      tty-screen (~> 0.6)
-      tty-which (~> 0.4)
-    tty-prompt (0.20.0)
+    tty-config (0.3.2)
+    tty-cursor (0.7.1)
+    tty-pager (0.13.0)
+      strings (~> 0.1.8)
+      tty-screen (~> 0.8)
+    tty-prompt (0.21.0)
       necromancer (~> 0.5.0)
       pastel (~> 0.7.0)
       tty-reader (~> 0.7.0)
@@ -100,28 +126,30 @@ GEM
       tty-cursor (~> 0.7)
       tty-screen (~> 0.7)
       wisper (~> 2.0.0)
-    tty-screen (0.7.0)
-    tty-which (0.4.1)
-    tzinfo (1.2.5)
+    tty-screen (0.8.0)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     unicode_utils (1.4.0)
     wisper (2.0.1)
-    zeitwerk (2.2.2)
+    xdg (3.1.1)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.1)
   fakefs (~> 0.14)
   git (~> 1.5)
   ostruct (~> 0.1)
   pry (~> 0.11)
-  rake (~> 10.0)
+  rake (~> 12.3, >= 12.3.3)
   rspec (~> 3)
   rspec_junit_formatter (~> 0.4)
+  rubocop (~> 0.86)
+  simplecov (~> 0.16)
   story_branch!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -4,11 +4,17 @@
 
 # Story Branch
 
-Story branch is a CLI application that interacts with Pivotal Tracker or Github at the
+Story branch is a CLI application that interacts with Pivotal Tracker, Github and Jira
 at the moment.
-It allows you to start and un-start stories in Pivotal Tracker, as well as creating
-branches based on the story name and id and have a final commit message marking
-the story as Finished.
+
+For all the trackers it supports creating local branches from the tickets or
+opening the ticket in your browser from the branch you're working on. In the future
+I plan to support different workflows in order to integrate your individual
+process in the tool.
+
+As for PivotalTracker, since the flow is mostly the same for everyone, it allows
+you to start and un-start stories as well.
+
 
 [View Changelog](Changelog.md)
 
@@ -30,8 +36,8 @@ You can see all the commands available by running
 $ story_branch -h
 
 Commands:
-  story_branch add             # Add a new story branch configuration
-  story_branch create          # Create branch from estimated stories in pivotal tracker
+  story_branch configure       # Configure a new story branch configuration
+  story_branch create          # Create branch from a ticket in the tracker
   story_branch finish          # Creates a git commit message for the staged changes with a [Finishes] tag
   story_branch help [COMMAND]  # Describe available commands or one specific command
   story_branch migrate         # Migrate old story branch configuration to the new format
@@ -113,14 +119,14 @@ the full list.
 
 ## Configuring PivotalTracker
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. tracker - You should select Pivotal Tracker
 2. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
 3. api key - this is your personal api key. You can get that from [your profile page](https://www.pivotaltracker.com/profile)
 
 ## Configuring Github
 
-When running the command `story_branch add` you'll be asked 3 things:
+When running the command `story_branch configure` you'll be asked 3 things:
 1. project id - This is the github repository name in the format `<owner>/<repo_name>`. E.g. `story-branch/story_branch`.
 2. tracker - You should select Github
 3. api key - this is your personal api token. You can create one under your

data/docs/index.md

@@ -0,0 +1,168 @@
+# Story Branch
+
+Story branch is a CLI application that interacts with Pivotal Tracker, Github
+and JIRA.
+
+Depending on the tracker features, it provides different approaches.
+
+- For PivotalTracker, it allows you to start and un-start stories, as well as
+creating branches based on the story name and id and have a final commit message
+marking the story as Finished.
+
+- For Github and JIRA because there is not a fixed flow, it allows you to create
+the branches based on the tickets name and numbers. Similarly, it supports one
+final commit with a standard message.
+
+[View Changelog](Changelog.md)
+
+## Installing
+
+Install the gem:
+
+    gem install story_branch
+
+## Usage
+
+You should run story_branch from the git/project root folder.
+
+## Commands available
+
+You can see all the commands available by running
+
+```
+$ story_branch -h
+
+Commands:
+  story_branch configure       # Setup story branch with a new/existing project
+  story_branch create          # Create branch from a ticket in the tracker
+  story_branch finish          # Creates a git commit message for the staged changes with a [Finishes] tag
+  story_branch help [COMMAND]  # Describe available commands or one specific command
+  story_branch migrate         # Migrate old story branch configuration to the new format
+  story_branch start           # Mark an estimated story as started [Only for Pivotal Tracker]
+  story_branch unstart         # Mark a started story as un-started [Only for Pivotal Tracker]
+  story_branch version         # story_branch gem version
+```
+
+## Settings
+
+Story branch has a command available that will help you creating the configurations
+for the projects, but essentially you'll be asked for the pivotal tracker project id and your api key.
+
+### Configuring the project id
+
+The project id you can get it easily from the url when viewing the project.
+This value will be stored in the local configuration file that will be committed
+to the working repository
+
+### Configuring the api key
+
+The api key you can get it from your account settings.
+This value will be stored in your global configuration file that typically is
+not shared with your co-workers in the repository. This way, each user will
+be properly identified in the tracker
+
+### Configuring the finish tag
+
+On your local config you can add a line with `finish_tag: <Some random word>`.
+This tag will be used in the commit message when running `story_branch finish`.
+
+E.g.
+`finish_tag: Resolves`
+
+`story_branch finish` will make a commit with the message
+`[Resolves #12313] story title`
+
+
+### .story_branch files
+
+When configuring story branch, it will create two .story_branch.yml files: one in
+your home folder (`~/`) and one in your project's root (`./`).
+The one in your home folder will be used to store the different project's configurations
+such as which api key to use. This is done so you don't need to commit your
+api key to the repository but still be able to use different keys in case you
+have different accounts.
+
+The one in your project root will keep a reference to the project configuration.
+For now, this reference is the project id. This file can be safely committed to
+the repository and shared amongst your co-workers.
+
+## Commentary
+
+`story_branch create`: Creates a git branch with automatic reference to a
+Pivotal Tracker Story. It will get started stories from your active
+project. You can enter text and press TAB to search for a story
+name, or TAB to show the full list. It will then suggest an editable
+branch name. When the branch is created the `story_id` will
+be appended to it.
+
+e.g. `my-story-name-1234567`
+
+`story_branch finish`: Creates a git commit message for the staged changes.
+
+e.g: `[Finishes #1234567] My story name`
+
+You must stage all changes (or stash them) first. Note the commit will not
+be pushed. Note: You'll be able to bail out of the commit.
+
+`story_branch start`: Start a story in Pivotal Tracker from the terminal.
+It'll get all un-started stories in your current project. You can
+enter text and press TAB to search for a story name, or TAB to show
+the full list.
+
+`story_branch unstart`: Un-start a story in Pivotal Tracker from the terminal.
+It'll get all started stories in your current project. You can
+enter text and press TAB to search for a story name, or TAB to show
+the full list.
+
+## Configuring PivotalTracker
+
+When running the command `story_branch configure` you'll be asked 3 things:
+1. tracker - You should select Pivotal Tracker
+2. project id - This can be fetched from the PivotalTracker url. E.g in the url `https://www.pivotaltracker.com/n/projects/651417`, the project id would be `651417`
+3. api key - this is your personal api key. You can get that from [your profile page](https://www.pivotaltracker.com/profile)
+
+## Configuring Github
+
+When running the command `story_branch configure` you'll be asked 3 things:
+1. project id - This is the github repository name in the format `<owner>/<repo_name>`. E.g. `story-branch/story_branch`.
+2. tracker - You should select Github
+3. api key - this is your personal api token. You can create one under your
+[developer profile tokens page](https://github.com/settings/tokens)
+
+## Configuring JIRA
+
+The configuration for JIRA is slightly more complex as the endpoint changes according
+to your project setup. You will need an API token, which you can create a new one in your [JIRA id management page](https://id.atlassian.com/manage/api-tokens)
+1. tracker - You should select JIRA
+2. JIRA's subdomain - you should type the JIRA's subdomain that you use to access in your browser. E.g I'd type perxtechnologies to access to https://perxtechnologies.atlassian.net
+3. JIRA's project key - this should match which project you want to fetch the issues from. E.g. PW is the key for my Project Whistler, so I'd type PW
+4. API key that you should have gotten in the first description step
+5. username used for login in the JIRA usually. If you use google email authentication, the username should be your email
+
+## Migrating
+
+### Old configuration
+
+If your were using story branch before there are some small changes on the way the
+tool works. But worry not, we've written a command that allows you to migrate your
+configuration. Running
+
+`$ story_branch migrate`
+
+will grab your existing configuration and convert it into the new format. The only
+thing you'll need to provide is the project name reference.
+
+### Old commands
+
+Story branch was built providing a set of bin commands such as `git-story`, `git-finish`, `git-start` and `git-unstart`. These will be available still as
+we try as much as possible to keep the updates retro-compatible, but are nothing
+more than an alias for the CLI commands as follow:
+
+- `git-story` runs `story_branch create`
+- `git-finish` runs `story_branch finish`
+- `git-start` runs `story_branch start`
+- `git-unstart` runs `story_branch unstart`
+
+## Contributing
+
+All pull requests are welcome and will be reviewed.