atomic-ruby 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +5 -0
  3. data/CODE_OF_CONDUCT.md +132 -0
  4. data/LICENSE.txt +21 -0
  5. data/README.md +56 -0
  6. data/atomic-ruby.gemspec +22 -0
  7. data/ext/atomic_ruby/atomic_ruby.c +80 -0
  8. data/ext/atomic_ruby/atomic_ruby.h +7 -0
  9. data/ext/atomic_ruby/extconf.rb +10 -0
  10. data/lib/atomic-ruby/atom.rb +9 -0
  11. data/lib/atomic-ruby/atomic_ruby.bundle +0 -0
  12. data/lib/atomic-ruby/version.rb +5 -0
  13. data/lib/atomic-ruby.rb +9 -0
  14. metadata +54 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a3ca7bf11c2aa032352d7be8554faf13818bf1e982514ff60761779e2ec1283d
4
+ data.tar.gz: 0b1965ea3c65e62d3c824e56ab673fc3e33f73f0283a39355aaf285f65a71b16
5
+ SHA512:
6
+ metadata.gz: 9396b5a3a334cb5d89a17a09d59bf27ce1742b8d49720dae2c056a643ca1e0c5d32bbfded745c5557fd01b5fc420beaef3936540633adf090890f5b5a6a9b6c0
7
+ data.tar.gz: 022cec086bc16c8b5437d42c9053c7fb2eca0484aea0e5d66221a292367efaebc0d4c30dbe12ad4d640f5751d7f4e9f9a3f90445c45aef58548d56d6e152c64e
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2025-06-06
4
+
5
+ - Initial release
data/CODE_OF_CONDUCT.md ADDED
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 Joshua Young
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,56 @@
1
+ # AtomicRuby
2
+
3
+ Atomic primitives for Ruby.
4
+
5
+ ## Installation
6
+
7
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
8
+
9
+ Install the gem and add to the application's Gemfile by executing:
10
+
11
+ ```bash
12
+ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
13
+ ```
14
+
15
+ If bundler is not being used to manage dependencies, install the gem by executing:
16
+
17
+ ```bash
18
+ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ require "atomic-ruby"
25
+
26
+ atom = AtomicRuby::Atom.new(0)
27
+ puts atom.value # => 0
28
+ atom.swap { |current| current + 1 }
29
+ puts atom.value # => 1
30
+ atom.swap { |current| current + 1 }
31
+ puts atom.value # => 2
32
+ ```
33
+
34
+ ## Development
35
+
36
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.
37
+ You can also run `bin/console` for an interactive prompt that will allow you to experiment.
38
+
39
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
40
+ version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
41
+ push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
42
+
43
+ ## Contributing
44
+
45
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[joshuay03]/atomic-ruby. This project is
46
+ intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
47
+ [code of conduct](https://github.com/[joshuay03]/atomic-ruby/blob/main/CODE_OF_CONDUCT.md).
48
+
49
+ ## License
50
+
51
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
52
+
53
+ ## Code of Conduct
54
+
55
+ Everyone interacting in the AtomicRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to
56
+ follow the [code of conduct](https://github.com/[joshuay03]/atomic-ruby/blob/main/CODE_OF_CONDUCT.md).
data/atomic-ruby.gemspec ADDED
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/atomic-ruby/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "atomic-ruby"
7
+ spec.version = AtomicRuby::VERSION
8
+ spec.authors = ["Joshua Young"]
9
+ spec.email = ["djry1999@gmail.com"]
10
+
11
+ spec.summary = "Atomic primitives for Ruby"
12
+ spec.homepage = "https://github.com/joshuay03/atomic-ruby"
13
+ spec.license = "MIT"
14
+ spec.required_ruby_version = ">= 3.2.0"
15
+
16
+ spec.metadata["source_code_uri"] = spec.homepage
17
+ spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
18
+
19
+ spec.files = Dir["lib/**/*", "ext/**/*", "**/*.{gemspec,md,txt}"]
20
+ spec.require_paths = ["lib"]
21
+ spec.extensions = ["ext/atomic_ruby/extconf.rb"]
22
+ end
data/ext/atomic_ruby/atomic_ruby.c ADDED
@@ -0,0 +1,80 @@
1
+ #include "atomic_ruby.h"
2
+ #include <stdlib.h>
3
+ #include <string.h>
4
+
5
+ typedef struct {
6
+ volatile VALUE value;
7
+ } atomic_ruby_atom_t;
8
+
9
+ static void atomic_ruby_atom_mark(void *ptr) {
10
+ atomic_ruby_atom_t *atomic_ruby_atom = (atomic_ruby_atom_t *)ptr;
11
+ rb_gc_mark_movable(atomic_ruby_atom->value);
12
+ }
13
+
14
+ static void atomic_ruby_atom_free(void *ptr) {
15
+ atomic_ruby_atom_t *atomic_ruby_atom = (atomic_ruby_atom_t *)ptr;
16
+ xfree(atomic_ruby_atom);
17
+ }
18
+
19
+ static size_t atomic_ruby_atom_memsize(const void *ptr) {
20
+ return sizeof(atomic_ruby_atom_t);
21
+ }
22
+
23
+ static void atomic_ruby_atom_compact(void *ptr) {
24
+ atomic_ruby_atom_t *atomic_ruby_atom = (atomic_ruby_atom_t *)ptr;
25
+ atomic_ruby_atom->value = rb_gc_location(atomic_ruby_atom->value);
26
+ }
27
+
28
+ static const rb_data_type_t atomic_ruby_atom_type = {
29
+ .wrap_struct_name = "AtomicRuby::Atom",
30
+ .function = {
31
+ .dmark = atomic_ruby_atom_mark,
32
+ .dfree = atomic_ruby_atom_free,
33
+ .dsize = atomic_ruby_atom_memsize,
34
+ .dcompact = atomic_ruby_atom_compact
35
+ },
36
+ .flags = RUBY_TYPED_FREE_IMMEDIATELY
37
+ };
38
+
39
+ static VALUE rb_cAtom_allocate(VALUE klass) {
40
+ atomic_ruby_atom_t *atomic_ruby_atom;
41
+ VALUE obj = TypedData_Make_Struct(klass, atomic_ruby_atom_t, &atomic_ruby_atom_type, atomic_ruby_atom);
42
+ atomic_ruby_atom->value = Qnil;
43
+ return obj;
44
+ }
45
+
46
+ static VALUE rb_cAtom_initialize(VALUE self, VALUE value) {
47
+ atomic_ruby_atom_t *atomic_ruby_atom;
48
+ TypedData_Get_Struct(self, atomic_ruby_atom_t, &atomic_ruby_atom_type, atomic_ruby_atom);
49
+ atomic_ruby_atom->value = value;
50
+ return self;
51
+ }
52
+
53
+ static VALUE rb_cAtom_swap(VALUE self) {
54
+ atomic_ruby_atom_t *atomic_ruby_atom;
55
+ TypedData_Get_Struct(self, atomic_ruby_atom_t, &atomic_ruby_atom_type, atomic_ruby_atom);
56
+
57
+ VALUE expected_old_value, new_value;
58
+ do {
59
+ expected_old_value = atomic_ruby_atom->value;
60
+ new_value = rb_yield(expected_old_value);
61
+ } while (RUBY_ATOMIC_VALUE_CAS(atomic_ruby_atom->value, expected_old_value, new_value) != expected_old_value);
62
+
63
+ return new_value;
64
+ }
65
+
66
+ static VALUE rb_cAtom_value(VALUE self) {
67
+ atomic_ruby_atom_t *atomic_ruby_atom;
68
+ TypedData_Get_Struct(self, atomic_ruby_atom_t, &atomic_ruby_atom_type, atomic_ruby_atom);
69
+ return atomic_ruby_atom->value;
70
+ }
71
+
72
+ RUBY_FUNC_EXPORTED void Init_atomic_ruby(void) {
73
+ VALUE rb_mAtomicRuby = rb_define_module("AtomicRuby");
74
+ VALUE rb_cAtom = rb_define_class_under(rb_mAtomicRuby, "Atom", rb_cObject);
75
+
76
+ rb_define_alloc_func(rb_cAtom, rb_cAtom_allocate);
77
+ rb_define_method(rb_cAtom, "_initialize", rb_cAtom_initialize, 1);
78
+ rb_define_method(rb_cAtom, "swap", rb_cAtom_swap, 0);
79
+ rb_define_method(rb_cAtom, "value", rb_cAtom_value, 0);
80
+ }
data/ext/atomic_ruby/atomic_ruby.h ADDED
@@ -0,0 +1,7 @@
1
+ #ifndef ATOMIC_RUBY_ATOM_H
2
+ #define ATOMIC_RUBY_ATOM_H 1
3
+
4
+ #include "ruby.h"
5
+ #include "ruby/atomic.h"
6
+
7
+ #endif /* ATOMIC_RUBY_ATOM_H */
data/ext/atomic_ruby/extconf.rb ADDED
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "mkmf"
4
+
5
+ # Makes all symbols private by default to avoid unintended conflict
6
+ # with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
7
+ # selectively, or entirely remove this flag.
8
+ append_cflags("-fvisibility=hidden")
9
+
10
+ create_makefile("atomic_ruby/atomic_ruby")
data/lib/atomic-ruby/atom.rb ADDED
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AtomicRuby
4
+ class Atom
5
+ def initialize(value)
6
+ _initialize(value)
7
+ end
8
+ end
9
+ end
data/lib/atomic-ruby/atomic_ruby.bundle ADDED
Binary file
data/lib/atomic-ruby/version.rb ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AtomicRuby
4
+ VERSION = "0.1.0"
5
+ end
data/lib/atomic-ruby.rb ADDED
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "atomic-ruby/version"
4
+ require_relative "atomic-ruby/atomic_ruby"
5
+ require_relative "atomic-ruby/atom"
6
+
7
+ module AtomicRuby
8
+ class Error < StandardError; end
9
+ end
metadata ADDED
@@ -0,0 +1,54 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: atomic-ruby
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Joshua Young
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies: []
12
+ email:
13
+ - djry1999@gmail.com
14
+ executables: []
15
+ extensions:
16
+ - ext/atomic_ruby/extconf.rb
17
+ extra_rdoc_files: []
18
+ files:
19
+ - CHANGELOG.md
20
+ - CODE_OF_CONDUCT.md
21
+ - LICENSE.txt
22
+ - README.md
23
+ - atomic-ruby.gemspec
24
+ - ext/atomic_ruby/atomic_ruby.c
25
+ - ext/atomic_ruby/atomic_ruby.h
26
+ - ext/atomic_ruby/extconf.rb
27
+ - lib/atomic-ruby.rb
28
+ - lib/atomic-ruby/atom.rb
29
+ - lib/atomic-ruby/atomic_ruby.bundle
30
+ - lib/atomic-ruby/version.rb
31
+ homepage: https://github.com/joshuay03/atomic-ruby
32
+ licenses:
33
+ - MIT
34
+ metadata:
35
+ source_code_uri: https://github.com/joshuay03/atomic-ruby
36
+ changelog_uri: https://github.com/joshuay03/atomic-ruby/blob/main/CHANGELOG.md
37
+ rdoc_options: []
38
+ require_paths:
39
+ - lib
40
+ required_ruby_version: !ruby/object:Gem::Requirement
41
+ requirements:
42
+ - - ">="
43
+ - !ruby/object:Gem::Version
44
+ version: 3.2.0
45
+ required_rubygems_version: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - ">="
48
+ - !ruby/object:Gem::Version
49
+ version: '0'
50
+ requirements: []
51
+ rubygems_version: 3.6.7
52
+ specification_version: 4
53
+ summary: Atomic primitives for Ruby
54
+ test_files: []