atlassian-stash 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88ec40d66199da9b5b268bbf2979dc9301a9970f
-  data.tar.gz: dad20552d00e8a88030ee8cfedc4b840b66a590c
+  metadata.gz: 004918119e117aac4f9359f4820c9b81c5adfa82
+  data.tar.gz: f6fc3a770ad9348126ff3ce781292218f7dd564a
 SHA512:
-  metadata.gz: ccf0058dcaf1725426abd151c0ddad4bbcc7fd62e7e440fb23e519cdd95a7e9b2735dd1ee23302324492fe967ab6764418c4f12e7b3c20159274f43f822f691f
-  data.tar.gz: 48990c6d3c68ef2db1c598cb74675a6e0c58348986aad23160ef275df275d6243a2b63d99588fe9a63f635e3e642705a3d2aed0a77c47f42737be5f9dcc3515a
+  metadata.gz: 9be92ea03f9de591a0d49aa7f2d160eb3557586b6ea2d8bf6cd047e0769941dd7fe408ddd496332bdd5b2984bcf0dcf089c8b202d17a68450290adac5645e2d2
+  data.tar.gz: 590e8c86f39160ab38e402a7f5ddeb61ec0fdee929aca5929d6cf1aac13c343c63b004355959615d3bd240031f12284beb38dcd8829a63b4687011ac0ac9708a

data/README.md

