breakverter 1.0.1 → 1.1.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 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
+
 === 1.0.1 / 2009-02-24
 
 * Now tested on Windows XP

data/Manifest.txt

@@ -6,3 +6,6 @@ Rakefile
 bin/breakverter
 lib/breakverter.rb
 spec/breakverter_spec.rb
+spec/fixtures/unix.txt
+spec/fixtures/windows.txt
+spec/fixtures/mac.txt

data/README.txt

@@ -11,7 +11,8 @@ to any of these formats.
 == FEATURES/PROBLEMS:
 
 * Usable as library and commandline tool.
-* Tested on Ubuntu Linux and Windows XP
+* 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)
 
 == SYNOPSIS:
 

data/Rakefile

@@ -7,7 +7,7 @@ require './lib/breakverter.rb'
 Hoe.new('breakverter', BreakVerter::VERSION) do |p|
   p.rubyforge_name = 'aef'
   p.developer('Alexander E. Fischer', 'aef@raxys.net')
-  p.extra_dev_deps = %w{rspec user-choices}
+  p.extra_dev_deps = %w{rspec user-choices sys-uname}
   p.testlib = 'spec'
   p.test_globs = ['spec/**/*_spec.rb']
 end

data/bin/breakverter

@@ -17,8 +17,12 @@
 # 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'
-require 'breakverter'
+begin
+  require 'lib/breakverter'
+rescue LoadError
+  require 'rubygems'
+  require 'breakverter'
+end
 
 begin
   require 'user-choices'
@@ -65,7 +69,7 @@ class BreakVerter::Application < UserChoices::Command
   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])
-    result = BreakVerter.convert(File.read(@user_choices[:input_filename]), @user_choices[:output])
+    result = BreakVerter.convert(File.read(@user_choices[:input_filename]), @user_choices[:output].to_sym)
 
     if @user_choices[:output_filename] == '-'
       puts result

data/lib/breakverter.rb

@@ -17,7 +17,7 @@
 
 # Module containing a single method
 module BreakVerter
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
   
   BREAKS = {
     :unix => "\n",
@@ -26,14 +26,13 @@ module BreakVerter
   }
 
   # 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
 
-    if output_encoding.respond_to?(:to_sym) then output_encoding = output_encoding.to_sym
-    else raise 'Output encoding has to be a symbol or must support to_sym' end
-
-    raise 'Output encoding unsupported' unless BREAKS.include?(output_encoding)
-    input.gsub(/\r(?:\n)?|\n/, BREAKS[output_encoding])
+    input.gsub(/\r(?:\n)?|\n/, BREAKS[output_encoding] || output_encoding)
   end
 end

data/spec/breakverter_spec.rb

@@ -15,7 +15,17 @@
 # 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 'breakverter'
+require 'lib/breakverter'
+require 'tempfile'
+
+require 'rubygems'
+require 'sys/uname'
+
+# If there is a way to get the executable path of the currently running ruby
+# interpreter, please tell me how.
+warn 'Attention: If the ruby interpreter to be tested with is not ruby in the' +
+     'default path, you have to change this manually in spec/breakverter_spec.rb'
+RUBY_PATH = 'ruby'
 
 module BreakVerterSpecHelper
   def unix_fixture
@@ -29,38 +39,99 @@ module BreakVerterSpecHelper
   def mac_fixture
     "Abcdef\rAbcdef\rAbcdef"
   end
+
+  def custom_fixture
+    "AbcdeffnordAbcdeffnordAbcdef"
+  end
 end
 
 describe BreakVerter do
   include BreakVerterSpecHelper
 
-  it 'should complain about invalid output formats' do
-    lambda {
-      BreakVerter.convert(unix_fixture, :invalid)
-    }.should raise_error(RuntimeError, 'Output encoding unsupported')
-  end
+  describe 'library' do
+    it 'should convert correctly from unix to windows format' do
+      BreakVerter.convert(unix_fixture, :windows).should eql(windows_fixture)
+    end
 
-  it 'should convert correctly from unix to windows format' do
-    BreakVerter.convert(unix_fixture, :windows).should eql(windows_fixture)
-  end
+    it 'should convert correctly from unix to mac format' do
+      BreakVerter.convert(unix_fixture, :mac).should eql(mac_fixture)
+    end
 
-  it 'should convert correctly from unix to mac format' do
-    BreakVerter.convert(unix_fixture, :mac).should eql(mac_fixture)
-  end
+    it 'should convert correctly from unix to a custom format' do
+      BreakVerter.convert(unix_fixture, 'fnord').should eql(custom_fixture)
+    end
 
-  it 'should convert correctly from windows to unix format' do
-    BreakVerter.convert(windows_fixture, :unix).should eql(unix_fixture)
-  end
+    it 'should convert correctly from windows to unix format' do
+      BreakVerter.convert(windows_fixture, :unix).should eql(unix_fixture)
+    end
 
