rails_admin 2.1.1 → 3.1.2

data/lib/rails_admin/extensions/paper_trail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/paper_trail/auditing_adapter'
 
 RailsAdmin.add_extension(:paper_trail, RailsAdmin::Extensions::PaperTrail, auditing: true)

data/lib/rails_admin/extensions/pundit/authorization_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Extensions
     module Pundit
@@ -7,7 +9,7 @@ module RailsAdmin
       class AuthorizationAdapter
         # This method is called first time only and used for setup
         def self.setup
-          RailsAdmin::Extensions::ControllerExtension.send(:include, ::Pundit)
+          RailsAdmin::Extensions::ControllerExtension.include defined?(::Pundit::Authorization) ? ::Pundit::Authorization : ::Pundit
         end
 
         # See the +authorize_with+ config method for where the initialization happens.
@@ -21,10 +23,9 @@ module RailsAdmin
         # AbstractModel instance that applies. The third argument is the actual model
         # instance if it is available.
         def authorize(action, abstract_model = nil, model_object = nil)
-          record = model_object || abstract_model && abstract_model.model
-          if action && !policy(record).send(action_for_pundit(action))
-            raise ::Pundit::NotAuthorizedError.new("not allowed to #{action} this #{record}")
-          end
+          record = model_object || abstract_model&.model
+          raise ::Pundit::NotAuthorizedError.new("not allowed to #{action} this #{record}") if action && !policy(record).send(action_for_pundit(action))
+
           @controller.instance_variable_set(:@_pundit_policy_authorized, true)
         end
 
@@ -33,7 +34,7 @@ module RailsAdmin
         # This takes the same arguments as +authorize+. The difference is that this will
         # return a boolean whereas +authorize+ will raise an exception when not authorized.
         def authorized?(action, abstract_model = nil, model_object = nil)
-          record = model_object || abstract_model && abstract_model.model
+          record = model_object || abstract_model&.model
           policy(record).send(action_for_pundit(action)) if action
         end
 
@@ -50,7 +51,7 @@ module RailsAdmin
         # records. It should return a hash of attributes which match what the user
         # is authorized to create.
         def attributes_for(action, abstract_model)
-          record = abstract_model && abstract_model.model
+          record = abstract_model&.model
           policy(record).try(:attributes_for, action) || {}
         end
 

data/lib/rails_admin/extensions/pundit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/extensions/pundit/authorization_adapter'
 
 RailsAdmin.add_extension(:pundit, RailsAdmin::Extensions::Pundit, authorization: true)

data/lib/rails_admin/support/csv_converter.rb

@@ -1,11 +1,13 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require 'csv'
 
 module RailsAdmin
   class CSVConverter
-    def initialize(objects = [], schema = {})
+    def initialize(objects = [], schema = nil)
       @fields = []
       @associations = []
+      schema ||= {}
 
       return self if (@objects = objects).blank?
 
@@ -13,12 +15,14 @@ module RailsAdmin
       @abstract_model = RailsAdmin::AbstractModel.new(@model)
       @model_config = @abstract_model.config
       @methods = [(schema[:only] || []) + (schema[:methods] || [])].flatten.compact
-      @fields = @methods.collect { |m| export_fields_for(m).first }
+      @fields = @methods.collect { |m| export_field_for(m) }.compact
       @empty = ::I18n.t('admin.export.empty_value_for_associated_objects')
       schema_include = schema.delete(:include) || {}
 
       @associations = schema_include.each_with_object({}) do |(key, values), hash|
-        association = association_for(key)
+        association = export_field_for(key)
+        next unless association&.association?
+
         model_config = association.associated_model_config
         abstract_model = model_config.abstract_model
         methods = [(values[:only] || []) + (values[:methods] || [])].flatten.compact
@@ -28,7 +32,7 @@ module RailsAdmin
           model: abstract_model.model,
           abstract_model: abstract_model,
           model_config: model_config,
-          fields: methods.collect { |m| export_fields_for(m, model_config).first },
+          fields: methods.collect { |m| export_field_for(m, model_config) }.compact,
         }
         hash
       end
