linebreak 1.3.1 → 2.0.0

data/.gitignore

@@ -0,0 +1,12 @@
+# Project metadata
+nbproject
+.idea
+
+Gemfile.lock
+
+doc
+coverage
+pkg
+.yardoc
+.rbx
+*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,23 @@
+# 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
+
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in weekling.gemspec
+gemspec

data/{History.txt → HISTORY.md}

@@ -1,4 +1,18 @@
-=== 1.3.1 / 2009-09-14
+2.0.0 / 2012-03-10
+==================
+
+* 1 major enhancement
+
+  * Changed to ISC based license
+
+* 3 minor enhancements
+
+  * Slightly restructured project
+  * Extracted the command-line tool into linebreak-cli gem
+  * Documentation converted to YARD syntax
+
+1.3.1 / 2009-09-14
+==================
 
 * 1 major bugfix
 
@@ -8,7 +22,8 @@
 
   * Implemented autoloading
 
-=== 1.3.0 / 2009-08-11
+1.3.0 / 2009-08-11
+==================
 
 * 3 major enhancements
 
@@ -23,7 +38,8 @@
   * Used the Pathname class where possible
   * Upgraded to use the latest hoe gem
 
-=== 1.2.0 / 2009-04-05
+1.2.0 / 2009-04-05
+==================
 
 * 2 major enhancements
 
@@ -42,7 +58,8 @@
 
   * Fixed some bugs related to Ruby 1.8.6
 
-=== 1.1.1 / 2009-03-08
+1.1.1 / 2009-03-08
+==================
 
 * minor enhancement
 
@@ -50,7 +67,8 @@
   * Some test refactoring
   * Some more comments
 
-=== 1.1.0 / 2009-03-01
+1.1.0 / 2009-03-01
+==================
 
 * 2 major enhancements
 
@@ -61,7 +79,8 @@
 
   * Added support for custom string linebreak encodings in library
 
-=== 1.0.1 / 2009-02-24
+1.0.1 / 2009-02-24
+==================
 
 * 1 minor enhancement
 
@@ -71,7 +90,8 @@
 
   * Bugfixes for commandline use
 
-=== 1.0.0 / 2009-02-24
+1.0.0 / 2009-02-24
+==================
 
 * 1 major enhancement
 

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+Linebreak is licensed under the following ISC-style license:
+
+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.

data/README.md

