ascetic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be538988aa7af75096c03b4d8e7890161855daa6
+  data.tar.gz: 36372d6ebf32580283a43f8852f73c77bc60c607
+SHA512:
+  metadata.gz: bbc1a1df9f9d76c632f300350d47559c2f6a7444203e5599bb8bc120fa146c81926692de78496fe38121cccea06e6643918b498d6c450b36f480c4f78bc91c34
+  data.tar.gz: 92844482babf865e02dfef0c38d192185429f1eb599efdc808972f81052b54adf3002654f8d31900940a213b405af3f4db0532de90cdceef92ec0facbdb278ac

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+settler

data/.ruby-version

@@ -0,0 +1 @@
+2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joseph McCormick
+
+MIT License
+
+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,59 @@
+# Ascetic
+
+Ascetic is a basic tool to interact with JSON or YAML configuration files.
+
+## Installation
+
+Place this in your `Gemfile`:
+
+```ruby
+gem 'ascetic'
+```
+
+Then `bundle install`.
+
+## Usage
+
+```ruby
+require 'ascetic'
+
+# Yaml files:
+Ascetic.load! '/path/to/config.yml'
+
+# Json files:
+Ascetic.load! '/path/to/config.json'
+```
+
+Ascetic will marshal the files and expose the options as methods.  For example, if your `config.json` looks like this:
+
+```json
+{
+  "api_key": "ec_fn_11h5bseljre35x"
+}
+```
+
+You will have the `api_key` method and a special `api_key?` presence check method available on your Ascetic object, like so:
+
+```ruby
+Ascetic.api_key?
+# => true
+
+Ascetic.api_key
+# => "ec_fn_11h5bseljre35x"
+```
+
+Any value set to `false`, or value which is not present in your configuration file, will result in `false` when a presence check is run.
+
+```ruby
+Ascetic.option_not_present_in_config?
+# => false
+
+Ascetic.option_not_present_in_config
+# => nil
+
+Ascetic.option_set_to_false_in_config?
+# => false
+
+Ascetic.option_set_to_false_in_config
+# => false
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |test_task|
+  test_task.libs << 'spec'
+  test_task.pattern = "spec/**/*_spec.rb"
+end
+
+task default: [:test]

data/ascetic.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ascetic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ascetic"
+  gem.version       = Ascetic::VERSION
+  gem.authors       = ["Joseph McCormick"]
+  gem.email         = ["esmevane@gmail.com"]
+  gem.description   = %q{Basic configuration loader}
+  gem.summary       = %q{Load .yml and .json files into a basic interface}
+  gem.homepage      = "http://www.github.com/esmevane/ascetic"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "minitest", "~> 4.3"
+  gem.add_development_dependency "pry", "~> 0.9"
+  gem.add_development_dependency "simplecov", "~> 0.8"
+end

data/lib/ascetic.rb

@@ -0,0 +1,21 @@
+module Ascetic
+  autoload :Config,  'ascetic/config'
+  autoload :Service, 'ascetic/service'
+  autoload :Store,   'ascetic/store'
+
+  def self.load! path
+    @service = Service.new Store.new Config.new(path).parse
+  end
+
+  def self.service
+    @service ||= Service.new
+  end
+
+  def self.respond_to? *arguments
+    service.respond_to? *arguments
+  end
+
+  def self.method_missing symbol, *arguments, &block
+    service.method_missing symbol, *arguments, &block
+  end
+end

data/lib/ascetic/config.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'yaml'
+
+module Ascetic
+  class Config
+    attr_reader :contents, :message, :strategy
+
+    STRATEGIES = { '.json' => JSON, '.yml' => YAML }
+    MESSAGES   = { '.json' => :parse, '.yml' => :load }
+
+    def initialize path
+      extension = File.extname path
+      @contents = File.read path
+      @strategy = STRATEGIES[extension]
+      @message  = MESSAGES[extension]
+    end
+
+    def parse
+      result = strategy.send message, contents
+      symbolize result
+    end
+
+    private
+
+    def symbolize value
+      return value unless value.is_a? Hash
+      value.reduce(Hash.new) do |hash, (key, value)|
+        hash[key.to_sym] = symbolize value
+        hash
+      end
+    end
+
+  end
+end

data/lib/ascetic/service.rb

@@ -0,0 +1,31 @@
+module Ascetic
+  class Service
+    attr_reader :store
+
+    def initialize store = Store.new
+      @store = store
+    end
+
+    def method_missing symbol, *arguments, &block
+      last_character = symbol.slice -1, 1
+      last_character == "?" ? present?(symbol) : get_from_store(symbol)
+    end
+
+    def respond_to? *_
+      true
+    end
+
+    private
+
+    def present? symbol
+      key_name = symbol.slice(0...-1).to_sym
+      result = get_from_store key_name
+      !!result
+    end
+
+    def get_from_store symbol
+      @store.get symbol
+    end
+
+  end
+end

data/lib/ascetic/store.rb

@@ -0,0 +1,17 @@
+module Ascetic
+  class Store
+    attr_reader :contents
+
+    def initialize options = Hash.new
+      @contents = options
+    end
+
+    def set key, value
+      contents[key] = value
+    end
+
+    def get key
+      contents[key]
+    end
+  end
+end

data/lib/ascetic/version.rb

@@ -0,0 +1,3 @@
+module Ascetic
+  VERSION = "0.0.1"
+end

data/spec/lib/ascetic/config_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Ascetic::Config do
+  let(:base_hash) do
+    { 'first_level' => { 'second_level' => true },
+      'array_key' => ['array_value'] }
+  end
+
+  let(:symbolized_hash) { symbolize base_hash }
+  let(:config) { Ascetic::Config.new file }
+
+  describe 'with JSON' do
+    let(:file) { 'config.json' }
+
+    describe '#strategy' do
+      subject { config.strategy }
+      it { File.stub(:read, '') { subject.must_equal JSON }}
+    end
+
+    describe '#message' do
+      subject { config.message }
+      it { File.stub(:read, '') { subject.must_equal :parse } }
+    end
+
+    describe '#parse' do
+      let(:json) { base_hash.to_json }
+      subject { File.stub(:read, json) { config.parse } }
+      it { subject.must_be_instance_of Hash }
+      it { subject.must_equal symbolized_hash }
+    end
+
+  end
+
+  describe 'with YAML' do
+    let(:file) { 'config.yml' }
+
+    describe '#strategy' do
+      subject { config.strategy }
+      it { File.stub(:read, '') { subject.must_equal YAML }}
+    end
+
+    describe '#message' do
+      subject { config.message }
+      it { File.stub(:read, '') { subject.must_equal :load } }
+    end
+
+    describe '#parse' do
+      let(:yaml) { base_hash.to_yaml }
+      subject { File.stub(:read, yaml) { config.parse } }
+      it { subject.must_be_instance_of Hash }
+      it { subject.must_equal symbolized_hash }
+    end
+
+  end
+end

data/spec/lib/ascetic/service_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Ascetic::Service do
+
+  describe 'default behavior' do
+    let(:service) { Ascetic::Service.new }
+    subject { service }
+    it { subject.respond_to?(:whatever).must_equal true }
+    it { subject.whatever.must_be_nil }
+    it { subject.whatever?.must_equal false }
+  end
+
+  describe 'with a populated Store object' do
+    let(:value) { "Value" }
+    let(:store) { Ascetic::Store.new key: value }
+    let(:service) { Ascetic::Service.new store }
+    subject { service }
+    it { subject.key.must_equal value }
+    it { subject.key?.must_equal true }
+  end
+
+end

data/spec/lib/ascetic/store_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Ascetic::Store do
+  let(:store) { Ascetic::Store.new }
+
+  describe 'accessors' do
+    subject { store }
+    it { subject.must_respond_to :contents }
+  end
+
+  describe '#set' do
+    subject { store }
+    let(:value) { "Value" }
+    it 'sets a value in #contents' do
+      store.set :key, value
+      store.contents[:key].must_equal value
+    end
+  end
+
+  describe '#get' do
+    let(:store) { Ascetic::Store.new key: value }
+    let(:value) { "Value" }
+    subject { store.get :key }
+    it { subject.must_equal value }
+  end
+
+end

data/spec/lib/ascetic_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Ascetic do
+  it { Ascetic.service.must_be_instance_of Ascetic::Service }
+
+  describe '#load!' do
+    let(:value) { "Value" }
+    let(:hash_config) { { "key" => value } }
+    let(:json_config) { hash_config.to_json }
+
+    before do
+      File.stub(:read, json_config) { Ascetic.load! 'config.json' }
+    end
+
+    it { Ascetic.whatever?.must_equal false }
+    it { Ascetic.key?.must_equal true }
+    it { Ascetic.key.must_equal value }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+
+SimpleCov.start { add_filter '/spec/' }
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../lib/ascetic'
+
+def symbolize value
+  return value unless value.is_a? Hash
+  value.reduce(Hash.new) do |hash, (key, value)|
+    hash[key.to_sym] = symbolize value
+    hash
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ascetic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joseph McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Basic configuration loader
+email:
+- esmevane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ascetic.gemspec
+- lib/ascetic.rb
+- lib/ascetic/config.rb
+- lib/ascetic/service.rb
+- lib/ascetic/store.rb
+- lib/ascetic/version.rb
+- spec/lib/ascetic/config_spec.rb
+- spec/lib/ascetic/service_spec.rb
+- spec/lib/ascetic/store_spec.rb
+- spec/lib/ascetic_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/esmevane/ascetic
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Load .yml and .json files into a basic interface
+test_files:
+- spec/lib/ascetic/config_spec.rb
+- spec/lib/ascetic/service_spec.rb
+- spec/lib/ascetic/store_spec.rb
+- spec/lib/ascetic_spec.rb
+- spec/spec_helper.rb