kefir 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34bd27c107be11b6e9051bf444f5eee377758915
-  data.tar.gz: 7354cd1b6751c3453a5e8c3cdf573f22cef8fe77
+  metadata.gz: 13d8742a055b653495c9e655d9469c0ecbd1894a
+  data.tar.gz: 095c8d016e1d849c91f5556497cc755978777768
 SHA512:
-  metadata.gz: 0a9cb0e32386852224d238643322e50d42d54371f6bff1315fcf383032f8e46668ec2b3cc1427ed64fa637e5780fc5e0cdda4963715184dd2c660614623c93aa
-  data.tar.gz: e6237785bf1bd138c2a0f710b00e9ba01b9de95d62ed09dd6dc0ac1c424ae4287480829e6acdba5b7c5f0fe3b115790a6d63a7e0808e3a2ffa2cfe811b5e9c09
+  metadata.gz: c3ce4f0d0abcc83bc1a3b22ed3a70b3ece3b9cb2d79062340dac8a89d0699c4adb8f9b92d04e5eda025dc4cb013179bb4ab88d7abc9f5c0b8d438a12a25c5175
+  data.tar.gz: 8a38019191d5ce6264e3b327b53ae30a159efb5cfca9e3617ed97ee284aefd2ec93e5773c976021ee86406cf2b4ed8c57edc500ec811cc2ca6530b1bc637b6cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kefir (0.1.0)
+    kefir (1.0.0)
       dig_rb (~> 1.0, >= 1.0.1)
       env_paths (~> 0.0.2)
 
@@ -16,6 +16,7 @@ GEM
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.1.0)
+    rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -42,6 +43,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.7)
   kefir!
+  rake (~> 10.0)
   rspec (~> 3)
   rubocop (~> 0.45)
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -1,4 +1,4 @@
-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)
+kefir [![Build Status](https://travis-ci.org/NickTomlin/ruby-kefir.png?branch=master)](https://travis-ci.org/NickTomlin/ruby-kefir) [![Gem Version](https://badge.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).

data/kefir.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'env_paths', '~> 0.0.2'
   s.add_dependency 'dig_rb', '~> 1.0', '>= 1.0.1'
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 3'
   s.add_development_dependency 'rubocop', '~> 0.45'
 end

data/lib/kefir/config.rb

@@ -0,0 +1,68 @@
+module Kefir
+  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
+end

data/lib/kefir/file_store.rb

@@ -0,0 +1,19 @@
+module Kefir
+  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
+end

data/lib/kefir/version.rb

@@ -1,3 +1,3 @@
 module Kefir
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'.freeze
 end

data/lib/kefir.rb

@@ -1,102 +1,33 @@
-require 'kefir/version'
 require 'dig_rb'
 require 'env_paths'
-require 'YAML'
+require 'yaml'
+require 'kefir/version'
+require 'kefir/config'
+require 'kefir/file_store'
 
 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
+  DEFAULT_OPTIONS = {
+    config_name: 'config.yml'
+  }.freeze
 
-      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
+  def self.config(namespace, options = {})
+    raise MissingNamespaceError, 'You must supply a namespace for your configuration files' if namespace.nil? || namespace.empty?
 
-      nested = keys.inject(hash) do |h, key|
-        h[key] = {} unless h[key]
-        h[key]
-      end
+    parsed_options = parse_options(namespace, options)
+    store = FileStore.new(parsed_options[:config_file_path])
 
-      nested[last_key] = value unless nested.nil?
-    end
+    Config.new(store, options)
   end
 
-  def self.config(namespace, options = {})
-    raise MissingNamespaceError, 'You must supply a namespace for your configuration files' if namespace.nil? || namespace.empty?
+  private_class_method
 
-    config_file_path = EnvPaths.get(namespace).config
-    store = FileStore.new(config_file_path)
+  def self.parse_options(namespace, options)
+    parsed = DEFAULT_OPTIONS.merge(options)
+    cwd = parsed.fetch(:cwd, EnvPaths.get(namespace).config)
+    parsed[:config_file_path] = File.expand_path(parsed[:config_name], cwd)
 
-    Config.new(store, options)
+    parsed
   end
 end

data/spec/kefir/config_spec.rb

@@ -0,0 +1,124 @@
+RSpec.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

data/spec/kefir/file_store_spec.rb

@@ -0,0 +1,43 @@
+RSpec.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

data/spec/kefir_spec.rb

@@ -1,177 +1,4 @@
-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
@@ -200,5 +27,29 @@ RSpec.describe Kefir do
       config = Kefir.config('test')
       config.persist
     end
+
+    context 'options' do
+      it 'provides defaults' do
+        expect(File).to receive(:read).with(/config\.yml$/).and_yield("user: bob\napi_key: secret-value")
+        config = Kefir.config('test')
+        config.get(:foo)
+      end
+
+      it 'allows overriding current directory' do
+        custom_cwd = File.expand_path('custom/path', '/')
+        expect(File).to receive(:read).with(File.join(custom_cwd, 'config.yml')).and_yield("user: bob\napi_key: secret-value")
+
+        config = Kefir.config('test', cwd: custom_cwd)
+        config.get(:foo)
+      end
+
+      it 'allows overriding the :config_name' do
+        custom_cwd = File.expand_path('custom/path', '/')
+        expect(File).to receive(:read).with(File.join(custom_cwd, 'custom_config_name.yml')).and_yield("user: bob\napi_key: secret-value")
+
+        config = Kefir.config('test', cwd: custom_cwd, config_name: 'custom_config_name.yml')
+        config.get(:foo)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
 require 'rspec'
+require 'yaml'
+require 'tmpdir'
+require 'fileutils'
 require 'kefir'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kefir
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nick Tomlin
@@ -44,6 +44,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +118,11 @@ files:
 - Rakefile
 - kefir.gemspec
 - lib/kefir.rb
+- lib/kefir/config.rb
+- lib/kefir/file_store.rb
 - lib/kefir/version.rb
+- spec/kefir/config_spec.rb
+- spec/kefir/file_store_spec.rb
 - spec/kefir_spec.rb
 - spec/spec_helper.rb
 homepage: 
@@ -118,5 +150,7 @@ signing_key:
 specification_version: 4
 summary: Simple configuration for your application/gem
 test_files:
+- spec/kefir/config_spec.rb
+- spec/kefir/file_store_spec.rb
 - spec/kefir_spec.rb
 - spec/spec_helper.rb