autoini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd90d5011121b5b00414dc5da6ab3deaf07eeb8e
+  data.tar.gz: d4cc5d55c16b7ede2eda4d5f5dc857538479d1da
+SHA512:
+  metadata.gz: 7665669b4bdeea08c253c598c459705fdb51ee6ac977938d8941c2d25cdddcf49461f96a82ad73df9348a0155fdb36f4af514dda526ff2a852b462ab0c971810
+  data.tar.gz: 5cbcb038d714bc5b182bf593a20e6de9405f407c6f52972a55e245b3e32e197ece6db096ed7e72530cb2dc8064a7038b48d5082625564a7ebda0032e6bc18cdc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sam.boylett@meritec.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autoini.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sam Boylett
+
+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,89 @@
+# Autoini
+
+Autoini is a library for writing and parsing INI files. It supports key/value pairs, sections, blank lines and comments
+
+It will escape control characters ([]=;#\r\n), so any data can be stored
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autoini'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install autoini
+
+## Usage
+
+To parse INI data:
+```ruby
+ini = Autoini::Contents.parse(File.open('data.ini', 'rb', &:read))
+```
+
+To generate INI data:
+```ruby
+Autoini::Contents.new(
+  Autoini::Comment.new('some comment'),
+  Autoini::Pair.new('foo', "bar\nnew"),
+  Autoini::Pair.new('foo2', 'bar').tap{ |p| p.comment = 'a comment' },
+  Autoini::Section.new(
+    'hello',
+    Autoini::Pair.new('[foo', 'bar'),
+    Autoini::Pair.new('fo;o2', 'bar').tap{ |p| p.comment = 'a comment' },
+    Autoini::BlankLine.new
+  ),
+  Autoini::Section.new(
+    'world',
+    Autoini::Pair.new('foo', 'bar'),
+    Autoini::Pair.new('foo2', 'bar').tap{ |p| p.comment = 'a comment' },
+  ).tap{ |p| p.comment = 'cool section' },
+).to_s
+```
+which will output:
+```
+# some comment
+foo=bar\nnew
+foo2=bar # a comment
+[hello]
+\[foo=bar
+fo\;o2=bar # a comment
+
+[world] # cool section
+foo=bar
+foo2=bar # a comment
+```
+
+## Config
+
+Autoini will always parse lines in a string by \n, but you can choose the new line string using:
+```ruby
+Autoini.newline = "\r\n"
+```
+
+Autoini will parse comments as begining with a ; or a #. You can choose which it uses to write comments by using:
+```ruby
+Autoini.comment = ";"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/automeow/autoini. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/autoini.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autoini/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autoini"
+  spec.version       = Autoini::VERSION
+  spec.authors       = ["Sam Boylett"]
+  spec.email         = ["sam.boylett@alumni.york.ac.uk"]
+
+  spec.summary       = %q{Parser / writer for INI files}
+  spec.homepage      = "https://github.com/automeow/autoini"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "autoini"
+
+# 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

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/lib/autoini.rb

@@ -0,0 +1,72 @@
+require "autoini/element"
+require "autoini/abstract_line"
+require "autoini/comment"
+require "autoini/inline_comment"
+require "autoini/pair"
+require "autoini/section"
+require "autoini/blank_line"
+require "autoini/contents"
+require "autoini/version"
+
+module Autoini
+  ESCAPE_CHAR = '\\'
+  COMMENTS    = %w( # ; )
+  SPECIAL     = %w( = [ ] ) | [ESCAPE_CHAR] | COMMENTS
+  MAP_CHARS   = { "\r" => '\\r', "\n" => '\\n' }
+
+  @newline = "\n"
+  @comment = '#'
+
+  class << self
+    attr_accessor :newline, :comment
+
+    def escape(text)
+      ''.tap do |b|
+        text.each_char do |c|
+          b << MAP_CHARS[c] and next if MAP_CHARS[c]
+          b << '\\' if SPECIAL.include?(c)
+          b << c
+        end
+      end
+    end
+
+    def unescape_char(char)
+      return char if SPECIAL.include?(char)
+      MAP_CHARS.key("\\#{char}") ||
+        raise(ArgumentError, "#{char.inspect} is not an unescapable character")
+    end
+
+    def divide(text)
+      [].tap do |s|
+        buffer = ''
+        escaping = false
+        text.each_char do |c|
+          if escaping
+            buffer << unescape_char(c)
+            escaping = false
+          elsif c == ESCAPE_CHAR
+            escaping = true
+          elsif SPECIAL.include?(c)
+            s << buffer.strip unless buffer.strip.empty?
+            s << c
+            buffer = ''
+          else
+            buffer << c
+          end
+        end
+        s << buffer.strip unless buffer.strip.empty?
+      end
+    end
+
+    def wrap(array)
+      case array
+      when nil
+        []
+      when Array
+        array
+      else
+        [array]
+      end
+    end
+  end
+end

data/lib/autoini/abstract_line.rb

@@ -0,0 +1,11 @@
+module Autoini
+  class AbstractLine < Element
+    def to_s
+      raise ArgumentError, "to_s must be overriden in the subclass"
+    end
+
+    def self.parse(line)
+      raise ArgumentError, "parse must be overriden in the subclass"
+    end
+  end
+end

data/lib/autoini/blank_line.rb

@@ -0,0 +1,19 @@
+module Autoini
+  class BlankLine < AbstractLine
+    def to_s
+      ""
+    end
+
+    def ==(e)
+      e.is_a?(BlankLine)
+    end
+
+    def self.parse_with_comment(line)
+      parse(line)
+    end
+
+    def self.parse(line)
+      BlankLine.new if line.empty?
+    end
+  end
+end

data/lib/autoini/comment.rb

@@ -0,0 +1,25 @@
+module Autoini
+  class Comment < AbstractLine
+    attr_accessor :comment
+
+    def initialize(comment)
+      @comment = comment
+    end
+
+    def to_s
+      "#{Autoini.comment} #{@comment}"
+    end
+
+    def ==(e)
+      e.is_a?(Comment) && comment == e.comment
+    end
+
+    def self.parse_with_comment(line)
+      parse(line)
+    end
+
+    def self.parse(line)
+      Comment.new(line[1..-1].join.strip) if line[0] == Autoini.comment
+    end
+  end
+end

data/lib/autoini/contents.rb

@@ -0,0 +1,50 @@
+module Autoini
+  class Contents
+    KLASSES = [Pair, Section, Comment, BlankLine]
+
+    attr_reader :lines
+
+    def self.parse(contents)
+      elements = []
+      section = nil
+      contents.split("\n").each do |l|
+        e = KLASSES.map{ |k| k.parse_with_comment(Autoini.divide(l.strip)) }
+          .select(&:itself)
+          .first || raise(ArgumentError, "couldn't parse line: #{l.inspect}")
+        if e.is_a?(Section)
+          section = e
+          elements << section
+        else
+          (section || elements) << e
+        end
+      end
+      new(*elements)
+    end
+
+    def initialize(*contents)
+      @lines = []
+      self << contents
+    end
+
+    def <<(contents)
+      Autoini.wrap(contents).each do |c|
+        unless c.is_a?(Element)
+          raise ArgumentError, "#{c.class.name} must extend Autoini::Element"
+        end
+        if !c.is_a?(Section) && lines.last.is_a?(Section)
+          raise ArgumentError, "Error on line #{c.inspect}: all elements after a section must be in a section"
+        end
+        lines << c
+      end
+    end
+
+    def to_s
+      lines.map(&:to_s).join(Autoini.newline)
+    end
+
+    def ==(c)
+      c.is_a?(Contents) && c.lines.length == lines.length &&
+        lines.map.with_index{ |l, i| c.lines[i] == l }.all?
+    end
+  end
+end

data/lib/autoini/element.rb

@@ -0,0 +1,7 @@
+module Autoini
+  class Element
+    def ==(element)
+      raise ArgumentError, "== must be overriden in the subclass"
+    end
+  end
+end

data/lib/autoini/inline_comment.rb

@@ -0,0 +1,24 @@
+module Autoini
+  module InlineComment
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    attr_accessor :comment
+
+    def line_comment(text)
+      return text unless comment
+      "#{text} #{Comment.new(comment).to_s}"
+    end
+
+    module ClassMethods
+      def parse_with_comment(line)
+        comment_index = COMMENTS.map{ |c| line.index(c) }.reject(&:nil?).min
+        return parse(line) unless comment_index
+        parse(line[0..(comment_index - 1)]).tap do |e|
+          e.comment = line[(comment_index + 1)..-1].join if e
+        end
+      end
+    end
+  end
+end

data/lib/autoini/pair.rb

@@ -0,0 +1,24 @@
+module Autoini
+  class Pair < AbstractLine
+    include InlineComment
+
+    attr_accessor :key, :value
+
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+
+    def to_s
+      line_comment("#{Autoini.escape(key)}=#{Autoini.escape(value)}")
+    end
+
+    def ==(e)
+      e.is_a?(Pair) && e.key == key && e.value == value && e.comment == comment
+    end
+
+    def self.parse(line)
+      Pair.new(line[0], line[2]) if line.length == 3 && line[1] == '='
+    end
+  end
+end

data/lib/autoini/section.rb

@@ -0,0 +1,37 @@
+module Autoini
+  class Section < Element
+    include InlineComment
+
+    attr_accessor :title
+    attr_reader   :lines
+
+    def initialize(title, *contents)
+      @title = title
+      @lines = []
+      self << contents
+    end
+
+    def <<(contents)
+      Autoini.wrap(contents).each do |c|
+        unless c.is_a?(AbstractLine)
+          raise ArgumentError, "#{c.class.name} must extend Autoini::AbstractLine"
+        end
+        @lines << c
+      end
+    end
+
+    def to_s
+      [line_comment("[#{title}]"), lines.map(&:to_s)].flatten.join(Autoini.newline)
+    end
+
+    def ==(e)
+      e.is_a?(Section) && e.title == title && e.comment == comment &&
+        e.lines.length == lines.length &&
+        lines.map.with_index{ |l, i| e.lines[i] == l }.all?
+    end
+
+    def self.parse(line)
+      Section.new(line[1]) if line.length == 3 && line[0] == '[' && line[2] == ']'
+    end
+  end
+end

data/lib/autoini/version.rb

@@ -0,0 +1,3 @@
+module Autoini
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: autoini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Boylett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- sam.boylett@alumni.york.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoini.gemspec
+- bin/console
+- bin/setup
+- lib/autoini.rb
+- lib/autoini/abstract_line.rb
+- lib/autoini/blank_line.rb
+- lib/autoini/comment.rb
+- lib/autoini/contents.rb
+- lib/autoini/element.rb
+- lib/autoini/inline_comment.rb
+- lib/autoini/pair.rb
+- lib/autoini/section.rb
+- lib/autoini/version.rb
+homepage: https://github.com/automeow/autoini
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Parser / writer for INI files
+test_files: []