opto 1.8.7 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8c5fb44e578d4ada0e75f570389edaaffb7240bf
-  data.tar.gz: 861c45894eb143c6e3077bf0cd7700564f489d01
+SHA256:
+  metadata.gz: 8d5546d31ee73e05adce64402dca900e55ef7159fcb277327fedf8bee0db2d00
+  data.tar.gz: 8dcaaf5040b306b4997f01124f2597a500c230f0a32d2ca5071c9d80e2bb536c
 SHA512:
-  metadata.gz: 183a776b2f65a61c20b84e2c216667bc6e7fc074dd7356e4e26619850dcd60a8a437faf1882ce1fcf02e4b088224f2d89b9904818b12b1b2e64bba38882ff290
-  data.tar.gz: 2411c527cb2e1b1028fe42a9768a7c112fb945f75f3f41811ada9241185212c7bc6f0bfde403f55b82ec0278d0cdf3353ccb2e7e419659a2457c5ec7c773abda
+  metadata.gz: 683dd71495e9ea808933e58416d81fb8ebc815ec0b34834bf14e4d4a7595ce478417287369184928033b6b309ff89797a39a4da0418f5f324a314b09308e7fe0
+  data.tar.gz: b4012a61a1a01b1a0ba7ef545956435939d329cd60400f37966b700a4ccc7e0f10c7223b19dd1a985a6383f5ce1b2d399c9914a411cdeb2d15b22597e4a383c9

data/.travis.yml

@@ -1,18 +1,21 @@
 language: ruby
 rvm:
-  - 2.1.10
-  - 2.2.3
-  - 2.3.3
-  - 2.4.1
+  - 2.3
+  - 2.4
+  - 2.5
 env:
   - secure: "bCu1bVzr6SP+gAbMo88GvcHHbhO3LcnJtWp+YuSZ5qW4EHhdBw+DOQeOlzoKHtYhNhptmb/65pZZctRTE6jOOSZzpOUHaeqaqHZpELldkCMu7rE8bXuCV4OfhG0CKWvURS0x5p5F5onEx1a1sjiu+MVEUqktAPDAcdTBNBW1irRwvnSifgjcZRLzfm1aRs1fqzBJpHaAXyD++2GQaWyXDtQsEsc/Eyhmnkac5Y2cTeQiYlDluqBeB885q9K16ruLp2NWx/rnR8RGMP1LSnrye/GEo2mRWOWy1MyIEwNDcVaA6MVDY2GBIQUoXg4PBrZAleVIsO3LzwR4oorFCaSgWxzqYI67g5Kb2zn8fW9Yu5lDcFEJKIHQAwBrlq3n3Mi5it/IxGQDWXQ/2fjBxCwuilvI0WTzOH0m4g8Uf6jHaQLFC6ahdWDjfs6aCzdPpbJls26/r39NIB5k/6ZO29NZkxGBsQ7E7m4wurr7a9ksLODgPOyPiB8/4Txu35Llp+IuJpbshrlkRIMwEIFVWiLi6MZhRBkxaRzlkJQ0bS3RD9W4z9UJyoBujmgXMrv0eHNTGCOC+/4tvrA+pXzJwmFQJA6TnenoDl9hc6o03gyfH/YvmMgrtJLbJ8rGoLRaY8HsQwHWgimpCl1o043kO8/UkhhS7J4wyQXYwqGnA2PC/j0="
-before_install: gem install bundler -v 1.12.5
-cache: bundler
-script: bundle install && bundle exec rspec spec/
+bundler_args: --with test development --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
+before_install:
+  - gem update --system
+  - gem install bundler
+script: bundle exec rspec spec/
+cache:
+  bundler: true
 deploy:
   provider: rubygems
   api_key: $GEM_TOKEN
   gem: opto
   on:
     tags: true
-    rvm: 2.4.1
+    rvm: 2.5

data/README.md

@@ -45,10 +45,12 @@ require 'opto'
   foo_username:
     type: string
     required: true
