dotcfg 0.2.5.1 → 1.0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fceaa5b08885b44f7253fcd0ae6c1a0d04341490
-  data.tar.gz: a16b4eef3b2ae96a9fa03c909552d97b1a1cfa55
+SHA256:
+  metadata.gz: 0007d2541e8532fec0e178a746ee16fdb912f11982fde3a37c02b8773af76691
+  data.tar.gz: 31312857a1ae306544500c59262275e4905509e8250d2192042c4db47dc561e3
 SHA512:
-  metadata.gz: 7fe781e92e9307c2eafc8f8a30c8d531bd91083b76d349f4b080a54e0d977cb0b1cfbb818f4c7f3b5a8abbea61bd2089159537c6771fc0c36983fd754982c13f
-  data.tar.gz: 86bfe8acee0d030bfb068ad9ecaa2e5679d2a84568875b5d40fe8de14c551b1a93eb2a1cf56671253ccc77a94845dccd3346402d6573da93ece5a6deae807dbc
+  metadata.gz: d3ac6d4557968bdfecffbe73fedf152b1db4e5a6d0274bae11b595ee9b84694ed0db682da902735aa54c1a0fe25eab512cb1ea7c5c87475a80686e2d0dc72201
+  data.tar.gz: 802a1677fe69d411a9d21fe5bb86cc3c01e5a250d368d4c2647dcf0479e426bb9f06b786eacdc7b22160eacb07793d3aa05c93177cf0a6bb48c53eed1a596640

data/README.md

