administrate 0.11.0 → 0.16.0

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "0.11.0".freeze
+  VERSION = "0.16.0".freeze
 end

data/lib/administrate/view_generator.rb

@@ -1,11 +1,11 @@
 require "rails/generators/base"
 require "administrate/generator_helpers"
+require "administrate/namespace"
 
 module Administrate
   class ViewGenerator < Rails::Generators::Base
     include Administrate::GeneratorHelpers
-
-    private
+    class_option :namespace, type: :string, default: :admin
 
     def self.template_source_path
       File.expand_path(
@@ -14,12 +14,18 @@ module Administrate
       )
     end
 
+    private
+
+    def namespace
+      options[:namespace]
+    end
+
     def copy_resource_template(template_name)
       template_file = "#{template_name}.html.erb"
 
       copy_file(
         template_file,
-        "app/views/admin/#{resource_path}/#{template_file}",
+        "app/views/#{namespace}/#{resource_path}/#{template_file}",
       )
     end
 

data/lib/generators/administrate/dashboard/dashboard_generator.rb

@@ -5,18 +5,21 @@ module Administrate
     class DashboardGenerator < Rails::Generators::NamedBase
       ATTRIBUTE_TYPE_MAPPING = {
         boolean: "Field::Boolean",
-        date: "Field::DateTime",
+        date: "Field::Date",
         datetime: "Field::DateTime",
-        enum: "Field::String",
+        enum: "Field::Select",
         float: "Field::Number",
         integer: "Field::Number",
         time: "Field::Time",
         text: "Field::Text",
         string: "Field::String",
+        uuid: "Field::String",
       }
 
       ATTRIBUTE_OPTIONS_MAPPING = {
-        enum: { searchable: false },
+        # procs must be defined in one line!
+        enum: {  searchable: false,
+                 collection: ->(field) { field.resource.class.send(field.attribute.to_s.pluralize).keys } },
         float: { decimals: 2 },
       }
 
@@ -24,7 +27,7 @@ module Administrate
       COLLECTION_ATTRIBUTE_LIMIT = 4
       READ_ONLY_ATTRIBUTES = %w[id created_at updated_at]
 
-      class_option :namespace, type: :string, default: "admin"
+      class_option :namespace, type: :string, default: :admin
 
       source_root File.expand_path("../templates", __FILE__)
 
@@ -50,7 +53,9 @@ module Administrate
       end
 
       def attributes
-        klass.reflections.keys + klass.attribute_names - redundant_attributes
+        klass.reflections.keys +
+          klass.columns.map(&:name) -
+          redundant_attributes
       end
 
       def form_attributes
@@ -105,11 +110,11 @@ module Administrate
         if relationship.has_one?
           "Field::HasOne"
         elsif relationship.collection?
-          "Field::HasMany" + relationship_options_string(relationship)
+          "Field::HasMany"
         elsif relationship.polymorphic?
           "Field::Polymorphic"
         else
-          "Field::BelongsTo" + relationship_options_string(relationship)
+          "Field::BelongsTo"
         end
       end
 
@@ -117,14 +122,6 @@ module Administrate
         @klass ||= Object.const_get(class_name)
       end
 
-      def relationship_options_string(relationship)
-        if relationship.class_name != relationship.name.to_s.classify
-          options_string(class_name: relationship.class_name)
-        else
-          ""
-        end
-      end
-
       def options_string(options)
         if options.any?
           ".with_options(#{inspect_hash_as_ruby(options)})"
@@ -134,7 +131,16 @@ module Administrate
       end
 
       def inspect_hash_as_ruby(hash)
-        hash.map { |key, value| "#{key}: #{value.inspect}" }.join(", ")
+        hash.map do |key, value|
+          v_str = value.respond_to?(:call) ? proc_string(value) : value.inspect
+          "#{key}: #{v_str}"
+        end.join(", ")
+      end
+
+      def proc_string(value)
+        source = value.source_location
+        proc_string = IO.readlines(source.first)[source.second - 1]
+        proc_string[/->[^}]*} | (lambda|proc).*end/x]
       end
     end
   end

data/lib/generators/administrate/dashboard/templates/controller.rb.erb

@@ -1,18 +1,43 @@
-module <%= namespace.classify %>
-  class <%= class_name.pluralize %>Controller < <%= namespace.classify %>::ApplicationController
-    # To customize the behavior of this controller,
-    # you can overwrite any of the RESTful actions. For example:
+module <%= namespace.to_s.classify %>
+  class <%= class_name.pluralize %>Controller < <%= namespace.to_s.classify %>::ApplicationController
+    # Overwrite any of the RESTful controller actions to implement custom behavior
+    # For example, you may want to send an email after a foo is updated.
     #
-    # def index
+    # def update
     #   super
