blankity 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96f50e260e8b3b183ecc3d40988238c571021514c813ae3e0032f76cf35744ac
-  data.tar.gz: fa48b5c00198840392e473b1cdd0904f96303bb4d52c6e81adc30355fec42d75
+  metadata.gz: 0a2474babea0e68bddb79670ae6b5680fd0b2be07677b502071d2d9a1abf4eea
+  data.tar.gz: 6898a094071b9dfa0bd62863ee9b64cf5823c664d84a77913597c999826e92e8
 SHA512:
-  metadata.gz: 3f4a1f1a834cc6b410cc9b27b805a62ed2bc3a9a9788669206e07f395e5e583db23c9541ca585ab982b4b94d5c051595b196b30692dea593b2ab6d5a5ed34e77
-  data.tar.gz: 92bfb06c6c8011f39f0d7bbf68d091df456ee43767c6f579bd912b03f3e5221e9071ff83dbc83bd8d1ae9cb3aa925e4a42ec267ff4ba28ff61fe06d902963afb
+  metadata.gz: b0ff3504d136935da61af9c623b4e09a6765c5cb865ce97ee0ef31d82f44b9355109c221ec68432e7c0a0d26db1ed56ca54066e9a2f40ee8fead43a3e1aec222
+  data.tar.gz: 98067d34173efe13142af36e399ee04ed95905924e4727995c1b0f09ded1cf679979fdca7b3718fbf03dffb574b6b6ff1e7f440b95cc2ce19b2fbc1ce0f6915f

data/lib/blankity/blank.rb

@@ -15,22 +15,26 @@ module Blankity
   # To make using +Blank+ easier, its constructor allows you to pass a +methods:+ keyword argument,
   # which will define singleton methods based on {Object}.
   class Blank < BasicObject
-    # Remove every public and protected method that we inherit, except for `__xyz__` methods
+    # Define top-level methods that are annoying to not have present.
+
+    # @rbs!
+    #   def __define_singleton_method__: (interned name, Method | UnboundMethod | Proc method) -> Symbol
+    #                                  | (interned name) { (?) [self: self] -> untyped } -> Symbol
+    #   def __instance_exec__: [T] (*untyped, **untyped) { (?) [self: self] -> T } -> T
+    define_method :__define_singleton_method__, ::Kernel.instance_method(:define_singleton_method)
+    alias_method :__instance_exec__, :instance_exec # Use `alias_method` instead of `alias` so rbs-inline won't pick it up
+
+    # Remove every other public and protected method that we inherit, except for `__xyz__` methods
     instance_methods.each do |name|
       undef_method(name) unless name.match?(/\A__.*__\z/)
     end
 
-    # Declare these as constants so we don't constantly look them up.
-    DEFINE_SINGLETON_METHOD = ::Object.instance_method(:define_singleton_method) #: UnboundMethod
-    INSTANCE_EXEC = ::Object.instance_method(:instance_exec) #: UnboundMethod
-    private_constant :DEFINE_SINGLETON_METHOD, :INSTANCE_EXEC
-
     # 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
     #                    type can be used as a key in +Hash+es
-    # @yield [] if a block is given, runs it via +instance_exec+.
+    # @yield [] if a block is given, runs it via +__instance_exec__+.
     #
     # === Example
     #   # Make a empty instance
@@ -48,35 +52,12 @@ module Blankity
       methods |= %i[hash eql?] if hash
 
       # Define any object methods requested by the end-user
-      __define_Object_methods__(*methods)
-
-      # If a block's provided, then `instance_exec`
-      INSTANCE_EXEC.bind_call(self, &__any__ = block) if block
-    end
-
-    # A helper method to define {Object} instance methods on +self+
-    #
-    # @param methods [*interned] The list of instance methods from {Object} to define
-    # @return [self]
-    #
-    # === Example
-    #   # Make an empty instance
-    #   blank = Blankity::Blank.blank
-    #
-    #   # Make sure it's printable
-    #   blank.__define_Object_methods__(:inspect, :==)
-    #
-    #   # Now you can use them!
-    #   fail unless blank == blank
-    #   p blank
-    #
-    # @rbs (*interned) -> self
-    def __define_Object_methods__(*methods)
       methods.each do |method|
-        DEFINE_SINGLETON_METHOD.bind_call(self, method, ::Object.instance_method(method).bind(self))
+        __define_singleton_method__(method, ::Object.instance_method(method).bind(self))
       end
 
-      self
+      # If a block's provided, then `instance_exec`
+      __instance_exec__(&__any__ = block) if block
     end
   end
 

data/lib/blankity/to.rb

@@ -2,7 +2,27 @@
 # rbs_inline: enabled
 
 module Blankity
