bmc 1.0.0

data/app/helpers/bmc/button_helper.rb

@@ -0,0 +1,150 @@
+module BMC::ButtonHelper
+  class << self
+    attr_writer :default_size, :default_style
+
+    def default_size
+      @default_size ||= :sm
+    end
+
+    def default_style
+      @default_style ||= :outline_primary
+    end
+  end
+
+  def bs_button( # rubocop:disable Metrics/ParameterLists
+    url,
+    method: :get,
+    confirm: nil,
+    text: nil,
+    icon:,
+    action: nil,
+    title: text,
+    btn_size: BMC::ButtonHelper.default_size,
+    btn_style: BMC::ButtonHelper.default_style,
+    add_class: [],
+    **options
+  )
+    text = ta(action) if text.nil? && action
+
+    content = icon(icon).concat(" ").concat(tag.span(text, class: "text"))
+
+    if method != :get
+      options[:method] = method
+      confirm = true if confirm.nil?
+    end
+
+    unless options[:class]
+      options[:class] = [
+        "btn",
+        "btn-#{btn_size}",
+        "btn-#{btn_style.to_s.tr('_', '-')}",
+        ("link-#{action}" if action),
+        *add_class,
+      ]
+    end
+
+    options[:title] = title
+
+    unless confirm.nil?
+      confirm = ta(:confirm) if confirm == true
+      options.deep_merge!(data: {confirm: confirm})
+    end
+
+    link_to(content, url, options.sort.to_h)
+  end
+
+  def new_button(url = url_for(action: :new), **options)
+    options = {
+      :icon      => :plus,
+      :action    => :new,
+      :btn_style => :success,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def read_button(url, **options)
+    options = {
+      :icon   => :info_circle,
+      :action => :read,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def edit_button(url, **options)
+    options = {
+      :icon   => :pencil_alt,
+      :action => :edit,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def delete_button(url, **options)
+    options = {
+      :icon      => :trash,
+      :action    => :delete,
+      :btn_style => :danger,
+      :method    => :delete,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def print_button(**options)
+    options = {
+      :icon    => :print,
+      :action  => :print,
+      :onclick => "print(); return false;",
+    }.merge(options)
+
+    bs_button("#", **options)
+  end
+
+  def download_button(url, **options)
+    options = {
+      :icon   => :cloud_download_alt,
+      :action => :download,
+      :target => :_blank,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def export_button(url, **options)
+    ext = url.split(".").last
+
+    if ext.length <= 4
+      text = "#{ta(:export)} (#{ext.upcase})"
+    else
+      text = ta(:export)
+    end
+
+    options = {
+      :icon   => :download,
+      :action => :export,
+      :text   => text,
+    }.merge(options)
+
+    download_button(url, **options)
+  end
+
+  def import_button(url, **options)
+    options = {
+      :icon   => :upload,
+      :action => :import,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+
+  def copy_button(url, **options)
+    options = {
+      :icon   => :copy,
+      :action => :copy,
+    }.merge(options)
+
+    bs_button(url, **options)
+  end
+end

data/app/helpers/bmc/filters_helper.rb

@@ -0,0 +1,16 @@
+module BMC::FiltersHelper
+  def bmc_time_periods_for_select
+    {
+      t("time_periods.all_time")    => "",
+      t("time_periods.today")       => "today",
+      t("time_periods.yesterday")   => "yesterday",
+      t("time_periods.this_week")   => "this_week",
+      t("time_periods.last_week")   => "last_week",
+      t("time_periods.this_month")  => "this_month",
+      t("time_periods.last_month")  => "last_month",
+      t("time_periods.this_year")   => "this_year",
+      t("time_periods.last_year")   => "last_year",
+      t("time_periods.custom_date") => "custom_date",
+    }
+  end
+end

data/app/helpers/bmc/font_awesome_helper.rb

@@ -0,0 +1,67 @@
+module BMC::FontAwesomeHelper
+  def icon(id, fa_style: nil, size: nil, spin: false, **options)
+    id = id.to_s.tr("_", "-").to_sym
+
+    if fa_style.nil?
+      fa_style = BMC::FontAwesomeHelper.default_fa_style_for_id(id)
+    end
+
+    css_classes = options.delete(:class).to_s.split
+    css_classes << "icon"
+    css_classes << "fa-#{id}"
+    css_classes << "fa#{fa_style.to_s[0]}"
+    css_classes << "fa-#{size}" if size
+    css_classes << "fa-spin" if spin
+
+    attributes = options.merge(class: css_classes.sort.join(" ")).sort.to_h
+
+    tag.span(**attributes)
+  end
+
+  class << self
+    def database
+      @database ||= YAML.safe_load(database_yml).deep_symbolize_keys
+    end
+
+    def database_path
+      Rails.root.join("tmp", "fa_database_#{version}.yml")
+    end
+
+    def database_yml
+      download_database! unless File.size?(database_path)
+      File.read(database_path)
+    end
+
+    def database_url
+      short_version = version.split(".")[0, 3].join(".") # 1.20.14.2 => 1.20.14
+      url = "https://raw.githubusercontent.com/FortAwesome/Font-Awesome/#{short_version}/metadata/icons.yml"
+
+      if Gem::Version.new(short_version) < Gem::Version.new("5.6.0")
+        url = url.gsub("/metadata", "/advanced-options/metadata")
+      end
+
+      url
+    end
+
+    def download_database!
+      require "open-uri"
+      data = URI.parse(database_url).open.read
+      File.write(database_path, data)
+    end
+
+    def version
+      require "font_awesome/sass/version"
+      FontAwesome::Sass::VERSION
+    end
+
+    def default_fa_style_for_id(id)
+      return if version.start_with?("4")
+
+      if version.start_with?("5")
+        return BMC::FontAwesomeHelper.database.dig(id, :styles).to_a.first
+      end
+
+      raise "invalid font-awesome-sass version"
+    end
+  end # class << self
+end

data/app/helpers/bmc/form_helper.rb

@@ -0,0 +1,24 @@
+module BMC::FormHelper
+  include BMC::I18nHelper
+
+  # Hidden submit to be the default triggered on <enter> keypress on a form
+  # Does not work if display:none
+  def form_hidden_submit
+    css = "position:absolute;top:-9999px;left:-9999px;opacity:0;height:0;width:0;visibility: hidden"
+    tag(:input, type: "submit", class: "hidden-submit", style: css)
+  end
+
+  def search_form(action: request.fullpath)
+    render "bmc/search/form", action: action
+  end
+
+  def hidden_inputs_for_get_form(url, except: [])
+    query_values = Addressable::URI.parse(url).query_values.to_h
+      .with_indifferent_access
+      .except(*except)
+
+    return if query_values.empty?
+
+    query_values.sum { |k, v| tag.input(type: "hidden", name: k, value: v) }
+  end
+end

data/app/helpers/bmc/i18n_helper.rb

@@ -0,0 +1,5 @@
+module BMC::I18nHelper
+  def ta(action)
+    t("actions.#{action}")
+  end
+end

data/app/helpers/bmc/link_helper.rb

@@ -0,0 +1,42 @@
+module BMC::LinkHelper
+  def link_to_object(obj, options = {})
+    return if obj.nil?
+
+    if policy(obj).read?
+      link_to(obj.to_s, engine_polymorphic_path(obj), options)
+    else
+      obj.to_s
+    end
+  end
+
+  def icon_link_to(icon, name, options = nil, html_options = nil, &block)
+    name = icon(icon).concat(" ").concat(name)
+    link_to(name, options, html_options, &block)
+  end
+
+  def web_link(text, opts = {})
+    return if text.to_s.blank?
+
+    href = text
+    href = "http://#{text}" unless text.include?("://")
+
+    link_to(text, href, opts)
+  end
+
+  def email_link(text, opts = {})
+    return if text.to_s.blank?
+
+    href = "mailto:#{text}"
+
+    link_to(text, href, opts)
+  end
+
+  def tel_link(text, opts = {})
+    return if text.to_s.blank?
+
+    value = text.delete(" ")
+    href  = "tel:#{value}"
+
+    link_to(text, href, opts)
+  end
+end

data/app/helpers/bmc/pagination_helper.rb

@@ -0,0 +1,22 @@
+module BMC::PaginationHelper
+  class << self
+    attr_writer :theme
+
+    def theme
+      @theme ||= "bootstrap4"
+    end
+  end
+
+  def paginate(objects, options = {})
+    options = {theme: BMC::PaginationHelper.theme}.merge(options)
+    super(objects, **options).gsub(/>(\s+)</, "><").html_safe
+  end
+
+  def pagination_infos(collection)
+    tag.p(class: "pagination-infos") { page_entries_info(collection) }
+  end
+
+  def pagination_and_infos(collection)
+    paginate(collection) + pagination_infos(collection)
+  end
+end

data/app/helpers/bmc/routes_helper.rb

@@ -0,0 +1,24 @@
+module BMC::RoutesHelper
+  def engine_polymorphic_path(obj, opts = {})
+    if Rails::VERSION::STRING >= "6.0.0"
+      engine = obj.class.module_parents[-2]
+    else
+      engine = obj.class.parents[-2]
+    end
+
+    if engine.nil?
+      routes = main_app
+    else
+      routes = engine::Engine.routes
+    end
+
+    opts = {
+      :controller => "/#{obj.class.to_s.tableize}",
+      :action     => :show,
+      :id         => obj.to_param,
+      :only_path  => true,
+    }.merge(opts)
+
+    routes.url_for(opts)
+  end
+end

data/app/helpers/bmc/sorting_helper.rb

@@ -0,0 +1,55 @@
+module BMC::SortingHelper
+  def sortable_column(name, column, options = {})
+    unless column.is_a?(Symbol)
+      raise ArgumentError, "invalid column, please use symbol"
+    end
+
+    current_column, current_direction = sortable_column_order
+
+    if current_column == column
+      if current_direction == :asc
+        name           = "#{name} ↓"
+        new_sort_param = "-#{column}"
+      end
+
+      if current_direction == :desc
+        name           = "#{name} ↑"
+        new_sort_param = column
+      end
+
+      klass = "sort #{current_direction}"
+    else
+      new_sort_param = column
+      klass          = "sort"
+    end
+
+    unless (url_params = options.delete(:url_params))
+      url_params = (params.try(:permit!) || params).to_h.symbolize_keys
+    end
+    url_params[:sort] = new_sort_param
+
+    html_options = {class: klass}.merge(options)
+
+    link_to(name, url_params, html_options)
+  end
+
+  def sortable_column_order(sort_param = params[:sort])
+    sort_param = sort_param.to_s
+
+    if sort_param.present?
+      if sort_param.start_with?("-")
+        column     = sort_param[1..].to_sym
+        direction  = :desc
+      else
+        column     = sort_param.to_sym
+        direction  = :asc
+      end
+    end
+
+    if block_given?
+      yield(column, direction)
+    else
+      [column, direction]
+    end
+  end
+end

data/app/helpers/bmc/text_helper.rb

@@ -0,0 +1,127 @@
+module BMC::TextHelper
+  include ::ActionView::Helpers::NumberHelper
+  include ::ActionView::Helpers::SanitizeHelper
+  include ::ActionView::Helpers::TextHelper
+
+  def nbsp(text = :no_argument)
+    if text == :no_argument
+      "\u00A0"
+    else
+      text.to_s.gsub(" ", nbsp)
+    end
+  end
+
+  def euros(n)
+    currency(n, "€")
+  end
+
+  def currency(n, u)
+    return if n.nil?
+
+    I18n.t("number.currency.format.format")
+      .gsub("%n", number(n))
+      .gsub("%u", u)
+      .tr(" ", nbsp)
+  end
+
+  def percentage(n)
+    return if n.nil?
+
+    number(n) + nbsp + "%"
+  end
+
+  def number(n)
+    return if n.nil?
+
+    opts = {}
+
+    if n.class.to_s.match?(/Float|Decimal/i)
+      opts[:precision] = 2
+    else
+      opts[:precision] = 0
+    end
+
+    opts[:delimiter] = I18n.t("number.format.delimiter")
+    opts[:separator] = I18n.t("number.format.separator")
+
+    number_with_precision(n, opts).tr(" ", nbsp)
+  end
+
+  def date(d, **args)
+    I18n.l(d, **args) unless d.nil?
+  end
+
+  def boolean_icon(bool)
+    return if bool.nil?
+
+    return icon(:check, style: "color: green") if bool == true
+    return icon(:times, style: "color: red")   if bool == false
+
+    raise "#{bool} is not a boolean"
+  end
+
+  def text2html(str)
+    return if str.to_s.blank?
+
+    str = str.delete("\r").strip
+    strip_tags(str).gsub("\n", "<br />").html_safe
+  end
+
+  def lf2br(str)
+    return if str.to_s.blank?
+
+    str.delete("\r").gsub("\n", "<br />").html_safe
+  end
+
+  def info( # rubocop:disable Metrics/ParameterLists
+    object,
+    attribute,
+    value: nil,
+    default: nil,
+    helper: nil,
+    tag: :div,
+    separator: " : ",
+    label: object.t(attribute)
+  )
+    if default == :hide
+      value = fma(object, attribute, value: value, helper: helper)
+      return if value.nil?
+    end
+
+    value = fma(object, attribute, value: value, default: default, helper: helper)
+
+    separator   = " :<br/>".html_safe if separator == :br
+    klass       = object.is_a?(Module) ? object : object.class
+    object_type = klass.to_s.split("::").last.underscore
+
+    html_label     = self.tag.strong(class: "info-label") { label }
+    span_css_class = "info-value #{object_type}-#{attribute}"
+    html_value     = self.tag.span(class: span_css_class) { value }
+    separator_html = self.tag.span(class: "info-separator") { separator }
+
+    container_css_class = ["info", ("blank" if value.blank?)]
+
+    content_tag(tag, class: container_css_class) do
+      [html_label, separator_html, html_value].sum
+    end
+  end # def info
+
+  # format model attribute
+  def fma(object, attribute, value: nil, default: nil, helper: nil)
+    value = object.public_send(attribute) if value.nil?
+    value = default if value != false && value.blank?
+
+    i18n_scope = object.model_name.instance_variable_get(:@klass).i18n_scope
+    i18n_key = "#{object.model_name.i18n_key}/#{attribute}"
+    nested   = I18n.t("#{i18n_scope}.attributes.#{i18n_key}", default: "").is_a?(Hash)
+
+    value = object.tv(attribute) if nested
+    value = send(helper, value)  if helper
+    value = t("yes")             if value == true
+    value = t("no")              if value == false
+    value = number(value)        if value.is_a?(Numeric)
+    value = date(value)          if value.is_a?(Date) || value.is_a?(Time)
+
+    value.to_s.presence
+  end
+end

data/app/helpers/h.rb

@@ -0,0 +1,3 @@
+# Short alias
+# Example : H.number(123)
+H = BMC::AllHelpers

data/app/jobs/concerns/bmc/setup_job_concern.rb

@@ -0,0 +1,35 @@
+module BMC::SetupJobConcern
+  extend ActiveSupport::Concern
+
+  def perform(*args)
+    setup(*args)
+    call
+  end
+
+  def call
+    raise NotImplementedError
+  end
+
+  class_methods do
+    def setup_with(*attrs)
+      attr_reader(*attrs)
+
+      define_method(:setup) do |*args|
+        if attrs.length != args.length
+          message = "wrong number of arguments (given #{args.length}, expected #{attrs.length})"
+          raise ArgumentError, message
+        end
+
+        attrs.length.times do |i|
+          instance_variable_set("@#{attrs[i]}", args[i])
+        end
+      end
+    end
+
+    private :setup_with
+
+    def setup(*args)
+      new.tap { |instance| instance.setup(*args) }
+    end
+  end # class_methods
+end

data/app/libs/bmc/collection_update.rb

@@ -0,0 +1,38 @@
+class BMC::CollectionUpdate
+  extend AttrExtras.mixin
+
+  attr_reader_initialize :scope, :params_array
+
+  def self.call(...)
+    new(...).call
+  end
+
+  def call
+    return update
+  end
+
+  def update!
+    ApplicationRecord.transaction do
+      params_array.each do |object_param|
+        if object_param[:id].present?
+          object = scope.find(object_param[:id])
+        else
+          object = scope.new
+        end
+
+        if object_param.delete(:_destroy).to_i == 1
+          object.destroy!
+        else
+          object.update!(object_param)
+        end
+      end
+    end
+    true
+  end
+
+  def update
+    update!
+  rescue ActiveRecord::RecordInvalid
+    false
+  end
+end

data/app/libs/bmc/fcm/notifier.rb

@@ -0,0 +1,32 @@
+class BMC::FCM::Notifier
+  attr_reader :to, :title, :body, :badge, :sound, :data
+
+  # rubocop:disable Metrics/ParameterLists
+  def initialize(to:, title: nil, body:, badge: 0, sound: "default", data: {})
+    super()
+    @to    = to
+    @title = title
+    @body  = body
+    @badge = badge
+    @sound = sound
+    @data  = data
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  def call
+    BMC::FCM::Request.call(
+      :to => to,
+      :notification => {
+        :title => title,
+        :body  => body,
+        :badge => badge,
+        :sound => sound,
+      },
+      :data => data,
+    )
+  end
+
+  def self.call(...)
+    new(...).call
+  end
+end

data/app/libs/bmc/fcm/request.rb

@@ -0,0 +1,54 @@
+class BMC::FCM::Request
+  extend AttrExtras.mixin
+
+  URL = "https://fcm.googleapis.com/fcm/send"
+
+  class << self
+    attr_writer :api_key
+
+    def api_key
+      @api_key ||= ENV["FCM_API_KEY"]
+    end
+  end
+
+  attr_reader_initialize :request_body
+
+  attr_reader :response_json
+
+  def self.call(...)
+    new(...).call
+  end
+
+  def call
+    response_body = HTTParty.post(URL,
+      :body    => request_body.to_json,
+      :headers => {
+        "Content-Type"  => "application/json",
+        "Authorization" => "key=#{self.class.api_key}",
+      },
+    ).body
+
+    @response_json = JSON.parse(response_body).deep_symbolize_keys
+
+    self
+  rescue JSON::ParserError
+    @response_json = {success: 0, failure: 1, results: [{:error => "InvalidJsonResponse"}]}
+    self
+  end
+
+  def ok?
+    response_json[:success].positive? && response_json[:failure].zero?
+  end
+
+  def error?
+    !ok?
+  end
+
+  def errors
+    response_json[:results].pluck(:error).compact
+  end
+
+  def invalid_token?
+    errors.include?("NotRegistered") || errors.include?("InvalidRegistration")
+  end
+end