@@ -36,18 +40,17 @@ module RailsAdmin
 
     def to_csv(options = {})
       if CSV::VERSION == '3.0.2'
-        raise <<-MSG.gsub(/^\s+/, '')
+        raise <<~MSG
           CSV library bundled with Ruby 2.6.0 has encoding issue, please upgrade Ruby to 2.6.1 or later.
           https://github.com/ruby/csv/issues/62
         MSG
       end
+
       options = HashWithIndifferentAccess.new(options)
       encoding_to = Encoding.find(options[:encoding_to]) if options[:encoding_to].present?
 
       csv_string = generate_csv_string(options)
-      if encoding_to
-        csv_string = csv_string.encode(encoding_to, invalid: :replace, undef: :replace, replace: '?')
-      end
+      csv_string = csv_string.encode(encoding_to, invalid: :replace, undef: :replace, replace: '?') if encoding_to
 
       # Add a BOM for utf8 encodings, helps with utf8 auto-detect for some versions of Excel.
       # Don't add if utf8 but user don't want to touch input encoding:
@@ -61,12 +64,8 @@ module RailsAdmin
 
   private
 
-    def association_for(key)
-      export_fields_for(key).detect(&:association?)
-    end
-
-    def export_fields_for(method, model_config = @model_config)
-      model_config.export.fields.select { |f| f.name == method }
+    def export_field_for(method, model_config = @model_config)
+      model_config.export.fields.detect { |f| f.name == method }
     end
 
     def generate_csv_string(options)

data/lib/rails_admin/support/datetime.rb

@@ -1,98 +1,63 @@
-require 'rails_admin/support/i18n'
+# frozen_string_literal: true
 
 module RailsAdmin
   module Support
     class Datetime
