goodmin 0.0.1

data/Rakefile

@@ -0,0 +1,56 @@
+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    = "Goodmin"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = false
+  t.verbose = false
+end
+
+task default: :test
+
+namespace :sandbox do
+  desc "Generate the Sandbox app then push it to GitHub which deploys it to Heroku"
+  task :deploy do
+    message = "Generated from: https://github.com/varvet/goodmin/commit/#{`git rev-parse HEAD`.strip}"
+    template_path = File.expand_path("../template.rb", __FILE__)
+    Bundler.with_unbundled_env do
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir)
+        system("git clone git@github.com:varvet/goodmin-sandbox.git")
+        if $CHILD_STATUS.success?
+          Dir.chdir("goodmin-sandbox")
+          system("rm -rf *")
+          system("rails _5.2.5_ new . -d postgresql -m #{template_path} --without-engine --skip-spring")
+          if $CHILD_STATUS.success?
+            system("git add --all")
+            system("git commit -m '#{message}'")
+            system("git push origin master")
+          end
+        end
+      end
+    end
+  end
+end

data/app/assets/stylesheets/goodmin/application.css

@@ -0,0 +1,75 @@
+body {
+  margin-bottom: 20px;
+}
+
+#login {
+  margin-top: 20px;
+}
+
+#breadcrumb .dropdown:before {
+  content: " ";
+}
+
+#scopes {
+  margin-bottom: 20px;
+}
+
+#filters .filter .control-label {
+  display: block;
+}
+
+#filters .filter .form-control {
+  min-width: 170px;
+}
+
+#actions {
+  margin-bottom: 20px;
+}
+
+#actions::after {
+  display: block;
+  content: "";
+  clear: both;
+}
+
+#table td {
+  vertical-align: middle;
+}
+
+#table td .btn-group {
+  display: flex;
+}
+
+.pagination {
+  margin: 0 0 10px 0;
+}
+
+.pagination-entries {
+  line-height: 35px;
+}
+
+.highlight {
+  -moz-animation: highlight 3s;
+  -webkit-animation: highlight 3s;
+  animation: highlight 3s;
+}
+
+@-moz-keyframes highlight {
+  from {
+    background: #fffbcc;
+  }
+
+  to {
+    background: none;
+  }
+}
+
+@-webkit-keyframes highlight {
+  from {
+    background: #fffbcc;
+  }
+
+  to {
+    background: none;
+  }
+}

data/app/controllers/goodmin/application_controller.rb

@@ -0,0 +1,43 @@
+module Goodmin
+  class ApplicationController < ActionController::Base
+    include Goodmin::Helpers::Translations
+
+    helper Goodmin::Helpers::Application
+    helper Goodmin::Helpers::Forms
+    helper Goodmin::Helpers::Navigation
+    helper Goodmin::Helpers::Translations
+
+    helper_method :authentication_enabled?
+    helper_method :authorization_enabled?
+
+    before_action :append_view_paths
+
+    layout "goodmin/application"
+
+    def welcome; end
+
+    protected
+
+    private
+
+    def append_view_paths
+      append_view_path Goodmin::Resolver.resolvers(controller_path)
+    end
+
+    def disable_authentication
+      @_disable_authentication = true
+    end
+
+    def disable_authorization
+      @_disable_authorization = true
+    end
+
+    def authentication_enabled?
+      !@_disable_authentication && singleton_class.include?(Goodmin::Authentication)
+    end
+
+    def authorization_enabled?
+      !@_disable_authorization && singleton_class.include?(Goodmin::Authorization)
+    end
+  end
+end

data/app/controllers/goodmin/resource_controller.rb

