semantic-administrate 0.1.0

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

@@ -0,0 +1,21 @@
+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:
+    #
+    # def index
+    #   super
+    #   @resources = <%= class_name %>.
+    #     page(params[:page]).
+    #     per(10)
+    # end
+
+    # Define a custom finder by overriding the `find_resource` method:
+    # def find_resource(param)
+    #   <%= class_name %>.find_by!(slug: param)
+    # end
+
+    # See https://administrate-prototype.herokuapp.com/customizing_controller_actions
+    # for more information
+  end
+end

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

@@ -0,0 +1,56 @@
+require "administrate/base_dashboard"
+
+class <%= class_name %>Dashboard < Administrate::BaseDashboard
+  # ATTRIBUTE_TYPES
+  # a hash that describes the type of each of the model's fields.
+  #
+  # Each different type represents an Administrate::Field object,
+  # which determines how the attribute is displayed
+  # on pages throughout the dashboard.
+  ATTRIBUTE_TYPES = {
+<% attributes.each do |attr| -%>
+    <%= attr %>: <%= field_type(attr) %>,
+<% end -%>
+  }.freeze
+
+  # COLLECTION_ATTRIBUTES
+  # an array of attributes that will be displayed on the model's index page.
+  #
+  # By default, it's limited to four items to reduce clutter on index pages.
+  # Feel free to add, remove, or rearrange items.
+  COLLECTION_ATTRIBUTES = [
+<%=
+  attributes.first(COLLECTION_ATTRIBUTE_LIMIT).map do |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 = [
+<%=
+  attributes.map do |attr|
+    "    :#{attr},"
+  end.join("\n")
+%>
+  ].freeze
+
+  # FORM_ATTRIBUTES
+  # an array of attributes that will be displayed
+  # on the model's form (`new` and `edit`) pages.
+  FORM_ATTRIBUTES = [
+<%=
+  form_attributes.map do |attr|
+    "    :#{attr},"
+  end.join("\n")
+%>
+  ].freeze
+
+  # Overwrite this method to customize how <%= file_name.pluralize.humanize.downcase %> are displayed
+  # across all pages of the admin dashboard.
+  #
+  # def display_resource(<%= file_name %>)
+  #   "<%= class_name %> ##{<%= file_name %>.id}"
+  # end
+end

data/lib/generators/administrate/field/field_generator.rb

@@ -0,0 +1,31 @@
+module Administrate
+  module Generators
+    class FieldGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def template_field_object
+        template(
+          "field_object.rb.erb",
+          "app/fields/#{file_name}_field.rb",
+        )
+      end
+
+      def copy_partials
+        copy_partial(:show)
+        copy_partial(:index)
+        copy_partial(:form)
+      end
+
+      private
+
+      def copy_partial(partial_name)
+        partial = "_#{partial_name}.html.erb"
+
+        copy_file(
+          partial,
+          "app/views/fields/#{file_name}_field/#{partial}",
+        )
+      end
+    end
+  end
+end

data/lib/generators/administrate/field/templates/_form.html.erb

@@ -0,0 +1,6 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.text_field field.attribute %>
+</div>

data/lib/generators/administrate/field/templates/_index.html.erb

@@ -0,0 +1 @@
+<%= field.to_s %>

data/lib/generators/administrate/field/templates/_show.html.erb

@@ -0,0 +1 @@
+<%= field.to_s %>

data/lib/generators/administrate/field/templates/field_object.rb.erb

@@ -0,0 +1,7 @@
+require "administrate/field/base"
+
+class <%= class_name %>Field < Administrate::Field::Base
+  def to_s
+    data
+  end
+end

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

@@ -0,0 +1,49 @@
+require "rails/generators/base"
+require "administrate/generator_helpers"
+require "administrate/namespace"
+
+module Administrate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Administrate::GeneratorHelpers
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :namespace, type: :string, default: "admin"
+
+      def run_routes_generator
+        if dashboard_resources.none?
+          call_generator("administrate:routes", "--namespace", namespace)
+          load Rails.root.join("config/routes.rb")
+        end
+      end
+
+      def create_dashboard_controller
+        template(
+          "application_controller.rb.erb",
+          "app/controllers/#{namespace}/application_controller.rb",
+        )
+      end
+
+      def run_dashboard_generators
+        singular_dashboard_resources.each do |resource|
+          call_generator "administrate:dashboard", resource,
+            "--namespace", namespace
+        end
+      end
+
+      private
+
+      def namespace
+        options[:namespace]
+      end
+
+      def singular_dashboard_resources
+        dashboard_resources.map(&:to_s).map(&:singularize)
+      end
+
+      def dashboard_resources
+        Administrate::Namespace.new(namespace).resources
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# All Administrate controllers inherit from this `Admin::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.
+module <%= namespace.classify %>
+  class ApplicationController < Administrate::ApplicationController
+    before_action :authenticate_admin
+
+    def authenticate_admin
+      # TODO Add authentication logic here.
+    end
+
+    # Override this value to specify the number of elements to display at a time
+    # on index pages. Defaults to 20.
+    # def records_per_page
+    #   params[:per_page] || 20
+    # end
+  end
+end

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

@@ -0,0 +1,91 @@
+Rails.application.eager_load!
+require "rails/generators/base"
+require "administrate/namespace"
+
+module Administrate
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :namespace, type: :string, default: "admin"
+
+      def insert_dashboard_routes
+        if should_route_dashboard?
+          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."
+        end
+
+        unnamed_constants.each do |invalid_model|
+          puts "NOTICE: Skipping dynamically generated model #{invalid_model}."
+        end
+      end
+
+      private
+
+      def namespace
+        options[:namespace]
+      end
+
+      def dashboard_resources
+        valid_dashboard_models.map do |model|
+          model.to_s.pluralize.underscore
+        end
+      end
+
+      def valid_dashboard_models
+        database_models - invalid_database_models
+      end
+
+      def database_models
+        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+      end
+
+      def invalid_database_models
+        models_without_tables + namespaced_models + unnamed_constants
+      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
+
+      def dashboard_routes
+        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/routes/templates/routes.rb.erb

@@ -0,0 +1,5 @@
+namespace :<%= namespace %> do
+<% dashboard_resources.each do |resource| %>    resources :<%= resource %>
+<%end%>
+    root to: "<%= dashboard_resources.first %>#index"
+  end

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

@@ -0,0 +1,16 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class EditGenerator < Administrate::ViewGenerator
+        source_root template_source_path
+
+        def copy_edit
+          copy_resource_template("edit")
+          copy_resource_template("_form")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class FieldGenerator < Administrate::ViewGenerator
+        def self.template_source_path
+          File.expand_path(
+            "../../../../../app/views/fields/",
+            __FILE__,
+          )
+        end
+
+        source_root template_source_path
+
+        def copy_partials
+          resource_path = args.first.try(:underscore)
+
+          if resource_path == "all"
+            entries = Dir.entries(self.class.template_source_path)
+            field_types = entries.reject { |name| name[0] == "." }
+
+            field_types.each do |field_type|
+              copy_field_partials(field_type)
+            end
+          else
+            copy_field_partials(resource_path)
+          end
+        end
+
+        private
+
+        def copy_field_partials(resource_path)
+          copy_field_partial(resource_path, :index)
+          copy_field_partial(resource_path, :show)
+          copy_field_partial(resource_path, :form)
+        end
+
+        def copy_field_partial(resource_path, partial_name)
+          template_file = "#{resource_path}/_#{partial_name}.html.erb"
+
+          copy_file(
+            template_file,
+            "app/views/fields/#{template_file}",
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class FormGenerator < Administrate::ViewGenerator
+        source_root template_source_path
+
+        def copy_form
+          copy_resource_template("_form")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class IndexGenerator < Administrate::ViewGenerator
+        source_root template_source_path
+
+        def copy_template
+          copy_resource_template("index")
+          copy_resource_template("_collection")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class LayoutGenerator < Administrate::ViewGenerator
+        source_root template_source_path
+
+        def copy_template
+          copy_file(
+            "../../layouts/administrate/application.html.erb",
+            "app/views/layouts/admin/application.html.erb",
+          )
+
+          call_generator("administrate:views:navigation")
+          copy_resource_template("_stylesheet")
+          copy_resource_template("_javascript")
+          copy_resource_template("_flashes")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require "administrate/view_generator"
+
+module Administrate
+  module Generators
+    module Views
+      class NavigationGenerator < Administrate::ViewGenerator
+        source_root template_source_path
+
+        def copy_navigation
+          copy_resource_template("_navigation")
+        end
+      end
+    end
+  end
+end