cm-admin 0.2.0 → 0.3.0

data/lib/cm_admin/models/field.rb

@@ -0,0 +1,14 @@
+module CmAdmin
+  module Models
+    class Field
+      attr_accessor :field_name, :label, :header
+
+      def initialize(field_name, attributes = {})
+        @field_name = field_name
+        attributes.each do |key, value|
+          self.send("#{key.to_s}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/models/filter.rb

@@ -0,0 +1,30 @@
+module CmAdmin
+  module Models
+    class Filter
+      attr_accessor :db_column_name, :filter_type, :placeholder, :collection, :multiselect, :checked
+
+      VALID_FILTER_TYPES = Set[:checkbox, :date, :dropdown, :range, :search].freeze
+
+      def initialize(db_column_name:, filter_type:, options: {})
+        raise TypeError, "Can't have array of multiple columns for #{filter_type} filter" if db_column_name.is_a?(Array) && db_column_name.size > 1 && !filter_type.to_sym.eql?(:search)
+        raise ArgumentError, "Kindly select a valid filter type like #{VALID_FILTER_TYPES.sort.to_sentence(last_word_connector: ', or ')} instead of #{filter_type} for column #{db_column_name}" unless VALID_FILTER_TYPES.include?(filter_type.to_sym)
+        @db_column_name, @filter_type = structure_data(db_column_name, filter_type)
+        options.each do |key, value|
+          self.send("#{key.to_s}=", value)
+        end
+      end
+
+      def structure_data(db_column_name, filter_type)
+        filter_type = filter_type.is_a?(Array) ? filter_type[0].to_sym : filter_type.to_sym
+
+        case filter_type
+        when :search
+          db_column_name = (Array.new << db_column_name).flatten.map(&:to_sym)
+        else
+          db_column_name = db_column_name.is_a?(Array) ? db_column_name[0].to_sym : db_column_name.to_sym
+        end
+        [db_column_name, filter_type]
+      end
+    end
+  end
+end

data/lib/cm_admin/utils.rb

@@ -0,0 +1,67 @@
+module CmAdmin::Utils
+  class << self
+    def serialize_csv_columns(*columns, **hashes)
+      # Turns an arbitrary list of args and kwargs into a list of params to be used in a form
+      # For example, turns CmAdmin::Utils.serialize_csv_columns(:a, :b, c: [:d, e: :h], f: :g)
+      # into [:a, :b, "c/d", "c/e/h", "f/g"]
+      columns.map(&:to_s) + hashes.map do |key, value|
+        serialize_csv_columns(*value).map do |column|
+          "#{key}/#{column}"
+        end
+      end.reduce([], :+)
+    end
+
+    def deserialize_csv_columns(list, method)
+      # Does the opposite operation of serialize_csv_columns
+      list.reduce(recursive_hash) do |acc, item|
+        tokens = item.to_s.split('/')
+        send(method, acc, tokens.shift, tokens)
+      end
+    end
+
+    def recursive_hash
+      func = ->(h, k) { h[k] = Hash.new(&func) }
+      # This hash creates a new hash, infinitely deep, whenever a value is not found
+      # recursive_hash[:a][:b][:c][:d] will never fail
+      Hash.new(&func)
+    end
+
+    def as_json_params(hash, key, tokens)
+      hash.empty? && hash = { only: [], methods: [], include: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:methods] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:include][key] = as_json_params(hash[:include][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+    def flatten_hash(hash, prefix="", separator="_")
+      hash.reduce({}) do |acc, item|
+        case item[1]
+        when Hash
+          acc.merge(flatten_hash(item[1], "#{prefix}#{item[0]}#{separator}"))
+        else
+          acc.merge("#{prefix}#{item[0]}" => item[1])
+        end
+      end
+    end
+
+    def base(hash, key, tokens) # recursive
+      hash.empty? && hash = { columns: [], associations: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:columns] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:associations][key] = base(hash[:associations][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+  end
+end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/cm_admin/view_helpers.rb

@@ -0,0 +1,72 @@
+module CmAdmin
+  module ViewHelpers
+    Dir[File.expand_path("view_helpers", __dir__) + "/*.rb"].each  { |f| require f }
+
+    include PageInfoHelper
+    include NavigationHelper
+    include FormHelper
+    include ColumnFieldHelper
+    include ActionView::Helpers::FormTagHelper
+    include ActionView::Helpers::TagHelper
+
+    def exportable(klass, html_class: [])
+      tag.a "Export as excel", class: html_class.append("filter-btn modal-btn mr-2"), data: {toggle: "modal", target: "#exportmodal"} do
+        concat tag.i class: 'fa fa-download'
+        concat tag.span " Export"
+      end
+    end
+
+    def column_pop_up(klass, required_filters = nil)
+      tag.div class: "modal fade form-modal", id: "exportmodal", role: "dialog", aria: {labelledby: "exportModal"} do
+        tag.div class: "modal-dialog modal-lg", role: "document" do
+          tag.div class: "modal-content" do
+            concat pop_ups(klass, required_filters)
+          end
+        end
+      end
+    end
+
+    def pop_ups(klass, required_filters)
+      tag.div do
+        concat pop_up_header
+        concat pop_up_body(klass, required_filters)
+      end
+    end
+
+    def pop_up_header
+      tag.div class: "modal-header" do
+        tag.button type: "button", class: "close", data: {dismiss: "modal"}, aria: {label: "Close"} do
+          tag.span "X", aria: {hidden: "true"}
+        end
+        tag.h4 "Select columns to export", class: "modal-title", id: "exportModal"
+      end
+    end
+
+    def pop_up_body(klass, required_filters)
+      tag.div class: "modal-body" do
+        form_tag '/cm_admin/export_to_file.js', id: 'export-to-file-form', style: "width: 100%;", class:"cm-admin-csv-export-form" do
+          concat hidden_field_tag 'class_name', klass.name.to_s, id: 'export-to-file-klass'
+          concat checkbox_row(klass)
+          concat tag.hr
+          concat submit_tag 'Export', class: 'btn btn-primary btn-bordered export-to-file-btn'
+        end
+      end
+    end
+
+    def checkbox_row(klass)
+      tag.div class: "row" do
+        CmAdmin::Models::Export.exportable_columns(klass).each do |column_path|
+          concat create_checkbox(column_path)
+        end
+      end
+    end
+
+    def create_checkbox(column_path)
+      tag.div class: "col-md-4" do
+        concat check_box_tag "columns[]", column_path, id: column_path.to_s.gsub('/', '-')
+        concat " " + column_path.to_s.gsub('/', '_').humanize
+      end
+    end
+
+  end
+end

data/lib/cm_admin/view_helpers/field_column_helper.rb

@@ -0,0 +1,23 @@
+module CmAdmin
+  module ViewHelpers
+    module ColumnFieldHelper
+
+      def column_for_field_helper(ar_object, column)
+        value = ar_object.send(column.db_column_name)
+        case column.column_type
+        when :datetime
+          if column.format.present?
+            value = ar_object.send(column.db_column_name).strftime(column.format)
+          else
+            value = ar_object.send(column.db_column_name).strftime("%d/%m/%Y")
+          end
+          if column.prefix.present?
+            value = column.prefix.to_s + ' ' + value
+          end
+        end
+        return value
+      end
+
+    end
+  end
+end

data/lib/cm_admin/view_helpers/form_field_helper.rb

@@ -0,0 +1,16 @@
+module CmAdmin
+  module ViewHelpers
+    module FormFieldHelper
+      def input_field_for_column(f, field)
+        case field.type
+        when :integer
+          return f.number_field field.name, class: 'normal-input'
+        when :string
+          return f.text_field field.name, class: 'normal-input'
+        when :text
+          return f.text_area field.name, class: 'normal-input'
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/form_helper.rb

@@ -0,0 +1,55 @@
+require_relative 'form_field_helper'
+module CmAdmin
+  module ViewHelpers
+    module FormHelper
+      include FormFieldHelper
+      REJECTABLE = %w(id created_at updated_at)
+
+      def generate_form(resource, cm_model)
+        if resource.new_record?
+          action = :new
+          method = :post
+        else
+          action = :edit
+          method = :patch
+        end
+        if cm_model.available_fields[action].empty?
+          return form_with_all_fields(resource, method)
+        else
+          return form_with_mentioned_fields(resource, cm_model.available_fields[:edit], method)
+        end
+      end
+
+      def form_with_all_fields(resource, method)
+        columns = resource.class.columns.dup
+        table_name = resource.class.table_name
+        columns.reject! { |i| REJECTABLE.include?(i.name) }
+        url = CmAdmin::Engine.mount_path + "/#{table_name}/#{resource.id}"
+        set_form_for_fields(resource, columns, url, method)
+      end
+
+      def form_with_mentioned_fields(resource, available_fields, method)
+        columns = resource.class.columns.select { |i| available_fields.include?(i.name.to_sym) }
+        table_name = resource.class.table_name
+        columns.reject! { |i| REJECTABLE.include?(i.name) }
+        url = CmAdmin::Engine.mount_path + "/#{table_name}/#{resource.id}"
+        set_form_for_fields(resource, columns, url, method)
+      end
+
+      def set_form_for_fields(resource, columns, url, method)
+        form_for(resource, url: url, method: method) do |f|
+          columns.each do |field|
+            concat f.label field.name, class: 'field-label'
+            concat tag.br
+            concat input_field_for_column(f, field)
+            concat tag.p resource.errors[field.name].first if resource.errors[field.name].present?
+            concat tag.br
+            concat tag.br
+          end
+          concat tag.br
+          concat f.submit 'Save', class: 'cta-btn mt-3'
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/navigation_helper.rb

@@ -0,0 +1,18 @@
+require 'pagy'
+module CmAdmin
+  module ViewHelpers
+    module NavigationHelper
+      include Pagy::Frontend
+      def sidebar_navigation
+        CmAdmin.cm_admin_models.map { |model|
+          path = CmAdmin::Engine.mount_path + '/' + model.name.underscore.pluralize
+          "<a href=#{path}><div class='menu-item'>
+            <span class='menu-icon'><i class='fa fa-th-large'></i></span>
+            #{model.name}
+          </div></a>".html_safe
+        }.join.html_safe
+      end
+
+    end
+  end
+end

data/lib/cm_admin/view_helpers/page_info_helper.rb

@@ -0,0 +1,21 @@
+module CmAdmin
+  module ViewHelpers
+    module PageInfoHelper
+      def page_title
+        @action.title || @model.title || "#{@model.ar_model.name} | #{@action.name&.titleize} | Admin"
+      end
+
+      def page_url(action_name=@action.name, ar_object=nil)
+        base_path = CmAdmin::Engine.mount_path + '/' + @model.name.downcase.pluralize
+        case action_name
+        when 'index'
+          base_path
+        when 'new'
+          base_path + '/new'
+        when 'edit'
+          base_path + "/#{ar_object.id}" + '/edit'
+        end
+      end
+    end
+  end
+end

data/lib/generators/cm_admin/install_generator.rb

@@ -1,36 +1,14 @@
-module CmAdmin
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
-
-    desc <<-DESC.strip_heredoc
-      Generates layout for the entire admin panel
-
-      For example:
-        rails g cm_admin:install
-
-      It copies the respectively layout files and the necessary asset files.
-
-    DESC
+require 'rails/generators'
 
-    def add_required_gems
-      gem 'slim'
-      gem 'simple_form'
-      system("yarn add bootstrap")
-      system("yarn add @fortawesome/fontawesome-free")
-      system("yarn add select2")
-    end
-
-    def copy_layout_file
-      copy_file "layouts/_side_navbar.html.slim", "app/views/layouts/_side_navbar.html.slim"
-      copy_file "layouts/_navbar.html.slim", "app/views/layouts/_navbar.html.slim"
-      remove_file "app/views/layouts/application.html.erb"
-      copy_file "layouts/application.html.slim", "app/views/layouts/application.html.slim"
-    end
-
-    def copy_asset_file
-      copy_file "assets/images/cm.png", "app/assets/images/cm.png"
-      directory "assets/stylesheets/", "app/assets/stylesheets/"
-      remove_file "app/assets/stylesheets/application.css"
+module CmAdmin
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer
+        copy_file 'cm_admin_initializer.rb', 'config/initializers/cm_admin.rb'
+        route 'mount CmAdmin::Engine => "/cm_admin"'
+      end
     end
   end
 end

data/lib/generators/cm_admin/templates/cm_admin_initializer.rb

@@ -0,0 +1,4 @@
+CmAdmin.setup do |config|
+  # Sets the default layout to be used for admin
+  config.layout = 'admin'
+end

data/lib/tasks/webpack_install.rake

@@ -0,0 +1,63 @@
+# desc "Explaining what the task does"
+# task :cm_admin do
+#   # Task goes here
+# end
+
+def ensure_log_goes_to_stdout
+    old_logger = Webpacker.logger
+    Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
+    yield
+ensure
+    Webpacker.logger = old_logger
+end
+
+namespace :cm_admin do
+    namespace :webpacker do
+        desc "Install deps with yarn"
+        task :yarn_install do
+            Dir.chdir(File.join(__dir__, "../..")) do
+                system "yarn install --no-progress --production"
+            end
+        end
+
+        desc "Compile JavaScript packs using webpack for production with digests"
+        task compile: [:yarn_install, :environment] do
+            Webpacker.with_node_env("production") do
+                ensure_log_goes_to_stdout do
+                    if CmAdmin.webpacker.commands.compile
+                        # Successful compilation!
+                    else
+                        # Failed compilation
+                        exit!
+                    end
+                end
+            end
+        end
+    end
+end
+
+def yarn_install_available?
+    rails_major = Rails::VERSION::MAJOR
+    rails_minor = Rails::VERSION::MINOR
+
+    rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+
+def enhance_assets_precompile
+    # yarn:install was added in Rails 5.1
+    deps = yarn_install_available? ? [] : ["cm_admin:webpacker:yarn_install"]
+    Rake::Task["assets:precompile"].enhance(deps) do
+        Rake::Task["cm_admin:webpacker:compile"].invoke
+    end
+end
+
+# Compile packs after we've compiled all other assets during precompilation
+skip_webpacker_precompile = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_precompile
+    if Rake::Task.task_defined?("assets:precompile")
+        enhance_assets_precompile
+    else
+        Rake::Task.define_task("assets:precompile" =>"cm_admin:webpacker:compile")
+    end
+end