lexical_private 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.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d7524fcfeef3c86c0d2f08ab0df38faae47b0fbdfdc8fe8fb132e84853169221
4
+ data.tar.gz: 2f274686e8d66f81175d7be70e247e81930c1ffe936aac84a11bea80736cdff6
5
+ SHA512:
6
+ metadata.gz: e41cea94a150d48e45cf7151cdd1fcffd8c70e7ea44dbe1ee63b0aafd770102680e942cacea14ab66834de92ed00bf7273c0f7ea96ab3795094f5efb993ad405
7
+ data.tar.gz: 5d226d560c0dff38397c672d721ca979c0f4f3cc4e07c7e17a9d988ca1488b8bedd8683e0335b3d6c1ed12fb5172203f911afeff37ed89cda0c3a65312162bc4
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,20 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.1
3
+ NewCops: disable
4
+
5
+ Style/StringLiterals:
6
+ EnforcedStyle: double_quotes
7
+
8
+ Style/StringLiteralsInInterpolation:
9
+ EnforcedStyle: double_quotes
10
+
11
+ Style/Documentation:
12
+ Exclude:
13
+ - "spec/**/*"
14
+
15
+ Metrics/MethodLength:
16
+ Max: 20
17
+
18
+ Metrics/BlockLength:
19
+ Exclude:
20
+ - "spec/**/*"
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2026-02-28
4
+
5
+ - Initial release
data/CLAUDE.md ADDED
@@ -0,0 +1,43 @@
1
+ # CLAUDE.md
2
+
3
+ This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
+
5
+ ## Commands
6
+
7
+ ```bash
8
+ bin/setup # Install dependencies
9
+ bundle exec rake spec # Run all tests
10
+ bundle exec rake rubocop # Run linter
11
+ bundle exec rake # Run both tests and rubocop (default)
12
+ bin/console # Interactive prompt for experimenting
13
+ ```
14
+
15
+ Run a single spec file:
16
+ ```bash
17
+ bundle exec rspec spec/lexical_private_spec.rb
18
+ ```
19
+
20
+ Run a single example by line number:
21
+ ```bash
22
+ bundle exec rspec spec/lexical_private_spec.rb:5
23
+ ```
24
+
25
+ Install gem locally:
26
+ ```bash
27
+ bundle exec rake install
28
+ ```
29
+
30
+ ## Architecture
31
+
32
+ This is a Ruby gem scaffold generated by Bundler. It is essentially empty and ready for implementation.
33
+
34
+ - `lib/lexical_private.rb` — Main entry point; defines the `LexicalPrivate` module and a base `Error` class
35
+ - `lib/lexical_private/version.rb` — Version constant (`LexicalPrivate::VERSION`)
36
+ - `spec/` — RSpec tests; `spec_helper.rb` disables monkey patching and uses `expect` syntax only
37
+ - `sig/` — RBS type signatures (Ruby 3+ static typing)
38
+
39
+ ## Style
40
+
41
+ - RuboCop enforces double-quoted strings (`Style/StringLiterals: double_quotes`)
42
+ - Target Ruby version: 3.1+
43
+ - All files use `# frozen_string_literal: true`
@@ -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) 2026 kyuuri1791
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,110 @@
1
+ # lexical_private
2
+
3
+ `lexical_private` is a Ruby gem that provides stronger visibility control for module methods than Ruby's built-in `private`.
4
+
5
+ ## Motivation
6
+
7
+ Ruby's `private` controls visibility at the object level: a private method can be called from any method on the same object, including methods defined in an including class. This is intentional and useful in many cases.
8
+
9
+ `lexical_private` offers a stricter alternative for situations where you want a method to be an internal detail of a specific module — inaccessible even to the classes that include it.
10
+
11
+ | Caller | `private` | `lexical_private` |
12
+ |---|---|---|
13
+ | Method in the same module | allowed | allowed |
14
+ | Method added by an including class | allowed | NoMethodError |
15
+ | Direct external call (`obj.method`) | NoMethodError | NoMethodError |
16
+
17
+ ## Usage
18
+
19
+ 1. `extend LexicalPrivate` in your module.
20
+ 2. Define public methods first (they can call lexically-private methods internally).
21
+ 3. Call `lexical_private` — all methods defined after this point become lexically private.
22
+
23
+ ```ruby
24
+ require "lexical_private"
25
+
26
+ module M
27
+ extend LexicalPrivate
28
+
29
+ def public_method
30
+ secret # OK — defined in the same module
31
+ end
32
+
33
+ lexical_private
34
+
35
+ def secret
36
+ "shh"
37
+ end
38
+ end
39
+
40
+ class C
41
+ include M
42
+
43
+ def leak
44
+ secret # raises NoMethodError
45
+ end
46
+ end
47
+
48
+ C.new.public_method # => "shh"
49
+ C.new.secret # => NoMethodError: private method 'secret' called for an instance of C
50
+ C.new.leak # => NoMethodError: private method 'secret' called for an instance of C
51
+ ```
52
+
53
+ Lexically-private methods can freely call other lexically-private methods defined in the same module:
54
+
55
+ ```ruby
56
+ module M
57
+ extend LexicalPrivate
58
+
59
+ def entry
60
+ step_one
61
+ end
62
+
63
+ lexical_private
64
+
65
+ def step_one
66
+ step_two # OK — step_two is also in M
67
+ end
68
+
69
+ def step_two
70
+ "done"
71
+ end
72
+ end
73
+ ```
74
+
75
+ ## How it works
76
+
77
+ When `lexical_private` is called, the gem:
78
+
79
+ 1. Wraps all already-defined methods in the module to track that execution is happening "inside" the module (via a thread-local counter keyed to the module's identity).
80
+ 2. Installs a `method_added` hook so that every subsequent method definition is wrapped to check that counter before running. If the counter is zero (the call came from outside the module), `NoMethodError` is raised.
81
+
82
+ Each module gets its own counter key derived from its `object_id`, so multiple modules with lexically-private methods never interfere with each other.
83
+
84
+ ## Installation
85
+
86
+ Add to your `Gemfile`:
87
+
88
+ ```ruby
89
+ gem "lexical_private"
90
+ ```
91
+
92
+ Or install directly:
93
+
94
+ ```bash
95
+ gem install lexical_private
96
+ ```
97
+
98
+ ## Development
99
+
100
+ ```bash
101
+ bin/setup # install dependencies
102
+ bundle exec rake spec # run tests
103
+ bundle exec rake rubocop # run linter
104
+ bundle exec rake # run both (default)
105
+ bin/console # interactive prompt
106
+ ```
107
+
108
+ ## License
109
+
110
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module LexicalPrivate
4
+ VERSION = "0.1.0"
5
+ end
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lexical_private/version"
4
+
5
+ # Provides lexical-scope visibility control for module methods.
6
+ # When a module extends LexicalPrivate and calls +lexical_private+,
7
+ # all subsequently defined methods become lexically private: they can
8
+ # only be called from other methods defined in the same module.
9
+ module LexicalPrivate
10
+ class Error < StandardError; end
11
+
12
+ def lexical_private
13
+ mod = self
14
+ lp_key = :"_lexical_private_#{object_id}"
15
+
16
+ # Step 1: Wrap already-defined methods as "trusted" so they can call LP methods.
17
+ # Must run before setting up the hook to avoid triggering it.
18
+ instance_methods(false).each do |method_name|
19
+ mod.__send__(:_lp_wrap_as_trusted, method_name, lp_key)
20
+ end
21
+
22
+ # Step 2: Hook method_added so all subsequent method definitions become LP.
23
+ singleton_class.prepend(
24
+ Module.new do
25
+ define_method(:method_added) do |method_name|
26
+ return if @_lp_wrapping
27
+
28
+ @_lp_wrapping = true
29
+ begin
30
+ super(method_name)
31
+ mod.__send__(:_lp_wrap_as_private, method_name, lp_key)
32
+ ensure
33
+ @_lp_wrapping = false
34
+ end
35
+ end
36
+ end
37
+ )
38
+ end
39
+
40
+ private
41
+
42
+ def _lp_wrap_as_trusted(method_name, lp_key)
43
+ original = instance_method(method_name)
44
+ define_method(method_name) do |*args, &block|
45
+ prev = Fiber[lp_key] || 0
46
+ Fiber[lp_key] = prev + 1
47
+ begin
48
+ original.bind_call(self, *args, &block)
49
+ ensure
50
+ Fiber[lp_key] = prev
51
+ end
52
+ end
53
+ end
54
+
55
+ def _lp_wrap_as_private(method_name, lp_key)
56
+ original = instance_method(method_name)
57
+ define_method(method_name) do |*args, &block|
58
+ unless (Fiber[lp_key] || 0).positive?
59
+ raise NoMethodError,
60
+ "private method '#{method_name}' called for an instance of #{self.class}"
61
+ end
62
+
63
+ prev = Fiber[lp_key]
64
+ Fiber[lp_key] = prev + 1
65
+ begin
66
+ original.bind_call(self, *args, &block)
67
+ ensure
68
+ Fiber[lp_key] = prev
69
+ end
70
+ end
71
+ end
72
+ end
metadata ADDED
@@ -0,0 +1,54 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lexical_private
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - kyuuri1791
8
+ bindir: exe
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies: []
12
+ description: Provides lexical_private, which restricts module methods so they can
13
+ only be called from within the same module definition — unlike Ruby's private, which
14
+ still allows including classes to call them.
15
+ executables: []
16
+ extensions: []
17
+ extra_rdoc_files: []
18
+ files:
19
+ - ".rspec"
20
+ - ".rubocop.yml"
21
+ - CHANGELOG.md
22
+ - CLAUDE.md
23
+ - CODE_OF_CONDUCT.md
24
+ - LICENSE.txt
25
+ - README.md
26
+ - Rakefile
27
+ - lib/lexical_private.rb
28
+ - lib/lexical_private/version.rb
29
+ homepage: https://github.com/kyuuri1791/lexical_private
30
+ licenses:
31
+ - MIT
32
+ metadata:
33
+ allowed_push_host: https://rubygems.org
34
+ homepage_uri: https://github.com/kyuuri1791/lexical_private
35
+ source_code_uri: https://github.com/kyuuri1791/lexical_private
36
+ changelog_uri: https://github.com/kyuuri1791/lexical_private/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.1.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: Stricter visibility control for module methods than Ruby's built-in private
54
+ test_files: []