-    #   @resources = <%= class_name %>.
-    #     page(params[:page]).
-    #     per(10)
+    #   send_foo_updated_email(requested_resource)
     # end
 
-    # Define a custom finder by overriding the `find_resource` method:
+    # Override this method to specify custom lookup behavior.
+    # This will be used to set the resource for the `show`, `edit`, and `update`
+    # actions.
+    #
     # def find_resource(param)
-    #   <%= class_name %>.find_by!(slug: param)
+    #   Foo.find_by!(slug: param)
+    # end
+
+    # The result of this lookup will be available as `requested_resource`
+
+    # Override this if you have certain roles that require a subset
+    # this will be used to set the records shown on the `index` action.
+    #
+    # def scoped_resource
+    #   if current_user.super_admin?
+    #     resource_class
+    #   else
+    #     resource_class.with_less_stuff
+    #   end
+    # end
+
+    # Override `resource_params` if you want to transform the submitted
+    # data before it's persisted. For example, the following would turn all
+    # empty values into nil values. It uses other APIs such as `resource_class`
+    # and `dashboard`:
+    #
+    # def resource_params
+    #   params.require(resource_class.model_name.param_key).
+    #     permit(dashboard.permitted_attributes).
+    #     transform_values { |value| value == "" ? nil : value }
     # end
 
     # See https://administrate-prototype.herokuapp.com/customizing_controller_actions

data/lib/generators/administrate/dashboard/templates/dashboard.rb.erb

@@ -18,20 +18,20 @@ class <%= class_name %>Dashboard < Administrate::BaseDashboard
   #
   # By default, it's limited to four items to reduce clutter on index pages.
   # Feel free to add, remove, or rearrange items.
