story_branch 0.6.1 → 0.7.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0adf65a12d1ab52998ada7760645345d76c1dbe817ce52724005a71cf1b7bb30
-  data.tar.gz: 63a19f6f253be9459618ecfb8d23f099c1e2ea5c65b3152394b49a6dce335094
+  metadata.gz: 9a12f882753865d3d70a70e890fd74ad6f2c62437af6156dbc95d351cf6af9ac
+  data.tar.gz: 663c2ab9b76745eea8c95e1c30f88c39ca40b1892c1a64eb311a6f91266fefd8
 SHA512:
-  metadata.gz: c7a2c1923c37f423f7f2a946e6ecf19371cae814b33489ec59069567711b3de50a3c49e054d4c30042c04ebfe4b16c032584f854a758ab1f0871bb7f27d67ca7
-  data.tar.gz: a59cb14660ed656598170978e63ccc2e51e414028d28a6af35c3e0de82d96fd9cea10c93e033c4c9a12850b880fbd922b1b60a035e700fea8b73ee292b59ad11
+  metadata.gz: d2442c7a38bc27d78a1be6d8219b99d70ccf531fcab8cd25b216b36845cd88c1f4e27748ea8733d8af232ef8c7235bc375f4dd45f3912daa0b7a9838fc3ca1e2
+  data.tar.gz: 8814adeb71cc1b479d2e521505fa1d0b58bd7a3f2f5e49781f8c7fce863d2e1490dfd202b6f79c58c58e59dfcdfd8c61cd44d2653a55db80ef5da0aa9ae447ae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    story_branch (0.6.1)
+    story_branch (0.7.0.alpha)
       blanket_wrapper (~> 3.0)
       damerau-levenshtein (~> 1.3)
       jira-ruby (~> 1.7)
@@ -10,6 +10,7 @@ PATH
       tty-config (~> 0.2.0)
       tty-pager (~> 0.12)
       tty-prompt (~> 0.18)
+      xdg (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -35,7 +36,7 @@ GEM
     httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.7.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jira-ruby (1.7.1)
       activesupport
@@ -44,10 +45,10 @@ GEM
       oauth (~> 0.5, >= 0.5.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)
+    minitest (5.14.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     necromancer (0.5.1)
@@ -65,15 +66,15 @@ GEM
       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)
     strings (0.1.8)
@@ -83,7 +84,7 @@ GEM
     strings-ansi (0.2.0)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tty-color (0.5.0)
+    tty-color (0.5.1)
     tty-command (0.8.2)
       pastel (~> 0.7.0)
     tty-config (0.2.0)
@@ -101,19 +102,20 @@ GEM
       tty-screen (~> 0.7)
       wisper (~> 2.0.0)
     tty-screen (0.7.0)
-    tty-which (0.4.1)
-    tzinfo (1.2.5)
+    tty-which (0.4.2)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
     unicode_utils (1.4.0)
     wisper (2.0.1)
+    xdg (3.1.1)
     zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0)
   fakefs (~> 0.14)
   git (~> 1.5)
   ostruct (~> 0.1)
@@ -124,4 +126,4 @@ DEPENDENCIES
   story_branch!
 
 BUNDLED WITH
-   2.1.2
+   2.1.3

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 add             # Add a new story branch configuration
+  story_branch create          # Create branch from estimated stories in pivotal 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 in Pivotal Tracker
+  story_branch unstart         # Mark a started story as un-started in 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 add` 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:
+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.

data/lib/story_branch/cli.rb

@@ -78,17 +78,5 @@ module StoryBranch
         StoryBranch::Commands::Add.new(options).execute
       end
     end
-
-    desc 'migrate', 'Migrate old story branch configuration to the new format'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    def migrate(*)
-      if options[:help]
-        invoke :help, ['migrate']
-      else
-        require_relative 'commands/migrate'
-        StoryBranch::Commands::Migrate.new(options).execute
-      end
-    end
   end
 end

data/lib/story_branch/commands/add.rb

@@ -13,60 +13,61 @@ module StoryBranch
     # It will try to load the existing global story branch config
     # and then add the project id specified by the user.
     class Add < StoryBranch::Command
-      def initialize(options)
-        @options = options
-        @config = ConfigManager.init_config(Dir.home)
-        @local_config = ConfigManager.init_config('.')
+      def initialize(_options)
+        @new_config = ConfigManager.new
       end
 
       def execute(_input: $stdin, output: $stdout)