-    min_length: 1
-    max_length: 30
-    strip: true   # remove leading / trailing whitespace
-    upcase: true  # make UPCASE
+    validate:
+      min_length: 1
+      max_length: 30
+    transform:
+      - strip # remove leading / trailing whitespace
+      - upcase # make UPCASE
     from:
       env: FOO_USER # read value from ENV variable FOO_USER
 ```
@@ -72,16 +74,18 @@ require 'opto'
   foo_instances:
     type: integer
     default: 1
-    min: 1
-    max: 30
+    validate:
+      min: 1
+      max: 30
 ```
 
 ```yaml
 # Uri validator
   host_url:
     type: uri
-    schemes:
-      - file # only allow file:/// uris
+    validate:
+      schemes:
+        - file # only allow file:/// uris
 ```
 
 ## Resolvers
@@ -343,6 +347,14 @@ end
   from: prompter
 ```
 
+You can also use procs:
+
+```ruby
+group = Opto::Group.new(
+  resolvers: { prompt: proc { |hint, option| print "Enter #{hint} (default: #{option.default}): "; gets }
+)
+```
+
 ## Subclassing a predefined type handler, setter, etc
 
 ```ruby
@@ -459,6 +471,23 @@ Global validations:
 }
 ```
 
+### group
+
+Allows nesting of Opto::Groups:
+
+```yaml
+subgroup:
+  type: group
+  value:
+    subvariable:
+      type: string
+      value: world
+greeting:
+  type: string
+  from:
+    interpolate: hello, ${subgroup.subvariable} # becomes hello, world
+```
+
 ## Default resolvers
 Hint is the value that gets passed to the resolver when doing for example: `env: FOO` (FOO is the hint)
 
@@ -598,6 +627,44 @@ When an "else" is not defined and none of the conditions match, a null value wil
 
 The syntax for conditionals and complex conditionals is documented above in the chapter about conditionals.
 
+### yaml
+
+Hint is a hash defining filename or variable containing YAML source and optionally a key
+
+Example:
+```yaml
+# Read a string value from a key in YAML file
+str:
+  type: string
+  from:
+    yaml:
+      file: .env
+      key: STR
+
+# Read an array from a nested key in a YAML file
+str2:
+  type: array
+  from:
+    yaml:
+      file: variables.yml
+      key: variables.str2.value # assuming { variables: { str2: { value: ["abcd", "defg"] } } }
+
+# Read a YAML file into a string
+yaml_content:
+  type: string
+  from:
+    file: /etc/config.yml
+
+# Read YAML content from a variable and fetch a key from it
+str3:
+  type: string
+  from:
+    yaml:
+      variable: yaml_content
+      key: settings.cpu_arch
+```
+
+
 ## Default setters
 
 ### env

data/lib/opto/group.rb

@@ -11,35 +11,52 @@ module Opto
 
     using Opto::Extension::HashStringOrSymbolKey
 
-    attr_reader :options, :defaults
-
     extend Forwardable
 
     # Initialize a new Option Group. You can also pass in :defaults.
     #
     # @param [Array<Hash,Opto::Option>,Hash,NilClass] opts An array of Option definition hashes or Option objects or a hash like { var_name: { opts } }.
     # @return [Opto::Group]
-    def initialize(*options)
-      if options.size > 0
-        if options.last.kind_of?(Hash) && options.last[:defaults]
-          @defaults = options.pop[:defaults]
-        end
-        @options =
-          case options.first
-          when NilClass
-            []
-          when Hash
-            options.first.map {|k,v| Option.new({name: k.to_s, group: self}.merge(v))}
-          when ::Array
-            options.first.map {|opt| opt.kind_of?(Opto::Option) ? opt : Option.new(opt.merge(group: self)) }
-          else
-            raise TypeError, "Invalid type #{options.first.class} for Opto::Group.new"
+    def initialize(*opts)
+      case opts.first
+      when NilClass
+      when Hash
+        defaults.merge!(opts.first.delete(:defaults)) if opts.first.key?(:defaults)
+        setters.merge!(opts.first.delete(:setters)) if opts.first.key?(:setters)
+        resolvers.merge!(opts.first.delete(:resolvers)) if opts.first.key?(:resolvers)
+        options.concat(opts.first.map {|k,v| Option.new({name: k.to_s, group: self}.merge(v))})
+      when ::Array
+        if opts.last.is_a?(Hash) && !opts.last.key?(:type)
+          opts.pop.tap do |settings|
+            defaults.merge!(settings[:defaults]) if settings.key?(:defaults)
+            setters.merge!(settings[:setters]) if settings.key?(:setters)
+            resolvers.merge!(settings[:resolvers]) if settings.key?(:resolvers)
           end
+        end
+        if opts.first.kind_of?(Array)
+          options.concat(opts.first.map { |opt| opt.kind_of?(Opto::Option) ? opt : Option.new(opt.merge(group: self)) })
+        end
       else
-        @options = []
+        raise TypeError, "Invalid type #{opts.class} for Opto::Group.new"
       end
     end
 
+    def options
+      @options ||= []
+    end
+
+    def setters
+      @setters ||= {}
+    end
+
+    def resolvers
+      @resolvers ||= {}
+    end
+
+    def defaults
+      @defaults ||= {}
+    end
+
     # Are all options valid? (Option value passes validation)
     # @return [Boolean]
     def valid?
@@ -91,7 +108,25 @@ module Opto
     # @param [String] option_name
     # @return [Opto::Option]
     def option(option_name)
-      options.find { |opt| opt.name == option_name }
+      if option_name.to_s.include?('.')
+        parts = option_name.to_s.split('.')
+        var_name = parts.pop
+        group = parts.inject(self) do |base, part|
+          grp = base.option(part).value
+          if grp.nil?
+            raise NameError, "No such group: #{base.name}.#{part}"
+          elsif grp.kind_of?(Opto::Group)
+            grp
+          else
+            raise TypeError, "Is not a group: #{base.name}.#{part}"
+          end
+        end
+      else
+        group = self
+        var_name = option_name
+      end
+
+      group.options.find { |opt| opt.name == var_name }
     end
 
     # Get a value of a member by option name
@@ -180,6 +215,6 @@ module Opto
       end
     end
 
-    def_delegators :@options, *(::Array.instance_methods - [:__send__, :object_id, :to_h, :to_a, :is_a?, :kind_of?, :instance_of?, :self, :inspect, :nil?])
+    def_delegators :options, *(::Array.instance_methods - [:__send__, :object_id, :to_h, :to_a, :is_a?, :kind_of?, :instance_of?, :self, :inspect, :nil?])
   end
 end

data/lib/opto/option.rb

@@ -86,12 +86,27 @@ module Opto
       @only_if       = opts.delete(:only_if)
       @from          = normalize_from_to(opts.delete(:from))
       @to            = normalize_from_to(opts.delete(:to))
-      @type_options  = opts
+      validations    = opts.delete(:validate).to_h
+      transforms     = opts.delete(:transform)
+      transforms     = case transforms
+                       when NilClass then {}
+                       when Hash then transforms
+                       when Array then
+                         transforms.each_with_object({}) { |t, hash| hash[t] = true }
+                       else
+                         raise TypeError, 'Transform has to be a hash or an array'
+                       end
+      @type_options  = opts.merge(validations).merge(transforms)
+      @tried_resolve = false
 
       set_initial(val) if val
       deep_merge_defaults
     end
 
+    def has_group?
+      !group.nil?
+    end
+
     def deep_merge_defaults
       return nil unless group && group.defaults
       if group.defaults[:from]
@@ -140,7 +155,7 @@ module Opto
     # Returns true if this field should not be processed because of the conditionals
     # @return [Boolean]
     def skip?
-      return false if group.nil?
+      return false unless has_group?
       return true if group.any_true?(skip_if)
       return true unless group.all_true?(only_if)
       false
@@ -150,7 +165,8 @@ module Opto
     # @param [String] option_name
     def value_of(option_name)
       return value if option_name == self.name
-      group.nil? ? nil : group.value_of(option_name)
+      return nil unless has_group?
+      group.value_of(option_name)
     end
 
     # Run validators
@@ -181,11 +197,11 @@ module Opto
     # Accessor to defined resolvers for this option.
     # @return [Array<Opto::Resolver>]
     def resolvers
-      @resolvers ||= from.merge(default: self).map { |origin, hint| Resolver.for(origin).new(hint, self) }
+      @resolvers ||= from.merge(default: self).map { |origin, hint| { origin: origin, hint: hint, resolver: ((has_group? && group.resolvers[origin]) || Resolver.for(origin)) } }
     end
 
     def setters
-      @setters ||= to.map { |target, hint| Setter.for(target).new(hint, self) }
+      @setters ||= to.map { |target, hint| { target: target, hint: hint, setter: ((has_group? && group.setters[target]) || Setter.for(target)) } }
     end
 
     # True if this field is defined as required: true
@@ -194,32 +210,55 @@ module Opto
       handler.required?
     end
 
+    def tried_resolve?
+      @tried_resolve
+    end
+
+    def set_tried
+      @tried_resolve = true
+    end
+
+    def unset_tried!
+      @tried_resolve = false
+    end
+
     # Run resolvers
     # @raise [TypeError, ArgumentError]
     def resolve
-      resolvers.each do |resolver|
+      return nil if tried_resolve?
+      resolvers.each do |resolver_config|
         begin
-          result = resolver.try_resolve
+          resolver = resolver_config[:resolver]
+          if resolver.respond_to?(:call)
+            result = resolver.call(resolver_config[:hint], self)
+          else
+            result = resolver.new(resolver_config[:hint], self).resolve
+          end
         rescue StandardError => ex
-          raise ex, "Resolver '#{resolver.origin}' for '#{name}' : #{ex.message}"
+          raise ex, "Resolver '#{resolver_config[:origin]}' for '#{name}' : #{ex.message}"
         end
         unless result.nil?
-          @origin = resolver.origin
+          @origin = resolver_config[:origin]
           return result
         end
       end
       nil
+    ensure
+      set_tried
     end
 
     # Run setters
     def output
-      setters.each do |setter|
+      setters.each do |setter_config|
         begin
-          setter.respond_to?(:before) && setter.before(self)
-          setter.set(value)
-          setter.respond_to?(:after)  && setter.after(self)
+          setter = setter_config[:setter]
+          if setter.respond_to?(:call)
+            setter.call(setter_config[:hint], value, self)
+          else
+            setter.new(setter_config[:hint], self).set(value)
+          end
         rescue StandardError => ex
-          raise ex, "Setter '#{setter.target}' for '#{name}' : #{ex.message}"
+          raise ex, "Setter '#{setter_config[:target]}' for '#{name}' : #{ex.message}"
         end
       end
     end

data/lib/opto/resolver.rb

@@ -43,28 +43,6 @@ module Opto
     def initialize(hint = nil, option = nil)
       @hint = hint
       @option = option
-      @tried = false
-    end
-
-    def tried?
-      !!@tried
-    end
-
-    def set_tried
-      @tried = true
-    end
-
-    def reset_tried
-      @tried = false
-    end
-
-    def try_resolve
-      return nil if tried?
-      set_tried
-      self.respond_to?(:before) && self.before
-      result = resolve
-      self.respond_to?(:after) && self.after
-      result
     end
 
     # This is a "base" class, you're supposed to inherit from this in your resolver and define a #resolve method.

data/lib/opto/resolvers/condition.rb

@@ -79,10 +79,6 @@ module Opto
         matching_condition = conditions.find {|c| c.true? }
         matching_condition.result
       end
-
-      def after
-        reset_tried # conditional value can change if some of the depending variables change values
-      end
     end
   end
 end

data/lib/opto/resolvers/evaluate.rb

@@ -10,7 +10,7 @@ module Opto
 
       def resolve
         raise TypeError, "String required" unless hint.kind_of?(String)
-        interpolated_hint = hint.gsub(/(?<!\$)\$(?!\$)\{?\w+\}?/) do |v|
+        interpolated_hint = hint.gsub(/(?<!\$)\$(?!\$)\{?[\w\.]+\}?/) do |v|
           var = v.tr('${}', '')
           if option.group.nil? || option.group.option(var).nil?
             raise RuntimeError, "Variable #{var} not declared"
@@ -27,10 +27,6 @@ module Opto
           raise TypeError, "Syntax error: '#{interpolated_hint}' does not look like a number or a calculation"
         end
       end
-
-      def after
-        reset_tried
-      end
     end
   end
 end

data/lib/opto/resolvers/interpolate.rb

@@ -14,20 +14,16 @@ module Opto
 
       def resolve
         raise TypeError, "String expected" unless hint.kind_of?(String)
-        hint.gsub(/(?<!\$)\$(?!\$)\{?\w+\}?/) do |v|
+        hint.gsub(/(?<!\$)\$(?!\$)\{?[\w\.]+\}?/) do |v|
           var = v.tr('${}', '')
-          if option.group.nil? || option.group.option(var).nil?
-            raise RuntimeError, "Variable #{var} not declared"
-          end
-          if option.value_of(var).nil?
-            raise RuntimeError, "No value for #{var}, note that the order is meaningful"
-          end
-          option.value_of(var)
-        end
-      end
 
-      def after
-        reset_tried
+          raise RuntimeError, "Variable #{var} not declared" if option.group.nil?
+          opt = option.group.option(var)
+          raise RuntimeError, "Variable #{var} not declared" if opt.nil?
+          value = opt.value
+          raise RuntimeError, "No value for #{var}, note that the order is meaningful" if value.nil?
+          value
+        end
       end
     end
   end

data/lib/opto/resolvers/yaml.rb

@@ -0,0 +1,45 @@
+require 'opto/extensions/snake_case'
+require 'opto/extensions/hash_string_or_symbol_key'
+
+module Opto
+  module Resolvers
+    # Loads values from YAML files
+    #
+    # Example:
+    # from:
+    #   yaml:
+    #     file: foofoo.yml
+    #     key: foo
+    class Yaml < Opto::Resolver
+
+      using Opto::Extension::HashStringOrSymbolKey
+
+      def resolve
+        raise TypeError, "Hash expected" unless hint.kind_of?(Hash)
+
+        require 'yaml' unless Kernel.const_defined?(:YAML)
+
+        if hint[:file]
+          yaml = YAML.safe_load(::File.read(hint[:file]), [], [], true, hint[:file])
+        elsif hint[:variable]
+          raise TypeError, "Option not in a group" unless option.has_group?
+          other_opt = option.group.option(hint[:variable])
+          raise ArgumentError, "No such option: #{hint[:variable]}" if other_opt.nil?
+          yaml = YAML.safe_load(other_opt.value.to_s, [], [], true, hint[:variable])
+        else
+          raise TypeError, "Missing file/variable definition"
+        end
+        if hint[:key]
+          raise TypeError, "Source is not a hash" unless yaml.kind_of?(Hash)
+          if yaml.key?(hint[:key])
+            yaml[hint[:key]]
+          elsif hint[:key].include?('.')
+            yaml.dig(*hint[:key].split('.'))
+          end
+        else
+          yaml
+        end
+      end
+    end
+  end
+end

data/lib/opto/types/group.rb

@@ -0,0 +1,28 @@
+require_relative '../type'
+
+module Opto
+  module Types
+    # A subgroup
+    class Group < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey
+
+      true_when do |value|
+        value.kind_of?(Opto::Group) && !value.empty?
+      end
+
+      sanitizer :init do |value|
+        if options[:variables]
+          Opto::Group.new(options[:variables])
+        elsif value.kind_of?(::Hash) || value.kind_of?(::Array)
+          Opto::Group.new(value)
+        elsif value.kind_of?(Opto::Group)
+          value
+        elsif value.nil?
+          Opto::Group.new
+        else
+          raise TypeError, "Invalid type #{value.class.name} for a group"
+        end
+      end
+    end
+  end
+end

data/lib/opto/version.rb

@@ -1,3 +1,3 @@
 module Opto
-  VERSION = "1.8.7"
+  VERSION = "1.9.0"
 end

data/opto.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opto
 version: !ruby/object:Gem::Version
-  version: 1.8.7
+  version: 1.9.0
 platform: ruby
 authors:
 - Kimmo Lehto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2018-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -83,12 +83,14 @@ files:
 - lib/opto/resolvers/random_string.rb
 - lib/opto/resolvers/random_uuid.rb
 - lib/opto/resolvers/variable.rb
+- lib/opto/resolvers/yaml.rb
 - lib/opto/setter.rb
 - lib/opto/setters/environment_variable.rb
 - lib/opto/type.rb
 - lib/opto/types/array.rb
 - lib/opto/types/boolean.rb
 - lib/opto/types/enum.rb
+- lib/opto/types/group.rb
 - lib/opto/types/integer.rb
 - lib/opto/types/string.rb
 - lib/opto/types/uri.rb
@@ -106,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -114,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Option validator / resolver