mutex_m 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88572cf91c2e6eb6f9c5152967666b5253a2edad27a0a3a97fd06515f85de11f
-  data.tar.gz: 0c1bb10f5fc6fcf7dc30721aae8d9b70e4cbb74f92286a86bb3af0a1e5e6041a
+  metadata.gz: d1d54bf09d34079f64d7745f1f13ede292635a314d6e30bdef7ddea3d2b3d855
+  data.tar.gz: d7f4478cce1952483631888a054636dfe0d8e26675057530b2cffeb66df19ead
 SHA512:
-  metadata.gz: a879eccfb2a6acd4997fac6fc3d2217129a405363d0442ad4274ec917106ecfa0c4221fa9d13c1e965c5c1ecd9e77b38f883d4fc59659575c33095dba7800912
-  data.tar.gz: 690a40841f4e9fc43ae58f4750a30ecabc173e2416d3bb0cdd070377d0025e8a83fc5c762d0a6c43aeaae048382fe789874c7d77ad8d697063aca0090f744eaf
+  metadata.gz: b39170d0f5349bf8616bd67216e6c0288588d41f7b4f276c8940406e5004e39f657d427cc1a236bdaecf3ad3086795302234ed0fe8db87c4caa471166179ad77
+  data.tar.gz: c63393f5facdcebf2bf07d7df6e1be0a566fd10e54009ac2dc50cd5baf857a1561dd5a908d3c15be13d512e93803e72605348faa0e0db19fd4231136bc1aa721

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/README.md

@@ -34,10 +34,12 @@ obj.extend Mutex_m
 ```
 
 Or mixin Mutex_m into your module to your class inherit Mutex instance methods.
+You should probably use `prepend` to mixin (if you use `include`, you need to
+make sure that you call `super` inside `initialize`).
 
 ```ruby
 class Foo
-  include Mutex_m
+  prepend Mutex_m
   # ...
 end
 

data/lib/mutex_m.rb

@@ -17,7 +17,7 @@
 #
 # Start by requiring the standard library Mutex_m:
 #
-#   require "mutex_m.rb"
+#   require "mutex_m"
 #
 # From here you can extend an object with Mutex instance methods:
 #
@@ -40,7 +40,7 @@
 #
 module Mutex_m
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   Ractor.make_shareable(VERSION) if defined?(Ractor)
 
   def Mutex_m.define_aliases(cl) # :nodoc:
@@ -51,6 +51,11 @@ module Mutex_m
     cl.alias_method(:synchronize, :mu_synchronize)
   end
 
+  def Mutex_m.prepend_features(cl) # :nodoc:
+    super
+    define_aliases(cl) unless cl.instance_of?(Module)
+  end
+
   def Mutex_m.append_features(cl) # :nodoc:
     super
     define_aliases(cl) unless cl.instance_of?(Module)

data/sig/mutex_m.rbs

@@ -0,0 +1,99 @@
+# # mutex_m.rb
+#
+# When 'mutex_m' is required, any object that extends or includes Mutex_m will
+# be treated like a Mutex.
+#
+# Start by requiring the standard library Mutex_m:
+#
+#     require "mutex_m"
+#
+# From here you can extend an object with Mutex instance methods:
+#
+#     obj = Object.new
+#     obj.extend Mutex_m
+#
+# Or mixin Mutex_m into your module to your class inherit Mutex instance methods
+# --- remember to call super() in your class initialize method.
+#
+#     class Foo
+#       include Mutex_m
+#       def initialize
+#         # ...
+#         super()
+#       end
+#       # ...
+#     end
+#     obj = Foo.new
+#     # this obj can be handled like Mutex
+#
+module Mutex_m
+  def self.append_features: (Module cl) -> untyped
+
+  def self.define_aliases: (Module cl) -> untyped
+
+  def self.extend_object: (Object obj) -> untyped
+
+  public
+
+  def mu_extended: () -> untyped
+
+  # <!--
+  #   - mu_lock()
+  # -->
+  # See Thread::Mutex#lock
+  #
+  def mu_lock: () -> Thread::Mutex
+
+  # <!--
+  #   - mu_locked?()
+  # -->
+  # See Thread::Mutex#locked?
+  #
+  def mu_locked?: () -> bool
+
+  # <!--
+  #   - mu_synchronize(&block)
+  # -->
+  # See Thread::Mutex#synchronize
+  #
+  def mu_synchronize: [T] () { () -> T } -> T
+
+  # <!--
+  #   - mu_try_lock()
+  # -->
+  # See Thread::Mutex#try_lock
+  #
+  def mu_try_lock: () -> bool
+
+  # <!--
+  #   - mu_unlock()
+  # -->
+  # See Thread::Mutex#unlock
+  #
+  def mu_unlock: () -> Thread::Mutex
+
+  # <!--
+  #   - sleep(timeout = nil)
+  # -->
+  # See Thread::Mutex#sleep
+  #
+  def sleep: (?Numeric timeout) -> Integer?
+
+  alias locked? mu_locked?
+
+  alias lock mu_lock
+
+  alias unlock mu_unlock
+
+  alias try_lock mu_try_lock
+
+  alias synchronize mu_synchronize
+
+  private
+
+  def initialize: (*untyped args) -> untyped
+
+  def mu_initialize: () -> untyped
+end
+
+Mutex_m::VERSION: String

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mutex_m
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keiju ISHITSUKA
-autorequire:
-bindir: exe
+autorequire: 
+bindir: bin
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies: []
 description: Mixin to extend objects to be handled like a Mutex.
 email:
 - keiju@ruby-lang.org
@@ -59,18 +17,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- LICENSE.txt
+- BSDL
+- COPYING
 - README.md
-- Rakefile
 - lib/mutex_m.rb
-- mutex_m.gemspec
+- sig/mutex_m.rbs
 homepage: https://github.com/ruby/mutex_m
 licenses:
 - Ruby
 - BSD-2-Clause
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/ruby/mutex_m
+  bug_tracker_uri: https://github.com/ruby/mutex_m/issues
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Mixin to extend objects to be handled like a Mutex.
 test_files: []

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-task :default => :test

data/mutex_m.gemspec

@@ -1,28 +0,0 @@
-begin
-  require_relative "lib/mutex_m"
-rescue LoadError
-  # for Ruby core repository
-  require_relative "mutex_m"
-end
-
-Gem::Specification.new do |spec|
-  spec.name          = "mutex_m"
-  spec.version       = Mutex_m::VERSION
-  spec.authors       = ["Keiju ISHITSUKA"]
-  spec.email         = ["keiju@ruby-lang.org"]
-
-  spec.summary       = %q{Mixin to extend objects to be handled like a Mutex.}
-  spec.description   = %q{Mixin to extend objects to be handled like a Mutex.}
-  spec.homepage      = "https://github.com/ruby/mutex_m"
-  spec.licenses      = ["Ruby", "BSD-2-Clause"]
-
-  spec.files         = ["Gemfile", "LICENSE.txt", "README.md", "Rakefile", "lib/mutex_m.rb", "mutex_m.gemspec"]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.5'
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "test-unit"
-end