travis_github_deployer 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8f20a4c4ce37d11b2ef8b7424c5beb0640f9b10
-  data.tar.gz: 9edd37bab8fa9a5ac853a806c18f6794b4927329
+  metadata.gz: e11bde28a88d34baf6233595fe490f13518dbd19
+  data.tar.gz: ef12a9b9f9312191fa0865437dec087ac2fd6318
 SHA512:
-  metadata.gz: 4f74213d9dcda4b693b10abaa637a272e90566fc23616d91b383c777151062237d69a23b343535192862613d48673339677296296ab771025ff9ff9fd1b23aee
-  data.tar.gz: cc29b250a8817db828b3686e63d794b34e1b0907ce32c2e0fb00e3da463fa7a9f44ce8a6df2f390ab4c16316dcfe806c63544a1c5fcd8701fa82e0c60f77059a
+  metadata.gz: 7ddff0780fbf8549584f7be3d198ace186182ecc062867a32c790b357acb055de188bfaca94249b1782a9de98c5f10449690361f686267f80b90509c520a245a
+  data.tar.gz: dbd98689fc07858fb02284d9408c519992b2d7122f26d85e467b26985a22bf0d7cded83f4be44426fd4bc2b8129829927d7b1fcdda83a0d7681c985074245e71

data/lib/travis_github_deployer/git_command_line.rb

@@ -18,6 +18,17 @@ class GitCommandLine
     git("commit -m \"#{message}\"")
   end
   
+  def filter_branch(patterns)
+    git("filter-branch --force --index-filter " +
+        "'git rm --cached --ignore-unmatch #{patterns}' " +
+        "--prune-empty --tag-name-filter cat -- --all"
+    )
+  end
+  
+  def force_push
+    git("push -f")
+  end
+  
   def push
     git("push")
   end

data/lib/travis_github_deployer/travis_github_deployer.rb

@@ -37,6 +37,10 @@ class TravisGithubDeployer
     @files_to_deploy ||= {}
   end
     
+  def files_to_purge
+    @files_to_purge ||= []
+  end
+    
   ## Deployment 
     
   def deploy
@@ -55,6 +59,7 @@ class TravisGithubDeployer
     copy_files_in_destination_repository
     change_current_directory_to_cloned_repository
     prepare_credentials_based_on_environment_variables
+    purge_files_from_history if not files_to_purge.empty?
     commit_and_push_files
   end
 
@@ -66,15 +71,24 @@ class TravisGithubDeployer
     prepare_files_to_deploy(configuration["files_to_deploy"])
   end
   
+  def get_destination_and_add_file_to_purge source, target_or_hash
+      if target_or_hash.instance_of?(Hash)
+        files_to_purge << source if (target_or_hash["purge"] == "yes")    
+        destination_file = target_or_hash["destination"]
+      else
+        destination_file = target_or_hash
+      end
+  end
+  
   def prepare_files_to_deploy files_hash
