aef-breakverter 1.2.0

data/History.txt

@@ -0,0 +1,53 @@
+=== 1.2.0 / 2009-04-05
+
+* 2 major enhancements
+
+  * Namespaced into module Aef
+  * Instance method added for on demand inclusion into the String class
+
+* 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.1.1 / 2009-03-08
+
+* minor enhancement
+
+  * Added a --version command to output version and licensing information
+  * Some test refactoring
+  * Some more comments
+
+=== 1.1.0 / 2009-03-01
+
+* 2 major enhancements
+
+  * Added automated tests for the commandline tool
+  * Tested compatibility with ruby 1.9.1
+
+* 1 minor enhancement
+
+  * Added support for custom string linebreak encodings in library
+
+=== 1.0.1 / 2009-02-24
+
+* 1 minor enhancement
+
+  * Now tested on Windows XP
+
+* 1 minor bugfix
+
+  * Bugfixes for commandline use
+
+=== 1.0.0 / 2009-02-24
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+COPYING.txt
+Rakefile
+bin/breakverter
+lib/breakverter.rb
+lib/breakverter/breakverter.rb
+spec/breakverter_spec.rb
+spec/fixtures/unix.txt
+spec/fixtures/windows.txt
+spec/fixtures/mac.txt

data/README.rdoc

@@ -0,0 +1,161 @@
+= BreakVerter
+
+* Project: https://rubyforge.org/projects/aef/
+* RDoc: http://aef.rubyforge.org/breakverter/
+* Github: http://github.com/aef/breakverter/
+
+== DESCRIPTION:
+
+BreakVerter is a Ruby library and commandline tool for conversion of text
+between linebreak encoding formats of unix, windows or mac.
+
+== 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)
+  * Windows XP i386 (Ruby 1.8.6)
+* 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 default output encoding is unix. You can also choose mac and windows.
+
+  breakverter -o windows unix.txt windows.txt
+
+If no target file is specified the output will be sent to STDOUT.
+
+  breakverter -o windows mac.txt > windows.txt
+
+You can set the default with the environment variable BREAKVERTER_OUTPUT.
+
+  export BREAKVERTER_OUTPUT=mac
+
+  breakverter windows.txt mac.txt
+
+=== Library
+
+First of all you have to load the BreakVerter gem:
+
+  require 'breakverter'
+
+You can put strings or objects responding to to_s into the convert method and
+optionally define a target linebreak encoding. The default encoding is :unix.
+You can also choose :mac and :windows. Notice that the :mac encoding is
+deprecated. Modern Apple machines also use :unix linebreak encoding.
+
+  windows_string = "Abcdef\r\nAbcdef\r\nAbcdef"
+
+  Aef::BreakVerter.convert(windows_string, :unix) #=> "Abcdef\nAbcdef\nAbcdef"
+
+Alternatively you could include BreakVerter into the String class and use it in
+the following way:
+
+  class String
+    include Aef::BreakVerter
+  end
+
+  "Abcdef\nAbcdef\nAbcdef".linebreaks(:mac) #=> "Abcdef\rAbcdef\rAbcdef"
+
+== REQUIREMENTS:
+
+* rubygems
+
+=== Additional for commandline
+* user-choices
+
+=== Additional for automated testing
+* hoe
+* rspec
+* sys-uname
+
+== INSTALL:
+
+=== Normal
+
+  gem install breakverter
+
+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 breakverter --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 breakverter
+
+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/breakverter.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 BreakVerter.
+
+BreakVerter 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/breakverter.rb'
+
+Hoe.new('breakverter', Aef::BreakVerter::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', 'BreakVerter']
+  }
+end
+
+# vim: syntax=Ruby