@@ -0,0 +1,235 @@
+require "goodmin/helpers/batch_actions"
+
+module Goodmin
+  class ResourceController < ApplicationController
+    include Goodmin::Resources::Resource::BatchActions
+
+    helper Goodmin::Helpers::BatchActions
+    helper Goodmin::Helpers::Filters
+    helper Goodmin::Helpers::Tables
+
+    before_action :set_resource_service
+    before_action :set_resource_class
+    before_action :set_resource_parents
+    before_action :set_resources, only: :index
+    before_action :handle_batch_action, only: :update, if: -> { params[:batch_action].present? }
+    before_action :set_resource, only: [:show, :new, :edit, :create, :update, :destroy]
+
+    def index
+      respond_to do |format|
+        format.html
+        format.json
+        format.csv
+      end
+    end
+
+    def show
+      respond_to do |format|
+        format.html
+        format.json
+      end
+    end
+
+    def new; end
+
+    def edit; end
+
+    def create
+      respond_to do |format|
+        if @resource_service.create_resource(@resource)
+          format.html { redirect_to redirect_after_create, notice: redirect_flash_message }
+          format.json { render :show, status: :created, location: @resource }
+        else
+          format.html { render :edit }
+          format.json { render json: @resource.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def update
+      respond_to do |format|
+        if @resource_service.update_resource(@resource, resource_params)
+          format.html { redirect_to redirect_after_update, notice: redirect_flash_message }
+          format.json { render :show, status: :ok, location: @resource }
+        else
+          format.html { render :edit }
+          format.json { render json: @resource.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def destroy
+      @resource_service.destroy_resource(@resource)
+
+      respond_to do |format|
+        format.html { redirect_to redirect_after_destroy, notice: redirect_flash_message }
+        format.json { head :no_content }
+      end
+    end
+
+    protected
+
+    def set_resource_service
+      @resource_service = resource_service
+    end
+
+    def set_resource_class
+      @resource_class = resource_class
+    end
+
+    def set_resource_parents
+      @resource_parents = resource_parents
+    end
+
+    def set_resources
+      @resources = resources
+      authorize(@resources) if authorization_enabled?
+    end
+
+    def set_resource
+      @resource = resource
+      authorize(@resource) if authorization_enabled?
+    end
+
+    def resource_service_class
+      resource_name = controller_path.split("/").last.singularize.classify
+      "Goodmin::Resources::#{resource_name}Resource".constantize
+    end
+
+    def resource_service
+      resource_service = resource_service_class.new
+
+      if authentication_enabled?
+        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
+
+    def resource
+      if params[:id]
+        @resource_service.find_resource(params[:id])
+      else
+        case action_name
+        when "create"
+          @resource_service.build_resource(resource_params)
+        when "new"
+          @resource_service.build_resource(nil)
+        end
+      end
+    end
+
+    def resource_params
+      params.require(@resource_class.model_name.param_key.to_sym).permit(resource_params_defaults)
+    end
+
+    def resource_params_defaults
+      @resource_service.attrs_for_form.map do |attribute|
+        association = @resource_class.reflect_on_association(attribute.name)
+
+        if association && association.macro == :belongs_to
+          association.foreign_key.to_sym
+        elsif association && (many_to_many_association?(association) || has_many_association?(association))
+          { "#{attribute.name.to_s.singularize}_ids".to_sym => [] }
+        elsif association && nested_attributes_accepted?(attribute.name)
+          { "#{attribute.name}_attributes".to_sym => nested_attribute_permit_list(association) }
+        else
+          attribute.name
+        end
+      end
+    end
+
+    def nested_attributes_accepted?(attribute_name)
+      @resource_class.method_defined?("#{attribute_name}_attributes=")
+    end
+
+    def nested_attribute_permit_list(association)
+      service_class = Goodmin::ServiceLocator.find_service_class_for(association.klass, context_service_class: @resource_service.class)
+      attrs = service_class&.attrs_for_form || []
+      [:id] + attrs.map(&:name)
+    end
+
+    def many_to_many_association?(association)
+      association.macro == :has_and_belongs_to_many ||
+        (association.macro == :has_many && association.options[:through].present?)
+    end
+
+    def has_many_association?(association)
+      association.macro == :has_many && !association.options[:through].present?
+    end
+
+    def redirect_after_create
+      redirect_after_save
+    end
+
+    def redirect_after_update
+      redirect_after_save
+    end
+
+    def redirect_after_save
+      [*@resource_parents, @resource]
+    end
+
+    def redirect_after_destroy
+      [*@resource_parents, resource_class.model_name.route_key.to_sym]
+    end
+
+    def redirect_flash_message
+      translate_scoped("flash.#{action_name}", resource: @resource.class.model_name.human)
+    end
+
+    def handle_batch_action
+      action = params[:batch_action].to_sym
+      ids = params[:id].to_s.split(",")
+      records = @resource_class.where(id: ids)
+
+      @resource_service.batch_action(action, records)
+
+      redirect_path = if respond_to?("redirect_after_batch_action_#{action}", true)
+        send("redirect_after_batch_action_#{action}")
+      else
+        [*@resource_parents, @resource_class.model_name.route_key.to_sym]
+      end
+
+      redirect_to redirect_path
+    end
+
+    private
+
+    def disable_authentication
+      @_disable_authentication = true
+    end
+
+    def disable_authorization
+      @_disable_authorization = true
+    end
+
+    def authentication_enabled?
+      !@_disable_authentication && singleton_class.include?(Goodmin::Authentication)
+    end
+
+    def authorization_enabled?
+      !@_disable_authorization && singleton_class.include?(Goodmin::Authorization)
+    end
+  end
+end

data/app/helpers/goodmin/application_helper.rb

@@ -0,0 +1,45 @@
+module Goodmin
+  module ApplicationHelper
+    # Renders the provided partial with locals if it exists, otherwise
+    # yields the given block. The lookup context call is cached for
+    # each partial.
+    # Returns the display name for a resource record by looking up its service
+    # class via ServiceLocator and calling display_name on it. Falls back to
+    # record.to_s if no service class is found.
+    def resource_display_name(record)
+      service_class = Goodmin::ServiceLocator.find_service_class_for(
+        record.class,
+        context_service_class: @resource_service&.class
+      )
+      service = service_class&.new
+      service ? service.display_name(record) : record.to_s
+    rescue StandardError
+      record.to_s
+    end
+
+    def partial_override(partial, locals = {}, &block)
+      @_partial_override ||= {}
+
+      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
+        capture(&block)
+      end
+    end
+
+    # Wraps the policy helper so that it is always accessible, even when
+    # authorization is not enabled. When that is the case, it returns a
+    # policy that always returns true.
+    def policy(resource)
+      if authorization_enabled?
+        controller.policy(resource)
+      else
+        Authorization::Policy.new(nil, nil, default: true)
+      end
+    end
+  end
+end

data/app/javascript/goodmin/application.js

@@ -0,0 +1,8 @@
+import { Application } from "@hotwired/stimulus"
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+
+const application = Application.start()
+application.debug = false
+window.Stimulus = application
+
+eagerLoadControllersFrom("controllers", application)

data/app/javascript/goodmin/controllers/batch_actions_controller.js

@@ -0,0 +1,101 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["selectAll", "selectNone", "checkbox", "checkboxContainer", "actionLink"]
+
+  connect() {
+    this.updateState()
+  }
+
+  toggle(event) {
+    event.preventDefault()
+    if (this.checkedIds().length > 0) {
+      this.checkboxTargets.forEach(cb => { cb.checked = false })
+    } else {
+      this.checkboxTargets.forEach(cb => { cb.checked = true })
+    }
+    this.updateActions()
+  }
+
+  containerClick(event) {
+    if (event.currentTarget === event.target) {
+      event.currentTarget.querySelector("[data-batch-actions-target='checkbox']").click()
+    }
+  }
+
+  checkboxChange() {
+    this.updateActions()
+  }
+
+  triggerAction(event) {
+    event.preventDefault()
+    const link = event.currentTarget
+    const confirmMessage = link.dataset.confirm
+    if (confirmMessage && !window.confirm(confirmMessage)) return
+
+    const action = link.getAttribute("href") + "/" + this.checkedIds().join(",")
+    const batchAction = link.dataset.value
+    const csrfToken = document.querySelector("meta[name='csrf-token']")?.content
+
+    const form = document.createElement("form")
+    form.method = "post"
+    form.action = action
+
+    const methodInput = document.createElement("input")
+    methodInput.type = "hidden"
+    methodInput.name = "_method"
+    methodInput.value = "patch"
+    form.appendChild(methodInput)
+
+    const batchInput = document.createElement("input")
+    batchInput.type = "hidden"
+    batchInput.name = "batch_action"
+    batchInput.value = batchAction
+    form.appendChild(batchInput)
+
+    if (csrfToken) {
+      const csrfInput = document.createElement("input")
+      csrfInput.type = "hidden"
+      csrfInput.name = "authenticity_token"
+      csrfInput.value = csrfToken
+      form.appendChild(csrfInput)
+    }
+
+    document.body.appendChild(form)
+    form.submit()
+  }
+
+  checkedIds() {
+    return this.checkboxTargets
+      .filter(cb => cb.checked)
+      .map(cb => {
+        const match = cb.id.match(/\d+/)
+        return match ? match[0] : null
+      })
+      .filter(id => id !== null)
+  }
+
+  showSelectAll() {
+    this.selectAllTargets.forEach(el => el.classList.remove("hidden"))
+    this.selectNoneTargets.forEach(el => el.classList.add("hidden"))
+  }
+
+  showSelectNone() {
+    this.selectAllTargets.forEach(el => el.classList.add("hidden"))
+    this.selectNoneTargets.forEach(el => el.classList.remove("hidden"))
+  }
+
+  updateActions() {
+    if (this.checkedIds().length > 0) {
+      this.actionLinkTargets.forEach(el => el.classList.remove("hidden"))
+      this.showSelectNone()
+    } else {
+      this.actionLinkTargets.forEach(el => el.classList.add("hidden"))
+      this.showSelectAll()
+    }
+  }
+
+  updateState() {
+    this.updateActions()
+  }
+}

data/app/javascript/goodmin/controllers/datetimepicker_controller.js

@@ -0,0 +1,24 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static values = { type: String }
+
+  connect() {
+    if (typeof $ === "undefined" || !$.fn.datetimepicker) return
+
+    const options = {}
+    if (this.typeValue === "date") {
+      options.pickTime = false
+    } else if (this.typeValue === "time") {
+      options.pickDate = false
+    }
+
+    $(this.element).datetimepicker(options)
+  }
+
+  disconnect() {
+    if (typeof $ === "undefined" || !$.fn.datetimepicker) return
+    const picker = $(this.element).data("DateTimePicker")
+    if (picker) picker.destroy()
+  }
+}