-    files_hash.each { |source_file_from_configuration, destination_file|
-      
-      source_files = Dir.glob(source_file_from_configuration)
+    files_hash.each { |source, values|
       
+      source_files = Dir.glob(source)      
       if source_files.empty?
-        raise StandardError.new("File: '#{source_file_from_configuration}' found in the configuration didn't exist. Deploy failed.") 
+        raise StandardError.new("File: '#{source}' found in the configuration didn't exist. Deploy failed.") 
       end
       
+      destination_file = get_destination_and_add_file_to_purge(source, values)  
       source_files.each { |source_file|
         files_to_deploy[source_file] = destination_file
       }
@@ -134,11 +148,19 @@ class TravisGithubDeployer
     
   end
   
+  def purge_files_from_history
+     git.filter_branch(files_to_purge.join(" "))
+  end
+  
   def commit_and_push_files
     files_to_deploy.each { |source_location, destination_location|
       git.add(Pathname.new(destination_location))
     }
     git.commit("File deployed with Travis Github Deployer")
-    git.push
+    if(files_to_purge.empty?) 
+      git.push
+    else
+      git.force_push
+    end
   end
 end

data/lib/travis_github_deployer/version.rb

@@ -1,4 +1,4 @@
 
 module TravisGithubDeployerVersion
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/git_command_line_spec.rb

@@ -6,57 +6,71 @@ describe "simple ruby interface around git command line" do
   subject { GitCommandLine.new}
   
   it "can do a git clone" do
-    subject.should_receive(:git).with("clone repository destination")
+    expect(subject).to receive(:git).with("clone repository destination")
     subject.clone("repository", "destination")
   end
   
   it "can add files" do
-    subject.should_receive(:git).with("add filename")
+    expect(subject).to receive(:git).with("add filename")
     subject.add("filename")
   end
   
   it "can commit" do
-    subject.should_receive(:git).with('commit -m "message"')
+    expect(subject).to receive(:git).with('commit -m "message"')
     subject.commit("message")
   end
   
+  it "can purge files from history" do
+    expect(subject).to receive(:git).with(
+      "filter-branch --force --index-filter " +
+      "'git rm --cached --ignore-unmatch file1 file2' " +
+      "--prune-empty --tag-name-filter cat -- --all"
+    )
+    subject.filter_branch("file1 file2")
+  end
+  
   it "can push" do
-    subject.should_receive(:git).with("push")
+    expect(subject).to receive(:git).with("push")
     subject.push
   end
   
+  it "can force-push" do
+    expect(subject).to receive(:git).with("push -f")
+    subject.force_push
+  end
+  
   it "can do a config" do
-    subject.should_receive(:git).with("config key 'value'")
+    expect(subject).to receive(:git).with("config key 'value'")
     subject.config("key", "value")
   end
   
   it "can configure the username" do
-    subject.should_receive(:config).with("user.name", "basvodde")
+    expect(subject).to receive(:config).with("user.name", "basvodde")
     subject.config_username("basvodde")
   end
   
   it "can configure the email" do
-    subject.should_receive(:config).with("user.email", "basv@sokewl.com")
+    expect(subject).to receive(:config).with("user.email", "basv@sokewl.com")
     subject.config_email("basv@sokewl.com")
   end
   
   it "can configure the credential helper" do
-    subject.should_receive(:config).with("credential.helper", "store --file=filename")
+    expect(subject).to receive(:config).with("credential.helper", "store --file=filename")
     subject.config_credential_helper_store_file("filename")
   end
   
   it "can do verbose output" do
     subject.verbose=true
-    subject.should_receive(:puts).with("command: git something")
-    subject.should_receive(:do_system).with("git something 2>&1").and_return("output")
-    subject.should_receive(:previous_command_success).and_return(true)
-    subject.should_receive(:puts).with("output: output")
+    expect(subject).to receive(:puts).with("command: git something")
+    expect(subject).to receive(:do_system).with("git something 2>&1").and_return("output")
+    expect(subject).to receive(:previous_command_success).and_return(true)
+    expect(subject).to receive(:puts).with("output: output")
     subject.git("something")    
   end
   
   it "Should be able to do a successful command" do
-    subject.should_not_receive(:puts)
-    subject.git('version').should start_with("git version")
+    expect(subject).not_to receive(:puts)
+    expect(subject.git('version')).to start_with("git version")
   end
   
   it "Should be able to raise an StandardError on failed commands" do

data/spec/travis_github_deployer_spec.rb

@@ -8,68 +8,68 @@ describe "travis github deployer" do
   before(:each) do
     ENV::clear
     @git = double
-    GitCommandLine.should_receive(:new).and_return(@git)
+    expect(GitCommandLine).to receive(:new).and_return(@git)
     subject
   end
   
   it "can deploy to an destination repository" do
     ENV['TRAVIS_PULL_REQUEST']="false"
     ENV['GIT_NAME']="Foo"
-    subject.should_receive(:load_configuration)
-    subject.should_receive(:clone_destination_repository)
-    subject.should_receive(:change_current_directory_to_cloned_repository)
-    subject.should_receive(:prepare_credentials_based_on_environment_variables)
-    subject.should_receive(:copy_files_in_destination_repository)
-    subject.should_receive(:commit_and_push_files)
+    expect(subject).to receive(:load_configuration)
+    expect(subject).to receive(:clone_destination_repository)
+    expect(subject).to receive(:change_current_directory_to_cloned_repository)
+    expect(subject).to receive(:prepare_credentials_based_on_environment_variables)
+    expect(subject).to receive(:copy_files_in_destination_repository)
+    expect(subject).to receive(:commit_and_push_files)
     subject.deploy
   end
   
   it "will not deploy on a pull request" do
     ENV['TRAVIS_PULL_REQUEST']="10"
-    subject.should_not_receive(:load_configuration)
-    subject.should_receive(:puts).with("In pull request and won't be deploying")
+    expect(subject).not_to receive(:load_configuration)
+    expect(subject).to receive(:puts).with("In pull request and won't be deploying")
     subject.deploy
   end
  
   it "will not deploy when run in a fork, e.g. when GIT_NAME isn't set" do
     ENV['TRAVIS_PULL_REQUEST']="false"
-    subject.should_not_receive(:load_configuration)
-    subject.should_receive(:puts).with("In fork and won't be deploying")
+    expect(subject).not_to receive(:load_configuration)
+    expect(subject).to receive(:puts).with("In fork and won't be deploying")
     subject.deploy
   end
   
   context "Prepare repository for being able to commit" do
     
     it "can clone the destination repository" do
-      subject.should_receive(:destination_repository).and_return("https://github.com/cpputest/cpputest")
-      subject.should_receive(:destination_repository_dir).and_return("destdir")
-      @git.should_receive(:clone).with("https://github.com/cpputest/cpputest", "destdir")
+      expect(subject).to receive(:destination_repository).and_return("https://github.com/cpputest/cpputest")
+      expect(subject).to receive(:destination_repository_dir).and_return("destdir")
+      expect(@git).to receive(:clone).with("https://github.com/cpputest/cpputest", "destdir")
       
       subject.clone_destination_repository
     end
     
     it "can change the directory to the cloned directory" do
-      subject.should_receive(:destination_repository_dir).and_return("destinationdir")
-      Dir.should_receive(:chdir).with("destinationdir")
+      expect(subject).to receive(:destination_repository_dir).and_return("destinationdir")
+      expect(Dir).to receive(:chdir).with("destinationdir")
       subject.change_current_directory_to_cloned_repository
     end
         
     it "Should be able to set the credentials for pushing stuff up" do
-      subject.should_receive(:set_username_based_on_environment_variable)
-      subject.should_receive(:set_email_based_on_environment_variable)
-      subject.should_receive(:set_repository_token_based_on_enviroment_variable)
+      expect(subject).to receive(:set_username_based_on_environment_variable)
+      expect(subject).to receive(:set_email_based_on_environment_variable)
+      expect(subject).to receive(:set_repository_token_based_on_enviroment_variable)
       subject.prepare_credentials_based_on_environment_variables
     end
     
     it "Should be able to set the username based on an environment variable" do
       ENV['GIT_NAME'] = "basvodde"
-      @git.should_receive(:config_username).with("basvodde")
+      expect(@git).to receive(:config_username).with("basvodde")
       subject.set_username_based_on_environment_variable    
     end
       
     it "Should be able to set the password based on an environment variable" do
       ENV['GIT_EMAIL'] = "basv@bestcompanythatexists.com"
-      @git.should_receive(:config_email).with("basv@bestcompanythatexists.com")
+      expect(@git).to receive(:config_email).with("basv@bestcompanythatexists.com")
       subject.set_email_based_on_environment_variable
     end
       
@@ -77,9 +77,9 @@ describe "travis github deployer" do
       credential_file = double
       ENV['GIT_TOKEN'] = "Token"
     
-      @git.should_receive(:config_credential_helper_store_file).with(".git/travis_deploy_credentials")
-      File.should_receive(:open).with(".git/travis_deploy_credentials", "w").and_yield(credential_file)
-      credential_file.should_receive(:write).with("https://Token:@github.com")
+      expect(@git).to receive(:config_credential_helper_store_file).with(".git/travis_deploy_credentials")
+      expect(File).to receive(:open).with(".git/travis_deploy_credentials", "w").and_yield(credential_file)
+      expect(credential_file).to receive(:write).with("https://Token:@github.com")
     
       subject.set_repository_token_based_on_enviroment_variable
     end  
@@ -87,59 +87,91 @@ describe "travis github deployer" do
 
   context "Prepare the changes that need to be made commit" do
     
-    it "should be able to copy a file from the root of the source repository to the root of the destination reportistory" do
-      subject.should_receive(:files_to_deploy).and_return( { "sourcefile" => ""})
-      FileUtils.should_receive(:cp_r).with(Pathname.new("sourcefile"), Pathname.new("travis_github_deployer_repository"))
+    it "should be able to copy a file from the root of the source repository to the root of the destination repository" do
+      expect(subject).to receive(:files_to_deploy).and_return( { "sourcefile" => ""})
+      expect(FileUtils).to receive(:cp_r).with(Pathname.new("sourcefile"), Pathname.new("travis_github_deployer_repository"))
       subject.copy_files_in_destination_repository
     end
     
     it "Should be able to copy multiple files" do
-      subject.should_receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
-      FileUtils.should_receive(:cp_r).with(Pathname.new("dir/onefile"), Pathname.new("travis_github_deployer_repository/destonefile"))
-      FileUtils.should_receive(:cp_r).with(Pathname.new("twofile"), Pathname.new("travis_github_deployer_repository/dir/desttwofile"))
+      expect(subject).to receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
+      expect(FileUtils).to receive(:cp_r).with(Pathname.new("dir/onefile"), Pathname.new("travis_github_deployer_repository/destonefile"))
+      expect(FileUtils).to receive(:cp_r).with(Pathname.new("twofile"), Pathname.new("travis_github_deployer_repository/dir/desttwofile"))
       subject.copy_files_in_destination_repository      
     end    
   end
   
   context "Actually committing the files" do
     
+    it "can purge files from history and force-push" do
+      files = ["dir/onefile", "twofile"]
+      expect(subject).to receive(:files_to_purge).and_return(files, files)
+      allow(@git).to receive_messages(add: nil, commit: nil)
+      expect(@git).to receive(:filter_branch).with(files.join(" "))
+      expect(@git).to receive(:force_push)
+      subject.purge_files_from_history
+      subject.commit_and_push_files
+    end
+  
     it "can add, commit and push up the files" do
-      subject.should_receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
-      @git.should_receive(:add).with(Pathname.new("destonefile"))
-      @git.should_receive(:add).with(Pathname.new("dir/desttwofile"))
-      @git.should_receive(:commit).with("File deployed with Travis Github Deployer")
-      @git.should_receive(:push)
+      expect(subject).to receive(:files_to_deploy).and_return({ "dir/onefile" => "destonefile", "twofile" => "dir/desttwofile"})
+      expect(@git).to receive(:add).with(Pathname.new("destonefile"))
+      expect(@git).to receive(:add).with(Pathname.new("dir/desttwofile"))
+      expect(@git).to receive(:commit).with("File deployed with Travis Github Deployer")
+      expect(@git).to receive(:push)
       subject.commit_and_push_files
     end
   end
   
   context "configuration" do
     it "can read configuration parameters out of the .travis_github_deployer.yml" do
+      files_to_deploy = { "source_dir/source_file" => "destination_dir/destination_file" }
       configuration = { 
         "destination_repository" => "https://github.com/cpputest/cpputest.github.io.git",
-        "files_to_deploy" => {
-          "source_dir/source_file" => "destination_dir/destination_file"
-        }
+        "files_to_deploy" => files_to_deploy
       }
     
-      YAML.should_receive(:load_file).with(".travis_github_deployer.yml").and_return(configuration)
-      subject.should_receive(:prepare_files_to_deploy).with({"source_dir/source_file" => "destination_dir/destination_file"})
+      expect(YAML).to receive(:load_file).with(".travis_github_deployer.yml").and_return(configuration)
+      expect(subject).to receive(:prepare_files_to_deploy).with(files_to_deploy)
       subject.load_configuration
     
-      subject.destination_repository.should== "https://github.com/cpputest/cpputest.github.io.git"
+      expect(subject.destination_repository).to eq("https://github.com/cpputest/cpputest.github.io.git")
+    
+    end
+
+    it "can parse destination with file to purge" do
+      source = "src_file"
+      target = {"destination"=>"dest", "purge"=>"yes"}
+      expect(subject.get_destination_and_add_file_to_purge(source, target)).to eq("dest")
+      expect(subject.files_to_purge).to eq(["src_file"])
+    end
+    
+    it "can parse destination without file to purge" do
+      source = "src_file"
+      target = "dest"
+      expect(subject.get_destination_and_add_file_to_purge(source, target)).to eq("dest")
+      expect(subject.files_to_purge).to eq([])
+    end
     
+    it "can have sources to purge from history" do
+      files_to_purge = { "myfile" => { "destination" => "destination_dir", "purge" => "yes" } }
+      expect(Dir).to receive(:glob).with("myfile").and_return(["myfile"])
+      
+      subject.prepare_files_to_deploy(files_to_purge)
+      expect(subject.files_to_deploy).to eq({ "myfile" => "destination_dir" })    
+      expect(subject.files_to_purge).to eq([ "myfile" ])
     end
     
     it "can have files with wildcards in the configuration" do
       wild_card_files = { "source_dir/*" => "destination_dir" }
-      Dir.should_receive(:glob).with("source_dir/*").and_return(["file1", "file2"])
+      expect(Dir).to receive(:glob).with("source_dir/*").and_return(["file1", "file2"])
       
       subject.prepare_files_to_deploy(wild_card_files)
-      subject.files_to_deploy.should== { "file1" => "destination_dir", "file2" => "destination_dir" }
+      expect(subject.files_to_deploy).to eq({ "file1" => "destination_dir", "file2" => "destination_dir" })
     end
     
-    it "raises an error when one of the source files doesn't exists" do
-      Dir.should_receive(:glob).with("not_exists").and_return([])
+    it "raises an error when one of the source files doesn't exist" do
+      expect(Dir).to receive(:glob).with("not_exists").and_return([])
       expect { 
         subject.prepare_files_to_deploy( { "not_exists" => "" }) 
       }.to raise_error(StandardError, "File: 'not_exists' found in the configuration didn't exist. Deploy failed.")
@@ -148,15 +180,15 @@ describe "travis github deployer" do
         
     it "isn't verbose by default" do
       subject.command_line_arguments([""])
-      subject.verbose.should == false
+      expect(subject.verbose).to eq(false)
     end
     
     it "can be made verbose using the -v" do
-      @git.should_receive(:verbose=).with(true)
+      expect(@git).to receive(:verbose=).with(true)
 
       subject.command_line_arguments(["-v"])
 
-      subject.verbose.should== true      
+      expect(subject.verbose).to eq(true)      
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travis_github_deployer
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Bas Vodde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake