buff-config 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec thor spec"
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing
+
+## Running tests
+
+### Install prerequisites
+
+Install the latest version of [Bundler](http://gembundler.com)
+
+    $ gem install bundler
+
+Clone the project
+
+    $ git clone git://github.com/RiotGames/buff-ruby_engine.git
+
+and run:
+
+    $ cd buff-ruby_engine
+    $ bundle install
+
+Bundler will install all gems and their dependencies required for testing and developing.
+
+### Running unit (RSpec) tests
+
+    $ bundle exec guard start

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+notification :off
+
+guard "spork" do
+  watch('Gemfile')
+  watch('spec/spec_helper.rb')     { :rspec }
+  watch(%r{^spec/support/.+\.rb$}) { :rspec }
+end
+
+guard "rspec", cli: "--color --drb --format Fuubar", all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/.+_spec\.rb$})
+
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { "spec" }
+  watch(%r{^spec/support/.+\.rb$})   { "spec" }
+end

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright 2012-2013 Riot Games
+
+    Jamie Winsor (<reset@riotgames.com>)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,36 @@
+# Buff::Config
+[![Gem Version](https://badge.fury.io/rb/buff-config.png)](http://badge.fury.io/rb/buff-config)
+[![Build Status](https://travis-ci.org/RiotGames/buff-config.png?branch=master)](https://travis-ci.org/RiotGames/buff-config)
+
+A simple configuration class
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'buff-config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buff-config
+
+## Usage
+
+    require 'buff/config/json'
+
+    class MyConfig < Buff::Config::JSON
+      attribute 'chef.chef_server_url'
+    end
+
+    my_config = MyConfig.new
+    my_config.chef.chef_server_url #=> nil
+
+# Authors and Contributors
+
+* Jamie Winsor (<reset@riotgames.com>)
+
+Thank you to all of our [Contributors](https://github.com/RiotGames/buff-config/graphs/contributors), testers, and users.

data/Thorfile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'bundler/setup'
+require 'buff/ruby_engine'
+require 'buff/config/version'
+
+class Default < Thor
+  extend Buff::RubyEngine
+
+  unless jruby?
+    require 'thor/rake_compat'
+
+    include Thor::RakeCompat
+    Bundler::GemHelper.install_tasks
+
+    desc "build", "Build buff-config-#{Buff::Config::VERSION}.gem into the pkg directory"
+    def build
+      Rake::Task["build"].execute
+    end
+
+    desc "install", "Build and install buff-config-#{Buff::Config::VERSION}.gem into system gems"
+    def install
+      Rake::Task["install"].execute
+    end
+
+    desc "release", "Create tag v#{Buff::Config::VERSION} and build and push buff-config-#{Buff::Config::VERSION}.gem to Rubygems"
+    def release
+      Rake::Task["release"].execute
+    end
+  end
+
+  class Spec < Thor
+    namespace :spec
+    default_task :unit
+
+    desc "unit", "run the project's unit tests"
+    def unit
+      exec "rspec --color --format=documentation spec"
+    end
+  end
+end

data/buff-config.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buff/config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "buff-config"
+  spec.version       = Buff::Config::VERSION
+  spec.authors       = ["Jamie Winsor"]
+  spec.email         = ["reset@riotgames.com"]
+  spec.description   = %q{A simple configuration class}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/RiotGames/buff-config"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 1.9.2"
+
+  spec.add_dependency "varia_model", "~> 0.1"
+  spec.add_dependency "buff-extensions", "~> 0.3"
+
+  spec.add_development_dependency "buff-ruby_engine", "~> 0.1"
+  spec.add_development_dependency "thor", "~> 0.18.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-spork"
+  spec.add_development_dependency "spork"
+  spec.add_development_dependency "json_spec"
+end

data/lib/buff-config.rb

@@ -0,0 +1 @@
+require_relative 'buff/config'

data/lib/buff/config.rb

@@ -0,0 +1,32 @@
+require 'buff/extensions'
+require 'varia_model'
+require 'forwardable'
+
+module Buff
+  require_relative 'config/errors'
+
+  module Config
+    class Base
+      extend Forwardable
+      include VariaModel
+
+      attr_accessor :path
+
+      def_delegator :to_hash, :slice
+      def_delegator :to_hash, :slice!
+      def_delegator :to_hash, :extract!
+
+      # @param [String] path
+      # @param [Hash] attributes
+      def initialize(path = nil, attributes = {})
+        @path = File.expand_path(path) if path
+
+        mass_assign(attributes)
+      end
+
+      def to_hash
+        super.deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/buff/config/errors.rb

@@ -0,0 +1,7 @@
+module Buff
+  module Errors
+    class ConfigNotFound < StandardError; end
+    class InvalidConfig < StandardError; end
+    class ConfigSaveError < StandardError; end
+  end
+end

data/lib/buff/config/json.rb

@@ -0,0 +1,59 @@
+require 'buff/config'
+
+module Buff
+  module Config
+    class JSON < Config::Base
+      class << self
+        # @param [String] data
+        #
+        # @return [Buff::Config::JSON]
+        def from_json(data)
+          new.from_json(data)
+        end
+
+        # @param [String] path
+        #
+        # @raise [Buff::Errors::ConfigNotFound]
+        #
+        # @return [Buff::Config::JSON]
+        def from_file(path)
+          path = File.expand_path(path)
+          data = File.read(path)
+          new(path).from_json(data)
+        rescue TypeError, Errno::ENOENT, Errno::EISDIR
+          raise Errors::ConfigNotFound, "No configuration found at: '#{path}'"
+        end
+      end
+
+      # @see {VariaModel#from_json}
+      #
+      # @raise [Buff::Errors::InvalidConfig]
+      #
+      # @return [Buff::Config::JSON]
+      def from_json(*args)
+        super
+      rescue JSON::ParseError => ex
+        raise Errors::InvalidConfig, ex
+      end
+
+      def save(destination = self.path)
+        if destination.nil?
+          raise Errors::ConfigSaveError, "Cannot save configuration without a destination. Provide one to save or set one on the object."
+        end
+
+        FileUtils.mkdir_p(File.dirname(destination))
+        File.open(destination, 'w+') do |f|
+          f.write(self.to_json(pretty: true))
+        end
+      end
+
+      # Reload the current configuration file from disk
+      #
+      # @return [Buff::Config::JSON]
+      def reload
+        mass_assign(self.class.from_file(path).to_hash)
+        self
+      end
+    end
+  end
+end

data/lib/buff/config/version.rb

@@ -0,0 +1,5 @@
+module Buff
+  module Config
+    VERSION = "0.1.0"
+  end
+end

data/spec/buff/config/json_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'buff/config/json'
+
+describe Buff::Config::JSON do
+  let(:json) do
+    %(
+      {
+        "name": "reset",
+        "job": "programmer",
+        "status": "awesome"
+      }
+    )
+  end
+
+  describe "ClassMethods" do
+    subject do
+      Class.new(Buff::Config::JSON) do
+        attribute :name, required: true
+        attribute :job
+      end
+    end
+
+    describe "::from_json" do
+      it "returns an instance of the inheriting class" do
+        expect(subject.from_json(json)).to be_a(subject)
+      end
+
+      it "assigns values for each defined attribute" do
+        config = subject.from_json(json)
+
+        expect(config[:name]).to eql("reset")
+        expect(config[:job]).to eql("programmer")
+      end
+    end
+
+    describe "::from_file" do
+      let(:file) { tmp_path.join("test_config.json").to_s }
+
+      before(:each) do
+        File.open(file, "w") { |f| f.write(json) }
+      end
+
+      it "returns an instance of the inheriting class" do
+        expect(subject.from_file(file)).to be_a(subject)
+      end
+
+      it "sets the object's filepath to the path of the loaded file" do
+        expect(subject.from_file(file).path).to eql(file)
+      end
+
+      context "given a file that does not exist" do
+        it "raises a Buff::Errors::ConfigNotFound error" do
+          expect { subject.from_file(tmp_path.join("asdf.txt")) }.to raise_error(Buff::Errors::ConfigNotFound)
+        end
+      end
+    end
+  end
+
+  subject do
+    Class.new(Buff::Config::JSON) do
+      attribute :name, required: true
+      attribute :job
+    end.new
+  end
+
+  describe "#to_json" do
+    before(:each) do
+      subject.name = "reset"
+      subject.job = "programmer"
+    end
+
+    it "returns JSON with key values for each attribute" do
+      hash = parse_json(subject.to_json)
+
+      expect(hash).to have_key("name")
+      expect(hash["name"]).to eql("reset")
+      expect(hash).to have_key("job")
+      expect(hash["job"]).to eql("programmer")
+    end
+  end
+
+  describe "#from_json" do
+    it "returns an instance of the updated class" do
+      expect(subject.from_json(json)).to be_a(Buff::Config::JSON)
+    end
+
+    it "assigns values for each defined attribute" do
+      config = subject.from_json(json)
+
+      expect(config.name).to eql("reset")
+      expect(config.job).to eql("programmer")
+    end
+  end
+
+  describe "#save" do
+    it "raises a ConfigSaveError if no path is set or given" do
+      subject.path = nil
+
+      expect { subject.save }.to raise_error(Buff::Errors::ConfigSaveError)
+    end
+  end
+
+  describe "#reload" do
+    before(:each) do
+      subject.path = tmp_path.join('tmpconfig.json').to_s
+      subject.save
+    end
+
+    it "returns self" do
+      expect(subject.reload).to eql(subject)
+    end
+
+    it "updates the contents of self from disk" do
+      original = subject.class.from_file(subject.path)
+      subject.job = "programmer"
+      subject.save
+
+      expect(original.job).to be_nil
+      original.reload
+      expect(original.job).to eql("programmer")
+    end
+
+    it "raises ConfigNotFound if the path is nil" do
+      subject.path = nil
+
+      expect { subject.reload }.to raise_error(Buff::Errors::ConfigNotFound)
+    end
+  end
+end

data/spec/buff/config_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Buff::Config::Base do
+  subject { Class.new(described_class).new }
+
+  describe "#to_hash" do
+    it "returns a Hash" do
+      expect(subject.to_hash).to be_a(Hash)
+    end
+
+    it "contains all of the attributes" do
+      subject.set_attribute(:something, "value")
+
+      expect(subject.to_hash).to have_key(:something)
+      expect(subject.to_hash[:something]).to eql("value")
+    end
+  end
+
+  describe "#slice" do
+    before(:each) do
+      subject.set_attribute(:one, nested: "value")
+      subject.set_attribute(:two, nested: "other")
+      @sliced = subject.slice(:one)
+    end
+
+    it "returns a Hash" do
+      expect(@sliced).to be_a(Hash)
+    end
+
+    it "contains just the sliced elements" do
+      expect(@sliced).to have(1).item
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'buff/ruby_engine'
+require 'json_spec'
+
+def setup_rspec
+  RSpec.configure do |config|
+    config.include JsonSpec::Helpers
+
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+    config.mock_with :rspec
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.filter_run focus: true
+    config.run_all_when_everything_filtered = true
+
+    config.before(:each) { clean_tmp_path }
+  end
+end
+
+def app_root
+  @app_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+end
+
+def clean_tmp_path
+  FileUtils.rm_rf(tmp_path)
+  FileUtils.mkdir_p(tmp_path)
+end
+
+def tmp_path
+  app_root.join('spec', 'tmp')
+end
+
+if Buff::RubyEngine.jruby?
+  require 'buff/config'
+  setup_rspec
+else
+  require 'spork'
+
+  Spork.prefork { setup_rspec }
+  Spork.each_run { require 'buff/config' }
+end

metadata

@@ -0,0 +1,278 @@
+--- !ruby/object:Gem::Specification
+name: buff-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Winsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: varia_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: buff-extensions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: buff-ruby_engine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple configuration class
+email:
+- reset@riotgames.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Thorfile
+- buff-config.gemspec
+- lib/buff-config.rb
+- lib/buff/config.rb
+- lib/buff/config/errors.rb
+- lib/buff/config/json.rb
+- lib/buff/config/version.rb
+- spec/buff/config/json_spec.rb
+- spec/buff/config_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/RiotGames/buff-config
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1013428391451847174
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple configuration class
+test_files:
+- spec/buff/config/json_spec.rb
+- spec/buff/config_spec.rb
+- spec/spec_helper.rb