structura 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50aa01efafd6ded7076f51fee213210c74a35934
+  data.tar.gz: 915291ebec61849a803777117e128ac51b1f9dbf
+SHA512:
+  metadata.gz: 8cde176a5675b9cfcf0514b4c4772b7875bcb0aea29f7d5eee37ff8b50f9cda94092c901b64ae5d5558b996d9ea0c1e9de9e4634e2ecbca31f6ff61d12758d69
+  data.tar.gz: 829b6fc34f2e8dbb8abe6d2fbbf7510a267625b02a0cc2805912459795160f7d5936ff792227d1808e58d4bc8f468ef8423a6d78f574c02c53cff29f4e29571c

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephen Yu
+
+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,47 @@
+# Structura
+
+Configuration File Reader Gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structura'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structura
+
+## Usage
+
+```
+require 'structura'
+
+Structura::Cfg.instance.load_file 'config.yaml'
+
+p Structura::Cfg.instance.read_value('section_one', 'value_one')
+p Structura::Cfg.instance.read_value('section_one', 'value_two')
+```
+
+The Configuration File Format
+
+```
+section_one:
+  :value_one: "1.1"
+  :value_two: "1.2"
+
+section_two:
+  :value_one: '2.1'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)

data/lib/structura.rb

@@ -0,0 +1,6 @@
+require 'yaml'
+require 'singleton'
+
+# Internal Requires
+require "structura/version"
+require "structura/cfg"

data/lib/structura/cfg.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+require 'singleton'
+
+module Structura
+  class Cfg
+    include Singleton
+
+    def read_value section, variable
+      raise LoadError, 'Configuration file has not been loaded' if !@cfg
+
+      is_string section
+      is_string variable
+
+      return false if !@cfg.include? section
+      return false if !@cfg[section].include? string_to_symbol(variable)
+
+      @cfg[section][string_to_symbol(variable)]
+    end
+
+    def load_file file_path
+      raw_config = File.read(file_path)
+      @cfg = YAML.load(raw_config)
+    end
+
+    def string_to_symbol string
+      string.to_s.downcase.gsub(/\s+/, "_").to_sym
+    end
+
+    def is_string target
+      raise ArgumentError, "Expected String Parameter: #{target}" if !target.instance_of? String
+    end
+  end
+end

data/lib/structura/version.rb

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

data/spec/cfg_spec.rb

@@ -0,0 +1,38 @@
+require './spec/spec_helper'
+
+describe Structura::Cfg.instance do
+
+  before do
+    stub_const "FakeCfgClass", Structura::Cfg.clone
+  end
+
+  it "can`'t use the Cfg without loading a configuration file'" do
+    expect {FakeCfgClass.instance.read_value 'aaa', 'bbb'}.to raise_error LoadError
+  end
+
+  it "is_string: exceptions and working" do
+    expect {FakeCfgClass.instance.is_string 123}.to raise_error ArgumentError
+    expect {FakeCfgClass.instance.is_string '123'}.not_to raise_error
+  end
+
+  it "string_to_symbol: convert string to symbol" do
+    expect(FakeCfgClass.instance.string_to_symbol("string")).to eq :string
+  end
+
+  it "Cfg will raise exception when using non string arguments" do
+    FakeCfgClass.instance.load_file 'spec/config.yaml'
+    expect {FakeCfgClass.instance.read_value(:section, :value)}.to raise_error ArgumentError
+  end
+
+  it "Cfg read expected values, return false for values that don't exist" do
+    FakeCfgClass.instance.load_file 'spec/config.yaml'
+
+    FakeCfgClass.instance.read_value('section_one', 'one').should eq 'one'
+    FakeCfgClass.instance.read_value('section_one', 'two').should eq 'two'
+    FakeCfgClass.instance.read_value('section_two', 'one').should eq 'one'
+
+    FakeCfgClass.instance.read_value('section_one', 'fake_value').should be_false
+    FakeCfgClass.instance.read_value('fake_section', 'one').should be_false
+  end
+
+end

data/spec/config.yaml

@@ -0,0 +1,6 @@
+section_one:
+  :one: "one"
+  :two: "two"
+
+section_two:
+  :one: 'one'

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'structura'

data/structura.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structura/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structura"
+  spec.version       = Structura::VERSION
+  spec.authors       = ["Stephen Yu"]
+  spec.email         = ["s.yu@less3.com"]
+  spec.description   = ["Reading a Configuration File"]
+  spec.summary       = ["Straight forward gem for reading a Configuration File"]
+  spec.homepage      = "https://github.com/stephenyu/Structura"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: structura
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: '["Reading a Configuration File"]'
+email:
+- s.yu@less3.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structura.rb
+- lib/structura/cfg.rb
+- lib/structura/version.rb
+- spec/cfg_spec.rb
+- spec/config.yaml
+- spec/spec_helper.rb
+- structura.gemspec
+homepage: https://github.com/stephenyu/Structura
+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.0.5
+signing_key: 
+specification_version: 4
+summary: '["Straight forward gem for reading a Configuration File"]'
+test_files:
+- spec/cfg_spec.rb
+- spec/config.yaml
+- spec/spec_helper.rb