yml_reader 0.1

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/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p0@data_magic --create

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'fuubar'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+gem 'growl'
+gem 'guard-rspec'
+
+# Specify your gem's dependencies in yml_reader.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format Fuubar' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/yml_reader/#{m[1]}_spec.rb" }
+  watch(%r{^(.+)\.rb$})     { |m| "spec/yml_reader/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeffrey S. Morgan
+
+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,53 @@
+# YmlReader
+
+Simple (very simple) gem to set a directory and load yaml files.  This gem is a result of finding duplication between my data_magic and fig_newton gems.  Here's an example of how it is used in the fig_newton gem:
+
+First of all you need to extend the `YmlReader` gem if you intend to use it in another Module:
+
+````ruby
+class FigNewton
+  extend YmlReader
+````
+
+By extending the `YmlReader` module you now have three new methods and two instance variables. Here are the three methods:
+
+````ruby
+yml_directory=
+yml_directory
+load
+````
+
+and the instance variables:
+
+````ruby
+@yml_directory
+@yml
+````
+
+The `@yml` instance variable will contain the contents of the yml file after a call to load.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yml_reader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yml_reader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+task :default => :spec

data/lib/yml_reader.rb

@@ -0,0 +1,29 @@
+require "yml_reader/version"
+
+module YmlReader
+
+  #
+  # Set the directory to use when reading yml files
+  #
+  def yml_directory=(directory)
+    @yml_directory = directory
+  end
+
+  #
+  # Returns the directory to be used when reading yml files
+  #
+  def yml_directory
+    return @yml_directory if @yml_directory
+    return default_directory if self.respond_to? :default_directory
+    nil
+  end
+
+  #
+  # Loads the requested file.  It will look for the file in the
+  # directory specified by a call to the yml_directory= method.
+  #
+  def load(filename)
+    @yml = YAML.load_file "#{@yml_directory}/#{filename}"
+  end
+  
+end

data/lib/yml_reader/version.rb

@@ -0,0 +1,3 @@
+module YmlReader
+  VERSION = "0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if ENV['coverage']
+  raise "simplecov only works on Ruby 1.9" unless RUBY_VERSION =~ /^1\.9/
+
+  require 'simplecov'
+  SimpleCov.start { add_filter "spec/" }
+end
+
+require 'rspec'
+require 'yml_reader'
+
+
+

data/spec/yml_reader/yml_reader_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module MyModule
+  extend YmlReader
+
+  def self.default_directory
+    'default_directory'
+  end
+end
+
+describe YmlReader do
+  context "when configuring the yml directory" do
+    before(:each) do
+      MyModule.yml_directory = nil
+    end
+    
+    it "should store a yml directory" do
+      MyModule.yml_directory = 'some_directory'
+      MyModule.yml_directory.should == 'some_directory'
+    end
+
+    it "should default to a directory specified by the containing class" do
+      MyModule.yml_directory.should == 'default_directory'
+    end
+  end
+
+  context "when reading yml files" do
+    it "should read files from the yml_directory" do
+      MyModule.yml_directory = 'conf'
+      YAML.should_receive(:load_file).with('conf/test').and_return({})
+      MyModule.load('test')
+    end
+  end
+end

data/yml_reader.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yml_reader/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jeffrey S. Morgan"]
+  gem.email         = ["jeff.morgan@leandog.com"]
+  gem.description   = %q{Sets a directory and reads yml files}
+  gem.summary       = %q{Sets a directory and reads yml files}
+  gem.homepage      = "http://github.com/cheezy/yml_reader"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "yml_reader"
+  gem.require_paths = ["lib"]
+  gem.version       = YmlReader::VERSION
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: yml_reader
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jeffrey S. Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies: []
+description: Sets a directory and reads yml files
+email:
+- jeff.morgan@leandog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yml_reader.rb
+- lib/yml_reader/version.rb
+- spec/spec_helper.rb
+- spec/yml_reader/yml_reader_spec.rb
+- yml_reader.gemspec
+homepage: http://github.com/cheezy/yml_reader
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Sets a directory and reads yml files
+test_files:
+- spec/spec_helper.rb
+- spec/yml_reader/yml_reader_spec.rb