-        create_local_config
+        set_tracker_type
+        set_project_key
         create_global_config
+        @new_config.save
         output.puts 'Configuration added successfully'
       end
 
       private
 
-      def create_local_config
-        return if local_config_has_value?
+      def set_tracker_type
+        return if @new_config.contains?(project_key)
 
         puts "Setting #{tracker}"
-        @local_config.set(:tracker, value: tracker)
-
-        puts "Appending #{project_id}"
-        @local_config.append(project_id, to: :project_id)
+        @new_config.tracker_type = tracker
+      end
 
-        @local_config.write(force: true)
+      def set_project_key
+        puts "Setting #{project_key}"
+        @new_config.project_key = project_key
       end
 
       def create_global_config
         api_key = prompt.ask('Please provide the api key:', required: true)
-        @config.set(project_id, :api_key, value: api_key)
-        @config.write(force: true)
+        @new_config.api_key = api_key
 
         return unless tracker == 'jira'
 
-        # rubocop:disable Layout/LineLength
+        # rubocop:disable Metrics/LineLength
         username = prompt.ask('Please provide username (email most of the times) for this key:',
                               required: true)
-        # rubocop:enable Layout/LineLength
-        @config.set(project_id, :username, value: username)
-        @config.write(force: true)
+        # rubocop:enable Metrics/LineLength
+        @new_config.username = username
       end
 
-      def project_id
-        return @project_id if @project_id
+      def project_key
+        return @project_key if @project_key
 
+        @project_key = ask_for_project_key
+      end
+
+      def ask_for_project_key
         if tracker == 'jira'
-          # rubocop:disable Layout/LineLength
-          project_domain = prompt.ask("What is your JIRA's subdomain?", required: true)
-          project_key = prompt.ask("What is your JIRA's project key?", required: true)
-          # rubocop:enable Layout/LineLength
-          @project_id = "#{project_domain}|#{project_key}"
+          project_domain = prompt.ask("What is your JIRA's subdomain?",
+                                      required: true)
+          project_key = prompt.ask("What is your JIRA's project key?",
+                                   required: true)
+
+          "#{project_domain}|#{project_key}"
         else
-          # rubocop:disable Layout/LineLength
-          @project_id = prompt.ask("Please provide this project's id:", required: true)
-          # rubocop:enable Layout/LineLength
+          prompt.ask("Please provide this project's id:", required: true)
         end
       end
 
@@ -80,15 +81,6 @@ module StoryBranch
         }
         @tracker = prompt.select('Which tracker are you using?', trackers)
       end
-
-      def local_config_has_value?
-        config_value = @local_config.fetch(:project_id)
-        if config_value.is_a? Array
-          config_value.include?(project_id)
-        else
-          config_value == project_id
-        end
-      end
     end
   end
 end

data/lib/story_branch/config_manager.rb

@@ -1,20 +1,169 @@
 # frozen_string_literal: true
 
 require 'tty-config'
+require 'tty-prompt'
+require 'xdg'
 
 module StoryBranch
-  # Config manager class is simply a wrapper around
-  # TTY::Config with the configuration file name set
-  # so we DRY our code.
+  # Config manager is used to manage all possible configuration settings
+  # it uses mainly TTY::Config with the configuration file name set
+  # rubocop:disable Metrics/ClassLength
   class ConfigManager
