aef-bakker 1.1.0

data/History.txt

@@ -0,0 +1,23 @@
+=== 1.1.0 / 2009-04-05
+
+* 1 major enhancement
+
+  * Namespaced into module Aef
+
+* 5 minor enhancements
+
+  * Better metadata for gem
+  * Test refactoring
+  * Minor refactorings
+  * Improved documentation
+  * Added test for --version command
+
+* 1 minor bugfix
+
+  * Fixed some bugs related to Ruby 1.8.6
+
+=== 1.0.0 / 2009-03-01
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.rdoc
+COPYING.txt
+Rakefile
+bin/bakker
+lib/bakker.rb
+lib/bakker/bakker.rb
+spec/bakker_spec.rb

data/README.rdoc

@@ -0,0 +1,206 @@
+= Bakker
+
+* Project: https://rubyforge.org/projects/aef/
+* RDoc: http://aef.rubyforge.org/bakker/
+* Github: http://github.com/aef/bakker/
+
+== DESCRIPTION:
+
+Bakker is a Ruby library and commandline tool to help with simple task of
+renaming or copying files for quick backup purposes. For instance by creating
+a copy of a list of files while adding .bak to the copies filenames. Bakker
+gives you control over the extension to be added to or removed from the file
+and whether it should be moved or copied.
+
+== FEATURES/PROBLEMS:
+
+* Usable as library and commandline tool
+* Tested and fully working on:
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+  * Debian GNU/Linux 4.0 i386 (Ruby 1.8.6)
+  * On Windows XP i386 (Ruby 1.8.6)
+* On Windows XP i386 (Ruby 1.8.6) there were some problems testing the
+  environment variable choices. Two tests are failing but the programs seems
+  to work correctly. If anyone finds the problem, please contact me.
+* The commandline tool doesn't work with Ruby 1.9.x because the user-choices gem
+  is not yet updated. A patch is available here:
+  https://rubyforge.org/tracker/index.php?func=detail&aid=24307&group_id=4192&atid=16176
+
+== SYNOPSIS:
+
+=== Commandline
+
+The following command renames config.ini to config.ini.bak. You can type the
+same command a second time to revert the action:
+
+  bakker config.ini
+
+Instead of renaming you can create a copy of config.xml by using the following
+command:
+
+  bakker -a copy config.ini
+
+To change the extension which will be appended or removed from the filename use
+the following command:
+
+  bakker -e .backup
+
+In a directory with the follwing contents:
+
+  demo1
+  demo2.bak
+  demo3.bak
+
+if you use the command:
+
+  bakker *
+
+you get the following list of files (because by default Bakker toggles the
+extension):
+
+  demo1.bak
+  demo2
+  demo3
+
+if you now want every file in the folder to have a .bak extension use the
+following command:
+
+  bakker -m add *
+
+the result will look like this:
+
+  demo1.bak
+  demo2.bak
+  demo3.bak
+
+Instead of using the add-mode you could have used the remove-mode like this:
+
+  bakker -m remove *
+
+Then the result would have looked like this:
+
+  demo1
+  demo2
+  demo3
+
+Bakker also includes a verbose mode which will inform you of any file transfer
+in the console:
+
+  bakker -v config.ini
+
+You can specify default values for extension, action, mode and even for the
+verbose mode by using environment variables. Notice that you can still override
+these by using commandline switches. A list of the variables:
+
+* BAKKER_MODE
+* BAKKER_ACTION
+* BAKKER_EXTENSION
+* BAKKER_VERBOSE
+
+=== Library
+
+Load the gem:
+
+  require 'bakker'
+
+Call Bakker:
+
+  Aef::Bakker.process('config.ini', '.backup', :add, :copy)
+
+== REQUIREMENTS:
+
+* rubygems
+
+=== Additional for commandline
+* user-choices
+
+=== Additional for automated testing
+* hoe
+* rspec
+* sys-uname
+
+== INSTALL:
+
+=== Normal
+
+  gem install bakker
+
+Additionally for the commandline tool:
+
+  gem install user-choices
+
+=== High security (recommended)
+
+There is a high security installation option available through rubygems. It is
+highly recommended over the normal installation, although it may be a bit less
+comfortable. To use the installation method, you will need my public key, which
+I use for cryptographic signatures on all my gems. You can find the public key
+and more detailed verification information in the aef-certificates section of my
+rubyforge project[https://rubyforge.org/frs/?group_id=7890&release_id=31749]
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+  gem cert --add aef.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+  gem install bakker --ignore-dependencies -P HighSecurity
+
+Please notice that you will need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+=== Automated testing
+
+You can test this package through rspec on your system. First find the path
+where the gem was installed to:
+
+  gem which bakker
+
+Go into the root directory of the installed gem and run the following command
+to start the test runner:
+
+  rake spec
+
+On Windows systems you have to run the following instead:
+
+  spec spec/**/*_spec.rb
+
+If something goes wrong you should be noticed through failing examples.
+
+== DEVELOPMENT:
+
+This software is developed in the source code management system git hosted
+at github.com. You can download the most recent sourcecode through the following
+command:
+
+  git clone git://github.com/aef/bakker.git
+
+Help on making this software better is always very appreciated. If you want your
+changes to be included in the official release, please send me a patch through
+the project's tracker[https://rubyforge.org/tracker/?group_id=7890] at
+rubyforge.org. You can generate a patch-file by the following command:
+
+  git diff > patch.diff
+
+Please make sure to write tests for your changes and notice that I can't promise
+to include your changes before reviewing them.
+
+== LICENSE:
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+This file is part of Bakker.
+
+Bakker is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/bakker.rb'
+
+Hoe.new('bakker', Aef::Bakker::VERSION) do |p|
+  p.rubyforge_name = 'aef'
+  p.developer('Alexander E. Fischer', 'aef@raxys.net')
+  p.extra_dev_deps = %w{user-choices rspec sys-uname}
+  p.url = 'https://rubyforge.org/projects/aef/'
+  p.readme_file = 'README.rdoc'
+  p.extra_rdoc_files = %w{README.rdoc}
+  p.spec_extras = {
+    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'Bakker']
+  }
+end
+
+# vim: syntax=Ruby

