opto 1.4.0

data/lib/opto/types/boolean.rb

@@ -0,0 +1,57 @@
+require_relative '../type'
+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 Types
+    # A boolean value.
+    #
+    # Options:
+    #   :truthy an array of strings / values that are converted to True.
+    #   :nil_is by default false
+    #   :blank_is by default false too
+    #   :as by default outputs a string. integer outputs a number, true_or_nil outputs true or nil. set to nil to just output whatever is in :true and :false
+    #   :true says "true" by default when outputting a string
+    #   :false says "false" by default when outputting a string
+    class Boolean < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      OPTIONS = {
+        truthy: ['true', 'yes', '1', 'on', 'enabled', 'enable'],
+        nil_is: false,
+        blank_is: false,
+        false: 'false',
+        true: 'true',
+        as: 'string'
+      }
+
+      sanitizer :to_bool do |value|
+        if value.nil?
+          options[:nil_is]
+        elsif value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
+          value
+        elsif value.to_s.strip == ''
+          options[:blank_is]
+        else
+          options[:truthy].include?(value.to_s.strip.downcase)
+        end
+      end
+
+      sanitizer :output do |value|
+        case options[:as].to_s.strip.downcase
+        when 'integer'
+          value ? (options[:true].kind_of?(Fixnum) ? options[:true] : 1) : (options[:false].kind_of?(Fixnum) ? options[:false] : 0)
+        when 'boolean'
+          value
+        else
+          value ? options[:true] : options[:false]
+        end
+      end
+    end
+  end
+end

data/lib/opto/types/enum.rb

@@ -0,0 +1,107 @@
+require_relative '../type'
+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 Types
+    # A list of possible values
+    #
+    # :options  - a list of possible values for this enum
+    # :can_be_other - set to true if the value can be outside of the value list in options
+    # :in - when "can be other" is defined, this can be used to define an extra set of possible values
+    #
+    # @example Shorthand option list
+    #   Opto::Option.new(
+    #     name: 'foo',
+    #     type: 'enum',
+    #     options: 
+    #       - foo
+    #       - bar
+    #       - cat
+    #     can_be_other: true
+    #   )
+    #
+    # @example Detailed option list
+    #   Opto::Option.new(
+    #     name: 'foo',
+    #     type: 'enum',
+    #     options:
+    #       - value: cat
+    #         label: Cat
+    #         description: A four legged ball of fur
+    #       - value: dog
+    #         label: Dog
+    #         description: A friendly furry creature with a tail, says 'woof'
+    #   )
+    class Enum < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      OPTIONS = {
+        options: [],
+        can_be_other: false,
+        in: []
+      }
+
+      def initialize(options={})
+        opts = normalize_opts(options.delete(:options))
+        super(options)
+        @options[:options] = opts
+      end
+
+      validator :options do |value|
+        if options[:options].nil? || options[:options].empty?
+          raise RuntimeError, "No options defined for enum"
+        elsif options[:options].map {|o| o[:value]}.uniq.size != options[:options].size
+          raise RuntimeError, "Duplicate values in enum option list"
+        end
+      end
+
+      validator :in do |value|
+        return nil if options[:can_be_other]
+        if options[:in] && !options[:in].empty?
+          "Value is not one of #{options[:in].join(', ')}" unless options[:in].include?(value)
+        else
+          "Value is not one of the options" unless options[:options].map { |o| o[:value] }.include?(value)
+        end
+      end
+
+      def normalize_opts(options)
+        case options
+        when Hash
+          options.each_with_object([]) do |(key, value), array|
+            array << { value: key, label: key, description: value }
+          end
+        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" 
+              end
+            end
+            options
+          when ::String, Fixnum
+            options.map do |opt|
+              { value: opt, description: opt, label: opt }
+            end
+          when NilClass
+            []
+          else
+            raise TypeError, "Invalid format for enum option list definition"
+          end
+        when NilClass
+          []
+        else
+          raise TypeError, "Invalid format for enum option list definition"
+        end
+      end
+    end
+  end
+end
+
+

data/lib/opto/types/integer.rb

@@ -0,0 +1,47 @@
+require_relative '../type'
+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 Types
+    # A number.
+    #
+    # Options
+    #   :min - minimum allowed value (default 0, can be negative)
+    #   :max - maximum allowed value
+    #   :nil_is_zero : set to true if you want to turn a null value into 0
+    class Integer < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      OPTIONS = {
+        min: 0,
+        max: nil,
+        nil_is_zero: false
+      }
+
+      sanitizer :to_i do |value|
+        value.nil? ? (options[:nil_is_zero] ? 0 : nil) : value.to_i
+      end
+
+      validator :min do |value|
+        return nil if value.nil?
+        if options[:min] && value < options[:min]
+          "Too small. Minimum value is #{options[:min_length]}, Value is #{value}."
+        end
+      end
+
+      validator :max do |value|
+        return nil if value.nil?
+        if options[:max] && value > options[:max]
+          "Too large. Maximum value is #{options[:max]}, Value is #{value}."
+        end
+      end
+    end
+  end
+end
+

