opto 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ca045aebcc54054d2901ed55fa11c32c1bfce21
-  data.tar.gz: a6e1510d1fee7789882f50501fc4d90613a16f0b
+  metadata.gz: 5ac3340f2ab72942ad62dd4589d773e7713ebb24
+  data.tar.gz: 5882bb7b1bb860e10413ca659887c1e166f39bad
 SHA512:
-  metadata.gz: 6424d5217c9dd151d6627222efae29999a82ac5d2629cd160b64cd34ff2c58a55d35dabf7c8e549f68dcbc4e7d4c0734a6481b16ec98094a6966ee56755f41e0
-  data.tar.gz: 5f1834c36f6db2b44e671c32a369c0b7be557ec7276c9a5561e8c2584443b91253a9181e998afbbd5cf2cbcb2374ad2cbdbfc2c5e5ba907e33d9b8dd733ba2dc
+  metadata.gz: 10ea21720b0b1d07c4d7deaa43424f296ac9b3dff137db003c2e40b87ba37604dbb864592268a1ffc30dfb0d8e46a1823a61954dfbf63e96f49df8a72d4fe4b6
+  data.tar.gz: 05c279f893883d1ac3b7dfabc8d9034719b22069369a24c6e7ed99f82e5f6ea192ce661cdb4278c68c4d4d68464446dd92160018f5a54626e6b91375f75a6d9a

data/LICENSE.txt

@@ -1,21 +1,191 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Kimmo Lehto
-
-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.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2015 Kontena, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -11,7 +11,7 @@ The option type handlers can perform validations, such as defining a range or le
 
 Transformations can be performed on values, such as upcasing strings or removing white space.
 
-Options can have simple conditionals for determining if it needs to be processed or not, an option for defining a database
+Options can have simple conditionals for determining if it needs to be processed or not, for example: an option for defining a database
 password can be processed only if a database has been selected.
 
 Finally the value for the option can be placed to some destination, such as an environment variable or sent to a command.
@@ -138,7 +138,7 @@ Ok, so what to do with the values? There's setters for that.
 
 ## Conditionals
 
-There's also rudimentary conditional support:
+There's also support for conditionals
 
 ```yaml
   - name: foo
@@ -194,7 +194,93 @@ There's also rudimentary conditional support:
       - baz   # AND baz is not null
 ```
 
-Pretty nifty, right?
+### Complex conditionals
+
+You can define more complicated conditionals by supplying a hash instead of a value:
+
+```yaml
+# value. same as foo == 5
+only_if:
+  foo: 5
+```
+
+```yaml
+# hash. same as foo > 5 && foo <= 10
+only_if:
+  foo:
+    gt: 5
+    lte: 10
+```
+
+### Complex conditional operators
+
+#### `lt`, `lte`
+
+less than / less than or equal to
+
+#### `gt`, `gte`
+
+greater than / greater than or equal to
+
+#### `eq`, `ne`
+
+equals / not equals
+
+#### `start_with`, `end_with`
+
+"foobar" starts with "foo" and ends with "bar".
+
+#### `contain`
+
+Can be used for strings and arrays:
+
+```yaml
+arr:
+  type: array
+  value:
+    - a
+    - b
+    - c
+
+str:
+  type: string
+  value: foobar
+
+x:
+  type: boolean
+  from:
+    condition:
+      - if:
+        arr:
+          contain: b
+        str:
+          contain: b
+        then: true
+      - else: false
+      -
+# group.value_of('x')
+# => true
+```
+
+#### `any_of`
+
+true when the value is one of the supplied values. Input is either a comma separated string or an array.
+
+```yaml
+foo:
+  skip_if:
+    bar:
+      any_of: foo,baz
+```
+
+```yaml
+foo:
+  skip_if:
+    bar:
+      any_of:
+        - foo
+        - baz
+```
 
 ## Examples
 
