Criando um Sistema Administrativo Completo com Rails Admin

Introdução

Neste Screencast, dividido em 5 partes, nós vamos criar um sistema administrativo completo usando Rails Admin, neste exemplo vamos criar uma plataforma para que uma empresa possa gerenciar as vendas do seus representantes comerciais com dois tipos de usuário: gerente e vendedor. O vendedor poderá entrar com novas vendas, clientes e ver as suas comissões, o gerente poderá criar produtos, descontos e outros usuários.

Também vamos aprender a implementar uma série de features úteis e comuns à maioria dos APPs como autenticação usando Devise, autorização usando CanCanCan, filtro de registros baseado em quem é o dono deles, upload de fotos, customização da aparência e exportação de dados para PDF usando gráficos.

Este é o primeiro tutorial do OneBitCode dividido em vários episódios em vídeos para aumentar o detalhamento e simplificar a explicação, então se você gostar desse formato deixa um feedback ainda em baixo para eu saber e produzir mais conteúdo como este.

Episódios

1. Criando a estrutura do nosso Projeto + Seed (assistir)
2. Autenticação + Autorização + Filtrando os resultados (assistir)
3. Incluindo fotos + Atribuição automática de comissão (assistir)
4. Configurando o Rails Admin + Customizando a aparência (assistir)
5. Exportando para PDF com gráficos + Testando tudo isto (disponível)

O que vamos Aprender?

1. Como criar um sistema administrativo
2. Como implementar a autenticação
3. Como implementar a autorização
4. Como filtrar para que os vendedores vejam apenas seus próprios clientes, vendas e comissões
5. Adicionando comissão automaticamente
6. Como receber fotos no nosso sistema administrativo
7. Como customizar a aparência do nosso sistema administrativo
8. Como exportar para PDF e gerar gráficos (Neste episódio)

Ingredientes

1. Ruby on Rails
2. Sqlite3 (Mas você pode usar outro Database :))
3. Gem: Rails Admin
4. Gem: Rails Admin Rollincode
5. Gem: Devise
6. Gem: CanCanCan
7. Gem: Carrierwave

Lista de comandos utilizados no Screencast parte 5

Crie o arquivo “rails_admin_pdf.rb” no seguinte path “/lib/rails_admin” e coloque este conteúdo:

module RailsAdminPdf
end

require 'rails_admin/config/actions'
require 'prawn'
require 'gruff'

