# Pragmater

[![Gem Version](https://badge.fury.io/rb/pragmater.svg)](http://badge.fury.io/rb/pragmater)
[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/pragmater.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/pragmater/coverage.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
[![Gemnasium Status](https://gemnasium.com/bkuhlmann/pragmater.svg)](https://gemnasium.com/bkuhlmann/pragmater)
[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/pragmater.svg)](https://travis-ci.org/bkuhlmann/pragmater)
[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)

A command line interface for adding [directive pragma](https://en.wikipedia.org/wiki/Directive_(programming)) comments
(a.k.a. *magic comments*) to source files. Examples:

    #! /usr/bin/ruby
    # frozen_string_literal: true
    # encoding: UTF-8

With the release of [Ruby 2.3.0](https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released), support for frozen
strings are now supported via a pragma comment. This gems provides an easy way to add pragma comments to single or
multiple Ruby source files in order to benefit from improved memory and concurrency performance.

<!-- Tocer[start]: Auto-generated, don't remove. -->

# Table of Contents

- [Features](#features)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
  - [Command Line Interface (CLI)](#command-line-interface-cli)
  - [Customization](#customization)
  - [Frozen String Literals](#frozen-string-literals)
- [Tests](#tests)
- [Versioning](#versioning)
- [Code of Conduct](#code-of-conduct)
- [Contributions](#contributions)
- [License](#license)
- [History](#history)
- [Credits](#credits)

<!-- Tocer[finish]: Auto-generated, don't remove. -->

# Features

- Supports adding a pragma comment or multiple pragma comments to single or multiple source files.
- Supports removing a pragma comment or multiple pragma comments from single or multiple source files.
- Supports whitelist filtering. Defaults to any file.
- Ensures duplicate pragma comments never exist.
- Ensures pragma commments are always properly formatted.

[![asciicast](https://asciinema.org/a/34038.png)](https://asciinema.org/a/34038)

# Requirements

0. [MRI 2.3.x](https://www.ruby-lang.org)

# Setup

For a secure install, type the following (recommended):

    gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
    gem install pragmater --trust-policy MediumSecurity

NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
allowing the installation of unsigned dependencies since they are beyond the scope of this gem.

For an insecure install, type the following (not recommended):

    gem install pragmater

# Usage

## Command Line Interface (CLI)

From the command line, type: `pragmater help`

    pragmater -a, [--add=ADD]        # Add pragma comments to source file(s).
    pragmater -e, [--edit]           # Edit Pragmater settings in default editor.
    pragmater -h, [--help=HELP]      # Show this message or get help for a command.
    pragmater -r, [--remove=REMOVE]  # Remove pragma comments from source file(s).
    pragmater -v, [--version]        # Show Pragmater version.

Both the `--add` and `--remove` options provide the ability to supply specific pragma comments and/or whitelisted files:

    -c, [--comments=one two three]   # Pragma comments
    -w, [--whitelist=one two three]  # File extension whitelist

## Customization

Should the default settings not be desired, customization is allowed via the `.pragmaterrc` file. The `.pragmaterrc`
can be created at a global and/or local level. Example:

- Global: `~/.pragmaterrc`
- Local: `<project repository root>/.pragmaterrc`

Order of precedence for any setting is resolved as follows (with the last taking top priority):

0. Global `~/.pragmaterrc`.
0. Local project repository `.pragmaterrc`.
0. CLI option (i.e. `--add` or `--remove` command options).

Any setting provided to the CLI during runtime would trump a local/global setting and a local setting would trump a
global setting. The global setting is the weakest of all but great for situations where custom settings should be
applied to *all* projects. It is important to note that local settings completely trump any global settings -- there is
no inheritance when local *and* global settings exist at the same time.

The `.pragmaterrc` uses the following default settings:

    :add:
      :comments: []
      :whitelist: []
    :remove:
      :comments: []
      :whitelist: []

Each `.pragmaterrc` setting can be configured as follows:

- `add`: Defines global/local comments and/or whitelists when adding pragma comments. The `comments` and `whitelist`
  options can be either a single string or an array of values.
- `remove`: Defines global/local comments and/or whitelists when removing pragma comments. The `comments` and
  `whitelist` options can be either a single string or an array of values.

## Frozen String Literals

With Ruby 2.3.0, support of frozen string literals are now supported. These comments are meant to be placed at the top
of each source file. Example:

    # frozen_string_literal: true

This is great for *selective* enablement of frozen string literals but might be too much work for some (even with the
aid of this gem). As an alternative, frozen string literals can be enabled via the following Ruby command line option:

    --enable=frozen-string-literal

It is important to note that once enabled, it freezes strings program-wide -- It's an all or nothing option.

Regardless of whether you leverage the capabilities of this gem or the Ruby command line option mentioned above, the
following Ruby command line option is available to aid debugging and tracking down frozen string literal issues:

    --debug=frozen-string-literal

# Tests

To test, run:

    bundle exec rake

# Versioning

Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:

- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.

# Code of Conduct

Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
you agree to abide by its terms.

# Contributions

Read [CONTRIBUTING](CONTRIBUTING.md) for details.

# License

Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
Read the [LICENSE](LICENSE.md) for details.

# History

Read the [CHANGELOG](CHANGELOG.md) for details.
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).

# Credits

Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).