cogwheels 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5ee70dfbd9dd92d4281567d1ba1ada1a5bb8a02
+  data.tar.gz: 0ce0a29503a912eb6d8f239957b001cee86df9a5
+SHA512:
+  metadata.gz: 5ad807c8cb8d9af9bcbaf71aaa19a7a9fa6687694c159f7d1ffc202297f38884aedd82029a49721bb63cca3143afd3dad99e46a595b6f221765bf0019b37e7d4
+  data.tar.gz: a469ca79dede33cc0b176f29034d49b9e541f2bf598a604e9dfcf9f0f744011713c4768e755246742dc5fd57b24a1969ba984a6b3b0bfec2a5f4aaa39ffbc345

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Christopher Lutz
+
+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,7 @@
+[![Dependency Status](https://gemnasium.com/badges/github.com/chrisblutz/cogwheels.svg)](https://gemnasium.com/github.com/chrisblutz/cogwheels)
+[![Linux Build Status](https://travis-ci.org/chrisblutz/cogwheels.svg?branch=master)](https://travis-ci.org/chrisblutz/cogwheels)
+[![Inline docs](http://inch-ci.org/github/chrisblutz/cogwheels.svg?branch=master)](http://inch-ci.org/github/chrisblutz/cogwheels)
+[![Test Coverage](https://codeclimate.com/github/chrisblutz/cogwheels/badges/coverage.svg)](https://codeclimate.com/github/chrisblutz/cogwheels/coverage)
+[![Code Climate](https://codeclimate.com/github/chrisblutz/cogwheels/badges/gpa.svg)](https://codeclimate.com/github/chrisblutz/cogwheels)
+# Cogwheels
+**Cogwheels** is a work-in-progress configuration-loading library for Ruby.

data/lib/cogwheels/configuration.rb

@@ -0,0 +1,36 @@
+module Cogwheels
+  # This class contains configuration information loaded from YAML sources
+  class Configuration
+    class ImmutableConfigurationError < StandardError
+    end
+
+    attr_reader :mutable
+
+    def initialize(hash, mutable = true)
+      @hash = hash
+      @mutable = mutable
+    end
+
+    def [](key)
+      @hash[key]
+    end
+
+    def []=(key, value)
+      unless @mutable
+        error = <<-EOF
+A modification was attempted on an immutable Configuration instance.
+      EOF
+        raise ImmutableConfigurationError, error
+      end
+      @hash[key] = value if @mutable
+    end
+
+    def to_s
+      @hash.to_s
+    end
+
+    def inspect
+      "Cogwheels::Configuration =>\n#{@hash}"
+    end
+  end
+end

data/lib/cogwheels/loader.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+require 'safe_yaml'
+
+require 'cogwheels/configuration'
+
+module Cogwheels
+  # This module helps in loading YAML configurations from different source types
+  module Loader
+    class << self
+      def load(src, mutable = true)
+        return Configuration.new(from_file(src), mutable) if File.file?(src)
+      end
+
+      def from_file(file)
+        hash = {}
+        if File.exist?(file)
+          yaml = IO.read(file)
+          hash = safe_load(yaml, File.path(file))
+        end
+        hash
+      end
+
+      private
+
+      def safe_load(yaml, name)
+        SafeYAML.load(yaml, name)
+      end
+    end
+  end
+end

data/lib/cogwheels/version.rb

@@ -0,0 +1,3 @@
+module Cogwheels
+  VERSION = '0.1.1'.freeze
+end

data/lib/cogwheels.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+# Internal dependencies
+require 'cogwheels/version'
+
+# Cogwheels allows YAML configuration files to be loaded into Configuration
+# instances for ease of use
+#
+# Cogwheels is licensed under the MIT license:
+#
+# Copyright (c) 2016 Christopher Lutz
+#
+# 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.
+module Cogwheels
+  autoload :Configuration, 'cogwheels/configuration'
+  autoload :Loader, 'cogwheels/loader'
+
+  module_function
+
+  def load(src, mutable = true)
+    Cogwheels::Loader.load(src, mutable)
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: cogwheels
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christopher Lutz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Cogwheels is a library to load configurations from YAML files into easy-to-use
+  hash-like objects
+email:
+- lutzblox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/cogwheels.rb
+- lib/cogwheels/configuration.rb
+- lib/cogwheels/loader.rb
+- lib/cogwheels/version.rb
+homepage: https://github.com/chrisblutz/cogwheels
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: A Ruby configuration-loading library
+test_files: []