sexy_settings 0.0.1 → 0.0.2

data/lib/sexy_settings/printable.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require_relative 'sensitive_data_protector'
+module SexySettings
+  # This module holds print methods
+  module Printable
+    def as_formatted_text(which = :all)
+      props_list = property_list(which)
+      max_key_size = props_list.map { |el| el.first.to_s.size }.max
+      [
+        sharp_line(which),
+        title(which),
+        sharp_line(which),
+        '',
+        formatted_properties(props_list, max_key_size),
+        ''
+      ].join("\n")
+    end
+
+    private
+
+    def sharp_line(which)
+      '#' * title(which).size
+    end
+
+    def title(which)
+      "##{' ' * 20}#{which.to_s.capitalize} Settings#{' ' * 21}#"
+    end
+
+    def indent(space_count = nil)
+      ' ' * (space_count.nil? ? 2 : space_count)
+    end
+
+    def property_list(which)
+      case which
+      when :all then @all
+      when :custom then @custom
+      when :default then @default
+      else ''
+      end.to_a
+    end
+
+    def formatted_properties(data, max_key_size)
+      data.sort_by(&:first).map do |(prop, value)|
+        value = protect_sensitive_data(prop, value)
+        "#{indent}#{prop}#{indent + indent(max_key_size - prop.to_s.size)}=#{indent}#{value}"
+      end
+    end
+
+    def protect_sensitive_data(prop, value)
+      SensitiveDataProtector.new(prop, value).protected_value
+    end
+  end
+end

data/lib/sexy_settings/sensitive_data_protector.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module SexySettings
+  # This class holds logic sensitive data hiding
+  class SensitiveDataProtector
+    PROTECTED_PROPERTIES = [/pass(\z|word)/i, /_key\z/i, /secret/i, /token/i].freeze
+    URL_REGEXP = %r{\A(?:https?|ftp):\/\/(?:(?<userpass>.+)@)?.*:?(?:[^\/]*)}i
+    attr_reader :prop, :value
+
+    def initialize(prop, value)
+      @prop = prop
+      @value = value.to_s
+    end
+
+    def protected_value
+      return hide_protected_data_in_url(value) if /_url\z/ =~ prop
+      return value unless PROTECTED_PROPERTIES.any? { |el| el =~ prop }
+      hide_protected_data(value)
+    end
+
+    def hide_protected_data(value)
+      return value if value.nil?
+      return '********' if value.to_s.size <= 4
+      "********#{value.to_s[-4..-1]}"
+    end
+
+    def hide_protected_data_in_url(value)
+      return value if value.nil? || !(URL_REGEXP =~ value)
+      userpass = URL_REGEXP.match(value)[:userpass]
+      return value if userpass.nil? || userpass.empty?
+      value.sub(userpass, protected_userpass(userpass))
+    end
+
+    def protected_userpass(value)
+      value.split(':', 2).compact.map(&method(:hide_protected_data)).join(':')
+    end
+  end
+end

data/lib/sexy_settings/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SexySettings
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/sexy_settings.rb

@@ -1,6 +1,5 @@
+# frozen_string_literal: true
 require 'sexy_settings/version'
 require 'sexy_settings/configuration'
 require 'sexy_settings/base'
 require 'sexy_settings/core'
-
-

data/sexy_settings.gemspec

@@ -1,20 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "sexy_settings/version"
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'sexy_settings/version'
 
 Gem::Specification.new do |s|
-  s.name        = "sexy_settings"
+  s.name        = 'sexy_settings'
   s.version     = SexySettings::VERSION
-  s.authors     = ["Roman Parashchenko"]
-  s.email       = ["romikoops1@gmail.com"]
-  s.homepage    = "https://github.com/romikoops/sexy_settings"
-  s.summary     = %q{Flexible specifying of application settings}
-  s.description = %q{Library for flexible specifying of application settings different ways}
-  s.rubyforge_project = "sexy_settings"
+  s.authors     = ['Roman Parashchenko']
+  s.email       = ['romikoops1@gmail.com']
+  s.homepage    = 'https://github.com/romikoops/sexy_settings'
+  s.summary     = 'Flexible specifying of application settings'
+  s.description = 'Library for flexible specifying of application settings different ways'
+  s.rubyforge_project = 'sexy_settings'
 
   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.require_paths = ["lib"]
