dotini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9129f4261682214a224a4085a6feab009e1366713e5c3b138c2e0275605da26f
+  data.tar.gz: 30890b30a109b43e3a6d91100b74c304ba644e886147c8fa7b97fba08606b547
+SHA512:
+  metadata.gz: aefebdb8e20d507093eeae7943f517a64c08f4fff6f99aead685f2c545ade8410117bbe4d78f8ef9c7aeee539ba369ae838efcc4d8faaeabc8dadc3dc4570d1f
+  data.tar.gz: 88001949bead84ba98de29dc672387edcf24e67758e14794e073647558129445c0f8e737d5deb4f475da52dac5938dfabaecad8903d5899c2dc897a06cdea997

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6.7', '2.7.3', '3.0.1']
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+AllCops:
+  NewCops: enable
+Layout/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  inherit_mode:
+    merge:
+      - Exclude
+  Exclude:
+    - lib/tasks/**/*
+    - spec/**/*
+Metrics/MethodLength:
+  inherit_mode:
+    merge:
+      - Exclude
+  Max: 30
+Metrics/ModuleLength:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wendelscardua@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dotini.gemspec
+gemspec
+
+gem 'rake', '~> 12.3'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    dotini (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotini!
+  pry (~> 0.14)
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  rubocop (~> 1.15)
+  rubocop-performance (~> 1.11)
+  rubocop-rake (~> 0.5)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Wendel Scardua
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+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.

data/README.md

@@ -0,0 +1,105 @@
+[![CI Status](https://github.com/wendelscardua/dotini/workflows/CI/badge.svg?branch=main)](https://github.com/wendelscardua/dotini/actions?query=workflow%3ACI+branch%3Amain)
+
+# 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotini'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dotini.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dotini/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dotini'
+  spec.version       = Dotini::VERSION
+  spec.authors       = ['Wendel Scardua']
+  spec.email         = ['wendelscardua@gmail.com']
+
+  spec.summary       = 'Read and write INI files'
+  spec.description   = 'Parser and generator of INI files'
+  spec.homepage      = 'https://github.com/wendelscardua/dotini'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'rubocop', '~> 1.15'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/dotini.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'dotini/version'
+require 'dotini/key_value_pair'
+require 'dotini/section'
+require 'dotini/ini_file'
+require 'stringio'
+
+# Root module for Dotini
+module Dotini; end

data/lib/dotini/ini_file.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Dotini
+  # Representation of a INI file
+  class IniFile
+    DEFAULT_KEY_PATTERN = /[^=\s]+/.freeze
+    DEFAULT_VALUE_PATTERN = /(?:"[^"]*"|[^=\s]*)/.freeze
+
+    attr_accessor :sections
+
+    # Creates a new, empty INI file
+    def initialize
+      @sections = []
+    end
+
+    # Retrieves an existing section, or creates a new one
+    def [](name)
+      sections.find { |section| section.name == name } ||
+        Section.new(name).tap { |section| sections << section }
+    end
+
+    # Represents the current INI file as a hash
+    def to_h
+      {}.tap do |hash|
+        sections.each do |section|
+          section.to_h.then do |section_hash|
+            next if section_hash.empty?
+
+            (hash[section.name] ||= {}).merge! section_hash
+          end
+        end
+      end
+    end
+
+    # Represents the current INI file as a string
+    def to_s
+      buffer = StringIO.new
+      sections.each do |section|
+        buffer << section.to_s
+      end
+      buffer.string
+    end
+
+    def write(io_stream)
+      io_stream.write(to_s)
+    end
+
+    class << self
+      # Loads an INI file by name
+      # The options are:
+      # - comment_character: which character is used for comments
+      # - key_pattern: a regexp that matches the property keys
+      # - value_pattern: a regexp that matches the property values
+      def load(filename,
+               comment_character: ';',
+               key_pattern: DEFAULT_KEY_PATTERN,
+               value_pattern: DEFAULT_VALUE_PATTERN)
+        line_pattern = /\A(?<key>#{key_pattern})
+                        \s*=\s*
+                        (?<value>#{value_pattern})
+                        (?:\s*(?<inline_comment>#{comment_character}.*))?\z/x
+        ini_file = IniFile.new
+        current_section = Section.new(nil)
+        current_key_value_pair = KeyValuePair.new
+        File.open(filename, 'r') do |f|
+          f.each_line(chomp: true) do |line|
+            line.strip!
+            if line.start_with?(comment_character)
+              current_key_value_pair.prepended_comments << line
+            elsif (match = line.match(/\A\[(?<section_name>[^\]]+)\]\z/))
+              current_section.key_value_pairs << current_key_value_pair
+              ini_file.sections << current_section
+              current_section = Section.new(match['section_name'])
+              current_key_value_pair = KeyValuePair.new
+            elsif (match = line.match(line_pattern))
+              current_key_value_pair.key = match['key']
+              current_key_value_pair.value = match['value']
+              current_key_value_pair.inline_comment = match['inline_comment']
+              current_section.key_value_pairs << current_key_value_pair
+              current_key_value_pair = KeyValuePair.new
+            end
+          end
+        end
+        current_section.key_value_pairs << current_key_value_pair
+        ini_file.sections << current_section
+
+        ini_file
+      end
+    end
+  end
+end

data/lib/dotini/key_value_pair.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dotini
+  # Key/value pair, with optional prepended and inline comments
+  class KeyValuePair
+    attr_accessor :key, :value, :prepended_comments, :inline_comment
+
+    # Creates a new, undefined key/value pair with no comments
+    def initialize
+      @key = nil
+      @value = nil
+      @prepended_comments = []
+      @inline_comment = nil
+    end
+
+    # Represents the key/value pair as a string
+    def to_s
+      buffer = StringIO.new
+      prepended_comments.each do |line|
+        buffer << line << "\n"
+      end
+
+      unless key.nil?
+        buffer << "#{key} = #{value}"
+        buffer <<
+          if inline_comment.nil?
+            "\n"
+          else
+            " #{inline_comment}\n"
+          end
+      end
+
+      buffer.string
+    end
+  end
+end

data/lib/dotini/section.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Dotini
+  # A single INI file section
+  class Section
+    attr_accessor :name, :key_value_pairs
+
+    # Creates a new, empty section
+    def initialize(name)
+      @name = name
+      @key_value_pairs = []
+    end
+
+    # Retrieves a KeyValuePair from the section, or creates one
+    def [](key)
+      key_value_pairs.find { |key_pair| key_pair.key == key } ||
+        KeyValuePair.new.tap do |pair|
+          pair.key = key
+          key_value_pairs << pair
+        end
+    end
+
+    # Sets a value for a key in this section
+    def []=(key, value)
+      self[key].value = value
+    end
+
+    # Represents the section as a hash
+    def to_h
+      {}.tap do |hash|
+        key_value_pairs.each do |pair|
+          next if pair.key.nil?
+
+          hash[pair.key] = pair.value
+        end
+      end
+    end
+
+    # Represents the section as a string
+    def to_s
+      buffer = StringIO.new
+      buffer << "[#{name}]\n" unless name.nil?
+      key_value_pairs.each do |pair|
+        buffer << pair.to_s
+      end
+      buffer.string
+    end
+  end
+end

data/lib/dotini/version.rb

@@ -0,0 +1,3 @@
+module Dotini
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: dotini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wendel Scardua
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Parser and generator of INI files
+email:
+- wendelscardua@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dotini.gemspec
+- lib/dotini.rb
+- lib/dotini/ini_file.rb
+- lib/dotini/key_value_pair.rb
+- lib/dotini/section.rb
+- lib/dotini/version.rb
+homepage: https://github.com/wendelscardua/dotini
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wendelscardua/dotini
+  source_code_uri: https://github.com/wendelscardua/dotini
+  changelog_uri: https://github.com/wendelscardua/dotini
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Read and write INI files
+test_files: []