bmc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f44e62a2b31e04cc714d58d89b5bf5752a26cb99b2e9013da86a5a7c7b52a15
+  data.tar.gz: 71693371c8912830ecbdbde9a6582c357dd0fdf63c8233ab1fc8c1e52723e828
+SHA512:
+  metadata.gz: 4a865f824ca4aa26d2cb0d0e92360d4aa88f7a0e8cfa7a10d32d35875bfe4a33c53c7cd6f0809da4810c613426b9a56b8d7b3e29fad162f5e816f5137cbe7496
+  data.tar.gz: a3febb518d32c8bccbb22b414fad2bbbe3473c4689b66d76cf7836b5bde532be34e0b22485c344dd24c59d70b0522e214357e50379ee3b60b1aaf78b44946748

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## v1.0.0
+
+- Fork from agilibox
+- Zeitwerk compatibility
+- Remove all CSS/JS
+- Filter class names changes
+- Remove test helpers
+- Various view helpers changes

data/README.md

@@ -0,0 +1,28 @@
+# BMC
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bmc'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bmc
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BMC'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test
+
+task "assets:precompile" do
+  Rake::Task["app:assets:precompile"].invoke
+end

data/app/assets/config/bmc_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/bmc .js
+//= link_directory ../stylesheets/bmc .css

data/app/controllers/bmc/application_controller.rb

@@ -0,0 +1,3 @@
+class BMC::ApplicationController < BMC.parent_controller
+  protect_from_forgery with: :exception
+end

data/app/controllers/bmc/filters_controller.rb

@@ -0,0 +1,38 @@
+class BMC::FiltersController < BMC::ApplicationController
+  skip_before_action :verify_authenticity_token, raise: false
+  skip_before_action :authenticate_user!,        raise: false
+  skip_after_action  :verify_authorized,         raise: false
+  skip_after_action  :verify_policy_scoped,      raise: false
+
+  def create
+    filters = BMC::Filter.new(cookies)
+    new_filters = params.fetch(:filters, {}).permit!.to_h
+    filters.merge new_filters
+
+    # Rewrite cookie with 1 year expiry
+    cookies[:filters] = {
+      :value   => cookies[:filters],
+      :expires => 1.year.from_now,
+      :path    => "/",
+    }
+
+    redirect_to back_url
+  end
+
+  private
+
+  def back_url
+    url = [
+      params[:form_url],
+      request.referer,
+      main_app.try(:root_path),
+      "/",
+    ].find(&:present?)
+
+    # Delete page param
+    base, query_string = url.split("?")
+    query_string = query_string.to_s.split("&").delete_if { |p| p.include?("page=") }.join("&")
+    query_string = "?#{query_string}" if query_string.present?
+    base + query_string
+  end
+end

data/app/controllers/concerns/bmc/api_controller_concern.rb

@@ -0,0 +1,69 @@
+module BMC::ApiControllerConcern
+  extend ActiveSupport::Concern
+
+  private
+
+  def render_json(json = {}, options = {})
+    json.reverse_merge!(current_user: current_user)
+    options.reverse_merge!(current_user: current_user)
+
+    json = BMC::MiniModelSerializer::Serialize.call(json, options)
+
+    render options.merge(json: json)
+  end
+
+  def render_json_error(any_object, options = {})
+    if any_object.is_a?(ActiveModel::Validations)
+      json = {
+        :error        => json_error_string_for_model(any_object),
+        :model_errors => json_errors_hash_for_model(any_object),
+      }
+    elsif any_object.is_a?(String)
+      json = {error: any_object}
+    else
+      json = any_object
+    end
+
+    options[:status] ||= :unprocessable_entity
+
+    render_json(json, options)
+  end
+
+  def json_errors_hash_for_model(object)
+    object.errors
+      .to_hash
+      .map { |a, m| [a, message: m.first, full_message: object.errors.full_message(a, m.first)] }
+      .uniq(&:first)
+      .to_h
+  end
+
+  def json_error_string_for_model(object)
+    json_errors_hash_for_model(object).values.pluck(:full_message).join(", ")
+  end
+
+  def render_not_found
+    render_json_error t("errors.not_found"), status: :not_found
+  end
+
+  def render_forbidden
+    render_json_error t("errors.forbidden"), status: :forbidden
+  end
+
+  def render_unauthorized
+    render_json_error t("errors.unauthorized"), status: :unauthorized
+  end
+
+  def render_forbidden_or_unauthorized
+    current_user ? render_forbidden : render_unauthorized
+  end
+
+  included do |controller|
+    if controller < ActionController::Rescue
+      if defined?(Pundit::NotAuthorizedError)
+        rescue_from Pundit::NotAuthorizedError, with: :render_forbidden_or_unauthorized
+      end
+
+      rescue_from ActiveRecord::RecordNotFound, with: :render_not_found
+    end
+  end
+end

