Skip to content

Commit eaedef5

Browse files
niteshpurohitniteshpurohit
authored
build: rails_cron gem skeleton (#15)
1 parent 197ad36 commit eaedef5

91 files changed

Lines changed: 4592 additions & 103 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.qlty/.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*
2+
!configs
3+
!configs/**
4+
!hooks
5+
!hooks/**
6+
!qlty.toml
7+
!.gitignore

‎.qlty/configs/.markdownlint.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"MD013": {
3+
"line_length": 500
4+
},
5+
"MD033": false,
6+
"MD025": false,
7+
"MD024": false
8+
}

‎.qlty/configs/.yamllint.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
extends: default
2+
3+
rules:
4+
document-start: disable
5+
quoted-strings:
6+
required: only-when-needed
7+
extra-allowed: ["{|}"]
8+
key-duplicates: {}
9+
octal-values:
10+
forbid-implicit-octal: true
11+
line-length: disable
12+
indentation: disable
13+
new-line-at-end-of-file: disable
14+
trailing-spaces: disable
15+
brackets: disable
16+
colons: disable
17+
empty-lines: disable
18+
comments: disable
19+
braces: disable
20+
comments-indentation: disable
21+
commas: disable
22+
truthy: disable

‎.qlty/qlty.toml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# This file was automatically generated by `qlty init`.
2+
# You can modify it to suit your needs.
3+
# We recommend you to commit this file to your repository.
4+
#
5+
# This configuration is used by both Qlty CLI and Qlty Cloud.
6+
#
7+
# Qlty CLI -- Code quality toolkit for developers
8+
# Qlty Cloud -- Fully automated Code Health Platform
9+
#
10+
# Try Qlty Cloud: https://qlty.sh
11+
#
12+
# For a guide to configuration, visit https://qlty.sh/d/config
13+
# Or for a full reference, visit https://qlty.sh/d/qlty-toml
14+
config_version = "0"
15+
16+
exclude_patterns = [
17+
"*_min.*",
18+
"*-min.*",
19+
"*.min.*",
20+
"**/.yarn/**",
21+
"**/*.d.ts",
22+
"**/assets/**",
23+
"**/bower_components/**",
24+
"**/build/**",
25+
"**/cache/**",
26+
"**/config/**",
27+
"**/db/**",
28+
"**/deps/**",
29+
"**/dist/**",
30+
"**/extern/**",
31+
"**/external/**",
32+
"**/generated/**",
33+
"**/Godeps/**",
34+
"**/gradlew/**",
35+
"**/mvnw/**",
36+
"**/node_modules/**",
37+
"**/protos/**",
38+
"**/seed/**",
39+
"**/target/**",
40+
"**/templates/**",
41+
"**/testdata/**",
42+
"**/vendor/**",
43+
]
44+
45+
test_patterns = [
46+
"**/test/**",
47+
"**/spec/**",
48+
"**/*.test.*",
49+
"**/*.spec.*",
50+
"**/*_test.*",
51+
"**/*_spec.*",
52+
"**/test_*.*",
53+
"**/spec_*.*",
54+
]
55+
56+
[smells]
57+
mode = "comment"
58+
59+
[[source]]
60+
name = "default"
61+
default = true
62+
63+
64+
[[plugin]]
65+
name = "actionlint"
66+
67+
[[plugin]]
68+
name = "checkov"
69+
70+
[[plugin]]
71+
name = "markdownlint"
72+
mode = "comment"
73+
74+
[[plugin]]
75+
name = "osv-scanner"
76+
77+
[[plugin]]
78+
name = "prettier"
79+
80+
[[plugin]]
81+
name = "radarlint-js"
82+
83+
[[plugin]]
84+
name = "reek"
85+
mode = "comment"
86+
87+
[[plugin]]
88+
name = "ripgrep"
89+
mode = "comment"
90+
91+
[[plugin]]
92+
name = "trivy"
93+
drivers = [
94+
"config",
95+
"fs-vuln",
96+
]
97+
98+
[[plugin]]
99+
name = "trufflehog"
100+
101+
[[plugin]]
102+
name = "yamllint"

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# CHANGELOG
1+
# CHANGELOG

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ This project comprises various modules/components, each housed in its dedicated
2222

2323
The table below provides an overview of all possible modules/components:
2424

25-
| Module/Component | Description | Related Language/Framework |
26-
| ---------------- | ------------------------------------- | -------------------------- |
27-
| rails_cron | Rails crons library | Ruby on Rails |
25+
| Module/Component | Description | Related Language/Framework |
26+
| ---------------- | ------------------- | -------------------------- |
27+
| rails_cron | Rails crons library | Ruby on Rails |
2828

