Skip to content

Commit 5a9dfac

Browse files
committed
Merge branch 'edge' of github.com:hyperstack-org/hyperstack into edge
2 parents 0c398b9 + c0992bb commit 5a9dfac

File tree

3 files changed

+29
-4
lines changed

3 files changed

+29
-4
lines changed

docs/dsl-isomorphic/hyper-policy.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@ from Mitch...
509509
These work very similar to pundit, and by design you can even mix pundit and hyperloop policies.
510510
Here is an example pundit policy from the pundit tutorial:
511511

512+
```ruby
512513
# app/policies/article_policy.rb
513514
class ArticlePolicy < ApplicationPolicy
514515
def index?
@@ -533,9 +534,9 @@ class ArticlePolicy < ApplicationPolicy
533534
record
534535
end
535536
end
536-
537+
```
537538
--------------
538-
539+
```ruby
539540
class ArticlePolicy < ApplicationPolicy
540541
# def index?
541542
# true
@@ -583,16 +584,19 @@ class ArticlePolicy < ApplicationPolicy
583584
# record
584585
# end
585586
end
587+
```
586588

587589
without comments....
588590

591+
```
589592
class ArticlePolicy < ApplicationPolicy
590593
regulate_broadcast { |policy| policy.send_all.to Application }
591594
592595
allow_create { acting_user } # <- create is okay if acting_user is not nil
593596
594597
allow_change(on: [:update, :destroy]) { acting_user == user }
595598
end
599+
```
596600

597601
BTW what if you want to restrict what data is broadcast? In Hyperloop you just update the regulation. In pundit you may have to edit both the index controller method and
598602
Policy class.

docs/feature_matrix.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Feature Matrix
2+
Table with Ruby (on Rails) features and the implemenatation status for Hyperstack/Opal.
3+
4+
| Feature | Type | Module | Status | Links | Exsisting Documenation | Exsisting Server Implementations | Implemenation At** |
5+
|-------------|-----------------|---------------|----------|----------------|------------------------|----------------------------------|--------------------|
6+
| new_record? | instance method | ActiveRecord | missing | Github issues? | [new_record?@apidock](https://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-new_record-3F) | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/instance_methods.rb) |
7+
| find | class method | ActiveRecord | buged? | [reproducable example](https://github.com/Tim-Blokdijk/hyperstack-experiments/blob/master/app/hyperstack/components/search.rb) | | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/class_methods.rb) |
8+
| destroy | instance method | ActiveRecord | buged? | [reproducable example](https://github.com/Tim-Blokdijk/hyperstack-experiments/blob/master/app/hyperstack/components/index.rb) | | | [hyper-model](https://github.com/hyperstack-org/hyperstack/blob/edge/ruby/hyper-model/lib/reactive_record/active_record/instance_methods.rb) |
9+
| DateTime | class | StdLib | missing | | [DateTime@ruby-doc](https://ruby-doc.org/stdlib-2.6/libdoc/date/rdoc/DateTime.html) | | Opal |
10+
| truncate | instance method | ActiveSupport | missing | | [truncate@apidock](https://apidock.com/rails/String/truncate) | | [opal-activesupport@github](https://github.com/opal/opal-activesupport/tree/master/opal/active_support/core_ext) |
11+
| i18n | lib | Rails-I18N | missing? | | | [rails-i18n@github](https://github.com/svenfuchs/rails-i18n) | |
12+
13+
** Implemenation At: If `Status` is `missing` the place (file or directory) where the code should probably be impemented. Otherwise the actual implemenation Opal.

docs/readme.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,10 @@ Our website serves as a Hyperstack example application. All the doc content is l
3333

3434
You can be up and running in **less than 5 minutes**. Just follow the simple setup guide for a new Rails application all correctly configured and ready to go with Hyperstack.
3535

36-
+ Setup and Installation: [https://hyperstack.org/edge/docs/installation)
36+
+ Setup and Installation: https://hyperstack.org/edge/docs/installation
37+
38+
Beyond the installation we strongly suggest new developers work trough the [ToDo tutorial](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/tutorial/todo.md).
39+
As it gives a minial understanding of the Hyperstack framework.
3740

3841
## Community and support
3942

@@ -49,7 +52,12 @@ Please see the [ROADMAP](https://github.com/hyperstack-org/hyperstack/blob/edge/
4952

5053
## Contributing
5154

52-
If you would like to help, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.
55+
We have a [Feature Matrix](https://github.com/hyperstack-org/hyperstack/blob/edge/docs/feature_matrix.md) that needs to be filled with missing features.
56+
The idea is that you can check here what the implementation status is of a Ruby (on Rails) feature.
57+
And if you have the time and skill you're more then encuraged to implement or fix one or two.
58+
But if you're not in a position to contribute code, just expanding and maintaining this table would be very excellent.
59+
60+
If you would like to help in any other way, please read the [CONTRIBUTING](https://github.com/hyperstack-org/hyperstack/blob/edge/CONTRIBUTING.md) file for suggestions.
5361

5462
## Links
5563

0 commit comments

Comments
 (0)