sexy_settings 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a2bdfde4cdce0f4675e616504f3116cb268696e
+  data.tar.gz: adcdd8d83a9fd898a2200d21f2c4d0dde34c08df
+SHA512:
+  metadata.gz: 0a3be7f1002c585f6f6b3a105e1db74c9d4e743083cbc3ac42b53834abae9ee1b275901698adf7658c18d90d9b4d97e33ca88a84528ddc049b0e33a14d553978
+  data.tar.gz: 71f70a96e8f4666d3212e7ad0955c2f7840a45f783144c3d8f33ef900d41c5ec7118bab6fbabfbfac2ff034b0f3d9b094141fad5fa5ab382fb1eefb6ea3c0763

data/.gitignore

@@ -3,3 +3,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+.byebug_history
+.yardoc/
+doc/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+LineLength:
+  Max: 120
+
+Style/CaseIndentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+MethodLength:
+  Max: 30

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1

data/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing to SexySettings
+
+I love pull requests from everyone.
+
+To contribute to SexySettings:
+
+1. Fork the [official repository](https://github.com/romikoops/sexy_settings/tree/master).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version.

data/Gemfile

@@ -1,4 +1,9 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in sexy_settings.gemspec
 gemspec
+
+group :development do
+  gem 'rubocop'
+end

data/LICENSE_MIT

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Roman Parashchenko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,104 +1,136 @@
-# Sexy Settings
-
-Flexible specifying of application settings
-
-## What is Sexy Settings?
-
-It is Ruby library for flexible specifying of application settings different ways:
-
-* from YAML file(default and custom settings)
-* from command line
-
-### What's new in 0.0.1
-
-Init version with base functionality
-
-## Getting Started
-
-### Prerequisites
-
-It was tested with Ruby 1.9.2, but assumes it should work with other Ruby version as well
-### Installation
-
->   gem install sexy_settings
-
-### Configuration
-
- Create 2 configuration files, for default and custom settings. For instance,
-
-```
-config\
-    default.yaml
-    overwritten.yaml
-```
-
- Place next code to boot executable ruby file:
-
- ```ruby
- require 'sexy_settings'
-
- SexySettings.configure do |config|
-   config.path_to_default_settings = File.expand_path("config.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'default.yml' by default
-   config.path_to_custom_settings = File.expand_path("overwritten.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'custom.yml' by default
-   config.path_to_project = File.dirname(__FILE__) # '.' by default
-   config.env_variable_with_options = 'OPTIONS' # 'OPTS' by default
-   cmd_line_option_delimiter = '$$$' # ',' by default
- end
- ```
-
- Specify shortcut method for Settings object:
-
- ```ruby
- def settings
-   SexySettings::Base.instance()
- end
- ```
-
-### Using
-
-There are 4 possible values of settings
-The priority ranks with respect to the setting places are as follows:
-
-> **command line** < **custom** < **default** < **nil**_(in case setting was not specified anywhere)_
-
-Thus, specifying some setting in command line will override the same setting value specified in <_default config file_> or <_custom config file_>
-
-Example:
-
-_default.yaml_
-
-```yaml
-  foo: bar
-  foo1: default ${foo}
-  foo2: default value
-```
-
- _overwritten.yaml_
-
-```yaml
-  foo1: custom ${foo}
-```
-
-Set environment variable:
-
-> OPTIONS="foo2=10$$$foo3=:hi$$$foo4=true"
-
-```ruby
-puts settings.foo # returns 'bar'
-puts settings.foo1 # returns 'custom foo'
-puts settings.foo2 # returns 10
-puts settings.foo3 # returns :hi
-puts settings.foo4 # returns true
-```
-
-
-## Hints
-
-* Add <_default config file_> under version control system
-* Add <_custom config file_> to ignore list
-* Use command line with using Environment Variable for quick specifying setting in your Continuous Integration System
-* Use next code for output all settings as pretty formatted text:
-
-```ruby
-puts settings.as_formatted_text
-```
+# Sexy Settings
+
+[![Build Status](https://travis-ci.org/romikoops/sexy_settings.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/romikoops/sexy_settings.png)][gemnasium]
+
+[travis]: https://travis-ci.org/romikoops/sexy_settings
+[gemnasium]: https://gemnasium.com/romikoops/sexy_settings
+(https://gemnasium.com/romikoops/sexy_settings)
+
+Application settings are specified in a flexible way.
+
+## What is Sexy Settings?
+
+It is a Ruby-based library used to specify application settings in different ways:
+
+* Using the YAML file (default and custom settings).
+* Using the command line.
+
+### What's new in 0.0.2
+
+- Ability to override delimiter on fly for command line settings
+- Hidden sensitive data in logging
+- Changed default environment variable name with options
+
+## Getting Started
+
+### Prerequisites
+
+It was tested with Ruby 2.0 but it expected to also work with other Ruby versions
+
+### Installation
+
+>   gem install sexy_settings
+
+### Configuration
+
+Create 2 configuration files, one for default settings and the other one – for custom settings, e.g.:
+
+```
+config\
+    default.yml
+    custom.yml
+```
+
+  Insert the following code to the boot executable ruby file:
+
+ ```ruby
+ require 'sexy_settings'
+ ```
+
+  Specify a shortcut method for the Settings object:
+
+ ```ruby
+ def settings
+   SexySettings::Base.instance
+ end
+ ```
+
+### Usage
+
+There are 4 possible settings values. The priority ranks with respect to the settings location are as follows:
+
+
+> **command line** < **custom** < **default** < **nil**_(in case setting was not specified anywhere)_
+
+Thus, specifying some setting in the command line will override the same setting value specified in the <_default config file_> or <_custom config file_>
+
+Example:
+
+_default.yml_
+
+```yaml
+  foo: bar
+  foo1: default ${foo}
+  foo2: default value
+```
+
+ _custom.yml_
+
+```yaml
+  foo1: custom ${foo}
+```
+
+Set an environment variable:
+
+> SEXY_SETTINGS="foo2=10,foo3=:hi,foo4=true"
+
+```ruby
+puts settings.foo # returns 'bar'
+puts settings.foo1 # returns 'custom foo'
+puts settings.foo2 # returns 10
+puts settings.foo3 # returns :hi
+puts settings.foo4 # returns true
+```
+
+
+## Hints
+
+* Add <_default config file_> under the version control system.
+* Add <_custom config file_> to ignore the list.
+*	Use the command line with an Environment Variable for fast specifying setting in your Continuous Integration System.
+* Specify custom delimiter with  SEXY_SETTINGS_DELIMITER environment variable in case you need unique delimiter for command line mode
+* Use the following code to output all settings as a pretty formatted text:
+```ruby
+puts settings.as_formatted_text
+```
+__Note__, all sensitive data will be masked.
+
+## Advanced settings
+
+You have ability to change some default settings:
+
+```ruby
+SexySettings.configure do |config|
+   config.path_to_default_settings = File.expand_path("config.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'default.yml' by default
+   config.path_to_custom_settings = File.expand_path("overwritten.yaml", File.join(File.dirname(__FILE__), '..', 'config')) # 'custom.yml' by default
+   config.path_to_project = File.dirname(__FILE__) # '.' by default
+   config.env_variable_with_options = 'OPTIONS' # 'SEXY_SETTINGS' by default
+   cmd_line_option_delimiter = '$$$' # ',' by default
+end
+```
+
+Contributing
+------------
+
+Please see [CONTRIBUTING.md](https://github.com/romikoops/sexy_settings/blob/master/CONTRIBUTING.md).
+
+SexySettings was originally designed and is now maintained by Roman Parashchenko. You can find list of contributors here [open source
+community](https://github.com/romikoops/sexy_settings/graphs/contributors).
+
+License
+-------
+
+SexySettngs is Copyright © 2011-2016 Roman Parashchenko. It is free
+software, and may be redistributed under the terms specified in the
+[LICENSE](/LICENSE_MIT) file.

data/Rakefile

@@ -1,6 +1,18 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler'
+Bundler.setup
 
-desc 'Spec all functionality of gem'
-task :spec_all do
-  system("rspec spec/*/")
-end
+require 'rake'
+require 'yard'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec) { |_spec| }
+
+YARD::Rake::YardocTask.new { |_t| }
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/lib/sexy_settings/base.rb

@@ -1,60 +1,39 @@
+# frozen_string_literal: true
 require 'singleton'
 require 'yaml'
+require_relative 'printable'
 
 module SexySettings
+  # This class represents core functionality
   class Base
-    include Singleton
     attr_reader :default, :custom, :command_line, :all
 
+    include Singleton
+    include Printable
+
     # Priorities: command_line > custom.yml > default.yml > nil
     def initialize
-      config = SexySettings.configuration
       @default = load_settings(config.path_to_default_settings)
       @custom = load_settings(config.path_to_custom_settings)
-      @all = @default.merge(@custom)
-      @command_line = {}
-      unless ENV[config.env_variable_with_options].nil?
-        ENV[config.env_variable_with_options].split(config.cmd_line_option_delimiter).each{|opt_line| parse_setting(opt_line) if opt_line }
-      end
-      @all.merge!(@command_line)
-      @all.each_pair{|k, v| @all[k] = get_compound_value(v)}
-    end
-
-    def as_formatted_text(which=:all)
-      props_list = case which
-                     when :all then @all
-                     when :custom then @custom
-                     when :default then @default
-                     else ''
-                    end.to_a
-      max_key_size = props_list.map{|el| el.first.to_s.size}.max
-      res = []
-      title = "##{' '*20}#{which.to_s.capitalize} Settings#{' '*21}#"
-      sharp_line = '#'*title.size
-      res << sharp_line
-      res << title
-      res << sharp_line
-      res << ''
-      res += props_list.map{|el| "#{indent}#{el[0]}#{indent + indent(max_key_size - el[0].to_s.size)}=#{indent}#{el[1]}"}.sort
-      res << ''
-      res.join("\n")
+      init_command_line_settings
+      init_all_settings
     end
 
-  private
+    private
 
-    def load_settings(path)
-      File.exists?(path) ? YAML::load_file(path) : {}
+    def config
+      SexySettings.configuration
     end
 
-    def indent(space_count=nil)
-      " "*(space_count.nil? ? 2 : space_count)
+    def load_settings(path)
+      File.exist?(path) ? YAML.load_file(path) : {}
     end
 
     #  Parse the compound setting.
     #  Parts of this config_parser must be defined earlier.
     #  You can define an option as option=${another_option_name}/something
     def get_compound_value(value)
-      if /\$\{(.*?)\}/.match(value.to_s)
+      if /\$\{(.*?)\}/ =~ value.to_s
         var = /\$\{(.*?)\}/.match(value.to_s)[1]
         exist_var = @all[var]
         raise ArgumentError, "Did you define this setting '#{var}' before?" if exist_var.nil?
@@ -66,7 +45,7 @@ module SexySettings
 
     def method_missing(name, *args)
       if name.to_s =~ /=$/
-        @all[name.to_s] = args[0] if @all.has_key?(name.to_s)
+        @all[name.to_s] = args[0] if @all.key?(name.to_s)
       else
         @all[name.to_s]
       end
@@ -76,38 +55,65 @@ module SexySettings
     # Return the value as String if all tries have failed.
     # If the value is not of String type, return it as is.
     def try_convert_value(value)
-      if value.class == String
-        if /^[0-9]+$/.match(value) #int
-          value.to_i
-        elsif /^[0-9]+(\.)[0-9]*$/.match(value) #float
-          value.to_f
-        elsif (value.downcase == 'true') #boolean
-          true
-        elsif (value.downcase == 'false') #boolean
-          false
-        elsif /^:(.+)$/.match(value)
-          $1.to_sym
-        else
-          value # can't parse, return String
-        end
-      else # value is not String, return it as is
-        value
-      end
+      return value.to_i if integer?(value)
+      return value.to_f if float?(value)
+      return true if boolean_true?(value)
+      return false if boolean_false?(value)
+      return convert_to_sym(value) if symbol?(value)
+      value # can't parse, return String
+    end
+
+    def integer?(value)
+      /^[0-9]+$/ =~ value
+    end
+
+    def float?(value)
+      /^[0-9]+(\.)[0-9]*$/ =~ value # float
+    end
+
+    def boolean_true?(value)
+      value.casecmp('true').zero?
+    end
+
+    def boolean_false?(value)
+      value.casecmp('false').zero? # boolean
+    end
+
+    def symbol?(value)
+      /^:(.+)$/ =~ value
+    end
+
+    def convert_to_sym(value)
+      /^:(.+)$/ =~ value && Regexp.last_match(1).to_sym
     end
 
     #  Try to parse the setting's line
     #  Delimiter is "=", ignores double quotes in the start and end positions
     def parse_setting(line)
-      raise ArgumentError, "Invalid pair: #{line}. Expected: name=value" unless line["="]
+      raise ArgumentError, "Invalid pair: #{line}. Expected: name=value" unless line['=']
       param, value = line.split(/\s*=\s*/, 2)
-      var_name = param.chomp.strip
       value = value.chomp.strip if value
       new_value = ''
-      if (value)
-        new_value = (value =~ /^["](.*)["]$/) ?  $1 : value
+      if value
+        new_value = (value =~ /^["](.*)["]$/) ? Regexp.last_match(1) : value
       end
-      new_value = try_convert_value(new_value)
-      @command_line[var_name] = new_value
+      new_value = try_convert_value(new_value) if new_value.class == String
+      [param.chomp.strip, new_value]
+    end
+
+    def init_command_line_settings
+      @command_line = {}
+      data = ENV[config.env_variable_with_options]
+      return if data.nil?
+      delimiter = config.cmd_line_option_delimiter
+      data = data.split(delimiter).map { |el| parse_setting(el) if el }.compact
+      @command_line = Hash[data]
+    end
+
+    def init_all_settings
+      @all = @default.merge(@custom)
+      @all.merge!(@command_line)
+      @all.each_pair { |k, v| @all[k] = get_compound_value(v) }
     end
   end
-end
+end

data/lib/sexy_settings/configuration.rb

@@ -1,21 +1,37 @@
-module SexySettings
-  class Configuration
-    DEFAULT_OPTIONS = {
-        :path_to_default_settings => "default.yml",
-        :path_to_custom_settings => "custom.yml",
-        :path_to_project => '.',
-        :env_variable_with_options => 'OPTS',
-        :cmd_line_option_delimiter => ','
-    }
-    DEFAULT_OPTIONS.keys.each{|option| attr_writer option}
-
-    def initialize
-      DEFAULT_OPTIONS.keys.each do |method|
-        self.class.send(:define_method, method) do
-          self.instance_variable_get("@#{method}") || DEFAULT_OPTIONS[method]
-        end
-      end
-    end
-
-  end
-end
+# frozen_string_literal: true
+module SexySettings
+  # This class holds all configuration settings
+  class Configuration
+    DEFAULT_OPTIONS = {
+      path_to_default_settings: 'default.yml',
+      path_to_custom_settings: 'custom.yml',
+      path_to_project: '.',
+      env_variable_with_options: 'SEXY_SETTINGS',
+      cmd_line_option_delimiter: ','
+    }.freeze
+
+    DEFAULT_OPTIONS.keys.each { |option| attr_writer option }
+
+    def cmd_line_option_delimiter
+      ENV['SEXY_SETTINGS_DELIMITER'] ||
+        @cmd_line_option_delimiter ||
+        DEFAULT_OPTIONS[:cmd_line_option_delimiter]
+    end
+
+    def path_to_default_settings
+      @path_to_default_settings || DEFAULT_OPTIONS[:path_to_default_settings]
+    end
+
+    def path_to_custom_settings
+      @path_to_custom_settings || DEFAULT_OPTIONS[:path_to_custom_settings]
+    end
+
+    def path_to_project
+      @path_to_project || DEFAULT_OPTIONS[:path_to_project]
+    end
+
+    def env_variable_with_options
+      @env_variable_with_options || DEFAULT_OPTIONS[:env_variable_with_options]
+    end
+  end
+end

data/lib/sexy_settings/core.rb

@@ -1,27 +1,30 @@
-module SexySettings
-  # Used internally to ensure examples get reloaded between multiple runs in
-  # the same process.
-  def self.reset
-    self.configuration.class::DEFAULT_OPTIONS.keys.each{|key| self.configuration.send("#{key}=", nil)}
-  end
-
-  # Returns the global configuration object
-  def self.configuration
-    @configuration ||= SexySettings::Configuration.new
-  end
-
-  # Yields the global configuration object
-  #
-  # == Examples
-  #
-  # SexySettings.configure do |config|
-  #   config.env_variable_with_options = 'OPTIONS'
-  # end
-  def self.configure
-    if block_given?
-      yield configuration
-    else
-      self.configuration
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Core module
+module SexySettings
+  # Used internally to ensure examples get reloaded between multiple runs in
+  # the same process.
+  def self.reset
+    configuration.class::DEFAULT_OPTIONS.keys.each { |key| configuration.send("#{key}=", nil) }
+  end
+
+  # Returns the global configuration object
+  def self.configuration
+    @configuration ||= SexySettings::Configuration.new
+  end
+
+  # Yields the global configuration object
+  #
+  # == Examples
+  #
+  # SexySettings.configure do |config|
+  #   config.env_variable_with_options = 'OPTIONS'
+  # end
+  def self.configure
+    if block_given?
+      yield configuration
+    else
+      configuration
+    end
+  end
+end