-  it 'should convert correctly from windows to mac format' do
-    BreakVerter.convert(windows_fixture, :mac).should eql(mac_fixture)
-  end
+    it 'should convert correctly from windows to mac format' do
+      BreakVerter.convert(windows_fixture, :mac).should eql(mac_fixture)
+    end
+
+    it 'should convert correctly from unix to a custom format' do
+      BreakVerter.convert(windows_fixture, 'fnord').should eql(custom_fixture)
+    end
 
-  it 'should convert correctly from mac to unix format' do
-    BreakVerter.convert(mac_fixture, :unix).should eql(unix_fixture)
+    it 'should convert correctly from mac to unix format' do
+      BreakVerter.convert(mac_fixture, :unix).should eql(unix_fixture)
+    end
+
+    it 'should convert correctly from mac to windows format' do
+      BreakVerter.convert(mac_fixture, :windows).should eql(windows_fixture)
+    end
+
+    it 'should convert correctly from unix to a custom format' do
+      BreakVerter.convert(mac_fixture, 'fnord').should eql(custom_fixture)
+    end
   end
 
-  it 'should convert correctly from mac to windows format' do
-    BreakVerter.convert(mac_fixture, :windows).should eql(windows_fixture)
+  describe 'commandline tool' do
+    it 'should use unix as default format' do
+      `#{RUBY_PATH} bin/breakverter spec/fixtures/windows.txt`.should eql(unix_fixture + "\n")
+    end
+
+    it 'should accept -o option to specify output format' do
+      `#{RUBY_PATH} bin/breakverter -o mac spec/fixtures/unix.txt`.should eql(mac_fixture + "\n")
+    end
+
+    it 'should also accept --output option to specify output format' do
+      `#{RUBY_PATH} bin/breakverter -o windows spec/fixtures/mac.txt`.should eql(windows_fixture + "\n")
+    end
+
+    it 'should abort on invalid output formats' do
+      puts "\nAn error output after this line is expected behavior, simply ignore it:\n"
+      `#{RUBY_PATH} bin/breakverter -o fnord spec/fixtures/mac.txt`.should be_empty
+    end
+
+    it 'should accept BREAKVERTER_OUTPUT environment variable to specify output format' do
+      if Sys::Uname.sysname.downcase.include?('windows')
+        `set BREAKVERTER_OUTPUT=mac`
+        `#{RUBY_PATH} bin/breakverter --output mac spec/fixtures/windows.txt`.should eql(mac_fixture + "\n")
+      else
+        `env BREAKVERTER_OUTPUT=mac #{RUBY_PATH} bin/breakverter --output mac spec/fixtures/windows.txt`.should eql(mac_fixture + "\n")
+      end
+    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')
+        `set BREAKVERTER_OUTPUT=windows`
+        `#{RUBY_PATH} bin/breakverter -o mac spec/fixtures/unix.txt`.should eql(mac_fixture + "\n")
+      else
+        `env BREAKVERTER_OUTPUT=windows #{RUBY_PATH} bin/breakverter -o mac spec/fixtures/unix.txt`.should eql(mac_fixture + "\n")
+      end
+    end
+
+    it 'should use a second argument as target file' do
+      temp_file = Tempfile.open('breakverter_spec')
+      location = temp_file.path
+      temp_file.close
+      temp_file.unlink
+
+      `#{RUBY_PATH} bin/breakverter --output windows spec/fixtures/unix.txt #{location}`.should be_empty
+
+      File.read(location).should eql(windows_fixture)
+      File.unlink(location)
+    end
   end
 end

data/spec/fixtures/mac.txt

@@ -0,0 +1 @@
+Abcdef

data/spec/fixtures/unix.txt

@@ -0,0 +1,3 @@
+Abcdef
+Abcdef
+Abcdef

data/spec/fixtures/windows.txt

@@ -0,0 +1,3 @@
+Abcdef
+Abcdef
+Abcdef

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: breakverter
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Alexander E. Fischer
@@ -29,7 +29,7 @@ cert_chain:
   55akF+N8NbO6tpVDy6TMagqa10LfEpiQH6dvDHe/xdAqYOCrXKpmqzwu2PI=
   -----END CERTIFICATE-----
 
-date: 2009-02-25 00:00:00 +01:00
+date: 2009-03-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: sys-uname
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -74,6 +84,9 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 - COPYING.txt
+- spec/fixtures/unix.txt
+- spec/fixtures/windows.txt
+- spec/fixtures/mac.txt
 files: 
 - History.txt
 - Manifest.txt
@@ -83,6 +96,9 @@ files:
 - bin/breakverter
 - lib/breakverter.rb
 - spec/breakverter_spec.rb
+- spec/fixtures/unix.txt
+- spec/fixtures/windows.txt
+- spec/fixtures/mac.txt
 has_rdoc: true
 homepage: "Project: https://rubyforge.org/projects/aef/"
 post_install_message: