geoffreywiseman-prune 1.2.0.rc4 → 1.2.0.rc5

data/lib/prune/archiver.rb

@@ -7,6 +7,10 @@ require 'tmpdir'
 include Archive::Tar
 
 module Prune
+
+  # Responsible for making or updating archives based on a list of files. 
+  #
+  # This is essentially a wrapper around tar/zlib.
   class Archiver
     attr_reader :destination
 

data/lib/prune/category.rb

@@ -1,34 +1,40 @@
-class Category
-  attr_accessor :action, :description
-  
-  def initialize( description, action, quiet = false, predicate = Proc.new { |x| true } )
-    @description = description
-    @action = action
-    @predicate = predicate
-    @quiet = quiet
-  end
-  
-  def requires_prompt?
-    case @action
-    when :remove
-      true
-    when :archive
-      true
-    else
-      false
+module Prune
+
+  # A category indicates how a file has been classified. These are defined in the retention policy,
+  # whether that be a project-specific one or the core retention policy. This is the primary abstraction
+  # used to decide what to do with a file.
+  class Category
+    attr_accessor :action, :description
+    
+    def initialize( description, action, quiet = false, predicate = Proc.new { |x| true } )
+      @description = description
+      @action = action
+      @predicate = predicate
+      @quiet = quiet
     end
+    
+    def requires_prompt?
+      case @action
+      when :remove
+        true
+      when :archive
+        true
+      else
+        false
+      end
+    end
+    
+    def includes?( filename )
+      @predicate.call filename
+    end
+    
+    def quiet?
+      @quiet
+    end
+    
+    def to_s
+      @description
+    end
+    
   end
-  
-  def includes?( filename )
-    @predicate.call filename
-  end
-  
-  def quiet?
-    @quiet
-  end
-  
-  def to_s
-    @description
-  end
-  
-end
+end

data/lib/prune/cli.rb

@@ -4,8 +4,10 @@ require 'optparse'
 require 'date'
 
 module Prune
-  VERSION = Gem::Version.new '1.2.0.rc4'
 
+  # The command-line interface for prune is the primary way to interact with it, although it can be invoked programatically as well.
+  #
+  # This class defines the arguments and options taken by Prune and how it reacts to various forms of command-line input.
   class CommandLineInterface
 
     DEFAULT_OPTIONS = { :verbose => false, :did_work => false, :dry_run => false, :prompt => true, :archive => true, :configure => false }

data/lib/prune/configurer.rb

@@ -1,6 +1,11 @@
 require 'fileutils'
 
 module Prune
+
+  # The configurer is used for configure a custom retention policy for a specified folder by either 
+  # editing the retention policy already in place,
+  # or by copying the default retention policy from the gem into place in the specified directory, 
+  # and then editing it.
   class Configurer
 
     def initialize( folder, options = {} )

data/lib/prune/grouper.rb

@@ -1,4 +1,7 @@
 module Prune
+
+  # Assembles files into groups by month name, for archival. This is not
+  # currently a configurable behaviour (grouping by some other means, for instance.)
   class Grouper
 
     def initialize( archiver )

data/lib/prune/meta.rb

@@ -0,0 +1,9 @@
+# The prune module contains all the classes defined for Prune to do its job -- it's the namespace for the project, essentially.
+#
+# In addition, the prune module contains a single piece of metadata -- the version of the GEM.
+#
+# @author Geoffrey Wiseman
+module Prune
+  # The version of the prune gem and all the associated code.
+  VERSION = Gem::Version.new '1.2.0.rc5'
+end

data/lib/prune/pruner.rb

@@ -4,6 +4,8 @@ require 'date'
 
 module Prune
 
+  # The co-ordinating class of Prune, Pruner works with the retention policy, archiver, grouper to get everything done.
+  # This is the central hub through which almost all other activity passes.
   class Pruner
     FILTERS = [ '.', '..', '.prune' ]
 

data/lib/prune/retention.rb

@@ -5,6 +5,9 @@ require 'pathname'
 
 module Prune
 