-  s.add_development_dependency 'rspec'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_development_dependency 'rspec', '~>3.5'
+  s.add_development_dependency('rake')
+  s.add_development_dependency('yard')
 end

data/spec/_config/config.yaml

@@ -1,3 +1,16 @@
-default_property: default DEFAULT value
-overwritten_property: default OVERWRITTEN value
-console_property: default CONSOLE value
+default_property: default DEFAULT value
+overwritten_property: default OVERWRITTEN value
+console_property: default CONSOLE value
+pass: 123
+user_pass: hello:world
+api_key: '12341234123222333'
+password_confirmation: 'mysuperpass'
+passenger_name: 'Ivan Petrov'
+api_token: wer221wfqw23ef
+my_secret: ssdf3fvqww
+email: user@example.com
+test1_url: http://${email}:${user_pass}@host:80/wd/hub
+test2_url: http://${email}@host/wd/hub
+test3_url: http://:${user_pass}@host:80/wd/hub
+test4_url:
+test5_url: http://host/wd/hub

data/spec/_config/overwritten.yaml

@@ -1,2 +1,2 @@
-overwritten_property: overwritten OVERWRITTEN value
+overwritten_property: overwritten OVERWRITTEN value
 console_property: overwritten CONSOLE value

data/spec/sexy_settings/base_spec.rb

