pgit 0.0.3 → 0.0.4

data/spec/pgit/configuration_spec.rb

@@ -1,4 +1,4 @@
-require 'pgit'
+require 'spec_helper'
 
 describe 'PGit::Configuration' do
   describe '.default_options' do
@@ -20,139 +20,37 @@ describe 'PGit::Configuration' do
       expect(default_options['projects']).to match_array(example_projects)
     end
   end
-  describe '#new(configuration_path)' do
-    describe 'empty' do
-      it 'should complain that there should be at least one project' do
-        fake_path = "~/some/config/path.yml"
-        fake_expanded_path = "/Users/edderic/some/config/path.yml"
-        fake_file = double('file')
-        fake_yaml = {}
-        error_message = <<-ERROR
-          Error: /Users/edderic/some/config/path.yml needs at least one project.
-          Please have the following layout:
-          ---
-          projects:
-          - api_token: somepivotalatoken124
-            id: '12345'
-            path: "~/some/path/to/a/pivotal-git/project"
-          - api_token: somepivotalatoken124
-            id: '23429070'
-            path: "~/some/other/pivotal-git/project"
-        ERROR
 
-        allow(File).to receive(:expand_path).with(fake_path).and_return(fake_expanded_path)
-        allow(File).to receive(:expand_path).with('.')
-        allow(File).to receive(:exists?).with(fake_expanded_path).and_return(true)
-        allow(File).to receive(:open).with(fake_expanded_path, 'r').and_return(fake_file)
-        allow(YAML).to receive(:load).with(fake_file).and_return(fake_yaml)
-        error_message.gsub!(/^\s{10}/,'')
-
-        expect{ PGit::Configuration.new(fake_path) }.to raise_error(error_message)
-      end
-    end
-
-    describe 'has projects but is missing a token' do
-      it 'should raise an error' do
-        fake_path = "~/some/config/path.yml"
-        fake_expanded_path = "/Users/edderic/some/config/path.yml"
-        fake_file = double('file')
-        fake_projects = [ { path: 'fake_path',
-                            api_token: 'fake_token'
-                          }]
-        fake_yaml = { 'projects' => fake_projects }
-
-        allow(File).to receive(:expand_path).with(fake_path).and_return(fake_expanded_path)
-        allow(File).to receive(:expand_path).with('.')
-        allow(File).to receive(:exists?).with(fake_expanded_path).and_return(true)
-        allow(File).to receive(:open).with(fake_expanded_path, 'r').and_return(fake_file)
-        allow(YAML).to receive(:load).with(fake_file).and_return(fake_yaml)
-        error_message = <<-ERROR
-          Error: Must have a path, id, and api_token for each project.
-          Please have the following layout:
-          ---
-          projects:
-          - api_token: somepivotalatoken124
-            id: '12345'
-            path: "~/some/path/to/a/pivotal-git/project"
-          - api_token: somepivotalatoken124
-            id: '23429070'
-            path: "~/some/other/pivotal-git/project"
-        ERROR
-        error_message.gsub!(/^\s{10}/, '')
+  describe '#new (without any arguments)' do
+    it 'should delegate the default path to PGit::Configuration::Validator instance' do
+      fake_validator = instance_double('PGit::Configuration::Validator')
+      allow(PGit::Configuration::Validator).to receive(:new).with("~/.pgit.rc.yml").and_return fake_validator
+      PGit::Configuration.new
 
-        expect{ PGit::Configuration.new(fake_path) }.to raise_error(error_message)
-      end
+      expect(PGit::Configuration::Validator).to have_received(:new).with("~/.pgit.rc.yml")
     end
   end
 
-  describe '#new(configuration_path)' do
-    describe 'configuration_path exists' do
-      it '#to_yaml should return the yaml file' do
-        fake_path = "~/some/config/path.yml"
-        fake_expanded_path = "/Users/edderic/some/config/path.yml"
-        fake_file = double('file')
-        fake_projects = [ { "path" => 'fake_path',
-                            "id" =>   'fake_id',
-                            "api_token" => 'fake_token'
-                          }]
+  describe '#new ("~/some/path")' do
+    it 'should delegate the path to PGit::Configuration::Validator instance' do
+      fake_validator = instance_double('PGit::Configuration::Validator')
+      fake_path = "~/some/path"
+      allow(PGit::Configuration::Validator).to receive(:new).with(fake_path).and_return fake_validator
+      PGit::Configuration.new(fake_path)
 