module RailsAdmin
  module Config
    module Actions
      class Pdf < Base RailsAdmin::Config::Actions.register(self) register_instance_option :member do true end register_instance_option :pjax? do false end register_instance_option :controller do Proc.new do # Configurando PDF PDF_OPTIONS = { :page_size => "A4",
              :page_layout => :portrait,
              :margin      => [40, 75]
            }

            # Configurando Retorno
            ramdom_file_name = (0...8).map { (65 + rand(26)).chr }.join

            Prawn::Document.new(PDF_OPTIONS) do |pdf|
              pdf.fill_color "666666"
              pdf.text "Relatório do Representante", :size => 32, :style => :bold, :align => :center
              pdf.move_down 80

              pdf.text "Dados Pessoais", :size => 14, :align => :justify, :inline_format => true, :style => :bold
              pdf.move_down 14

              if @object.name
                pdf.text "Nome: #{@object.name}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 8
              end

              if @object.document
                pdf.text "Documento: #{@object.document}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 8
              end

              if @object.kind
                pdf.text "Tipo: #{@object.kind}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 8
              end

              if @object.status
                pdf.text "Status: #{@object.status}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 8
              end

              if @object.email
                pdf.text "Email: #{@object.email}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 8
              end

              pdf.move_down 20

              if @object.comissions.where(status: :pending).count > 0

                pdf.text "Comissões Pendentes", :size => 14, :align => :justify, :inline_format => true, :style => :bold
                pdf.move_down 14

                total = 0

                @object.comissions.where(status: :pending).each do |c|
                  pdf.text "Id #{c.id}, valor R$#{c.value}, gerada em #{c.created_at.strftime("%d/%m/%y as %H:%M")}",
                    :size => 12, :align => :justify, :inline_format => true
                  pdf.move_down 8

                  total += c.value
                end

                pdf.move_down 10
                pdf.text "Total: R$#{total}", :size => 12, :align => :justify, :inline_format => true
                pdf.move_down 20
              end


              if @object.clients.count > 0

                pdf.text "Clientes Ativos", :size => 14, :align => :justify, :inline_format => true, :style => :bold
                pdf.move_down 14

                total = 0

                @object.clients.each do |c|
                  pdf.text "#{c.name}",
                    :size = 12, :align = :justify, :inline_format = true, :style = :bold
                  pdf.move_down 8

                  pdf.text "Da empresa: #{c.company_name}",
                    :size = 12, :align = :justify, :inline_format = true
                  pdf.move_down 8

                  pdf.text "Cliente desde #{c.created_at.strftime("%d/%m/%y as %H:%M")}",
                    :size = 12, :align = :justify, :inline_format = true
                  pdf.move_down 8

                  total += 1
                end

                pdf.move_down 10
                pdf.text "Total: #{total}", :size = 12, :align = :justify, :inline_format = true
                pdf.move_down 20
              end


              if @object.sales.count  0
                # Cria o objeto Gruff
                g = Gruff::Pie.new 900
                g.theme = Gruff::Themes::PASTEL

                # Aqui ele formata nossos dados
                sales_values = {}
                @object.sales.each do |sale|
                  calc = 0
                  sale.product_quantities.each {|p| calc += p.product.price * p.quantity}
                  sales_values[sale.client.name] = (sales_values[sale.client.name])? sales_values[sale.client.name] + calc : calc
                end

                sales_values.each {|key, value| g.data(key, value)}

                # Gera a imagem no diretório público (você pode escolher onde gerar)
                g.write('public/graph.jpg')

                pdf.start_new_page

                pdf.text "Gráfico de Vendas", :size = 20, :style = :bold, :align = :center

                # Incluir o gráfico numero 2
                pdf.image "public/graph.jpg", :scale = 0.50
              end


              # Muda de font para Helvetica
              pdf.font "Helvetica"
              # Inclui um texto com um link clicável (usando a tag link) no bottom da folha do lado esquerdo e coloca uma cor especifica nessa parte (usando a tag color)
              pdf.text "Link Para o Manul do Prawn clicável", :size = 10, :inline_format = true, :valign = :bottom, :align = :left
              # Inclui em baixo da folha do lado direito a data e o némero da página usando a tag page
              pdf.number_pages "Gerado: #{(Time.now).strftime("%d/%m/%y as %H:%M")} - Página ", :start_count_at = 0, :page_filter = :all, :at = [pdf.bounds.right - 140, 7], :align = :right, :size = 8
              # Gera no nosso PDF e coloca na pasta public com o nome agreement.pdf
              pdf.render_file("public/#{ramdom_file_name}.pdf")
            end

            File.open("public/#{ramdom_file_name}.pdf", 'r') do |f|
              send_data f.read.force_encoding('BINARY'), :filename = 'pdf', :type = "application/pdf", :disposition = "attachment"
            end
            File.delete("public/#{ramdom_file_name}.pdf")
            File.delete("public/graph.jpg") if @object.sales.count  0
          end
        end

        register_instance_option :link_icon do
          'fa fa-file-pdf-o'
        end
      end
    end
  end
end

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

module RailsAdminPdf

end

require 'rails_admin/config/actions'

require 'prawn'

require 'gruff'

module RailsAdmin

module Config

module Actions

class Pdf < Base RailsAdmin::Config::Actions.register(self) register_instance_option :member do true end register_instance_option :pjax? do false end register_instance_option :controller do Proc.new do # Configurando PDF PDF_OPTIONS = { :page_size => "A4",

:page_layout => :portrait,

:margin => [40, 75]

}

# Configurando Retorno

ramdom_file_name = (0...8).map { (65 + rand(26)).chr }.join

Prawn::Document.new(PDF_OPTIONS) do |pdf|

pdf.fill_color "666666"

pdf.text "Relatório do Representante", :size => 32, :style => :bold, :align => :center

pdf.move_down 80

pdf.text "Dados Pessoais", :size => 14, :align => :justify, :inline_format => true, :style => :bold

pdf.move_down 14

if @object.name

pdf.text "Nome: #{@object.name}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

end

if @object.document

pdf.text "Documento: #{@object.document}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

end

if @object.kind

pdf.text "Tipo: #{@object.kind}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

end

if @object.status

pdf.text "Status: #{@object.status}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

end

if @object.email

pdf.text "Email: #{@object.email}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