@@ -445,6 +531,45 @@ greeting:
 # group.value_of('greeting') => "Hello, world!"
 ```
 
+### condition
+
+Hint is an array containing if/then/elsif/else definitions. Sets the value based on the values of other variables.
+
+Example:
+```yaml
+int:
+  type: integer
+  value: 5
+
+str:
+  type: string
+  from:
+    condition:
+      - if:
+          int: 5
+        then: "five"
+      - elsif:
+          int: 6
+        then: "six"
+      - else: "not five or six"
+```
+
+```ruby
+group.option('int').set(4)
+group.option('str').resolve
+=> "not five or six"
+group.option('int').set(5)
+group.option('str').resolve
+=> "five"
+group.option('int').set(6)
+group.option('str').resolve
+=> "six"
+```
+
+When an "else" is not defined and none of the conditions match, a null value will be returned.
+
+The syntax for conditionals and complex conditionals is documented above in the chapter about conditionals.
+
 ## Default setters
 
 ### env

data/lib/opto/extensions/hash_string_or_symbol_key.rb

@@ -8,6 +8,14 @@ module Opto
           super(key.to_s) || super(key.to_sym)
         end
 
+        def has_key?(key)
+          if key.nil?
+            super(nil)
+          else
+            super(key.to_s) || super(key.to_sym)
+          end
+        end
+
         def delete(key)
           return nil if key.nil?
           super(key) || super(key.to_s) || super(key.to_sym)

data/lib/opto/group.rb

@@ -1,3 +1,4 @@
+require 'opto/option'
 require 'opto/extensions/snake_case'
 require 'opto/extensions/hash_string_or_symbol_key'
 
@@ -125,7 +126,58 @@ module Opto
         end
       when Hash
         ifs.each_with_object([]) do |(k, v), arr|
-          arr << lambda { |grp| grp.value_of(k.to_s) == v }
+          if v.kind_of?(Hash)
+            if v.has_key?(:lt)
+              arr << lambda { |grp| grp.value_of(k.to_s) < v[:lt] }
+            end
+
+            if v.has_key?(:lte)
+              arr << lambda { |grp| grp.value_of(k.to_s) <= v[:lte] }
+            end
+
+            if v.has_key?(:gt)
+              arr << lambda { |grp| grp.value_of(k.to_s) > v[:gt] }
+            end
+
+            if v.has_key?(:gte)
+              arr << lambda { |grp| grp.value_of(k.to_s) > v[:gte] }
+            end
+
+            if v.has_key?(:eq)
+              arr << lambda { |grp| grp.value_of(k.to_s) == v[:eq] }
+            end
+
+            if v.has_key?(:ne)
+              arr << lambda { |grp| grp.value_of(k.to_s) != v[:ne] }
+            end
+
+            if v.has_key?(:start_with)
+              arr << lambda { |grp| grp.value_of(k.to_s).to_s.start_with?(v[:start_with]) }
+            end
+
+            if v.has_key?(:end_with)
+              arr << lambda { |grp| grp.value_of(k.to_s).to_s.end_with?(v[:end_with]) }
+            end
+
+            if v.has_key?(:contain)
+              arr << lambda { |grp| grp.value_of(k.to_s).kind_of?(::Array) ? grp.value_of(k.to_s).include?(v[:contain]) : grp.value_of(k.to_s).to_s.include?(v[:contain]) }
+            end
+
+            if v.has_key?(:any_of)
+              arr << lambda do |grp|
+                if v[:any_of].kind_of?(String)
+                  arr = v[:any_of].split(",")
+                elsif v[:any_of].kind_of?(::Array)
+                  arr = v[:any_of]
+                else
+                  raise TypeError, "Invalid list for 'any_of'. Expected: Array or a comma separated string"
+                end
+                arr.include?(grp.value_of(k.to_s))
+              end
+            end
+          else
+            arr << lambda { |grp| grp.value_of(k.to_s) == v }
+          end
         end
       when String, Symbol
         [lambda { |grp| !grp.value_of(ifs.to_s).nil? }]

data/lib/opto/resolvers/condition.rb

@@ -0,0 +1,90 @@
+require 'opto/extensions/snake_case'
+require 'opto/extensions/hash_string_or_symbol_key'
+
+if RUBY_VERSION < '2.1'
+  using Opto::Extension::SnakeCase
+  using Opto::Extension::HashStringOrSymbolKey
+end
+
+module Opto
+  module Resolvers
+    # Allows setting the value conditionally based on other variables
+    #
+    # Example:
+    # from:
+    #   condition:
+    #     - if:
+    #         db_instances: 1
+    #       then: single
+    #     - elsif:
+    #         db_instances:
+    #           gt: 1
+    #       then: multi
+    #     - else: none
+    #
+    # Which is the same as:
+    # if $db_instances == 1
+    #   return "single"
+    # elsif $db_instances > 1
+    #   return "multi"
+    # else
+    #   return "none"
+    # end
+    #
+    # If you don't define an else, a null will be returned when no conditions match.
+    class Condition < Opto::Resolver
+
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      class HashCond
+        attr_reader :condition
+        attr_reader :result
+        attr_reader :group
+
+        def initialize(group, options={})
+          @group = group
+          if options.has_key?(:else)
+            @result = options[:else]
+            @else = true
+          elsif options.has_key?(:if) || options.has_key?(:elsif)
+            @condition = options[:if] || options[:elsif]
+            if options.has_key?(:then)
+              @result = options[:then]
+            else
+              raise ArgumentError, "Invalid condition definition: #{options.inspect} (no 'then')"
+            end
+            @else = false
+          else
+            raise ArgumentError, "Invalid condition definition: #{options.inspect} (no 'if', 'elsif' or 'else')"
+          end
+        end
+
+        def else?
+          @else
+        end
+
+        def true?
+          return true if else?
+          return true if group.all_true?(condition)
+          false
+        end
+      end
+
+      def resolve
+        raise TypeError, "An Array of Hashes expected" unless hint.kind_of?(Array)
+        raise TypeError, "An Array of Hashes expected" unless hint.all? {|h| h.kind_of?(Hash) }
+        raise TypeError, "Can't use condition resolver when option isn't a member of an option group" if option.group.nil?
+
+        conditions = hint.map {|h| HashCond.new(option.group, h) }
+
+        unless conditions.last.else?
+          conditions << HashCond.new(:else => nil)
+        end
+
+        matching_condition = conditions.find {|c| c.true? }
+        matching_condition.result
+      end
+    end
+  end
+end
+

data/lib/opto/version.rb

@@ -1,3 +1,3 @@
 module Opto
-  VERSION = "1.6.1"
+  VERSION = "1.7.0"
 end

data/opto.gemspec

@@ -9,6 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Kimmo Lehto"]
   spec.email         = ["info@kontena.io"]
 
+  spec.licenses      = ['Apache-2.0']
+
   spec.summary       = "Option validator / resolver"
   spec.description   = "Create validatable and resolvable options from hashes or YAML"
   spec.homepage      = "https://github.com/kontena/opto"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opto
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Kimmo Lehto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/opto/group.rb
 - lib/opto/option.rb
 - lib/opto/resolver.rb
+- lib/opto/resolvers/condition.rb
 - lib/opto/resolvers/default.rb
 - lib/opto/resolvers/environment_variable.rb
 - lib/opto/resolvers/evaluate.rb
@@ -92,7 +93,8 @@ files:
 - lib/opto/version.rb
 - opto.gemspec
 homepage: https://github.com/kontena/opto
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []