breakverter 1.1.0 → 1.1.1

data/History.txt

@@ -1,15 +1,34 @@
+=== 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
 
-* Tested compatibility with ruby 1.9.1
-* Added support for custom string linebreak encodings in library
-* Added automated tests for the commandline tool
+* 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
 
-* Now tested on Windows XP
-* Bugfixes for commandline use
+* 1 minor enhancement
+
+  * Now tested on Windows XP
+
+* 1 minor bugfix
+
+  * Bugfixes for commandline use
 
 === 1.0.0 / 2009-02-24
 
-* Initial release
+* 1 major enhancement
 
+  * Birthday!

data/README.txt

@@ -10,9 +10,11 @@ to any of these formats.
 
 == FEATURES/PROBLEMS:
 
-* Usable as library and commandline tool.
-* Tested on Ubuntu Linux 8.10 and Windows XP
-* Compatible with ruby 1.9.1 (only the library part because of the not yet compatible user-choices gem)
+* Usable as library and commandline tool
+* Tested and fully working on:
+  * Windows XP i386 (Ruby 1.8.6)
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+* 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:
 
@@ -38,6 +40,7 @@ The default output encoding is unix. You can set the default with the environmen
 == INSTALL:
 
 * gem install breakverter
+* gem install user-choices (only for commandline tool)
 
 == LICENSE:
 

data/bin/breakverter

@@ -17,6 +17,10 @@
 # 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
@@ -24,10 +28,11 @@ rescue LoadError
   require 'breakverter'
 end
 
+# User friendly message if user-choices is not available
 begin
   require 'user-choices'
 rescue LoadError
-  puts 'This command needs the user-choices gem to be installed'; exit
+  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
@@ -38,7 +43,7 @@ class BreakVerter::Application < UserChoices::Command
   def add_sources(builder)
     builder.add_source(
       CommandLineSource, :usage,
-      "Usage: #$PROGRAM_NAME [options] input-file [output-file]",
+      "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"
     )
@@ -56,6 +61,10 @@ class BreakVerter::Application < UserChoices::Command
         "Output formatting. Possible settings: #{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 => 1..2) {|cli| cli.uses_arglist}
   end
 
@@ -67,18 +76,54 @@ class BreakVerter::Application < UserChoices::Command
 
   # Main program
   def execute
-    raise "Input file not found (#{@user_choices[:input_filename]})" unless File.exists?(@user_choices[:input_filename])
-    raise "Input file access denied (#{@user_choices[:input_filename]})" unless File.readable?(@user_choices[:input_filename])
+    if @user_choices[:version]
+      klass = Breakverter
+      puts "\n#{klass.name} #{klass::VERSION}"
+      puts DATA.read; exit
+    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 = 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]
-      raise "Output file access denied (#{@user_choices[:output_filename]})" unless File.writable?(File.dirname(@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 {BreakVerter::Application.new.execute}
+
+__END__
+
+Project: https://rubyforge.org/projects/aef/
+RDoc: http://aef.rubyforge.org/breakverter/
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+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/lib/breakverter.rb

@@ -17,7 +17,7 @@
 
 # Module containing a single method
 module BreakVerter
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
   
   BREAKS = {
     :unix => "\n",

data/spec/breakverter_spec.rb

@@ -43,6 +43,10 @@ module BreakVerterSpecHelper
   def custom_fixture
     "AbcdeffnordAbcdeffnordAbcdef"
   end
+
+  def windows?
+    Sys::Uname.sysname.downcase.include?('windows')
+  end
 end
 
 describe BreakVerter do
@@ -105,7 +109,7 @@ describe BreakVerter do
     end
 
     it 'should accept BREAKVERTER_OUTPUT environment variable to specify output format' do
-      if Sys::Uname.sysname.downcase.include?('windows')
+      if windows?
         `set BREAKVERTER_OUTPUT=mac`
         `#{RUBY_PATH} bin/breakverter --output mac spec/fixtures/windows.txt`.should eql(mac_fixture + "\n")
       else
@@ -114,7 +118,7 @@ describe BreakVerter do
     end
 
     it 'should use output format specified with -o even if BREAKVERTER_OUTPUT environment variable is set' do
-      if Sys::Uname.sysname.downcase.include?('windows')
+      if windows?
         `set BREAKVERTER_OUTPUT=windows`
         `#{RUBY_PATH} bin/breakverter -o mac spec/fixtures/unix.txt`.should eql(mac_fixture + "\n")
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: breakverter
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Alexander E. Fischer
@@ -29,7 +29,7 @@ cert_chain:
   55akF+N8NbO6tpVDy6TMagqa10LfEpiQH6dvDHe/xdAqYOCrXKpmqzwu2PI=
   -----END CERTIFICATE-----
 
-date: 2009-03-01 00:00:00 +01:00
+date: 2009-03-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency