autoini 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd90d5011121b5b00414dc5da6ab3deaf07eeb8e
-  data.tar.gz: d4cc5d55c16b7ede2eda4d5f5dc857538479d1da
+  metadata.gz: fba73e42029d7494a3259f14d218356f197146a9
+  data.tar.gz: 5ad14b10e7d3167801798c48f3b9d70887e5b445
 SHA512:
-  metadata.gz: 7665669b4bdeea08c253c598c459705fdb51ee6ac977938d8941c2d25cdddcf49461f96a82ad73df9348a0155fdb36f4af514dda526ff2a852b462ab0c971810
-  data.tar.gz: 5cbcb038d714bc5b182bf593a20e6de9405f407c6f52972a55e245b3e32e197ece6db096ed7e72530cb2dc8064a7038b48d5082625564a7ebda0032e6bc18cdc
+  metadata.gz: b5f615d3dc551ff4dcde7105dbbe19caccf47f1323fc9992a067a600d8b8f98248d84e7f65cd24071475a4b513bd711fab3db5d794c2e480320a30231335deb8
+  data.tar.gz: 83511d105f93a7891248eb2a559d0fc1f44cc6fe72919f26e652421cc5fb1b1b999904f0c1863f61aa8ee329e44d51e825dab8fcf94accc4d2e3ff49aa215e52

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/test/fixtures/*

data/README.md

@@ -22,6 +22,29 @@ Or install it yourself as:
 
 ## Usage
 
+### Reading / writing to files
+
+If you just want to read/write data to files, these 3 methods are all you need:
+
+To read an INI file into a hash object:
+```ruby
+hash = Autoini.read('data.ini')
+```
+
+To write INI data to a file:
+```ruby
+Autoini.write('data.ini', section: { foo: :bar })
+```
+
+To merge INI data into a file:
+```ruby
+Autoini.merge('data.ini', section: { another: :value })
+```
+
+### Advanced manipulation
+
+If you need to read/write comments and blank lines, or alter INI data without writing to a file, you can use the following classes
+
 To parse INI data:
 ```ruby
 ini = Autoini::Contents.parse(File.open('data.ini', 'rb', &:read))
@@ -62,7 +85,7 @@ foo2=bar # a comment
 
 ## Config
 
-Autoini will always parse lines in a string by \n, but you can choose the new line string using:
+Autoini will always parse lines in a string/file by \n, but you can choose how Autoini writes a new line using:
 ```ruby
 Autoini.newline = "\r\n"
 ```
@@ -72,15 +95,9 @@ Autoini will parse comments as begining with a ; or a #. You can choose which it
 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/automeow/autoini.
 
 
 ## License

data/lib/autoini.rb

@@ -20,9 +20,22 @@ module Autoini
   class << self
     attr_accessor :newline, :comment
 
+    def read(file)
+      Contents.hash(File.open(file, 'rb', &:read))
+    end
+
+    def write(file, data)
+      File.write(file, Contents[data].to_s)
+    end
+
+    def merge(file, data)
+      Contents.parse((File.open(file, 'rb', &:read) rescue nil))
+        .merge!(Contents[data]).tap{ |c| File.write(file, c.to_s) }.to_h
+    end
+
     def escape(text)
       ''.tap do |b|
-        text.each_char do |c|
+        text.to_s.each_char do |c|
           b << MAP_CHARS[c] and next if MAP_CHARS[c]
           b << '\\' if SPECIAL.include?(c)
           b << c

data/lib/autoini/blank_line.rb

@@ -8,6 +8,10 @@ module Autoini
       e.is_a?(BlankLine)
     end
 
+    def to_a
+      []
+    end
+
     def self.parse_with_comment(line)
       parse(line)
     end

data/lib/autoini/comment.rb

@@ -10,6 +10,10 @@ module Autoini
       "#{Autoini.comment} #{@comment}"
     end
 
+    def to_a
+      []
+    end
+
     def ==(e)
       e.is_a?(Comment) && comment == e.comment
     end

data/lib/autoini/contents.rb

@@ -5,6 +5,7 @@ module Autoini
     attr_reader :lines
 
     def self.parse(contents)
+      return new if contents.nil? || contents.empty?
       elements = []
       section = nil
       contents.split("\n").each do |l|
@@ -21,6 +22,23 @@ module Autoini
       new(*elements)
     end
 
+    def self.hash(contents)
+      parse(contents).to_h
+    end
+
+    def self.[](hash)
+      raise ArgumentError, "must pass a hash" unless hash.is_a?(Hash)
+      new(
+        *hash.map do |k, v|
+          if v.is_a?(Hash)
+            Section[k, v]
+          else
+            Pair.new(k, v)
+          end
+        end
+      )
+    end
+
     def initialize(*contents)
       @lines = []
       self << contents
@@ -32,16 +50,52 @@ module Autoini
           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"
+          raise ArgumentError, "Error on line #{c.inspect}: all elements " \
+            "after a section must be in a section"
         end
         lines << c
       end
     end
 
+    def section(key)
+      lines.select{ |l| l.is_a?(Section) && l.title.to_s == key.to_s }.first
+    end
+
+    def pair(key)
+      lines.select{ |l| l.is_a?(Pair) && l.key.to_s == key.to_s }.first
+    end
+
+    def merge!(other_contents)
+      unless other_contents.is_a?(Contents)
+        raise ArgumentError, "must pass a Autoini::Contents"
+      end
+      other_contents.lines.each do |l|
+        case l
+        when Section
+          if s = section(l.title)
+            s.merge!(l)
+          else
+            self << l
+          end
+        when Pair
+          if p = pair(l.key)
+            p.value = l.value
+          else
+            self << l
+          end
+        end
+      end
+      self
+    end
+
     def to_s
       lines.map(&:to_s).join(Autoini.newline)
     end
 
+    def to_h
+      lines.map(&:to_a).reject(&:empty?).to_h
+    end
+
     def ==(c)
       c.is_a?(Contents) && c.lines.length == lines.length &&
         lines.map.with_index{ |l, i| c.lines[i] == l }.all?

data/lib/autoini/element.rb

@@ -3,5 +3,9 @@ module Autoini
     def ==(element)
       raise ArgumentError, "== must be overriden in the subclass"
     end
+
+    def to_a(element)
+      raise ArgumentError, "to_a must be overriden in the subclass"
+    end
   end
 end

data/lib/autoini/pair.rb

@@ -13,6 +13,10 @@ module Autoini
       line_comment("#{Autoini.escape(key)}=#{Autoini.escape(value)}")
     end
 
+    def to_a
+      [key.to_sym, value]
+    end
+
     def ==(e)
       e.is_a?(Pair) && e.key == key && e.value == value && e.comment == comment
     end

data/lib/autoini/section.rb

@@ -11,6 +11,11 @@ module Autoini
       self << contents
     end
 
+    def self.[](title, hash)
+      raise ArgumentError, "must pass a hash" unless hash.is_a?(Hash)
+      new title, *hash.map{ |k, v| Pair.new(k, v) }
+    end
+
     def <<(contents)
       Autoini.wrap(contents).each do |c|
         unless c.is_a?(AbstractLine)
@@ -24,12 +29,35 @@ module Autoini
       [line_comment("[#{title}]"), lines.map(&:to_s)].flatten.join(Autoini.newline)
     end
 
+    def to_a
+      [title.to_sym, lines.map(&:to_a).reject(&:empty?).to_h]
+    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 pair(key)
+      lines.select{ |l| l.is_a?(Pair) && l.key.to_s == key.to_s }.first
+    end
+
+    def merge!(other_section)
+      unless other_section.is_a?(Section)
+        raise ArgumentError, "must pass a Autoini::Section"
+      end
+      other_section.lines.each do |l|
+        next unless l.is_a?(Pair)
+        if p = pair(l.key)
+          p.value = l.value
+        else
+          self << l
+        end
+      end
+      self
+    end
+
     def self.parse(line)
       Section.new(line[1]) if line.length == 3 && line[0] == '[' && line[2] == ']'
     end

data/lib/autoini/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoini
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Boylett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler