blankity 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a2474babea0e68bddb79670ae6b5680fd0b2be07677b502071d2d9a1abf4eea
-  data.tar.gz: 6898a094071b9dfa0bd62863ee9b64cf5823c664d84a77913597c999826e92e8
+  metadata.gz: 77c386d3e2995f2bd9b923e9454b6ea7eee52ab56b0bee93365c38cf3c0c7116
+  data.tar.gz: b590b899c896efe9d843ee456517a30822e85220a89e8ae890fba831975159fd
 SHA512:
-  metadata.gz: b0ff3504d136935da61af9c623b4e09a6765c5cb865ce97ee0ef31d82f44b9355109c221ec68432e7c0a0d26db1ed56ca54066e9a2f40ee8fead43a3e1aec222
-  data.tar.gz: 98067d34173efe13142af36e399ee04ed95905924e4727995c1b0f09ded1cf679979fdca7b3718fbf03dffb574b6b6ff1e7f440b95cc2ce19b2fbc1ce0f6915f
+  metadata.gz: 614a8f62d477bac3d9809ac2e37201242fe34bca08693af20dd5089f6be99e5b1ef336971e31a0e3c02f355aa572420353288d747767a8f9ae2aa431e62ee6a0
+  data.tar.gz: 3044675608037373cb1d7ff3ff9ee40729289e0d68b3c170cdb8c5302013b70844d556fc359be50281598f598d5afa8b02c713d011b224c1cbcaeefae9b2b773

data/README.md

@@ -24,7 +24,7 @@ p defined?(blank.==)      #=> nil
 p defined?(blank.inspect) #=> nil
 
 # Include specific `Object` methods:
-blank = Blankity::Blank.new(methods: [:==])
+blank = Blankity::Blank.new(with: [:==])
 p blank == blank #=> true
 
 # Also supports blocks, which are `instance_exec`ed

data/lib/blankity/blank.rb

@@ -12,7 +12,7 @@ module Blankity
   # - Private methods are not undefined, as each one of them is expected to be present (most of them
   #   are hooks, eg +singleton_method_added+), and aren't easily accessible from external classes.
   #
-  # To make using +Blank+ easier, its constructor allows you to pass a +methods:+ keyword argument,
+  # To make using +Blank+ easier, its constructor allows you to pass a +with:+ keyword argument,
   # which will define singleton methods based on {Object}.
   class Blank < BasicObject
     # Define top-level methods that are annoying to not have present.
@@ -29,10 +29,15 @@ module Blankity
       undef_method(name) unless name.match?(/\A__.*__\z/)
     end
 
+    class << self
+      # Alias for `new`
+      alias blank new
+    end
+
     # Creates a new {BlankValue}, and defining singleton methods depending on the parameters
     #
-    # @param methods [Array[interned]] a list of {Object} methods to define on +self+.
-    # @param hash [bool] convenience argument, adds +hash+ and +eql?+ to +methods+ so the resulting
+    # @param with [Array[interned]] a list of {Object} methods to define on +self+.
+    # @param hash [bool] convenience argument, adds +hash+ and +eql?+ to +with+ so the resulting
     #                    type can be used as a key in +Hash+es
     # @yield [] if a block is given, runs it via +__instance_exec__+.
     #
@@ -41,18 +46,18 @@ module Blankity
     #   Blankity::Blank.new
     #
     #   # Include `Object#inspect`, so we can print with `p`
-    #   p Blankity::Blank.new(methods: %i[inspect])
+    #   p Blankity::Blank.new(with: %i[inspect])
     #
     #   # Define a singleton method
     #   p Blankity::Blank.new{ def cool?(other) = other == 3 }.cool?(3) #=> true
     #
-    # @rbs (?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
-    def initialize(methods: [], hash: false, &block)
+    # @rbs (?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    def initialize(with: [], hash: false, &block)
       # If `hash` is supplied, then add `hash` and `eql?` to the list of methods to define
-      methods |= %i[hash eql?] if hash
+      with |= %i[hash eql?] if hash
 
       # Define any object methods requested by the end-user
-      methods.each do |method|
+      with.each do |method|
         __define_singleton_method__(method, ::Object.instance_method(method).bind(self))
       end
 
@@ -60,9 +65,4 @@ module Blankity
       __instance_exec__(&__any__ = block) if block
     end
   end
-
-  # Shorthand constructor {Blankity::Blank}.
-  #
-  # @rbs (?methods: Array[interned], ?hash: bool) ?{ () [self: Blank] -> void } -> Blank
-  def self.blank(...) = Blank.new(...)
 end

data/lib/blankity/classes.rb

@@ -8,7 +8,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Integer, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Integer, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -24,7 +24,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Integer, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Integer, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -40,7 +40,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (String, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (String, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -56,7 +56,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (String, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (String, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -74,7 +74,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Array[T], ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Array[T], ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -92,7 +92,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Array[T], ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Array[T], ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -111,7 +111,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Hash[K, V], ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Hash[K, V], ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -130,7 +130,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Hash[K, V], ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Hash[K, V], ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -146,7 +146,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Symbol, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Symbol, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -162,7 +162,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Rational, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Rational, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -178,7 +178,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Complex, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Complex, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -194,7 +194,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Float, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Float, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -210,7 +210,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Regexp, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Regexp, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -226,7 +226,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (String, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (String, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -242,7 +242,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (IO, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (IO, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -258,7 +258,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (Proc, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (Proc, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(value, ...)
       @__value__ = value
       super(...)
@@ -279,7 +279,7 @@ module Blankity
 
     # Creates a new instance; any additional arguments or block are passed to {Blank#initialize}.
     #
-    # @rbs (T?, T?, ?bool, ?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
+    # @rbs (T?, T?, ?bool, ?with: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize(begin_, end_, exclude_end = false, ...)
       @__begin__ = begin_
       @__end__ = end_

data/lib/blankity/version.rb

@@ -2,5 +2,5 @@
 # rbs_inline: enabled
 
 module Blankity
-  VERSION = '0.9.3'
+  VERSION = '0.10.0'
 end

data/lib/blankity.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 # rbs_inline: enabled
 
-module Blankity; end
+module Blankity
+  # Shorthand constructor {Blankity::Blank}.
+  #
+  # @rbs (?with: Array[interned], ?hash: bool) ?{ () [self: Blank] -> void } -> Blank
+  def self.blank(...) = Blank.new(...)
+end
 
 require_relative 'blankity/version'
 require_relative 'blankity/top'

data/sig/generated/blankity/blank.rbs

@@ -19,6 +19,8 @@ module Blankity
 
     def __instance_exec__: [T] (*untyped, **untyped) { (?) [self: self] -> T } -> T
 
+    alias self.blank self.new
+
     # Creates a new {BlankValue}, and defining singleton methods depending on the parameters
     #
     # @param methods [Array[interned]] a list of {Object} methods to define on +self+.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blankity
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Sam Westerman