-        fake_yaml = { 'projects' => fake_projects }
-
-        allow(File).to receive(:expand_path).with(fake_path).and_return(fake_expanded_path)
-        allow(File).to receive(:exists?).with(fake_expanded_path).and_return(true)
-        allow(File).to receive(:open).with(fake_expanded_path, 'r').and_return(fake_file)
-        allow(YAML).to receive(:load).with(fake_file).and_return(fake_yaml)
-
-        configuration = PGit::Configuration.new(fake_path)
-
-        expect(configuration.to_yaml).to eq fake_yaml
-      end
-    end
-
-    describe 'configuration path does not exist' do
-      it 'should throw an error' do
-        file_path = '~/.edderic-dotfiles/config/project.yml'
-        fake_expanded_path = "/home/edderic/.edderic-dotfiles/config/project.yml"
-        error_message = "No such file or directory. Please give a valid path to the project.yml"
-        allow(File).to receive(:exists?).and_return(false)
-
-        expect{ PGit::Configuration.new(file_path) }.to raise_error
-      end
+      expect(PGit::Configuration::Validator).to have_received(:new).with(fake_path)
     end
   end
 
-  describe '#new (without any arguments)' do
-    describe 'default configuration_path does exist' do
-      it 'should load the default configuration file' do
-        default_path = "~/.pgit.rc.yml"
-        default_expanded_path = "/Users/edderic/.pgit.rc.yml"
-        fake_file = double('file')
-
-        fake_projects = [ { "path" => 'fake_path',
-                            "id" =>   'fake_id',
-                            "api_token" => 'fake_token'
-                          }]
-
-        fake_yaml = { 'projects' => fake_projects }
-
-        allow(File).to receive(:exists?).with(default_expanded_path).and_return(true)
-        allow(File).to receive(:expand_path).with(default_path).and_return(default_expanded_path)
-        allow(File).to receive(:open).with(default_expanded_path, 'r').and_return(fake_file)
-        allow(YAML).to receive(:load).with(fake_file).and_return(fake_yaml)
-
-        configuration = PGit::Configuration.new
-
-        expect(File).to have_received(:expand_path).with(default_path)
-      end
-    end
-
-    describe 'default configuration file does not exist' do
-      it 'should throw an error' do
-        allow(File).to receive(:exists?).and_return(false)
+  describe '#to_yaml' do
+    it 'should delegate #yaml to validator' do
+      fake_validator = instance_double('PGit::Configuration::Validator')
+      allow(fake_validator).to receive(:yaml)
+      allow(PGit::Configuration::Validator).to receive(:new).with("~/.pgit.rc.yml").and_return fake_validator
+      configuration = PGit::Configuration.new
+      configuration.to_yaml
 
-        error_message =  "Default configuration file does not exist. Please run `pgit install`"
-        expect{ PGit::Configuration.new }.to raise_error(error_message)
-      end
+      expect(fake_validator).to have_received(:yaml)
     end
   end
 end

data/spec/pgit/current_branch_spec.rb

@@ -1,4 +1,4 @@
-require 'pgit'
+require 'spec_helper'
 
 describe 'PGit::CurrentBranch' do
   describe '#name' do

data/spec/pgit/current_project/no_paths_match_working_dir_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'PGit::CurrentProject::NoPathsMatchWorkingDirError' do
+  it 'should have PGit::Error as an ancestor' do
+    ancestors = PGit::CurrentProject::NoPathsMatchWorkingDirError.ancestors
+
+    expect(ancestors).to include PGit::Error
+  end
+
+  it 'should have the appropriate message' do
+    matches = []
+    error = PGit::CurrentProject::NoPathsMatchWorkingDirError.new
+    message = error.instance_eval { @message }
+
+    expect(message).to eq "None of the project paths matches the working directory"
+  end
+end

data/spec/pgit/current_project/validator_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'PGit::CurrentProject::Validator' do
+  it 'should raise an error if there are no matching projects' do
+    matching_projects = []
+
+    expect do
+      PGit::CurrentProject::Validator.new(matching_projects)
+    end.to raise_error PGit::CurrentProject::NoPathsMatchWorkingDirError
+  end
+end

data/spec/pgit/current_project_spec.rb