data/app/javascript/goodmin/controllers/navigation_controller.js

@@ -0,0 +1,30 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.setActiveLink()
+    this.removeEmptyDropdowns()
+  }
+
+  setActiveLink() {
+    const pathWithSearch = window.location.pathname + window.location.search
+    let links = this.element.querySelectorAll(`.nav.navbar-nav a[href="${pathWithSearch}"]`)
+
+    if (links.length === 0) {
+      links = this.element.querySelectorAll(`.nav.navbar-nav a[href="${window.location.pathname}"]`)
+    }
+
+    links.forEach(link => {
+      link.closest("li")?.classList.add("active")
+      link.closest("li.dropdown")?.classList.add("active")
+    })
+  }
+
+  removeEmptyDropdowns() {
+    this.element.querySelectorAll(".navbar-nav .dropdown, .breadcrumb .dropdown").forEach(dropdown => {
+      if (dropdown.querySelectorAll("li").length === 0) {
+        dropdown.remove()
+      }
+    })
+  }
+}

data/app/jobs/goodmin/application_job.rb

@@ -0,0 +1,4 @@
+module Goodmin
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/goodmin/application_mailer.rb

@@ -0,0 +1,6 @@
+module Goodmin
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/goodmin/application_record.rb

@@ -0,0 +1,5 @@
+module Goodmin
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/goodmin/application/welcome.html.erb

