Skip to content

Commit d83dc58

Browse files
saadshamssaadshams
committed
init
0 parents  commit d83dc58

Some content is hidden

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

52 files changed

+3861
-0
lines changed

‎.github/workflows/ruby.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
6+
# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
7+
8+
name: Ruby
9+
10+
on:
11+
push:
12+
branches: [ "main" ]
13+
pull_request:
14+
branches: [ "main" ]
15+
16+
permissions:
17+
contents: read
18+
19+
jobs:
20+
test:
21+
22+
runs-on: ubuntu-22.04
23+
strategy:
24+
matrix:
25+
ruby-version: ['3.2']
26+
27+
steps:
28+
- uses: actions/checkout@v4
29+
- name: Set up Ruby
30+
# To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
31+
# change this to (see https://github.com/ruby/setup-ruby#versioning):
32+
uses: ruby/setup-ruby@v1
33+
# uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
34+
with:
35+
ruby-version: ${{ matrix.ruby-version }}
36+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
37+
38+
- name: Run bundle install with verbose output
39+
run: bundle install --verbose
40+
41+
- name: Run tests
42+
run: ruby -Itest -e 'Dir["test/**/*_test.rb"].each { |file| require_relative file }' --verbose

‎.gitignore

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
*.gem
2+
*.rbc
3+
/.config
4+
/coverage/
5+
/InstalledFiles
6+
/pkg/
7+
/spec/reports/
8+
/spec/examples.txt
9+
/test/tmp/
10+
/test/version_tmp/
11+
/tmp/
12+
13+
# Used by dotenv library to load environment variables.
14+
# .env
15+
16+
# Ignore Byebug command history file.
17+
.byebug_history
18+
19+
## Specific to RubyMotion:
20+
.dat*
21+
.repl_history
22+
build/
23+
*.bridgesupport
24+
build-iPhoneOS/
25+
build-iPhoneSimulator/
26+
27+
## Specific to RubyMotion (use of CocoaPods):
28+
#
29+
# We recommend against adding the Pods directory to your .gitignore. However
30+
# you should judge for yourself, the pros and cons are mentioned at:
31+
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
32+
#
33+
# vendor/Pods/
34+
35+
## Documentation cache and generated files:
36+
/.yardoc/
37+
lib/.yardoc/
38+
/_yardoc/
39+
/doc/
40+
/rdoc/
41+
42+
## Environment normalization:
43+
/.bundle/
44+
/vendor/bundle
45+
/lib/bundler/man/
46+
47+
# for a library or gem, you might want to ignore these files since the code is
48+
# intended to run in multiple environments; otherwise, check them in:
49+
Gemfile.lock
50+
# .ruby-version
51+
# .ruby-gemset
52+
53+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
54+
.rvmrc
55+
56+
# Used by RuboCop. Remote config files pulled in from inherit_from directive.
57+
# .rubocop-https?--*
58+
59+
.DS_Store
60+
.idea

‎CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [1.0.0] - 2025-08-14
6+
### Added
7+
- Initial release of the framework

‎Gemfile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
group :development do
6+
gem 'rubocop', require: false
7+
gem 'steep'
8+
gem 'typeprof'
9+
gem 'yard'
10+
end

‎LICENSE

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2025, Saad Shams <[email protected]>
4+
5+
Redistribution and use in source and binary forms, with or without
6+
modification, are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its
16+
contributors may be used to endorse or promote products derived from
17+
this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
## [PureMVC](http://puremvc.github.com/) Ruby MultiCore Framework [![Ruby](https://github.com/PureMVC/puremvc-ruby-multicore-framework/actions/workflows/ruby.yml/badge.svg)](https://github.com/PureMVC/puremvc-ruby-multicore-framework/actions/workflows/ruby.yml)
2+
3+
PureMVC is a lightweight framework for creating applications based upon the classic [Model-View-Controller](http://en.wikipedia.org/wiki/Model-view-controller) design meta-pattern. It supports [modular programming](http://en.wikipedia.org/wiki/Modular_programming) through the use of [Multiton](http://en.wikipedia.org/wiki/Multiton) Core actors instead of the [Singletons](http://en.wikipedia.org/wiki/Singleton_pattern) used in the [Standard](https://github.com/PureMVC/puremvc-ruby-standard-framework/wiki) Version.
4+
5+
* [Ruby Gem](https://rubygems.org/gems/puremvc)
6+
* [API Docs](http://puremvc.org/pages/docs/Ruby/multicore/)
7+
8+
## Installation
9+
```shell
10+
gem install puremvc
11+
```
12+
13+
## Platforms / Technologies
14+
* [Ruby](https://en.wikipedia.org/wiki/Ruby_(programming_language))
15+
* [Command-line interface](https://en.wikipedia.org/wiki/Command-line_interface)
16+
* [Cross-platform software](https://en.wikipedia.org/wiki/Cross-platform_software)
17+
18+
---
19+
## Development
20+
21+
### Install Dependencies
22+
```shell
23+
bundle install
24+
```
25+
26+
### Lint Code
27+
```shell
28+
bundle exec rubocop
29+
```
30+
31+
### Generate RBS Signatures
32+
```shell
33+
rbs prototype rb lib/**/*.rb --out-dir=sig
34+
```
35+
36+
### Run Type Checking
37+
```shell
38+
steep check
39+
```
40+
41+
### Test
42+
```shell
43+
ruby -Itest -e 'Dir["test/**/*_test.rb"].each { |file| require_relative file }'
44+
RubyMine: Test file name mask: **/{*_test,test_*,*_spec}.rb
45+
```
46+
47+
### Generate Documentation
48+
```shell
49+
yard doc lib/**/*.rb --protected --private
50+
open doc/index.html
51+
```
52+
53+
#### Publish
54+
```shell
55+
gem signin
56+
gem build puremvc.gemspec
57+
gem push puremvc-1.0.0.gem
58+
```
59+
60+
## Reference
61+
* [Ruby](https://www.ruby-lang.org/en)
62+
* [RBS](https://github.com/ruby/rbs)
63+
* [YARD: Yay! A Ruby Documentation Tool](https://rubydoc.info/gems/yard)
64+
65+
---
66+
67+
## License
68+
* PureMVC MultiCore Framework for Ruby
69+
* PureMVC - Copyright © 2025 [Saad Shams](https://www.linkedin.com/in/muizz/)
70+
* PureMVC - Copyright © 2025 [Futurescale, Inc.](http://futurescale.com/)
71+
* All rights reserved.
72+
73+
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
74+
75+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
76+
* 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.
77+
* Neither the name of Futurescale, Inc., PureMVC.org, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
78+
79+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎Steepfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# frozen_string_literal: true
2+
3+
target :app do
4+
signature 'sig'
5+
check 'lib'
6+
ignore 'test'
7+
end

0 commit comments

Comments
 (0)