yamload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d479e22a573daeec01e50860fd57bcbbdd156b41
+  data.tar.gz: a214e210884aa1700000372b007876511494f7fa
+SHA512:
+  metadata.gz: db21529dffbe4ec9389b2935628700ae463316f823e65202531a95409976400673fbccb5e2865da036204d401b8fa77e94c227b9d41b39daf9c1809175ee3307
+  data.tar.gz: ac79928bb7fe4532c1e153d85cd2d60e170d6ab838323b15235abadb3b2eaceade65ce239ee3b3ea8bb772219d25523c2b1899da59c346ac5105cb4de189c2ce

data/.gitignore

@@ -0,0 +1,16 @@
+/vendor/
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+Style/Blocks:
+  Enabled: false
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1
+  - 2.2
+script: "bundle exec rake coverage"
+notifications:
+  email:
+    - support@travellink.com.au
+  flowdock: e69dcafad1fea15c6b8c76e9ced965af

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alessandro Berardi
+
+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,79 @@
+# Yamload
+
+[![Gem Version](https://badge.fury.io/rb/yamload.png)](http://badge.fury.io/rb/yamload)
+[![Build Status](https://travis-ci.org/sealink/yamload.png?branch=master)](https://travis-ci.org/sealink/yamload)
+[![Coverage Status](https://coveralls.io/repos/sealink/yamload/badge.png)](https://coveralls.io/r/sealink/yamload)
+[![Dependency Status](https://gemnasium.com/sealink/yamload.png)](https://gemnasium.com/sealink/yamload)
+[![Code Climate](https://codeclimate.com/github/sealink/yamload.png)](https://codeclimate.com/github/sealink/yamload)
+
+* YAML files loading
+* Recursive conversion to immutable objects
+* Schema validation
+* Default values
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yamload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yamload
+
+## Usage
+
+Set up the YAML files directory
+```ruby
+Yamload.dir = File.join(File.dirname(File.expand_path(__FILE__)),'config')
+```
+
+e.g. config/test.yml
+```yaml
+---
+test: true
+```
+
+Load YAML files from the directory and access keys
+```ruby
+# Load config/test.yml
+loader = Yamload::Loader.new(:test)
+loader.loaded_hash('attribute')
+# => true
+loader.obj.attribute
+# => true
+```
+
+Define a schema for the configuration
+```ruby
+# Load config/test.yml
+loader = Yamload::Loader.new(:test)
+loader.define_schema do |schema|
+  schema.string 'test'
+end
+loader.valid?
+# => true
+loader.validate!
+# => nil
+loader.error
+# => nil
+```
+
+Define defaults
+```ruby
+loader.defaults = { 'test' => true , 'coverage' => { 'minimum' => 0.95 } }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sealink/yamload/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc 'Generate SimpleCov test coverage and open in your browser'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].invoke
+end

data/lib/yamload/hash_to_immutable_object.rb

@@ -0,0 +1,40 @@
+require 'facets/hash/rekey'
+require 'anima'
+
+module Yamload
+  class HashToImmutableObject
+    def initialize(hash)
+      @hash = hash.rekey
+    end
+
+    def call
+      immutable_objects_factory.new(converted_hash)
+    end
+
+    private
+
+    def immutable_objects_factory
+      anima = Anima.new(*@hash.keys)
+      Class.new do
+        include Adamantium
+        include anima
+      end
+    end
+
+    def converted_hash
+      @hash.map.with_object({}) { |(key, value), hash|
+        hash[key] = convert(value)
+      }
+    end
+
+    def convert(value)
+      if value.is_a?(Hash)
+        self.class.new(value).call
+      elsif value.is_a?(Array)
+        value.map { |element| convert(element) }
+      else
+        value
+      end
+    end
+  end
+end

data/lib/yamload/loader.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+require 'respect'
+require 'facets/hash/deep_merge'
+
+module Yamload
+  class Loader
+    def initialize(file, dir = Yamload.dir)
+      @file = file
+      @dir  = dir
+    end
+
+    def loaded_hash
+      @loaded_hash ||= defaults.deep_merge(load)
+    end
+
+    def obj
+      @immutable_obj ||= HashToImmutableObject.new(loaded_hash).call
+    end
+
+    def reload
+      @loaded_hash = @immutable_obj = nil
+      loaded_hash
+    end
+
+    def define_schema
+      @schema = Respect::HashSchema.define do |schema|
+        yield schema
+      end
+    end
+
+    attr_writer :defaults
+
+    def defaults
+      @defaults ||= {}
+    end
+
+    def valid?
+      return true if @schema.nil?
+      @schema.validate? loaded_hash
+    end
+
+    def validate!
+      return if valid?
+      fail SchemaError, error
+    end
+
+    def error
+      return nil if valid?
+      @schema.last_error.message
+    end
+
+    private
+
+    def load
+      YAML.load_file(File.join(@dir, "#{@file}.yml"))
+    end
+  end
+
+  class SchemaError < StandardError; end
+end

data/lib/yamload/version.rb

@@ -0,0 +1,3 @@
+module Yamload
+  VERSION = '0.0.1'
+end

data/lib/yamload.rb

@@ -0,0 +1,10 @@
+require 'yamload/version'
+
+module Yamload
+  class << self
+    attr_accessor :dir
+  end
+end
+
+require 'yamload/loader'
+require 'yamload/hash_to_immutable_object'

data/spec/fixtures/test.yml

@@ -0,0 +1,25 @@
+---
+test: true
+users:
+  - first_name: Testy
+    last_name: Tester
+    address:
+      address_line_1: 1 Test Avenue
+      address_line_2:
+      city: Testville
+      state: TST
+      post_code: 1234
+      country: Testalia
+    email: testy.tester@test.com
+  - first_name: Speccy
+    last_name: Speccer
+    address:
+      address_line_1: Unit 1
+      address_line_2: 42 Spec Street
+      city: Specwood
+      state: SPC
+      post_code: 5678
+      country: Specland
+    email: speccy.speccer@spec.com
+settings:
+  remote_access: true

data/spec/loader_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+require 'yamload'
+
+describe Yamload do
+  let(:loader)      { Yamload::Loader.new(:test) }
+  let(:config)      { loader.loaded_hash }
+  let(:config_obj)  { loader.obj }
+
+  let(:expected_config) {
+    {
+      'test'  => true,
+      'users' => [
+        {
+          'first_name' => 'Testy',
+          'last_name'  => 'Tester',
+          'address'    => {
+            'address_line_1' => '1 Test Avenue',
+            'address_line_2' => nil,
+            'city'           => 'Testville',
+            'state'          => 'TST',
+            'post_code'      => 1234,
+            'country'        => 'Testalia'
+          },
+          'email'      => 'testy.tester@test.com'
+        },
+        {
+          'first_name' => 'Speccy',
+          'last_name'  => 'Speccer',
+          'address'    => {
+            'address_line_1' => 'Unit 1',
+            'address_line_2' => '42 Spec Street',
+            'city'           => 'Specwood',
+            'state'          => 'SPC',
+            'post_code'      => 5678,
+            'country'        => 'Specland'
+          },
+          'email'      => 'speccy.speccer@spec.com'
+        }
+      ],
+      'settings' => {
+        'remote_access' => true
+      }
+    }
+  }
+
+  specify { expect(config).to eq expected_config }
+  specify { expect(config_obj.test).to eq true }
+  specify { expect(config_obj.users[0].first_name).to eq 'Testy' }
+  specify { expect(config_obj.users[0].last_name).to eq 'Tester' }
+  specify { expect(config_obj.users[0].address.address_line_1).to eq '1 Test Avenue' }
+  specify { expect(config_obj.users[0].address.address_line_2).to eq nil }
+  specify { expect(config_obj.users[0].address.city).to eq 'Testville' }
+  specify { expect(config_obj.users[0].address.state).to eq 'TST' }
+  specify { expect(config_obj.users[0].address.post_code).to eq 1234 }
+  specify { expect(config_obj.users[0].address.country).to eq 'Testalia' }
+  specify { expect(config_obj.users[0].email).to eq 'testy.tester@test.com' }
+  specify { expect(config_obj.users[1].first_name).to eq 'Speccy' }
+  specify { expect(config_obj.users[1].last_name).to eq 'Speccer' }
+  specify { expect(config_obj.users[1].address.address_line_1).to eq 'Unit 1' }
+  specify { expect(config_obj.users[1].address.address_line_2).to eq '42 Spec Street' }
+  specify { expect(config_obj.users[1].address.city).to eq 'Specwood' }
+  specify { expect(config_obj.users[1].address.state).to eq 'SPC' }
+  specify { expect(config_obj.users[1].address.post_code).to eq 5678 }
+  specify { expect(config_obj.users[1].address.country).to eq 'Specland' }
+  specify { expect(config_obj.users[1].email).to eq 'speccy.speccer@spec.com' }
+  specify { expect(config_obj.settings.remote_access).to eq true }
+
+  context 'when trying to modify the configuration object' do
+    let(:new_user) { double('new user') }
+    specify 'the object should be immutable' do
+      expect { config_obj.users << new_user }
+        .to raise_error RuntimeError, "can't modify frozen Array"
+      expect(config_obj.users).not_to include new_user
+    end
+  end
+
+  context 'when a schema is defined' do
+    let(:define_schema) {
+      loader.define_schema do |schema|
+        schema.array 'users' do |users_array|
+          users_array.hash do |user_hash|
+            user_hash.string 'first_name'
+            user_hash.string 'last_name'
+            user_hash.hash 'address' do |address_hash|
+              address_hash.string 'address_line_1'
+              address_hash.string 'city'
+              address_hash.string 'state'
+              address_hash.integer 'post_code'
+              address_hash.string 'country'
+            end
+            user_hash.string 'email', format: :email
+          end
+        end
+      end
+    }
+
+    before { define_schema }
+
+    specify { expect(loader).to be_valid }
+    specify { expect(loader.error).to be_nil }
+    specify { expect { loader.validate! }.not_to raise_error }
+
+    context 'when the schema is not matched' do
+      let(:define_schema) {
+        loader.define_schema do |schema|
+          schema.array 'users' do |users_array|
+            users_array.hash do |user_hash|
+              user_hash.string 'expected_attribute'
+            end
+          end
+        end
+      }
+
+      let(:expected_error) { "missing key `expected_attribute'" }
+      specify { expect(loader).not_to be_valid }
+      specify { expect(loader.error).to eq expected_error }
+      specify { expect { loader.validate! }.to raise_error Yamload::SchemaError, expected_error }
+    end
+  end
+
+  context 'when defaults are defined' do
+    let(:defaults) {
+      {
+        'settings' => {
+          'remember_user' => false,
+          'remote_access' => false
+        }
+      }
+    }
+
+    before do
+      loader.defaults = defaults
+    end
+
+    specify { expect(config_obj.settings.remember_user).to eq false }
+    specify { expect(config_obj.settings.remote_access).to eq true }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+MINIMUM_COVERAGE = 95
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-rcov'
+  require 'coveralls'
+  Coveralls.wear!
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::RcovFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start do
+    add_filter '/vendor/'
+    add_filter '/spec/'
+    add_group 'lib', 'lib'
+  end
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    percent = SimpleCov.result.covered_percent
+    unless percent >= MINIMUM_COVERAGE
+      puts "Coverage must be above #{MINIMUM_COVERAGE}%. It is #{format('%.2f', percent)}%"
+      Kernel.exit(1)
+    end
+  end
+end
+
+require 'yamload'
+
+current_file_dir = File.expand_path(File.dirname(__FILE__))
+Yamload.dir = File.join(current_file_dir, 'fixtures')

data/yamload.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yamload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yamload'
+  spec.version       = Yamload::VERSION
+  spec.authors       = ['Alessandro Berardi']
+  spec.email         = ['berardialessandro@gmail.com']
+  spec.summary       = 'YAML files loader'
+  spec.description   = 'YAML files loader with validation'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'anima', '~> 0.2'
+  spec.add_dependency 'facets', '~> 3.0'
+  spec.add_dependency 'respect', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: yamload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alessandro Berardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: respect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: YAML files loader with validation
+email:
+- berardialessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yamload.rb
+- lib/yamload/hash_to_immutable_object.rb
+- lib/yamload/loader.rb
+- lib/yamload/version.rb
+- spec/fixtures/test.yml
+- spec/loader_spec.rb
+- spec/spec_helper.rb
+- yamload.gemspec
+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.4.5
+signing_key: 
+specification_version: 4
+summary: YAML files loader
+test_files:
+- spec/fixtures/test.yml
+- spec/loader_spec.rb
+- spec/spec_helper.rb