@@ -1,29 +1,66 @@
+[![CI Status](https://github.com/rickhull/dotcfg/actions/workflows/ci.yaml/badge.svg)](https://github.com/rickhull/dotcfg/actions/workflows/ci.yaml)
 [![Gem Version](https://badge.fury.io/rb/dotcfg.svg)](http://badge.fury.io/rb/dotcfg)
 [![Code Climate](https://codeclimate.com/github/rickhull/dotcfg/badges/gpa.svg)](https://codeclimate.com/github/rickhull/dotcfg/badges)
-[![Dependency Status](https://gemnasium.com/rickhull/dotcfg.svg)](https://gemnasium.com/rickhull/dotcfg)
-[![Security Status](https://hakiri.io/github/rickhull/dotcfg/master.svg)](https://hakiri.io/github/rickhull/dotcfg/master)
 
-dotcfg
-======
+# dotcfg
+
 dotcfg is a simple, intuitive way for your app to store configuration data on the filesystem -- ideally within the user's home directory, presumably in a dotfile.  If your config data can be represented by a Hash, then dotcfg can easily serialize and persist that data between runs.
 
-### Serialization Formats
+## Serialization Formats
 dotcfg currently understands [JSON](http://json.org) and [YAML](http://yaml.org), defaulting to YAML.
 
-Installation
-------------
-Install the gem:
+# Usage
+
+## Install
+
+3 options:
+
+* `git clone`
+* `gem install`
+* [Bundler](http://bundler.io/) `Gemfile`
+
+### `git clone`
+
+Clone the repo, then `cd dotcfg`
+
+Optional, if you use *direnv* and want to use Nix flakes to load a dev env:
+`direnv allow`
+
+From here, use `-I lib` with calls to e.g. `ruby` or `irb` to make dotcfg
+available without having the gem installed. e.g.
+
 ```
-$ gem install dotcfg         # sudo as necessary
+$ irb -Ilib -rdotcfg
+
+irb(main):001:0> CFG = DotCfg.new 'example.cfg'
+=>
+#<DotCfg:0x00007f75d06b83a0
+...
+irb(main):002:0> CFG[:does_not_exist]
+=> nil
+irb(main):003:0> CFG['hello'] = 'world'
+=> "world"
+irb(main):004:0> CFG['hello']
+=> "world"
+irb(main):005:0>
 ```
 
-Or, if using [Bundler](http://bundler.io/), add to your Gemfile:
+### `gem install`
+
+```
+gem install dotcfg
+```
+
+### [Bundler](http://bundler.io/) `Gemfile`
+
+Add to your Gemfile:
+
 ```ruby
-gem 'dotcfg', '~> 0.1'
+gem 'dotcfg', '~> 1.0'
 ```
 
-Usage
------
+## Usage
+
 ```ruby
 require 'dotcfg'
 
@@ -68,8 +105,8 @@ CFG.serialize
 # ...
 ```
 
-Details
--------
+## Details
+
 ### Symbols and Strings
 
 When JSON consumes symbols, it emits strings. So if you want to use JSON, use strings rather than symbols for your config items.  YAML cycles strings and symbols independently, so stick to one or the other.

data/Rakefile

@@ -1,3 +1,17 @@
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.pattern = 'test/*.rb'
+  t.warning = true
+end
+
+Rake::TestTask.new bench: :test do |t|
+  t.pattern = 'test/bench/*.rb'
+  t.warning = true
+end
+
+task default: :test
+
 begin
   require 'buildar'
 
@@ -7,16 +21,5 @@ begin
     b.use_git = true
   end
 rescue LoadError
-  # ok
-end
-
-begin
-  require 'rake/testtask'
-
-  Rake::TestTask.new do |t|
-    t.test_files = FileList['test/**/*.rb']
-  end
-  desc "Run tests"
-rescue Exception => e
-  warn "rake/testtask error: #{e}"
+  warn "buildar tasks unavailable"
 end

data/VERSION

@@ -1 +1 @@
-0.2.5.1
+1.0.0.1

data/dotcfg.gemspec

@@ -5,13 +5,13 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/rickhull/dotcfg'
   s.license = 'MIT'
   s.description = 'JSON and YAML config serialization and persistence'
-  s.add_runtime_dependency 'json', '>= 1.7.7'
+
+  s.required_ruby_version = '~> 3.0'
+  s.add_runtime_dependency 'json', '~> 2.5'
+  s.add_runtime_dependency 'yaml', '~> 0.1'
   s.add_development_dependency 'buildar', '~> 2'
 
-  # set version dynamically from version file contents
-  this_dir = File.expand_path('..', __FILE__)
-  version_file = File.join(this_dir, 'VERSION')
-  s.version  = File.read(version_file).chomp
+  s.version  = File.read(File.join(__dir__, 'VERSION')).chomp
 
   s.files = %w[
     dotcfg.gemspec
@@ -19,5 +19,6 @@ Gem::Specification.new do |s|
     README.md
     Rakefile
     lib/dotcfg.rb
+    test/dotcfg.rb
   ]
 end

data/test/dotcfg.rb

@@ -0,0 +1,99 @@
+require 'minitest/autorun'
+require 'dotcfg'
+
+describe DotCfg do
+  def new_filename
+    begin
+      Dir::Tmpname.make_tmpname('/tmp/dotcfg', nil)
+    rescue
+      ['/tmp/dotcfg', rand(9**9)].join
+    end
+  end
+
+  before do
+    @filename = new_filename
+    @dc = DotCfg.new(@filename)
+  end
+
+  describe "bad initialization" do
+    it "raises" do
+      expect { DotCfg.new('does/not/exist') }.must_raise Errno::ENOENT
+    end
+    it "creates a new file" do
+      expect(File.exist?(@filename)).must_equal true
+    end
+  end
+
+  describe "config manipulation" do
+    describe "accessing keys" do
+      before do
+        @dc['hello'] = 'world'
+      end
+
+      describe "nonexistent keys" do
+        it "returns nil" do
+          expect(@dc[:does_not_exist]).must_be_nil
+        end
+      end
+
+      describe "existing keys" do
+        it "returns the value" do
+          expect(@dc['hello']).must_equal 'world'
+        end
+      end
+
+      describe "key removal" do
+        it "returns nil" do
+          @dc[:hello] = :world
+          expect(@dc[:hello]).must_equal :world
+          @dc.delete :hello
+          expect(@dc[:hello]).must_be_nil
+        end
+      end
+
+      after do
+        @dc.delete 'hello'
+      end
+    end
+  end
+
+  describe "serialization" do
+    before do
+      @dc['hello'] = 'world'
+      @dc['goodbye'] = 'cruel world'
+    end
+
+    it "serializes to a string" do
+      expect(@dc.serialize).must_be_kind_of String
+    end
+
+    it "deserializes its serialization" do
+      hsh = @dc.deserialize(@dc.serialize)
+      expect(hsh).must_be_kind_of Hash
+      expect(hsh).must_equal({ 'hello' => 'world', 'goodbye' => 'cruel world' })
+      expect(@dc['hello']).must_equal 'world'
+      expect(@dc['goodbye']).must_equal 'cruel world'
+    end
+
+    it "overwrites when deserializing" do
+      str = @dc.serialize
+      @dc.delete 'hello'
+      @dc.deserialize(str)
+      expect(@dc['hello']).must_equal 'world'
+    end
+
+    it "responds to pretty with a string" do
+      expect(@dc.pretty).must_be_kind_of String
+    end
+
+    # eh, needed?
+    after do
+      @dc.delete 'hello'
+      @dc.delete 'goodbye'
+    end
+  end
+
+  after do
+    File.unlink(@filename)
+  end
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dotcfg
 version: !ruby/object:Gem::Version
-  version: 0.2.5.1
+  version: 1.0.0.1
 platform: ruby
 authors:
 - Rick Hull
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: buildar
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 description: JSON and YAML config serialization and persistence
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,28 +63,28 @@ files:
 - VERSION
 - dotcfg.gemspec
 - lib/dotcfg.rb
+- test/dotcfg.rb
 homepage: https://github.com/rickhull/dotcfg
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: simple filesystem de/serialization for app configs
 test_files: []