2929
## Improve Documentation
3030

@@ -158,8 +158,8 @@ Pick the version number from draft release notes on the
158158
8. **Open a PR to `main`**
159159
Create a pull request to merge `release/<version>` into `main`.
160160

161-
9. **Label the PR**
162-
Tag the PR with `release`, `release/<version>`, and `skip-changelog`.
161+
9. **Label the PR**
162+
Tag the PR with `release`, `release/<version>`, and `skip-changelog`.
163163

164164
10. **Create a GitHub Release**
165165
After the PR is approved and merged, create a new Release on the

‎README.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# ⏰ RailsCron — Distributed Cron Scheduler for Rails
22

3+
> First release 0.0.1 is empty gem.
34
> A scheduler-agnostic, multi-node-safe cron runner for Ruby and Rails.
45
> Designed and maintained by **Codevedas Inc.**
56
@@ -18,14 +19,13 @@
1819

1920
This repository contains the **RailsCron** gem and its documentation site.
2021

21-
```
22+
```text
2223
2324
/repo-root
2425
├── .github/ # CI workflows, issue templates
2526
├── rails_cron/ # Gem source (lib/, bin/, gemspec)
2627
├── docs/ # Documentation site (Jekyll + Markdown)
2728
└── README.md # This file
28-
2929
```
3030

3131
---
@@ -46,12 +46,12 @@ Comprehensive guides are published at:
4646

4747
👉 **[https://rails-cron.codevedas.com](https://rails-cron.codevedas.com)**
4848

49-
| Section | Description |
50-
|----------|-------------|
51-
| [Overview & Motivation](https://rails-cron.codevedas.com/overview) | Why RailsCron exists |
52-
| [Installation & Setup](https://rails-cron.codevedas.com/install) | Gem setup and initializer |
53-
| [Usage](https://rails-cron.codevedas.com/usage) | Registering jobs, CLI, and Rake tasks |
54-
| [FAQ / Troubleshooting](https://rails-cron.codevedas.com/faq) | Common issues and fixes |
49+
| Section | Description |
50+
| ------------------------------------------------------------------ | ------------------------------------- |
51+
| [Overview & Motivation](https://rails-cron.codevedas.com/overview) | Why RailsCron exists |
52+
| [Installation & Setup](https://rails-cron.codevedas.com/install) | Gem setup and initializer |
53+
| [Usage](https://rails-cron.codevedas.com/usage) | Registering jobs, CLI, and Rake tasks |
54+
| [FAQ / Troubleshooting](https://rails-cron.codevedas.com/faq) | Common issues and fixes |
5555

5656
---
5757

@@ -76,6 +76,7 @@ bin/rspec-unit
7676
```bash
7777
bin/rubocop
7878
```
79+
7980
### 4. Reek
8081

8182
```bash
@@ -122,11 +123,11 @@ Then open:
122123

123124
GitHub Actions workflows include:
124125

125-
| Workflow | Purpose |
126-
| ------------- | ------------------------------------------------- |
127-
| `ci.yml` | Runs tests (RSpec + RuboCop) on all Ruby versions |
128-
| `release.yml` | Builds and publishes gem to RubyGems |
129-
| `jekyll-gh-pages.yml` | Builds and deploys docs to GitHub Pages |
126+
| Workflow | Purpose |
127+
| --------------------- | ------------------------------------------------- |
128+
| `ci.yml` | Runs tests (RSpec + RuboCop) on all Ruby versions |
129+
| `release.yml` | Builds and publishes gem to RubyGems |
130+
| `jekyll-gh-pages.yml` | Builds and deploys docs to GitHub Pages |
130131

131132
---
132133

@@ -141,4 +142,4 @@ GitHub Actions workflows include:
141142
## 📄 License
142143

143144
Released under the [MIT License](LICENSE)
144-
© 2025 **Codevedas Inc.** — All rights reserved.
145+
© 2025 **Codevedas Inc.** — All rights reserved.

‎docs/_includes/footer_custom.html‎

