# Build::Text

`Build::Text` provides substitutions and merging for textual files, typically code.

[![Build Status](https://secure.travis-ci.org/ioquatix/build-text.svg)](http://travis-ci.org/ioquatix/build-text)
[![Code Climate](https://codeclimate.com/github/ioquatix/build-text.svg)](https://codeclimate.com/github/ioquatix/build-text)
[![Coverage Status](https://coveralls.io/repos/ioquatix/build-text/badge.svg)](https://coveralls.io/r/ioquatix/build-text)

## Installation

Add this line to your application's Gemfile:

	gem 'build-text'

And then execute:

	$ bundle

Or install it yourself as:

	$ gem install build-text

## Usage

### Substitutions

Provides a very simple template language for doing text substitutions:

```ruby
require 'build/text'

substitutions = Build::Text::Substitutions.new
substitutions['ANIMAL'] = 'cat'
substitutions['SOUND'] = 'meow'

puts substitutions.apply("The $ANIMAL says $SOUND.")
# Prints "The cat says meow."
```

It can also do indented expressions.

```ruby
require 'build/text'

substitutions = Build::Text::Substitutions.new
substitutions['MODULE'] = ["module Meow\n", "end\n"]

puts substitutions.apply("<MODULE>\ndef function\nend\n</MODULE>")
# Prints:
# module Meow
# 	def function
# 	end
# end
```

### Merging

A best effort merging strategy to combine two files. It uses LCS to match up sections, and then appends segments together.

Given the following input file:

```c++
class Bob {
	int alice();
}
```

and the following template:

```c++
class Bob {
	int bob();
}
```

it can be merged

```ruby
merged = Build::Text::Merge.combine(input.lines, template.lines)
```

and the merged result will be:

```c++
class Bob {
	int alice();
	int bob();
}
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## License

Released under the MIT license.

Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
