Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wendelscardua/dotini
Ruby INI file reader/writer
https://github.com/wendelscardua/dotini
Last synced: 2 months ago
JSON representation
Ruby INI file reader/writer
- Host: GitHub
- URL: https://github.com/wendelscardua/dotini
- Owner: wendelscardua
- License: mit
- Created: 2021-05-28T13:44:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-08T18:20:32.000Z (4 months ago)
- Last Synced: 2024-09-08T19:52:53.835Z (4 months ago)
- Language: Ruby
- Size: 55.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/wendelscardua/dotini/actions?query=workflow%3ACI+branch%3Amain)
[](https://badge.fury.io/rb/dotini)
[](http://www.rubydoc.info/github/wendelscardua/dotini)
# Dotini
Dotini allows [INI files](https://en.wikipedia.org/wiki/INI_file) to be parsed, created,
modified and written, preserving existing comments.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'dotini'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install dotini
## Usage
### Reading an INI file
Given this INI file:
```ini
[main]
username = foo
; this is a color
; the color is nice
color = red
[personal]
color = cyan
path = /tmp ; TODO: change later
```
It can be read with:
```ruby
ini_file = Dotini::IniFile.load(filename, options) # options are not required
ini_file['main']['color'].value # => 'red'
ini_file['main']['color'].prepended_comments # => ['; this is a color', '; the color is nice']
ini_file['personal']['path'].value # => '/tmp'
ini_file['personal']['path'].inline_comment # => '; TODO: change later'
```
These are the available options:
- `comment_character` (default: `';'`)
- `key_pattern` (default: `Dotini::IniFile::DEFAULT_KEY_PATTERN`)
- `value_pattern` (default: `Dotini::IniFile::DEFAULT_VALUE_PATTERN`)
### Creating a new INI file
```ruby
ini_file = Dotini::IniFile.new
ini_file['profile default']['color'] = 'blue'
ini_file['preferences']['width'] = 42
```
### Saving the INI file
Given the INI file above, it can be turned into a string:
```ruby
ini_file.to_s # => "[profile default]\ncolor = blue\n[preferences]\nwidth = 42\n"
```
...or it can be written to a IO stream:
```ruby
File.open('new-file.ini', 'wb') do |file|
ini_file.write(file)
end
```
### Converting the INI file to a hash
```ruby
ini_file.to_h # => { 'profile default' => { 'color' => 'blue' }, 'preferences' => { 'width' => '42' } }
```
## 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/wendelscardua/dotini. 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/wendelscardua/dotini/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 Dotini project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dotini/blob/main/CODE_OF_CONDUCT.md).