end

pdf.move_down 20

if @object.comissions.where(status: :pending).count > 0

pdf.text "Comissões Pendentes", :size => 14, :align => :justify, :inline_format => true, :style => :bold

pdf.move_down 14

total = 0

@object.comissions.where(status: :pending).each do |c|

pdf.text "Id #{c.id}, valor R$#{c.value}, gerada em #{c.created_at.strftime("%d/%m/%y as %H:%M")}",

:size => 12, :align => :justify, :inline_format => true

pdf.move_down 8

total += c.value

end

pdf.move_down 10

pdf.text "Total: R$#{total}", :size => 12, :align => :justify, :inline_format => true

pdf.move_down 20

end

if @object.clients.count > 0

pdf.text "Clientes Ativos", :size => 14, :align => :justify, :inline_format => true, :style => :bold

pdf.move_down 14

total = 0

@object.clients.each do |c|

pdf.text "#{c.name}",

:size = 12, :align = :justify, :inline_format = true, :style = :bold

pdf.move_down 8

pdf.text "Da empresa: #{c.company_name}",

:size = 12, :align = :justify, :inline_format = true

pdf.move_down 8

pdf.text "Cliente desde #{c.created_at.strftime("%d/%m/%y as %H:%M")}",

:size = 12, :align = :justify, :inline_format = true

pdf.move_down 8

total += 1

end

pdf.move_down 10

pdf.text "Total: #{total}", :size = 12, :align = :justify, :inline_format = true

pdf.move_down 20

end

if @object.sales.count 0

# Cria o objeto Gruff

g = Gruff::Pie.new 900

g.theme = Gruff::Themes::PASTEL

# Aqui ele formata nossos dados

sales_values = {}

@object.sales.each do |sale|

calc = 0

sale.product_quantities.each {|p| calc += p.product.price * p.quantity}

sales_values[sale.client.name] = (sales_values[sale.client.name])? sales_values[sale.client.name] + calc : calc

end

sales_values.each {|key, value| g.data(key, value)}

# Gera a imagem no diretório público (você pode escolher onde gerar)

g.write('public/graph.jpg')

pdf.start_new_page

pdf.text "Gráfico de Vendas", :size = 20, :style = :bold, :align = :center

# Incluir o gráfico numero 2

pdf.image "public/graph.jpg", :scale = 0.50

end

# Muda de font para Helvetica

pdf.font "Helvetica"

# Inclui um texto com um link clicável (usando a tag link) no bottom da folha do lado esquerdo e coloca uma cor especifica nessa parte (usando a tag color)

pdf.text "Link Para o Manul do Prawn clicável", :size = 10, :inline_format = true, :valign = :bottom, :align = :left

# Inclui em baixo da folha do lado direito a data e o némero da página usando a tag page

pdf.number_pages "Gerado: #{(Time.now).strftime("%d/%m/%y as %H:%M")} - Página ", :start_count_at = 0, :page_filter = :all, :at = [pdf.bounds.right - 140, 7], :align = :right, :size = 8

# Gera no nosso PDF e coloca na pasta public com o nome agreement.pdf

pdf.render_file("public/#{ramdom_file_name}.pdf")

end

File.open("public/#{ramdom_file_name}.pdf", 'r') do |f|

send_data f.read.force_encoding('BINARY'), :filename = 'pdf', :type = "application/pdf", :disposition = "attachment"

end

File.delete("public/#{ramdom_file_name}.pdf")

File.delete("public/graph.jpg") if @object.sales.count 0

end

register_instance_option :link_icon do

'fa fa-file-pdf-o'

end

Agora no seu Gemfile adicione:

Ruby

# Gem para gerar os pdfs gem 'prawn-rails' # Gem para gerar os gráficos gem 'gruff'

1
2
3
4

# Gem para gerar os pdfs
gem 'prawn-rails'
# Gem para gerar os gráficos
gem 'gruff'
Para instalar as dependencias da Gem Gruff caso você esteja no Ubuntu rode no console:

Ruby

sudo apt-get install imagemagick libmagickcore-dev libmagickwand-dev

1

sudo apt-get install imagemagick libmagickcore-dev libmagickwand-dev
Caso você esteja no Mac, rode:

Ruby

brew install imagemagick

1

brew install imagemagick
Para instalar as Gems, rode no console:

Ruby

bundle

1

bundle

