console_kit 1.0.0 → 1.2.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.
data/CODE_OF_CONDUCT.md DELETED
@@ -1,132 +0,0 @@
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
- [report here](https://github.com/Soumyadeep-ai/console_kit/issues).
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/README.md DELETED
@@ -1,116 +0,0 @@
1
- # ConsoleKit
2
-
3
- ![Gem Version](https://img.shields.io/gem/v/console_kit.svg)
4
- ![Gem Downloads](https://img.shields.io/gem/dt/console_kit.svg)
5
- ![Build Status](https://github.com/Soumyadeep-ai/console_kit/actions/workflows/release.yml/badge.svg)
6
- ![License](https://img.shields.io/github/license/Soumyadeep-ai/console_kit)
7
- ![Ruby](https://img.shields.io/badge/ruby-%3E=3.1.0-red)
8
-
9
- A simple and flexible multi-tenant console setup toolkit for Rails applications.
10
-
11
- ConsoleKit helps you manage tenant-specific database connections and context configuration via an easy CLI interface and Rails integration.
12
-
13
- ## Installation
14
-
15
- Install the gem and add to the application's Gemfile by executing:
16
-
17
- ```ruby
18
- bundle add console_kit
19
- ```
20
-
21
- Additionally you can also add this line to your application's Gemfile:
22
-
23
- ```ruby
24
- gem 'console_kit'
25
- ```
26
-
27
- And then execute:
28
-
29
- ```ruby
30
- bundle install
31
- ```
32
-
33
- If bundler is not being used to manage dependencies, install the gem by executing:
34
-
35
- ```ruby
36
- gem install console_kit
37
- ```
38
-
39
- ## Usage
40
-
41
- After installing, generate the initializer and configuration files by running:
42
-
43
- ```ruby
44
- rails generate console_kit:install
45
- ```
46
-
47
- Then, edit config/initializers/console_kit.rb to define your tenants and context class. Example format:
48
-
49
- ```ruby
50
- ConsoleKit.configure do |config|
51
- config.tenants = {
52
- tenant_one: {
53
- constants: { shard: :tenant_one_db, mongo_db: :tenant_one_mongo, partner_code: 'partnerA' }
54
- },
55
- tenant_two: {
56
- constants: { shard: :tenant_two_db, mongo_db: :tenant_two_mongo, partner_code: 'partnerB' }
57
- }
58
- }
59
-
60
- config.context_class = CurrentContext
61
-
62
- # Optional: Toggle pretty CLI output
63
- config.pretty_output = true
64
- end
65
- ```
66
-
67
- ## Console Usage
68
-
69
- When launching the Rails console, ConsoleKit will prompt you to select a tenant (if multiple tenants are configured).
70
-
71
- ### Selection Options:
72
- - **Number or Name:** Select a tenant by its index or name (case-insensitive).
73
- - **0 (Skip):** Load the console without any tenant configuration.
74
- - **exit / quit:** Immediately terminate the console session.
75
-
76
- You can also manually interact with it:
77
-
78
- ### Get Current Tenant
79
- ```ruby
80
- ConsoleKit.current_tenant
81
- # => :tenant_one
82
- ```
83
-
84
- ### Reset Current Tenant
85
- ```ruby
86
- ConsoleKit.reset_current_tenant
87
- # => nil
88
- ```
89
-
90
- ### Manually Enable Pretty Output
91
- ```ruby
92
- ConsoleKit.enable_pretty_output
93
- ```
94
-
95
- ### Manually Disable Pretty Output
96
- ```ruby
97
- ConsoleKit.disable_pretty_output
98
- ```
99
-
100
- ## Development
101
-
102
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
103
-
104
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
105
-
106
- ## Contributing
107
-
108
- Bug reports and pull requests are welcome on GitHub at [Console Kit](https://github.com/Soumyadeep-ai/console_kit). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Soumyadeep-ai/console_kit/blob/main/CODE_OF_CONDUCT.md).
109
-
110
- ## License
111
-
112
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
113
-
114
- ## Code of Conduct
115
-
116
- Everyone interacting in the ConsoleKit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Soumyadeep-ai/console_kit/blob/main/CODE_OF_CONDUCT.md).
data/SECURITY.md DELETED
@@ -1,30 +0,0 @@
1
- # Security Policy
2
-
3
- ## Supported Versions
4
-
5
- We do **not maintain multiple supported versions**. Only the latest released version is eligible for security updates.
6
-
7
- Once a new version is released, the previous version is branched and locked, and will no longer receive updates — including security patches.
8
-
9
- | Version | Supported |
10
- | ------- | ------------------ |
11
- | 1.0.0 | :white_check_mark: |
12
- | 0.1.5 | :x: |
13
- | 0.1.4 | :x: |
14
- | 0.1.3 | :x: |
15
- | 0.1.2 | :x: |
16
- | 0.1.1 | :x: |
17
- | 0.1.0 | :x: |
18
-
19
- ## Reporting a Vulnerability
20
-
21
- If you discover a security vulnerability, please use the GitHub [Security Advisories](https://github.com/Soumyadeep-ai/console_kit/security/advisories/new) feature to report it privately.
22
-
23
- We follow this process:
24
- - All reported vulnerabilities are reviewed promptly.
25
- - A new version with security fixes will be released.
26
- - Once validated, we will publish an advisory and issue a patched release if necessary.
27
-
28
- Please avoid disclosing vulnerabilities publicly until we’ve had a chance to review and respond.
29
-
30
- For more details, visit [GitHub Docs: Reporting a Vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).
data/sig/console_kit.rbs DELETED
@@ -1,4 +0,0 @@
1
- module ConsoleKit
2
- VERSION: String
3
- # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
- end