setty 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7197876a7fd153864e854a68461bce2a3cbc14d
+  data.tar.gz: a0aa78b034d6bb80d830b583d1bb2d3a1845c155
+SHA512:
+  metadata.gz: 913a5c1bb8bc607e19b90bb747454b4cddfd0a0208e06afa8ae3db01ef53c05f4efc4f30d77da8f45426a94d1e389995aa2f918252938f77a1d267ec59eddffb
+  data.tar.gz: 22ac1895547bf190df26458b7c969d87aa0a23448ffe542ea37b8c99200edb1b7cacb3af657346077ff2a3755c72c196c9ea1a63e5fcdbc5db21fea7e8439d96

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## Version 1.1 (unreleased)
+
+* Added reload method to Settings.
+
+* Raise error when settings file exists, but is not readable.
+
+* Added `settings_environment` option. It defaults to `Rails.env`.
+
+  Example:
+
+    # config/application.rb
+    config.setty.settings_environment = 'custom'
+
+    # config/settings.yml
+    custom:
+      key: "value"
+
+    development:
+      key: "other value"
+
 ## Version 1.0
 
-* Initial release
+* Initial release.

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/setty.png)](http://badge.fury.io/rb/setty)
 [![Code Climate](https://codeclimate.com/github/RStankov/setty.png)](https://codeclimate.com/github/RStankov/setty)
 [![Build Status](https://secure.travis-ci.org/RStankov/setty.png)](http://travis-ci.org/RStankov/setty)
 [![Code coverage](https://coveralls.io/repos/RStankov/setty/badge.png?branch=master)](https://coveralls.io/r/RStankov/setty)
@@ -55,7 +56,7 @@ Settings.secret_token                  #=> "blablablabla"
 Settings.secret_token?                 #=> true
 Settings.ssl_only                      #=> false
 Settings.ssl_only?                     #=> false
-Settings.projects.minumum_photos_count #= 1
+Settings.products.minumum_photos_count #=> 1
 ```
 
 You can find example of most important features and plugins - [here](https://github.com/RStankov/setty/tree/master/example).
@@ -66,6 +67,7 @@ You can find example of most important features and plugins - [here](https://git
 * Environment dependent
 * Interpolation
 * Nested settings
+* Reloading settings
 
 ### Configurable
 
@@ -74,8 +76,9 @@ You can find example of most important features and plugins - [here](https://git
 module MyApp
   class Application < Rails::Application
     # ... code ... code ...
-    config.setty.settings_object_name    = 'Settings'  # => Settings will be loaded in `Settings`
-    config.setty.settings_path           = 'settings'   # => extracts Settings from `config/settings/*` and `config/settings.yml`
+    config.setty.settings_object_name    = 'Settings'  # => settings will be loaded in `Settings`
+    config.setty.settings_path           = 'settings'  # => extracts settings from `config/settings/*` and `config/settings.yml`
+    config.setty.settings_environment    = Rails.env   # => enviroment name (defaults to Rails.env)
   end
 end
 ```
@@ -98,12 +101,12 @@ Depending on your Rails environment:
 
 ```Ruby
 # in development
-Settings::Validations.require_user_to_belong_to_account  #=> true
-Settings::Validations.require_user_to_belong_to_account? #=> true
+Settings.validations.require_user_to_belong_to_account  #=> true
+Settings.validations.require_user_to_belong_to_account? #=> true
 
 # in test
-Settings::Validations.require_user_to_belong_to_account  #=> false
-Settings::Validations.require_user_to_belong_to_account? #=> false
+Settings.validations.require_user_to_belong_to_account  #=> false
+Settings.validations.require_user_to_belong_to_account? #=> false
 ```
 
 ### Interpolation
@@ -127,8 +130,8 @@ production:
 
 ```Ruby
 # in production
-Settings::S3.access_key_id     #=> S3_ACCESS_KEY from `.env.production`
-Settings::S3.secret_access_key #=> S3_SECRET_KEY from `.env.production`
+Settings.s3.access_key_id     #=> S3_ACCESS_KEY from `.env.production`
+Settings.s3.secret_access_key #=> S3_SECRET_KEY from `.env.production`
 ```
 
 ### Nested Settings
@@ -151,6 +154,14 @@ Settings.validations.product
 Settings.validations.category
 ```
 
+### Reloading
+
+You can reload the current settings by calling:
+
+```ruby
+Settings.reload
+```
+
 ## Contributing
 
 1. Fork it

data/example/app/controllers/examples_controller.rb

@@ -1,4 +1,10 @@
 class ExamplesController < ApplicationController
   def index
   end
+
+  def reload
+    AppSettings.reload
+
+    redirect_to :back, notice: 'Settings reloaded'
+  end
 end

data/example/app/views/examples/index.html.slim

@@ -1,4 +1,7 @@
 #example
+  - if flash[:notice]
+    .alert.alert-success = flash[:notice]
+
   h1 Settings values
 
   table.table.table-striped.table-bordered
@@ -25,3 +28,7 @@
         td AppSettings.uploads.s3_active?
         td = AppSettings.uploads.s3_active?
         td Presence checker
+
+
+  p
+    = link_to 'Reload settings', reload_path

data/example/config/routes.rb

@@ -1,3 +1,5 @@
 Example::Application.routes.draw do
+  get :reload, to: 'examples#reload'
+
   root to: 'examples#index'
 end

data/lib/setty.rb

@@ -1,10 +1,11 @@
 require 'setty/version'
 require 'setty/options'
 require 'setty/loader'
+require 'setty/settings'
 require 'setty/railtie' if defined? Rails
 
 module Setty
   def self.load(path, enviroment)
-    Loader.new(path, enviroment).options
+    Settings.new Loader.new(path, enviroment)
   end
 end

data/lib/setty/loader.rb

@@ -1,33 +1,35 @@
 require 'erb'
 require 'yaml'
+require 'pathname'
 require 'active_support/core_ext/hash/keys.rb'
 require 'active_support/core_ext/string/inflections.rb'
 
 module Setty
   MissingEnviromentError = Class.new(RuntimeError)
+  NotReadableFileError = Class.new(RuntimeError)
 
   class Loader
     def initialize(path, enviroment)
-      @base_path  = path
-      @enviroment = enviroment
+      @base_path  = Pathname(path)
+      @enviroment = enviroment.to_s
     end
 
-    def options
-      load_options @base_path
+    def load_options
+      load_option_and_sub_options @base_path
     end
 
     private
 
-    def load_options(path)
-      options = load_options_from_file "#{path}.yml"
+    def load_option_and_sub_options(path)
+      options = load_options_from_file path.sub_ext('.yml')
       find_nested_options(path).each do |sub_path|
-        options[:"#{File.basename(sub_path)}"] = load_options(sub_path)
+        options[sub_path.basename.to_s.to_sym] = load_option_and_sub_options sub_path
       end
       options
     end
 
     def find_nested_options(path)
-      Dir.glob(File.join(path, '/*')).map { |file_path| "#{path}/#{File.basename(file_path, '.yml')}" }.uniq
+      Pathname.glob(path.join('*')).map { |file_path| path.join file_path.basename('.yml') }.uniq
     end
 
     def load_options_from_file(path)
@@ -38,13 +40,15 @@ module Setty
       Options[enviroment_options.symbolize_keys]
     end
 
-    def load_enviroment_options_from_file(path)
-      return {} unless File.readable? path
+    def load_enviroment_options_from_file(file)
+      return {} unless file.exist?
 
-      yaml_content = ERB.new(File.read(path)).result
+      raise NotReadableFileError, %Q(Settings file "#{file}" is not readable) unless file.readable?
+
+      yaml_content = ERB.new(file.read).result
       options      = YAML.load yaml_content
 
-      options[@enviroment.to_s]
+      options[@enviroment]
     end
   end
 end

data/lib/setty/railtie.rb

@@ -3,12 +3,14 @@ module Setty
     config.setty                        = ActiveSupport::OrderedOptions.new
     config.setty[:settings_path]        = 'settings'
     config.setty[:settings_object_name] = 'Settings'
+    config.setty[:settings_environment] = Rails.env
 
     initializer 'setty.load' do |app|
       path        = app.root.join 'config', app.config.setty[:settings_path]
       object_name = app.config.setty[:settings_object_name]
+      environment = app.config.setty[:settings_environment]
 
-      Object.const_set object_name, ::Setty.load(path, Rails.env)
+      Object.const_set object_name, ::Setty.load(path, environment)
     end
   end
 end

data/lib/setty/settings.rb

@@ -0,0 +1,16 @@
+module Setty
+  class Settings < Delegator
+    def initialize(loader)
+      @loader  = loader
+      @options = loader.load_options
+    end
+
+    def __getobj__
+      @options
+    end
+
+    def reload
+      @options = @loader.load_options
+    end
+  end
+end

data/lib/setty/version.rb

@@ -1,3 +1,3 @@
 module Setty
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'
 end

data/setty.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 2.14'
-  spec.add_development_dependency 'rspec-mocks', '>= 2.12.3'
+  spec.add_development_dependency 'rspec', '3.0'
+  spec.add_development_dependency 'rspec-mocks', '3.0'
   spec.add_development_dependency 'coveralls'
 end
 

data/spec/fixtures/forbidden.yml

@@ -0,0 +1,2 @@
+test:
+  content: 'should not be available'

data/spec/setty/base_spec.rb

@@ -6,11 +6,11 @@ describe Setty do
   end
 
   describe "#load" do
-    it "returns loaded options" do
-      loader = double options: 'options'
-      allow(Setty::Loader).to receive(:new).with('path', 'enviroment').and_return loader
+    it "returns settings" do
+      allow(Setty::Loader).to receive(:new).with('path', 'enviroment').and_return 'loader'
+      allow(Setty::Settings).to receive(:new).with('loader').and_return 'settings'
 
-      expect(Setty.load('path', 'enviroment')).to eq 'options'
+      expect(Setty.load('path', 'enviroment')).to eq 'settings'
     end
   end
 end

data/spec/setty/loader_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'tempfile'
 
 module Setty
   describe Loader do
@@ -10,7 +9,7 @@ module Setty
     it "loads yaml depending on environment variable" do
       options = load 'settings'
       expect(options.enviroment).to eq 'test'
-      expect(options.active?).to be_true
+      expect(options.active?).to be_truthy
     end
 
     it "does not complain about missing yaml file" do
@@ -39,8 +38,18 @@ module Setty
       expect { load 'settings', 'bongus enviroment' }.to raise_error MissingEnviromentError
     end
 
+    it "raises error on not readable settings file" do
+      begin
+        File.chmod(0200, fixture('forbidden.yml'))
+
+        expect { load 'forbidden' }.to raise_error NotReadableFileError
+      ensure
+        File.chmod(0777, fixture('forbidden.yml'))
+      end
+    end
+
     def load(name, env = 'test')
-      Loader.new(fixture(name), env).options
+      Loader.new(fixture(name), env).load_options
     end
   end
 end

data/spec/setty/options_spec.rb

@@ -19,9 +19,9 @@ module Setty
     it "has attribute checker" do
       options = Setty::Options[active: true, disabled: false]
 
-      expect(options.active?).to be_true
-      expect(options.disabled?).to be_false
-      expect(options.missing?).to be_false
+      expect(options.active?).to be_truthy
+      expect(options.disabled?).to be_falsey
+      expect(options.missing?).to be_falsey
     end
   end
 end

data/spec/setty/settings_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Setty
+  describe Settings do
+    let(:options) { 'options' }
+    let(:loader) { double 'Loader', load_options: options }
+
+    it "delegates to loader's loaded options" do
+      config = Settings.new(loader)
+
+      expect(config).to eq options
+    end
+
+    it "caches the loaded options" do
+      allow(loader).to receive(:load_options).and_return options
+
+      config = Settings.new(loader)
+
+      2.times { config.size }
+
+      expect(loader).to have_received(:load_options).once
+    end
+
+    describe "#reload" do
+      it "loads options again from the loader" do
+        config = Settings.new(loader)
+
+        allow(loader).to receive(:load_options).and_return 'new options'
+
+        config.reload
+
+        expect(config).to eq 'new options'
+      end
+    end
+  end
+end

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: setty
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-06-11 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: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.3
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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'
 description: Mini application configuration for Rails projects.
@@ -114,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -160,8 +147,10 @@ files:
 - lib/setty/loader.rb
 - lib/setty/options.rb
 - lib/setty/railtie.rb
+- lib/setty/settings.rb
 - lib/setty/version.rb
 - setty.gemspec
+- spec/fixtures/forbidden.yml
 - spec/fixtures/settings.yml
 - spec/fixtures/settings/inner_0.yml
 - spec/fixtures/settings/inner_1.yml
@@ -170,39 +159,34 @@ files:
 - spec/setty/base_spec.rb
 - spec/setty/loader_spec.rb
 - spec/setty/options_spec.rb
+- spec/setty/settings_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rstankov/setty
 licenses:
 - MIT
+metadata: {}
 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: -655774490321426843
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -655774490321426843
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Geneartes object hierarchy based on YAML files
 test_files:
+- spec/fixtures/forbidden.yml
 - spec/fixtures/settings.yml
 - spec/fixtures/settings/inner_0.yml
 - spec/fixtures/settings/inner_1.yml
@@ -211,4 +195,6 @@ test_files:
 - spec/setty/base_spec.rb
 - spec/setty/loader_spec.rb
 - spec/setty/options_spec.rb
+- spec/setty/settings_spec.rb
 - spec/spec_helper.rb
+has_rdoc: