hashconfig 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+spec/testfiles/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,17 @@
+(General Public License)
+
+Copyright (c) 2012 Philipp Böhm
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation in version 3 of the License.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+MA 02110-1301, USA.

data/README.md

@@ -0,0 +1,45 @@
+# Hashconfig
+
+Extends the Ruby Hash class with a method (merge_with_serialized) that
+merges a hash instance with an serialized (YAML) instance of a hash. So
+it is a lightweight mechanism for configuration.
+
+[http://github.com/pboehm/hashconfig](http://github.com/pboehm/hashconfig)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hashconfig'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashconfig
+
+## Usage
+
+    require 'hashconfig'
+
+    STANDARD_CONFIG = {
+        :default_directory  => File.join(File.expand_path("~"), "Downloads"),
+        :store_episode_info => false,
+        :store_path         => File.join(CONFIG_DIR, "information_storage.yml"),
+        :byte_count_for_md5 => 2048,
+    }
+
+    config = STANDARD_CONFIG.merge_with_serialized('path/to/yaml/file')
+
+    # config now holds the data from STANDARD_CONFIG updated with values from
+    # the yaml file
+
+## 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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hashconfig.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hashconfig/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Philipp Böhm"]
+  gem.email         = ["philipp@i77i.de"]
+  gem.description   = %q{Simple configuration mechanism through serialized hash}
+  gem.summary       = %q{Simple configuration mechanism through serialized hash}
+  gem.homepage      = "http://github.com/pboehm/hashconfig"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hashconfig"
+  gem.require_paths = ["lib"]
+  gem.version       = Hashconfig::VERSION
+end

data/lib/hashconfig/version.rb

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

data/lib/hashconfig.rb

@@ -0,0 +1,32 @@
+require "hashconfig/version"
+require 'yaml'
+
+module Hashconfig
+
+  class ::Hash
+
+    # this method merges a YAML-serialized hash-instance
+    # with self. if the given File is not exisiting this will write
+    # a serialized version of self to this file.
+    #
+    # if the given yaml file does not contain a serialized hash than it
+    # merges with an empty hash that returns self unchanged.
+    #
+    # returns a new Hash merged with deserialized version from the file
+    def merge_with_serialized(yaml_file)
+
+      unless File.file? yaml_file
+        File.open(yaml_file, 'w') {|f| f.write(self.to_yaml) }
+      end
+
+      persistent_config = YAML.load(File.new(yaml_file, "rb").read)
+      persistent_config = Hash.new unless persistent_config.is_a? Hash
+
+      config = self.merge(persistent_config)
+      File.open(yaml_file, 'w') {|f| f.write(config.to_yaml) }
+
+      return config
+    end
+  end
+
+end

data/spec/hashconfig_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'yaml'
+
+require File.dirname(__FILE__) + '/../lib/hashconfig'
+
+TEST_DATA = {
+  :first  => "first parameter",
+  :second => "second parameter",
+  :third  => "third parameter"
+}
+
+TEST_DIR                 = File.join( File.dirname(__FILE__), "testfiles")
+TEST_CONFIG_FILE         = File.join(TEST_DIR, "config.yml")
+TEST_EMPTY_CONFIG_FILE   = File.join(TEST_DIR, "empty.yml")
+TEST_INVALID_CONFIG_FILE = File.join(TEST_DIR, "invalid.yml")
+TEST_NOT_EXISTING        = File.join(TEST_DIR, "not_exisiting.yml")
+
+
+describe Hashconfig do
+
+  before(:all) do
+
+    @modified = TEST_DATA.merge({:third => "modified third parameter"})
+
+    FileUtils.mkdir(TEST_DIR) unless File.directory? TEST_DIR
+    File.open(TEST_CONFIG_FILE, 'w') {|f| f.write(@modified.to_yaml) }
+    File.open(TEST_EMPTY_CONFIG_FILE, 'w') {|f| f.write(Hash.new.to_yaml) }
+    File.open(TEST_EMPTY_CONFIG_FILE, 'w') {|f| f.write("invalid") }
+
+  end
+
+  after(:all) do
+    FileUtils.remove_dir(TEST_DIR) if File.directory? TEST_DIR
+  end
+
+  it "should add a method to the Ruby Hash class" do
+    Hash.new.respond_to?(:merge_with_serialized).should be_true
+  end
+
+  it "should return an updated hash when yaml file is valid" do
+    config = TEST_DATA.merge_with_serialized(TEST_CONFIG_FILE)
+    config[:third].should eq "modified third parameter"
+  end
+
+  it "should return original hash when yaml file is empty" do
+    config = TEST_DATA.merge_with_serialized(TEST_EMPTY_CONFIG_FILE)
+    config[:third].should eq "third parameter"
+  end
+
+  it "should return original hash when yaml file is invalid" do
+    config = TEST_DATA.merge_with_serialized(TEST_INVALID_CONFIG_FILE)
+    config[:third].should eq "third parameter"
+  end
+
+  it "should return original hash when yaml file is not exisiting" do
+    config = TEST_DATA.merge_with_serialized(TEST_INVALID_CONFIG_FILE)
+    config[:third].should eq "third parameter"
+  end
+
+  it "should update the yaml when it is merged with a different hash" do
+    updated = TEST_DATA.merge({:fourth => "parameter number 4"})
+    config = updated.merge_with_serialized(TEST_CONFIG_FILE)
+    config[:fourth].should eq "parameter number 4"
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'fileutils'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: hashconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philipp Böhm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-23 00:00:00.000000000 Z
+dependencies: []
+description: Simple configuration mechanism through serialized hash
+email:
+- philipp@i77i.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hashconfig.gemspec
+- lib/hashconfig.rb
+- lib/hashconfig/version.rb
+- spec/hashconfig_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pboehm/hashconfig
+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.19
+signing_key: 
+specification_version: 3
+summary: Simple configuration mechanism through serialized hash
+test_files:
+- spec/hashconfig_spec.rb
+- spec/spec_helper.rb