-    # TODO: Might be worht moving the configuration filename
-    # to a constant
-    def self.init_config(path, should_read = true)
+    CONFIG_FILENAME = '.story_branch'
+
+    attr_reader :errors
+
+    def initialize
+      @prompt = TTY::Prompt.new(interrupt: :exit)
+      load_configs
+      @config = ::TTY::Config.new
+      @config.merge(@local)
+      @config.merge(@global)
+      @errors = []
+    end
+
+    def tracker_type
+      @tracker_type ||= @config.fetch(:tracker, default: 'pivotal-tracker')
+    end
+
+    def tracker_type=(tracker)
+      @local.set(:tracker, value: tracker)
+    end
+
+    def issue_placement
+      @issue_placement ||= @config.fetch(:issue_placement, default: 'End')
+    end
+
+    def finish_tag
+      @finish_tag ||= @config.fetch(project_key,
+                                    :finish_tag, default: 'Finishes')
+    end
+
+    def project_key=(key)
+      @project_key = key
+      @local.append(key, to: :project_id) unless contains?(key)
+    end
+
+    def api_key=(key)
+      @api_key = key
+      @global.set(@project_key, :api_key, value: key)
+    end
+
+    def username=(username)
+      @username = username
+      @global.set(@project_key, :username, value: username)
+    end
+
+    def tracker_params
+      {
+        tracker_domain: tracker_domain,
+        username: username,
+        project_id: project_id,
+        api_key: api_key,
+        extra_query: extra_query
+      }
+    end
+
+    def valid?
+      validate
+      @errors.length.zero?
+    end
+
+    def contains?(project_key)
+      project_keys = @config.fetch(:project_id)
+      if project_keys.is_a? Array
+        project_keys.include?(project_key)
+      else
+        project_keys == project_key
+      end
+    end
+
+    def save
+      @local.write(force: true)
+      @global.write(force: true)
+    end
+
+    private
+
+    def api_key
+      @api_key ||= @config.fetch(project_key, :api_key)
+    end
+
+    def username
+      @username ||= @config.fetch(project_key, :username)
+    end
+
+    def project_key
+      return @project_key if @project_key
+
+      project_keys = @config.fetch(:project_id)
+
+      @project_key = choose_project_id(project_keys)
+    end
+
+    def extra_query
+      @extra_query ||= @config.fetch(project_key, :extra_query, default: '')
+    end
+
+    def project_id
+      return @project_id if @project_id
+
+      @project_id = if tracker_type == 'jira'
+                      project_key.split('|')[1]
+                    else
+                      project_key
+                    end
+    end
+
+    def tracker_domain
+      return @tracker_domain if @tracker_domain
+
+      @tracker_domain = if tracker_type != 'jira'
+                          ''
+                        else
+                          project_key.split('|')[0]
+                        end
+    end
+
+    def choose_project_id(project_ids)
+      return project_ids unless project_ids.is_a? Array
+      return project_ids[0] unless project_ids.length > 1
+
+      @prompt.select('Which project you want to fetch from?', project_ids)
+    end
+
+    def validate
+      @errors << 'Project ID is not set' if project_id.nil?
+    end
+
+    def load_configs
+      @local = read_config('.')
+      xdg_conf = XDG::Config.new
+      home_path = if conf_exist?(Dir.home)
+                    Dir.home
+                  else
+                    xdg_conf.home
+                  end
+      @global = read_config(home_path)
+    end
+
+    def read_config(path)
+      config = init_config(path)
+      config.read if config.persisted?
+      config
+    end
+
+    def conf_exist?(path)
+      config = init_config(path)
+      config.persisted?
+    end
+
+    def init_config(path)
       config = ::TTY::Config.new
-      config.filename = '.story_branch'
+      config.filename = CONFIG_FILENAME
       config.append_path path
-      config.read if config.persisted? && should_read
       config
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/story_branch/github/tracker.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
 
 require 'blanket'
+require 'story_branch/tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Github
     # Github API wrapper for story branch tracker
-    class Tracker
+    class Tracker < StoryBranch::TrackerBase
       API_URL = 'https://api.github.com/'
-      TYPE = 'github'
 
-      attr_reader :type
-
-      def initialize(repo_name, api_key)
+      def initialize(project_id:, api_key:, **)
         # NOTE: RepoName should follow owner/repo_name format
-        @repo_name = repo_name
+        @repo_name = project_id
         @api_key = api_key
-        @type = TYPE
       end
 
       def valid?
@@ -37,9 +34,7 @@ module StoryBranch
 
       private
 
