interage-helpers 0.0.1

data/lib/generators/interage/helper/install/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Interage
+  module Helper
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Generates a application helpers.'
+
+      def create_application_helper
+        copy_file 'application_helper.rb', application_helper_path
+        copy_file 'application_helper.yml', application_locales_path
+      end
+
+      private
+
+      def application_helper_path
+        Rails.root.join('app/helpers/application_helper.rb')
+      end
+
+      def application_locales_path
+        Rails.root.join('config/locales/pt-BR/application_helper.yml')
+      end
+    end
+  end
+end

data/lib/generators/interage/helper/install/templates/application_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+  include ::Interage::ApplicationHelper
+end

data/lib/generators/interage/helper/install/templates/application_helper.yml

@@ -0,0 +1,124 @@
+pt-BR:
+  boolean:
+    truly: 'Sim'
+    falsely: 'Não'
+
+  application:
+    name: ''
+    destroy_confirm_message: Tem certeza que deseja apagar?
+
+  bootstrap:
+    alert:
+      icons:
+        default: info-circle
+        info: info-circle
+        warning: exclamation-triangle
+        success: check
+        notice: check
+        danger: ban
+        error: ban
+      subtitles:
+        info: Informação
+        warning: Atenção
+        success: Sucesso
+        notice: Sucesso
+        danger: Erro
+        error: Erro
+      not_found: Nenhum registro foi encontrado
+      male:
+        not_found: Nenhum %{model} foi encontrado
+      female:
+        not_found: Nenhuma %{model} foi encontrada
+
+  menu:
+    default:
+      index: Listar
+      create: Criar
+      update: Editar
+      show: Mostrar
+      destroy: Apagar
+
+    links:
+      new: Adicionar %{model}
+      show: Ver
+      edit: Editar
+      destroy: Apagar
+      cancel: Cancelar
+      duplicate: Duplicar
+      back: Voltar
+
+    icons:
+      new: plus
+      show: eye
+      edit: pencil
+      destroy: trash
+      cancel: ban
+      duplicate: files-o
+      back: arrow-left
+
+  buttons:
+    cocoon:
+      add:
+        icon: plus
+        text: adicionar
+      remove:
+        icon: times
+        text: excluir
+
+  icons_alias:
+    arrow-down: arrow_downward
+    arrow-left: arrow_back
+    arrow-right: arrow_forward
+    arrow-up: arrow_upward
+    arrows-h: compare_arrows
+    ban: cancel
+    bars: menu
+    bell: notifications
+    calendar: today
+    calendar-o: today
+    calendar-check-o: event_available
+    calendar-times-o: event_busy
+    calendar-minus-o: date_range
+    camera: camera_enhance
+    check: done
+    check-square: check_box
+    minus-square: indeterminate_check_box
+    chevron-down: expand_more
+    chevron-right: chevron_right
+    chevron-up: expand_less
+    chevron-left: chevron_left
+    cog: settings
+    cogs: settings
+    comment: mode_comment
+    comments: question_answer
+    dollar: attach_money
+    envelope: email
+    eye: visibility
+    exclamation-triangle: report_problem
+    info-circle: info
+    hdd-o: save_alt
+    paperclip: attachment
+    files-o: file_copy
+    file-pdf-o: picture_as_pdf
+    list-alt: reorder
+    money: local_atm
+    pencil: edit
+    pencil-square: rate_review
+    pencil-square-o: edit_location
+    picture-o: insert_photo
+    plus: add
+    plus-circle: add_circle
+    plus-square: add_circle_outline
+    key: vpn_key
+    search: search
+    sign-in: exit_to_app
+    sign-out: power_settings_new
+    square-o: crop_square
+    ticket: local_activity
+    times: clear
+    trash: delete_sweep
+    trash-o: delete_sweep
+    upload: cloud_upload
+    user: person
+    user-plus: person_add
+    users: people