data/bin/breakverter

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# 
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of BreakVerter.
+#
+# BreakVerter 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/breakverter'
+rescue LoadError
+  require 'rubygems'
+  require 'breakverter'
+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::BreakVerter::Application < UserChoices::Command
+  include UserChoices
+
+  # Prepare configuration sources
+  def add_sources(builder)
+    builder.add_source(
+      CommandLineSource, :usage,
+      "Usage: #$PROGRAM_NAME [options] input-file [output-file]\n\n",
+      "Convert a file with any linebreak encoding to a specific linebreak encoding.\n",
+      "Use the environment variable BREAKVERTER_OUTPUT to specify a default output encoding.\n"
+    )
+
+    builder.add_source(EnvironmentSource, :mapping,
+      :output => 'BREAKVERTER_OUTPUT'
+    )
+  end
+
+  # Define configuration options
+  def add_choices(builder)
+    output_values = Aef::BreakVerter::BREAKS.keys.map{|key| key.to_s}
+    builder.add_choice(:output, :default => 'unix', :type => output_values) do |cli|
+      cli.uses_option('-o', '--output PLATFORM',
+        "Output formatting. Possible settings: #{Aef::BreakVerter::BREAKS.keys.join(', ')}")
+    end
+
+    builder.add_choice(:version, :default => false, :type => :boolean) do |cli|
+      cli.uses_switch('-v', '--version', 'Display version and licensing information')
+    end
+
+    builder.add_choice(:filenames, :length => 0..2) {|cli| cli.uses_arglist}
+  end
+
+  # Manual option post processing
+  def postprocess_user_choices
+    version if @user_choices[:version]
+
+    @user_choices[:input_filename] = @user_choices[:filenames][0]
+    @user_choices[:output_filename] = @user_choices[:filenames][1] || '-'
+  end
+
+  # Version and licensing information output
+  def version
+    name = 'BreakVerter'
+    puts "#{name} #{Aef::BreakVerter::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
+    unless @user_choices[:input_filename]
+      warn 'No input file given'; exit false
+    end
+
+    unless File.exists?(@user_choices[:input_filename])
+      warn "Input file not found (#{@user_choices[:input_filename]})"; exit false
+    end
+
+    unless File.readable?(@user_choices[:input_filename])
+      warn "Input file access denied (#{@user_choices[:input_filename]})"; exit false
+    end
+    
+    result = Aef::BreakVerter.convert(File.read(@user_choices[:input_filename]), @user_choices[:output].to_sym)
+
+    if @user_choices[:output_filename] == '-'
+      puts result
+    else
+      @user_choices[:output_filename]
+
+      unless File.writable?(File.dirname(@user_choices[:output_filename]))
+        warn "Output file access denied (#{@user_choices[:output_filename]})"; exit false
+      end
+      
+      File.open(@user_choices[:output_filename], 'w') {|f| f.write(result)}
+    end
+  end
+end
+
+S4tUtils.with_pleasant_exceptions {Aef::BreakVerter::Application.new.execute}

data/lib/breakverter.rb

@@ -0,0 +1,29 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of BreakVerter.
+#
+# BreakVerter 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__), 'breakverter/breakverter')

data/lib/breakverter/breakverter.rb

@@ -0,0 +1,45 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of BreakVerter.
+#
+# BreakVerter 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/>.
+
+# BreakVerter is Ruby library and commandline tool for conversion of text
+# between linebreak encoding formats of unix, windows or mac.
+module Aef::BreakVerter
+  VERSION = '1.2.0'
+  
+  BREAKS = {
+    :unix => "\n",
+    :windows => "\r\n",
+    :mac => "\r"
+  }
+
+  # Convert a file with any linebreak encoding to a specific linebreak encoding.
+  #
+  # If given output_encoding is not a key of BREAKS, all linebreaks are replaced
+  # with output_encoding's content itself.
+  def self.convert(input, output_encoding = :unix)
+    if input.respond_to?(:to_s) then input = input.to_s
+    else raise 'Input has to be a string or must support to_s' end
+
+    input.gsub(/\r(?:\n)?|\n/, BREAKS[output_encoding] || output_encoding)
+  end
+
+  # Shortcut for direct receiver conversion, for example if BreakVerter is
+  # included into the string class
+  def linebreaks(output_encoding = :unix)
+    Aef::BreakVerter.convert(self, output_encoding)
+  end
+end