-      def api
-        raise 'API key must be specified' unless @api_key
-
+      def configure_api
         Blanket.wrap API_URL, headers: {
           'User-Agent' => 'Story Branch',
           Authorization: "token #{@api_key}"

data/lib/story_branch/jira/project.rb

@@ -6,8 +6,9 @@ module StoryBranch
   module Jira
     # Jira Project representation
     class Project
-      def initialize(jira_project)
+      def initialize(jira_project, query_addon = '')
         @project = jira_project
+        @query_addon = query_addon
       end
 
       # Returns an array of Jira issues (Issue Class)
@@ -17,15 +18,22 @@ module StoryBranch
         stories = if options[:id]
                     [@project.issues.find(options[:id])]
                   else
-                    # rubocop:disable Layout/LineLength
-                    @project.client.Issue.jql(
-                      "project=#{@project.key} AND status='To Do' AND assignee=currentUser()"
-                    )
-                    # rubocop:enable Layout/LineLength
+                    @project.client.Issue.jql(jql_query)
                   end
 
         stories.map { |s| Issue.new(s, @project) }
       end
+
+      private
+
+      def jql_query
+        base_query = "project=#{@project.key} AND assignee=currentUser()"
+        if @query_addon.length.positive?
+          [base_query, @query_addon].join(' AND ')
+        else
+          base_query
+        end
+      end
     end
   end
 end

data/lib/story_branch/jira/tracker.rb

@@ -5,23 +5,22 @@
 # my tracker and issues will still provide a similar api. This jira-ruby
 # is used to get the data.
 require 'jira-ruby'
+require 'story_branch/tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Jira
     # JIRA API wrapper for story branch tracker
-    class Tracker
-      TYPE = 'jira'
-
-      attr_reader :type
-
-      def initialize(tracker_domain:, project_id:, api_key:, username:)
+    class Tracker < StoryBranch::TrackerBase
+      # rubocop:disable Metrics/LineLength
+      def initialize(tracker_domain:, project_id:, api_key:, username:, extra_query:)
         @tracker_url = "https://#{tracker_domain}.atlassian.net"
         @project_id = project_id
         @api_key = api_key
         @username = username
-        @type = TYPE
+        @extra_query = extra_query
       end
+      # rubocop:enable Metrics/LineLength
 
       def valid?
         [@api_key, @project_id, @username, @tracker_url].none?(&:nil?)
@@ -52,10 +51,8 @@ module StoryBranch
         }
       end
 
-      def api
-        raise 'API key must be specified' unless @api_key
-
-        @api ||= JIRA::Client.new(options)
+      def configure_api
+        JIRA::Client.new(options)
       end
 
       def project
@@ -63,7 +60,7 @@ module StoryBranch
         raise 'project key must be set' unless @project_id
 
         jira_project = api.Project.find(@project_id)
-        @project = Project.new(jira_project)
+        @project = Project.new(jira_project, @extra_query)
       end
     end
   end

data/lib/story_branch/main.rb

@@ -17,14 +17,9 @@ module StoryBranch
     attr_accessor :tracker
 
     def initialize
-      # TODO: Config manager should be responsible for handling the
-      # configuration and the story branch should only initialize one
-      # config manager that has attr accessors for needed values
-      # Read local config and decide what Utility to use
-      # (e.g. PivotalUtils, GithubUtils, ...)
-      @local_config = ConfigManager.init_config('.')
-      @global_config = ConfigManager.init_config(Dir.home)
-      initialize_tracker
+      @config = ConfigManager.new
+      abort(@config.errors.join("\n")) unless @config.valid?
+      @tracker = initialize_tracker
       abort('Invalid tracker configuration setting.') unless @tracker.valid?
     end
 
@@ -75,11 +70,10 @@ module StoryBranch
     private
 
     def require_pivotal
-      if @tracker.type != 'pivotal'
-        prompt.say 'The configured tracker does not support this feature'
-        return false
-      end
-      true
+      return true if @tracker.class.name.match?('Pivotal')
+
+      prompt.say 'The configured tracker does not support this feature'
+      false
     end
 
     def current_story
@@ -159,29 +153,8 @@ module StoryBranch
       @prompt ||= TTY::Prompt.new(interrupt: :exit)
     end
 
-    def finish_tag
-      return @finish_tag if @finish_tag
-
-      fallback = @global_config.fetch(project_id,
-                                      :finish_tag,
-                                      default: 'Finishes')
-      @finish_tag = @local_config.fetch(:finish_tag, default: fallback)
-      @finish_tag
-    end
-
-    def issue_placement
-      return @issue_placement if @issue_placement
-
-      fallback = @global_config.fetch(project_id,
-                                      :issue_placement,
-                                      default: 'End')
-      @issue_placement = @local_config.fetch(:issue_placement,
-                                             default: fallback)
-      @issue_placement
-    end
-
     def build_finish_message
-      message_tag = [finish_tag, "##{current_story.id}"].join(' ').strip
+      message_tag = [@config.finish_tag, "##{current_story.id}"].join(' ').strip
       "[#{message_tag}] #{current_story.title}"
     end
 
@@ -196,10 +169,11 @@ module StoryBranch
       branch_name = valid_branch_name(story)
       return unless branch_name
 
-      # rubocop:disable Layout/LineLength
+      # rubocop:disable Metrics/LineLength
       feature_branch_name_with_story_id = build_branch_name(branch_name, story.id)
+
       prompt.say("Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent")
-      # rubocop:enable Layout/LineLength
+      # rubocop:enable Metrics/LineLength
       GitWrapper.create_branch feature_branch_name_with_story_id
     end
 
