story_branch 0.2.11 → 0.3.0

data/lib/story_branch/cli.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module StoryBranch
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'story_branch gem version'
+    def version
+      require_relative 'version'
+      puts "v#{StoryBranch::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc 'unstart', 'Mark a started story as un-started in Pivotal Tracker'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def unstart(*)
+      if options[:help]
+        invoke :help, ['unstart']
+      else
+        require_relative 'commands/unstart'
+        StoryBranch::Commands::Unstart.new(options).execute
+      end
+    end
+
+    desc 'start', 'Mark an estimated story as started in Pivotal Tracker'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def start(*)
+      if options[:help]
+        invoke :help, ['start']
+      else
+        require_relative 'commands/start'
+        StoryBranch::Commands::Start.new(options).execute
+      end
+    end
+
+    desc 'finish', 'Creates a git commit message for the staged changes with a [Finishes] tag'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def finish(*)
+      if options[:help]
+        invoke :help, ['finish']
+      else
+        require_relative 'commands/finish'
+        StoryBranch::Commands::Finish.new(options).execute
+      end
+    end
+
+    desc 'create', 'Create branch from estimated stories in pivotal tracker'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def create(*)
+      if options[:help]
+        invoke :help, ['create']
+      else
+        require_relative 'commands/create'
+        StoryBranch::Commands::Create.new(options).execute
+      end
+    end
+
+    desc 'add', 'Add a new story branch configuration'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    def add(*)
+      if options[:help]
+        invoke :help, ['add']
+      else
+        require_relative 'commands/add'
+        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/command.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module StoryBranch
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/story_branch/commands/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/story_branch/commands/add.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative '../config_manager'
+require_relative '../command'
+require 'tty-config'
+require 'tty-prompt'
+
+module StoryBranch
+  module Commands
+    # Command responsible for adding a new configuration to
+    # the available configurations
+    #
+    # 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(ENV['HOME'])
+        @local_config = ConfigManager.init_config('.')
+      end
+
+      def execute(_input: $stdin, output: $stdout)
+        create_global_config
+        create_local_config
+        output.puts 'Configuration added successfully'
+      end
+
+      private
+
+      def create_local_config
+        @local_config.set(:project_id, value: project_id)
+        @local_config.write(force: true)
+      end
+
+      def create_global_config
+        api_key = prompt.ask 'Please provide the api key:'
+        @config.set(project_id, :api_key, value: api_key)
+        @config.write(force: true)
+      end
+
+      def project_id
+        return @project_id if @project_id
+        @project_id = prompt.ask "Please provide this project's id:"
+        @project_id
+      end
+    end
+  end
+end

data/lib/story_branch/commands/create.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module StoryBranch
+  module Commands
+    # Create command is used to create a branch from
+    # started stories in the tracker
+    class Create < StoryBranch::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(_input: $stdin, _output: $stdout)
+        require_relative '../main'
+        sb = StoryBranch::Main.new
+        sb.create_story_branch
+      end
+    end
+  end
+end

data/lib/story_branch/commands/finish.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module StoryBranch
+  module Commands
+    # Command to finish a story
+    class Finish < StoryBranch::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(_input: $stdin, _output: $stdout)
+        require_relative '../main'
+        sb = StoryBranch::Main.new
+        sb.story_finish
+      end
+    end
+  end
+end

data/lib/story_branch/commands/migrate.rb

@@ -0,0 +1,100 @@
+# 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".freeze
+      LOCAL_CONFIG_FILE = '.story_branch'.freeze
+      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

data/lib/story_branch/commands/start.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module StoryBranch
+  module Commands
+    # Command to start an estimated story
+    class Start < StoryBranch::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(_input: $stdin, _output: $stdout)
+        require_relative '../main'
+        sb = StoryBranch::Main.new
+        sb.story_start
+      end
+    end
+  end
+end

data/lib/story_branch/commands/unstart.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+
+module StoryBranch
+  module Commands
+    # Command to unstart a previously started story
+    class Unstart < StoryBranch::Command
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(_input: $stdin, _output: $stdout)
+        require_relative '../main'
+        sb = StoryBranch::Main.new
+        sb.story_unstart
+      end
+    end
+  end
+end