shutl_yaml_properties 0.0.13

data/lib/yaml_properties/diff.rb

@@ -0,0 +1,40 @@
+require 'active_support/core_ext/hash'
+
+class YamlProperties::Diff
+  def initialize a, b
+    @hash_a, @hash_b = read(a, b)
+    unless same?
+      raise ArgumentError.new(error_message)
+    end
+  end
+
+  private
+
+  def error_message
+    "Following keys are not present in both files '#{key_diff}'"
+  end
+
+  def key_diff
+    (keys_a - keys_b) + (keys_b - keys_a)
+  end
+
+  def keys_a
+    @hash_a.keys
+  end
+
+  def keys_b
+    @hash_b.keys
+  end
+
+  def same?
+    key_diff.empty?
+  end
+
+  def read *files
+    files.map do |f|
+      YAML.load File.read(f)
+    end
+  end
+
+end
+

data/lib/yaml_properties/version.rb

@@ -0,0 +1,3 @@
+module YamlProperties
+  VERSION = "0.0.13"
+end

data/lib/yaml_properties.rb

@@ -0,0 +1,54 @@
+require "yaml_properties/version"
+require "active_support/core_ext/hash"
+require "yaml"
+require "erb"
+
+module YamlProperties
+  def properties
+    reset! if dev_environment
+
+    @properties ||= load_properties.with_indifferent_access
+  end
+
+  attr_accessor :dev_environment
+
+  def reset!
+    reset_properties
+  end
+
+  def reset_properties
+    @properties = nil
+  end
+
+  def method_missing(key, *args, &block)
+    return properties[key] if key_present? key
+
+    super key, *args, &block
+  end
+
+
+  def override_attribute attribute, value
+    unless key_present? attribute
+      raise ArgumentError, "Trying to override non-existent property `#{attribute}' with `#{value}'"
+    end
+    properties[attribute] = value
+  end
+
+  private
+
+  def key_present? key
+    properties.keys.include? key.to_s
+  end
+
+  def yaml_file
+    File.join %w(config properties.yml)
+  end
+
+  def load_properties
+    yaml = YAML.load ERB.new(File.read(yaml_file)).result
+
+    yaml
+  end
+
+  extend self
+end

data/spec/diff_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../../lib/yaml_properties/diff.rb', __FILE__)
+
+describe YamlProperties::Diff do
+  def f file
+    File.expand_path("../fixtures/#{file}.yml", __FILE__)
+  end
+
+  it "raises an exception if two YAML files have different keys" do
+    -> {YamlProperties::Diff.new f('file1'), f('file2')}.should raise_error
+  end
+
+  it "doesn't raise an exception if two YAML files have same keys" do
+    -> {YamlProperties::Diff.new f('file1'), f('file4') }.should_not raise_error
+  end
+
+  it "raises a argument error if two YAML files have present vs. non-present keys" do
+    argument_error = "Following keys are not present in both files '[\"d\"]'"
+
+    -> {YamlProperties::Diff.new f('file2'),f('file3')}.should(
+      raise_error(ArgumentError, argument_error))
+  end
+end
+

data/spec/fixtures/erb.yml

@@ -0,0 +1 @@
+life_the_universe_and_everything: <%= ENV['mistery_message'] %>

data/spec/fixtures/file1.yml

@@ -0,0 +1,3 @@
+a: 1
+b: 2
+c: 3

data/spec/fixtures/file2.yml

@@ -0,0 +1,4 @@
+a: 1
+b: 2
+c: 3
+d: 4

data/spec/fixtures/file3.yml

@@ -0,0 +1,3 @@
+a: 1
+b: 2
+c: 3

data/spec/fixtures/file4.yml

@@ -0,0 +1,3 @@
+a: 1
+b: 2
+c: 3

data/spec/fixtures/test.yml