data/app/controllers/concerns/bmc/back_url_concern.rb

@@ -0,0 +1,26 @@
+module BMC::BackUrlConcern
+  extend ActiveSupport::Concern
+
+  private
+
+  def default_back_url
+  end
+
+  def back_url
+    url = [
+      params[:back_url],
+      request.referer,
+      default_back_url,
+      main_app.try(:root_path),
+      "/",
+    ].find(&:present?)
+
+    uri = URI.parse(url)
+    uri.host = nil
+    uri.port = nil
+    uri.scheme = nil
+    uri.user = nil
+    uri.password = nil
+    uri.to_s
+  end
+end

data/app/emails/bmc/email.rb

@@ -0,0 +1,113 @@
+class BMC::Email
+  include ActiveModel::Model
+  include BMC::ModelToS
+  include BMC::ModelI18n
+
+  validates :to,      presence: true
+  validates :subject, presence: true
+  validates :body,    presence: true
+
+  validate :validate_addr_formats
+
+  attr_accessor(
+    :current_user,
+    :from,
+    :reply_to,
+    :to,
+    :cc,
+    :subject,
+    :body,
+    :attachments,
+  )
+
+  def initialize(*)
+    super
+    assign_default_values
+  end
+
+  def attachment_names
+    attachments.keys.join(", ")
+  end
+
+  def validate_and_deliver
+    ok = valid?
+    deliver if ok
+    ok
+  end
+
+  def data
+    {
+      :from        => from,
+      :reply_to    => reply_to,
+      :to          => to,
+      :cc          => cc,
+      :subject     => subject,
+      :body        => body,
+      :attachments => attachments,
+    }
+  end
+
+  def deliver
+    deliver_now
+  end
+
+  def deliver_now
+    BMC::GenericMailer.generic_email(data).deliver_now
+  end
+
+  def deliver_later
+    BMC::GenericMailer.generic_email(data).deliver_later
+  end
+
+  private
+
+  def assign_default_values
+    self.from        ||= default_from
+    self.reply_to    ||= default_reply_to
+    self.to          ||= default_to
+    self.cc          ||= default_cc
+    self.subject     ||= default_subject
+    self.body        ||= default_body
+    self.attachments ||= default_attachments
+  end
+
+  def default_from
+  end
+
+  def default_reply_to
+    "#{current_user} <#{current_user.email}>" if current_user
+  end
+
+  def default_to
+  end
+
+  def default_cc
+  end
+
+  def default_subject
+  end
+
+  def default_body
+  end
+
+  def default_attachments
+    {}
+  end
+
+  def validate_addr_formats
+    validate_addr_formats_for(:from)
+    validate_addr_formats_for(:reply_to)
+    validate_addr_formats_for(:to)
+    validate_addr_formats_for(:cc)
+  end
+
+  def validate_addr_formats_for(attr)
+    require "mail"
+
+    string = public_send(attr).to_s
+    return if string.blank?
+    addrs  = Mail.new(to: string).to_addrs
+    return true if addrs.any? && addrs.all? { |addr| URI::MailTo::EMAIL_REGEXP.match?(addr) }
+    errors.add(attr, :invalid)
+  end
+end

data/app/filters/bmc/filter/by_date.rb

@@ -0,0 +1,6 @@
+class BMC::Filter::ByDate < BMC::Filter::ByKeyValue
+  def apply(query, value)
+    value = Date.parse(value)
+    super(query, value)
+  end
+end

data/app/filters/bmc/filter/by_date_begin.rb

@@ -0,0 +1,7 @@
+class BMC::Filter::ByDateBegin < BMC::Filter::ByKeyValue
+  def apply(query, value)
+    value = Date.parse(value)
+    column = column_for(query)
+    query.where("#{column} >= ?", value)
+  end
+end

data/app/filters/bmc/filter/by_date_end.rb