@@ -1,4 +1,4 @@
-require 'pgit'
+require 'spec_helper'
 # .edderic-dotfiles/config.yml
 # projects
 #   - path:                  ~/Therapy-Exercises-Online
@@ -22,25 +22,24 @@ end
 
 describe 'PGit::CurrentProject' do
   describe '#new(config_yaml)' do
-    describe 'none of the projects listed matches the working directory' do
-      it 'should throw an error' do
-        error_message = "None of the project paths matches the working directory"
-        fake_project_1 =  { "path" => "~/some-non-matching-path",
-                            "id" => 12345,
-                            "api_token" => "astoeuh" }
-        fake_project_2 =  { "path" => "~/some-other-non-matching-path",
-                            "id" => 19191,
-                            "api_token" => "astoeuh" }
-        fake_project_list = [ fake_project_1, fake_project_2 ]
-        fake_yaml = { "projects" => fake_project_list }
-        fake_pwd = "/Therapy-Exercises-Online/some_other_project/some_subdirectory"
-        fake_configuration = double('configuration', to_yaml: fake_yaml)
-        allow(Dir).to receive(:pwd).and_return(fake_pwd)
+    it 'should delegate to PGit::CurrentProject::Validator' do
+      fake_project_1 =  { "path" => "~/some-non-matching-path",
+                          "id" => 12345,
+                          "api_token" => "astoeuh" }
+      fake_project_2 =  { "path" => "~/some-other-non-matching-path",
+                          "id" => 19191,
+                          "api_token" => "astoeuh" }
+      fake_project_list = [ fake_project_1, fake_project_2 ]
+      fake_yaml = { "projects" => fake_project_list }
+      fake_pwd = "/Therapy-Exercises-Online/some_other_project/some_subdirectory"
+      fake_configuration = double('configuration', to_yaml: fake_yaml)
+      allow(Dir).to receive(:pwd).and_return(fake_pwd)
+      allow(PGit::CurrentProject::Validator).to receive(:new).with []
 
-        expect{ PGit::CurrentProject.new(fake_configuration.to_yaml) }.to raise_error(error_message)
-      end
-    end
+      PGit::CurrentProject.new(fake_configuration.to_yaml)
 
+      expect(PGit::CurrentProject::Validator).to have_received(:new).with []
+    end
   end
 
   describe '#pwd' do

data/spec/pgit/external_error_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'PGit::ExternalError' do
+  it 'should take in the response' do
+    response = '{
+      "code": "unfound_resource",
+      "kind": "error",
+      "error": "The object you tried to access could not be found.  It may have been removed by another user, you may be using the ID of another object type, or you may be trying to access a sub-resource at the wrong point in a tree."
+    }'
+    external_error = PGit::ExternalError.new(response)
+    message = external_error.instance_eval { @message }
+
+    expect(message).to eq(response)
+  end
+
+  it 'should inherit from PGit::Error' do
+    ancestors = PGit::ExternalError.ancestors
+
+    expect(ancestors).to include PGit::Error
+  end
+end

data/spec/pgit/installer/configuration_spec.rb

