aef-linebreak 1.3.0

data/History.txt

@@ -0,0 +1,68 @@
+=== 1.3.0 / 2009-08-11
+
+* major enhancements
+
+  * Included methods for linebreak system detection and ensuring
+  * Overhauled commandline tool to support detection and ensuring
+  * BreakVerter renamed to Linebreak for better recognition
+
+* minor enhancements
+
+  * String extension now loadable via require
+  * Most of the specifications now run on JRuby
+  * Used the Pathname class where possible
+  * Upgraded to use the latest hoe gem
+
+=== 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,24 @@
+History.txt
+Manifest.txt
+README.rdoc
+COPYING.txt
+Rakefile
+bin/linebreak
+lib/aef/linebreak.rb
+lib/aef/linebreak/string_extension.rb
+lib/aef/linebreak/commands/encode.rb
+lib/aef/linebreak/commands/encodings.rb
+lib/aef/linebreak/commands/version.rb
+lib/aef/linebreak/pathname_conversion.rb
+lib/aef/linebreak/linebreak.rb
+lib/aef.rb
+spec/spec_helper.rb
+spec/linebreak_spec.rb
+spec/spec.opts
+spec/fixtures/unix.txt
+spec/fixtures/windows.txt
+spec/fixtures/mac.txt
+spec/fixtures/unix_windows.txt
+spec/fixtures/windows_mac.txt
+spec/fixtures/mac_unix.txt
+spec/fixtures/unix_windows_mac.txt

data/README.rdoc