data/bin/bakker

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Bakker.
+#
+# Bakker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# TODO: If user-choices patch gets accepted, use :one_way => true for --version
+# TODO: If user-choices patch gets accepted, use :upcase for environment variables
+
+# If library is not locally accessible, use gem to include it.
+begin
+  require 'lib/bakker'
+rescue LoadError
+  require 'rubygems'
+  require 'bakker'
+end
+
+# User friendly message if user-choices is not available
+begin
+  require 'user-choices'
+rescue LoadError
+  warn "This command needs the user-choices gem to be installed.\n\nSolution: gem install user-choices"
+  exit false
+end
+
+# Application class for commandline interface
+class Aef::Bakker::Application < UserChoices::Command
+  include UserChoices
+
+  # Prepare configuration sources
+  def add_sources(builder)
+    builder.add_source(CommandLineSource, :usage,
+      "Usage: #$PROGRAM_NAME [options] files\n\n",
+      "You can set the default behavior through environment variables:\n",
+      "BAKKER_MODE (#{Aef::Bakker::MODES.join(', ')}. Default: #{Aef::Bakker::MODES.first})",
+      "BAKKER_ACTION (#{Aef::Bakker::ACTIONS.join(', ')}. Default: #{Aef::Bakker::ACTIONS.first})",
+      'BAKKER_EXTENSION (Default: .bak)',
+      "BAKKER_VERBOSE (true, false. Default: false)\n"
+    )
+
+    # Hopefully possible with next release of user-choices
+    # builder.add_source(ExtendedEnvironmentSource, :upcase, :with_prefix, 'BAKKER_')
+
+    builder.add_source(EnvironmentSource, :mapping,
+      :mode      => 'BAKKER_MODE',
+      :action    => 'BAKKER_ACTION',
+      :extension => 'BAKKER_EXTENSION',
+      :verbose   => 'BAKKER_VERBOSE'
+    )
+  end
+
+  # Define configuration options
+  def add_choices(builder)
+    builder.add_choice(:mode, :type => Aef::Bakker::MODES.map{|item| item.to_s}, :default => Aef::Bakker::MODES.first.to_s) do |cli|
+      cli.uses_option('-m', '--mode MODE',
+        "Processing mode. Can be one of: #{Aef::Bakker::MODES.join(', ')}. " +
+        "Default: #{Aef::Bakker::MODES.first}")
+    end
+
+    builder.add_choice(:action, :type => Aef::Bakker::ACTIONS.map{|item| item.to_s}, :default => Aef::Bakker::ACTIONS.first.to_s) do |cli|
+      cli.uses_option('-a', '--action ACTION',
+        "Filesystem action. Can be one of: #{Aef::Bakker::ACTIONS.join(', ')}. " +
+        "Default: #{Aef::Bakker::ACTIONS.first}")
+    end
+
+    builder.add_choice(:extension, :default => Aef::Bakker::DEFAULT_EXTENSION) do |cli|
+      cli.uses_option('-e', '--extension EXTENSION',
+        "Suffix to be added/removed"
+      )
+    end
+
+    builder.add_choice(:verbose, :type => :boolean, :default => false) do |cli|
+      cli.uses_switch('-v', '--verbose', 'Log all actions to console')
+    end
+
+    builder.add_choice(:version, :default => false, :type => :boolean) do |cli|
+      cli.uses_switch('--version', 'Display version and licensing information')
+    end
+
+    builder.add_choice(:filenames) {|cli| cli.uses_arglist }
+  end
+
+  # Manual option post processing
+  def postprocess_user_choices
+    version if @user_choices[:version]
+  end
+
+  # Version and licensing information output
+  def version
+    name = 'Bakker'
+    puts "#{name} #{Aef::Bakker::VERSION}"
+    puts
+    puts 'Project: https://rubyforge.org/projects/aef/'
+    puts "RDoc: http://aef.rubyforge.org/#{name.downcase}/"
+    puts "Github: http://github.com/aef/#{name.downcase}/"
+    puts
+    puts 'Copyright 2009 Alexander E. Fischer <aef@raxys.net>'
+    # Read and print licensing information from the top of this file
+    if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new('1.8.6')
+      puts File.read(__FILE__).map{|line| line[2..-1]}[5..17]
+    else
+      puts File.read(__FILE__).lines.map{|line| line[2..-1]}[5..17]
+    end
+    exit
+  end
+
+  # Main program
+  def execute
+    if @user_choices[:filenames].empty?
+      warn 'No files given'; exit false
+    else
+      @user_choices[:filenames].each do |filename|
+        begin
+          Aef::Bakker.process(filename, @user_choices[:extension], @user_choices[:mode].to_sym,
+            @user_choices[:action].to_sym, { :verbose => @user_choices[:verbose] })
+        rescue Aef::BakkerWarning
+          warn "Ignoring #{filename}: #$!"
+        end
+      end
+    end
+  end
+end
+
+S4tUtils.with_pleasant_exceptions {Aef::Bakker::Application.new.execute}

