linebreak 1.3.1 → 2.0.0

data/lib/aef/linebreak.rb

@@ -1,27 +1,149 @@
-# 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/>.
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
 
-# Namespace for projects of Alexander E. Fischer <aef@raxys.net>
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'set'
+require 'aef/linebreak/version'
+
+# 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:
+# classes.
 #
-#  include Aef
+# @example Including the namespace
+#   include Aef
+# @author Alexander E. Fischer
 module Aef
-  autoload :Linebreak, 'aef/linebreak/linebreak'
+
+  # Namespace for the linebreak library
+  module Linebreak
+
+    # Mapping table from symbol to actual linebreak sequence
+    #
+    # @private
+    BREAK_BY_SYSTEM = {
+      :unix => "\n",
+      :windows => "\r\n",
+      :mac => "\r"
+    }
+  
+    # Mapping table from actual linebreak sequence to symbol
+    #
+    # @private
+    SYSTEM_BY_BREAK = BREAK_BY_SYSTEM.invert
+  
+    # Regular expression for linebreak detection and extraction
+    #
+    # @private
+    BREAK_REGEXP = /(\r\n|[\r\n])/
+  
+    # Detects encoding systems of a string.
+    #
+    # @param [String] input a String to be analysed
+    # @return [Set<Symbol>] the encoding systems present in the given String
+    def self.encodings(input)
+      if input.respond_to?(:to_s) then input = input.to_s
+      else raise ArgumentError, 'Input needs to be a string or must support to_s' end
+  
+      occurences = Set.new
+  
+      input.scan(BREAK_REGEXP).each do |linebreak|
+        occurences << SYSTEM_BY_BREAK[linebreak.first]
+      end
+  
+      occurences
+    end
+  
+    # Checks whether a string includes linebreaks of all the given encoding
+    # systems.
+    #
+    # @param [String] input a String to be analysed
+    # @param [Array<Symbol>] encodings one or more encoding systems
+    # @return [true, false] true if all of the given linebreak systems are
+    #   present in the given String
+    def self.encoding?(input, *encodings)
+      systems = BREAK_BY_SYSTEM.keys
+      
+      encodings.flatten!
+      encodings.each do |encoding|
+        unless systems.include?(encoding)
+          raise ArgumentError,
+            %{Invalid encoding system. Available systems: #{systems.join(', ')}. Arguments are expected as symbols or an array of symbols.}
+        end
+      end
+  
+      Aef::Linebreak.encodings(input) == Set.new(encodings)
+    end
+  
+    # Create a copy of a string with all the string's linebreaks replaced by
+    # linebreaks of a specific system or a given replacement.
+    #
+    # @overload encode(input, system)
+    #   @param [String] input a String as conversion template
+    #   @param [:unix, :windows, :mac] system a target linebreak system
+    #
+    # @overload encode(input, replacement)
+    #   @param [String] input a String as conversion template
+    #   @param [String] replacement a String to be the replacement for all 
+    #     linebreaks in the template
+    def self.encode(input, system_or_replacement = :unix)
+      if input.respond_to?(:to_s) then input = input.to_s
+      else raise ArgumentError, 'Input needs to be a string or must support to_s' end
+  
+      input.gsub(BREAK_REGEXP,
+        BREAK_BY_SYSTEM[system_or_replacement] || system_or_replacement)
+    end
+  
+    # Detects encoding systems of a string.
+    #
+    # This method is supposed to be used as a method of String.
+    #
+    # @return [Set<Symbol>] the encoding systems present in the String
+    def linebreak_encodings
+      Aef::Linebreak.encodings(self)
+    end
+  
+    # Checks whether a string includes linebreaks of all the given encoding
+    # systems.
+    #
+    # This method is supposed to be used as a method of String.
+    #
+    # @param [Array<Symbol>] encodings one or more encoding systems
+    # @return [true, false] true if all of the given linebreak systems are
+    #   present in the given String
+    def linebreak_encoding?(*encodings)
+      Aef::Linebreak.encoding?(self, encodings)
+    end
+  
+    # Create a copy of a string with all the string's linebreaks replaced by
+    # linebreaks of a specific system or a given replacement.
+    #
+    # This method is supposed to be used as a method of String.
+    #
+    # @overload encode(system)
+    #   @param [:unix, :windows, :mac] system a target linebreak system
+    #
+    # @overload encode(replacement)
+    #   @param [String] replacement a String to be the replacement for all 
+    #     linebreaks in the template
+    def linebreak_encode(system_or_replacement = :unix)
+      Aef::Linebreak.encode(self, system_or_replacement)
+    end
+  end
 end

data/lib/aef/linebreak/version.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module Aef
+  module Linebreak
+
+    # The currently loaded library version
+    #
+    # Using Semantic Versioning (2.0.0-rc.1) rules
+    # @see http://semver.org/
+    VERSION = '2.0.0'.freeze
+    
+  end
+end

data/lib/linebreak.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/linebreak'
+
+String.send(:include, Aef::Linebreak)

data/lib/linebreak/bare.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'aef/linebreak'

data/linebreak.gemspec

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require File.expand_path('../lib/aef/linebreak/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'linebreak'
+  s.version     = Aef::Linebreak::VERSION.dup
+  s.authors     = ['Alexander E. Fischer']
+  s.email       = ['aef@raxys.net']
+  s.homepage    = 'http://github.com/aef/linebreak'
+  s.license     = 'ISC'
+  s.summary     = 'Easy linebreak system conversion library'
+  s.description = <<-DESCRIPTION
+Linebreak is a Ruby library for conversion of text between linebreak encoding
+formats of unix, windows or mac.
+  DESCRIPTION
+
+  s.rubyforge_project = nil
+  s.has_rdoc          = 'yard'
+  s.extra_rdoc_files  = ['HISTORY.md', 'LICENSE.md'] 
+
+  s.files         = `git ls-files`.lines.map(&:chomp)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.lines.map(&:chomp)
+  s.executables   = `git ls-files -- bin/*`.lines.map{|f| File.basename(f.chomp) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_development_dependency('bundler', '~> 1.0.21')
+  s.add_development_dependency('rake', '~> 0.9.2')
+  s.add_development_dependency('rspec', '~> 2.8.0')
+  s.add_development_dependency('simplecov', '~> 0.6.1')
+  s.add_development_dependency('pry', '~> 0.9.8')
+  s.add_development_dependency('yard', '~> 0.7.5')
+
+  s.cert_chain = "#{ENV['GEM_CERT_CHAIN']}".split(':')
+  s.signing_key = ENV['GEM_SIGNING_KEY']
+end

data/spec/linebreak_spec.rb

@@ -1,24 +1,34 @@
-# 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 'spec/spec_helper'
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'spec_helper'
 
 describe Aef::Linebreak do
-  include LinebreakSpecHelper
+  let(:unix_fixture)    { "Abcdef\nAbcdef\nAbcdef" }
+  let(:windows_fixture) { "Abcdef\r\nAbcdef\r\nAbcdef" }
+  let(:mac_fixture)     { "Abcdef\rAbcdef\rAbcdef" }
+  let(:custom_fixture)  { "AbcdeffnordAbcdeffnordAbcdef" }
+  let(:none_fixture)    { "AbcdefAbcdefAbcdef" }
+  let(:unix_windows_fixture) { unix_fixture + windows_fixture }
+  let(:windows_mac_fixture)  { windows_fixture + mac_fixture }
+  let(:mac_unix_fixture)     { mac_fixture + unix_fixture }
+  let(:unix_windows_mac_fixture) { unix_fixture + windows_fixture + mac_fixture }
 
   context 'library' do
     describe 'method "encode"' do
@@ -263,118 +273,4 @@ describe Aef::Linebreak do
 
     end
   end
-
-  context 'commandline tool' do
-    describe '"version" command' do
-      it 'should display correct version and licensing information with the version argument' do
-        `#{executable_path} version`.should eql(version_message)
-      end
-
-      it 'should display correct version and licensing information with the --version argument' do
-        `#{executable_path} --version`.should eql(version_message)
-      end
-
-      it 'should display correct version and licensing information with the -v argument' do
-        `#{executable_path} -v`.should eql(version_message)
-      end
-
-      it 'should display correct version and licensing information with the -V argument' do
-        `#{executable_path} -V`.should eql(version_message)
-      end
-    end
-
-    describe '"encode" command' do
-      it 'should use unix as default format' do
-        `#{executable_path} encode #{fixture_path('windows.txt')}`.should eql(unix_fixture)
-      end
-
-      it 'should accept -s option to specify output format' do
-        `#{executable_path} encode -s mac #{fixture_path('unix.txt')}`.should eql(mac_fixture)
-      end
-
-      it 'should also accept --system option to specify output format' do
-        `#{executable_path} encode --system windows #{fixture_path('mac.txt')}`.should eql(windows_fixture)
-      end
-
-      it 'should abort on invalid output formats' do
-        POpen4.popen4("#{executable_path} encode -s fnord #{fixture_path('mac.txt')}") do |stdout, stderr, stdin, pid|
-          stdout.read.should be_empty
-          stderr.read.should_not be_empty
-        end
-      end
-
-      it 'should accept LINEBREAK_SYSTEM environment variable to specify output format' do
-        env(:LINEBREAK_SYSTEM => 'mac') do
-          `#{executable_path} encode #{fixture_path('windows.txt')}`.should eql(mac_fixture)
-        end
-      end
-
-      it 'should use output format specified with -s even if LINEBREAK_SYSTEM environment variable is set' do
-        env(:LINEBREAK_SYSTEM => 'windows') do
-          `#{executable_path} encode -s mac #{fixture_path('unix.txt')}`.should eql(mac_fixture)
-        end
-      end
-
-      it 'should use a second argument as target file' do
-        temp_file = Tempfile.open('linebreak_spec')
-        location = Pathname(temp_file.path)
-        temp_file.close
-        location.delete
-
-        `#{executable_path} encode --system windows #{fixture_path('unix.txt')} #{location}`.should be_empty
-
-        location.read.should eql(windows_fixture)
-        location.delete
-      end
-    end
-
-    describe '"encodings" command' do
-      it "should correctly detect the linebreak encodings of a file" do
-        POpen4.popen4("#{executable_path} encodings #{fixture_path('mac.txt')}") do |stdout, stderr, stdin, pid|
-          stdout.read.should eql("#{fixture_path('mac.txt')}: mac\n")
-        end.exitstatus.should eql(0)
-      end
-
-      it "should correctly detect the linebreak encodings of multiple files" do
-        files = %w{unix_windows.txt windows_mac.txt mac_unix.txt unix_windows_mac.txt}
-        files = files.map{|file| fixture_path(file)}
-
-        POpen4.popen4("#{executable_path} encodings #{files.join(' ')}") do |stdout, stderr, stdin, pid|
-          output = stdout.read
-          output.should include("#{files[0]}: unix,windows\n")
-          output.should include("#{files[1]}: windows,mac\n")
-          output.should include("#{files[2]}: unix,mac\n")
-          output.should include("#{files[3]}: unix,windows,mac\n")
-        end.exitstatus.should eql(0)
-      end
-
-      it "should correctly ensure the linebreak encodings of a valid file" do
-        POpen4.popen4("#{executable_path} encodings --ensure unix #{fixture_path('unix.txt')}") do |stdout, stderr, stdin, pid|
-          output = stdout.read
-          output.should eql("#{fixture_path('unix.txt')}: unix\n")
-        end.exitstatus.should eql(0)
-      end
-
-      it "should correctly ensure the linebreak encodings of an invalid file" do
-        POpen4.popen4("#{executable_path} encodings --ensure mac #{fixture_path('unix_windows.txt')}") do |stdout, stderr, stdin, pid|
-          output = stdout.read
-          output.should eql("#{fixture_path('unix_windows.txt')}: unix,windows (failed)\n")
-        end.exitstatus.should eql(1)
-      end
-
-      it "should correctly ensure the linebreak encodings of multiple files" do
-        files = %w{unix_windows.txt windows_mac.txt mac_unix.txt unix_windows_mac.txt}
-        files = files.map{|file| fixture_path(file)}
-
-        POpen4.popen4("#{executable_path} encodings --ensure windows,unix #{files.join(' ')}") do |stdout, stderr, stdin, pid|
-          output = stdout.read
-          output.should include("#{files[0]}: unix,windows\n")
-          output.should_not include("#{files[0]}: unix,windows (failed)\n")
-          output.should include("#{files[1]}: windows,mac (failed)\n")
-          output.should include("#{files[2]}: unix,mac (failed)\n")
-          output.should include("#{files[3]}: unix,windows,mac (failed)\n")
-        end.exitstatus.should eql(1)
-      end
-    end
-  end
 end