kefir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34bd27c107be11b6e9051bf444f5eee377758915
+  data.tar.gz: 7354cd1b6751c3453a5e8c3cdf573f22cef8fe77
+SHA512:
+  metadata.gz: 0a9cb0e32386852224d238643322e50d42d54371f6bff1315fcf383032f8e46668ec2b3cc1427ed64fa637e5780fc5e0cdda4963715184dd2c660614623c93aa
+  data.tar.gz: e6237785bf1bd138c2a0f710b00e9ba01b9de95d62ed09dd6dc0ac1c424ae4287480829e6acdba5b7c5f0fe3b115790a6d63a7e0808e3a2ffa2cfe811b5e9c09

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install:
+  - gem update bundler
+notifications:
+  email:
+    on_success: never
+    on_failure: always
+ignore:
+  - README.md

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    kefir (0.1.0)
+      dig_rb (~> 1.0, >= 1.0.1)
+      env_paths (~> 0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    dig_rb (1.0.1)
+    env_paths (0.0.2)
+    parser (2.3.2.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kefir!
+  rspec (~> 3)
+  rubocop (~> 0.45)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Tomlin
+
+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,52 @@
+kefir kefir [![Build Status](https://travis-ci.org/NickTomlin/kefir.png?branch=master)](https://travis-ci.org/NickTomlin/kefir.fury.io/rb/kefir.svg)](https://badge.fury.io/rb/kefir)
+===
+
+Simple configuration for your Gem or application. A ruby port of [conf](https://www.npmjs.com/package/conf).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kefir'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kefir
+
+## Usage
+
+```
+require 'kefir'
+
+config = Kefier.config('my_gem')
+api_key = config.get(:api_key)
+
+config.set(:api_key, api_key + '!')
+
+# write your changes
+config.persist
+```
+
+`get` and `set` can accept multiple keys for nested paths:
+
+```
+config.set(:my, :nested, :value, 'hello!')
+value = config.get(:my, :nested, :value)
+
+expect(value).to eq('hello!')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nicktomlin/kefir/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the tests `rake`
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+spec = eval(File.read('kefir.gemspec')) # rubocop:disable Lint/Eval
+
+Gem::PackageTask.new(spec)
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %w(rubocop spec)

data/kefir.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require File.expand_path('../lib/kefir/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'kefir'
+  s.version = Kefir::VERSION
+  s.authors = ['Nick Tomlin']
+  s.email = ['nick.tomlin@gmail.com']
+  s.summary = 'Simple configuration for your application/gem'
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'env_paths', '~> 0.0.2'
+  s.add_dependency 'dig_rb', '~> 1.0', '>= 1.0.1'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'rubocop', '~> 0.45'
+end

data/lib/kefir/version.rb

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

data/lib/kefir.rb

@@ -0,0 +1,102 @@
+require 'kefir/version'
+require 'dig_rb'
+require 'env_paths'
+require 'YAML'
+
+module Kefir
+  class MissingNamespaceError < StandardError; end
+
+  class FileStore
+    attr_reader :path
+
+    def initialize(config_file_path)
+      @path = config_file_path
+    end
+
+    def read
+      File.read(@path) do |contents|
+        YAML.load(contents)
+      end
+    end
+
+    def write(data)
+      File.write(@path, YAML.dump(data))
+    end
+  end
+
+  class Config
+    include Enumerable
+    extend Forwardable
+
+    def_delegators :@config, :key?, :delete
+    def_delegator :@store, :path
+
+    def each(&block)
+      @config.each(&block)
+    end
+
+    def initialize(store, options)
+      @store = store
+      @options = options
+    end
+
+    def config
+      @config ||= @store.read.merge!(@options.fetch(:defaults, {}))
+    end
+
+    def persist
+      @store.write(config)
+    end
+
+    def set(*paths)
+      if paths.first.is_a?(Hash)
+        config.merge!(paths.first)
+      elsif paths.size >= 2
+        deep_set(config, paths)
+      else
+        raise ArgumentError.new, 'Kefir::Config.set accepts a hash or key(s) and value'
+      end
+
+      config
+    end
+
+    def empty!
+      @config = {}
+    end
+
+    def get(*paths)
+      config.dig(*paths)
+    end
+
+    def to_s
+      config.to_s
+    end
+
+    def to_h
+      config.dup
+    end
+
+    private
+
+    def deep_set(hash, paths)
+      value = paths.pop
+      *keys, last_key = paths
+
+      nested = keys.inject(hash) do |h, key|
+        h[key] = {} unless h[key]
+        h[key]
+      end
+
+      nested[last_key] = value unless nested.nil?
+    end
+  end
+
+  def self.config(namespace, options = {})
+    raise MissingNamespaceError, 'You must supply a namespace for your configuration files' if namespace.nil? || namespace.empty?
+
+    config_file_path = EnvPaths.get(namespace).config
+    store = FileStore.new(config_file_path)
+
+    Config.new(store, options)
+  end
+end

data/spec/kefir_spec.rb

@@ -0,0 +1,204 @@
+require 'YAML'
+require 'tmpdir'
+require 'fileutils'
+
+RSpec.describe Kefir do
+  describe Kefir::Config do
+    let(:store_double) { double(Kefir::FileStore, read: {}, write: nil) }
+    let(:config) { Kefir::Config.new(store_double, {}) }
+
+    describe 'initialize' do
+      it 'accepts a default option that shallowly merges with config' do
+        store = double(Kefir::FileStore, read: { should_change: 'change_me', should_stay: 'immortal' }, write: nil)
+        options = {
+          defaults: {
+            should_change: 'changed!'
+          }
+        }
+        config = Kefir::Config.new(store, options)
+
+        expect(config.get(:should_change)).to eq('changed!')
+        expect(config.get(:should_stay)).to eq('immortal')
+      end
+    end
+
+    it 'includes enumerable methods' do
+      config.set(foo: 'hay', biz: 'needle')
+
+      expect(config.any? { |_, v| v == 'needle' }).to eq(true)
+      expect(config.count).to eq(2)
+    end
+
+    describe 'set' do
+      it 'sets config' do
+        config.set(:foo, 'bar')
+
+        expect(config.get(:foo)).to eq('bar')
+      end
+
+      it 'accepts a hash' do
+        config.set(foo: 'bar', biz: 'baz', hsh: { nested: 'value' })
+
+        expect(config.get(:hsh)).to eq(nested: 'value')
+      end
+
+      it 'raises an error if less than two arguments are supplied' do
+        expect do
+          config.set(:foo)
+        end.to raise_exception(ArgumentError, 'Kefir::Config.set accepts a hash or key(s) and value')
+      end
+
+      it 'handles nested config values' do
+        config.set(:my, :nested, :value, 'hello')
+
+        expect(config.get(:my, :nested, :value)).to eq('hello')
+      end
+
+      it 'handles array indexes' do
+        config.set(:nested, :array, [])
+        config.set(:nested, :array, 0, 'hello')
+
+        expect(config.get(:nested, :array, 0)).to eq('hello')
+      end
+
+      it 'handles a mixture of symbols and strings' do
+        config.set(:one, 'two', 'boo')
+
+        expect(config.get(:one, 'two')).to eq('boo')
+      end
+    end
+
+    describe 'empty!' do
+      it 'empties config' do
+        config.set(foo: 'hay', biz: 'needle')
+        expect(config.count).to eq(2)
+        config.empty!
+        expect(config.count).to eq(0)
+      end
+    end
+
+    describe 'path' do
+      it 'returns the path of its store' do
+        store =  double(Kefir::FileStore, path: '/config/path')
+        config = Kefir::Config.new(store, {})
+
+        expect(config.path).to eq('/config/path')
+      end
+    end
+
+    context 'methods delegated to config hash' do
+      it 'allows inspection via key?' do
+        config.set(:one, 'one')
+
+        expect(config.key?(:one)).to eq(true)
+      end
+
+      it 'allows for the deletion of items via delete' do
+        config.set(one: 'one', two: 'two')
+        expect(config.key?(:one)).to eq(true)
+        config.delete(:one)
+
+        expect(config.to_h).to eq(two: 'two')
+      end
+    end
+
+    describe 'to_s' do
+      it 'stringifies as the value of it\'s config hash' do
+        config.set(:one, :two, 'bar')
+
+        expect(config.to_s).to eq('{:one=>{:two=>"bar"}}')
+      end
+    end
+
+    describe 'to_h' do
+      it 'provides access to the underlying hash' do
+        config.set(:one, 'bar')
+
+        expect(config.to_h).to eq(one: 'bar')
+      end
+    end
+
+    describe 'persist' do
+      it 'persists data to a store' do
+        expect(store_double).to receive(:write).with(one: { two: 'bar' })
+
+        config.set(:one, :two, 'bar')
+        config.persist
+      end
+    end
+  end
+
+  describe Kefir::FileStore do
+    let(:data) { { secret: 'dont tell', users: [{ name: 'bob' }, { name: 'jane' }] } }
+    let(:file_path) { File.join(@temp_dir, 'config') }
+
+    before(:each) do
+      @temp_dir = Dir.mktmpdir
+    end
+
+    after(:each) do
+      FileUtils.remove_dir(@temp_dir)
+    end
+
+    it 'reads a configuration file' do
+      File.write(file_path, YAML.dump(data))
+      Kefir::FileStore.new(file_path)
+      parsed = YAML.load_file(file_path)
+
+      expect(parsed).to eq(
+        secret: 'dont tell',
+        users: [
+          { name: 'bob' },
+          { name: 'jane' }
+        ]
+      )
+    end
+
+    it 'writes to a configuration file' do
+      File.write(file_path, YAML.dump(data))
+      store = Kefir::FileStore.new(file_path)
+
+      store.write(data.merge(secret: 'changed'))
+
+      parsed = YAML.load_file(file_path)
+
+      expect(parsed).to eq(
+        secret: 'changed',
+        users: [
+          { name: 'bob' },
+          { name: 'jane' }
+        ]
+      )
+    end
+  end
+
+  describe '.config' do
+    it 'throws an error if no namespace is provided' do
+      expect do
+        Kefir.config(nil)
+      end.to raise_exception(Kefir::MissingNamespaceError)
+    end
+
+    it 'throws an error if an empty namespace is provided' do
+      expect do
+        Kefir.config('')
+      end.to raise_exception(Kefir::MissingNamespaceError)
+    end
+
+    it 'returns a fully functioning config object that can read config' do
+      allow(File).to receive(:read).and_yield("user: bob\napi_key: secret-value")
+
+      config = Kefir.config('test')
+
+      expect(config.get('user')).to eq('bob')
+    end
+
+    it 'returns a fully functioning config object that can write config' do
+      allow(File).to receive(:read).and_yield("user: bob\napi_key: secret-value")
+      expect(File).to receive(:write)
+
+      config = Kefir.config('test')
+      config.persist
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'kefir'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: kefir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Tomlin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: env_paths
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: dig_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+description: 
+email:
+- nick.tomlin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- kefir.gemspec
+- lib/kefir.rb
+- lib/kefir/version.rb
+- spec/kefir_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.7
+signing_key: 
+specification_version: 4
+summary: Simple configuration for your application/gem
+test_files:
+- spec/kefir_spec.rb
+- spec/spec_helper.rb