@@ -1,9 +1,9 @@
-# Atlassian Stash Command Line Tools
+# Bitbucket Server Command Line Tools
 
 [ ![Build Status](https://codeship.com/projects/813f7dc0-2924-0133-5117-3e546cad586a/status?branch=master)](https://codeship.com/projects/97914)
 
 ## Installing this tool
-This command line helper for Stash is written in Ruby and is deployed as a [Ruby Gem](https://rubygems.org/gems/atlassian-stash/). Installation is easy, simply run the following command
+This command line helper for Bitbucket Server is written in Ruby and is deployed as a [Ruby Gem](https://rubygems.org/gems/atlassian-stash/). Installation is easy, simply run the following command
 
 ```
 #!text
@@ -15,7 +15,7 @@ $> gem install atlassian-stash
 Once the gem is installed, the command `stash` will be in your `$PATH`
 
 ## Configuration and usage
-Run `stash configure`. This will prompt for details about your Stash instance. If no password is provided, then you will be prompted for a password when executing commands to Stash.
+Run `stash configure`. This will prompt for details about your Bitbucket Server instance. If no password is provided, then you will be prompted for a password when executing commands to Bitbucket Server.
 
 The global configuration file lives at `$HOME/.stashconfig.yml` and any options in a similarly named `.stashconfig.yml` file in the root of a git repository will take precedence.
 
@@ -36,7 +36,7 @@ The `stash configure` utility will not prompt you for this. If you wish to use `
 
 
 ### Creating a pull request
-Use the `pull-request` command to create a pull request in Stash. For example:
+Use the `pull-request` command to create a pull request in Bitbucket Server. For example:
 
 ```
 #!text
@@ -51,13 +51,13 @@ See the usage for command details
 $> stash help pull-request
 ```
 
-### Opening the Stash web UI
-Use the `browse` command to open the Stash UI for your repository in the browser.
+### Opening the Bitbucket Server web UI
+Use the `browse` command to open the Bitbucket Server UI for your repository in the browser.
 
 ```
 #!text
 $> stash browse -b develop
-Open the browser at the Stash repository page for the branch 'develop'
+Open the browser at the Bitbucket Server repository page for the branch 'develop'
 ```
 
 For more options, see the help
@@ -73,12 +73,12 @@ Running `stash configure` will prepopulate `~/.stashconfig.yml` with a variety o
 
 ```
 #!yaml
-username: seb # username to connect to stash server.
-password: s3cr3t # password for user. If ommitted, you will be prompted at the terminal when making a request to Stash
-stash_url: https://stash.server.com # fully qualified stash url
-remote: upstream # Pull requests will be created in the Stash repository specified by this remote
+username: seb # username to connect to Bitbucket Server server.
+password: s3cr3t # password for user. If ommitted, you will be prompted at the terminal when making a request to Bitbucket Server
+stash_url: https://bitbucket.server.com # fully qualified Bitbucket Server url
+remote: upstream # Pull requests will be created in the Bitbucket Server repository specified by this remote
 open: true # opens newly created pull requests in the browser
-ssl_no_verify: true # do not check ssl certificates for the configured stash server
+ssl_no_verify: true # do not check ssl certificates for the configured Bitbucket Server server
 ```
 
 ## Troubleshooting

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "atlassian-stash"
   gem.homepage = "https://bitbucket.org/atlassian/stash-command-line-tools"
   gem.license = "MIT"
-  gem.summary = "Command line tools for Atlassian Stash"
-  gem.description = "Provides convenient functions for interacting with Atlassian Stash through the command line" 
+  gem.summary = "Command line tools for Bitbucket Server"
+  gem.description = "Provides convenient functions for interacting with Bitbucket Server through the command line" 
   gem.email = "sruiz@atlassian.com"
   gem.authors = ["Seb Ruiz"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/bin/stash

@@ -9,7 +9,7 @@ require 'pathname'
 
 program :name, "Atlassian Stash CLI"
 program :version, Atlassian::Stash::Version::STRING
-program :description, "Provides convenient functions for interacting with Atlassian Stash through the command line"
+program :description, "Provides convenient functions for interacting with Atlassian Bitbucket Server through the command line"
 
 include Atlassian::Stash
 include Atlassian::Stash::Git
@@ -18,7 +18,7 @@ $configFileName = ".stashconfig.yml"
 $configFile = File.join(ENV['HOME'], $configFileName)
 
 def load_config
-  raise "No Stash configuration found; please run configure" unless File.exists? $configFile
+  raise "No Bitbucket Server configuration found; please run configure" unless File.exists? $configFile
   config = YAML.load_file($configFile)
   raise "Stash configuration file is incomplete, please re-run configure" unless config['username'] and config['stash_url']
 
@@ -44,16 +44,16 @@ end
 
 command 'configure' do |c|
   c.syntax = 'configure'
-  c.description = 'Setup configuration details to your Stash instance'
-  c.example 'stash configure --username sebr --password s3cre7 --stash_url http://stash.mycompany.com', 'Setup Stash CLI with credentials to the Stash server'
-  c.option '--username user', String, 'Writes your Stash username to the configuration file'
-  c.option '--password password', String, 'Writes your Stash user password to the configuration file. If omitted, password will be prompted to be entered'
-  c.option '--stashUrl', String, 'Writes the Stash server url to the configuration file'
-  c.option '--remote', String, 'Pull requests will be created in the Stash repository specified by the given remote'
+  c.description = 'Setup configuration details to your Bitbucket Server instance'
+  c.example 'stash configure --username sebr --password s3cre7 --stashUrl http://bitbucket.mycompany.com', 'Setup Bitbucket Server CLI with credentials to the Bitbucket Server instance'
+  c.option '--username user', String, 'Writes your Bitbucket Server username to the configuration file'
+  c.option '--password password', String, 'Writes your Bitbucket Server user password to the configuration file. If omitted, password will be prompted to be entered'
+  c.option '--stashUrl url', String, 'Writes the Bitbucket Server hostname to the configuration file'
+  c.option '--remote remote', String, 'Pull requests will be created in the Bitbucket Server repository specified by the given remote'
   c.action do |args, options|
-    username = options.username ? options.username : ask("Stash Username: ")
-    password = options.password ? options.password : ask("Stash Password (optional): ") { |q| q.echo = "*" }
-    stashUrl = options.stashUrl ? options.stashUrl : ask("Stash URL: ")
+    username = options.username ? options.username : ask("Bitbucket Server Username: ")
+    password = options.password ? options.password : ask("Bitbucket Server Password (optional): ") { |q| q.echo = "*" }
+    stashUrl = options.stashUrl ? options.stashUrl : ask("Bitbucket Server URL: ")
     remote   = options.remote   ? options.remote   : ask("Remote (optional): ")
 
     c = {
@@ -83,10 +83,10 @@ command 'pull-request' do |c|
   end
 
   c.syntax = 'pull-request [sourceBranch] targetBranch [@reviewer1 @reviewer2] [options]'
-  c.description = 'Create a pull request in Stash'
+  c.description = 'Create a pull request in Bitbucket Server'
   c.option '-d DESCRIPTION', '--description DESCRIPTION', String, 'Use the following description when creating the pull request'
   c.option '-T TITLE', '--title TITLE', String, 'Use the following title when creating the pull request'
-  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Stash repository specified by the given remote'
+  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Bitbucket Server repository specified by the given remote'
   c.option '-o', '--open', 'Open the created pull request page in a web browser'
   c.example 'stash pull-request topicBranch master @michael', "Create a pull request from branch 'topicBranch' into 'master' with 'michael' added as a reviewer"
   c.example 'stash pull-request master', "Create a pull request from the current git branch into 'master'"
@@ -147,16 +147,19 @@ command 'pull-request' do |c|
 end
 
 command 'browse' do |c|
-  c.syntax = 'browse [browse|commits|pull-requests]'
-  c.description = 'Open the Stash web ui for this repository'
-  c.option '-b branch', '--branch branch', String, 'Open the Stash web ui at the specified branch, tag or commit hash. Defaults to the current branch'
-  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Stash repository specified by the given remote'
+  c.syntax = 'browse [browse|commits|pull-requests] [path]'
+  c.description = 'Open the Bitbucket Server web ui for this repository'
+  c.option '-b branch', '--branch branch', String, 'Open the Bitbucket Server web ui at the specified branch, tag or commit hash. Defaults to the current branch'
+  c.option '-r remote', '--remote remote', String, 'Creates the pull request in the Bitbucket Server repository specified by the given remote'
+  c.option '-l lineNumber', '--lineNumber lineNumber', Integer, 'Open the Bitbucket Server web ui at the specified file, highlighting the specified line number. Valid only when used with browse when path is specified'
   c.example 'stash browse -b master', 'Open the files view for this repository at the current branch'
   c.example 'stash browse -r upstream', 'Open the files view for the "upstream" remote repository'
+  c.example 'stash browse browse -l 42 path/to/a/file', 'Open the files view for this repository at the specified file on the current branch, highlighting the specified line'
 
   c.action do |args, options|
 
     tab = args.shift unless args.empty?
+    path = args.shift unless args.empty?
 
     config = load_config
 
@@ -164,13 +167,18 @@ command 'browse' do |c|
 
     branch = options.branch || get_current_branch
 
-    Launchy.open repoInfo.repoUrl(tab, branch)
+    if tab == 'browse' && path
+      url = repoInfo.repoUrl(tab, branch, filePath: path, lineNumber: options.lineNumber)
+    else
+      url = repoInfo.repoUrl(tab, branch)
+    end
+    Launchy.open url
   end
 end
 
 
 default_command :help
-program :help_formatter, :compact
+#program :help_formatter, :compact
 program :help, 'Authors', 'Seb Ruiz <sruiz@atlassian.com>'
 program :help, 'Website', 'https://bitbucket.org/atlassian/stash-command-line-tools'
 

data/lib/atlassian/stash/repo_info.rb

@@ -23,11 +23,13 @@ module Atlassian
         repoPath
       end
 
-      def repoUrl(suffix, branch)
+      def repoUrl(suffix, branch, options = {})
+        filePath = options[:filePath]
+        lineNumber = options[:lineNumber]
         uri = URI.parse(@config["stash_url"])
-        path = repoPath + (suffix.nil? ? '' : '/' + suffix)
-        uri.path = path
-        
+        uri.path = repoPath + (suffix.nil? ? '' : '/' + suffix)
+        uri = RepoInfo.appendFilePathAndFragment(uri, filePath, lineNumber)
+
         if (!branch.nil? and !branch.empty?)
             q = uri.query || ''
             q = q + (q.empty? ? '' : '&') + 'at=' + branch unless branch.nil?
@@ -37,6 +39,18 @@ module Atlassian
         uri.to_s
       end
 
+      def self.appendFilePathAndFragment(uri, filePath, lineNumber)
+        if filePath && !filePath.empty?
+          uri.path = uri.path + (filePath.start_with?('/') ? filePath : "/#{filePath}")
+
+          if lineNumber && !lineNumber.nil?
+            uri.fragment = lineNumber.to_s
+          end
+        end
+
+        uri
+      end
+
       def self.create (config, remote=nil)
         config = Hash.new if config.nil?
         remote = config["remote"] if (remote.nil? || remote.empty?)

data/test/test_stash-repo-info.rb

@@ -84,6 +84,22 @@ class TestStashRepoInfo < Minitest::Test
       assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash', ri.repoUrl(nil, nil)
     end
 
+    should "create expected repo url with context, branch and filePath" do
+      config = {
+        'stash_url' => 'https://www.stash.com/foo'
+      }
+      ri = RepoInfo.create config
+      assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash/browse/path/to/file?at=develop', ri.repoUrl('browse', 'develop', filePath: 'path/to/file')
+    end
+
+    should "create expected repo url with context, branch, filePath and lineNumber" do
+      config = {
+        'stash_url' => 'https://www.stash.com/foo'
+      }
+      ri = RepoInfo.create config
+      assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash/browse/path/to/file?at=develop#1337', ri.repoUrl('browse', 'develop', filePath: 'path/to/file', lineNumber: 1337)
+    end
+
     should "create expected repo url with path and branch" do
       config = {
         'stash_url' => 'https://www.stash.com/foo'
@@ -99,5 +115,65 @@ class TestStashRepoInfo < Minitest::Test
       ri = RepoInfo.create config
       assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash/commits?git=ftw&at=develop', ri.repoUrl('commits', 'develop')
     end
+
+    should "create expected repo url with context, query, path, branch and filePath" do
+      config = {
+        'stash_url' => 'https://www.stash.com/foo?git=ftw'
+      }
+      ri = RepoInfo.create config
+      assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash/browse/path/to/file?git=ftw&at=develop', ri.repoUrl('browse', 'develop', filePath: 'path/to/file')
+    end
+
+    should "create expected repo url with context, query, branch, filePath and lineNumber" do
+      config = {
+        'stash_url' => 'https://www.stash.com/foo?git=ftw'
+      }
+      ri = RepoInfo.create config
+      assert_equal 'https://www.stash.com/foo/projects/STASH/repos/stash/browse/path/to/file?git=ftw&at=develop#1337', ri.repoUrl('browse', 'develop', filePath: 'path/to/file', lineNumber: 1337)
+    end
+  end
+
+  context "append file path and line number to uri" do
+    should 'Append a file path to the specified uri' do
+      uri = URI.parse('http://example.com/browse')
+      expected = 'http://example.com/browse/path/to/file'
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, 'path/to/file', nil).to_s
+    end
+
+    should 'Append a file path with leading slash to the specified uri' do
+      uri = URI.parse('http://example.com/browse')
+      expected = 'http://example.com/browse/path/to/file'
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, '/path/to/file', nil).to_s
+    end
+
+    should 'Append a file path and line number to the specified uri' do
+      uri = URI.parse('http://example.com/browse')
+      expected = 'http://example.com/browse/path/to/file#1337'
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, 'path/to/file', 1337).to_s
+    end
+
+    should 'Append a file path with leading slash and line number to the specified uri' do
+      uri = URI.parse('http://example.com/browse')
+      expected = 'http://example.com/browse/path/to/file#1337'
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, '/path/to/file', 1337).to_s
+    end
+
+    should 'Return the specified uri unmodified if both filePath and lineNumber is nil' do
+      expected = 'http://example.com/browse'
+      uri = URI.parse(expected)
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, nil, nil).to_s
+    end
+
+    should 'Return the specified uri unmodified if filePath is the empty string and lineNumber is nil' do
+      expected = 'http://example.com/browse'
+      uri = URI.parse(expected)
+
+      assert_equal expected, RepoInfo.appendFilePathAndFragment(uri, '', nil).to_s
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlassian-stash
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Seb Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-23 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -178,7 +178,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides convenient functions for interacting with Atlassian Stash through
+description: Provides convenient functions for interacting with Bitbucket Server through
   the command line
 email: sruiz@atlassian.com
 executables:
@@ -229,5 +229,5 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Command line tools for Atlassian Stash
+summary: Command line tools for Bitbucket Server
 test_files: []