godmin 1.3.0 → 2.1.0

data/lib/godmin/engine_wrapper.rb

@@ -40,8 +40,17 @@ module Godmin
       end
     end
 
+    # Some gymnastics because the `parents` function is slated for deprecation
+    # and being replaced by `module_parents` and we don't want to clutter our
+    # log with a million warnings
+    def parents_of(controller)
+      return controller.module_parents if controller.respond_to?(:module_parents)
+
+      controller.parents
+    end
+
     def find_engine_module(controller)
-      controller.parents.find do |parent|
+      parents_of(controller).find do |parent|
         parent.respond_to?(:use_relative_model_naming?) && parent.use_relative_model_naming?
       end
     end

data/lib/godmin/generators/base.rb

@@ -4,7 +4,7 @@ module Godmin
   module Generators
     class Base < Rails::Generators::Base
       def self.source_paths
-        %w(authentication install policy resource).map do |path|
+        %w[authentication install policy resource].map do |path|
           File.expand_path("../../../generators/godmin/#{path}/templates", __FILE__)
         end
       end
@@ -12,15 +12,15 @@ module Godmin
       private
 
       def namespace
-        @namespace ||= Rails::Generators.namespace
+        @_namespace ||= Rails::Generators.namespace
       end
 
       def namespaced?
-        @namespaced ||= namespace.present?
+        @_namespaced ||= namespace.present?
       end
 
       def namespaced_path
-        @namespaced_path ||= begin
+        @_namespaced_path ||= begin
           if namespaced?
             namespace.name.split("::").map(&:underscore)
           else

data/lib/godmin/generators/named_base.rb

@@ -8,7 +8,7 @@ module Godmin
       private
 
       def full_class_name
-        if namespace
+        if namespaced?
           "#{namespace}::#{class_name}"
         else
           class_name
@@ -16,15 +16,15 @@ module Godmin
       end
 
       def class_name
-        @class_name ||= name.classify
+        @_class_name ||= name.classify
       end
 
       def class_path
-        @class_path ||= namespaced_path + name.classify.deconstantize.split("::").map(&:underscore)
+        @_class_path ||= namespaced_path + name.classify.deconstantize.split("::").map(&:underscore)
       end
 
       def file_name
-        @file_name ||= class_name.demodulize.underscore
+        @_file_name ||= class_name.demodulize.underscore
       end
     end
   end

data/lib/godmin/helpers/application.rb

@@ -4,17 +4,17 @@ module Godmin
       # Renders the provided partial with locals if it exists, otherwise
       # yields the given block. The lookup context call is cached for
       # each partial.
-      def partial_override(partial, locals = {})
+      def partial_override(partial, locals = {}, &block)
         @_partial_override ||= {}
 
-        if @_partial_override[partial].nil?
+        unless @_partial_override.key?(partial)
           @_partial_override[partial] = lookup_context.exists?(partial, nil, true)
         end
 
         if @_partial_override[partial]
           render partial: partial, locals: locals
         else
-          yield
+          capture(&block)
         end
       end
 

data/lib/godmin/helpers/batch_actions.rb

