easy_settings 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b576c4cc8f7df5949f577776925dd2cf736f25b9
-  data.tar.gz: f752df3e59269a8fc30ab5461452d236ecc0537a
+  metadata.gz: 2085b197801aa7b23546218a9a2cd4d187c0997b
+  data.tar.gz: f017d3d8cfcac1ad5e3acd50e3420445058b2ea5
 SHA512:
-  metadata.gz: a07f2b0934754767fea381bc86e9ee33e75be14395cf87ed1fa98bde1931f0cbfa3000ea3910f0c19512e3f66737537cd7c152251efaf804580b9278f8b27b4d
-  data.tar.gz: aef00e04a6612a1055ef9c494fe1b49a04a1c24a2a90288f183271545c3277c29ccf404d69ea659a0cd8373ea89939d61b0f2b939a7ed1cea14aefa50a954052
+  metadata.gz: 235f5f02e84ccc6ac2be90c03e5bafb55035040122feaed01fe4c25857c81dc037ca4adeff405ac4566829694de51d6b8cbf93cdff16c7269685d46d4e9f58a7
+  data.tar.gz: 8af02731d7090dd8b535a84008057e4f4a5a39371dc1ff9cc8b0ac608cc1115beb4aa351df9e039559ef23441ea4e44a3ef145a8cd8c3fd2891d9785ac2e24d6

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 

data/easy_settings.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "pry"
 end

data/lib/easy_settings.rb

@@ -51,7 +51,7 @@ class EasySettings < Hashie::Mash
 
     def _source_from_file
       unless FileTest.exist?(source_file)
-        raise(SourceFileNotExist, "Your source file '#{file}' does not exist.")
+        raise(SourceFileNotExist, "Your source file '#{source_file}' does not exist.")
       end
       _load_file(source_file)
     end

data/lib/easy_settings_version.rb

@@ -1,3 +1,3 @@
 module EasySettingsVersion
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/easy_settings_spec.rb