@@ -233,65 +207,30 @@ module StoryBranch
     # rubocop:enable Metrics/MethodLength
 
     def build_branch_name(branch_name, story_id)
-      if issue_placement.casecmp('beginning').zero?
+      if @config.issue_placement.casecmp('beginning').zero?
         "#{story_id}-#{branch_name}"
       else
         "#{branch_name}-#{story_id}"
       end
     end
 
-    def project_id
-      return @project_id if @project_id
-
-      project_ids = @local_config.fetch(:project_id)
-      @project_id = choose_project_id(project_ids)
-    end
-
-    def choose_project_id(project_ids)
-      return project_ids unless project_ids.is_a? Array
-      return project_ids[0] unless project_ids.length > 1
-
-      prompt.select('Which project you want to fetch from?', project_ids)
-    end
-
-    def api_key
-      @api_key ||= @global_config.fetch(project_id, :api_key)
-    end
-
-    def username
-      @username ||= @global_config.fetch(project_id, :username)
-    end
-
     def current_branch
       @current_branch ||= GitWrapper.current_branch
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
     def initialize_tracker
-      if project_id.nil?
-        prompt.say 'Project ID not set'
-        exit 0
+      # TODO: Ideally this would be mapped out somewhere so we don't need to
+      # evaluate anything from the config here
+      tracker_type = @config.tracker_type
+      case tracker_type
+      when 'github'
+        StoryBranch::Github::Tracker.new(@config.tracker_params)
+      when 'pivotal-tracker'
+        StoryBranch::Pivotal::Tracker.new(@config.tracker_params)
+      when 'jira'
+        StoryBranch::Jira::Tracker.new(@config.tracker_params)
       end
-      tracker_type = @local_config.fetch(:tracker, default: 'pivotal-tracker')
-      @tracker = case tracker_type
-                 when 'github'
-                   StoryBranch::Github::Tracker.new(project_id, api_key)
-                 when 'pivotal-tracker'
-                   StoryBranch::Pivotal::Tracker.new(project_id, api_key)
-                 when 'jira'
-                   tracker_domain, project_key = project_id.split('|')
-                   options = {
-                     tracker_domain: tracker_domain,
-                     project_id: project_key,
-                     api_key: api_key,
-                     username: username
-                   }
-                   StoryBranch::Jira::Tracker.new(options)
-                 end
     end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/story_branch/pivotal/tracker.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
 
 require 'blanket'
+require 'story_branch/tracker_base'
 require_relative './project'
 
 module StoryBranch
   module Pivotal
     # Utility class for integration with PivotalTracker. It relies on Blanket
     # wrapper to communicate with pivotal tracker's api.
-    class Tracker
+    class Tracker < StoryBranch::TrackerBase
       API_URL = 'https://www.pivotaltracker.com/services/v5/'
-      TYPE = 'pivotal'
 
-      attr_reader :type
-
-      def initialize(project_id, api_key)
+      def initialize(project_id:, api_key:, **)
         @project_id = project_id
         @api_key = api_key
-        @type = TYPE
       end
 
       def valid?
@@ -41,9 +38,7 @@ module StoryBranch
 
       private
 
-      def api
-        raise 'API key must be specified' unless @api_key
-
+      def configure_api
         Blanket.wrap API_URL, headers: { 'X-TrackerToken' => @api_key }
       end
 

data/lib/story_branch/tracker_base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module StoryBranch
+  # Base story branch tracker class that will define the expected interface
+  class TrackerBase
+    def valid?
+      raise 'valid? > must be implemented in the custom tracker'
+    end
+
+    # TODO: This should probably be renamed to something more meaningful
+    # in the sense that it should be workable stories/issues
+    # which depend on the tracker's workflow. PivotalTracker they need to
+    # be started and estimated, while for Github they just need to be open
+    def stories
+      []
+    end
+
+    def get_story_by_id(_story_id)
+      []
+    end
+
+    private
+
+    def api
+      raise 'API key must be specified' unless @api_key
+
+      @api ||= configure_api
+    end
+
+    def project
+      return @project if @project
+      raise 'project key must be set' unless @project_id
+
+      raise 'project > must be implemented in the custom tracker'
+    end
+  end
+end

data/lib/story_branch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoryBranch
-  VERSION = '0.6.1'
+  VERSION = '0.7.0.alpha'
 end

data/story_branch.gemspec

