linebreak-cli 2.0.0

data/lib/aef/linebreak/cli.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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 'user-choices'
+require 'aef/linebreak'
+
+# 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.
+#
+# @example Including the namespace
+#   include Aef
+# @author Alexander E. Fischer
+module Aef
+
+  # Namespace for the linebreak library
+  module Linebreak
+
+    # Namespace for the linebreak command-line tool
+    module CLI
+  
+    end
+  end
+end
+
+require 'aef/linebreak/cli/version'
+require 'aef/linebreak/cli/pathname_conversion'
+require 'aef/linebreak/cli/commands/encode'
+require 'aef/linebreak/cli/commands/encodings'
+require 'aef/linebreak/cli/commands/version'

data/lib/aef/linebreak/cli/commands/encode.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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
+    module CLI
+
+      # Command-line sub-command for re-ncoding of files.
+      class EncodeCommand < UserChoices::Command
+        include UserChoices
+      
+        # Prepare configuration sources
+        def add_sources(builder)
+          builder.add_source(
+            CommandLineSource, :usage,
+            "Usage: #$PROGRAM_NAME encode [OPTIONS] [INPUT] [OUTPUT]\n\n",
+            "Convert all linebreak encodings of a file.\n",
+            "Use the environment variable LINEBREAK_SYSTEM to specify a default output encoding.\n"
+          )
+      
+          builder.add_source(EnvironmentSource, :mapping,
+            :system => 'LINEBREAK_SYSTEM'
+          )
+        end
+      
+        # Define configuration options
+        def add_choices(builder)
+          systems = Aef::Linebreak::BREAK_BY_SYSTEM.keys.map{|key| key.to_s}
+          builder.add_choice(:system, :default => 'unix', :type => systems) do |cli|
+            cli.uses_option('-s', '--system SYSTEM',
+              "Output encoding system. Possible settings: #{systems.join(', ')}")
+          end
+      
+          builder.add_choice(:files, :length => 0..2, :type => :pathname) {|cli| cli.uses_arglist}
+        end
+      
+        # Manual option post processing
+        def postprocess_user_choices
+          if @user_choices[:files][0] and @user_choices[:files][0] != Pathname('-')
+            @user_choices[:input] = @user_choices[:files][0].open('r')
+          else
+            @user_choices[:input] = STDIN
+          end
+      
+          if @user_choices[:files][1] and @user_choices[:files][1] != Pathname('-')
+            @user_choices[:output] = @user_choices[:files][1].open('w')
+          else
+            @user_choices[:output] = STDOUT
+          end
+        end
+      
+        # Main program
+        def execute
+          @user_choices[:input].each_line do |line|
+            @user_choices[:output] << Aef::Linebreak.encode(line, @user_choices[:system].to_sym)
+          end
+      
+          [:input, :output].each {|stream| @user_choices[stream].close }
+        end
+      end
+
+    end
+  end
+end

data/lib/aef/linebreak/cli/commands/encodings.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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
+    module CLI
+      
+      # Command-line sub command for encoding detection.
+      class EncodingsCommand < UserChoices::Command
+        include UserChoices
+      
+        # Prepare configuration sources
+        def add_sources(builder)
+          builder.add_source(CommandLineSource, :usage,
+            "Usage: #$PROGRAM_NAME encodings [OPTIONS] [FILE]\n\n",
+            "Detect linebreak encoding systems of a file.\n"
+          )
+        end
+      
+        # Define configuration options
+        def add_choices(builder)
+          builder.add_choice(:ensure, :type => [:string]) do |cli|
+            cli.uses_option('-e', '--ensure SYSTEMLIST',
+              "Verify that given encodings are existent. Separated by commas without spaces. Possible settings: #{Aef::Linebreak::BREAK_BY_SYSTEM.keys.join(', ')}.")
+          end
+      
+          builder.add_choice(:files, :type => :pathname) {|cli| cli.uses_arglist}
+        end
+      
+        # Manual option post processing
+        def postprocess_user_choices
+          if @user_choices[:ensure]
+            @user_choices[:ensure] = @user_choices[:ensure].map{|string| string.to_sym }.to_set
+          end
+      
+          if @user_choices[:files].empty? or @user_choices[:files].include?(Pathname('-'))
+            @user_choices[:files] = [STDIN]
+          end
+        end
+      
+        # Main program
+        def execute
+          systems_by_file = {}
+      
+          @user_choices[:files].each do |file|
+            unless systems_by_file[file]
+              systems_by_file[file] = Set.new
+      
+              file.each_line do |line|
+                systems_by_file[file] = Aef::Linebreak.encodings(line) + systems_by_file[file]
+              end
+            end
+          end
+      
+          failed = false
+      
+          systems_by_file.each do |file, systems|
+            print "#{file}: " unless file == STDIN
+      
+            sorted_systems = systems.sort do |a,b|
+              order = [:unix, :windows, :mac]
+              order.index(a) <=> order.index(b)
+            end
+      
+            print sorted_systems.join(',')
+      
+            if @user_choices[:ensure] and systems != @user_choices[:ensure]
+              failed = true
+              puts ' (failed)'
+            else
+              puts
+            end
+          end
+          
+          exit false if failed
+        end
+      end
+
+    end
+  end
+end