@@ -1,120 +1,140 @@
-require 'spec_helper'
-
-describe 'Base' do
-  before :all do
-    SexySettings.configure do |config|
-      config.path_to_default_settings = File.expand_path("config.yaml", File.join(File.dirname(__FILE__), '..', '_config'))
-      config.path_to_custom_settings = File.expand_path("overwritten.yaml", File.join(File.dirname(__FILE__), '..', '_config'))
-      config.path_to_project = File.dirname(__FILE__)
-      config.env_variable_with_options = 'OPTIONS'
-    end
-    if ENV.has_key?(SexySettings.configuration.env_variable_with_options)
-      @original_options = ENV[SexySettings.configuration.env_variable_with_options]
-    else
-      @original_options = nil
-    end
-    ENV[SexySettings.configuration.env_variable_with_options] = "console_property=console CONSOLE value"
-    @settings ||= settings
-  end
-
-  after :all do
-    @original_options = ENV[SexySettings.configuration.env_variable_with_options]
-    unless @original_options
-      ENV[SexySettings.configuration.env_variable_with_options] = @original_options
-    end
-  end
-
-  it "should be singleton object" do
-    SexySettings::Base.respond_to?(:instance).should be_true
-    SexySettings::Base.instance.is_a?(SexySettings::Base).should be_true
-  end
-
-  it "should have getter for default setting" do
-    @settings.respond_to?(:default).should be_true
-    expected_default_settings = {
-        "default_property" => "default DEFAULT value",
-        "overwritten_property" => "default OVERWRITTEN value",
-        "console_property" => "default CONSOLE value"
-    }
-    @settings.default.should == expected_default_settings
-  end
-
-  it "should have getter for custom setting" do
-    @settings.respond_to?(:default).should be_true
-    expected_custom_settings = {
-        "overwritten_property" => "overwritten OVERWRITTEN value",
-        "console_property" => "overwritten CONSOLE value"
-    }
-    @settings.custom.should == expected_custom_settings
-  end
-
-  it "should have getter for all setting" do
-    @settings.respond_to?(:default).should be_true
-    expected_all_settings = {
-        "default_property" => "default DEFAULT value",
-        "overwritten_property" => "overwritten OVERWRITTEN value",
-        "console_property" => "console CONSOLE value"
-    }
-    @settings.all.should == expected_all_settings
-  end
-
-  it "should return specified pretty formatted settings for output" do
-    expected = <<-eos
-#######################################################
-#                    All Settings                     #
-#######################################################
-
-  console_property      =  console CONSOLE value
-  default_property      =  default DEFAULT value
-  overwritten_property  =  overwritten OVERWRITTEN value
-eos
-    @settings.as_formatted_text.should == expected
-  end
-
-  context "command line" do
-    before :all do
-      SexySettings.configure.env_variable_with_options = 'OPTS'
-      ENV['OPTS'] = "string=Test, int=1, float=1.09, boolean_true=true, boolean_false=false, symbol=:foo, reference = ${string}"
-      @clone_settings = settings.class.clone.instance
-    end
-
-    after :all do
-      SexySettings.configure.env_variable_with_options = 'OPTIONS'
-    end
-
-    it "should convert command line string value to String type" do
-      @clone_settings.string.should == 'Test'
-    end
-
-    it "should convert command line integer value to Fixnum type" do
-      @clone_settings.int.should == 1
-      @clone_settings.int.class.should == Fixnum
-    end
-
-    it "should convert command line float value to Float type" do
-      @clone_settings.float.should == 1.09
-      @clone_settings.float.class.should == Float
-    end
-
-    it "should convert command line true value to TrueClass type" do
-      @clone_settings.boolean_true.should be_true
-    end
-
-    it "should convert command line false value to FalseClass type" do
-      @clone_settings.boolean_false.should be_false
-      @clone_settings.boolean_false.class.should == FalseClass
-    end
-
-    it "should convert command line symbol value to Symbol type" do
-      @clone_settings.symbol.should == :foo
-    end
-
-    it "should replace command line reference to correct value" do
-      @clone_settings.reference == 'Test'
-    end
-  end
-end
-
-def settings
-  SexySettings::Base.instance()
-end
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe 'Base' do
+  before :all do
+    SexySettings.configure do |config|
+      config.path_to_default_settings =
+        File.expand_path('config.yaml', File.join(File.dirname(__FILE__), '..', '_config'))
+      config.path_to_custom_settings =
+        File.expand_path('overwritten.yaml', File.join(File.dirname(__FILE__), '..', '_config'))
+      config.path_to_project = File.dirname(__FILE__)
+      config.env_variable_with_options = 'OPTIONS'
+    end
+    @original_options = if ENV.key?(SexySettings.configuration.env_variable_with_options)
+                          ENV[SexySettings.configuration.env_variable_with_options]
+                        else
+                          nil
+                        end
+    ENV[SexySettings.configuration.env_variable_with_options] = 'console_property=console CONSOLE value'
+    @settings ||= settings
+  end
+
+  after :all do
+    @original_options = ENV[SexySettings.configuration.env_variable_with_options]
+    unless @original_options
+      ENV[SexySettings.configuration.env_variable_with_options] = @original_options
+    end
+  end
+
+  it 'should be singleton object' do
+    expect(SexySettings::Base.respond_to?(:instance)).to be_truthy
+    expect(SexySettings::Base.instance).to be_a(SexySettings::Base)
+  end
+
+  it 'should have getter for default setting' do
+    expect(@settings).to be_respond_to(:default)
+    expected_default_settings = {
+      'default_property' => 'default DEFAULT value',
+      'overwritten_property' => 'default OVERWRITTEN value',
+      'console_property' => 'default CONSOLE value'
+    }
+    expect(@settings.default).to include(expected_default_settings)
+  end
+
+  it 'should have getter for custom setting' do
+    expect(@settings).to be_respond_to(:default)
+    expected_custom_settings = {
+      'overwritten_property' => 'overwritten OVERWRITTEN value',
+      'console_property' => 'overwritten CONSOLE value'
+    }
+    expect(@settings.custom).to eq(expected_custom_settings)
+  end
+
+  it 'should have getter for all setting' do
+    expect(@settings).to be_respond_to(:default)
+    expected_all_settings = {
+      'default_property' => 'default DEFAULT value',
+      'overwritten_property' => 'overwritten OVERWRITTEN value',
+      'console_property' => 'console CONSOLE value'
+    }
+
+    expect(@settings.all).to include(expected_all_settings)
+  end
+
+  it 'should return specified pretty formatted settings for output' do
+    # rubocop:disable Lint/EmptyInterpolation
+    expected = <<-eos
+#######################################################
+#                    All Settings                     #
+#######################################################
+
+  api_key                =  ********2333
+  api_token              =  ********23ef
+  console_property       =  console CONSOLE value
+  default_property       =  default DEFAULT value
+  email                  =  user@example.com
+  my_secret              =  ********vqww
+  overwritten_property   =  overwritten OVERWRITTEN value
+  pass                   =  ********
+  passenger_name         =  Ivan Petrov
+  password_confirmation  =  ********pass
+  test1_url              =  http://********.com:********orld@host:80/wd/hub
+  test2_url              =  http://********.com@host/wd/hub
+  test3_url              =  http://********:********orld@host:80/wd/hub
+  test4_url              =  #{}
+  test5_url              =  http://host/wd/hub
+  user_pass              =  ********orld
+eos
+    # rubocop:enable Lint/EmptyInterpolation
+    expect(@settings.as_formatted_text).to eq(expected)
+  end
+
+  context 'command line' do
+    let(:clone_settings) { settings.class.clone.instance }
+    before do
+      SexySettings.configure.env_variable_with_options = 'SEXY_SETTINGS'
+      ENV['SEXY_SETTINGS'] = 'string=Test, int=1, float=1.09, boolean_true=true,' \
+                    ' boolean_false=false, symbol=:foo, reference = ${string}'
+    end
+
+    after do
+      SexySettings.configure.env_variable_with_options = 'OPTIONS'
+    end
+
+    it 'should convert command line string value to String type' do
+      expect(clone_settings.string).to eq('Test')
+    end
+
+    it 'should convert command line integer value to Fixnum type' do
+      expect(clone_settings.int).to eq(1)
+      expect(clone_settings.int.class).to eq(Fixnum)
+    end
+
+    it 'should convert command line float value to Float type' do
+      expect(clone_settings.float).to eq(1.09)
+      expect(clone_settings.float.class).to eq(Float)
+    end
+
+    it 'should convert command line true value to TrueClass type' do
+      expect(clone_settings.boolean_true).to be_truthy
+    end
+
+    it 'should convert command line false value to FalseClass type' do
+      expect(clone_settings.boolean_false).to be_falsy
+      expect(clone_settings.boolean_false.class).to eq(FalseClass)
+    end
+
+    it 'should convert command line symbol value to Symbol type' do
+      expect(clone_settings.symbol).to eq(:foo)
+    end
+
+    it 'should replace command line reference to correct value' do
+      expect(clone_settings.reference).to eq('Test')
+    end
+  end
+end
+
+def settings
+  SexySettings::Base.instance
+end