@@ -0,0 +1,263 @@
+shared_examples_for "EasySettings" do |proc|
+  let(:settings, &proc)
+
+  it "can access by dot" do
+    expect(settings.app_name).to eq app_name
+  end
+
+  it "can access by [Srting]" do
+    expect(settings["app_name"]).to eq app_name
+  end
+
+  it "can access by [Symbol]" do
+    expect(settings[:app_name]).to eq app_name
+  end
+
+  it "can access nested hash by dot" do
+    expect(settings.admins.admin1.password).to eq "PassWord1"
+  end
+
+  it "can access nested hash by []" do
+    expect(settings[:admins][:admin1][:password]).to eq "PassWord1"
+  end
+
+  it "return nil when access key that doesn't exist by dot" do
+    expect(settings.admins.admin3).to be_nil
+  end
+
+  it "return nil when access key that doesn't exist by []" do
+    expect(settings[:admins][:admin3]).to be_nil
+  end
+
+  it "can be set value by dot" do
+    settings.foo = :bar
+    expect(settings.foo).to eq :bar
+
+    admin3 = {"password" => "PassWord3", "role" => "administrator"}
+    settings.admins.admin3 = admin3
+    expect(settings.admins.admin3.to_h).to eq admin3
+  end
+
+  it "can be set value by []" do
+    settings[:foo] = :bar
+    expect(settings.foo).to eq :bar
+
+    admin3 = {"password" => "PassWord3", "role" => "administrator"}
+    settings[:admins][:admin3] = admin3
+    expect(settings.admins.admin3.to_h).to eq admin3
+  end
+
+  it "can be rewrited by dot" do
+    settings.app_name = "hoge"
+    expect(settings.app_name).to eq "hoge"
+
+    password = "PASSWORD"
+    settings.admins.admin1 = password
+    expect(settings.admins.admin1).to eq password
+  end
+
+  it "can be rewrited by []" do
+    settings[:app_name] = "hoge"
+    expect(settings.app_name).to eq "hoge"
+
+    password = "PASSWORD"
+    settings[:admins][:admin1] = password
+    expect(settings.admins.admin1).to eq password
+  end
+
+  it "can treat ERB format" do
+    unless settings.source_hash
+      expect(settings.erb).to eq "This was set by ERB"
+    end
+  end
+
+  describe "method?" do
+    it "return true when key exist" do
+      expect(settings.app_name?).to be_truthy
+    end
+
+    it "return false when key doesn't exist" do
+      expect(settings.not_exist?).to be_falsey
+    end
+  end
+
+  describe "method!" do
+    it "return new hash when key doesn't exist" do
+      ret = settings.newkey!
+      expect(ret).to be_an_instance_of settings
+      expect(ret.to_h).to eq({})
+    end
+
+    it "return existing value when key exist" do
+      expect(settings.app_name!).to eq app_name
+    end
+  end
+
+  describe "method_" do
+    it "return new hash but doesn't set when key doesn't exist" do
+      ret = settings.newkey_
+      expect(ret).to be_an_instance_of settings
+      expect(ret.to_h).to eq({})
+      expect(settings.newkey).to be_nil
+    end
+
+    it "return existing value when key exist" do
+      expect(settings.app_name_).to eq app_name
+    end
+  end
+
+  describe "method()" do
+    it "can set new value when key doesn't exist" do
+      new_value = "NEWVAL"
+      expect(settings.newkey(new_value)).to eq new_value
+      expect(settings.newkey).to eq new_value
+    end
+
+    it "doesn't set new value when key already exist" do
+      expect(settings.app_name("NEWVAL")).to eq "EasySettingsTest"
+      expect(settings.app_name).to eq "EasySettingsTest"
+    end
+
+    it "can set nil when using nil option" do
+      expect(settings.newkey(nil, nil: true)).to be_nil
+      expect(settings.has_key?(:newkey)).to be_truthy
+      expect(settings.newkey).to be_nil
+    end
+
+    it "doesn't set nil when not using nil option" do
+      expect(settings.newkey(nil)).to be_nil
+      expect(settings.has_key?(:newkey)).to be_falsey
+    end
+  end
+end
+
+describe EasySettings do
+  before do
+    FileUtils.mkdir File.expand_path("../../config", __FILE__)
+  end
+
+  after do
+    FileUtils.rm_rf File.expand_path("../../config", __FILE__)
+  end
+
+  let(:settings) do
+    Class.new(EasySettings)
+  end
+
+  let(:test_settings_file) do
+    File.expand_path("../settings.yml", __FILE__)
+  end
+
+  let(:default_settings_path1) do
+    File.expand_path("../../settings.yml", __FILE__)
+  end
+
+  let(:default_settings_path2) do
+    File.expand_path("../../config/settings.yml", __FILE__)
+  end
+
+  let(:custom_settings_path) do
+    File.expand_path("../../config/application.yml", __FILE__)
+  end
+  
+  let(:app_name) do
+    "EasySettingsTest"
+  end
+
+  context "from settings.yml" do
+    before do
+      FileUtils.cp test_settings_file, default_settings_path1
+    end
+
+    after do
+      FileUtils.rm_f default_settings_path1
+    end
+
+    it_behaves_like("EasySettings", Proc.new{Class.new(EasySettings)})
+
+    describe ".reload!" do
+      it "can reload source" do
+        expect(settings.app_name).to eq app_name
+        settings.source_hash = {app_name: "RELOAD"}
+        expect(settings.reload!).to be_truthy
+        expect(settings.app_name).to eq "RELOAD"
+      end
+    end
+  end
+
+  context "from config/settings.yml" do
+    before do
+      FileUtils.cp test_settings_file, default_settings_path2
+    end
+
+    after do
+      FileUtils.rm_f default_settings_path2
+    end
+
+    it_behaves_like("EasySettings", Proc.new{Class.new(EasySettings)})
+  end
+
+  context "from custom path" do
+    before do
+      FileUtils.cp test_settings_file, custom_settings_path
+    end
+
+    after do
+      FileUtils.rm_f custom_settings_path
+    end
+
+    it_behaves_like(
+      "EasySettings",
+      Proc.new do
+        Class.new(EasySettings) do
+          self.source_file = File.expand_path("../../config/application.yml", __FILE__)
+        end
+      end
+    )
+  end
+
+  context "from source hash" do
+    it_behaves_like(
+      "EasySettings",
+      Proc.new do
+        source_file = File.expand_path("../settings.yml", __FILE__)
+        Class.new(EasySettings) do
+          self.source_file = source_file
+          self.source_hash = YAML.load_file(source_file)
+        end
+      end
+    )
+  end
+
+  context "with namespace" do
+    it_behaves_like(
+      "EasySettings",
+      Proc.new do
+        Class.new(EasySettings) do
+          self.source_file = File.expand_path("../settings_with_namespace.yml", __FILE__)
+          self.namespace   = "test"
+        end
+      end
+    )
+  end
+
+  context "source does not exist" do
+    it "EasySettings is empty hash" do
+      expect(settings.to_h).to eq({})
+    end
+  end
+
+  context "with empty source" do
+    it "EasySettings become empty hash" do
+      settings.source_file = File.expand_path("../empty_settings.yml", __FILE__)
+      expect(settings.to_h).to eq({})
+    end
+  end
+
+  context "specify wrong source path" do
+    it "raise error" do
+      settings.source_file = "notexist.yml"
+      expect{settings.to_h}.to raise_error(EasySettings::SourceFileNotExist)
+    end
+  end
+end

data/spec/settings.yml

@@ -0,0 +1,9 @@
+app_name: EasySettingsTest
+admins:
+  admin1:
+    password: PassWord1
+    role: administrator
+  admin2:
+    password: PassWord2
+    role: manager
+erb: <%= "This was set by ERB" %>

data/spec/settings_with_namespace.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  app_name: EasySettingsTestDefault
+  admins:
+    admin1:
+      password: PassWord1
+      role: administrator
+    admin2:
+      password: PassWord2
+      role: manager
+  erb: <%= "This was set by ERB" %>
+
+test: 
+  <<: *defaults
+  app_name: EasySettingsTest

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "vendor"
+  add_filter "spec"
+end
+
+require "fileutils"
+require "easy_settings" 
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_settings
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - nownabe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -95,6 +110,11 @@ files:
 - easy_settings.gemspec
 - lib/easy_settings.rb
 - lib/easy_settings_version.rb
+- spec/easy_settings_spec.rb
+- spec/empty_settings.yml
+- spec/settings.yml
+- spec/settings_with_namespace.yml
+- spec/spec_helper.rb
 homepage: https://github.com/nownabe/easy_settings
 licenses:
 - MIT
@@ -119,4 +139,9 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: EasySettings is a simple settings with YAML file.
-test_files: []
+test_files:
+- spec/easy_settings_spec.rb
+- spec/empty_settings.yml
+- spec/settings.yml
+- spec/settings_with_namespace.yml
+- spec/spec_helper.rb