data/lib/interage/application_helper.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Interage
+  module ApplicationHelper
+    include ::Interage::ApplicationIconHelper
+    include ::Interage::BootstrapHelper
+    include ::Interage::CEPHelper
+    include ::Interage::CNPJHelper
+    include ::Interage::CocoonHelper
+    include ::Interage::ControllerActiveHelper
+    include ::Interage::CPFHelper
+    include ::Interage::DateTimeHelper
+    include ::Interage::FaviconHelper
+    include ::Interage::FlashMessageHelper
+    include ::Interage::FontAwesomeHelper
+    include ::Interage::GravatarHelper
+    include ::Interage::LinkToHelper
+    include ::Interage::MaterialDesignIconsHelper
+    include ::Interage::NumberHelper
+    include ::Interage::PaginationHelper
+    include ::Interage::PhoneHelper
+    include ::Interage::TextHelper
+    include ::Interage::TranslationHelper
+    include ::Interage::VersionHelper
+
+    def format_seconds(seconds)
+      t('time.seconds.short', count: seconds)
+    end
+
+    def app_page_title(area = '')
+      strip_tags "#{env_name_upcase}#{page_title}#{area}#{app_name}"
+    end
+
+    def admin_page_title
+      app_page_title(ENV['PREFIX_ADMIN_PAGE_TITLE'])
+    end
+
+    def devise_page_title
+      app_page_title(ENV['PREFIX_DEVISE_PAGE_TITLE'])
+    end
+
+    def page_title
+      content_for?(:page_title) ? "#{content_for(:page_title)} » " : ''
+    end
+
+    def app_name
+      ENV.fetch('APP_NAME', t('application.name', default: rails_app_name))
+    end
+
+    def rails_app_name
+      rails_class = Rails.application.class
+
+      rails_class.try(:module_parent_name) || rails_class.parent_name
+    end
+
+    def env_name_upcase
+      "[#{env_name.upcase}] " if env_name.present?
+    end
+
+    def env_name
+      ENV['ENV_NAME']
+    end
+  end
+end

data/lib/interage/application_icon_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Interage
+  module ApplicationIconHelper
+    ALLOWED_FONT_ICONS = ['fa', 'md'].freeze
+    DEFAULT_FONT_ICON = ENV.fetch('DEFAULT_FONT_ICON', 'fa')
+
+    def app_icon(icon, options = {})
+      execute_method("#{DEFAULT_FONT_ICON}_icon", icon, options)
+    end
+
+    def app_icon_text(icon, text, options = {})
+      execute_method("#{DEFAULT_FONT_ICON}_icon_text", icon, text, options)
+    end
+
+    def app_icon_classes(icon, prefix, separator, options = {})
+      icon_classes = icon.to_s.split(' ').uniq.join(" #{separator}-")
+
+      "#{prefix} #{separator}-#{icon_classes} #{options[:class]}".strip
+    end
+
+    def execute_method(method_name, *arguments)
+      return unless ALLOWED_FONT_ICONS.include?(DEFAULT_FONT_ICON)
+
+      try(method_name, *arguments)
+    end
+  end
+end

data/lib/interage/bootstrap_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Interage
+  module BootstrapHelper
+    DEFAULT_BTN_CLASS = 'btn btn-sm btn-outline-'
+
+    def bootstrap_alert(type, message)
+      icon = t("bootstrap.alert.icons.#{type}", default: type)
+
+      content_tag :div, class: "no-margin alert alert-#{type}" do
+        app_icon_text(icon, message)
+      end
+    end
+
+    def bootstrap_alert_default(message)
+      bootstrap_alert(:default, message)
+    end
+
+    def bootstrap_alert_info(message)
+      bootstrap_alert(:info, message)
+    end
+
+    def bootstrap_alert_warning(message)
+      bootstrap_alert(:warning, message)
+    end
+
+    def bootstrap_alert_success(message)
+      bootstrap_alert(:success, message)
+    end
+
+    def bootstrap_alert_danger(message)
+      bootstrap_alert(:danger, message)
+    end
+
+    def bootstrap_alert_not_found(gender, model)
+      bootstrap_alert_info(text_not_found(gender, model))
+    end
+
+    def bootstrap_alert_not_found_male(model)
+      bootstrap_alert_not_found(:male, model)
+    end
+
+    def bootstrap_alert_not_found_female(model)
+      bootstrap_alert_not_found(:female, model)
+    end
+
+    def text_not_found(gender, model)
+      default_not_found = t('bootstrap.alert.not_found', default: '')
+
+      t("bootstrap.alert.#{gender}.not_found", model: tm(model).downcase,
+                                               default: default_not_found)
+    end
+
+    def text_not_found_male(model)
+      text_not_found(:male, model)
+    end
+
+    def text_not_found_female(model)
+      text_not_found(:female, model)
+    end
+
+    def bootstrap_default_btn_class(type)
+      default_btn_class = ENV.fetch('DEFAULT_BTN_TYPE_CLASS', DEFAULT_BTN_CLASS)
+
+      "#{default_btn_class}#{type} text-truncate"
+    end
+  end
+end

data/lib/interage/cep_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/parser_cep'
+
+module Interage
+  module CEPHelper
+    def format_cep(cep)
+      Interage::ParserCep.call(cep)
+    end
+  end
+end

data/lib/interage/cnpj_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/parser_cnpj'
+
+module Interage
+  module CNPJHelper
+    def format_cnpj(cnpj)
+      ParserCNPJ.call(cnpj)
+    end
+  end
+end

data/lib/interage/cocoon_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Interage
+  module CocoonHelper
+    def cocoon_link_to_add_association(form, association, options = {})
+      label = options[:label] || t('buttons.cocoon.add.text')
+      html_class =
+        options[:html_class] || bootstrap_default_btn_class('success')
+
+      link_to_add_association(form, association, class: html_class) do
+        app_icon_text(t('buttons.cocoon.add.icon'), label)
+      end
+    end
+
+    def cocoon_link_to_remove_association(form, label = nil)
+      label ||= t('buttons.cocoon.remove.text')
+      html_class = bootstrap_default_btn_class('danger')
+
+      content_tag :div, class: 'cocoon-link-to-remove' do
+        link_to_remove_association(form, class: html_class, title: label) do
+          app_icon_text(t('buttons.cocoon.remove.icon'), label)
+        end
+      end
+    end
+  end
+end

data/lib/interage/controller_active_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Interage
+  module ControllerActiveHelper
+    HTML_SHOW_CLASS = ENV.fetch('CONTROLLER_SHOW_CLASS', 'show')
+    HTML_ACTIVE_CLASS = ENV.fetch('CONTROLLER_ACTIVE_CLASS', 'active')
+
+    def menu_class_show(*controllers)
+      HTML_SHOW_CLASS if current_controller?(*controllers)
+    end
+
+    def menu_active(*controllers)
+      HTML_ACTIVE_CLASS if current_controller?(*controllers)
+    end
+    alias menu_class_active menu_active
+
+    def current_controller?(*controllers)
+      controllers = controllers.is_a?(Array) ? controllers : [controllers]
+
+      controllers.include?(params[:controller])
+    end
+  end
+end

data/lib/interage/cpf_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/parser_cpf'
+
+module Interage
+  module CPFHelper
+    def format_cpf(cpf)
+      ParserCPF.call(cpf)
+    end
+  end
+end

data/lib/interage/date_time_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Interage
+  module DateTimeHelper
+    def business_days_from_now(days = 2)
+      date = days.to_i.business_days.from_now.to_date
+
+      return l(date) if business_day?(date)
+
+      business_days_from_now(days + 1)
+    end
+
+    def business_day?(date)
+      Holidays.on(date, :br).empty? && date.to_date.workday?
+    end
+
+    def format_date(date, date_format = :date_time)
+      l(date, format: date_format)
+    end
+
+    def format_time(time)
+      return if time.blank?
+
+      time.strftime('%H:%M')
+    end
+  end
+end