data/spec/sexy_settings/configuration_spec.rb

@@ -1,34 +1,46 @@
-require 'spec_helper'
-
-describe 'Configuration' do
-  before :all do
-    @expected_opts = {
-        :path_to_default_settings => "default.yml",
-        :path_to_custom_settings => "custom.yml",
-        :path_to_project => '.',
-        :env_variable_with_options => 'OPTS',
-        :cmd_line_option_delimiter => ','
-    }
-    @config = SexySettings::Configuration.new
-  end
-
-  it "should have correct default options" do
-    SexySettings::Configuration.constants.should include(:DEFAULT_OPTIONS)
-    SexySettings::Configuration::DEFAULT_OPTIONS.should == @expected_opts
-  end
-
-  it "should have setters for all options" do
-    @expected_opts.keys.each{|key| @config.respond_to?("#{key}=").should be_true}
-  end
-
-  it "should return last value of specified option" do
-    new_value = 'fake'
-    @expected_opts.keys.each{|key| @config.send("#{key}=", new_value)}
-    @expected_opts.keys.each{|key| @config.send(key).should == new_value}
-  end
-
-  it "should return default value of specified option" do
-    config = SexySettings::Configuration.new
-    @expected_opts.keys.each{|key| config.send(key).should == @expected_opts[key]}
-  end
-end
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'Configuration' do
+  let(:expected_opts) do
+    {
+      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: ','
+    }
+  end
+  let(:config) { SexySettings::Configuration.new }
+
+  it 'should have correct default options' do
+    expect(SexySettings::Configuration.constants).to include(:DEFAULT_OPTIONS)
+    expect(SexySettings::Configuration::DEFAULT_OPTIONS).to eq(expected_opts)
+  end
+
+  it 'should have setters for all options' do
+    expected_opts.keys.each { |key| expect(config).to be_respond_to("#{key}=") }
+  end
+
+  it 'should return last value of specified option' do
+    new_value = 'fake'
+    expected_opts.keys.each do |key|
+      config.send("#{key}=", new_value)
+      expect(config.send(key)).to eq(new_value)
+    end
+  end
+
+  it 'should return default value of specified option' do
+    expected_opts.keys.each { |key| expect(config.send(key)).to eq(expected_opts[key]) }
+  end
+
+  context 'when SEXY_SETTINGS_DELIMITER env variable specified' do
+    before { ENV['SEXY_SETTINGS_DELIMITER'] = '$' }
+    after { ENV['SEXY_SETTINGS_DELIMITER'] = nil }
+
+    it 'should override specified delimiter' do
+      config.cmd_line_option_delimiter = ';'
+      expect(config.cmd_line_option_delimiter).to eq('$')
+    end
+  end
+end