@@ -0,0 +1,255 @@
+Linebreak
+=========
+
+[![Build Status](https://secure.travis-ci.org/aef/linebreak.png)](
+https://secure.travis-ci.org/aef/linebreak)
+
+* [Documentation][docs]
+* [Project][project]
+
+   [docs]:    http://rdoc.info/github/aef/linebreak/
+   [project]: https://github.com/aef/linebreak/
+
+Description
+-----------
+
+Linebreak is a Ruby library for conversion of text between linebreak encoding
+formats of unix, windows or mac.
+
+A command-line tool is available as separate gem named linebreak-cli.
+Earlier versions of Linebreak were called BreakVerter.
+
+Features / Problems
+-------------------
+
+This project tries to conform to:
+
+* [Semantic Versioning (2.0.0-rc.1)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
+
+   [semver]: http://semver.org/
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+
+Additional facts:
+
+* Written purely in Ruby.
+* Documented with YARD.
+* Intended to be used with Ruby 1.8.7 or higher.
+* Extends core classes. This can be disabled through bare mode.
+* Cryptographically signed gem and git tags.
+
+Synopsis
+--------
+
+This documentation defines the public interface of the software. Don't rely
+on elements marked as private. Those should be hidden in the documentation
+by default.
+
+### Loading
+
+In most cases you want to load the library by the following command:
+
+~~~~~ ruby
+require 'linebreak'
+~~~~~
+
+In a bundler Gemfile you should use the following:
+
+~~~~~ ruby
+gem 'linebreak'
+~~~~~
+
+By default, Linebreak extends the String class to make all Strings support the
+linebreak helper methods. The decision to modify Ruby's core classes should be
+in the hand of the end user (e.g. the application developer). So if you don't
+want the core extensions to be loaded or if you are using this library as a
+component in another library you should load this library in bare mode: 
+
+~~~~~ ruby
+require 'linebreak/bare'
+~~~~~
+
+Or for bundler Gemfiles:
+
+~~~~~ ruby
+gem 'linebreak', require: 'linebreak/bare'
+~~~~~
+
+### Library
+
+You can convert Strings to 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.
+
+~~~~~ ruby
+windows_string = "Abcdef\r\nAbcdef\r\nAbcdef"
+
+windows_string.linebreak_encode(:unix)
+#=> "Abcdef\nAbcdef\nAbcdef"
+~~~~~
+
+You can detect which decoding systems are used in a String:
+
+~~~~~ ruby
+mixed_unix_and_mac_string = "Abcdef\rAbcdef\nAbcdef"
+
+mixed_unix_and_mac_string.linebreak_encodings
+#=> #<Set: {:unix, :mac}>
+~~~~~
+
+You can also easily ensure that a String contains exactly the linebreak
+encodings you expect it to contain:
+
+~~~~~ ruby
+mixed_windows_and_mac_string = "Abcdef\r\nAbcdef\rAbcdef"
+
+mixed_windows_and_mac_string.linebreak_encoding?(:windows)
+#=> false
+
+mixed_windows_and_mac_string.linebreak_encoding?(:windows, :mac)
+#=> true
+~~~~~
+
+Note that the expected linebreak systems could also be given as an Array or a
+Set.
+
+If you prefer not the use the core extensions (e.g. in bare mode) you can use
+this library in the following way: 
+
+~~~~~ ruby
+Aef::Linebreak.encode("Abcdef\nAbcdef\nAbcdef", :mac)
+#=> "Abcdef\rAbcdef\rAbcdef"
+
+Aef::Linebreak.encodings("Abcdef\r\nAbcdef\nAbcdef")
+#=> #<Set: {:unix, :windows}>
+
+Aef::Linebreak.encoding?("Abcdef\nAbcdef\nAbcdef", :unix, :windows)
+#=> false
+
+Aef::Linebreak.encoding?("Abcdef\nAbcdef\nAbcdef", :unix)
+#=> true
+~~~~~
+
+Or you can manually extend a String to support the linebreak helper methods like
+this:
+
+~~~~~ ruby
+some_string.extend Aef::Linebreak
+~~~~~
+
+Requirements
+------------
+
+* Ruby 1.8.7 or higher
+
+Installation
+------------
+
+On *nix systems you may need to prefix the command with sudo to get root
+privileges.
+
+### 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 [gem signing
+public key][gemkey], which I use for cryptographic signatures on all my gems.
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+    gem cert --add aef-gem.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+    gem install linebreak -P HighSecurity
+
+Please notice that you may need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+   [gemkey]: http://aef.name/crypto/aef-gem.pem
+
+### Normal
+
+    gem install linebreak
+
+### Automated testing
+
+Go into the root directory of the installed gem and run the following command
+to fetch all development dependencies:
+
+    bundle
+
+Afterwards start the test runner:
+
+    rake spec
+
+If something goes wrong you should be noticed through failing examples.
+
+Development
+-----------
+
+### Bugs Reports and Feature Requests
+
+Please use the [issue tracker][issues] on github.com to let me know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/aef/linebreak/issues/
+
+### Source code
+
+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 https://github.com/aef/linebreak.git
+
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v", as required by Semantic
+Versioning. Every tag will be signed by my [OpenPGP public key][openpgp] which
+enables you to verify your copy of the code cryptographically.
+
+   [openpgp]: http://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag -v [TAG NAME]
+
+### Contribution
+
+Help on making this software better is always very appreciated. If you want
+your changes to be included in the official release, please clone my project
+on github.com, create a named branch to commit and push your changes into and
+send me a pull request afterwards.
+
+Please make sure to write tests for your changes so that I won't break them
+when changing other things on the library. Also notice that I can't promise
+to include your changes before reviewing them.
+
+License
+-------
+
+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.

data/Rakefile

@@ -1,21 +1,48 @@
-# -*- 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 = ''
+# 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 'bundler/gem_tasks'
+require 'rake'
+require 'pathname'
+require 'yard'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+YARD::Rake::YardocTask.new('doc')
+
+desc "Removes temporary project files"
+task :clean do
+  %w{doc coverage pkg .yardoc .rbx Gemfile.lock}.map{|name| Pathname.new(name) }.each do |path|
+    path.rmtree if path.exist?
+  end
+
+  Pathname.glob('*.gem').each &:delete
+  Pathname.glob('**/*.rbc').each &:delete
+end
+
+desc "Opens an interactive console with the library loaded"
+task :console do
+  Bundler.setup
+  require 'pry'
+  require 'linebreak'
+  Pry.start
 end
 
-# vim: syntax=Ruby
+task :default => :spec