right_support 1.3.3 → 1.4.0

data/README.rdoc

@@ -105,4 +105,29 @@ Profile your compute-heavy and network activities using a Stats::Activity counte
     stats.finish
   end
 
-  puts "Only %.1f lines/sec? You are a slow typist!" % [stats.avg_rate]
+  puts "Only %.1f lines/sec? You are a slow typist!" % [stats.avg_rate]
+
+=== Configuration
+
+RightSupport::Config contains functionality, which provides possibility 
+to use human-readable yaml configuration files. For example, you have following yaml 
+file '/tmp/features_config.yml', with content:
+
+  eat: 
+    khlav kalash: YES!
+  speak: 
+    klingonese: false
+    belarusian: true
+
+Then, if you would add configuration in you class, like:
+
+  class SweetestClass    
+    CONFIG = RightSupport::Config.features('/tmp/features_config.yml')
+  end
+
+* RightSupport::Config.features receives file` path, io or string.
+
+Now you can call CONFIG['feature_group']['feature'], like:
+
+* SweetestClass::CONFIG['eat']['khlav kalash'] would return 'YES!'
+* SweetestClass::CONFIG['speak']['belarusian'] would return true

data/lib/right_support.rb

@@ -3,6 +3,7 @@ require 'thread'
 
 require 'right_support/ruby'
 require 'right_support/crypto'
+require 'right_support/config'
 require 'right_support/db'
 require 'right_support/log'
 require 'right_support/net'

data/lib/right_support/config.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# 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.
+
+module RightSupport
+  #
+  # A namespace for configuration tools.
+  #
+  module Config
+
+  end
+end
+
+require 'right_support/config/feature_set'
+require 'right_support/config/yaml_config'
+require 'right_support/config/recursive_true_class'

data/lib/right_support/config/feature_set.rb

@@ -0,0 +1,95 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# 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.
+
+module RightSupport::Config
+
+  # Returns new instance of FeatureSet class,
+  # with loaded from config_source configuration
+  #
+  # === Parameters
+  # config_source(IO|String):: File` path, IO or raw yaml.
+  #
+  # === Return
+  # (FeatureSet):: new instance of FeatureSet class
+  def self.features(config_source)
+    return FeatureSet.new(config_source)
+  end  
+  
+  class FeatureSet
+    
+    attr_accessor :configuration_source
+    attr_accessor :configuration
+    
+    # Create features configuration object
+    #
+    # === Parameters
+    # cfg_source(IO|String):: File path, IO or raw yaml.
+    def initialize(cfg_source)
+      @configuration = load(cfg_source)
+    end
+
+    # Returns configuration value
+    #
+    # === Parameters
+    # feature_group(String):: Feature group name
+    # feature(String|nil):: Feature name
+    #
+    # === Return
+    # (String|Boolean):: Configuration value
+    def [](feature_group, feature=nil)
+      return_value = true
+      if @configuration[feature_group]
+        if feature == nil
+          return_value = @configuration[feature_group]
+        else
+          return_value = @configuration[feature_group][feature]
+        end
+      else
+        return_value = RecursiveTrueClass.new
+      end
+      return_value = true if return_value == nil            
+      return_value
+    end
+
+    # Load configuration source
+    #
+    # === Parameters
+    # something(IO|String|Hash):: File path, IO, raw YAML string, or a pre-loaded Hash
+    #
+    # === Return
+    # (Hash|nil):: Loaded yaml file 
+    #
+    # === Raise
+    # (ArgumentError):: If configuration source can`t be loaded
+    def load(something)
+      return_value = nil
+      @configuration_source = something
+      raise ArgumentError, "Can't coerce #{something} into YAML/Hash" unless (return_value = YAMLConfig.read(something))
+      return_value
+    end
+
+  end
+
+  # Temporary alias for FeatureSet class, to avoid disrupting downstream development
+  Feature = FeatureSet
+  
+end

data/lib/right_support/config/recursive_true_class.rb

@@ -0,0 +1,63 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# 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.
+
+module RightSupport::Config
+  
+  # Recursive(according to []) implementation of TrueClass.
+  # To use, just do: true1 = RecTrueClass.new
+  # now you can do true1['a'], true1['a']['b'], ...
+  # and it will return
+  class RecursiveTrueClass
+    
+    def initialize
+      @value = true    
+    end
+     
+    def [](something)
+      self
+    end
+ 
+    # supporting standart boolean 
+    # opeimplementation 
+    def ==(other)
+      @value==other
+    end
+
+    def &(other)
+      @value & other
+    end
+
+    def ^(other)
+      @value ^ other
+    end
+
+    def to_s
+      @value.to_s
+    end
+
+    def |(other)
+      @value | other
+    end
+
+  end
+
+end

data/lib/right_support/config/yaml_config.rb

@@ -0,0 +1,62 @@
+#
+# Copyright (c) 2012 RightScale Inc
+#
+# 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.
+require 'yaml'
+
+module RightSupport::Config
+
+  # Helper that encapsulates logic for loading YAML configuration hashes from various sources
+  # which can include strings, IO objects, or already-loaded YAML in the form of a Hash.
+  module YAMLConfig
+
+    class << self
+
+      # Load yaml source
+      #
+      # === Parameters
+      # something(IO|String|Hash):: File path, IO, raw YAML string, or a pre-loaded Hash
+      #
+      # === Returns
+      # (Boolean|Hash):: Loaded yaml file or false if a RuntimeError occurred while loading
+      def read(something)
+        return_value = false
+
+        begin
+          if something.kind_of?(Hash)
+            return_value = something
+          elsif File.exists?(something)
+            return_value = YAML.load_file(something)
+          else
+            return_value = YAML.load(something)
+          end 
+          raise unless return_value.kind_of?(Hash)
+        rescue
+          return_value = false
+        end
+
+        return_value
+      end
+
+    end
+
+  end  
+
+end

data/right_support.gemspec

@@ -7,8 +7,8 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
 
   s.name    = 'right_support'
-  s.version = '1.3.3'
-  s.date    = '2012-03-23'
+  s.version = '1.4.0'
+  s.date    = '2012-04-12'
 
   s.authors = ['Tony Spataro', 'Sergey Sergyenko', 'Ryan Williamson', 'Lee Kirchhoff']
   s.email   = 'support@rightscale.com'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_support
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
-  - 3
-  version: 1.3.3
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Tony Spataro
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-23 00:00:00 -07:00
+date: 2012-04-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,10 @@ files:
 - LICENSE
 - README.rdoc
 - lib/right_support.rb
+- lib/right_support/config.rb
+- lib/right_support/config/feature_set.rb
+- lib/right_support/config/recursive_true_class.rb
+- lib/right_support/config/yaml_config.rb
 - lib/right_support/crypto.rb
 - lib/right_support/crypto/signed_hash.rb
 - lib/right_support/db.rb