sexy_settings 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.idea/*
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sexy_settings.gemspec
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+# 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
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'Spec all functionality of gem'
+task :spec_all do
+  system("rspec spec/*/")
+end

data/lib/sexy_settings.rb

@@ -0,0 +1,6 @@
+require 'sexy_settings/version'
+require 'sexy_settings/configuration'
+require 'sexy_settings/base'
+require 'sexy_settings/core'
+
+

data/lib/sexy_settings/base.rb

@@ -0,0 +1,113 @@
+require 'singleton'
+require 'yaml'
+
+module SexySettings
+  class Base
+    include Singleton
+    attr_reader :default, :custom, :command_line, :all
+
+    # 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")
+    end
+
+  private
+
+    def load_settings(path)
+      File.exists?(path) ? YAML::load_file(path) : {}
+    end
+
+    def indent(space_count=nil)
+      " "*(space_count.nil? ? 2 : space_count)
+    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)
+        var = /\$\{(.*?)\}/.match(value.to_s)[1]
+        exist_var = @all[var]
+        raise ArgumentError, "Did you define this setting '#{var}' before?" if exist_var.nil?
+        value["${#{var}}"] = exist_var.to_s if var
+        get_compound_value(value)
+      end
+      value
+    end
+
+    def method_missing(name, *args)
+      if name.to_s =~ /=$/
+        @all[name.to_s] = args[0] if @all.has_key?(name.to_s)
+      else
+        @all[name.to_s]
+      end
+    end
+
+    # Try to convert a value from String to other types (int, boolean, float)
+    # 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
+    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["="]
+      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
+      end
+      new_value = try_convert_value(new_value)
+      @command_line[var_name] = new_value
+    end
+  end
+end

data/lib/sexy_settings/configuration.rb

@@ -0,0 +1,21 @@
+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

data/lib/sexy_settings/core.rb

@@ -0,0 +1,27 @@
+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

data/lib/sexy_settings/version.rb

@@ -0,0 +1,3 @@
+module SexySettings
+  VERSION = "0.0.1"
+end

data/sexy_settings.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sexy_settings/version"
+
+Gem::Specification.new do |s|
+  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.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'
+end

data/spec/_config/config.yaml

@@ -0,0 +1,3 @@
+default_property: default DEFAULT value
+overwritten_property: default OVERWRITTEN value
+console_property: default CONSOLE value

data/spec/_config/overwritten.yaml

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

data/spec/sexy_settings/base_spec.rb

@@ -0,0 +1,120 @@
+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

data/spec/sexy_settings/configuration_spec.rb

@@ -0,0 +1,34 @@
+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

data/spec/sexy_settings/core_spec.rb

@@ -0,0 +1,31 @@
+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

data/spec/sexy_settings/version_spec.rb

@@ -0,0 +1,8 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'sexy_settings'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: sexy_settings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roman Parashchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &26780748 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26780748
+description: Library for flexible specifying of application settings different ways
+email:
+- romikoops1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/sexy_settings.rb
+- lib/sexy_settings/base.rb
+- lib/sexy_settings/configuration.rb
+- lib/sexy_settings/core.rb
+- lib/sexy_settings/version.rb
+- sexy_settings.gemspec
+- spec/_config/config.yaml
+- spec/_config/overwritten.yaml
+- spec/sexy_settings/base_spec.rb
+- spec/sexy_settings/configuration_spec.rb
+- spec/sexy_settings/core_spec.rb
+- spec/sexy_settings/version_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/romikoops/sexy_settings
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sexy_settings
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Flexible specifying of application settings
+test_files: []