nac 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4a5dbcbba373fe64c3ce3e9dda3751f6cfe02c6
+  data.tar.gz: 5b1a9e6c32e739556932cd6b6c5fdaeb809a53ff
+SHA512:
+  metadata.gz: 207428dc237f2c1c74e3de522392bf89ddc45fa90089f29d0c552f136add60f81f630168efd6c845186be47d5861c56a1de350af90e94532804d1cc76bd4b95e
+  data.tar.gz: bfbbf3a4746a837431ae4950280460d8290e0d25b19e44136e98a543216c416735ba26996762d73b84412e59af9d023796ccaf09db2356c0b1cfe91fe425589d

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'test/**/*.rb'
+  Exclude:
+    - 'bin/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    nac (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    docile (1.3.2)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    guard-shell (0.7.1)
+      guard (>= 2.0.0)
+      guard-compat (~> 1.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  guard (~> 2.15)
+  guard-minitest (~> 2.4)
+  guard-rubocop (~> 1.3)
+  guard-shell (~> 0.7.1)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  nac!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  simplecov (~> 0.17.0)
+
+BUNDLED WITH
+   2.0.1

data/Guardfile

@@ -0,0 +1,38 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  #watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  #watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  watch(%r{^test/(.*)_test\.rb$})
+  watch(%r{^(lib/.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+# Add files and commands to this file, like the example:
+#   watch(%r{file/path}) { `command(s)` }
+#
+guard :shell do
+  # watch(/(.*).txt/) {|m| `tail #{m[0]}` }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chris Roerig
+
+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,119 @@
+# Nac
+
+A very simple yet flexible configuration writer/reader library. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nac'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nac
+
+## How it works
+
+The source config file and its path will be created if they don't 
+already exist. The data is cached when the file is loaded and after a 
+new value is saved.
+
+## Usage
+
+### Basic
+
+This simple example shows how to load, write, and read. 
+
+```ruby
+require 'nac'
+
+# load or create a new config
+config = Nac::Config.new('my_config')
+
+# set values
+config.set('name', 'Chris')
+config.set('color', 'Blue')
+
+# get a single value
+puts config.get('name')
+
+# get all data
+puts config.get
+#=> { name: 'Chris', color: 'Blue' }
+```
+
+### Nesting Keys
+
+It's possible to read and write nested data by passing an array to the `set` and `get`  methods.
+
+```ruby
+require 'nac'
+
+config = Nac::Config.new('my_config')
+
+config.set(%[user name first], 'Homer')
+config.set(%[user name last],st 'Simpson')
+
+puts config.get('user')
+#=> { name: { first: 'Homer', last: 'Simpson' }}
+
+puts config.get(%[user name])
+#=> { first: 'Homer', last: 'Simpson' }
+
+puts config.get(%[user name last])
+#=> { last: 'Simpson' }
+
+# nil is returned if the key doesn't exist
+puts config.get(%[user name middle])
+#=> nil
+
+# Symbol arrays work too!
+
+config.set(%i{look ma no}, 'hands')
+puts config.get(:look)
+#=> { ma: { no: 'hands' } }
+```
+
+## Options
+
+* `template`: Optional value that will be converted to yaml and written to the config file. Default is `{}`.
+* `init!`: When true, force the configuration file to be rewritten. Default is `false`.
+
+**Note:** One doesn't need to specify `init!` when using `template`. 
+The template will not be written if if the configuration file exists.
+However, using `init!` will re-initialize the config file and the 
+template *will* be written. Similarly, `template` is not required when 
+using `init!`.
+
+### Usage
+
+```ruby
+
+requre 'nac'
+
+options = {
+  template: { some: { default: [:options] } },
+  init!: true
+}
+
+config = Nac::Config.new('my_config', options)
+
+puts config.get
+#=> { some: { default: [:options] } }
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chris-roerig/nac.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/bin/console

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+
+require_relative 'nac/config'
+require_relative 'nac/version'

data/lib/nac/config.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Nac
+  # The main configuration manager class
+  class Config
+    attr_reader :template, :source
+
+    def initialize(source, options = {})
+      @source     = source
+      @template   = (options[:template] || {}).to_yaml
+
+      options[:init!] ? init! : init
+      cache
+    end
+
+    def init!
+      FileUtils.mkdir_p(File.dirname(@source))
+
+      File.open(@source, 'w+') do |file|
+        file.write(@template)
+      end
+    end
+
+    def get(keys = nil)
+      return @cache unless keys
+
+      val = @cache
+
+      [keys].flatten.each do |key|
+        val = val[key]
+      end
+
+      val
+    rescue NoMethodError
+      nil
+    end
+
+    def set(keys, value)
+      @cache.merge!(bury(keys, value))
+
+      File.write(@source, @cache.to_yaml)
+
+      cache!
+    end
+
+    private
+
+    def init
+      return true if File.exist?(@source)
+
+      init!
+    end
+
+    def bury(keys, value)
+      hkeys = [keys].flatten.map { |k| { k => nil } }
+
+      hkeys.count.times do |i|
+        val = hkeys[i + 1] || value
+        hkeys[i][hkeys[i].keys[0]] = val
+      end
+
+      hkeys.shift
+    end
+
+    def cache!
+      @cache = nil
+      cache
+    end
+
+    def cache
+      @cache ||= YAML.load_file(@source) || {}
+    end
+  end
+end

data/lib/nac/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nac
+  VERSION = '1.0.0'
+end

data/nac.gemspec

@@ -0,0 +1,49 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nac/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nac"
+  spec.version       = Nac::VERSION
+  spec.authors       = ["Chris Roerig"]
+  spec.email         = ["idwyjm@gmail.com"]
+
+  spec.summary       = %q{A simple Ruby Gem to read/write configuration files.}
+  spec.description   = %q{NAC stands for "not another config" }
+  spec.homepage      = "https://github.com/chris-roerig/nac"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #  spec.metadata["homepage_uri"] = spec.homepage
+  #  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  # 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('..', __FILE__)) 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"]
+
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+  spec.add_development_dependency "guard", "~> 2.15"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+  spec.add_development_dependency "guard-rubocop", "~> 1.3"
+  spec.add_development_dependency "guard-shell", "~> 0.7.1"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: nac
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Roerig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 'NAC stands for "not another config" '
+email:
+- idwyjm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nac.rb
+- lib/nac/config.rb
+- lib/nac/version.rb
+- nac.gemspec
+homepage: https://github.com/chris-roerig/nac
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A simple Ruby Gem to read/write configuration files.
+test_files: []