geoffreywiseman-prune 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89c920f4af989a1bba3db2478a1237a3cc0603b2
+  data.tar.gz: a6ad83bb456149beafbea78df830742be3129b78
+SHA512:
+  metadata.gz: 00b0dfc00922b298475fc4e69e3c7c22c9a6ade2af0faffc8a24547888af4e3977003293ff4644034f7ef2b4b57a78c651c1db311907d0358e4f8fc7f08a5865
+  data.tar.gz: 44ed5f208033ba8c1fd4e070a264a633c2c126905ff163076389e342b42e53d621c53678d6f15a04cb6d9541499a95e5b0e6067d53017a8e86fae058409546ec

data/Rakefile

@@ -23,7 +23,7 @@ end
 spec = Gem::Specification.new do |spec|
   spec.name = 'geoffreywiseman-prune'
   spec.version = Prune::VERSION
-  spec.date = '2011-09-09'
+  spec.date = Prune::RELEASE_DATE
   spec.summary = 'Prunes files from a folder based on a retention policy, often time-based.'
   spec.description = 'Prune is meant to analyze a folder full of files, run them against a retention policy and decide which to keep, which to remove and which to archive. It is extensible and embeddable.'
   spec.author = 'Geoffrey Wiseman'

data/lib/prune/archiver.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+ #!/usr/bin/ruby
 require 'rubygems'
 require 'date'
 require 'zlib'
@@ -8,18 +8,28 @@ include Archive::Tar
 
 module Prune
 
-  # Responsible for making or updating archives based on a list of files. 
+  # Responsible for making or updating archives based on a list of files.
   #
   # This is essentially a wrapper around tar/zlib.
   class Archiver
+
+    # The destination folder to which archives will be written.
     attr_reader :destination
 
+    # Initialize an archiver.
+    #
+    # @param [string] source the source folder from which files should be archived.
+    # @param [boolean] verbose indicates if the output should be verbose
+    # @param [string, nil] destination The destination folder to which archives should be written.
     def initialize( destination, source, verbose )
       @source = source
       @verbose = verbose
       @destination = destination || get_default_dir
     end
 
+    # Get the default directory for the archiver, based on the source folder, but with '-archives' appended.
+    #
+    # @return the default directory
     def get_default_dir
       absolute = File.expand_path @source
       path = File.dirname absolute
@@ -27,6 +37,9 @@ module Prune
       File.join( path, "#{name}-archives" )
     end
 
+    # Make the destination directory by creating it if it doesn't already exist.
+    #
+    # @raise IOError if the folder doesn't exist and can't be created
     def make_destination_dir
       begin
         Dir.mkdir @destination unless File.exists? @destination
@@ -35,10 +48,19 @@ module Prune
       end
     end
     
+    # Get a list of all filenames that are not directories within a root folder.
+    #
+    # @param [String] root the folder in which to look for files
+    # @return an array of folders
     def get_filenames( root )
       Dir.entries( root ).map { |tmpfile| File.join( root, tmpfile ) }.reject { |path| File.directory? path }
     end
     
+    # Update an archive file by adding additional files to it. This is done by extracting the contents to a
+    # temporary folder, then reassembling the archive with the existing and new contents.
+    #
+    # @param [String] archive_path the path to the archive file
+    # @param [Array] paths a list of paths to include in the archive
     def update_archive( archive_path, paths )
       puts "Archive file #{archive_path} exists." if @verbose
       Dir.mktmpdir do |tmp_dir|
@@ -52,12 +74,20 @@ module Prune
       end
     end
     
+    # Create a new archive file, and add some files to it.
+    #
+    # @param [String] archive_path the full filename of the archive file to be created
+    # @param [Array] paths the paths of the files to add to the archive
     def create_archive( archive_path, paths )
       tgz = Zlib::GzipWriter.new( File.open( archive_path, 'wb' ) )
       Minitar.pack( paths, tgz )
       puts "Compressed #{paths.size} file(s) into #{archive_path} archive." if @verbose
     end
 
+    # Archive a group of files by creating an archive or updating an existing one.
+    # 
+    # @param [String] group_name the name of the group , which will be used in deciding the name of the archive
+    # @param [Array] files the files to be added to the archive
     def archive( group_name, files )
       make_destination_dir
       archive_path = File.join( @destination, "archive-#{group_name}.tar.gz")

data/lib/prune/meta.rb

@@ -5,5 +5,8 @@
 # @author Geoffrey Wiseman
 module Prune
   # The version of the prune gem and all the associated code.
-  VERSION = Gem::Version.new '1.2.0'
+  VERSION = Gem::Version.new '1.3.0'
+
+  # The release date associated with the version
+  RELEASE_DATE = '2016-06-24'
 end

data/lib/prune/pruner.rb

@@ -93,8 +93,10 @@ module Prune
         "No files categorized to be removed."
       else
         paths = files.map { |file| File.join folder_name, file }
+
         begin
-          File.delete *paths
+          paths.each { |path| FileUtils.remove_entry( path, true ) }
+         
           "#{files.size} file(s) deleted"
         rescue
           raise IOError, "Could not remove file(s): #{$!}"

data/spec/pruner_spec.rb

@@ -118,12 +118,12 @@ describe Prune::Pruner do
       end
       
       it "should delete file" do
-        File.should_receive( :delete ).with( File.join( PRUNE_PATH, FILENAME ) )
+        FileUtils.should_receive( :remove_entry ).with( File.join( PRUNE_PATH, FILENAME ), true )
         subject.prune PRUNE_PATH
       end
       
       it "should display file deleted message" do
-        File.stub( :delete )
+        FileUtils.should_receive( :remove_entry ).with( File.join( PRUNE_PATH, FILENAME ), true )
         subject.prune PRUNE_PATH
         @messages.should include_match( /file\(s\) deleted/ )
       end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: geoffreywiseman-prune
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Geoffrey Wiseman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-09 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.3
 description: Prune is meant to analyze a folder full of files, run them against a
@@ -36,6 +33,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Rakefile
+- UNLICENSE
+- bin/prune
+- lib/prune.rb
 - lib/prune/archiver.rb
 - lib/prune/category.rb
 - lib/prune/cli.rb
@@ -45,7 +46,6 @@ files:
 - lib/prune/meta.rb
 - lib/prune/pruner.rb
 - lib/prune/retention.rb
-- lib/prune.rb
 - spec/archiver_spec.rb
 - spec/cli_spec.rb
 - spec/configurer_spec.rb
@@ -53,34 +53,27 @@ files:
 - spec/pruner_spec.rb
 - spec/retention_spec.rb
 - spec/spec_helper.rb
-- bin/prune
-- Rakefile
-- UNLICENSE
 homepage: http://geoffreywiseman.github.com/prune
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -394753839533755841
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Prunes files from a folder based on a retention policy, often time-based.
 test_files: []