pgit 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11d6044b7f8bd8030a10c3e563eafbf594a498f
-  data.tar.gz: 517300daf5c4126e417940f0af925e669a65f0bb
+  metadata.gz: d736adc51cc2cda472f63edadcddd766f7ad22a2
+  data.tar.gz: 2b7e43a567cb947507d4d1d1cd4c0704a02af14c
 SHA512:
-  metadata.gz: 4649d681d4b7e8dbbfcfe33e6ce55ae113bf4ec7e8bbef9db81f5944738a1b196f36ab9d14971892d38a6d2c3e52d314393a7d02f692d558cc07c360ed55c7f7
-  data.tar.gz: 32e1abf53d85783fa22004377823035bc0ac6ca527d5c2a45af4befceb28b17eec0324ed8269d78014d00dda283750aebf21c547619e1e9392421b4025dc3c07
+  metadata.gz: 7c30a313b05b8940dc915c14f13c9e36621c7c876dd1b8121d23d16d0a7d2bc74d39062e1543184cb3fd5bf9f2bfdb7c39cb81184a42aa48f0a2cc4292a67a72
+  data.tar.gz: e811579cab502fd70ed1dda709637222f42036e04fd8702636da4d99319236d27876a2bc44302adf9cb6b0d66a159bf1501e5c6a12183c5eab4170fa6c3e93e1

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/README.markdown