@@ -0,0 +1,232 @@
+= Linebreak
+
+* Project: https://rubyforge.org/projects/linebreak/
+* RDoc: http://linebreak.rubyforge.org/
+* Github: http://github.com/aef/linebreak/
+
+== DESCRIPTION:
+
+Linebreak is a Ruby library and commandline tool for conversion of text
+between linebreak encoding formats of unix, windows or mac.
+
+== FEATURES/PROBLEMS:
+
+* Completely written in Ruby
+* Core class extensions are optionally loadable
+* Tested and fully working on:
+  * Ubuntu Linux 9.04 i386_64
+    * Ruby 1.8.7p72
+    * Ruby 1.9.1p129
+    * JRuby 1.3.1 (22 tests fail, but it's fully usable)
+  * Debian GNU/Linux 4.0 i386
+    * Ruby 1.8.6
+  * Windows XP i386
+    * Ruby 1.8.6 (tests fail completely because of problems with popen4)
+* The commandline tool does only work with a patched user-choices gem on Ruby
+  1.9 or higher. See the INSTALL section for further instructions.
+
+== SYNOPSIS:
+
+=== Commandline
+
+The default output encoding is unix. You can also choose mac and windows.
+
+  linebreak encode --system windows unix.txt windows.txt
+
+If no target file is specified the output will be sent to STDOUT.
+
+  linebreak encode --system windows mac.txt > windows.txt
+
+You can set the default with the environment variable LINEBREAK_SYSTEM.
+
+  export LINEBREAK_SYSTEM=mac
+
+  linebreak encode windows.txt mac.txt
+  
+If you do not specify an output file, output will be put to STDOUT. If you also
+do not specify an input file, input will be expected from STDIN.
+  
+You can also detect the linebreak systems contained in a file in the following
+way:
+
+  linebreak encodings windows_mac.txt
+  
+If you want to ensure that a file contains the exact encodings systems you
+specified, you can use the following command:
+
+  linebreak encodings --ensure unix,windows,mac unix.txt
+
+The results will be outputted. In case of a file containing other linebreak
+encoding systems there will be an exit code of 1.
+
+It is also possible to specify multiple input files or none to expect input from
+STDIN.
+
+=== Library
+
+First of all you have to load the Linebreak gem:
+
+  require 'aef/linebreak'
+
+You can put strings or objects responding to to_s into the  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, while
+Commodore machines also use the :mac linebreak encoding.
+
+  windows_string = "Abcdef\r\nAbcdef\r\nAbcdef"
+
+  Aef::Linebreak.encode(windows_string, :unix)
+  #=> "Abcdef\nAbcdef\nAbcdef"
+  
+You can detect which decoding systems are used in a string:
+
+  mixed_unix_and_mac_string = "Abcdef\rAbcdef\nAbcdef"
+
+  Aef::Linebreak.encodings(mixed_unix_and_mac_string)
+  #=> #<Set: {:unix, :mac}>
+
+You can also easily ensure that a string contains exactly the linebreak
+encodings you expect it to contain:
+
+  mixed_windows_and_mac_string = "Abcdef\r\nAbcdef\rAbcdef"
+
+  Aef::Linebreak.encoding?(mixed_windows_and_mac_string, :windows)
+  #=> false
+
+  Aef::Linebreak.encoding?(mixed_windows_and_mac_string, :windows, :mac)
+  #=> true
+  
+Note that the expected linebreak systems could also be given as an array or a
+set.
+
+Alternatively you could include Linebreak into the String class and use it in
+the following way:
+
+  require 'aef/linebreak/string_extension'
+
+  "Abcdef\nAbcdef\nAbcdef".linebreak_encode(:mac)
+  #=> "Abcdef\rAbcdef\rAbcdef"
+  
+  "Abcdef\r\nAbcdef\nAbcdef".linebreak_encodings
+  #=> #<Set: {:unix, :windows}>
+  
+  "Abcdef\nAbcdef\nAbcdef".linebreak_encoding?(:unix, :windows)
+  #=> false
+  
+  "Abcdef\nAbcdef\nAbcdef".linebreak_encoding?(:unix)
+  #=> true
+
+== REQUIREMENTS:
+
+* rubygems
+
+=== Additional for commandline
+* user-choices
+
+=== Additional for automated testing
+* hoe
+* rspec
+* popen4
+
+== INSTALL:
+
+On *nix systems you may need to prefix the command with sudo to get root
+privileges.
+
+If you want to use the commandline tool you need to install the following gem
+manually:
+
+  gem install user-choices
+  
+On Ruby 1.9 or higher you need to install an inofficially updated version from
+github instead:
+
+  gem install qoobaa-user-choices --source http://gems.github.com
+  
+You could also patch the normal user-choices gem yourself with a patch written
+by me. You can find it here: https://rubyforge.org/tracker/index.php?func=detail&aid=24307&group_id=4192&atid=16176
+
+=== 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 linebreak --ignore-dependencies -P HighSecurity
+
+Please notice that you may need other keys for dependent libraries, so you may
+have to install dependencies manually.  
+
+=== Normal (insecure)
+
+  gem install linebreak
+
+=== Github (also insecure)
+
+Alternatively you could install linebreak from github which may be a bit more
+up to date. The version may however not be as stable as the normal gem and there
+is no way to install the gem securely. Therefore this is not recommended.
+
+  gem install aef-linebreak --source http://gems.github.com
+
+=== Automated testing
+
+You can test this package through rspec on your system. First find the path
+where the gem was installed to:
+
+  gem which aef/linebreak
+
+Go into the root directory of the installed gem and run the following command
+to start the test runner:
+
+  rake spec
+
+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/linebreak.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 Linebreak.
+
+Linebreak 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,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec('linebreak') do
+  developer('Alexander E. Fischer', 'aef@raxys.net')
+
+  self.rubyforge_name = 'linebreak'
+  self.extra_dev_deps = %w{user-choices rspec popen4}
+  self.url = 'https://rubyforge.org/projects/aef/'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = %w{README.rdoc}
+  self.spec_extras = {
+    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'Linebreak']
+  }
+  self.rspec_options = ['--options', 'spec/spec.opts']
+  self.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/bin/linebreak

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# 
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Linebreak.
+#
+# Linebreak 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 'rubygems'
+
+# 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
+
+require 'lib/aef/linebreak/pathname_conversion' rescue LoadError require 'aef/linebreak/pathname_conversion'
+
+commands_available = {
+  :encode => 'Convert all linebreak encodings of a file',
+  :encodings => 'Detect linebreak encoding systems of a file',
+  :version => 'More information about this program',
+  :'--version' => :version,
+  :'-v' => :version,
+  :'-V' => :version
+}
+
+command_name = ARGV.shift
+command_name = command_name.to_sym if command_name
+
+if commands_available[command_name].nil?
+  puts "Usage: #$PROGRAM_NAME COMMAND"
+  puts
+  puts 'Available commands:'
+  puts
+  padding = commands_available.keys.map{|symbol| symbol.to_s}.max{|a,b| a.size <=> b.size}.size
+  commands_available.each do |command_name, description|
+    unless description.is_a?(Symbol)
+      printf "%-#{padding}s\t%s\n", command_name, description
+    end
+  end
+  exit false
+else
+  if commands_available[command_name].is_a?(Symbol)
+    command_name = commands_available[command_name]
+  end
+
+  begin
+    require "lib/aef/linebreak/commands/#{command_name}"
+  rescue LoadError
+    require "aef/linebreak/commands/#{command_name}"
+  end
+
+  command = Aef::Linebreak.const_get("#{command_name.to_s.capitalize}Command").new
+  S4tUtils.with_pleasant_exceptions {command.execute}
+end

data/lib/aef.rb

@@ -0,0 +1,27 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Linebreak.
+#
+# Linebreak 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

data/lib/aef/linebreak.rb

@@ -0,0 +1,18 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of Linebreak.
+#
+# Linebreak 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 'lib/aef/linebreak/linebreak' rescue LoadError require 'aef/linebreak/linebreak'