pivotal-github 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 539f3b0c8e216974b9bff5ef66acbd97e17e64fe
-  data.tar.gz: 40a1bfff6dc52af9f2408fccf0e33466cbf034ae
+  metadata.gz: 727659cf612b3572160046ca9f12608acf16698a
+  data.tar.gz: cc892a9b14ca4d3538d64b345d69c65825945fe8
 SHA512:
-  metadata.gz: 0a27676c8844b14de42dae831605bc89fd4a7b465edaca72b6b51dfab1bcf64ba25f3f0967bef7510711e99573befc95663f438dc90540602e79631ccafeb3cc
-  data.tar.gz: 9d4fa7934c92d112569eba79f0993e226abde76720d453be5b82af796ad50f94bc50eec501f6a673f4e192bd6647017b86e2e492bee0f0a60d0f104f63e50f17
+  metadata.gz: 0af10b8c3ef1fa9348d4aa4b06aee3bb552100258859a49af400ba809f79d286edf8b18f1a4066bc1322ece1a8ff686f0987d8724354ae5b5c07186a338306f2
+  data.tar.gz: 107f5d9c12867a47b3e548770cfe96fe1fc5ff5126859b70463101efc7599690a0d4ad46060491291b410fc0d2020895449acf0fdaa3c3069b462e0f7da4e3aa

data/README.md

@@ -147,6 +147,13 @@ The `story-open` command (no `git`) opens the current story in the default brows
 
     $ story-open
 
+### project-open
+
+The `project-open` command (no `git`) opens the current project in the default browser (OS X–only):
+
+    $ project-open
+
+`project-open` requires the existence of file containing the project id with filename `.project_id` in the project's root directory. If it doesn't exist, the user is prompted to create it, and for safety it is automatically added to the `.gitignore` file.
 
 ## Configuration
 

data/bin/project-open

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'pivotal-github/project_open'
+
+exit Command.run!(ProjectOpen, ARGV.dup)

data/lib/pivotal-github.rb

@@ -6,3 +6,4 @@ require "pivotal-github/story_merge"
 require "pivotal-github/story_open"
 require "pivotal-github/story_pull_request"
 require "pivotal-github/story_accept"
+require "pivotal-github/project_open"

data/lib/pivotal-github/config_files.rb

@@ -0,0 +1,45 @@
+module ConfigFiles
+
+  # Returns the Pivotal Tracker API token.
+  def api_token
+    config_filename('.api_token', 'your Pivotal tracker API token')
+  end
+
+  # Returns the Pivotal Tracker project id.
+  def project_id
+    config_filename('.project_id', 'the Pivotal tracker project id')
+  end
+
+  # Facilitate the creation of config variables based on files.
+  def config_filename(filename, description)
+    if File.exist?(filename)
+      add_to_gitignore(filename)
+      varname = '@' + filename.sub('.', '')
+      value = File.read(filename).strip
+      instance_variable_set(varname, value)
+    else
+      puts "Please create a file called '#{filename}'"
+      puts "containing #{description}."
+      add_to_gitignore(filename)
+      exit 1
+    end
+  end
+
+  private
+
+    # Adds a filename to the .gitignore file (if necessary).
+    # This is put in as a security precaution, especially to keep the
+    # Pivotal Tracker API key from leaking.
+    def add_to_gitignore(filename)
+      gitignore = '.gitignore'
+      if File.exist?(gitignore)
+        contents = File.read(gitignore)
+        unless contents =~ /#{filename}/
+          # Prepend a newline if the file doesn't end in a newline.
+          line = contents == contents.chomp ? "\n#{filename}" : filename
+          File.open(gitignore, 'a') { |f| f.puts(line) }
+          puts "Added #{filename} to .gitignore"
+        end
+      end
+    end
+end

data/lib/pivotal-github/project_open.rb

@@ -0,0 +1,18 @@
+require 'pivotal-github/command'
+require 'pivotal-github/config_files'
+
+class ProjectOpen < Command
+  include ConfigFiles
+
+  def project_url
+    "https://www.pivotaltracker.com/projects/#{project_id}"
+  end
+
+  def cmd
+    "open #{project_url}"
+  end
+
+  def run!
+    system cmd
+  end
+end