@@ -0,0 +1,162 @@
+require 'pgit'
+
+describe 'PGit::Installer::Configuration' do
+  describe '::FILEPATH' do
+    it 'should eq ~/.pgit.rc.yml' do
+      expect(PGit::Installer::Configuration::FILEPATH).to eq '~/.pgit.rc.yml'
+    end
+  end
+
+  describe "#{PGit::Installer::Configuration::FILEPATH} exists" do
+    it 'should say that the file already exists' do
+      global_opts = {}
+      opts = { }
+      args = {}
+      message = "#{PGit::Installer::Configuration::FILEPATH} already exists"
+      default_file_path = "#{PGit::Installer::Configuration::FILEPATH}"
+      file_expanded_path = "/home/edderic/.pgit.rc.yml"
+
+      allow(File).to receive(:expand_path).
+        with(".")
+      allow(File).to receive(:expand_path).
+        with(default_file_path).and_return(file_expanded_path)
+      allow(File).to receive(:exists?).
+        with(file_expanded_path).and_return(true)
+      allow_any_instance_of(PGit::Installer::Configuration).to receive(:warn).with(message)
+
+      installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+      expect(installer).to have_received(:warn).with(message)
+    end
+  end
+
+  describe '~/pgit.rc.yml does not exist' do
+    it 'should ask to continue or not' do
+      global_opts = {}
+      opts = { }
+      args = {}
+
+      message = "*** Installing example pgit configuration file under #{PGit::Installer::Configuration::FILEPATH}. " +
+        "Continue? [Y/n]"
+      confirmation_message = "Saving example pgit config in #{PGit::Installer::Configuration::FILEPATH}..."
+      edit_message = "Saved! Please edit #{PGit::Installer::Configuration::FILEPATH} and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+      answer = instance_double("String", chomp: 'y')
+      expanded_path = "/home/edderic/.pgit.rc.yml"
+      fake_writable_file = double('File')
+      allow(File).to receive(:expand_path).with("#{PGit::Installer::Configuration::FILEPATH}").and_return(expanded_path)
+      allow(File).to receive(:exists?).with(expanded_path).and_return(false)
+      allow(File).to receive(:open).with(expanded_path, 'w').and_return(fake_writable_file)
+      allow(STDIN).to receive(:gets).and_return(answer)
+      allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(message)
+      allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(confirmation_message)
+      allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(edit_message)
+      installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+      expect(installer).to have_received(:puts).with(message)
+    end
+
+    describe 'user answers "y"' do
+      it "should show the save message" do
+        global_opts = {}
+        opts = { }
+        args = {}
+
+        first_message = "*** Installing example pgit configuration file under #{PGit::Installer::Configuration::FILEPATH}. " +
+          "Continue? [Y/n]"
+        save_message = "Saving example pgit config in #{PGit::Installer::Configuration::FILEPATH}..."
+        expanded_path = "/home/edderic/.pgit.rc.yml"
+        edit_message = "Saved! Please edit #{PGit::Installer::Configuration::FILEPATH} and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+        fake_writable_file = double('File')
+        allow(File).to receive(:expand_path).with("#{PGit::Installer::Configuration::FILEPATH}").and_return(expanded_path)
+        allow(File).to receive(:exists?).with(expanded_path).and_return(false)
+        allow(File).to receive(:open).with(expanded_path, 'w').and_return(fake_writable_file)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(edit_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(first_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(save_message)
+
+        answer = instance_double("String", chomp: 'Y')
+        allow(STDIN).to receive(:gets).and_return(answer)
+
+        installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+        expect(installer).to have_received(:puts).with(save_message)
+      end
+
+      it "should save the file under #{PGit::Installer::Configuration::FILEPATH}" do
+        global_opts = {}
+        opts = { }
+        args = {}
+
+        first_message = "*** Installing example pgit configuration file under #{PGit::Installer::Configuration::FILEPATH}. " +
+          "Continue? [Y/n]"
+        save_message = "Saving example pgit config in #{PGit::Installer::Configuration::FILEPATH}..."
+        expanded_path = "/home/edderic/.pgit.rc.yml"
+        fake_writable_file = double('File')
+        edit_message = "Saved! Please edit #{PGit::Installer::Configuration::FILEPATH} and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+        allow(File).to receive(:expand_path).with(PGit::Installer::Configuration::FILEPATH).and_return(expanded_path)
+        allow(File).to receive(:exists?).with(expanded_path).and_return(false)
+        allow(File).to receive(:open).with(expanded_path, 'w').and_return(fake_writable_file)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(first_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(save_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(edit_message)
+
+        answer = instance_double("String", chomp: 'Y')
+        allow(STDIN).to receive(:gets).and_return(answer)
+
+        installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+        expect(File).to have_received(:open).with(expanded_path, 'w')
+      end
+
+      it 'should ask the user to edit the config file' do
+        global_opts = {}
+        opts = { }
+        args = {}
+
+        first_message = "*** Installing example pgit configuration file under #{PGit::Installer::Configuration::FILEPATH}. " +
+          "Continue? [Y/n]"
+        save_message = "Saving example pgit config in #{PGit::Installer::Configuration::FILEPATH}..."
+        edit_message = "Saved! Please edit #{PGit::Installer::Configuration::FILEPATH} and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+        expanded_path = "/home/edderic/.pgit.rc.yml"
+        fake_writable_file = double('File')
+        allow(File).to receive(:expand_path).with(PGit::Installer::Configuration::FILEPATH).and_return(expanded_path)
+        allow(File).to receive(:exists?).with(expanded_path).and_return(false)
+        allow(File).to receive(:open).with(expanded_path, 'w').and_return(fake_writable_file)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(first_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(edit_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(save_message)
+
+        answer = instance_double("String", chomp: 'Y')
+        allow(STDIN).to receive(:gets).and_return(answer)
+
+        installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+        expect(installer).to have_received(:puts).with(edit_message)
+      end
+    end
+
+    describe 'user answers with "n"' do
+      it "should show the abort message" do
+        message = "Aborting installation..."
+        global_opts = {}
+        opts = { }
+        args = {}
+
+        first_message = "*** Installing example pgit configuration file under #{PGit::Installer::Configuration::FILEPATH}. " +
+          "Continue? [Y/n]"
+        expanded_path = "/home/edderic/.pgit.rc.yml"
+        allow(File).to receive(:expand_path).with("#{PGit::Installer::Configuration::FILEPATH}").and_return(expanded_path)
+        allow(File).to receive(:exists?).with(expanded_path).and_return(false)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(first_message)
+        allow_any_instance_of(PGit::Installer::Configuration).to receive(:puts).with(message)
+
+        answer = instance_double("String", chomp: 'n')
+        allow(STDIN).to receive(:gets).and_return(answer)
+
+        installer = PGit::Installer::Configuration.new(global_opts, opts, args)
+
+        expect(installer).to have_received(:puts).with(message)
+      end
+    end
+  end
+end

data/spec/pgit/pgit_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+
 describe 'pgit' do
   describe 'story_branch' do
     it 'should output the help info for story_branch command' do

data/spec/pgit/pivotal_request_validator_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe 'PGit::PivotalRequestValidator' do
+  describe 'when the request has an "error" but "kind" is not "error"' do
+    it 'should not raise an error' do
+      request = <<-REQUEST
+        {
+          "kind": "story",
+          "id": 84538682,
+          "project_id": 1228944,
+          "name": "Don't just use regex to match the whole JSON string response for the word \"error\".",
+          "description": " If \"kind\" of the get response is \"error\", throw an error.",
+          "story_type": "bug",
+          "current_state": "started",
+          "requested_by_id": 1121520,
+          "owned_by_id": 1121520,
+          "owner_ids": [ 1121520 ],
+          "labels": [ ],
+          "created_at": "2014-12-14T15:11:46Z",
+          "updated_at": "2014-12-15T12:04:13Z",
+          "url": "https://www.pivotaltracker.com/story/show/84538682"
+        }
+      REQUEST
+
+      expect do
+        PGit::PivotalRequestValidator.new(request)
+      end.not_to raise_error
+    end
+  end
+
+  describe 'when the request has "kind": "error"' do
+    it 'should raise an error' do
+      request = <<-REQUEST
+        {
+          "code": "unfound_resource",
+          "kind": "error",
+          "error": "The object you tried to access could not be found.  It may have been removed by another user, you may be using the ID of another object type, or you may be trying to access a sub-resource at the wrong point in a tree."
+        }
+      REQUEST
+
+      expect do
+        PGit::PivotalRequestValidator.new(request)
+      end.to raise_error(PGit::ExternalError)
+    end
+  end
+
+  describe 'when the request has no "kind"' do
+    it 'should raise a PGit::ExternalError' do
+      request = <<-REQUEST
+        some unrecognizable request
+      REQUEST
+
+      expect do
+        PGit::PivotalRequestValidator.new(request)
+      end.to raise_error(PGit::ExternalError)
+    end
+  end
+
+  describe '#request' do
+    it 'should return the passed request when there is no error' do
+      request = <<-REQUEST
+        {
+          "kind": "story",
+          "id": 84538682,
+          "project_id": 1228944,
+          "name": "Don't just use regex to match the whole JSON string response for the word \"error\".",
+          "description": " If \"kind\" of the get response is \"error\", throw an error.",
+          "story_type": "bug",
+          "current_state": "started",
+          "requested_by_id": 1121520,
+          "owned_by_id": 1121520,
+          "owner_ids": [ 1121520 ],
+          "labels": [ ],
+          "created_at": "2014-12-14T15:11:46Z",
+          "updated_at": "2014-12-15T12:04:13Z",
+          "url": "https://www.pivotaltracker.com/story/show/84538682"
+        }
+      REQUEST
+
+      validator = PGit::PivotalRequestValidator.new(request)
+      filtered_request = validator.request
+
+      expect(filtered_request).to eq request
+    end
+  end
+end