weby-lv/weeler

# Weeler

[![Gem Version](https://badge.fury.io/rb/weeler.svg)](https://badge.fury.io/rb/weeler)
[![Build Status](https://travis-ci.org/weby-lv/weeler.svg?branch=master)](https://travis-ci.org/weby-lv/weeler)
[![Coverage Status](https://coveralls.io/repos/weby-lv/weeler/badge.svg)](https://coveralls.io/r/weby-lv/weeler)
[![Code Climate](https://codeclimate.com/github/weby-lv/weeler/badges/gpa.svg)](https://codeclimate.com/github/weby-lv/weeler)

## Installation

### Rails 6.0

2.0.0 version only supports Rails 6.0 and ruby 2.5 or higher version. In Gemfile include:

```ruby
gem 'weeler', '~> 2.0'
```

### Rails 5.0

1.6.0 version only supports Rails 5.0 and ruby 2.2.2 and higher version. In Gemfile include:

```ruby
gem 'weeler', '~> 1.6'
```

### Rails 4.2

```ruby
gem 'weeler', '~> 1.5'
```

After specifying necessary gems in Gemfile run

```bash
bundle install
```

## Setup

Run weeler generator:

    $ rails g weeler:install

This will generate follwing files:
* <tt>config/initializers/weeler.rb</tt>
* <tt>db/migrate/xxxxxxxxxxxxxx_create_weeler_seos.rb</tt>
* <tt>db/migrate/xxxxxxxxxxxxxx_create_weeler_settings.rb</tt>
* <tt>db/migrate/xxxxxxxxxxxxxx_create_weeler_translations.rb</tt>
* <tt>db/migrate/xxxxxxxxxxxxxx_translate_weeler_seos.rb</tt>
* <tt>app/controllers/weeler/application_controller.rb</tt>
* <tt>lib/assets/javascripts/weeler/app/index.js</tt>
* <tt>lib/assets/stylesheets/weeler/app/index.css</tt>
* your route file will be appended

Following will be appended to your route file:

    mount_weeler_at "weeler" do
      # weeler_resources :example, include_in_weeler_menu: true
      # Also you orderable and imageable concerns
    end

And then migrate database:

    $ rake db:migrate

## Weeler Structure

    - app
    -- controllers
    --- weeler
    ---- application_controller.rb
    -- views
    --- weeler
    - lib
    -- assets
    --- javascripts
    ---- weeler
    ----- app
    ------ index.js
    --- stylesheets
    ---- weeler
    ----- app
    ------ index.css


## Usage

### Controllers, Views, Routes

Place weeler backend controllers in <tt>app/controllers/weeler/</tt> directory and view files in  <tt>app/views/weeler</tt> directory. Then add a route, a resource <tt>weeler_resources</tt> to this controller inside <tt>mount_weeler_at</tt> in <tt>config/routes.rb</tt>
All weeler contollers have to extend <tt>Weeler::BaseController</tt>.

### Menu

If you want your controller work under menu section, you should extend one of:
* <tt>Weeler::AdministrationController</tt> - for administration section;
* <tt>Weeler::ContentController</tt> - for content section;

Then you should append <tt>config.content_menu_items</tt> or <tt>config.administration_menu_items</tt> array with hash that contains: <tt>name</tt> for submenu name and <tt>weeler_path</tt> as string for relative weeler path. E.g.:

    config.content_menu_items = [
      {name: "Posts",         weeler_path: "posts"},
      {name: "Post comments", weeler_path: "comments"}
    ]

### acts_as_restful

Weeler action controller method.
It creates all restful actions for action controller. Create a controller for your
model (e.g. Post) what you want to administrate in weeler. Add method <tt>acts_as_restful Post</tt>
and permit params for your resource - option <tt>permit_params</tt>. Also you can paginate - add
option <tt>paginate</tt>
e.g.

    class Weeler::PostController < Weeler::ContentController
      acts_as_restful Post, permit_params: [:title, :body], paginate: 50
    end

It will handle <tt>:index</tt>, <tt>:new</tt>, <tt>:edit</tt>, <tt>:update</tt>,
<tt>:destroy</tt>, <tt>:order</tt>, <tt>:activation</tt> and <tt>:remove_image</tt> actions

For permiting custom by role or permiting all params (permit!),
you must add block <tt>permit_params: -> (params) { params.require(:post).permit! }</tt>

You can override redirect path after <tt>:create</tt>, <tt>:update</tt>, <tt>:destroy</tt> actions.
You can do this by overriding private methods in your controller.

    def after_create_path
      { action: :edit, id: @item.id }
    end

    def after_update_path
      { action: :edit, id: @item.id }
    end

    def after_destroy_path
      { action: :index }
    end

Or you can override what happens after successful <tt>:create</tt>, <tt>:update</tt>, <tt>:destroy</tt> actions.
You can do this by overriding private methods in your controller.

    def after_create_action
      redirect_to( after_create_path, {:notice => "Successfully created item"} )
    end

    def after_update_action
      redirect_to( after_update_path, {:notice => "Successfully updated item"} )
    end

    def after_destroy_action
      redirect_to( after_destroy_path, {:notice => "Successfully destroyed item"})
    end

You should implement form file with your own active record attributes.
To do that, create <tt>_form.html.haml</tt> in <tt>views/weeler/_YOUR_RESOURCE_/_form.html.haml</tt>
where <tt>_YOUR_RESOURCE_</tt> is name of your resource.

Also you can override all standart restful action view and implement, if you need,
<tt>_filter.html.haml</tt>

### View partials for restful controllers:

Weeler have default views for index, new, edit actions. You should override <tt>_form.html.haml</tt> partial.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request