data/lib/interage/favicon_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Interage
+  module FaviconHelper
+    EXTENTION = ENV.fetch('FAVICON_EXTENTION', 'png')
+    FILE_NAME = ENV.fetch('FAVICON_FILE_NAME', 'icons/apple-touch-icon')
+    FAVICON_SIZES = [nil, 57, 72, 76, 114, 120, 144, 152, 180].freeze
+
+    def favicon_link_tags
+      safe_join favicon_size_link_tags.push(favicon_link_tag)
+    end
+
+    def favicon_size_link_tags
+      FAVICON_SIZES.map do |s|
+        favicon_link_tag(handler_name(s), favicon_options(s))
+      end
+    end
+
+    def handler_name(size)
+      "#{FILE_NAME}#{handler_size(size, '-')}.#{EXTENTION}"
+    end
+
+    def favicon_options(size)
+      { type: 'image/png', rel: 'apple-touch-icon', sizes: handler_size(size) }
+    end
+
+    def handler_size(size, prefix = '')
+      "#{prefix}#{size}x#{size}" if size.present?
+    end
+  end
+end

data/lib/interage/flash_message_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Interage
+  module FlashMessageHelper
+    def flash_messages
+      messages ||= flashes.map do |type, message|
+        bootstrap_alert(handle_type(type), message)
+      end
+
+      safe_join(messages || [])
+    end
+
+    def flashes
+      flash.to_h.symbolize_keys
+    end
+
+    def handle_type(type)
+      type == :notice ? :success : type
+    end
+  end
+end

data/lib/interage/font_awesome_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Interage
+  module FontAwesomeHelper
+    def fa_icons
+      t('icons_alias', default: {}).keys
+    end
+
+    def fa_icon(icon, options = {})
+      content_tag :i, nil, options.merge(class: fa_classes(icon, options))
+    end
+
+    def fa_fw_icon(icon, options = {})
+      fa_icon("fw #{icon}", options)
+    end
+
+    def fa_icon_text(icon, text, options = {})
+      content_tag :span do
+        concat fa_fw_icon(icon, options)
+        concat text
+      end
+    end
+
+    def fa_classes(icon, options = {})
+      icon_classes = icon.to_s.split(' ').uniq.join(' fa-')
+
+      "fa fa-#{icon_classes} #{options[:class]}".strip
+    end
+  end
+end

data/lib/interage/gravatar_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Interage
+  module GravatarHelper
+    BASE_URL = 'https://www.gravatar.com/avatar'
+
+    def gravatar_image_tag(email, size = 50, options = {})
+      hexdigest = Digest::MD5.hexdigest(email)
+
+      image_tag("#{BASE_URL}/#{hexdigest}?size=#{size}", options)
+    end
+  end
+end

data/lib/interage/helpers/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Interage
+  module Helper
+    VERSION = '0.0.1'
+  end
+end

data/lib/interage/helpers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'interage/helpers/version'
+require 'active_support/core_ext/module'
+
+module Interage
+  module Helper
+    class Error < StandardError
+    end
+  end
+
+  autoload :ApplicationHelper, 'interage/application_helper'
+  autoload :ApplicationIconHelper, 'interage/application_icon_helper'
+  autoload :BootstrapHelper, 'interage/bootstrap_helper'
+  autoload :CEPHelper, 'interage/cep_helper'
+  autoload :CNPJHelper, 'interage/cnpj_helper'
+  autoload :CocoonHelper, 'interage/cocoon_helper'
+  autoload :ControllerActiveHelper, 'interage/controller_active_helper'
+  autoload :CPFHelper, 'interage/cpf_helper'
+  autoload :DateTimeHelper, 'interage/date_time_helper'
+  autoload :FaviconHelper, 'interage/favicon_helper'
+  autoload :FlashMessageHelper, 'interage/flash_message_helper'
+  autoload :FontAwesomeHelper, 'interage/font_awesome_helper'
+  autoload :GravatarHelper, 'interage/gravatar_helper'
+  autoload :LinkToHelper, 'interage/link_to_helper'
+  autoload :MaterialDesignIconsHelper, 'interage/material_design_icons_helper'
+  autoload :NumberHelper, 'interage/number_helper'
+  autoload :PaginationHelper, 'interage/pagination_helper'
+  autoload :PhoneHelper, 'interage/phone_helper'
+  autoload :TextHelper, 'interage/text_helper'
+  autoload :TranslationHelper, 'interage/translation_helper'
+  autoload :VersionHelper, 'interage/version_helper'
+end

