sbagdat/turkish_regexps

# TurkishRegexps

[![Gem Version](https://badge.fury.io/rb/turkish_regexps.svg)](https://badge.fury.io/rb/turkish_regexps)
[![Build Status](https://travis-ci.org/sbagdat/turkish_regexps.svg?branch=main)](https://travis-ci.org/sbagdat/turkish_regexps)
[![Code Climate](https://codeclimate.com/github/sbagdat/turkish_regexps/badges/gpa.svg)](https://codeclimate.com/github/sbagdat/turkish_regexps)

Regular expressions meet Turkish language. 

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'turkish_regexps'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install turkish_regexps

## Usage

```ruby
require 'turkish_regexps'

include TurkishRegexps

# Creating new regexps
TrRegexp.new(/[ç-ş]/i)

# Translating character classes
TrRegexp.new(/[ç-ö]/).translate        # /[çdefgğhıijklmnoö]/
TrRegexp.new(/[A-Z]/).translate        # /[ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ]/
TrRegexp.new(/[Ç-Ş#!$ç-ş]/).translate  # /[ÇDEFGĞHIİJKLMNOÖPQRSŞ#!$çdefgğhıijklmnoöpqrsş]/

# Translating meta characters 
re = TrRegexp.new(/\w+/).translate
Regexp.compile(re).match('ABCÇDEFGĞHIİJKLMNOÖPQRSabcçdeğiş')[0]  # 'ABCÇDEFGĞHIİJKLMNOÖPQRSabcçdeğiş'

re = TrRegexp.new(/\W+/).translate
Regexp.compile(re).match('ABCÇDEFGĞHIİJKLMNOÖPQRSŞTUÜVWXYZ.+%')[0]  # '.+%'
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sbagdat/turkish_regexps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/turkish_regexps/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the TurkishRegexps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/turkish_regexps/blob/master/CODE_OF_CONDUCT.md).