@@ -0,0 +1,7 @@
+class BMC::Filter::ByDateEnd < BMC::Filter::ByKeyValue
+  def apply(query, value)
+    value = Date.parse(value)
+    column = column_for(query)
+    query.where("#{column} <= ?", value)
+  end
+end

data/app/filters/bmc/filter/by_date_or_datetime_period.rb

@@ -0,0 +1,56 @@
+class BMC::Filter::ByDateOrDatetimePeriod < BMC::Filter::ByKeyValue
+  def initialize(*)
+    if instance_of?(BMC::Filter::ByDateOrDatetimePeriod)
+      raise "please use FilterStrategyByDatePeriod or FilterStrategyByDatetimePeriod"
+    end
+
+    super
+  end
+
+  def apply(query, value) # rubocop:disable Metrics/MethodLength
+    value = value.to_s
+
+    if value == "today"
+      a = now
+      b = now
+    elsif value == "yesterday"
+      a = (now - 1.day)
+      b = (now - 1.day)
+    elsif value == "this_week"
+      a = now.beginning_of_week
+      b = now.end_of_week
+    elsif value == "this_month"
+      a = now.beginning_of_month
+      b = now.end_of_month
+    elsif value == "this_year"
+      a = now.beginning_of_year
+      b = now.end_of_year
+    elsif value == "last_week"
+      a = (now - 1.week).beginning_of_week
+      b = (now - 1.week).end_of_week
+    elsif value == "last_month"
+      a = (now - 1.month).beginning_of_month
+      b = (now - 1.month).end_of_month
+    elsif value == "last_year"
+      a = (now - 1.year).beginning_of_year
+      b = (now - 1.year).end_of_year
+    elsif (m = value.match(/last\.([0-9]+)\.(days?|weeks?|months?|years?)/))
+      a = now - m[1].to_i.public_send(m[2])
+      b = now
+    else
+      return query
+    end
+
+    if now.is_a?(Time)
+      a = a.beginning_of_day if a
+      b = b.end_of_day       if b
+    end
+
+    column = column_for(query)
+
+    query = query.where("#{column} >= ?", a) if a
+    query = query.where("#{column} <= ?", b) if b
+
+    query
+  end
+end

data/app/filters/bmc/filter/by_date_period.rb

@@ -0,0 +1,5 @@
+class BMC::Filter::ByDatePeriod < BMC::Filter::ByDateOrDatetimePeriod
+  def now
+    Date.current
+  end
+end

data/app/filters/bmc/filter/by_datetime_period.rb

@@ -0,0 +1,5 @@
+class BMC::Filter::ByDatetimePeriod < BMC::Filter::ByDateOrDatetimePeriod
+  def now
+    Time.zone.now
+  end
+end

data/app/filters/bmc/filter/by_key_value.rb

@@ -0,0 +1,27 @@
+class BMC::Filter::ByKeyValue
+  attr_reader :key
+
+  def initialize(key = nil)
+    super()
+    @key = key
+  end
+
+  def apply(query, value)
+    value = true  if value == "true"
+    value = false if value == "false"
+
+    column = column_for(query)
+
+    if value.to_s.in?(%w(nil null))
+      query.where("#{column} IS NULL")
+    elsif value.to_s.in?(%w(not_nil not_null))
+      query.where("#{column} IS NOT NULL")
+    else
+      query.where("#{column} = ?", value)
+    end
+  end
+
+  def column_for(query)
+    key.is_a?(Symbol) ? "#{query.model.table_name}.#{key}" : key.to_s
+  end
+end

data/app/filters/bmc/filter/by_key_values.rb

@@ -0,0 +1,13 @@
+class BMC::Filter::ByKeyValues < BMC::Filter::ByKeyValue
+  def apply(query, value)
+    value = value.split if value.is_a?(String)
+    value = value.select(&:present?)
+    column = column_for(query)
+
+    if value.any?
+      query.where("#{column} IN (?)", value)
+    else
+      query
+    end
+  end
+end

data/app/filters/bmc/filter.rb