+  # Represents a retention policy, whether loaded from the core retention policy or from a project-specific configured retention
+  # policy. It defines all the categories, the actions associated with them and some other elements. It is the primary form of
+  # prune Configuration.
   class RetentionPolicy
     DEFAULT_OPTIONS={ :load_dsl => true }
 
@@ -54,7 +57,8 @@ module Prune
     end
     
   end
-  
+
+  # A builder for building categories -- this is essentially the DSL used in the retention policy.
   class CategoryBuilder
     
     def initialize( description )
@@ -97,6 +101,8 @@ module Prune
     
   end
   
+  # A thin wrapper around files for holding attributes that might be precalculated and then
+  # used by a number of categories.
   class FileContext
     attr_accessor :name
     

data/lib/prune.rb

@@ -7,4 +7,4 @@ require 'prune/retention'
 require 'prune/grouper'
 require 'prune/category'
 require 'prune/configurer'
-
+require 'prune/meta'

data/spec/pruner_spec.rb

@@ -8,7 +8,7 @@ describe Prune::Pruner do
   subject { Prune::Pruner.new Hash.new }
 
   before( :each ) do
-    @categories = [ Category.new( "Unmatched Files", :retain, true ) ]
+    @categories = [ Prune::Category.new( "Unmatched Files", :retain, true ) ]
     @retention_policy = double( "RetentionPolicy" )
     @retention_policy.stub( :categories ) { @categories }
     Prune::RetentionPolicy.stub( :new ) { @retention_policy }
@@ -198,17 +198,17 @@ describe Prune::Pruner do
       end
         
       it "should display empty categories" do
-        subject.display_categories( { Category.new( "Empty Category", :retain ) => [] } )
+        subject.display_categories( { Prune::Category.new( "Empty Category", :retain ) => [] } )
         @messages.should include_match( /Empty Category/ )
       end
         
       it "should display quiet categories" do
-        subject.display_categories( { Category.new( "Quiet Category", :retain, true ) => [ 'quiet.txt' ] } )
+        subject.display_categories( { Prune::Category.new( "Quiet Category", :retain, true ) => [ 'quiet.txt' ] } )
         @messages.should include_match( /Quiet Category/ )
       end
       
       it "should display categories with files" do
-        subject.display_categories( { Category.new( "Normal Category", :retain ) => [ 'normal.txt' ] } )
+        subject.display_categories( { Prune::Category.new( "Normal Category", :retain ) => [ 'normal.txt' ] } )
         @messages.should include_match( /Normal Category/ )
       end
     end
@@ -220,17 +220,17 @@ describe Prune::Pruner do
       end
         
       it "should not display empty categories" do
-        subject.display_categories( { Category.new( "Empty Category", :retain, true ) => [] } )
+        subject.display_categories( { Prune::Category.new( "Empty Category", :retain, true ) => [] } )
         @messages.should_not include_match( /Empty Category/ )
       end
       
       it "should not display quiet categories" do
-        subject.display_categories( { Category.new( "Quiet Category", :retain, true ) => [ 'shhh.txt' ] } )
+        subject.display_categories( { Prune::Category.new( "Quiet Category", :retain, true ) => [ 'shhh.txt' ] } )
         @messages.should_not include_match( /Quiet Category/ )
       end
       
       it "should display categories with files" do
-        subject.display_categories( { Category.new( "Normal Category", :retain ) => [ 'normal.txt' ] } )
+        subject.display_categories( { Prune::Category.new( "Normal Category", :retain ) => [ 'normal.txt' ] } )
         @messages.should include_match( /Normal Category/ )
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoffreywiseman-prune
 version: !ruby/object:Gem::Version
-  version: 1.2.0.rc4
+  version: 1.2.0.rc5
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitar
-  requirement: &70347705700040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70347705700040
+  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
   retention policy and decide which to keep, which to remove and which to archive.
   It is extensible and embeddable.
@@ -37,6 +42,7 @@ files:
 - lib/prune/configurer.rb
 - lib/prune/default_retention.rb
 - lib/prune/grouper.rb
+- lib/prune/meta.rb
 - lib/prune/pruner.rb
 - lib/prune/retention.rb
 - lib/prune.rb
@@ -62,6 +68,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2783546995479807081
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -70,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Prunes files from a folder based on a retention policy, often time-based.