not_nilable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13334576efbfe3d36a848151d4b41fde9a624b83748cbaad0e19f14c558eeb3e
+  data.tar.gz: 10af223a1f5f660b98e90d0a67aee35b3f6bc45e795a2f2a2bcd5642af24eb01
+SHA512:
+  metadata.gz: 225f3ca2c4a5d438466dc7359555c2f153582d59259168b111ccdfbebdaff285d9f713e2be867edf05eab1eb38b3c6bb35f56a3b53f52b5e1a4a91ddc30bfee2
+  data.tar.gz: 047ec5e9324c0c19bf062f6efdffc5e417bd7e9e474a114ff899f62eb81f4d1ac2dbaa31efc02bc5b9cc973c116a6a9721c4710b8327340388b2377b24864f19

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2026-05-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"not_nilable" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["i.tkomiya@gmail.com"](mailto:"i.tkomiya@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Takeshi KOMIYA
+
+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,41 @@
+# NotNilable
+
+A non-null assertion operator for Ruby. Adds `Object#not_nil!`, ported from TypeScript's `!` operator and inspired by [Crystal's `not_nil!`](https://crystal-lang.org/api/Object.html#not_nil!).
+
+When the receiver is anything but `nil`, `.not_nil!` returns the receiver unchanged. When it is `nil`, the method raises `NotNilable::NilAssertionError`. The bundled RBS signatures let [Steep](https://github.com/soutaro/steep) narrow `T?` to `T` at the type level.
+
+## Installation
+
+```bash
+bundle add not_nilable
+```
+
+## Usage
+
+```ruby
+require "not_nilable"
+
+"hello".not_nil!   # => "hello"
+42.not_nil!        # => 42
+
+nil.not_nil!
+# raises NotNilable::NilAssertionError: Nil assertion failed
+
+nil.not_nil!("user must be present")
+# raises NotNilable::NilAssertionError: user must be present
+```
+
+With RBS + Steep, the type is narrowed:
+
+```ruby
+val = ENV.fetch("HOME", nil)   # type: String?
+val.not_nil!.length            # narrowed to String — .length is OK
+```
+
+## Development
+
+After cloning the repo, run `bundle install`, then `bundle exec rake` to lint, run specs, and type-check.
+
+## License
+
+[MIT](LICENSE.txt).

data/lib/not_nilable/core_ext/nil_class.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class NilClass
+  # Raises +NotNilable::NilAssertionError+.
+  #
+  # This method asserts that the receiver is not +nil+. Since the receiver
+  # _is_ +nil+, the assertion fails and an exception is raised. An optional
+  # +message+ may be supplied to customize the exception message.
+  #
+  # @rbs message: String?
+  def not_nil!(message = nil) #: bot
+    raise NotNilable::NilAssertionError, message || "Nil assertion failed"
+  end
+end

data/lib/not_nilable/core_ext/object.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Object
+  # Returns +self+.
+  #
+  # This method asserts that the receiver is not +nil+. Since +Object+ is not
+  # +NilClass+, the assertion succeeds and +self+ is returned. The +message+
+  # parameter is accepted for API parity with +NilClass#not_nil!+ but is
+  # ignored.
+  #
+  # @rbs message: String?
+  def not_nil!(message = nil) #: self # rubocop:disable Lint/UnusedMethodArgument
+    self
+  end
+end

data/lib/not_nilable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NotNilable
+  VERSION = "1.0.0"
+end

data/lib/not_nilable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "not_nilable/version"
+
+module NotNilable
+  class NilAssertionError < StandardError
+  end
+end
+
+require_relative "not_nilable/core_ext/object"
+require_relative "not_nilable/core_ext/nil_class"

data/sig/not_nilable/core_ext/nil_class.rbs

@@ -0,0 +1,12 @@
+# Generated from lib/not_nilable/core_ext/nil_class.rb with RBS::Inline
+
+class NilClass
+  # Raises +NotNilable::NilAssertionError+.
+  #
+  # This method asserts that the receiver is not +nil+. Since the receiver
+  # _is_ +nil+, the assertion fails and an exception is raised. An optional
+  # +message+ may be supplied to customize the exception message.
+  #
+  # @rbs message: String?
+  def not_nil!: (?String? message) -> bot
+end

data/sig/not_nilable/core_ext/object.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/not_nilable/core_ext/object.rb with RBS::Inline
+
+class Object
+  # Returns +self+.
+  #
+  # This method asserts that the receiver is not +nil+. Since +Object+ is not
+  # +NilClass+, the assertion succeeds and +self+ is returned. The +message+
+  # parameter is accepted for API parity with +NilClass#not_nil!+ but is
+  # ignored.
+  #
+  # @rbs message: String?
+  def not_nil!: (?String? message) -> self
+end

data/sig/not_nilable/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/not_nilable/version.rb with RBS::Inline
+
+module NotNilable
+  VERSION: ::String
+end

data/sig/not_nilable.rbs

@@ -0,0 +1,6 @@
+# Generated from lib/not_nilable.rb with RBS::Inline
+
+module NotNilable
+  class NilAssertionError < StandardError
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: not_nilable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Takeshi KOMIYA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Ports TypeScript's non-null assertion `!` to Ruby as a method, inspired
+  by Crystal's `not_nil!`. The bundled RBS signatures let Steep narrow `T?` to `T`
+  at the type level.
+email:
+- i.tkomiya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/not_nilable.rb
+- lib/not_nilable/core_ext/nil_class.rb
+- lib/not_nilable/core_ext/object.rb
+- lib/not_nilable/version.rb
+- sig/not_nilable.rbs
+- sig/not_nilable/core_ext/nil_class.rbs
+- sig/not_nilable/core_ext/object.rbs
+- sig/not_nilable/version.rbs
+homepage: https://github.com/tk0miya/not_nilable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/tk0miya/not_nilable
+  changelog_uri: https://github.com/tk0miya/not_nilable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: 'A non-null assertion operator for Ruby: Object#not_nil!.'
+test_files: []