@@ -0,0 +1,86 @@
+class BMC::Filter
+  include ActiveModel::Model
+
+  STRATEGIES = {}
+
+  attr_reader :jar
+
+  def initialize(jar)
+    @jar = jar
+  end
+
+  def strategies
+    self.class::STRATEGIES.with_indifferent_access
+  end
+
+  def apply(query)
+    strategies.each do |key, strategy|
+      value = get(key)
+
+      next if value.blank?
+
+      query = strategy.apply(query, value)
+    end
+
+    return query
+  end
+
+  def method_missing(method, *args)
+    if method.to_s.end_with?("=")
+      key    = method.to_s[0..-2]
+      value  = args.first
+      action = :write
+    else
+      key    = method.to_s
+      action = :read
+    end
+
+    if strategies.key?(key) && action == :read
+      get(key)
+    elsif strategies.key?(key) && action == :write
+      set(key, value)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, *)
+    super || strategies.key?(method.to_s) || strategies.key?(method.to_s.chomp("="))
+  end
+
+  def read
+    JSON.parse jar["filters"].to_s
+  rescue JSON::ParserError
+    {}
+  end
+
+  def write(filters)
+    jar["filters"] = filters.to_json
+  end
+
+  def merge(new_filters)
+    write read.merge(new_filters)
+  end
+
+  def actives_count
+    read.count { |k, v| strategies.key?(k.to_s) && v.present? }
+  end
+
+  def any?
+    actives_count.positive?
+  end
+
+  def empty?
+    !any?
+  end
+
+  private
+
+  def get(key)
+    read[key.to_s]
+  end
+
+  def set(key, value)
+    merge(key.to_s => value)
+  end
+end

data/app/forms/bmc/mini_form_object.rb

@@ -0,0 +1,29 @@
+class BMC::MiniFormObject < SimpleDelegator
+  include ActiveModel::Validations
+  extend Forwardable
+
+  def valid?
+    __getobj__.valid?
+    run_validations!
+  end
+
+  def invalid?
+    !valid?
+  end
+
+  alias validate valid?
+
+  def validate!
+    valid? || raise_validation_error
+  end
+
+  def_delegators :__getobj__, :errors
+
+  def save
+    valid? && __getobj__.save
+  end
+
+  def save!
+    validate! && __getobj__.save!
+  end
+end

data/app/helpers/bmc/all_helpers.rb

@@ -0,0 +1,15 @@
+module BMC::AllHelpers
+  include BMC::BootstrapHelper
+  include BMC::ButtonHelper
+  include BMC::FiltersHelper
+  include BMC::FontAwesomeHelper
+  include BMC::FormHelper
+  include BMC::I18nHelper
+  include BMC::LinkHelper
+  include BMC::PaginationHelper
+  include BMC::RoutesHelper
+  include BMC::SortingHelper
+  include BMC::TextHelper
+
+  extend self
+end

data/app/helpers/bmc/bootstrap_helper.rb

@@ -0,0 +1,63 @@
+module BMC::BootstrapHelper
+  class << self
+    attr_writer :card_classes
+
+    def card_classes
+      @card_classes ||= {
+        :card   => "card",
+        :header => "card-header",
+        :body   => "card-body",
+        :footer => "card-footer",
+      }
+    end
+  end
+
+  def bs_progress_bar(percentage)
+    percentage = percentage.round if percentage.respond_to?(:round)
+
+    tag.div(class: "progress") do
+      tag.div(class: "progress-bar", style: "width:#{percentage}%") do
+        "#{percentage}%"
+      end
+    end
+  end
+
+  def bs_card( # rubocop:disable Metrics/ParameterLists
+    header: nil,
+    body: true,
+    footer: nil,
+    card_tag: :div,
+    header_tag: :div,
+    body_tag: :div,
+    footer_tag: :div,
+    card_class: nil,
+    header_class: nil,
+    body_class: nil,
+    footer_class: nil,
+    &block
+  )
+    global_classes = BMC::BootstrapHelper.card_classes
+    card_classes   = ([global_classes[:card]]   + card_class.to_s.split).compact.sort
+    header_classes = ([global_classes[:header]] + header_class.to_s.split).compact.sort
+    body_classes   = ([global_classes[:body]]   + body_class.to_s.split).compact.sort
+    footer_classes = ([global_classes[:footer]] + footer_class.to_s.split).compact.sort
+
+    if header
+      header_html = content_tag(header_tag, class: header_classes) { header }
+    end
+
+    if body
+      body_html = content_tag(body_tag, class: body_classes) { capture(&block) }
+    else
+      body_html = capture(&block)
+    end
+
+    if footer
+      footer_html = content_tag(footer_tag, class: footer_classes) { footer }
+    end
+
+    content_tag(card_tag, class: card_classes) do
+      [header_html, body_html, footer_html].compact.sum
+    end
+  end
+end