@@ -1,7 +1,10 @@
 # PGit
 
 ![Travis CI Build](https://travis-ci.org/Edderic/pgit.svg?branch=master)
+[![Gem Version](https://badge.fury.io/rb/pgit.svg)](http://badge.fury.io/rb/pgit)
 [![Code Climate](https://codeclimate.com/github/Edderic/pgit/badges/gpa.svg)](https://codeclimate.com/github/Edderic/pgit)
+[![Coverage Status](https://coveralls.io/repos/Edderic/pgit/badge.png?branch=master)](https://coveralls.io/r/Edderic/pgit?branch=master)
+
 ## Example Usage
 
 Assuming that:

data/bin/pgit

@@ -25,7 +25,7 @@ arguments :strict
 desc "Installs the pgit configuration file"
 command :install do |c|
   c.action do |global_options,options,args|
-    PGit::Installer.new(global_options, options, args)
+    PGit::Installer::Configuration.new(global_options, options, args)
   end
 end
 

data/lib/pgit.rb

@@ -1,9 +1,19 @@
 require 'json'
+require 'pgit/error'
+require 'pgit/configuration/layout_error'
+require 'pgit/configuration/not_found_error'
+require 'pgit/configuration/project_missing_error'
+require 'pgit/configuration/missing_attributes_error'
+require 'pgit/configuration/validator'
 require 'pgit/configuration'
 require 'pgit/current_branch'
+require 'pgit/current_project/no_paths_match_working_dir_error'
+require 'pgit/current_project/validator'
 require 'pgit/current_project'
-require 'pgit/installer'
+require 'pgit/installer/configuration'
 require 'pgit/name_parser'
+require 'pgit/pivotal_request_validator'
+require 'pgit/external_error'
 require 'pgit/story'
 require 'pgit/story_branch'
 require 'pgit/story_branch/application'

data/lib/pgit/configuration.rb

@@ -26,52 +26,11 @@ module PGit
     end
 
     def initialize(config_path = '~/.pgit.rc.yml')
-      @expanded_path = File.expand_path(config_path)
-      if File.exists? @expanded_path
-        config_file = File.open(@expanded_path, 'r')
-        @yaml = YAML.load(config_file)
-
-        validate_existence_of_at_least_one_project
-        validate_presence_of_items_in_each_project
-      else
-        raise missing_config_default
-      end
+      @validator = PGit::Configuration::Validator.new(config_path)
     end
 
     def to_yaml
-      @yaml
-    end
-
-    private
-
-    def missing_config_default
-      "Default configuration file does not exist. Please run `pgit install`"
-    end
-
-    def general_error_message
-      "Please have the following layout:\n" + YAML.dump(PGit::Configuration.default_options)
-    end
-
-    def validate_presence_of_items_in_each_project
-      projects = @yaml["projects"]
-      all_present = projects.all? do |project|
-        project["api_token"] &&
-          project["path"] &&
-          project["id"]
-      end
-
-      unless all_present
-        raise "Error: Must have a path, id, and api_token for each project.\n" +
-          general_error_message
-      end
-    end
-
-    def validate_existence_of_at_least_one_project
-      unless @yaml["projects"]
-        raise "Error: #{@expanded_path} needs at least one project.\n" +
-          general_error_message
-
-      end
+      @validator.yaml
     end
   end
 end

data/lib/pgit/configuration/layout_error.rb

@@ -0,0 +1,9 @@
+module PGit
+  class Configuration
+    class LayoutError < PGit::Error
+      def prepend_general_message(message)
+        "#{message}\nPlease have the following layout:\n" + YAML.dump(PGit::Configuration.default_options)
+      end
+    end
+  end
+end

data/lib/pgit/configuration/missing_attributes_error.rb

@@ -0,0 +1,10 @@
+module PGit
+  class Configuration
+    class MissingAttributesError < PGit::Configuration::LayoutError
+      def initialize(path)
+        @message = prepend_general_message "#{path} must have a path, id, and api_token for each project."
+        super(@message)
+      end
+    end
+  end
+end

data/lib/pgit/configuration/not_found_error.rb

@@ -0,0 +1,10 @@
+module PGit
+  class Configuration
+    class NotFoundError < PGit::Error
+      def initialize(config_path)
+        @message = "#{config_path} configuration file does not exist. Please run `pgit install`"
+        super(@message)
+      end
+    end
+  end
+end

data/lib/pgit/configuration/project_missing_error.rb

@@ -0,0 +1,10 @@
+module PGit
+  class Configuration
+    class ProjectMissingError < PGit::Configuration::LayoutError
+      def initialize(path)
+        @message = prepend_general_message "#{path} needs at least one project."
+        super(@message)
+      end
+    end
+  end
+end

data/lib/pgit/configuration/validator.rb

@@ -0,0 +1,41 @@
+module PGit
+  class Configuration
+    class Validator
+      attr_reader :yaml
+
+      def initialize(config_path)
+        @expanded_path = File.expand_path(config_path)
+        if File.exists? @expanded_path
+          config_file = File.open(@expanded_path, 'r')
+          @yaml = YAML.load(config_file)
+
+          validate_existence_of_at_least_one_project
+          validate_presence_of_items_in_each_project
+        else
+          raise PGit::Configuration::NotFoundError.new(@expanded_path)
+        end
+      end
+
+      private
+
+      def validate_presence_of_items_in_each_project
+        projects = @yaml["projects"]
+        all_present = projects.all? do |project|
+          project["api_token"] &&
+            project["path"] &&
+            project["id"]
+        end
+
+        unless all_present
+          raise PGit::Configuration::MissingAttributesError.new(@expanded_path)
+        end
+      end
+
+      def validate_existence_of_at_least_one_project
+        unless @yaml["projects"]
+          raise PGit::Configuration::ProjectMissingError.new(@expanded_path)
+        end
+      end
+    end
+  end
+end

data/lib/pgit/current_project.rb

@@ -27,12 +27,6 @@ module PGit
 
     private
 
-    def validate_pwd_match_at_least_one(matching_projects)
-      if matching_projects.length == 0
-        raise "None of the project paths matches the working directory"
-      end
-    end
-
     def escape_slashes(project_path)
       project_path.gsub('/','\/')
     end
@@ -50,7 +44,7 @@ module PGit
       projects = config_yaml["projects"]
       matching_projects = find_matching_projects(projects)
 
-      validate_pwd_match_at_least_one(matching_projects)
+      PGit::CurrentProject::Validator.new(matching_projects)
       find_best_match(matching_projects)
     end
 

data/lib/pgit/current_project/no_paths_match_working_dir_error.rb

@@ -0,0 +1,10 @@
+module PGit
+  class CurrentProject
+    class NoPathsMatchWorkingDirError < PGit::Error
+      def initialize
+        @message = "None of the project paths matches the working directory"
+        super(@message)
+      end
+    end
+  end
+end

data/lib/pgit/current_project/validator.rb

@@ -0,0 +1,11 @@
+module PGit
+  class CurrentProject
+    class Validator
+      def initialize(matching_projects)
+        if matching_projects.length == 0
+          raise PGit::CurrentProject::NoPathsMatchWorkingDirError.new
+        end
+      end
+    end
+  end
+end

data/lib/pgit/error.rb

@@ -0,0 +1,4 @@
+module PGit
+  class Error < StandardError
+  end
+end

data/lib/pgit/external_error.rb

@@ -0,0 +1,9 @@
+module PGit
+  class ExternalError < PGit::Error
+    def initialize(message)
+      @message = message
+
+      super @message
+    end
+  end
+end

data/lib/pgit/installer/configuration.rb

@@ -0,0 +1,34 @@
+module PGit
+  module Installer
+    class Configuration
+      FILEPATH = "~/.pgit.rc.yml"
+      def initialize(glob_opts, opts, args)
+        @expanded_path = File.expand_path(FILEPATH)
+
+        if File.exists? @expanded_path
+          warn "#{FILEPATH} already exists"
+        else
+          ask_continue
+        end
+      end
+
+      def ask_continue
+        puts  "*** Installing example pgit configuration file under #{FILEPATH}. Continue? [Y/n]"
+        if STDIN.gets.chomp.match(/y/i)
+          puts "Saving example pgit config in #{FILEPATH}..."
+          write_example_pgit_rc_file
+        else
+          puts "Aborting installation..."
+        end
+      end
+
+      def write_example_pgit_rc_file
+        File.open(@expanded_path, 'w') do |f|
+          YAML.dump(PGit::Configuration.default_options, f)
+        end
+
+        puts "Saved! Please edit #{FILEPATH} and add the proper Pivotal Tracker API tokens, id, and file paths for each project"
+      end
+    end
+  end
+end

data/lib/pgit/pivotal_request_validator.rb

@@ -0,0 +1,27 @@
+module PGit
+  class PivotalRequestValidator
+    attr_reader :request
+
+    def initialize(request)
+      @request = request
+
+      validate
+    end
+
+    private
+
+    def validate
+      if kind_error? || no_kind?
+        raise PGit::ExternalError.new(@request)
+      end
+    end
+
+    def kind_error?
+      @request.match(/"kind": "error"/)
+    end
+
+    def no_kind?
+      !@request.match(/"kind"/)
+    end
+  end
+end

data/lib/pgit/story.rb

@@ -28,12 +28,8 @@ module PGit
       end
 
       def get!
-        request = `#{get_request}`
-        if request.match(/error/)
-          raise request
-        else
-          request
-        end
+        validator = PGit::PivotalRequestValidator.new `#{get_request}`
+        validator.request
       end
 
       def link

data/lib/pgit/version.rb

@@ -1,3 +1,3 @@
 module Pgit
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/pgit.gemspec

@@ -18,6 +18,8 @@ spec = Gem::Specification.new do |s|
   s.executables << 'pgit'
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec', '~> 3.1')
+  s.add_development_dependency('coveralls', '~> 0.7')
+  s.add_development_dependency('simplecov', '~> 0.9')
   s.add_runtime_dependency('gli','2.12.2')
   s.license = 'MIT'
   s.requirements << 'At least one project that uses Pivotal Tracker and Git'

data/spec/pgit/configuration/missing_attributes_error_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'PGit::Configuration::MissingAttributesError' do
+  it 'should inherit from PGit::Error' do
+    ancestors = PGit::Configuration::MissingAttributesError.ancestors
+
+    expect(ancestors).to include (PGit::Error)
+  end
+
+  it 'should complain saying that a project must exist' do
+    error_message = <<-ERROR
+      /Users/edderic/some/config/path.yml 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{6}/,'')
+    fake_path = "/Users/edderic/some/config/path.yml"
+    missing_attributes_error = PGit::Configuration::MissingAttributesError.new(fake_path)
+    message = missing_attributes_error.instance_eval{ @message }
+
+    expect(message).to eq error_message
+  end
+end

data/spec/pgit/configuration/not_found_error_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'PGit::Configuration::NotFoundError' do
+  it 'should inherit from PGit::Error' do
+    ancestors = PGit::Configuration::NotFoundError.ancestors
+
+    expect(ancestors).to include (PGit::Error)
+  end
+
+  it 'should complain that the Configuration file does not exist' do
+    fake_config_path = "/Users/edderic/some/path/to/.pgit.rc.yml"
+    not_found_error = PGit::Configuration::NotFoundError.new(fake_config_path)
+    message = not_found_error.instance_eval{ @message }
+
+    expect(message).to eq "#{fake_config_path} configuration file does not exist. Please run `pgit install`"
+  end
+end

data/spec/pgit/configuration/project_missing_error_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'PGit::Configuration::ProjectMissingError' do
+  it 'should inherit from PGit::Error' do
+    ancestors = PGit::Configuration::ProjectMissingError.ancestors
+
+    expect(ancestors).to include (PGit::Error)
+  end
+
+  it 'should complain saying that a project must exist' do
+    error_message = <<-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
+    error_message.gsub!(/^\s{6}/,'')
+    fake_path = "/Users/edderic/some/config/path.yml"
+    project_missing_error = PGit::Configuration::ProjectMissingError.new(fake_path)
+    message = project_missing_error.instance_eval{ @message }
+
+    expect(message).to eq error_message
+  end
+end

data/spec/pgit/configuration/validator_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'PGit::Configuration::Validator' do
+  describe '#new(configuration_path)' do
+    describe 'empty file' 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 = {}
+
+        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)
+
+        expect do
+          PGit::Configuration::Validator.new(fake_path)
+        end.to raise_error(PGit::Configuration::ProjectMissingError)
+      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)
+
+        expect do
+          PGit::Configuration::Validator.new(fake_path)
+        end.to raise_error(PGit::Configuration::MissingAttributesError)
+      end
+    end
+
+    describe 'configuration_path exists' do
+      it '#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'
+                          }]
+
+        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::Validator.new(fake_path)
+
+        expect(configuration.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"
+        allow(File).to receive(:exists?).and_return(false)
+
+        expect{ PGit::Configuration::Validator.new(file_path) }.to raise_error(PGit::Configuration::NotFoundError)
+      end
+    end
+  end
+end