data/lib/pivotal-github/story_accept.rb

@@ -1,11 +1,13 @@
 require 'pivotal-github/command'
 require 'pivotal-github/story'
+require 'pivotal-github/config_files'
 require 'nokogiri'
 require 'net/http'
 require 'cgi'
 
 class StoryAccept < Command
   include Story
+  include ConfigFiles
 
   def parser
     OptionParser.new do |opts|
@@ -69,44 +71,6 @@ class StoryAccept < Command
     Nokogiri::XML(response.body).at_css('current_state').content == "accepted"
   end
 
-  def config_filename(filename, description)
-    if File.exist?(filename)
-      add_to_gitignore(filename)
-      varname = '@' + filename.sub('.', '')
-      value = File.read(filename).strip
-      instance_variable_set(varname, value)
-    else
-      puts "Please create a file called '#{filename}'"
-      puts "containing #{description}."
-      add_to_gitignore(filename)
-      exit 1
-    end
-  end
-
-  def api_token
-    config_filename('.api_token', 'your Pivotal tracker API token')
-  end
-
-  def project_id
-    config_filename('.project_id', 'the Pivotal tracker project id')
-  end
-
-  # Adds a filename to the .gitignore file (if necessary).
-  # This is put in as a security precaution, especially to keep the
-  # Pivotal Tracker API key from leaking.
-  def add_to_gitignore(filename)
-    gitignore = '.gitignore'
-    if File.exist?(gitignore)
-      contents = File.read(gitignore)
-      unless contents =~ /#{filename}/
-        # Prepend a newline if the file doesn't end in a newline.
-        line = contents == contents.chomp ? "\n#{filename}" : filename
-        File.open(gitignore, 'a') { |f| f.puts(line) }
-        puts "Added #{filename} to .gitignore"
-      end
-    end
-  end
-
   # Changes a story's state to **Accepted**.
   def accept!(story_id)
     accepted = "<story><current_state>accepted</current_state></story>"

data/lib/pivotal-github/version.rb

@@ -1,5 +1,5 @@
 module Pivotal
   module Github
-    VERSION = "1.1.7"
+    VERSION = "1.2.0"
   end
 end

data/spec/commands/project_open_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe ProjectOpen do
+
+  let(:command) { ProjectOpen.new }
+
+  it "should have a working project_url" do
+    expect { command.project_url }.not_to raise_error
+  end
+
+  context "with stubbed-out project_id" do
+    let(:project_id) { '6283185' }
+    before { command.stub(:project_id).and_return(project_id) }
+    let(:uri) { "https://www.pivotaltracker.com/projects/#{project_id}" }
+    subject { command }
+
+    its(:cmd) { should eq "open #{uri}" }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotal-github
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Hartl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git-utils
@@ -46,6 +46,7 @@ executables:
 - git-story-commit
 - git-story-merge
 - git-story-pull-request
+- project-open
 - story-open
 extensions: []
 extra_rdoc_files: []
@@ -63,11 +64,14 @@ files:
 - bin/git-story-commit
 - bin/git-story-merge
 - bin/git-story-pull-request
+- bin/project-open
 - bin/story-open
 - lib/pivotal-github.rb
 - lib/pivotal-github/command.rb
+- lib/pivotal-github/config_files.rb
 - lib/pivotal-github/finished_command.rb
 - lib/pivotal-github/options.rb
+- lib/pivotal-github/project_open.rb
 - lib/pivotal-github/story.rb
 - lib/pivotal-github/story_accept.rb
 - lib/pivotal-github/story_commit.rb
@@ -77,6 +81,7 @@ files:
 - lib/pivotal-github/version.rb
 - pivotal-github.gemspec
 - spec/commands/command_spec.rb
+- spec/commands/project_open_spec.rb
 - spec/commands/story_accept_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb
@@ -110,6 +115,7 @@ specification_version: 4
 summary: See the README for full documentation
 test_files:
 - spec/commands/command_spec.rb
+- spec/commands/project_open_spec.rb
 - spec/commands/story_accept_spec.rb
 - spec/commands/story_commit_spec.rb
 - spec/commands/story_merge_spec.rb