Agora coloque no seu arquivo de configuração do Rails Admin “/config/initializers/rails_admin.rb” o seguinte conteúdo:

RailsAdmin.config do |config|

  require Rails.root.join('lib', 'rails_admin', 'rails_admin_pdf.rb')
  RailsAdmin::Config::Actions.register(RailsAdmin::Config::Actions::Pdf)

  ### Popular gems integration

  ## == Devise ==
  config.authenticate_with do
    warden.authenticate! scope: :user
  end
  config.current_user_method(&&current_user)

  ## == Cancan ==
  config.authorize_with :cancan

  ## == Pundit ==
  # config.authorize_with :pundit

  ## == PaperTrail ==
  # config.audit_with :paper_trail, 'User', 'PaperTrail::Version' # PaperTrail = 3.0.0

  ### More at https://github.com/sferik/rails_admin/wiki/Base-configuration

  ## == Gravatar integration ==
  ## To disable Gravatar integration in Navigation Bar set to false
  # config.show_gravatar true

  config.navigation_static_links = {
    'OneBitCode' = 'https://onebitcode.com'
  }
  config.navigation_static_label = "Lins Úteis"

  config.main_app_name = ["Representantes Comerciais", ""]

  config.model Sale do
    navigation_icon 'fa fa-money'
    create do
      field  :client
      field  :sale_date
      field  :discount
      field  :notes
      field  :product_quantities

      field :user_id, :hidden do
        default_value do
          bindings[:view]._current_user.id
        end
      end
    end

    edit do
      field  :client
      field  :sale_date
      field  :discount
      field  :notes
      field  :product_quantities

      field :user_id, :hidden do
        default_value do
          bindings[:view]._current_user.id
        end
      end
    end
  end

  config.model Client do
    create do
      field  :name
      field  :company_name
      field  :document
      field  :email
      field  :phone
      field  :notes
      field  :status
      field  :address

      field :user_id, :hidden do
        default_value do
          bindings[:view]._current_user.id
        end
      end
    end

    edit do
      field  :name
      field  :company_name
      field  :document
      field  :email
      field  :phone
      field  :notes
      field  :status
      field  :address


      field :user_id, :hidden do
        default_value do
          bindings[:view]._current_user.id
        end
      end
    end

    list do
      field  :name
      field  :company_name
      field  :document
      field  :email
      field  :phone
      field  :notes
      field  :status
      field  :address

    end
  end


  config.model Discount do
    parent Product
  end

  config.model Sale do
    parent User
    weight -2
  end

  config.model Comission do
    parent User
    weight -1
  end

  config.model Client do
    parent User
  end

  config.model ProductQuantity do
    visible false
  end

  config.model Address do
    visible false
  end


  config.model ProductQuantity do
    edit do
      field :product
      field :quantity

      field :user_id, :hidden do
        default_value do
          bindings[:view]._current_user.id
        end
      end
    end
  end


  config.actions do
    dashboard                     # mandatory
    index                         # mandatory
    new
    export
    bulk_delete
    show
    edit
    delete
    show_in_app
    pdf do
      only User
    end

    ## With an audit adapter, you can add:
    # history_index
    # history_show
  end
end

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

RailsAdmin.config do |config|

require Rails.root.join('lib', 'rails_admin', 'rails_admin_pdf.rb')

RailsAdmin::Config::Actions.register(RailsAdmin::Config::Actions::Pdf)

### Popular gems integration

## == Devise ==

config.authenticate_with do

warden.authenticate! scope: :user

end

config.current_user_method(&&current_user)

## == Cancan ==

config.authorize_with :cancan

## == Pundit ==

# config.authorize_with :pundit

## == PaperTrail ==

# config.audit_with :paper_trail, 'User', 'PaperTrail::Version' # PaperTrail = 3.0.0

### More at https://github.com/sferik/rails_admin/wiki/Base-configuration

## == Gravatar integration ==

## To disable Gravatar integration in Navigation Bar set to false

# config.show_gravatar true

config.navigation_static_links = {

'OneBitCode' = 'https://onebitcode.com'

}

config.navigation_static_label = "Lins Úteis"

config.main_app_name = ["Representantes Comerciais", ""]

config.model Sale do

navigation_icon 'fa fa-money'

create do

field :client

field :sale_date

field :discount

field :notes

field :product_quantities

field :user_id, :hidden do

default_value do