@@ -61,8 +61,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'tty-config', '~> 0.2.0'
   spec.add_runtime_dependency 'tty-pager', '~> 0.12'
   spec.add_runtime_dependency 'tty-prompt', '~> 0.18'
+  spec.add_runtime_dependency 'xdg', '~> 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'fakefs', '~> 0.14'
   spec.add_development_dependency 'git', '~> 1.5'
   spec.add_development_dependency 'ostruct', '~> 0.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0.alpha
 platform: ruby
 authors:
 - Rui Baltazar
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blanket_wrapper
@@ -126,20 +126,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -274,6 +288,7 @@ files:
 - README.md
 - Rakefile
 - Roadmap.md
+- docs/index.md
 - exe/git-finish
 - exe/git-start
 - exe/git-story
@@ -286,7 +301,6 @@ files:
 - lib/story_branch/commands/add.rb
 - lib/story_branch/commands/create.rb
 - lib/story_branch/commands/finish.rb
-- lib/story_branch/commands/migrate.rb
 - lib/story_branch/commands/start.rb
 - lib/story_branch/commands/unstart.rb
 - lib/story_branch/config_manager.rb
@@ -313,6 +327,7 @@ files:
 - lib/story_branch/templates/migrate/.gitkeep
 - lib/story_branch/templates/start/.gitkeep
 - lib/story_branch/templates/unstart/.gitkeep
+- lib/story_branch/tracker_base.rb
 - lib/story_branch/version.rb
 - story_branch.gemspec
 homepage: https://github.com/story-branch/story_branch
@@ -337,11 +352,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Create git branches based on your preferred tracker tickets

data/lib/story_branch/commands/migrate.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../config_manager'
-require_relative '../command'
-require 'yaml'
-require 'fileutils'
-
-module StoryBranch
-  module Commands
-    # Migrate command is intended to make the migration from old version
-    # of story branch to the latest one easier.
-    class Migrate < StoryBranch::Command
-      GLOBAL_CONFIG_FILE = "#{Dir.home}/.story_branch"
-      LOCAL_CONFIG_FILE = '.story_branch'
-      OLD_CONFIG_FILES = [LOCAL_CONFIG_FILE, GLOBAL_CONFIG_FILE].freeze
-
-      def initialize(options)
-        @options = options
-        @config = ConfigManager.init_config(Dir.home)
-      end
-
-      def execute(_input: $stdin, output: $stdout)
-        if missing_old_config?
-          error_migrating(output, old_config_file_not_found)
-          return
-        end
-        @config.set(project_id, :api_key, value: api_key)
-        @config.write(force: true)
-        create_local_config
-        clean_old_config_files
-        output.puts 'Migration complete'
-      end
-
-      private
-
-      def project_id
-        return @project_id if @project_id
-
-        @project_id = old_config_value('project', 'PIVOTAL_PROJECT_ID')
-        @project_id
-      end
-
-      def api_key
-        return @api_key if @api_key
-
-        @api_key = old_config_value('api', 'PIVOTAL_API_KEY')
-        @api_key
-      end
-
-      def error_migrating(output, error_message)
-        output.puts error_message
-      end
-
-      def missing_old_config?
-        OLD_CONFIG_FILES.each { |file| return false if File.exist?(file) }
-        return false if env_set?
-
-        true
-      end
-
-      def env_set?
-        ENV['PIVOTAL_API_KEY'].length.positive? ||
-          ENV['PIVOTAL_PROJECT_ID'].length.positive?
-      end
-
-      def old_config_value(key, env)
-        OLD_CONFIG_FILES.each do |config_file|
-          if File.exist? config_file
-            old_config = YAML.load_file config_file
-            return old_config[key].to_s if old_config && old_config[key]
-          end
-        end
-        ENV[env]
-      end
-
-      def create_local_config
-        local_config = ConfigManager.init_config('.')
-        local_config.set(:project_id, value: project_id)
-        local_config.write
-      end
-
-      def clean_old_config_files
-        [GLOBAL_CONFIG_FILE, LOCAL_CONFIG_FILE].each do |file|
-          FileUtils.rm file if File.exist? file
-        end
-      end
-
-      def old_config_file_not_found
-        <<~MESSAGE
-          Old configuration not found.
-          Trying to start from scratch? Use story_branch add
-        MESSAGE
-      end
-
-      def cant_migrate_missing_value
-        <<~MESSAGE
-          Old configuration not found. Nothing has been migrated
-          Trying to start from scratch? Use story_branch add
-        MESSAGE
-      end
-    end
-  end
-end