@@ -6,7 +6,7 @@ module Godmin
 
         link_to(
           translate_scoped("batch_actions.labels.#{name}", default: name.to_s.titleize),
-          @resource_class,
+          [*@resource_parents, @resource_class],
           method: :patch,
           class: "btn btn-default hidden",
           data: {

data/lib/godmin/helpers/forms.rb

@@ -2,7 +2,11 @@ module Godmin
   module Helpers
     module Forms
       def form_for(record, options = {}, &block)
-        super(record, { builder: FormBuilders::FormBuilder, inline_errors: false }.merge(options), &block)
+        super(record, {
+          url: [*@resource_parents, record],
+          builder: FormBuilders::FormBuilder,
+          inline_errors: false
+        }.merge(options), &block)
       end
     end
   end

data/lib/godmin/paginator.rb

@@ -1,12 +1,12 @@
 module Godmin
   class Paginator
-    WINDOW_SIZE = 7.freeze
+    WINDOW_SIZE = 7
 
     attr_reader :per_page, :current_page
 
     def initialize(resources, per_page: 25, current_page: nil)
-      @resources    = resources
-      @per_page     = per_page
+      @resources = resources
+      @per_page = per_page
       @current_page = current_page ? current_page.to_i : 1
     end
 
@@ -35,7 +35,15 @@ module Godmin
     end
 
     def total_resources
-      @total_resources ||= @resources.count
+      @total_resources ||= begin
+        count = @resources.count
+
+        if count.respond_to?(:count)
+          count.count
+        else
+          count
+        end
+      end
     end
 
     private

data/lib/godmin/resolver.rb

@@ -1,3 +1,6 @@
+require "action_view"
+require "action_view/template/resolver"
+
 module Godmin
   class Resolver < ::ActionView::FileSystemResolver
     def self.resolvers(controller_path, engine_wrapper)
@@ -13,15 +16,30 @@ module Godmin
       @engine_wrapper = engine_wrapper
     end
 
+    # This function is for Rails 6 and up since the `find_templates` function
+    # is deprecated. It does the same thing, just a little differently. It's
+    # not being run by versions previous to Rails 6.
+    def _find_all(name, prefix, partial, details, key, locals)
+      templates = []
+
+      template_paths(prefix).each do |p|
+        break if templates.present?
+
+        path = Path.build(name, "#{@path}/#{p}", partial)
+        templates = query(path, details, details[:formats], locals, cache: !!key)
+      end
+
+      templates
+    end
+
+    # This is how we find templates in Rails 5 and below.
     def find_templates(name, prefix, *args)
       templates = []
 
       template_paths(prefix).each do |path|
-        if templates.present?
-          break
-        else
-          templates = super(name, path, *args)
-        end
+        break if templates.present?
+
+        templates = super(name, path, *args)
       end
 
       templates

data/lib/godmin/resources/resource_controller.rb

@@ -17,6 +17,7 @@ module Godmin
 
         before_action :set_resource_service
         before_action :set_resource_class
+        before_action :set_resource_parents
         before_action :set_resources, only: :index
         before_action :set_resource, only: [:show, :new, :edit, :create, :update, :destroy]
       end
@@ -83,6 +84,10 @@ module Godmin
         @resource_class = resource_class
       end
 
+      def set_resource_parents
+        @resource_parents = resource_parents
+      end
+
       def set_resources
         @resources = resources
         authorize(@resources) if authorization_enabled?
@@ -98,17 +103,31 @@ module Godmin
       end
 
       def resource_service
+        resource_service = resource_service_class.new
+
         if authentication_enabled?
-          resource_service_class.new(admin_user: admin_user)
-        else
-          resource_service_class.new
+          resource_service.options[:admin_user] = admin_user
+        end
+
+        if resource_parents.present?
+          resource_service.options[:resource_parent] = resource_parents.last
         end
+
+        resource_service
       end
 
       def resource_class
         @resource_service.resource_class
       end
 
+      def resource_parents
+        params.to_unsafe_h.each_with_object([]) do |(name, value), parents|
+          if name =~ /(.+)_id$/
+            parents << $1.classify.constantize.find(value)
+          end
+        end
+      end
+
       def resources
         @resource_service.resources(params)
       end
@@ -151,11 +170,11 @@ module Godmin
       end
 
       def redirect_after_save
-        @resource
+        [*@resource_parents, @resource]
       end
 
       def redirect_after_destroy
-        resource_class.model_name.route_key.to_sym
+        [*@resource_parents, resource_class.model_name.route_key.to_sym]
       end
 
       def redirect_flash_message

data/lib/godmin/resources/resource_controller/batch_actions.rb

@@ -33,7 +33,7 @@ module Godmin
             end
           end
 
-          redirect_back
+          redirect_back(fallback_location: root_path)
         end
 
         def batch_action_ids

data/lib/godmin/resources/resource_service.rb

@@ -1,3 +1,4 @@
+require "godmin/resources/resource_service/associations"
 require "godmin/resources/resource_service/batch_actions"
 require "godmin/resources/resource_service/filters"
 require "godmin/resources/resource_service/ordering"
@@ -9,6 +10,7 @@ module Godmin
     module ResourceService
       extend ActiveSupport::Concern
 
+      include Associations
       include BatchActions
       include Filters
       include Ordering
@@ -21,17 +23,16 @@ module Godmin
         @options = options
       end
 
-      # TODO: should this raise its own error?
       def resource_class
-        @options[:resource_class] || resource_class_name.constantize
-      end
-
-      def resource_class_name
-        self.class.name.demodulize.chomp("Service")
+        self.class.name.chomp("Service").constantize
       end
 
       def resources_relation
-        resource_class.all
+        if options[:resource_parent].present?
+          resource_class.where(options[:resource_parent].class.name.underscore => options[:resource_parent])
+        else
+          resource_class.all
+        end
       end
 
       def resources(params)

data/lib/godmin/resources/resource_service/associations.rb

@@ -0,0 +1,23 @@
+module Godmin
+  module Resources
+    module ResourceService
+      module Associations
+        extend ActiveSupport::Concern
+
+        delegate :has_many_map, to: "self.class"
+
+        module ClassMethods
+          def has_many_map
+            @has_many_map ||= {}
+          end
+
+          def has_many(attr, options = {})
+            has_many_map[attr] = {
+              class_name: attr.to_s.singularize.classify
+            }.merge(options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "1.3.0"
+  VERSION = "2.1.0"
 end

data/template.rb

@@ -1,10 +1,15 @@
 require "active_support/all"
 
 def install_standalone
-  gem "godmin", "1.2.0"
+  set_ruby_version
+
+  gem "godmin", "1.5.0"
 
   after_bundle do
-    generate_model
+    create_database
+
+    generate_models
+
     generate("godmin:install")
     generate("godmin:resource", "article")
     generate("godmin:resource", "author")
@@ -16,12 +21,15 @@ def install_standalone
     modify_author_service
     modify_article_controller
     modify_article_service
+    modify_readme
 
     migrate_and_seed
   end
 end
 
 def install_engine
+  set_ruby_version
+
   run_ruby_script("bin/rails plugin new admin --mountable")
 
   gsub_file "admin/admin.gemspec", "TODO: ", ""
@@ -29,14 +37,17 @@ def install_engine
 
   inject_into_file "admin/admin.gemspec", before: /^end/ do
     <<-END.strip_heredoc.indent(2)
-      s.add_dependency "godmin", "~> 1.0.0"
+      s.add_dependency "godmin", "~> 1.5.0"
     END
   end
 
   gem "admin", path: "admin"
 
   after_bundle do
-    generate_model
+    create_database
+
+    generate_models
+
     run_ruby_script("admin/bin/rails g godmin:install")
     run_ruby_script("admin/bin/rails g godmin:resource article")
     run_ruby_script("admin/bin/rails g godmin:resource author")
@@ -54,12 +65,24 @@ def install_engine
     modify_author_service("admin")
     modify_article_controller("admin")
     modify_article_service("admin")
+    modify_readme
 
     migrate_and_seed
   end
 end
 
-def generate_model
+def set_ruby_version
+  prepend_to_file "Gemfile" do
+    "ruby '2.3.5'\n"
+  end
+end
+
+def create_database
+  rake("db:drop")
+  rake("db:create")
+end
+
+def generate_models
   generate(:model, "author name:string")
   generate(:model, "article title:string body:text author:references published:boolean published_at:datetime")
 
@@ -106,6 +129,7 @@ def modify_rakefile
         desc "Reseed the database"
         task reseed: :environment do
           Rake::Task["sandbox:reset"].invoke
+          Rake::Task["db:environment:set"].invoke
           Rake::Task["db:schema:load"].invoke
           Rake::Task["db:seed"].invoke
         end
@@ -285,9 +309,20 @@ def modify_author_service(namespace = nil)
     END
   end
 end
+
+def modify_readme
+  readme_file = "README.md"
+  run "rm #{readme_file}"
+  readme_text = <<~README
+    # README
+
+    This is the source code for a demo application of the [Godmin](https://github.com/varvet/godmin) admin framework for Rails.
+    It is generated by running `rake sandbox:deploy` inside the Godmin repo.
+  README
+  File.open(readme_file, 'w') { |file| file.write(readme_text) }
+end
+
 def migrate_and_seed
-  rake("db:drop")
-  rake("db:create")
   rake("db:migrate")
   rake("db:seed")
 end