Skip to content

Contributing.md

Latest commit

 

History

History
162 lines (111 loc) · 3.98 KB

Contributing.md

File metadata and controls

162 lines (111 loc) · 3.98 KB

Contributing

This document describes the usages and rules to follow when contributing to Weber.

Bugs, Issues, Suggestions

If you will have any questsions, suggestions or bug repports, you should create a ticket in issues.

If you will ideas about new Weber's feature, you should create a ticket in issues with [PROPOSAL] theme, see example for further discussion.

Style guide

If you will send patch to the Weber your code should follow some simple rules:

  • We use 2 spaces for Elixir code.
  • Variables example: file_name, file_content.

Developing

First of all you must fork the project's repository to your GitHub account by clicking on the Fork button. Then you must clone your fork to the local machine with:

git clone https://github.com/your_nick/weber.git

and add official remote repo url:

git remote add upstream https://github.com/0xAX/weber.git

Before starting working on the code, you MUST update to upstream. You should make sure that you start making changes to the current version of the Weber.

For updating the current branch to upstream:

git fetch upstream
git rebase upstream/master

You MUST create a new branch for your work. First, ensure you are on master, and execute:

git checkout -b "feature-1"

make your changes and push it:

git push origin feature-1

Go to the Github and send Pull Request.

Testing

If you made new non-trivial feature or bug fix, please write nit test for it.

There are 2 types of tests in Weber:

  1. You can test usual function as we doing it in route_test.ex

  2. If you need to test Weber in working mode (you need to test request/response and etc...) we use hackney web client and exunit too. See response_test

Running tests with:

mix test --no-start

or

make test

Weber internal API

Weber source code structure:

  • weber/lib/weber.ex - weber application initialization. (Starts cowboy, session manager and etc... here)
  • lib/mix/tasks/weber.ex - weber mix tasks declaration.
  • weber/lib/route.ex - routing source code
  • weber/lib/cowboy.ex - cowboy initialization and launch code
  • weber/lib/templates - macroses for compiling EEx templates and generating Elixir modules for getting this templates.
  • weber/lib/session - weber's session manager.
  • weber/lib/i18n - weber's localization utils.
  • weber/lib/http - weber's http utils.
  • weber/lib/helper - weber helper (tag, include_view and etc...)
  • weber/lib/controller - weber controllers macroses.
  • weber/lib/handler - weber http/websocket handlers.
  • weber/lib/utils - weber utils.

Routing

We can get current routing with calling:

RouteModule.__route__

For example if we have routing settings:

route on("GET", "/", :Gr.Main, :action)

and now call:

Route.__route__

we get:

[[method: "GET", path: "/", controller: Gr.Main, action: :action]]

Config

We can access weber application anywhere config with:

Config.config

Views/Static resources

Weber generates views modules in compile time and you can access it as ussual Elixir modules.

If there is lib/views/main.html views, it will be Elixir.Views.Main module and there is:

Elixir.Views.Main.__view__/0

which will return lib/views/main.html content.

Also there are some builtin API:

  • Weber.Path.root - returns root path of the current project
  • Weber.Path.views - returns list of views paths of the current project
  • Weber.Path.static - returns list of static resources paths of the current project