dry-types-fear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7944142467a930e085d2cd0c17c6ac64074d1eae541fcc22df99d0378b112147
+  data.tar.gz: bc81b914b6676746a6710a1f0c2a1d4210b581ebceb8e58bac7222ee418ce974
+SHA512:
+  metadata.gz: b64be83062f40faf38229aa0bb3f358ce00f1c488ec525747eff16eab570bec03c57fb7a43297f2e643d262199be32bff92423a4dca41a45dc696ee3f1ee44b5
+  data.tar.gz: 899253ccf38c0f1aca5de14251a37e9e3b34abc3b30f69afbc42d233a02e0ec4e2142de51682e65b62ecd211704d66c72688bb417078a11f79dfcdd6319f16d9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2024 Tema Bolshakov
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,98 @@
+# Dry::Types::Fear
+
+`Dry::Types` integration with [fear] allows using `Fear::Option` as optional type for `Dry::Types`
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add dry-types-fear
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install dry-types-fear
+
+## Usage
+
+Load the `:fear_option` extension in your application.
+
+```ruby
+require 'dry-types'
+require 'dry/types/fear'
+
+Dry::Types.load_extensions(:fear_option)
+
+module Types
+  include Dry.Types()
+end
+```
+
+Append `.option` to a Type to return a `Fear::Option` object:
+
+```ruby
+Types::Option::Strict::Integer[nil] 
+#=> Fear.none
+Types::Option::Coercible::String[nil] 
+#=> Fear.none
+Types::Option::Strict::Integer[123] 
+#=> Fear.some(123)
+Types::Option::Strict::String[123]
+#=> Fear.some(123)
+Types::Option::Coercible::Float['12.3'] 
+#=> Fear.some(12.3)
+```
+
+'Option' types can also accessed by calling `.option` on a regular type:
+
+```ruby
+Types::Strict::Integer.option # equivalent to Types::Option::Strict::Integer
+```
+
+
+You can define your own optional types:
+
+```ruby
+option_string = Types::Strict::String.option
+option_string[nil]
+# => Fear.none
+option_string[nil].map(&:upcase)
+# => Fear.none
+option_string['something']
+# => Fear.some('something')
+option_string['something'].map(&:upcase)
+# => Fear.some('SOMETHING')
+option_string['something'].map(&:upcase).get_or_else { 'NOTHING' }
+# => "SOMETHING"
+```
+
+You can use it with dry-struct as well:
+
+```ruby
+class User < Dry::Struct
+  attribute :name, Types::Coercible::String
+  attribute :age,  Types::Coercible::Integer.option
+end
+
+user = User.new(name: 'Bob', age: nil)
+user.name #=> "Bob"
+user.age #=> Fear.none 
+
+user = User.new(name: 'Bob', age: 42)
+user.age #=> Fear.some(42) 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run 
+`rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will 
+allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, 
+update the version number in the gemspec, and then run `bundle exec rake release`, which will create a git 
+tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bolshakov/dry-types-fear.
+
+[fear]: https://github.com/bolshakov/fear

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/dry/types/fear/option.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Dry
+  module Types
+    class Option
+      include Type
+      include ::Dry::Equalizer(:type, :options, inspect: false, immutable: true)
+      include Decorator
+      include Builder
+      include Printable
+
+      # @param [Fear::Option, Object] input
+      #
+      # @return [Fear::Option]
+      #
+      # @api private
+      def call_unsafe(input = Undefined)
+        case input
+        when ::Fear::Option
+          input
+        when Undefined
+          Fear.none
+        else
+          Fear.option(type.call_unsafe(input))
+        end
+      end
+
+      # @param [Fear::Option, Object] input
+      #
+      # @return [Fear::Option]
+      #
+      # @api private
+      def call_safe(input = Undefined)
+        case input
+        when ::Fear::Option
+          input
+        when Undefined
+          Fear.none
+        else
+          Fear.option(type.call_safe(input) { |output = input| return yield(output) })
+        end
+      end
+
+      # @param [Object] input
+      #
+      # @return [Result::Success]
+      #
+      # @api public
+      def try(input = Undefined)
+        result = type.try(input)
+
+        if result.success?
+          Result::Success.new(Fear.option(result.input))
+        else
+          result
+        end
+      end
+
+      # @return [true]
+      #
+      # @api public
+      def default?
+        true
+      end
+
+      # @param [Object] value
+      #
+      # @see Dry::Types::Builder#default
+      #
+      # @raise [ArgumentError] if nil provided as default value
+      #
+      # @api public
+      def default(value)
+        raise ArgumentError, "nil cannot be used as a default of a maybe type" if value.nil?
+
+        super
+      end
+    end
+
+    module Builder
+      # Turn a type into a maybe type
+      #
+      # @return [Option]
+      #
+      # @api public
+      def option
+        Option.new(Types["nil"] | self)
+      end
+    end
+
+    # @api private
+    class Schema
+      class Key
+        # @api private
+        def option
+          __new__(type.option)
+        end
+      end
+    end
+
+    # @api private
+    class Printer
+      MAPPING[Option] = :visit_option
+
+      # @api private
+      def visit_option(maybe)
+        visit(maybe.type) do |type|
+          yield "Fear::Option<#{type}>"
+        end
+      end
+    end
+
+    # Register non-coercible maybe types
+    NON_NIL.each_key do |name|
+      register("option.strict.#{name}", self[name.to_s].option)
+    end
+
+    # Register coercible maybe types
+    COERCIBLE.each_key do |name|
+      register("option.coercible.#{name}", self["coercible.#{name}"].option)
+    end
+  end
+end

data/lib/dry/types/fear.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "dry/types"
+require "fear"
+
+Dry::Types.register_extension(:fear_option) do
+  require "dry/types/fear/option"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: dry-types-fear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tëma Bolshakov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fear
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gems enables you to use Fear::Option as optional type for Dry::Types
+email:
+- either.free@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dry/types/fear.rb
+- lib/dry/types/fear/option.rb
+homepage: https://github.com/bolshakov/dry-types-fear
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bolshakov/dry-types-fear
+  source_code_uri: https://github.com/bolshakov/dry-types-fear
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Dry::Types integration with Fear.
+test_files: []