+  # Convenience methods for creating new +BlankIty::ToXXX+ instances.
+  #
+  # Using +To+ as a mixin (via +extend+ / +include+ / +prepend+) isn't suggested, as {Kernel#proc}
+  # and {Kernel#hash} will be overwritten. Attempting to do so will emit a warning if `$VERBOSE` is
+  # enabled.
   module To
+    # Warn when including +To+
+    def self.included(mod)
+      $VERBOSE and warn 'including Blankity::To overwrites Kernel#proc and Kernel#hash', uplevel: 1
+    end
+
+    # Warn when extending +To+
+    def self.extended(mod)
+      $VERBOSE and warn 'extending Blankity::To overwrites Kernel#proc and Kernel#hash', uplevel: 1
+    end
+
+    # Warn when prepending +To+
+    def self.prepended(mod)
+      $VERBOSE and warn 'prepending Blankity::To overwrites Kernel#proc and Kernel#hash', uplevel: 1
+    end
+
     module_function
 
     # Convenience method to make {ToI}s from +value.to_i+
@@ -111,7 +131,7 @@ module Blankity
     #
     # @rbs (_ToProc, ?methods: Array[interned], ?hash: bool) ?{ () [self: ToProc] -> void } -> ToProc
     #    | (?methods: Array[interned], ?hash: bool) { (?) -> untyped } -> ToProc
-    def proc(proc = nil, **, &block)
+    def self.proc(proc = nil, **, &block)
       if proc
         ToProc.new(proc.to_proc, **, &block)
       elsif !block_given?
@@ -129,3 +149,4 @@ module Blankity
     end
   end
 end
+

data/lib/blankity/version.rb

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

data/sig/generated/blankity/blank.rbs

@@ -14,17 +14,17 @@ module Blankity
   # To make using +Blank+ easier, its constructor allows you to pass a +methods:+ keyword argument,
   # which will define singleton methods based on {Object}.
   class Blank < BasicObject
-    # Declare these as constants so we don't constantly look them up.
-    DEFINE_SINGLETON_METHOD: UnboundMethod
+    def __define_singleton_method__: (interned name, Method | UnboundMethod | Proc method) -> Symbol
+                                   | (interned name) { (?) [self: self] -> untyped } -> Symbol
 
-    INSTANCE_EXEC: UnboundMethod
+    def __instance_exec__: [T] (*untyped, **untyped) { (?) [self: self] -> T } -> T
 
     # 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
     #                    type can be used as a key in +Hash+es
-    # @yield [] if a block is given, runs it via +instance_exec+.
+    # @yield [] if a block is given, runs it via +__instance_exec__+.
     #
     # === Example
     #   # Make a empty instance
@@ -38,25 +38,6 @@ module Blankity
     #
     # @rbs (?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
     def initialize: (?methods: Array[interned], ?hash: bool) ?{ () [self: instance] -> void } -> void
-
-    # A helper method to define {Object} instance methods on +self+
-    #
-    # @param methods [*interned] The list of instance methods from {Object} to define
-    # @return [self]
-    #
-    # === Example
-    #   # Make an empty instance
-    #   blank = Blankity::Blank.blank
-    #
-    #   # Make sure it's printable
-    #   blank.__define_Object_methods__(:inspect, :==)
-    #
-    #   # Now you can use them!
-    #   fail unless blank == blank
-    #   p blank
-    #
-    # @rbs (*interned) -> self
-    def __define_Object_methods__: (*interned) -> self
   end
 
   # Shorthand constructor {Blankity::Blank}.

data/sig/generated/blankity/to.rbs

@@ -1,7 +1,21 @@
 # Generated from lib/blankity/to.rb with RBS::Inline
 
 module Blankity
+  # Convenience methods for creating new +BlankIty::ToXXX+ instances.
+  #
+  # Using +To+ as a mixin (via +extend+ / +include+ / +prepend+) isn't suggested, as {Kernel#proc}
+  # and {Kernel#hash} will be overwritten. Attempting to do so will emit a warning if `$VERBOSE` is
+  # enabled.
   module To
+    # Warn when including +To+
+    def self.included: (untyped mod) -> untyped
+
+    # Warn when extending +To+
+    def self.extended: (untyped mod) -> untyped
+
+    # Warn when prepending +To+
+    def self.prepended: (untyped mod) -> untyped
+
     # Convenience method to make {ToI}s from +value.to_i+
     #
     # @rbs (_ToI, ?methods: Array[interned], ?hash: bool) ?{ () [self: ToI] -> void } -> ToI

data/sig/test/test/test_blank.rbs

@@ -16,6 +16,4 @@ class TestBlankity_Top < Minitest::Test
   def test_initialize_with_block: () -> untyped
 
   def test_initialize_with_block_is_run_after_methods: () -> untyped
-
-  def test___define_Object_methods__: () -> untyped
 end

metadata

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