data/lib/bakker.rb

@@ -0,0 +1,29 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Bakker.
+#
+# Bakker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Namespace for projects of Alexander E. Fischer <aef@raxys.net>
+#
+# If you want to be able to simply type Example instead of Aef::Example to
+# address classes in this namespace simply write the following before using the
+# classes:
+#
+#  include Aef
+module Aef
+
+end
+
+require File.join(File.dirname(__FILE__), 'bakker/bakker')

data/lib/bakker/bakker.rb

@@ -0,0 +1,73 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Bakker.
+#
+# Bakker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>
+
+require 'fileutils'
+
+class Aef::BakkerWarning < StandardError; end
+
+# Bakker is a Ruby library and commandline tool to help with simple task of
+# renaming or copying files for quick backup purposes.
+module Aef::Bakker
+  VERSION = '1.1.0'
+  DEFAULT_EXTENSION = '.bak'
+  MODES = [:toggle, :add, :remove]
+  ACTIONS = [:move, :copy]
+
+  module_function
+
+  # For possible options see FileUtils methods cp() and mv()
+  def process(filename, extension = DEFAULT_EXTENSION, mode = MODES.first, action = ACTIONS.first, options = {})
+    raise ArgumentError, 'Action can only be :copy or :move.' unless ACTIONS.include?(action)
+    raise ArgumentError, 'Mode can only be :toggle, :add or :remove.' unless MODES.include?(mode)
+
+    # Regex used for determining if an extension should be added or removed
+    regexp = /#{Regexp.escape(extension)}$/
+
+    # Find out both the basic file name and the extended file name for every
+    # situation possible
+    filename_without_extension = filename.gsub(regexp, '')
+    filename_with_extension = filename_without_extension + extension
+
+    # Check both cases for existence for further processing
+    without_exists = File.exists?(filename_without_extension)
+    with_exists = File.exists?(filename_with_extension)
+
+    # Error if both unextended and extended files or none of them exist
+    #
+    # The mode variable contains symbols :copy or :move which correspond to
+    # methods of class FileUtils which are invoked through the send() method.
+    if without_exists and with_exists
+      raise Aef::BakkerWarning, "Both #{filename_without_extension} and #{filename_with_extension} already exist."
+    elsif without_exists and not with_exists
+      if [:toggle, :add].include?(mode)
+        FileUtils.send(action, filename_without_extension, filename_with_extension, options)
+        filename_with_extension
+      else
+        filename_without_extension
+      end
+    elsif not without_exists and with_exists
+      if [:toggle, :remove].include?(mode)
+        FileUtils.send(action, filename_with_extension, filename_without_extension, options)
+        filename_without_extension
+      else
+        filename_with_extension
+      end
+    else
+      raise Aef::BakkerWarning, "Neither #{filename_without_extension} nor #{filename_with_extension} found."
+    end
+  end
+end