# BaseEditingBootstrap
[![Gem Version](https://badge.fury.io/rb/base_editing_bootstrap.svg)](https://badge.fury.io/rb/base_editing_bootstrap)

WIP

## Installation
Add this line to your application's Gemfile:

```ruby
gem "base_editing_bootstrap"
```

And then execute:
```bash
$ bundle
```

Or install it yourself as:
```bash
$ gem install base_editing_bootstrap
```

Then run installer:
```bash
$ bundle exec rails g base_editing_bootstrap:install
```

### Generators
Then Install dependency (if you run base_editing_bootstrap:install you are good to go):
```bash

bundle exec rails g pundit:install
```
Aggiungere ad ApplicationController 
```ruby
  include Pundit::Authorization
```

Installare bootstrap e questo dipende dal sistema scelto di assets bundling.  
La versione più semplice è attraverso: https://github.com/rails/cssbundling-rails  
Una volta installato basta lanciare bin/rails css:install:bootstrap come da
documentazione e avrete la vostra versione di boostrap installata.

Installare `gem "factory_bot_rails"`

### Initializers
E' possibile configurare BaseEditingBootstrap con alcune impostazioni:
```ruby
  BaseEditingBootstrap.configure do |config|
    ##
    # Controller da cui derivare poi il BaseEditingController da cui derivano 
    # tutti i controller sottostanti
    # @default "ApplicationController"
    # config.inherited_controller = 'ApplicationController'

    ##
    # Configurazione per alterare lo standard di azione post aggiornamento record
    # il default è andare nella pagina di editing del record
    # possibili valori :edit , :index
    # config_accessor :after_success_update_redirect, default: :edit

    ##
    # Configurazione per alterare lo standard di azione post creazione record
    # il default è andare nella pagina di editing del record
    # possibili valori :edit , :index  
    # config_accessor :after_success_create_redirect, default: :edit
  
  end

```

## Usage
Utilizzo per modello base, in questo esempio prendiamo come modello Post come esempio del dummy.

- Creare il Modello ed includere 
  ```ruby
   include BaseEditingBootstrap::BaseModel
  ```
- La factory nelle spec deve contenere il trait `with_invalid_attributes` per definire la situazione di dati per record
  non valido. ES:  
  ```ruby
  trait :with_invalid_attributes do
   name {nil} # name dovrebbe essere obbligatorio nel modello
  end
  ```
- Creare Controller:
  ```ruby
    class PostsController < BaseEditingController
      ##
      # Set default sort order for ransack
      # self.default_sort= ["id"] 
    end
  ```
- Aggiungere la rotta: `resources :posts`
- Creare la policy:
  ```ruby
  class PostPolicy < BaseModelPolicy
  
    def editable_attributes
      [
      :title,
      :description
      ]
    end
    
    def permitted_attributes
      [
      :title,
      :description
      ]
    end
    
    def search_result_fields
      [:title]
    end
  
  end

  ```
- [OPTIONAL] nel caso si volesse fare override dei campi della form chiamare il generatore:
  ```shell
  rails g base_editing_bootstrap:field_override ModelName field1 field2:type
  ```
- [OPTIONAL] la medesima cosa è possibile fare con il rendering dei campi
  delle celle della tabella
  ```shell
  rails g base_editing_bootstrap:cell_override ModelName field1 field2:type
  ```
- [OPTIONAL] Base overrides:  
  E' possibile anche fare un override generico dei campi, sono previsti questi tipi di partial
  legati al tipo di dati:  
  **Cell Field**:
  - created_at => timestamps.html.erb
  - updated_at => timestamps.html.erb
  - default    => base.html.erb
  **Form Field**
  - Integer           => _integer.html.erb
  - Float             => _decimal.html.erb
  - Decimal           => _decimal.html.erb
  - DateTime          => _detetime.html.erb
  - Date              => _date.html.erb
  - Enum              => _enum.html.erb
    Per gli enum, le traduzioni dei labels di ogni valore provvengono da i18n
    attraverso l'helper: `Utilities::EnumHelper#enum_translation`
    il quale utilizza il nome dell'attributo con 
  - Default/String    => _base.html.erb
  
  In futuro si prevede di aggiungere automatismi per renderizzare senza 
  l'intervento dell'utente dei campi.
- [OPTIONAL] Search Form:  
  Per poter aggiungere una form di ricerca basta aggiungere alla policy
  del modello in questione i campi di ricerca che verranno poi utilizzati da ransack
  per eseguire le ricerche  
  ES:
  ```ruby 
  # file app/policies/post_policy.rb
  #...
  def search_fields
  [:title_i_cont]
  end
  #...
  ```

## Testing helpers

### Requirements(installed with generators)
```ruby
group :test do
  gem 'rails-controller-testing'
end
```
### Usage 
Controllers:
```ruby
require 'rails_helper'
RSpec.describe "ServiceControllers", type: :request do
  it_behaves_like "as logged in user" do
    it_behaves_like "base editing controller", factory: :service
  end
end
```
Model:
```ruby
require 'rails_helper'
RSpec.describe Service, type: :model do
  it_behaves_like "a base model",
                  ransack_permitted_attributes: %w[created_at id last_status name stack_id updated_at],
                  ransack_permitted_associations: []
end
```
Policy
```ruby
require 'rails_helper'
##
# - check_default_responses default false, to check default responses
#    
#    on true all are true
#    [:show?, true], 
#    [:destroy?, true],
#    [:update?, true],
#    [:create?, true],
#    [:index?, true],
#
#    when hash keys are:
#    - show
#    - destroy
#    - update
#    - create
#    - index
# 
RSpec.describe ServicePolicy, type: :policy do
  it_behaves_like "a standard base model policy", :service, check_default_responses: false
end
```


## Contributing
Contribution directions go here.

## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).