Lines changed: 78 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,97 @@
11
<p class="text-small text-grey-dk-100 mb-0 text-center">
2-
<a href="https://badge.fury.io/rb/rails_cron"><img src="https://badge.fury.io/rb/rails_cron.svg" alt="Gem Version" height="18" /></a>
3-
<a href="https://https://github.com/Code-Vedas/rails_cron/actions/workflows/ci.yml">
4-
<img src="https://github.com/Code-Vedas/rails_cron/actions/workflows/ci.yml/badge.svg" alt="CI Status" />
2+
<a href="https://badge.fury.io/rb/rails_cron"
3+
><img
4+
src="https://badge.fury.io/rb/rails_cron.svg"
5+
alt="Gem Version"
6+
height="18"
7+
/></a>
8+
<a
9+
href="https://https://github.com/Code-Vedas/rails_cron/actions/workflows/ci.yml"
10+
>
11+
<img
12+
src="https://github.com/Code-Vedas/rails_cron/actions/workflows/ci.yml/badge.svg"
13+
alt="CI Status"
14+
/>
515
</a>
616
<!-- License -->
7-
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">
8-
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" />
17+
<a
18+
href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE"
19+
target="_blank"
20+
rel="noopener noreferrer"
21+
>
22+
<img
23+
src="https://img.shields.io/badge/license-MIT-blue.svg"
24+
alt="License"
25+
/>
926
</a>
1027
<!-- Repository Link -->
11-
<a href="https://github.com/Code-Vedas/rails_cron" target="_blank" rel="noopener noreferrer">
12-
<img src="https://img.shields.io/badge/github-repository-blue.svg" alt="GitHub Repository" />
28+
<a
29+
href="https://github.com/Code-Vedas/rails_cron"
30+
target="_blank"
31+
rel="noopener noreferrer"
32+
>
33+
<img
34+
src="https://img.shields.io/badge/github-repository-blue.svg"
35+
alt="GitHub Repository"
36+
/>
1337
</a>
1438
<!-- Issues Link -->
15-
<a href="https://github.com/Code-Vedas/rails_cron/issues" target="_blank" rel="noopener noreferrer">
16-
<img src="https://img.shields.io/github/issues/Code-Vedas/rails_cron.svg" alt="Open Issues" />
39+
<a
40+
href="https://github.com/Code-Vedas/rails_cron/issues"
41+
target="_blank"
42+
rel="noopener noreferrer"
43+
>
44+
<img
45+
src="https://img.shields.io/github/issues/Code-Vedas/rails_cron.svg"
46+
alt="Open Issues"
47+
/>
1748
</a>
1849
<a href="https://www.rubydoc.info/gems/rails_cron" target="_blank">
19-
<img src="https://img.shields.io/badge/rubydoc-rails_cron-blue.svg" alt="View API Documentation" />
50+
<img
51+
src="https://img.shields.io/badge/rubydoc-rails_cron-blue.svg"
52+
alt="View API Documentation"
53+
/>
2054
</a>
2155
</p>
2256

2357
<p class="text-small text-grey-dk-100 mb-0">
2458
Copyright &copy; 2024-2025 Code Vedas Inc. Distributed by an
25-
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE">MIT license.</a>
59+
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE"
60+
>MIT license.</a
61+
>
2662
&nbsp;&nbsp;
27-
<a href="https://github.com/Code-Vedas/rails_cron" target="_blank" rel="noopener noreferrer">GitHub</a>
63+
<a
64+
href="https://github.com/Code-Vedas/rails_cron"
65+
target="_blank"
66+
rel="noopener noreferrer"
67+
>GitHub</a
68+
>
2869
|
29-
<a href="https://github.com/Code-Vedas/rails_cron/issues" target="_blank" rel="noopener noreferrer">Issues</a>
70+
<a
71+
href="https://github.com/Code-Vedas/rails_cron/issues"
72+
target="_blank"
73+
rel="noopener noreferrer"
74+
>Issues</a
75+
>
3076
|
31-
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/CHANGELOG.md" target="_blank" rel="noopener noreferrer">Changelog</a>
77+
<a
78+
href="https://github.com/Code-Vedas/rails_cron/blob/main/CHANGELOG.md"
79+
target="_blank"
80+
rel="noopener noreferrer"
81+
>Changelog</a
82+
>
3283
|
33-
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">License</a>
84+
<a
85+
href="https://github.com/Code-Vedas/rails_cron/blob/main/LICENSE"
86+
target="_blank"
87+
rel="noopener noreferrer"
88+
>License</a
89+
>
3490
|
35-
<a href="https://github.com/Code-Vedas/rails_cron/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">Contributing</a>
36-
</p>
91+
<a
92+
href="https://github.com/Code-Vedas/rails_cron/blob/main/CONTRIBUTING.md"
93+
target="_blank"
94+
rel="noopener noreferrer"
95+
>Contributing</a
96+
>
97+
</p>

0 commit comments

Comments
 (0)