data/spec/sexy_settings/core_spec.rb

@@ -1,31 +1,32 @@
-require 'spec_helper'
-
-describe 'Core' do
-  it "should have ability to reset settings" do
-    new_delim = '#@#'
-    old_delim = nil
-    SexySettings.configure do |config|
-      old_delim = config.cmd_line_option_delimiter
-      config.cmd_line_option_delimiter = new_delim
-    end
-    SexySettings.configuration.cmd_line_option_delimiter.should ==(new_delim)
-    SexySettings.reset
-    SexySettings.configuration.cmd_line_option_delimiter.should ==(old_delim)
-  end
-
-  it "should return the same configuration object each time" do
-    config = SexySettings.configuration
-    config.is_a?(SexySettings::Configuration).should be_true
-    config.object_id.should == SexySettings.configuration.object_id
-  end
-
-  it "should have ability to configure Configuration object with block" do
-    SexySettings.configure do |config|
-      config.is_a?(SexySettings::Configuration).should be_true
-    end
-  end
-
-  it "should have ability to configure Configuration object without block" do
-    SexySettings.configure.is_a?(SexySettings::Configuration).should be_true
-  end
-end
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'Core' do
+  it 'should have ability to reset settings' do
+    new_delim = '#@#'
+    old_delim = nil
+    SexySettings.configure do |config|
+      old_delim = config.cmd_line_option_delimiter
+      config.cmd_line_option_delimiter = new_delim
+    end
+    expect(SexySettings.configuration.cmd_line_option_delimiter).to eq(new_delim)
+    SexySettings.reset
+    expect(SexySettings.configuration.cmd_line_option_delimiter).to eq(old_delim)
+  end
+
+  it 'should return the same configuration object each time' do
+    config = SexySettings.configuration
+    expect(config).to be_a(SexySettings::Configuration)
+    expect(config.object_id).to eq(SexySettings.configuration.object_id)
+  end
+
+  it 'should have ability to configure Configuration object with block' do
+    SexySettings.configure do |config|
+      expect(config).to be_a(SexySettings::Configuration)
+    end
+  end
+
+  it 'should have ability to configure Configuration object without block' do
+    expect(SexySettings.configure).to be_a(SexySettings::Configuration)
+  end
+end

data/spec/sexy_settings/version_spec.rb

@@ -1,8 +1,9 @@
-require 'spec_helper'
-
-describe 'Version' do
-  it "should contains VERSION constant with correct format" do
-    SexySettings.constants.should include(:VERSION)
-    SexySettings::VERSION.should match(/^\d+\.\d+\.\d+$/)
-  end
-end
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe 'Version' do
+  it 'should contains VERSION constant with correct format' do
+    expect(SexySettings.constants).to include(:VERSION)
+    expect(SexySettings::VERSION).to match(/^\d+\.\d+\.\d+$/)
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
-require 'sexy_settings'
+# frozen_string_literal: true
+require 'sexy_settings'