data/lib/interage/link_to_helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Interage
+  module LinkToHelper
+    ASIDE_DEFAULT_CLASS = 'list-group-item'
+    PREFIX_BUTTON_CLASS = 'btn btn-sm btn-outline-'
+    DESTROY_CONFIRM_MESSAGE = 'Tem certeza que deseja apagar?'
+    NEW_BUTTON_CLASS = 'btn text-truncate btn-outline-application'
+
+    def aside_link_to(text, url = '#', html_options = {})
+      html_options[:class] = "#{ASIDE_DEFAULT_CLASS} #{html_options[:class]}"
+      html_options[:title] = strip_tags(text)
+
+      link_to text, url, html_options
+    end
+
+    def link_to_modal(text, url = '#', html_options = {})
+      link_to text, url, html_options.merge('data-toggle': 'modal')
+    end
+
+    def link_to_new(resource, url)
+      text = t('menu.links.new', model: tm(resource).downcase)
+
+      link_to url, title: strip_tags(text), class: NEW_BUTTON_CLASS do
+        app_icon_text(t('menu.icons.new'), text)
+      end
+    end
+
+    def link_to_edit(url)
+      link_to_default(:edit, url, class: button_class('info'))
+    end
+
+    def link_to_back(url)
+      link_to_default(:back, url, class: button_class('secondary'))
+    end
+
+    def link_to_show(url)
+      link_to_default(:show, url, class: button_class('dark'))
+    end
+
+    def link_to_destroy(url, html_options = {})
+      html_options.merge!(method: :delete,
+                          'data-confirm' => destroy_confirm_message,
+                          class: button_class('danger', html_options[:class]))
+
+      link_to_default(:destroy, url, html_options)
+    end
+
+    def link_to_default(type, url, html_options = {})
+      text = t("menu.links.#{type}")
+      html_options = html_options.merge(title: strip_tags(text),
+                                        data: { tooltip: 'top' })
+
+      link_to(app_icon_text(t("menu.icons.#{type}"), text), url, html_options)
+    end
+
+    def button_class(type, addicional_class = nil)
+      "#{PREFIX_BUTTON_CLASS}#{type} #{addicional_class}"
+    end
+
+    def destroy_confirm_message
+      t('application.destroy_confirm_message', default: DESTROY_CONFIRM_MESSAGE)
+    end
+  end
+end

data/lib/interage/material_design_icons_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Interage
+  module MaterialDesignIconsHelper
+    def md_icon(icon, options = {})
+      icon_classes = icon.to_s.split(' ')
+      icon = icon_classes.shift
+
+      content_tag :i, class: md_classes(icon, options) do
+        t("icons_alias.#{icon}", default: icon)
+      end
+    end
+
+    def md_icon_text(icon, text, options = {})
+      content_tag :span do
+        concat md_icon(icon, options)
+        concat " #{text}"
+      end
+    end
+
+    def md_classes(icon, options = {})
+      app_icon_classes(icon, 'material-icons', 'md', options)
+    end
+  end
+end

data/lib/interage/number_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Interage
+  module NumberHelper
+    def default_currency_format(number, precision = 2, unit = 'R$')
+      number_to_currency(number, precision: precision, unit: unit)
+    end
+
+    def only_numbers(number)
+      number.to_s.gsub(/[^0-9]/, '')
+    end
+  end
+end