data/lib/aef/linebreak/cli/commands/version.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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
+    module CLI
+
+      # Command-line sub-command to display version and license info.
+      class VersionCommand
+
+        # Main program
+        def execute
+          # Read licensing information from the top of this file
+          license = File.read(__FILE__)[/=begin\n(.*)\n=end/m, 1]
+      
+          puts <<-TEXT
+Linebreak::CLI #{Aef::Linebreak::CLI::VERSION}
+using Linebreak #{Aef::Linebreak::VERSION}
+
+Project: https://github.com/aef/linebreak-cli/
+Documentation: http://rdoc.info/github/aef/linebreak-cli/
+
+#{license}
+          TEXT
+      
+          exit false
+        end
+      end
+
+    end
+  end
+end

data/lib/aef/linebreak/cli/pathname_conversion.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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
+    module CLI
+      
+      # This class adds the type :pathname to user-choices
+      #
+      # @private
+      class ConversionToPathname < UserChoices::Conversion
+        def self.described_by?(conversion_tag)
+          conversion_tag == :pathname
+        end
+      
+        def description
+          "a pathname"
+        end
+      
+        def suitable?(actual)
+          true
+        end
+      
+        def convert(value)
+          case value
+          when Array
+            pathnames = []
+            
+            value.each {|path| pathnames << Pathname(path) }
+      
+            pathnames
+          else
+            Pathname(value)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/aef/linebreak/cli/version.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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
+    module CLI
+  
+      # 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
+end

data/linebreak-cli.gemspec

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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/cli/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'linebreak-cli'
+  s.version     = Aef::Linebreak::CLI::VERSION.dup
+  s.authors     = ['Alexander E. Fischer']
+  s.email       = ['aef@raxys.net']
+  s.homepage    = 'http://github.com/aef/linebreak-cli'
+  s.license     = 'ISC'
+  s.summary     = 'Command-line linebreak system conversion tool'
+  s.description = <<-DESCRIPTION
+Linebreak::CLI is a Ruby command-line tool for conversion of text
+between linebreak encoding formats of unix, windows or mac.
+
+Before Linebreak 2.0.0 this tool was part of the linebreak gem.
+Earlier versions of Linebreak were called BreakVerter.
+  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_dependency('linebreak', '~> 2.0.0')
+  s.add_dependency('user-choices', '~> 1.1.6.1')
+
+  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.add_development_dependency('childprocess', '~> 0.3.1')
+
+  s.cert_chain = "#{ENV['GEM_CERT_CHAIN']}".split(':')
+  s.signing_key = ENV['GEM_SIGNING_KEY']
+end

data/spec/cli_spec.rb

@@ -0,0 +1,163 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Linebreak::CLI.
+
+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" }
+
+  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
+        process, stdout, stderr = command("encode -s fnord #{fixture_path('mac.txt')}")
+        process.wait
+        process.io.stdout.close
+        process.io.stderr.close
+
+        stdout.read.should be_empty
+        stderr.read.should_not be_empty
+      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
+        process, stdout, stderr = command("encodings #{fixture_path('mac.txt')}")
+        process.wait        
+        process.io.stdout.close
+        process.io.stderr.close
+
+        stdout.read.should eql("#{fixture_path('mac.txt')}: mac\n")
+        process.exit_code.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)}
+
+        process, stdout, stderr = command("encodings #{files.join(' ')}")
+        process.wait
+        process.io.stdout.close
+        process.io.stderr.close
+        process.exit_code.should eql 0
+
+        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
+
+      it "should correctly ensure the linebreak encodings of a valid file" do
+        process, stdout, stderr = command("encodings --ensure unix #{fixture_path('unix.txt')}")
+        process.wait
+        process.io.stdout.close
+        process.io.stderr.close
+        process.exit_code.should eql 0
+
+        stdout.read.should eql "#{fixture_path('unix.txt')}: unix\n"
+      end
+
+      it "should correctly ensure the linebreak encodings of an invalid file" do
+        process, stdout, stderr = command("encodings --ensure mac #{fixture_path('unix_windows.txt')}")
+        process.wait
+        process.io.stdout.close
+        process.io.stderr.close
+        process.exit_code.should eql 1
+
+        stdout.read.should eql "#{fixture_path('unix_windows.txt')}: unix,windows (failed)\n"
+      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)}
+
+        process, stdout, stderr = command("encodings --ensure windows,unix #{files.join(' ')}")
+        process.wait
+        process.io.stdout.close
+        process.io.stderr.close
+        process.exit_code.should eql 1
+
+        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
+    end
+  end
+end