-  COLLECTION_ATTRIBUTES = [
+  COLLECTION_ATTRIBUTES = %i[
 <%=
   attributes.first(COLLECTION_ATTRIBUTE_LIMIT).map do |attr|
-    "    :#{attr},"
+    "    #{attr}"
   end.join("\n")
 %>
   ].freeze
 
   # SHOW_PAGE_ATTRIBUTES
   # an array of attributes that will be displayed on the model's show page.
-  SHOW_PAGE_ATTRIBUTES = [
+  SHOW_PAGE_ATTRIBUTES = %i[
 <%=
   attributes.map do |attr|
-    "    :#{attr},"
+    "    #{attr}"
   end.join("\n")
 %>
   ].freeze
@@ -39,14 +39,26 @@ class <%= class_name %>Dashboard < Administrate::BaseDashboard
   # FORM_ATTRIBUTES
   # an array of attributes that will be displayed
   # on the model's form (`new` and `edit`) pages.
-  FORM_ATTRIBUTES = [
+  FORM_ATTRIBUTES = %i[
 <%=
   form_attributes.map do |attr|
-    "    :#{attr},"
+    "    #{attr}"
   end.join("\n")
 %>
   ].freeze
 
+  # COLLECTION_FILTERS
+  # a hash that defines filters that can be used while searching via the search
+  # field of the dashboard.
+  #
+  # For example to add an option to search for open resources by typing "open:"
+  # in the search field:
+  #
+  #   COLLECTION_FILTERS = {
+  #     open: ->(resources) { resources.where(open: true) }
+  #   }.freeze
+  COLLECTION_FILTERS = {}.freeze
+
   # Overwrite this method to customize how <%= file_name.pluralize.humanize.downcase %> are displayed
   # across all pages of the admin dashboard.
   #

data/lib/generators/administrate/install/install_generator.rb

@@ -1,3 +1,9 @@
+if defined?(Zeitwerk)
+  Zeitwerk::Loader.eager_load_all
+else
+  Rails.application.eager_load!
+end
+
 require "rails/generators/base"
 require "administrate/generator_helpers"
 require "administrate/namespace"
@@ -13,7 +19,7 @@ module Administrate
       def run_routes_generator
         if dashboard_resources.none?
           call_generator("administrate:routes", "--namespace", namespace)
-          load Rails.root.join("config/routes.rb")
+          Rails.application.reload_routes!
         end
       end
 
@@ -31,6 +37,12 @@ module Administrate
         end
       end
 
+      def model_check
+        if valid_dashboard_models.none?
+          puts "WARNING: Add models before installing Administrate."
+        end
+      end
+
       private
 
       def namespace
@@ -44,6 +56,30 @@ module Administrate
       def dashboard_resources
         Administrate::Namespace.new(namespace).resources
       end
+
+      def valid_dashboard_models
+        database_models - invalid_dashboard_models
+      end
+
+      def database_models
+        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+      end
+
+      def invalid_dashboard_models
+        (models_without_tables + namespaced_models + unnamed_constants).uniq
+      end
+
+      def models_without_tables
+        database_models.reject(&:table_exists?)
+      end
+
+      def namespaced_models
+        database_models.select { |model| model.to_s.include?("::") }
+      end
+
+      def unnamed_constants
+        ActiveRecord::Base.descendants.reject { |d| d.name == d.to_s }
+      end
     end
   end
 end

data/lib/generators/administrate/install/templates/application_controller.rb.erb

@@ -1,6 +1,6 @@
-# All Administrate controllers inherit from this `Admin::ApplicationController`,
-# making it the ideal place to put authentication logic or other
-# before_actions.
+# All Administrate controllers inherit from this
+# `Administrate::ApplicationController`, making it the ideal place to put
+# authentication logic or other before_actions.
 #
 # If you want to add pagination or other controller-level concerns,
 # you're free to overwrite the RESTful controller actions.

data/lib/generators/administrate/routes/routes_generator.rb

@@ -1,29 +1,36 @@
-Rails.application.eager_load!
+if defined?(Zeitwerk)
+  Zeitwerk::Loader.eager_load_all
+else
+  Rails.application.eager_load!
+end
+
 require "rails/generators/base"
+require "administrate/generator_helpers"
 require "administrate/namespace"
 
 module Administrate
   module Generators
     class RoutesGenerator < Rails::Generators::Base
+      include Administrate::GeneratorHelpers
       source_root File.expand_path("../templates", __FILE__)
       class_option :namespace, type: :string, default: "admin"
 
       def insert_dashboard_routes
-        if should_route_dashboard?
+        if valid_dashboard_models.any?
           route(dashboard_routes)
         end
       end
 
       def warn_about_invalid_models
-        namespaced_models.each do |invalid_model|
-          puts "WARNING: Unable to generate a dashboard for #{invalid_model}."
-          puts "         Administrate does not yet support namespaced models."
-        end
-
-        models_without_tables.each do |invalid_model|
-          puts "WARNING: Unable to generate a dashboard for #{invalid_model}."
-          puts "         It is not connected to a database table."
-          puts "         Make sure your database migrations are up to date."
+        invalid_dashboard_models.each do |model|
+          puts "WARNING: Unable to generate a dashboard for #{model}."
+          if namespaced_models.include?(model)
+            puts "       - Administrate does not yet support namespaced models."
+          end
+          if models_without_tables.include?(model)
+            puts "       - It is not connected to a database table."
+            puts "         Make sure your database migrations are up to date."
+          end
         end
 
         unnamed_constants.each do |invalid_model|
@@ -44,15 +51,15 @@ module Administrate
       end
 
       def valid_dashboard_models
-        database_models - invalid_database_models
+        database_models - invalid_dashboard_models
       end
 
       def database_models
         ActiveRecord::Base.descendants.reject(&:abstract_class?)
       end
 
-      def invalid_database_models
-        models_without_tables + namespaced_models + unnamed_constants
+      def invalid_dashboard_models
+        (models_without_tables + namespaced_models + unnamed_constants).uniq
       end
 
       def models_without_tables
@@ -71,21 +78,9 @@ module Administrate
         ERB.new(File.read(routes_file_path)).result(binding)
       end
 
-      def routes_includes_resources?
-        File.read(rails_routes_file_path).include?(dashboard_routes)
-      end
-
-      def rails_routes_file_path
-        Rails.root.join("config/routes.rb")
-      end
-
       def routes_file_path
         File.expand_path(find_in_source_paths("routes.rb.erb"))
       end
-
-      def should_route_dashboard?
-        routes_includes_resources? || valid_dashboard_models.any?
-      end
     end
   end
 end

data/lib/generators/administrate/views/layout_generator.rb

@@ -16,6 +16,7 @@ module Administrate
           copy_resource_template("_stylesheet")
           copy_resource_template("_javascript")
           copy_resource_template("_flashes")
+          copy_resource_template("_icons")
         end
       end
     end

data/lib/generators/administrate/views/views_generator.rb

@@ -4,10 +4,11 @@ module Administrate
   module Generators
     class ViewsGenerator < Administrate::ViewGenerator
       def copy_templates
-        call_generator("administrate:views:index", resource_path)
-        call_generator("administrate:views:show", resource_path)
-        call_generator("administrate:views:new", resource_path)
-        call_generator("administrate:views:edit", resource_path)
+        view = "administrate:views:"
+        call_generator("#{view}index", resource_path, "--namespace", namespace)
+        call_generator("#{view}show", resource_path, "--namespace", namespace)
+        call_generator("#{view}new", resource_path, "--namespace", namespace)
+        call_generator("#{view}edit", resource_path, "--namespace", namespace)
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: administrate
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Nick Charlton
 - Grayson Wright
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,74 +17,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: autoprefixer-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: datetime_picker_rails
   requirement: !ruby/object:Gem::Requirement
@@ -142,19 +110,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: sass-rails
+  name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: selectize-rails
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Administrate is heavily inspired by projects like Rails Admin and ActiveAdmin,
   but aims to provide a better user experience for site admins,
@@ -191,8 +173,8 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - app/assets/javascripts/administrate/application.js
+- app/assets/javascripts/administrate/components/associative.js
 - app/assets/javascripts/administrate/components/date_time_picker.js
-- app/assets/javascripts/administrate/components/has_many_form.js
 - app/assets/javascripts/administrate/components/table.js
 - app/assets/stylesheets/administrate/application.scss
 - app/assets/stylesheets/administrate/base/_forms.scss
@@ -223,7 +205,7 @@ files:
 - app/views/administrate/application/_collection.html.erb
 - app/views/administrate/application/_flashes.html.erb
 - app/views/administrate/application/_form.html.erb
-- app/views/administrate/application/_icons.erb
+- app/views/administrate/application/_icons.html.erb
 - app/views/administrate/application/_javascript.html.erb
 - app/views/administrate/application/_navigation.html.erb
 - app/views/administrate/application/_search.html.erb
@@ -238,6 +220,9 @@ files:
 - app/views/fields/boolean/_form.html.erb
 - app/views/fields/boolean/_index.html.erb
 - app/views/fields/boolean/_show.html.erb
+- app/views/fields/date/_form.html.erb
+- app/views/fields/date/_index.html.erb
+- app/views/fields/date/_show.html.erb
 - app/views/fields/date_time/_form.html.erb
 - app/views/fields/date_time/_index.html.erb
 - app/views/fields/date_time/_show.html.erb
@@ -271,9 +256,11 @@ files:
 - app/views/fields/time/_form.html.erb
 - app/views/fields/time/_index.html.erb
 - app/views/fields/time/_show.html.erb
+- app/views/fields/url/_form.html.erb
+- app/views/fields/url/_index.html.erb
+- app/views/fields/url/_show.html.erb
 - app/views/layouts/administrate/application.html.erb
 - config/i18n-tasks.yml
-- config/locales/administrate.al.yml
 - config/locales/administrate.ar.yml
 - config/locales/administrate.bs.yml
 - config/locales/administrate.ca.yml
@@ -281,6 +268,7 @@ files:
 - config/locales/administrate.de.yml
 - config/locales/administrate.en.yml
 - config/locales/administrate.es.yml
+- config/locales/administrate.fi.yml
 - config/locales/administrate.fr.yml
 - config/locales/administrate.id.yml
 - config/locales/administrate.it.yml
@@ -291,14 +279,16 @@ files:
 - config/locales/administrate.pt-BR.yml
 - config/locales/administrate.pt.yml
 - config/locales/administrate.ru.yml
+- config/locales/administrate.sq.yml
 - config/locales/administrate.sv.yml
+- config/locales/administrate.tr.yml
 - config/locales/administrate.uk.yml
 - config/locales/administrate.vi.yml
 - config/locales/administrate.zh-CN.yml
 - config/locales/administrate.zh-TW.yml
 - config/routes.rb
-- config/secrets.yml
 - config/unicorn.rb
+- docs/adding_controllers_without_related_model.md
 - docs/adding_custom_field_types.md
 - docs/authentication.md
 - docs/authorization.md
@@ -306,14 +296,20 @@ files:
 - docs/customizing_controller_actions.md
 - docs/customizing_dashboards.md
 - docs/customizing_page_views.md
+- docs/extending_administrate.md
 - docs/getting_started.md
+- docs/guides.md
+- docs/guides/hiding_dashboards_from_sidebar.md
+- docs/rails_api.md
 - lib/administrate.rb
 - lib/administrate/base_dashboard.rb
+- lib/administrate/custom_dashboard.rb
 - lib/administrate/engine.rb
 - lib/administrate/field/associative.rb
 - lib/administrate/field/base.rb
 - lib/administrate/field/belongs_to.rb
 - lib/administrate/field/boolean.rb
+- lib/administrate/field/date.rb
 - lib/administrate/field/date_time.rb
 - lib/administrate/field/deferred.rb
 - lib/administrate/field/email.rb
@@ -326,6 +322,7 @@ files:
 - lib/administrate/field/string.rb
 - lib/administrate/field/text.rb
 - lib/administrate/field/time.rb
+- lib/administrate/field/url.rb
 - lib/administrate/generator_helpers.rb
 - lib/administrate/namespace.rb
 - lib/administrate/namespace/resource.rb
@@ -365,11 +362,11 @@ files:
 - lib/generators/administrate/views/show_generator.rb
 - lib/generators/administrate/views/views_generator.rb
 - lib/tasks/administrate_tasks.rake
-homepage: https://administrate-prototype.herokuapp.com/
+homepage: https://administrate-demo.herokuapp.com/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -384,9 +381,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Rails engine for creating super-flexible admin dashboards
 test_files: []