-      # Ruby format options as a key and momentjs format options as a value
-      MOMENTJS_TRANSLATIONS = {
-        '%a' => 'ddd',        # The abbreviated weekday name ("Sun")
-        '%A' => 'dddd',       # The  full  weekday  name ("Sunday")
-        '%b' => 'MMM',        # The abbreviated month name ("Jan")
-        '%B' => 'MMMM',       # The  full  month  name ("January")
-        '%d' => 'DD',         # Day of the month (01..31)
-        '%-d' => 'D',         # Day of the month (1..31)
-        '%D' => 'MM/DD/YY',   # American date format mm/dd/yy
-        '%e' => 'D',          # Day of the month (1..31)
-        '%F' => 'YY-MM-DD',   # ISO 8601 date format
-        '%H' => 'HH',         # Hour of the day, 24-hour clock (00..23)
-        '%I' => 'hh',         # Hour of the day, 12-hour clock (01..12)
-        '%m' => 'MM',         # Month of the year (01..12)
-        '%-m' => 'M',         # Month of the year (1..12)
-        '%M' => 'mm',         # Minute of the hour (00..59)
-        '%p' => 'A',          # Meridian indicator ('AM' or 'PM')
-        '%S' => 'ss',         # Second of the minute (00..60)
-        '%Y' => 'YYYY',       # Year with century
-        '%y' => 'YY',         # Year without a century (00..99)
+      # Ruby format options as a key and flatpickr format options as a value
+      FLATPICKR_TRANSLATIONS = {
+        '%A' => 'l',       # The  full  weekday  name ("Sunday")
+        '%a' => 'D',       # The abbreviated weekday name ("Sun")
+        '%B' => 'F',       # The  full  month  name ("January")
+        '%b' => 'M',       # The abbreviated month name ("Jan")
+        '%D' => 'm/d/y',   # American date format mm/dd/yy
+        '%d' => 'd',       # Day of the month (01..31)
+        '%-d' => 'j',      # Day of the month (1..31)
+        '%e' => 'j',       # Day of the month (1..31)
+        '%F' => 'Y-m-d',   # ISO 8601 date format
+        '%H' => 'H',       # Hour of the day, 24-hour clock (00..23)
+        '%-H' => 'H',      # Hour of the day, 24-hour clock (0..23)
+        '%h' => 'M',       # Same as %b
+        '%I' => 'G',       # Hour of the day, 12-hour clock (01..12)
+        '%-I' => 'h',      # Hour of the day, 12-hour clock (1..12)
+        '%k' => 'H',       # Hour of the day, 24-hour clock (0..23)
+        '%l' => 'h',       # Hour of the day, 12-hour clock (1..12)
+        '%M' => 'i',       # Minute of the hour (00..59)
+        '%-M' => 'i',      # Minute of the hour (00..59)
+        '%m' => 'm',       # Month of the year (01..12)
+        '%-m' => 'n',      # Month of the year (1..12)
+        '%P' => 'K',       # Meridian indicator ('am' or 'pm')
+        '%p' => 'K',       # Meridian indicator ('AM' or 'PM')
+        '%R' => 'H:i',     # 24-hour time (%H:%M)
+        '%r' => 'G:i:S K', # 12-hour time (%I:%M:%S %p)
+        '%S' => 'S',       # Second of the minute (00..60)
+        '%-S' => 's',      # Second of the minute (0..60)
+        '%s' => 'U',       # Number of seconds since 1970-01-01 00:00:00 UTC.
+        '%T' => 'H:i:S',   # 24-hour time (%H:%M:%S)
+        '%U' => 'W',       # Week number of the year.  The week starts with Sunday.  (00..53)
+        '%w' => 'w',       # Day of the week (Sunday is 0, 0..6)
+        '%X' => 'H:i:S',   # Same as %T
+        '%x' => 'm/d/y',   # Same as %D
+        '%Y' => 'Y',       # Year with century
+        '%y' => 'y',       # Year without a century (00..99)
+        '%%' => '%',
       }.freeze
 
       class << self
-        include RailsAdmin::Support::I18n
-
-        def delocalize(date_string, format)
-          return date_string if ::I18n.locale.to_s == 'en'
-          format.to_s.scan(/%[AaBbp]/) do |match|
+        def to_flatpickr_format(strftime_format)
+          strftime_format.gsub(/(?<!%)(?<![-0-9:])\w/, '\\\\\0').gsub(/%([-0-9:]?\w)/) do |match|
+            # Timezone can't be handled by frontend, the server's one is always used
             case match
-            when '%A'
-              english = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
-              day_names.each_with_index { |d, i| date_string = date_string.gsub(/#{d}/, english[i]) }
-            when '%a'
-              english = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"]
-              abbr_day_names.each_with_index { |d, i| date_string = date_string.gsub(/#{d}/, english[i]) }
-            when '%B'
-              english = [nil, "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"][1..-1]
-              month_names.each_with_index { |m, i| date_string = date_string.gsub(/#{m}/, english[i]) }
-            when '%b'
-              english = [nil, "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"][1..-1]
-              abbr_month_names.each_with_index { |m, i| date_string = date_string.gsub(/#{m}/, english[i]) }
-            when '%p'
-              date_string = date_string.gsub(/#{::I18n.t('date.time.am', default: "am")}/, 'am')
-              date_string = date_string.gsub(/#{::I18n.t('date.time.pm', default: "pm")}/, 'pm')
+            when '%Z', '%:z' # Time zone as hour and minute offset from UTC with a colon (e.g. +09:00)
+              Time.zone.formatted_offset
+            when '%z' # Time zone as hour and minute offset from UTC (e.g. +0900)
+              Time.zone.formatted_offset(false)
+            else
+              FLATPICKR_TRANSLATIONS[match] or raise <<~MSG
+                Unsupported strftime directive '#{match}' was found. Please consider explicitly setting flatpickr_format instance option for the field.
+                  field(:name_of_field) { flatpickr_format '...' }
+              MSG
             end
           end
-          date_string
-        end
-
-        def normalize(date_string, format)
-          return unless date_string
-          delocalize(date_string, format)
-          parse_date_string(date_string)
-        end
-
-        # Parse normalized date strings using time zone
-        def parse_date_string(date_string)
-          ::Time.zone.parse(date_string)
-        end
-      end
-
-      attr_reader :strftime_format
-
-      def initialize(strftime_format)
-        @strftime_format = strftime_format
-      end
-
-      # Ruby to javascript formatting options translator
-      def to_momentjs
-        strftime_format.gsub(/\w[^.(!?%)\W]{1,}/, '[\0]').gsub(/%(\w|\-\w)/) do |match|
-          MOMENTJS_TRANSLATIONS[match]
-        end
-      end
-
-      # Delocalize a l10n datetime strings
-      def delocalize(value)
-        self.class.delocalize(value, strftime_format)
-      end
-
-      def parse_string(value)
-        return if value.blank?
-        return value if %w(DateTime Date Time).include?(value.class.name)
-        return if (delocalized_value = delocalize(value)).blank?
-
-        begin
-          # Adjust with the correct timezone and daylight savint time
-          datetime_with_wrong_tz = ::DateTime.strptime(delocalized_value, strftime_format.gsub('%-d', '%d'))
-          Time.zone.parse(datetime_with_wrong_tz.strftime('%Y-%m-%d %H:%M:%S'))
-        rescue ArgumentError
-          nil
         end
       end
     end

data/lib/rails_admin/support/es_module_processor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Support
+    class ESModuleProcessor
+      def self.instance
+        @instance ||= new
+      end
+
+      def self.call(input)
+        instance.call(input)
+      end
+
+      def initialize; end
+
+      def call(input)
+        return unless input[:name] == 'rails_admin/application'
+
+        input[:data].gsub(/^((?:import|export) .+)$/) { "// #{Regexp.last_match(1)}" }
+      end
+    end
+  end
+end

data/lib/rails_admin/support/hash_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   class HashHelper
     def self.symbolize(obj)
@@ -13,11 +15,12 @@ module RailsAdmin
       when Hash
         obj.each_with_object({}) do |(key, val), res|
           nkey = key.is_a?(String) ? key.to_sym : key
-          nval = case val
-                 when Hash, Array then symbolize(val)
-                 when String      then val.to_sym
-                 else val
-                 end
+          nval =
+            case val
+            when Hash, Array then symbolize(val)
+            when String      then val.to_sym
+            else val
+            end
           res[nkey] = nval
         end
       else

data/lib/rails_admin/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   class Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 1
-    PATCH = 1
+    PATCH = 2
     PRE = nil
 
     class << self
@@ -10,6 +12,43 @@ module RailsAdmin
       def to_s
         [MAJOR, MINOR, PATCH, PRE].compact.join('.')
       end
+
+      def js
+        JSON.parse(File.read("#{__dir__}/../../package.json"))['version']
+      end
+
+      def actual_js_version
+        case RailsAdmin.config.asset_source
+        when :webpacker, :webpack
+          js_version_from_node_modules
+        else
+          js
+        end
+      end
+
+      def warn_with_js_version
+        return unless Rails.env.development? || Rails.env.test?
+
+        case actual_js_version
+        when js
+          # Good
+        when nil
+          warn "[Warning] Failed to detect RailsAdmin npm package, did you run 'yarn install'?"
+        else
+          warn <<~MSG
+            [Warning] RailsAdmin npm package version inconsistency detected, expected #{js} but actually used is #{actual_js_version}.
+            This may cause partial or total malfunction of RailsAdmin frontend features.
+          MSG
+        end
+      end
+
+    private
+
+      def js_version_from_node_modules
+        JSON.parse(File.read(Rails.root.join('node_modules/rails_admin/package.json')))['version']
+      rescue StandardError
+        nil
+      end
     end
   end
 end

data/lib/rails_admin.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
 require 'rails_admin/engine'
 require 'rails_admin/abstract_model'
 require 'rails_admin/config'
+require 'rails_admin/config/const_load_suppressor'
 require 'rails_admin/extension'
 require 'rails_admin/extensions/cancancan'
 require 'rails_admin/extensions/pundit'
 require 'rails_admin/extensions/paper_trail'
-require 'rails_admin/extensions/history'
 require 'rails_admin/support/csv_converter'
 require 'rails_admin/support/hash_helper'
 require 'yaml'
 
 module RailsAdmin
+  extend RailsAdmin::Config::ConstLoadSuppressor
+
   # Setup RailsAdmin
   #
   # Given the first argument is a model class, a model class name
@@ -18,7 +22,7 @@ module RailsAdmin
   #
   # If only a block is passed it is stored to initializer stack to be evaluated
   # on first request in production mode and on each request in development. If
-  # initialization has already occured (in other words RailsAdmin.setup has
+  # initialization has already occurred (in other words RailsAdmin.setup has
   # been called) the block will be added to stack and evaluated at once.
   #
   # Otherwise returns RailsAdmin::Config class.
@@ -28,7 +32,7 @@ module RailsAdmin
     if entity
       RailsAdmin::Config.model(entity, &block)
     elsif block_given?
-      block.call(RailsAdmin::Config)
+      RailsAdmin::Config::ConstLoadSuppressor.suppressing { yield(RailsAdmin::Config) }
     else
       RailsAdmin::Config
     end
@@ -56,5 +60,3 @@ module RailsAdmin
     YAML.dump(object)
   end
 end
-
-require 'rails_admin/bootstrap-sass' unless defined? Bootstrap

data/lib/tasks/rails_admin.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 namespace :rails_admin do
   desc 'Install rails_admin'
   task :install do
@@ -9,10 +11,10 @@ namespace :rails_admin do
     system 'rails g rails_admin:uninstall'
   end
 
-  desc 'CI env for Travis'
+  desc 'CI env for GitHub Actions'
   task :prepare_ci_env do
     adapter = ENV['CI_DB_ADAPTER'] || 'sqlite3'
-    database = ('sqlite3' == adapter ? 'db/development.sqlite3' : 'ci_rails_admin')
+    database = (adapter == 'sqlite3' ? 'db/development.sqlite3' : 'ci_rails_admin')
     username =
       case adapter
       when 'postgresql'
@@ -28,7 +30,7 @@ namespace :rails_admin do
         'adapter' => adapter,
         'database' => database,
         'username' => username,
-        'password' => ('postgresql' == adapter ? 'postgres' : ''),
+        'password' => (adapter == 'postgresql' ? 'postgres' : ''),
         'host' => '127.0.0.1',
         'encoding' => 'utf8',
         'pool' => 5,

data/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "rails_admin",
+  "version": "3.1.2",
+  "description": "RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.",
+  "homepage": "https://github.com/railsadminteam/rails_admin",
+  "license": "MIT",
+  "author": "Mitsuhiro Shibuya <mit.shibuya@gmail.com>",
+  "files": [
+    "src"
+  ],
+  "main": "src/rails_admin/base.js",
+  "scripts": {
+    "link": "yarn link && cd spec/dummy_app && yarn link rails_admin",
+    "format": "prettier -w ."
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.16.7",
+    "@fortawesome/fontawesome-free": ">=5.15.0 <7.0.0",
+    "@hotwired/turbo-rails": "^7.1.0",
+    "@popperjs/core": "^2.11.0",
+    "@rails/ujs": "^6.1.4-1",
+    "bootstrap": "^5.1.3",
+    "flatpickr": "^4.6.9",
+    "jquery": "^3.6.0",
+    "jquery-ui": "^1.12.1"
+  },
+  "devDependencies": {
+    "prettier": "^2.4.1"
+  }
+}

data/src/rails_admin/base.js

@@ -0,0 +1,29 @@
+import Rails from "@rails/ujs";
+import "@hotwired/turbo-rails";
+import "./jquery";
+import "./vendor/jquery_nested_form";
+import "bootstrap";
+
+// These jQuery-UI indirect dependencies need to be preloaded to be used within Import maps
+import "jquery-ui/ui/version.js";
+import "jquery-ui/ui/keycode.js";
+import "jquery-ui/ui/position.js";
+import "jquery-ui/ui/safe-active-element.js";
+import "jquery-ui/ui/data.js";
+import "jquery-ui/ui/ie.js";
+import "jquery-ui/ui/scroll-parent.js";
+import "jquery-ui/ui/unique-id.js";
+import "jquery-ui/ui/widget.js";
+import "jquery-ui/ui/widgets/menu.js";
+import "jquery-ui/ui/widgets/mouse.js";
+
+import "./filter-box";
+import "./filtering-multiselect";
+import "./filtering-select";
+import "./nested-form-hooks";
+import "./remote-form";
+import "./sidescroll";
+import "./ui";
+import "./widgets";
+
+Rails.start();