rails_config_i18n 0.3.1.1

data/lib/rails_config/vendor/deep_merge.rb

@@ -0,0 +1,180 @@
+module DeepMerge
+  class InvalidParameter < StandardError; end
+
+  DEFAULT_FIELD_KNOCKOUT_PREFIX = '--'
+
+  # Deep Merge core documentation.
+  # deep_merge! method permits merging of arbitrary child elements. The two top level
+  # elements must be hashes. These hashes can contain unlimited (to stack limit) levels
+  # of child elements. These child elements to not have to be of the same types.
+  # Where child elements are of the same type, deep_merge will attempt to merge them together.
+  # Where child elements are not of the same type, deep_merge will skip or optionally overwrite
+  # the destination element with the contents of the source element at that level.
+  # So if you have two hashes like this:
+  #   source = {:x => [1,2,3], :y => 2}
+  #   dest =   {:x => [4,5,'6'], :y => [7,8,9]}
+  #   dest.deep_merge!(source)
+  #   Results: {:x => [1,2,3,4,5,'6'], :y => 2}
+  # By default, "deep_merge!" will overwrite any unmergeables and merge everything else.
+  # To avoid this, use "deep_merge" (no bang/exclamation mark)
+  #
+  # Options:
+  #   Options are specified in the last parameter passed, which should be in hash format:
+  #   hash.deep_merge!({:x => [1,2]}, {:knockout_prefix => '--'})
+  #   :preserve_unmergeables  DEFAULT: false
+  #      Set to true to skip any unmergeable elements from source
+  #   :knockout_prefix        DEFAULT: nil
+  #      Set to string value to signify prefix which deletes elements from existing element
+  #   :sort_merged_arrays     DEFAULT: false
+  #      Set to true to sort all arrays that are merged together
+  #   :unpack_arrays          DEFAULT: nil
+  #      Set to string value to run "Array::join" then "String::split" against all arrays
+  #   :merge_debug            DEFAULT: false
+  #      Set to true to get console output of merge process for debugging
+  #
+  # Selected Options Details:
+  # :knockout_prefix => The purpose of this is to provide a way to remove elements
+  #   from existing Hash by specifying them in a special way in incoming hash
+  #    source = {:x => ['--1', '2']}
+  #    dest   = {:x => ['1', '3']}
+  #    dest.ko_deep_merge!(source)
+  #    Results: {:x => ['2','3']}
+  #   Additionally, if the knockout_prefix is passed alone as a string, it will cause
+  #   the entire element to be removed:
+  #    source = {:x => '--'}
+  #    dest   = {:x => [1,2,3]}
+  #    dest.ko_deep_merge!(source)
+  #    Results: {:x => ""}
+  # :unpack_arrays => The purpose of this is to permit compound elements to be passed
+  #   in as strings and to be converted into discrete array elements
+  #   irsource = {:x => ['1,2,3', '4']}
+  #   dest   = {:x => ['5','6','7,8']}
+  #   dest.deep_merge!(source, {:unpack_arrays => ','})
+  #   Results: {:x => ['1','2','3','4','5','6','7','8'}
+  #   Why: If receiving data from an HTML form, this makes it easy for a checkbox
+  #    to pass multiple values from within a single HTML element
+  #
+  # There are many tests for this library - and you can learn more about the features
+  # and usages of deep_merge! by just browsing the test examples
+  def DeepMerge.deep_merge!(source, dest, options = {})
+    # turn on this line for stdout debugging text
+    merge_debug = options[:merge_debug] || false
+    overwrite_unmergeable = !options[:preserve_unmergeables]
+    knockout_prefix = options[:knockout_prefix] || nil
+    if knockout_prefix == ""; raise InvalidParameter, "knockout_prefix cannot be an empty string in deep_merge!"; end
+    if knockout_prefix && !overwrite_unmergeable; raise InvalidParameter, "overwrite_unmergeable must be true if knockout_prefix is specified in deep_merge!"; end
+    # if present: we will split and join arrays on this char before merging
+    array_split_char = options[:unpack_arrays] || false
+    # request that we sort together any arrays when they are merged
+    sort_merged_arrays = options[:sort_merged_arrays] || false
+    di = options[:debug_indent] || ''
+    # do nothing if source is nil
+    if source.nil? || (!source.is_a?(FalseClass) && source.respond_to?(:blank?) && source.blank?); return dest; end
+    # if dest doesn't exist, then simply copy source to it
+    if dest.nil? && overwrite_unmergeable; dest = source; return dest; end
+
+    puts "#{di}Source class: #{source.class.inspect} :: Dest class: #{dest.class.inspect}" if merge_debug
+    if source.kind_of?(Hash)
+      puts "#{di}Hashes: #{source.inspect} :: #{dest.inspect}" if merge_debug
+      source.each do |src_key, src_value|
+        if dest.kind_of?(Hash)
+          puts "#{di} looping: #{src_key.inspect} => #{src_value.inspect} :: #{dest.inspect}" if merge_debug
+          if !dest[src_key].nil?
+            puts "#{di} ==>merging: #{src_key.inspect} => #{src_value.inspect} :: #{dest[src_key].inspect}" if merge_debug
+            dest[src_key] = deep_merge!(src_value, dest[src_key], options.merge(:debug_indent => di + '  '))
+          else # dest[src_key] doesn't exist so we want to create and overwrite it (but we do this via deep_merge!)
+            puts "#{di} ==>merging over: #{src_key.inspect} => #{src_value.inspect}" if merge_debug
+            # note: we rescue here b/c some classes respond to "dup" but don't implement it (Numeric, TrueClass, FalseClass, NilClass among maybe others)
+            begin
+              src_dup = src_value.dup # we dup src_value if possible because we're going to merge into it (since dest is empty)
+            rescue TypeError
+              src_dup = src_value
+            end
+            dest[src_key] = deep_merge!(src_value, src_dup, options.merge(:debug_indent => di + '  '))
+          end
+        else # dest isn't a hash, so we overwrite it completely (if permitted)
+          if overwrite_unmergeable
+            puts "#{di}  overwriting dest: #{src_key.inspect} => #{src_value.inspect} -over->  #{dest.inspect}" if merge_debug
+            dest = overwrite_unmergeables(source, dest, options)
+          end
+        end
+      end
+    elsif source.kind_of?(Array)
+      puts "#{di}Arrays: #{source.inspect} :: #{dest.inspect}" if merge_debug
+      # if we are instructed, join/split any source arrays before processing
+      if array_split_char
+        puts "#{di} split/join on source: #{source.inspect}" if merge_debug
+        source = source.join(array_split_char).split(array_split_char)
+        if dest.kind_of?(Array); dest = dest.join(array_split_char).split(array_split_char); end
+      end
+      # if there's a naked knockout_prefix in source, that means we are to truncate dest
+      if source.index(knockout_prefix); dest = clear_or_nil(dest); source.delete(knockout_prefix); end
+      if dest.kind_of?(Array)
+        if knockout_prefix
+          print "#{di} knocking out: " if merge_debug
+          # remove knockout prefix items from both source and dest
+          source.delete_if do |ko_item|
+            retval = false
+            item = ko_item.respond_to?(:gsub) ? ko_item.gsub(%r{^#{knockout_prefix}}, "") : ko_item
+            if item != ko_item
+              print "#{ko_item} - " if merge_debug
+              dest.delete(item)
+              dest.delete(ko_item)
+              retval = true
+            end
+            retval
+          end
+          puts if merge_debug
+        end
+        puts "#{di} merging arrays: #{source.inspect} :: #{dest.inspect}" if merge_debug
+        dest = dest | source
+        if sort_merged_arrays; dest.sort!; end
+      elsif overwrite_unmergeable
+        puts "#{di} overwriting dest: #{source.inspect} -over-> #{dest.inspect}" if merge_debug
+        dest = overwrite_unmergeables(source, dest, options)
+      end
+    else # src_hash is not an array or hash, so we'll have to overwrite dest
+      puts "#{di}Others: #{source.inspect} :: #{dest.inspect}" if merge_debug
+      dest = overwrite_unmergeables(source, dest, options)
+    end
+    puts "#{di}Returning #{dest.inspect}" if merge_debug
+    dest
+  end # deep_merge!
+
+  # allows deep_merge! to uniformly handle overwriting of unmergeable entities
+  def DeepMerge::overwrite_unmergeables(source, dest, options)
+    merge_debug = options[:merge_debug] || false
+    overwrite_unmergeable = !options[:preserve_unmergeables]
+    knockout_prefix = options[:knockout_prefix] || false
+    di = options[:debug_indent] || ''
+    if knockout_prefix && overwrite_unmergeable
+      if source.kind_of?(String) # remove knockout string from source before overwriting dest
+        src_tmp = source.gsub(%r{^#{knockout_prefix}},"")
+      elsif source.kind_of?(Array) # remove all knockout elements before overwriting dest
+        src_tmp = source.delete_if {|ko_item| ko_item.kind_of?(String) && ko_item.match(%r{^#{knockout_prefix}}) }
+      else
+        src_tmp = source
+      end
+      if src_tmp == source # if we didn't find a knockout_prefix then we just overwrite dest
+        puts "#{di}#{src_tmp.inspect} -over-> #{dest.inspect}" if merge_debug
+        dest = src_tmp
+      else # if we do find a knockout_prefix, then we just delete dest
+        puts "#{di}\"\" -over-> #{dest.inspect}" if merge_debug
+        dest = ""
+      end
+    elsif overwrite_unmergeable
+      dest = source
+    end
+    dest
+  end
+
+  def DeepMerge::clear_or_nil(obj)
+    if obj.respond_to?(:clear)
+      obj.clear
+    else
+      obj = nil
+    end
+    obj
+  end
+
+end # module DeepMerge

data/lib/rails_config/version.rb

@@ -0,0 +1,3 @@
+module RailsConfig
+  VERSION = '0.3.1.1'
+end

data/lib/rails_config_i18n.rb

@@ -0,0 +1 @@
+require 'rails_config/rails_config'

data/rails_config.gemspec

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + "/lib/rails_config/version"
+
+Gem::Specification.new do |s|
+  s.name             = "rails_config_i18n"
+  s.version          = RailsConfig::VERSION
+  s.date             = Date.today.to_s
+  s.authors          = ["Jacques Crocker", "Fred Wu", "Cedric Fung"]
+  s.email            = ["railsjedi@gmail.com", "ifredwu@gmail.com", "wolfplanet@gmail.com"]
+  s.summary          = "Provides a Settings helper for rails3 that reads from config/settings(.locale).yml"
+  s.description      = "Easy to use Settings helper that loads its data in from config/settings.yml. Handles adding multiple sources, multiple locales, and easy reloading."
+  s.homepage         = "http://github.com/abitno/rails_config_i18n"
+  s.extra_rdoc_files = ["README.md"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_paths    = ["lib"]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_runtime_dependency "activesupport", ">= 3.0"
+  s.add_runtime_dependency "i18n", ">= 0.6"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "autotest", ">= 0"
+  s.add_development_dependency "growl-glue", ">= 0"
+end
+

data/spec/fixtures/bool_override/config1.yml

@@ -0,0 +1,2 @@
+override_bool: true
+override_bool_opposite: false

data/spec/fixtures/bool_override/config2.yml

@@ -0,0 +1,2 @@
+override_bool: false
+override_bool_opposite: true

data/spec/fixtures/custom_types/hash.yml

@@ -0,0 +1,7 @@
+prices:
+  type: hash
+  contents:
+    1: 2.99
+    5: 9.99
+    15: 19.99
+    30: 29.99

data/spec/fixtures/deep_merge/config1.yml

@@ -0,0 +1,28 @@
+size: 1
+server: google.com
+inner:
+  something1: "blah1"
+  something2: "blah2"
+
+inner2:
+  inner2_inner:
+    foo1: "blah1"
+
+
+arraylist1:
+  - 1
+  - 2
+  - 3
+  
+arraylist2:
+  inner:
+    - 1
+    - 2
+    - 3
+
+hash_array:
+  - 1
+  - inner:
+    - 1
+    - 2
+    - 3

data/spec/fixtures/deep_merge/config2.yml

@@ -0,0 +1,28 @@
+server: google.com
+
+inner:
+  something3: "blah3"
+
+inner2:
+  inner2_inner:
+    foo2: "blah2"
+    foo3: "blah3"
+    
+arraylist1:
+  - 4
+  - 5
+  - 6
+
+
+arraylist2:
+  inner:
+    - 4
+    - 5
+    - 6
+
+hash_array:
+  - 2
+  - inner:
+    - 4
+    - 5
+    - 6

data/spec/fixtures/deep_merge2/config1.yml

@@ -0,0 +1,3 @@
+tvrage:
+  service_url: 'http://services.tvrage.com'
+  cache: 500

data/spec/fixtures/deep_merge2/config2.yml

@@ -0,0 +1,2 @@
+tvrage:
+  service_url: "http://url2"

data/spec/fixtures/development.yml

@@ -0,0 +1,4 @@
+size: 2
+section:
+  size: 3
+  servers: [ {name: yahoo.com}, {name: amazon.com} ]

data/spec/fixtures/locales/settings.en.yml

@@ -0,0 +1,3 @@
+en:
+  language: 'English'
+  fallback_locale: 'Fallback locale'

data/spec/fixtures/locales/settings.zh-CN.yml

@@ -0,0 +1,2 @@
+zh-CN:
+  language: '中文'

data/spec/fixtures/settings.yml

@@ -0,0 +1,3 @@
+size: 1
+server: google.com
+1: "one"

data/spec/fixtures/settings2.yml

@@ -0,0 +1 @@
+another: "something"

data/spec/fixtures/with_erb.yml

@@ -0,0 +1,4 @@
+computed: <%= 1 + 2 + 3 %>
+section:
+  computed1: <%= "1" %>
+  computed2: <%= "2" %>

data/spec/rails_config_spec.rb

@@ -0,0 +1,235 @@
+# encoding: UTF-8
+
+require 'i18n'
+require 'spec_helper'
+
+describe RailsConfig do
+
+  it "should load a basic config file" do
+    config = RailsConfig.load_files(setting_path("settings.yml"))
+    config.size.should eq 1
+    config.server.should eq "google.com"
+  end
+
+  it "should load 2 basic config files" do
+    config = RailsConfig.load_files(setting_path("settings.yml"), setting_path("settings2.yml"))
+    config.size.should eq 1
+    config.server.should eq "google.com"
+    config.another.should eq "something"
+  end
+
+  it "should load empty config for a missing file path" do
+    config = RailsConfig.load_files(setting_path("some_file_that_doesnt_exist.yml"))
+    config.should be_empty
+  end
+
+  it "should load an empty config for multiple missing file paths" do
+    files = [setting_path("doesnt_exist1.yml"), setting_path("doesnt_exist2.yml")]
+    config = RailsConfig.load_files(files)
+    config.should be_empty
+  end
+
+  it "should load empty config for an empty setting file" do
+    config = RailsConfig.load_files(setting_path("empty1.yml"))
+    config.should be_empty
+  end
+
+  it "should convert to a hash" do
+    config = RailsConfig.load_files(setting_path("development.yml")).to_hash
+    config[:section][:servers].should be_a_kind_of(Array)
+  end
+
+  it "should convert to a json" do
+    config = RailsConfig.load_files(setting_path("development.yml")).to_json
+    JSON.parse(config)["section"]["servers"].should be_a_kind_of(Array)
+  end
+
+  it "should load an empty config for multiple missing file paths" do
+    files = [setting_path("empty1.yml"), setting_path("empty2.yml")]
+    config = RailsConfig.load_files(files)
+    config.should be_empty
+  end
+
+  it "should allow overrides" do
+    files = [setting_path("settings.yml"), setting_path("development.yml")]
+    config = RailsConfig.load_files(files)
+    config.server.should eq "google.com"
+    config.size.should eq 2
+  end
+
+  #it "should allow full reload of the settings files" do
+    #files = [setting_path("settings.yml")]
+    #RailsConfig.load_and_set_settings(files)
+    #Settings.server.should eq "google.com"
+    #Settings.size.should eq 1
+
+    #files = [setting_path("settings.yml"), setting_path("development.yml")]
+    #Settings.reload_from_files(files)
+    #Settings.server.should eq "google.com"
+    #Settings.size.should eq 2
+  #end
+
+  context "Nested Settings" do
+    let(:config) do
+      RailsConfig.load_files(setting_path("development.yml"))
+    end
+
+    it "should allow nested sections" do
+      config.section.size.should eq 3
+    end
+
+    it "should allow configuration collections (arrays)" do
+      config.section.servers[0].name.should eq "yahoo.com"
+      config.section.servers[1].name.should eq "amazon.com"
+    end
+  end
+
+  context "Settings with ERB tags" do
+    let(:config) do
+      RailsConfig.load_files(setting_path("with_erb.yml"))
+    end
+
+    it "should evaluate ERB tags" do
+      config.computed.should eq 6
+    end
+
+    it "should evaluated nested ERB tags" do
+      config.section.computed1.should eq 1
+      config.section.computed2.should eq 2
+    end
+  end
+
+  context "Deep Merging" do
+    let(:config) do
+      files = [setting_path("deep_merge/config1.yml"), setting_path("deep_merge/config2.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should merge hashes from multiple configs" do
+      config.inner.marshal_dump.keys.size.should eq 3
+      config.inner2.inner2_inner.marshal_dump.keys.size.should eq 3
+    end
+
+    it "should merge arrays from multiple configs" do
+      config.arraylist1.size.should eq 6
+      config.arraylist2.inner.size.should eq 6
+    end
+  end
+
+  context "Boolean Overrides" do
+    let(:config) do
+      files = [setting_path("bool_override/config1.yml"), setting_path("bool_override/config2.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should allow overriding of bool settings" do
+      config.override_bool.should eq false
+      config.override_bool_opposite.should eq true
+    end
+  end
+
+  context "Custom Configuration" do
+    it "should have the default settings constant as 'Settings'" do
+      RailsConfig.const_name.should eq "Settings"
+    end
+
+    it "should be able to assign a different settings constant" do
+      RailsConfig.setup{ |config| config.const_name = "Settings2" }
+      RailsConfig.const_name.should eq "Settings2"
+    end
+  end
+
+  context "Settings with a type value of 'hash'" do
+    let(:config) do
+      files = [setting_path("custom_types/hash.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should turn that setting into a Real Hash" do
+      config.prices.should be_a(Hash)
+    end
+
+    it "should map the hash values correctly" do
+      config.prices[1].should eq 2.99
+      config.prices[5].should eq 9.99
+      config.prices[15].should eq 19.99
+      config.prices[30].should eq 29.99
+    end
+  end
+
+  context "Merging hash at runtime" do
+    let(:config) { RailsConfig.load_files(setting_path("settings.yml")) }
+    let(:hash) { {:options => {:suboption => 'value'}, :server => 'amazon.com'} }
+
+    it 'should be chainable' do
+      config.merge!({}).should eq config
+    end
+
+    it 'should preserve existing keys' do
+      expect { config.merge!({}) }.to_not change{ config.keys }
+    end
+
+    it 'should recursively merge keys' do
+      config.merge!(hash)
+      config.options.suboption.should eq 'value'
+    end
+
+    it 'should rewrite a merged value' do
+      expect { config.merge!(hash) }.to change{ config.server }.from('google.com').to('amazon.com')
+    end
+  end
+
+  context "Merging nested hash at runtime" do
+    let(:config) { RailsConfig.load_files(setting_path("deep_merge/config1.yml")) }
+    let(:hash) { {:inner => {:something1 => 'changed1', :something3 => 'changed3'} } }
+
+    it 'should preserve first level keys' do
+      expect { config.merge!(hash) }.to_not change{ config.keys }
+    end
+
+    it 'should preserve nested key' do
+      config.merge!(hash)
+      config.inner.something2.should eq 'blah2'
+    end
+
+    it 'should add new nested key' do
+      expect { config.merge!(hash) }.to change { config.inner.something3 }.from(nil).to("changed3")
+    end
+
+    it 'should rewrite a merged value' do
+      expect { config.merge!(hash) }.to change{ config.inner.something1 }.from('blah1').to('changed1')
+    end
+  end
+
+  context "[] accessors" do
+    let(:config) do
+      files = [setting_path("development.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should access attributes using []" do
+      config.section['size'].should eq 3
+      config.section[:size].should eq 3
+      config[:section][:size].should eq 3
+    end
+
+    it "should set values using []=" do
+      config.section[:foo] = 'bar'
+      config.section.foo.should eq 'bar'
+    end
+  end
+
+  context "I18n locales" do
+    it "should output language" do
+      files = [setting_path("locales/settings.en.yml"), setting_path("locales/settings.zh-CN.yml")]
+      RailsConfig.load_and_set_settings(files)
+
+      I18n.locale = 'en'
+      RailsConfig.language.should eq 'English'
+
+      I18n.locale = 'zh-CN'
+      RailsConfig.language.should eq '中文'
+      RailsConfig.fallback_locale.should eq 'Fallback locale'
+    end
+  end
+end

data/spec/sources/yaml_source_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module RailsConfig::Sources
+  describe YAMLSource do
+
+    it "should take a path as initializer" do
+      source = YAMLSource.new "somepath"
+      source.path.should == "somepath"
+    end
+
+    context "basic yml file" do
+      let(:source) do
+        YAMLSource.new setting_path("development.yml")
+      end
+
+      it "should properly read the settings" do
+        results = source.load
+        results["size"].should == 2
+      end
+
+      it "should properly read nested settings" do
+        results = source.load
+        results["section"]["size"].should == 3
+        results["section"]["servers"].should be_an(Array)
+        results["section"]["servers"].size.should == 2
+      end
+    end
+
+    context "yml file with erb tags" do
+      let(:source) do
+        YAMLSource.new setting_path("with_erb.yml")
+      end
+
+      it "should properly evaluate the erb" do
+        results = source.load
+        results["computed"].should == 6
+      end
+
+      it "should properly evaluate the nested erb settings" do
+        results = source.load
+        results["section"]["computed1"].should == 1
+        results["section"]["computed2"].should == 2
+      end
+    end
+
+    context "missing yml file" do
+      let(:source) do
+        YAMLSource.new "somewhere_that_doesnt_exist.yml"
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        results.should == {}
+      end
+    end
+
+    context "blank yml file" do
+      let(:source) do
+        YAMLSource.new setting_path("empty1.yml")
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        results.should == {}
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rails_config_i18n'
+require 'pathname'
+require 'bundler/setup'
+
+def in_editor?
+  ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM')
+end
+
+RSpec.configure do |c|
+  c.color_enabled = !in_editor?
+  c.run_all_when_everything_filtered = true
+
+  # setup fixtures path
+  c.before(:all) do
+    @fixture_path = Pathname.new(File.join(File.dirname(__FILE__), "/fixtures"))
+    raise "Fixture folder not found: #{@fixture_path}" unless @fixture_path.directory?
+  end
+
+  # returns the file path of a fixture setting file
+  def setting_path(filename)
+    @fixture_path.join(filename)
+  end
+
+end
+