@@ -0,0 +1 @@
+life_the_universe_and_everything: "Nobody knows"

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/yaml_config_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path('spec/spec_helper')
+require './lib/yaml_properties'
+
+describe YamlProperties do
+  context "in general" do
+    before do
+      File.stub(:open)
+      YamlProperties.dev_environment = false
+
+      Psych.stub(:load).and_return properties
+    end
+
+    let(:properties) do
+      {
+        "life_the_universe_and_everything" => 42,
+        "some_string_value"                => "something",
+        "a boolean"                        => true,
+        "parent"                           => {
+          "child"=>"Egg"}
+      }
+    end
+
+    context "in non dev" do
+      before do
+        YamlProperties.dev_environment = false
+        YamlProperties.reset!
+      end
+
+      specify "it caches yaml file" do
+        YamlProperties.should_receive(:load_properties).
+          exactly(1).times.and_return properties
+
+        YamlProperties.some_string_value
+        YamlProperties.some_string_value
+      end
+    end
+
+    context "in dev environment" do
+      before do
+        YamlProperties.dev_environment = true
+        YamlProperties.reset!
+      end
+
+
+      specify "reload so Rails/Sinatra don't need restarting" do
+        YamlProperties.should_receive(:load_properties).at_least(2).times.and_return properties
+        YamlProperties.some_string_value
+        YamlProperties.some_string_value
+
+      end
+    end
+
+    specify "overriding attributes (in e.g. tests)" do
+      YamlProperties.override_attribute :life_the_universe_and_everything, 13
+      YamlProperties.life_the_universe_and_everything.should == 13
+      YamlProperties.reset!
+      YamlProperties.life_the_universe_and_everything.should == 42
+    end
+
+    specify "non-existent attribute overrides shouldn't work" do
+      ->{
+        YamlProperties.override_attribute :unset_attribute,
+        "let's not allow typos to cause us grief"}.
+        should raise_error ArgumentError
+    end
+
+    specify do
+      YamlProperties.properties.should == properties
+    end
+    specify do
+      YamlProperties.life_the_universe_and_everything.should == 42
+    end
+
+    specify do
+      YamlProperties.some_string_value.should == "something"
+    end
+
+    specify do
+      YamlProperties.send("a boolean").should == true
+    end
+
+    specify do
+      YamlProperties.parent.should == {"child" => "Egg"}
+    end
+
+    context "extending a module" do
+      module Acme
+        extend YamlProperties
+      end
+
+      specify do
+        Acme.life_the_universe_and_everything.should == 42
+      end
+    end
+  end
+
+  context "overriding yaml_file default" do
+    module Mystery
+      extend YamlProperties
+
+      def self.yaml_file
+        "./spec/fixtures/test.yml"
+      end
+    end
+
+    specify do
+      Mystery.life_the_universe_and_everything.should == "Nobody knows"
+    end
+  end
+
+  context "with erb" do
+    module ErbMystery
+      extend YamlProperties
+
+      def self.yaml_file
+        "./spec/fixtures/erb.yml"
+      end
+    end
+
+    before { ENV['mistery_message'] = "Everybody knows" }
+    after  { ENV.delete 'mistery_message' }
+
+    specify do
+      ErbMystery.life_the_universe_and_everything.should == "Everybody knows"
+    end
+  end
+end

data/yaml_properties.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_properties/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "shutl_yaml_properties"
+  gem.version       = YamlProperties::VERSION
+  gem.authors       = ["Mark Burns", "David Rouchy"]
+  gem.email         = ["markthedeveloper@gmail.com", "davidr@shutl.com"]
+  gem.description   = %q{Easily add configurable variables for app config using YAML files}
+  gem.executables << 'yaml_diff'
+
+  gem.summary       = <<-DESCRIPTION.gsub(/^\s{4}/, '')
+    Example:
+
+      YamlProperties.life_the_universe_and_everything
+      #=> 42
+
+    In config/properties.yml
+
+      life_the_universe_and_everything: 42
+  DESCRIPTION
+
+  gem.homepage      = ""
+
+  gem.add_dependency  'activesupport'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'debugger', '~> 1.4.0'
+
+  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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: shutl_yaml_properties
+version: !ruby/object:Gem::Version
+  version: 0.0.13
+  prerelease: 
+platform: ruby
+authors:
+- Mark Burns
+- David Rouchy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Easily add configurable variables for app config using YAML files
+email:
+- markthedeveloper@gmail.com
+- davidr@shutl.com
+executables:
+- yaml_diff
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/yaml_diff
+- config/license_finder.yml
+- config/properties.yml
+- doc/dependencies.csv
+- doc/dependencies.db
+- doc/dependencies.html
+- lib/yaml_properties.rb
+- lib/yaml_properties/diff.rb
+- lib/yaml_properties/version.rb
+- spec/diff_spec.rb
+- spec/fixtures/erb.yml
+- spec/fixtures/file1.yml
+- spec/fixtures/file2.yml
+- spec/fixtures/file3.yml
+- spec/fixtures/file4.yml
+- spec/fixtures/test.yml
+- spec/spec_helper.rb
+- spec/yaml_config_spec.rb
+- yaml_properties.gemspec
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 2433610047750443937
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2433610047750443937
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Example: YamlProperties.life_the_universe_and_everything #=> 42 In config/properties.yml
+  life_the_universe_and_everything: 42'
+test_files:
+- spec/diff_spec.rb
+- spec/fixtures/erb.yml
+- spec/fixtures/file1.yml
+- spec/fixtures/file2.yml
+- spec/fixtures/file3.yml
+- spec/fixtures/file4.yml
+- spec/fixtures/test.yml
+- spec/spec_helper.rb
+- spec/yaml_config_spec.rb