Enable markdownlint for checking documentation style consistency

Author: pkuczynski

.mdlrc

@@ -0,0 +1,2 @@
+git_recurse true
+style ".mdlstyle.rb"

.mdlstyle.rb

@@ -0,0 +1,2 @@
+all
+rule 'MD013', :line_length => 120

CHANGELOG.md

@@ -1,45 +1,49 @@
-# 1.1.0
+# Changelog
+
+## 1.1.0
 
 * Add ability to specify knockout_prefix option for deep_merge
 * Minor code and documentation refactoring and cleanup
 
-# 1.0.0
+## 1.0.0
 
 * `RailsConfig` is now officially renamed to `Config`
-* Fixed array descent when converting to hash ([#89](https://github.com/railsconfig/config/pull/89))
-* Catch OpenStruct reserved keywords ([#95](https://github.com/railsconfig/config/pull/95) thanks @dudo)
-* Allows loading before app configuration process ([#107](https://github.com/railsconfig/config/pull/107) thanks @Antiarchitect)
-* `deep_merge` is now properly managed via gemspec ([#110](https://github.com/railsconfig/config/pull/110))
-* Added `prepend_source!` ([#102](https://github.com/railsconfig/config/pull/102))
+* Fixed array descent when converting to hash ([##89](https://github.com/railsconfig/config/pull/89))
+* Catch OpenStruct reserved keywords ([##95](https://github.com/railsconfig/config/pull/95) thanks @dudo)
+* Allows loading before app configuration process ([##107](https://github.com/railsconfig/config/pull/107) thanks @Antiarchitect)
+* `deep_merge` is now properly managed via gemspec ([##110](https://github.com/railsconfig/config/pull/110))
+* Added `prepend_source!` ([##102](https://github.com/railsconfig/config/pull/102))
+
+## 0.99
 
-# 0.99
 * Released deprecated gem migrating to the new name
 
-# 0.5.0.beta1
+## 0.5.0.beta1
+
+* Ability to use in Settings file keywords reserved for OpenStruct: select, collect ([##95](https://github.com/railsjedi/config/issues/95))
+* Made config work without Rails as a hard dependency ([##86](https://github.com/railsjedi/config/issues/86), [##88](https://github.com/railsjedi/config/issues/88))
+* Fix generate error when .gitignore is missing ([##85](https://github.com/railsjedi/config/issues/85))
+* Fix deprecation warning on File.exists? ([##81](https://github.com/railsjedi/config/issues/81))
+* Add a shortcut method for setting files ([##67](https://github.com/railsjedi/config/issues/67))
+* Improve YAMLSource load error message by outputting offending file path ([##88](https://github.com/railsjedi/config/issues/88))
 
-* Ability to use in Settings file keywords reserved for OpenStruct: select, collect ([#95](https://github.com/railsjedi/config/issues/95))
-* Made config work without Rails as a hard dependency ([#86](https://github.com/railsjedi/config/issues/86), [#88](https://github.com/railsjedi/config/issues/88))
-* Fix generate error when .gitignore is missing ([#85](https://github.com/railsjedi/config/issues/85))
-* Fix deprecation warning on File.exists? ([#81](https://github.com/railsjedi/config/issues/81))
-* Add a shortcut method for setting files ([#67](https://github.com/railsjedi/config/issues/67))
-* Improve YAMLSource load error message by outputting offending file path ([#88](https://github.com/railsjedi/config/issues/88))
+## 0.4.2
 
-# 0.4.2
-* Ability to specify the app name when calling the Heroku rake task ([#75](https://github.com/railsjedi/config/issues/75))
+* Ability to specify the app name when calling the Heroku rake task ([##75](https://github.com/railsjedi/config/issues/75))
 
-# 0.4.1
+## 0.4.1
 
-* Fixed compatibility with Rails 4.1 ([#72](https://github.com/railsjedi/config/issues/72))
+* Fixed compatibility with Rails 4.1 ([##72](https://github.com/railsjedi/config/issues/72))
 * Testing suite verifies compatibility with Rails 3.2, 4.0 and 4.1
 
-# 0.4.0
+## 0.4.0
 
-* Compatibility with Heroku ([#64](https://github.com/railsjedi/config/issues/64))
+* Compatibility with Heroku ([##64](https://github.com/railsjedi/config/issues/64))
 
-# 0.3.4
+## 0.3.4
 
-* Expose Settings in application.rb, so you don't have to duplicate configuration for each environment file ([#59](https://github.com/railsjedi/config/issues/59))
-* Adding support for Rails 4.1.0.rc ([#70](https://github.com/railsjedi/config/issues/70))
+* Expose Settings in application.rb, so you don't have to duplicate configuration for each environment file ([##59](https://github.com/railsjedi/config/issues/59))
+* Adding support for Rails 4.1.0.rc ([##70](https://github.com/railsjedi/config/issues/70))
 
 
 

LICENSE.md

@@ -20,7 +20,6 @@ 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.
 
-
 Third-party materials and licenses:
 
 * Config contains Deep Merge (deep_merge.rb) which is governed by the MIT license

README.md

@@ -12,23 +12,22 @@ Config helps you easily manage environment specific settings in an easy and usab
 
 ## Features
 
-- simple YAML config files
-- config files support ERB
-- config files support inheritance and multiple environments
-- access config information via convenient object member notation
-- support for multi-level settings (`Settings.group.subgroup.setting`)
-- local developer settings ignored when committing the code
+* simple YAML config files
+* config files support ERB
+* config files support inheritance and multiple environments
+* access config information via convenient object member notation
+* support for multi-level settings (`Settings.group.subgroup.setting`)
+* local developer settings ignored when committing the code
 
 ## Compatibility
 
-- Ruby `2.x`
-- Rails `>= 3.1` and `4`
-- Padrino
-- Sinatra
+* Ruby `2.x`
+* Rails `>= 3.1` and `4`
+* Padrino
+* Sinatra
 
 For older versions of Rails or Ruby use [AppConfig](http://github.com/fredwu/app_config).
 
-
 ## Installing
 
 ### Installing on Rails 3 or 4
@@ -75,22 +74,25 @@ register Config
 
 ### Installing on Sinatra
 
-Add the gem to your `Gemfile` and run `bundle install` to install it. Afterwards in need to register `Config` in your app and give it a root so it can find the config files.
+Add the gem to your `Gemfile` and run `bundle install` to install it. Afterwards in need to register `Config` in your
+app and give it a root so it can find the config files.
 
 ```ruby
 set :root, File.dirname(__FILE__)
 register Config
 ```
 
-It's also possible to initialize `Config` manually within your configure block if you want to just give it some yml paths to load from.
+It's also possible to initialize `Config` manually within your configure block if you want to just give it some yml
+paths to load from.
 
 ```ruby
 Config.load_and_set_settings("/path/to/yaml1", "/path/to/yaml2", ...)
 ```
 
 ## Accessing the Settings object
 
-After installing the gem, `Settings` object will become available globally and by default will be compiled from the files listed below. Settings defined in files that are lower in the list override settings higher.
+After installing the gem, `Settings` object will become available globally and by default will be compiled from the
+files listed below. Settings defined in files that are lower in the list override settings higher.
 
     config/settings.yml
     config/settings/#{environment}.yml
@@ -142,7 +144,8 @@ Settings.reload_from_files(
 
 ### Environment specific config files
 
-You can have environment specific config files. Environment specific config entries take precedence over common config entries.
+You can have environment specific config files. Environment specific config entries take precedence over common config
+entries.
 
 Example development environment config file:
 
@@ -185,29 +188,33 @@ Settings.prepend_source!("/path/to/source.yml")
 Settings.reload!
 ```
 
-This will do the same as `add_source`, but the given YML file will be loaded first (instead of last) and its settings will be overwritten by any other configuration file.
-This is especially useful if you want to define defaults.
+This will do the same as `add_source`, but the given YML file will be loaded first (instead of last) and its settings
+will be overwritten by any other configuration file. This is especially useful if you want to define defaults.
 
-One thing I like to do for my Rails projects is provide a local.yml config file that is .gitignored (so its independent per developer). Then I create a new initializer in `config/initializers/add_local_config.rb` with the contents
+One thing I like to do for my Rails projects is provide a local.yml config file that is .gitignored (so its independent
+per developer). Then I create a new initializer in `config/initializers/add_local_config.rb` with the contents
 
 ```ruby
 Settings.add_source!("#{Rails.root}/config/settings/local.yml")
 Settings.reload!
 ```
 
-> Note: this is an example usage, it is easier to just use the default local files `settings.local.yml, settings/#{Rails.env}.local.yml and environments/#{Rails.env}.local.yml` for your developer specific settings.
+> Note: this is an example usage, it is easier to just use the default local files `settings.local.yml,
+settings/#{Rails.env}.local.yml and environments/#{Rails.env}.local.yml` for your developer specific settings.
 
 ## Embedded Ruby (ERB)
 
 Embedded Ruby is allowed in the configuration files. Consider the two following config files.
 
 * ```#{Rails.root}/config/settings.yml```
+
 ```yaml
 size: 1
 server: google.com
 ```
 
 * ```#{Rails.root}/config/environments/development.yml```
+
 ```yaml
 size: 2
 computed: <%= 1 + 2 + 3 %>
@@ -263,10 +270,10 @@ Inheritance customization (check [Deep Merge](https://github.com/danielsdeleo/de
 
 * `knockout_prefix` - ability to remove elements of the array set in earlier loaded settings file. Default: `nil`
 
-
 ## Working with Heroku
 
-Heroku uses ENV object to store sensitive settings which are like the local files described above. You cannot upload such files to Heroku because it's ephemeral filesystem gets recreated from the git sources on each instance refresh.
+Heroku uses ENV object to store sensitive settings which are like the local files described above. You cannot upload
+such files to Heroku because it's ephemeral filesystem gets recreated from the git sources on each instance refresh.
 
 To use config with Heroku just set the `use_env` var to `true` in your `config/initializers/config.rb` file. Eg:
 
@@ -277,7 +284,8 @@ Config.setup do |config|
 end
 ```
 
-Now config would read values from the ENV object to the settings. For the example above it would look for keys starting with 'AppSettings'. Eg:
+Now config would read values from the ENV object to the settings. For the example above it would look for keys starting
+with 'AppSettings'. Eg:
 
 ```ruby
 ENV['AppSettings.section.size'] = 1
@@ -293,13 +301,19 @@ To upload your local values to Heroku you could ran `bundle exec rake config:her
 Bootstrap
 
 ```bash
-$ appraisal install
+appraisal install
+```
+
+Run the test suite:
+
+```bash
+appraisal rspec
 ```
 
-Running the test suite
+If you modified any of the documentation files verify their format:
 
 ```bash
-$ appraisal rspec
+mdl --style .mdlstyle.rb *.md
 ```
 
 ## Authors

config.gemspec

@@ -39,6 +39,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-rails", "~> 3.4.2"
   s.add_development_dependency "test-unit",   "~> 3.1.7"
   s.add_development_dependency "sqlite3"
+
+  # Static code analysis
+  s.add_development_dependency "mdl"
   s.add_development_dependency "rubocop"
 
   if ENV['TRAVIS']