bindings[:view]._current_user.id

end

edit do

field :client

field :sale_date

field :discount

field :notes

field :product_quantities

field :user_id, :hidden do

default_value do

bindings[:view]._current_user.id

end

config.model Client do

create do

field :name

field :company_name

field :document

field :email

field :phone

field :notes

field :status

field :address

field :user_id, :hidden do

default_value do

bindings[:view]._current_user.id

end

edit do

field :name

field :company_name

field :document

field :email

field :phone

field :notes

field :status

field :address

field :user_id, :hidden do

default_value do

bindings[:view]._current_user.id

end

list do

field :name

field :company_name

field :document

field :email

field :phone

field :notes

field :status

field :address

end

config.model Discount do

parent Product

end

config.model Sale do

parent User

weight -2

end

config.model Comission do

parent User

weight -1

end

config.model Client do

parent User

end

config.model ProductQuantity do

visible false

end

config.model Address do

visible false

end

config.model ProductQuantity do

edit do

field :product

field :quantity

field :user_id, :hidden do

default_value do

bindings[:view]._current_user.id

end

config.actions do

dashboard # mandatory

index # mandatory

new

export

bulk_delete

show

edit

delete

show_in_app

pdf do

only User

end

## With an audit adapter, you can add:

# history_index

# history_show

end

Pronto \o/

12 formas de vencer o bloqueio criativo e escrever textos memoráveis (e 6 dicas extras)

Não perca nenhum conteúdo

Receba nosso resumo semanal com os novos posts, cursos, talks e vagas o/

Conclusão – Parte 5

Nesta parte nós aprendemos como criar uma custom action capaz de exportar em PDF um resumo sobre os vendedores com um gráfico. Este foi o último vídeo desta parte da nossa série (Pode ser que tenhamos uma segundo parte onde vamos colocar o site no ar permitindo que as empresas usem o sistema), então se você quer uma segunda parte comente ai em báixo :).

Obrigado por acompanhar nossa primeira série, logo teremos mais como esta para trazer ainda mais conteúdos para você \o/

Veja as partes anteriores da série:

Parte 1
Parte 2
Parte 3
Parte 4

Você pode ver o código completo acessando o projeto no Github dating agencies preston lancashire e escolhendo a branch “Part5”, aproveita e me segue lá também 🙂

Muito Obrigado por acompanhar este Blog!
Sua presença aqui é uma honra para mim,

Abraço,
Leonardo Scorza.

Primeira vez no OneBitCode? Curtiu esse conteúdo?
O OneBitCode tem muito mais para você!

O OneBitCode traz conteúdos de qualidade, e em português, sobre programação com foco em Ruby on Rails e também JavaScript.
Além disso, aqui sempre levamos à você conteúdos valiosos sobre a carreira de programação, dicas sobre currículos, portfólios, perfil profissional, soft skills, enfim, tudo o que você precisa saber para continuar evoluindo como Programador(a)!

Fique por dentro de todos os conteúdos o/

Nossas redes sociais:

📹 • https://onebitcode.com/dating-sites-pakistani/ [Live todas as terças-feiras às 19h)
💻 • https://onebitcode.com/ex-girlfriend-dating-your-friend/
🙂 • https://facebook.com/onebitcode
📱 • https://instagram.com/one_bit_code
🐦 • https://twitter.com/onebitcode

Nossos cursos:

🥇 • Programador Full Stack Javascript em 8 Semanas
💎 • Curso Completo de Ruby
⚙ • Minicurso: API Rails 5 Completo
🐞 • Minicurso de Testes para Ruby on Rails com RSpec

Espero que curta nossos conteúdos e sempre que precisar de ajuda, fala com a gente!
Estamos aqui para você 🙂

Bem-vindo à família OneBitCode o/

janeiro 17, 2020

Criando um Sistema Administrativo Completo com Rails Admin – PARTE 5

Introdução

Episódios

O que vamos Aprender?

Ingredientes

Lista de comandos utilizados no Screencast parte 5

Não perca nenhum conteúdo

Receba nosso resumo semanal com os novos posts, cursos, talks e vagas o/

Primeira vez no OneBitCode? Curtiu esse conteúdo? O OneBitCode tem muito mais para você!

Nossas redes sociais:

Nossos cursos:

Primeira vez no OneBitCode? Curtiu esse conteúdo?
O OneBitCode tem muito mais para você!