@@ -0,0 +1,17 @@
+<div class="row">
+  <div class="col-md-6 col-md-offset-3">
+    <div class="jumbotron">
+      <h1>Welcome</h1>
+      <p>
+        You are running Goodmin <%= Goodmin::VERSION %>.
+        Add your own root route to the routes file in order to remove this page.
+      </p>
+      <p>
+        <a href="https://github.com/mbajur/goodmin/" class="btn btn-primary btn-lg" role="button">
+          <span class="glyphicon glyphicon-book"></span>
+          Browse the documentation
+        </a>
+      </p>
+    </div>
+  </div>
+</div>

data/app/views/goodmin/fields/association/_form.html.erb

@@ -0,0 +1,19 @@
+<% if field.belongs_to? %>
+  <div class="form-group">
+    <%= f.label field.select_attribute %>
+    <%= f.select field.select_attribute, field.collection, {}, class: "form-control" %>
+    <%= content_tag(:p, field.hint, class: "help-block") if field.hint.present? %>
+  </div>
+<% elsif field.many_to_many? || field.has_many? %>
+  <div class="form-group">
+    <%= f.label field.select_attribute, field.attribute.to_s.humanize %>
+    <%= f.select field.select_attribute, field.collection, {}, class: "form-control", multiple: true %>
+    <%= content_tag(:p, field.hint, class: "help-block") if field.hint.present? %>
+  </div>
+<% else %>
+  <div class="form-group">
+    <%= f.label field.attribute %>
+    <%= f.text_field field.attribute, class: "form-control" %>
+    <%= content_tag(:p, field.hint, class: "help-block") if field.hint.present? %>
+  </div>
+<% end %>

data/app/views/goodmin/fields/association/_index.html.erb

@@ -0,0 +1,6 @@
+<% value = field.value %>
+<% if value.respond_to?(:each) %>
+  <%= value.map { |v| field.display_name_for(v) }.join(", ") %>
+<% else %>
+  <%= field.display_name_for(value) %>
+<% end %>

data/app/views/goodmin/fields/association/_show.html.erb

@@ -0,0 +1,6 @@
+<% value = field.value %>
+<% if value.respond_to?(:each) %>
+  <%= value.map { |v| field.display_name_for(v) }.join(", ") %>
+<% else %>
+  <%= field.display_name_for(value) %>
+<% end %>