<commit_before>= Mournful Settings

Adds a settings class to a rails app. The settings are mournful because
they can be stored encrypted. Aren't puns wonderful.

== Installation

    gem mournful_settings

== Usage

    class MySetting < ActiveRecord::Base

      acts_as_mournful_setting

    end

=== Fields

Each setting should have five fields:

[name]         String: Identifies the setting. Used in 'for' (see below)

[value]        String: The value being stored.

[value_type]   String: defines how that string should be presented. For example, 
               '1.23' with value_type 'number' will be presented as numeric 1.23. 
               If the value_type was 'text' the value returned would be '1.23'.

[description]  String or Text: Information about the setting being stored

[encrypted]    Boolean: If set to true, the value will be stored in an encrypted 
               format. Otherwise the value will be stored as plain text.

See db/migrate/001_create_settings.rb for an example migration.<commit_msg>Update README.rdoc<commit_after>= Mournful Settings

Adds a settings class to a rails app. The settings are mournful because
they can be stored encrypted. Aren't puns wonderful.

== Installation

    gem 'mournful_settings'

== Usage

    class MySetting < ActiveRecord::Base

      acts_as_mournful_setting

    end

=== Fields

Each setting should have five fields:

[name]         String: Identifies the setting. Used in 'for' (see below)

[value]        String: The value being stored.

[value_type]   String: defines how that string should be presented. For example, 
               '1.23' with value_type 'number' will be presented as numeric 1.23. 
               If the value_type was 'text' the value returned would be '1.23'.

[description]  String or Text: Information about the setting being stored

[encrypted]    Boolean: If set to true, the value will be stored in an encrypted 
               format. Otherwise the value will be stored as plain text.

See db/migrate/001_create_settings.rb for an example migration.
{'fraction_non_alphanumeric': 0.061800486618004864, 'fraction_numerical': 0.01167883211678832, 'mean_word_length': 3.0874751491053676, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3128256', 'n_tokens_mistral': 594, 'n_tokens_neox': 552, 'n_words': 256}