data/lib/opto/types/string.rb

@@ -0,0 +1,71 @@
+require_relative '../type'
+require 'base64'
+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 Types
+    # A string
+    #
+    # Options:
+    #   - min_length: minimum lenght
+    #   - max_length: maximum length
+    #   - empty_is_nil: an empty string will be replaced with nil
+    #   - encode_64: set to true if you want the final value to be base64 encoded representation
+    #   - decode_64: set to true if your string is in base64 and you want to convert to plain text
+    #   - upcase: set to true to upcase the string
+    #   - downcase: set to true to downcase the string
+    #   - strip: set to true to remove leading and trailing whitespace
+    #   - chomp: set to true to remove trailing linefeed
+    #   - capitalize: set to true to upcase the first letter
+    class String < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      TRANSFORMATIONS = [ :upcase, :downcase, :strip, :chomp, :capitalize ]
+
+      OPTIONS = {
+        min_length: nil,
+        max_length: nil,
+        empty_is_nil: true,
+        encode_64: false,
+        decode_64: false
+      }.merge(Hash[*TRANSFORMATIONS.flat_map {|tr| [tr, false]}])
+
+
+      sanitizer :encode_64 do |value|
+        (options[:encode_64] && value) ? Base64.encode64(value) : value
+      end
+
+      sanitizer :decode_64 do |value|
+        (options[:decode_64] && value) ? Base64.decode64(value) : value
+      end
+
+      TRANSFORMATIONS.each do |transform|
+        sanitizer transform do |value|
+          (options[transform] && value.respond_to?(transform)) ? value.send(transform) : value
+        end
+      end
+
+      sanitizer :empty_is_nil do |value|
+        (options[:empty_is_nil] && value.to_s.strip.empty?) ? nil : value.to_s
+      end
+
+      validator :min_length do |value|
+        if options[:min_length] && value.length < options[:min_length]
+          "Too short. Minimum length is #{options[:min_length]}, length is #{value.length}."
+        end
+      end
+
+      validator :max_length do |value|
+        if options[:max_length] && value.length > options[:max_length]
+          "Too long. Maximum length is #{options[:max_length]}, length is #{value.length}."
+        end
+      end
+    end
+  end
+end

data/lib/opto/types/uri.rb

@@ -0,0 +1,36 @@
+require_relative '../type'
+require 'uri'
+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 Types
+    # An uri/url.
+    #
+    # Options:
+    #   schemes: an array of allowed schemes, such as ['http', 'https', 'file']
+    class Uri < Opto::Type
+      using Opto::Extension::HashStringOrSymbolKey unless RUBY_VERSION < '2.1'
+
+      OPTIONS = {
+        schemes: [ 'http', 'https' ]
+      }
+
+      validator :scheme do |value|
+        return nil if options[:schemes].nil? || options[:schemes].empty?
+        scheme = uri(value).scheme
+        return nil if options[:schemes].include?(scheme)
+        "Uri scheme '#{scheme}' not allowed, allowed schemes: #{options[:schemes].join(', ')}"
+      end
+
+      def uri(value)
+        URI.parse(value)
+      end
+    end
+  end
+end

data/lib/opto/version.rb

@@ -0,0 +1,3 @@
+module Opto
+  VERSION = "1.4.0"
+end

data/opto.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opto"
+  spec.version       = Opto::VERSION
+  spec.authors       = ["Kimmo Lehto"]
+  spec.email         = ["info@kontena.io"]
+
+  spec.summary       = "Create validatable and resolvable options from hashes"
+  spec.description   = "Example: Opto.new(type: :string, name: 'foo, min_length: 20, from: { env: 'FOO' }).value"
+  spec.homepage      = "https://github.com/kontena/opto"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: opto
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Kimmo Lehto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Example: Opto.new(type: :string, name: ''foo, min_length: 20, from:
+  { env: ''FOO'' }).value'
+email:
+- info@kontena.io
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opto.rb
+- lib/opto/extensions/hash_string_or_symbol_key.rb
+- lib/opto/extensions/snake_case.rb
+- lib/opto/group.rb
+- lib/opto/option.rb
+- lib/opto/resolver.rb
+- lib/opto/resolvers/default.rb
+- lib/opto/resolvers/environment_variable.rb
+- lib/opto/resolvers/file_content.rb
+- lib/opto/resolvers/random_number.rb
+- lib/opto/resolvers/random_string.rb
+- lib/opto/resolvers/random_uuid.rb
+- lib/opto/setter.rb
+- lib/opto/setters/environment_variable.rb
+- lib/opto/type.rb
+- lib/opto/types/boolean.rb
+- lib/opto/types/enum.rb
+- lib/opto/types/integer.rb
+- lib/opto/types/string.rb
+- lib/opto/types/uri.rb
+- lib/opto/version.rb
+- opto.gemspec
+homepage: https://github.com/kontena/opto
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Create validatable and resolvable options from hashes
+test_files: []