opto 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9f0ef7542d31a0ad7e239c0cb806b8043fbf180
-  data.tar.gz: 7c8f9cce7e8f4e72ab1e5e5a02e2b7db6ce1e2ad
+  metadata.gz: 622c74b8329576a787113264f93f0cc5c8341aac
+  data.tar.gz: 1d47bf107b35bb43ead69de0c351b6971ef096ed
 SHA512:
-  metadata.gz: 9308afe78c8546a80374aa50001cb6c2db6b16844a0fbf34bc13965da43dce0348a6cec1ba8c383021ae84f4f7e99f7786c692d396c249fd661b4bbb0eeda9e9
-  data.tar.gz: 99d48baecaea59a3d1cffad818fc3799c9d2c36eef1df0a6b311448cca96fc3d409220f3cf687b0d542f732311ce40e878590712faa5f986cd20d8087c03387b
+  metadata.gz: cb0e8e17ccd405b4b4804a2f94cc7f81897e5b6c73ddc5442d6c758c86f7df96abca6800e09216619668abb0f5ec0cf3a207649d425bc6956da01f7b31233f10
+  data.tar.gz: 0d53fca76c0ed5ff96fc3587d9cd1393dda7ed5a891a25bf1f1a399edb28a10ebba7f4f2ded8be94ddfa9fe7e8d143104252f409603c2e7f1470c343374e4194

data/README.md

@@ -92,7 +92,7 @@ Simple so far. Now let's mix in "resolvers" which can fetch the value from a num
 # Generate random strings
   vault_iv:
     type: string
-    from: 
+    from:
       random_string:
         length: 64
         charset: ascii_printable # Other charsets include hex, hex_upcase, alphanumeric, etc.
@@ -116,7 +116,7 @@ Simple so far. Now let's mix in "resolvers" which can fetch the value from a num
       env: FOOFOO
       file:  # if env is not set, try to read it from this file, returns nil if not readable
         path: /tmp/aws_secret.txt
-        ignore_errors: true 
+        ignore_errors: true
       random_string: 30 # not there either, generate a random string.
 ```
 
@@ -151,10 +151,10 @@ There's also rudimentary conditional support:
 ```
 
 ```ruby
- group.option('bar').skip? 
+ group.option('bar').skip?
  => false
  group.option('foo').value = 'world'
- group.option('bar').skip? 
+ group.option('bar').skip?
  => true
 ```
 
@@ -167,10 +167,10 @@ There's also rudimentary conditional support:
 
 ```ruby
  group.option('foo').value = 'world'
- group.option('bar').skip? 
+ group.option('bar').skip?
  => false
  group.option('foo').value = 'hello'
- group.option('bar').skip? 
+ group.option('bar').skip?
  => true
 ```
 
@@ -179,7 +179,7 @@ There's also rudimentary conditional support:
 
   - name: bar
     type: integer
-    skip_if: 
+    skip_if:
       - foo: hello # AND
       - baz: world
 
@@ -360,6 +360,19 @@ Global validations:
 }
 ```
 
+### array
+```ruby
+{
+  split: ',', # Use this pattern to split an incoming string into an array
+  join: false, # Set to a pattern such as ',' to output a comma separated string
+  empty_is_nil: false, # When true, an empty array will become nil
+  sort: false, # Sort the array before output
+  uniq: false, # Remove duplicates before output
+  count: false, # Instead of outputting the array, output the array size
+  compact: false # Remove nils before output
+}
+```
+
 ## Default resolvers
 Hint is the value that gets passed to the resolver when doing for example: `env: FOO` (FOO is the hint)
 

data/lib/opto.rb

@@ -24,7 +24,7 @@ module Opto
       else
         Group.new(opts)
       end
-    when Array
+    when ::Array
       if opts.all? {|o| o.kind_of?(Hash) }
         Group.new(opts)
       else

data/lib/opto/group.rb

@@ -34,7 +34,7 @@ module Opto
             []
           when Hash
             options.first.map {|k,v| Option.new({name: k.to_s, group: self}.merge(v))}
-          when Array
+          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"
@@ -107,6 +107,34 @@ module Opto
       opt.nil? ? nil : opt.value
     end
 
-    def_delegators :@options, *(Array.instance_methods - [:__send__, :object_id, :to_h, :to_a, :is_a?, :kind_of?, :instance_of?])
+    def any_true?(conditions)
+      normalize_ifs(conditions).any? { |s| s.call(self) == true }
+    end
+
+    def all_true?(conditions)
+      normalize_ifs(conditions).all? { |s| s.call(self) == true }
+    end
+
+    def normalize_ifs(ifs)
+      case ifs
+      when NilClass
+        []
+      when ::Array
+        ifs.map do |iff|
+          lambda { |grp| !grp.value_of(iff).nil? }
+        end
+      when Hash
+        ifs.each_with_object([]) do |(k, v), arr|
+          arr << lambda { |grp| grp.value_of(k.to_s) == v }
+        end
+      when String, Symbol
+        [lambda { |grp| !grp.value_of(ifs.to_s).nil? }]
+      else
+        raise TypeError, "Invalid syntax for conditional"
+      end
+    end
+
+
+    def_delegators :@options, *(::Array.instance_methods - [:__send__, :object_id, :to_h, :to_a, :is_a?, :kind_of?, :instance_of?])
   end
 end

data/lib/opto/option.rb

@@ -10,7 +10,7 @@ if RUBY_VERSION < '2.1'
 end
 
 module Opto
-  # What is an option? It's like a variable that has a value, which can be validated or 
+  # What is an option? It's like a variable that has a value, which can be validated or
   # manipulated on creation. The value can be resolved from a number of origins, such as
   # an environment variable or random string generator.
   class Option
@@ -57,7 +57,7 @@ module Opto
     #     description: 'Enter a name for your cat',
     #     from:
     #       env: 'CAT_NAME'
-    #     only_if: 
+    #     only_if:
     #       pet: 'cat'
     #     min_length: 2
     #     max_length: 20
@@ -91,8 +91,6 @@ module Opto
       val            = opts.delete(:value)
       @skip_if       = opts.delete(:skip_if)
       @only_if       = opts.delete(:only_if)
-      @skip_lambdas  = normalize_ifs(@skip_if)
-      @only_lambdas  = normalize_ifs(@only_if)
       @from          = normalize_from_to(opts.delete(:from))
       @to            = normalize_from_to(opts.delete(:to))
       @type_options  = opts
@@ -149,8 +147,9 @@ module Opto
     # Returns true if this field should not be processed because of the conditionals
     # @return [Boolean]
     def skip?
-      return true if     @skip_lambdas.any? { |s| s.call(self) }
-      return true unless @only_lambdas.all? { |s| s.call(self) }
+      return false if group.nil?
+      return true if group.any_true?(skip_if)
+      return true unless group.all_true?(only_if)
       false
     end
 
@@ -247,28 +246,9 @@ module Opto
       handler.errors
     end
 
-    def normalize_ifs(ifs)
-      case ifs
-      when NilClass
-        []
-      when Array
-        ifs.map do |iff|
-          lambda { |opt| !opt.value_of(iff).nil? }
-        end
-      when Hash
-        ifs.each_with_object([]) do |(k, v), arr|
-          arr << lambda { |opt| opt.value_of(k.to_s) == v }
-        end
-      when String, Symbol
-        [lambda { |opt| !opt.value_of(ifs.to_s).nil? }]
-      else
-        raise TypeError, "Invalid syntax for if"
-      end
-    end
-
     def normalize_from_to(inputs)
       case inputs
-      when Array
+      when ::Array
         case inputs.first
         when String, Symbol
           inputs.each_with_object({}) { |o, hash| hash[o.to_s.snakecase.to_sym] = name }

data/lib/opto/types/array.rb

@@ -0,0 +1,74 @@
+require_relative '../type'
+if RUBY_VERSION < '2.1'
+  using Opto::Extension::SnakeCase
+  using Opto::Extension::HashStringOrSymbolKey
+end
+
+module Opto
+  module Types
+    # An array
+    #
+    # Options:
+    #   - split: an incoming string will be split using this pattern
+    #   - join: when outputting, join the array using this pattern into a string
+    #   - empty_is_nil: an empty array will be replaced with nil
+    #   - sort: when true, sorts the array before output
+    #   - uniq: when true, removes duplicates
+    #   - compact: when true, removes nils and blanks
+    #   - count: when true, the output is the count of items in the array
+    class Array < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+
+      OPTIONS = {
+        split: ',',
+        join: false,
+        empty_is_nil: false,
+        sort: false,
+        uniq: false,
+        count: false,
+        compact: false
+      }
+
+      sanitizer :split do |value|
+        if value.kind_of?(::Array)
+          value
+        elsif value.kind_of?(::String)
+          value.split(options[:split])
+        else
+          [value]
+        end
+      end
+
+      sanitizer :sort do |value|
+        (value && options[:sort]) ? value.sort : value
+      end
+
+      sanitizer :uniq do |value|
+        (value && options[:uniq]) ? value.uniq : value
+      end
+
+      sanitizer :compact do |value|
+        (value && options[:compact]) ? value.compact : value
+      end
+
+      sanitizer :empty_is_nil do |value|
+        (options[:empty_is_nil] && value.empty?) ? nil : value
+      end
+
+      sanitizer :output do |value|
+        if value
+          if options[:join]
+            value.join(options[:join])
+          elsif options[:count]
+            value.size
+          else
+            value
+          end
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/opto/types/enum.rb

@@ -19,7 +19,7 @@ module Opto
     #   Opto::Option.new(
     #     name: 'foo',
     #     type: 'enum',
-    #     options: 
+    #     options:
     #       - foo
     #       - bar
     #       - cat
@@ -76,12 +76,12 @@ module Opto
           options.each_with_object([]) do |(key, value), array|
             array << { value: key, label: key, description: value }
           end
-        when Array
+        when ::Array
           case options.first
           when Hash
             options.each do |opt|
               if opt[:value].nil? || opt[:description].nil?
-                raise TypeError, "Option definition requires value and description and can have label when using hash syntax" 
+                raise TypeError, "Option definition requires value and description and can have label when using hash syntax"
               end
             end
             options

data/lib/opto/version.rb

@@ -1,3 +1,3 @@
 module Opto
-  VERSION = "1.5.3"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opto
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Kimmo Lehto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - 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/integer.rb