mayak 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11b0f5c9288055fd9f0ca907a38e257b06b78fdd0f4e1185fafa8beae4fdcc2
-  data.tar.gz: f49566c5b0d830610843288c56ae001513a72b34b5beb75a9cb764998c0e6abd
+  metadata.gz: e3b0f6dd0284a5fcb3319c3c809fac92a1f071115495ea492deee12687023413
+  data.tar.gz: d2ec0d4a48f29136f159553233b846f56d998f79852bfad962aee7ba6b09cfbb
 SHA512:
-  metadata.gz: b24805002d39350e5d6fa0f4b8bc501b6c576b34368bc90eca7af794f820f191e7c4e35c1487cb3083ddabd18e2dbb1929822801cd934eebeac298c4bb5d34d4
-  data.tar.gz: 87275eb153d98c62d264c20a51db6e99109ec519eb957fbf4728f3b0612686aa41f76f728090d332d72323d16e7a954751fb17ad23b1bf9bff3cf99eba20fef8
+  metadata.gz: ac0b20d7a23fab465f1fb460a0a5866a411c4c3874e557ceb82bca724af63f55cb7c0c582fa61c392362b72be01447851895f8b17cceb674a0874dfa91ab92aa
+  data.tar.gz: a1598a89492189ee4fc70b4cabc54898164ca6ddd9b23d00dc66c578c105180b02d3cc0245cfe71069fad75938e04eea60277cb6f7e722d8b005f14bd1cfaa71

data/README.md

@@ -30,4 +30,129 @@ Mayak consists from separate classes and interfaces as well as separate modules
 
 #### HTTP
 
-[Documentation](./lib/mayak/http/README.md)
+[Documentation](./lib/mayak/http/README.md)
+
+#### Miscellaneous
+
+##### Function
+In some situations Sorbet can not infer a type of proc passed:
+
+```ruby
+sig {
+  type_parameters(:A)
+    .params(blk: T.proc.params(arg0: T.type_parameter(:A)).returns(T.type_parameter(:A)))
+    .returns(T.proc.params(arg0: T.type_parameter(:A)).returns(T.type_parameter(:A)))
+}
+def proc_identity(&blk)
+  blk
+end
+
+T.reveal_type(proc_identity { |a| 10 })
+# This code is unreachable https://srb.help/7006
+# proc_identity { |a| 10 }
+```
+
+`Mayak::Fuction` allows explicitly define input and output types to help sorbet infer types:
+
+```ruby
+sig {
+  type_parameters(:A)
+    .params(
+      fn: Mayak::Function[T.type_parameter(:A), T.type_parameter(:A)])
+    .returns(Mayak::Function[T.type_parameter(:A), T.type_parameter(:A)])
+}
+def fn_identity(fn)
+  fn
+end
+
+T.reveal_type(
+  fn_identity(Mayak::Function[Integer, Integer].new { |a| a })
+)
+# Revealed type: Mayak::Function[Integer, Integer]
+```
+
+##### JSON
+
+`JSON` module provides a type alias to encode JSON type:
+
+```ruby
+JsonType = T.type_alias {
+  T.any(
+    T::Array[T.untyped],
+    T::Hash[T.untyped, T.untyped],
+    String,
+    Integer,
+    Float
+  )
+}
+```
+
+and methods to safely parse JSON:
+
+```ruby
+Mayak::Json.parse(%{ { "foo": 1} })
+#<Mayak::Monads::Try::Success:0x00000001086c8398 @value={"foo"=>1}>
+
+Mayak::Json.parse(%{ { "foo: 1} })
+#<Mayak::Monads::Try::Failure:0x00000001085ea250 @failure=#<Mayak::Json::ParsingError: unexpected token at '{ "foo: 1} '>>
+```
+
+##### Numeric
+
+`Numeric` method provides method for safe parsing numerical values:
+
+```ruby
+Mayak::Numeric.parse_float("0.1")
+#<Mayak::Monads::Maybe::Some:0x000000010bbb4070 @value=0.1>
+
+Mayak::Numeric.parse_float("0.1sdfs")
+#<Mayak::Monads::Maybe::None:0x000000010bab3e50>
+
+Mayak::Numeric.parse_integer("10")
+#<Mayak::Monads::Maybe::Some:0x0000000108fcdb78 @value=10>
+
+Mayak::Numeric.parse_integer("10qq")
+#<Mayak::Monads::Maybe::None:0x000000010bbf64c0>
+
+Mayak::Numeric.parse_decimal("100")
+#<Mayak::Monads::Maybe::Some:0x000000010ba78968 @value=0.1e3>
+
+Mayak::Numeric.parse_decimal("100dd")
+#<Mayak::Monads::Maybe::None:0x000000010bb718b0>
+```
+
+##### Random
+
+Utils for random number generating
+
+###### `#jittered`
+
+Adds random noise for a number within specified range
+
+```ruby
+# Yield a random number from 100 to 105
+Mayak::Random.jittered(100, jitter: 0.05)
+# 101.53359412200601
+
+Mayak::Random.jittered(100, jitter: 0.05)
+# 103.59043964431787
+```
+
+##### WeakRef
+
+Parameterized weak Reference class that allows a referenced object to be garbage-collected.
+
+```ruby
+class Obj
+end
+
+value = Obj.new
+value = Mayak::WeakRef[Obj].new(value)
+value.deref
+#<Mayak::Monads::Maybe::Some:0x0000000103e8fa90 @value=#<Obj:0x000000010721de48>>
+
+GC.start
+value.deref
+#<Mayak::Monads::Maybe::None:0x000000010715f6f0>
+# Not necessarily will be collected after only one GC cycle
+```

data/lib/mayak/json.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # typed: strict
 
+require "json"
+
 module Mayak
   module Json
     extend T::Sig

data/lib/mayak/numeric.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 # typed: strict
 
+require 'bigdecimal'
+
 module Mayak
   module Numeric
     extend T::Sig

data/lib/mayak/random.rb

@@ -9,7 +9,8 @@ module Mayak
 
     sig { params(number: T.any(Integer, Float), jitter: Float).returns(Float) }
     def self.jittered(number, jitter: DEFAULT_JITTER)
-      (number + Kernel.rand(number * jitter)).to_f
+      delta = Kernel.rand(0..(number * jitter))
+      (number + delta.to_f).to_f
     end
   end
 end

data/mayak.gemspec

@@ -4,7 +4,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "mayak"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.summary       = "Set of fully typed utility classes and interfaces integrated with Sorbet."
   spec.description   = spec.summary
   spec.authors       = ["Daniil Bober"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mayak
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniil Bober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime