administrate 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab74a9176bf14060fc26e4346b4fca17b2672371
-  data.tar.gz: 990b4f062e37a68c7be97ee5104323d00e99a4ad
+  metadata.gz: f99e940d39ae750c539424f5430bd5f07c1d33a5
+  data.tar.gz: 8d9917e0b8332333309afdefe113cac7c3b0caee
 SHA512:
-  metadata.gz: 4f04b6bea3d168597600b14b390ec6ea6bc14836cf3236b34a0982b4067468c161b8014f253e8d4ca7ccac898aaac8ca9093dcf7143cc32aa51b8f6d54834c98
-  data.tar.gz: ec346e46a0ed10bbd38d14f5bffc2859fd8047467a1be90360a9b8fdc3dc8d7ebc67aa7472d9537c99527e7fd10960806a58502b88d7f6e4fddcb86e529adc72
+  metadata.gz: 32889166105790ee128bef195cba90618686b5a00d90a0c48195faa46d4b580c48032ce48145cf713348029048a288f51018cce289fa16402c43b0d89286fc49
+  data.tar.gz: 4abd94bd39f09afb5b0054338b076e0f144f2d4b27473a2051d0a03c37fe4de7ca97b55d4c8b0ce80471900fe08ef3db8b2bce802a51a4298b6695373072d313

data/app/assets/javascripts/administrate/components/table.js

@@ -11,7 +11,8 @@ $(function() {
       }
 
       var dataUrl = $(event.target).closest("tr").data("url");
-      if (dataUrl) {
+      var selection = window.getSelection().toString();
+      if (selection.length === 0 && dataUrl) {
         window.location = dataUrl;
       }
     }

data/app/assets/stylesheets/administrate/application.scss

@@ -7,6 +7,25 @@
 @import "selectize";
 @import "datetime_picker";
 
-@import "library/**/*";
-@import "base/**/*";
-@import "components/**/*";
+@import "library/data-label";
+@import "library/variables";
+
+@import "base/forms";
+@import "base/layout";
+@import "base/lists";
+@import "base/tables";
+@import "base/typography";
+
+@import "components/app-container";
+@import "components/attributes";
+@import "components/buttons";
+@import "components/cells";
+@import "components/field-unit";
+@import "components/flashes";
+@import "components/form-actions";
+@import "components/header";
+@import "components/main-content";
+@import "components/pagination";
+@import "components/search";
+@import "components/sidebar";
+@import "components/table";

data/app/controllers/administrate/application_controller.rb

@@ -5,6 +5,7 @@ module Administrate
     def index
       search_term = params[:search].to_s.strip
       resources = Administrate::Search.new(resource_resolver, search_term).run
+      resources = resources.includes(*resource_includes) if resource_includes.any?
       resources = order.apply(resources)
       resources = resources.page(params[:page]).per(records_per_page)
       page = Administrate::Page::Collection.new(dashboard, order: order)
@@ -73,11 +74,7 @@ module Administrate
 
     helper_method :nav_link_state
     def nav_link_state(resource)
-      if resource_name.to_s.pluralize == resource.to_s
-        :active
-      else
-        :inactive
-      end
+      resource_name.to_s.pluralize == resource.to_s ? :active : :inactive
     end
 
     helper_method :valid_action?
@@ -111,6 +108,10 @@ module Administrate
       resource_class.find(param)
     end
 
+    def resource_includes
+      dashboard.association_includes
+    end
+
     def resource_params
       params.require(resource_name).permit(dashboard.permitted_attributes)
     end

data/app/views/administrate/application/_sidebar.html.erb

@@ -12,7 +12,7 @@ as defined by the routes in the `admin/` namespace
     <li>
       <%= link_to(
         display_resource_name(resource),
-        [namespace, resource],
+        [namespace, resource.path],
         class: "sidebar__link sidebar__link--#{nav_link_state(resource)}"
       ) %>
     </li>

data/app/views/administrate/application/index.html.erb

@@ -38,7 +38,7 @@ It renders the `_table` partial to display details about the resources.
   <div class="header__actions">
     <%= link_to(
       "#{t("administrate.actions.new")} #{page.resource_name.titleize.downcase}",
-      [:new, namespace, page.resource_name],
+      [:new, namespace, page.resource_path],
       class: "button",
     ) if valid_action? :new %>
   </div>

data/config/locales/administrate.ja.yml

@@ -6,8 +6,8 @@ ja:
       destroy: 削除
       edit: 編集
       show: 参照
-      new: 目新しい
-      back: バック
+      new: 新規
+      back: 戻る
     controller:
       create:
         success: "%{resource}を作成しました。"

data/config/locales/administrate.pl.yml

@@ -7,7 +7,7 @@ pl:
       edit: Edytuj
       show: Wyświetl
       new: Nowy
-      back: Plecy
+      back: Wstecz
     controller:
       create:
         success: "Zasób %{resource} został pomyślnie utworzony."

data/config/locales/administrate.uk.yml

@@ -6,15 +6,15 @@ uk:
       destroy: Видалити
       edit: Редагувати
       show: Показати
-      new: новий
-      back: назад
+      new: Новий
+      back: Назад
     controller:
       create:
-        success: "%{resource} було успішно створено."
+        success: "Успішно створено %{resource}."
       destroy:
-        success: "%{resource} було успішно видалено."
+        success: "Успішно видалено %{resource}."
       update:
-        success: "%{resource} було успішно оновлено."
+        success: "Успішно оновлено %{resource}."
     fields:
       has_many:
         more: "%{count} із %{total_count}"

data/config/locales/administrate.zh-TW.yml

@@ -6,8 +6,8 @@ zh-TW:
       destroy: 刪除
       edit: 編輯
       show: 檢視
-      new: 删除
-      back: 背部
+      new: 新增
+      back: 返回
     controller:
       create:
         success: "已成功新增 %{resource}。"

data/docs/authentication.md

@@ -1,7 +1,8 @@
 # Authenticating admin users
 
 Authentication is left for you to implement after you install Administrate into
-your app. You can easily plugin your existing authentication system.
+your app. It's expected that you can plugin your existing authentication
+system.
 
 The base `Admin::ApplicationController` has a `TODO` to be completed:
 

data/docs/customizing_controller_actions.md

@@ -3,7 +3,7 @@
 When you install Administrate into your app,
 we generate empty controllers for each of your resources.
 If you want to create more complex application behavior for a dashboard,
-simply overwrite controller actions.
+you can overwrite controller actions.
 
 The generated controller will look something like:
 

data/docs/customizing_dashboards.md

@@ -74,12 +74,18 @@ which are specified through the `.with_options` class method:
 `:limit` - Set the number of resources to display in the show view. Default is
 `5`.
 
+`:sort_by` - What to sort the association by in the show view.
+
+`:direction` - What direction the sort should be in, `:asc` (default) or `:desc`.
+
 **Field::Number**
 
 `:decimals` - Set the number of decimals to display. Defaults to `0`.
 
 `:prefix` - Prefixes the number with a string. Defaults to `""`.
 
+`:suffix` - Suffixes the number with a string. Defaults to `""`.
+
 For example, you might use the following to display U.S. currency:
 
 ```ruby
@@ -89,6 +95,15 @@ For example, you might use the following to display U.S. currency:
   )
 ```
 
+Or, to display a distance in kilometers:
+
+```ruby
+  unit_price: Field::Number.with_options(
+    suffix: " km",
+    decimals: 2,
+  )
+```
+
 **Field::Select**
 
 `:collection` - Specify the array or range to select from.  Defaults to `[]`.

data/docs/getting_started.md

@@ -42,7 +42,7 @@ visit <http://localhost:3000/admin> to see your new dashboard in action.
 
 ## Create Additional Dashboards
 
-In order to create additional dashboards, pass in the resource name to 
+In order to create additional dashboards, pass in the resource name to
 the dashboard generator. A dashboard and controller will be created.
 
 ```bash
@@ -58,3 +58,19 @@ namespace :admin do
   resources :foos
 end
 ```
+
+## Rails API
+
+Since Rails 5.0, we've been able to have API only applications. Yet, sometimes
+we still want to have an admin. To get this working, please update this config:
+
+```ruby
+# config/application.rb
+config.api_only = false
+```
+
+That means, when your app _boots_, we'll have access to flashes and such. We
+also don't use your `ApplicationController`. Instead, Administrate provides its
+own. Meaning you're free to specify `ActionController::API` as your parent
+controller to make sure no flash, session, or cookie middleware is used by your
+API.

data/lib/administrate/base_dashboard.rb

@@ -52,6 +52,17 @@ module Administrate
       "#{resource.class} ##{resource.id}"
     end
 
+    def association_includes
+      association_classes = [Field::HasMany, Field::HasOne, Field::BelongsTo]
+
+      collection_attributes.map do |key|
+        field = self.class::ATTRIBUTE_TYPES[key]
+
+        next key if association_classes.include?(field)
+        key if association_classes.include?(field.try :deferred_class)
+      end.compact
+    end
+
     private
 
     def attribute_not_found_message(attr)

data/lib/administrate/engine.rb

@@ -16,6 +16,7 @@ require "administrate/order"
 require "administrate/resource_resolver"
 require "administrate/search"
 require "administrate/namespace"
+require "administrate/namespace/resource"
 
 module Administrate
   class Engine < ::Rails::Engine
@@ -24,7 +25,12 @@ module Administrate
     @@javascripts = []
     @@stylesheets = []
 
-    Engine.config.assets.precompile << /\.(?:svg)\z/
+    Engine.config.assets.precompile << %w(
+      administrate/cancel.svg
+      administrate/dropdown.svg
+      administrate/search.svg
+      administrate/sort_arrow.svg
+    )
 
     def self.add_javascript(script)
       @@javascripts << script

data/lib/administrate/field/has_many.rb

@@ -1,5 +1,6 @@
 require_relative "associative"
 require "administrate/page/collection"
+require "administrate/order"
 
 module Administrate
   module Field
@@ -37,7 +38,8 @@ module Administrate
       end
 
       def resources(page = 1)
-        data.page(page).per(limit)
+        resources = order.apply(data).page(page).per(limit)
+        includes.any? ? resources.includes(*includes) : resources
       end
 
       def more_than_limit?
@@ -46,6 +48,10 @@ module Administrate
 
       private
 
+      def includes
+        associated_dashboard.association_includes
+      end
+
       def candidate_resources
         if options.key?(:includes)
           includes = options.fetch(:includes)
@@ -58,6 +64,18 @@ module Administrate
       def display_candidate_resource(resource)
         associated_dashboard.display_resource(resource)
       end
+
+      def order
+        @_order ||= Administrate::Order.new(sort_by, direction)
+      end
+
+      def sort_by
+        options[:sort_by]
+      end
+
+      def direction
+        options[:direction]
+      end
     end
   end
 end

data/lib/administrate/field/number.rb

@@ -4,11 +4,7 @@ module Administrate
   module Field
     class Number < Field::Base
       def to_s
-        if data.nil?
-          "-"
-        else
-          format_string % value
-        end
+        data.nil? ? "-" : format_string % value
       end
 
       private
@@ -26,7 +22,9 @@ module Administrate
       end
 
       def decimals
-        options.fetch(:decimals, 0)
+        _left, right = data.to_s.split(".")
+        default = right.nil? ? 0 : right.size
+        options.fetch(:decimals, default)
       end
 
       def value

data/lib/administrate/namespace.rb

@@ -5,7 +5,9 @@ module Administrate
     end
 
     def resources
-      @resources ||= routes.map(&:first).uniq.map(&:to_sym)
+      @resources ||= routes.map(&:first).uniq.map do |path|
+        Resource.new(namespace, path)
+      end
     end
 
     def routes

data/lib/administrate/namespace/resource.rb

@@ -0,0 +1,28 @@
+module Administrate
+  class Namespace
+    class Resource
+      attr_reader :namespace, :resource
+
+      def initialize(namespace, resource)
+        @namespace = namespace
+        @resource = resource
+      end
+
+      def to_s
+        name.to_s
+      end
+
+      def to_sym
+        name
+      end
+
+      def name
+        resource.to_s.gsub(/^#{namespace}\//, "").to_sym
+      end
+
+      def path
+        name.to_s.gsub("/", "_")
+      end
+    end
+  end
+end

data/lib/administrate/page/base.rb

@@ -11,6 +11,10 @@ module Administrate
           dashboard.class.to_s.scan(/(.+)Dashboard/).first.first.underscore
       end
 
+      def resource_path
+        @resource_path ||= resource_name.gsub("/", "_")
+      end
+
       protected
 
       def attribute_field(dashboard, resource, attribute_name, page)

data/lib/administrate/search.rb

@@ -21,7 +21,12 @@ module Administrate
     delegate :resource_class, to: :resolver
 
     def query
-      search_attributes.map { |attr| "lower(#{attr}) LIKE ?" }.join(" OR ")
+      search_attributes.map do |attr|
+        table_name = ActiveRecord::Base.connection.
+          quote_table_name(resource_class.table_name)
+        attr_name = ActiveRecord::Base.connection.quote_column_name(attr)
+        "lower(#{table_name}.#{attr_name}) LIKE ?"
+      end.join(" OR ")
     end
 
     def search_terms

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "0.5.0".freeze
+  VERSION = "0.6.0".freeze
 end

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

@@ -1,7 +1,7 @@
 module Admin
   class <%= class_name.pluralize %>Controller < Admin::ApplicationController
     # To customize the behavior of this controller,
-    # simply overwrite any of the RESTful actions. For example:
+    # you can overwrite any of the RESTful actions. For example:
     #
     # def index
     #   super

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nick Charlton
@@ -9,8 +9,68 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -123,26 +183,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
@@ -220,11 +260,10 @@ files:
 - app/assets/stylesheets/administrate/components/_search.scss
 - app/assets/stylesheets/administrate/components/_sidebar.scss
 - app/assets/stylesheets/administrate/components/_table.scss
-- app/assets/stylesheets/administrate/library/_data_label.scss
+- app/assets/stylesheets/administrate/library/_data-label.scss
 - app/assets/stylesheets/administrate/library/_variables.scss
 - app/assets/stylesheets/docs.scss
 - app/controllers/administrate/application_controller.rb
-- app/controllers/docs_controller.rb
 - app/helpers/administrate/application_helper.rb
 - app/views/administrate/application/_collection.html.erb
 - app/views/administrate/application/_flashes.html.erb
@@ -271,7 +310,6 @@ files:
 - app/views/fields/text/_index.html.erb
 - app/views/fields/text/_show.html.erb
 - app/views/layouts/administrate/application.html.erb
-- app/views/layouts/docs.html.erb
 - config/i18n-tasks.yml
 - config/locales/administrate.ar.yml
 - config/locales/administrate.da.yml
@@ -321,6 +359,7 @@ files:
 - lib/administrate/field/text.rb
 - lib/administrate/generator_helpers.rb
 - lib/administrate/namespace.rb
+- lib/administrate/namespace/resource.rb
 - lib/administrate/order.rb
 - lib/administrate/page.rb
 - lib/administrate/page/base.rb
@@ -378,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A Rails engine for creating super-flexible admin dashboards

data/app/controllers/docs_controller.rb

@@ -1,9 +0,0 @@
-class DocsController < ApplicationController
-  def index
-    render file: "README"
-  end
-
-  def show
-    render file: "docs/#{params[:page]}"
-  end
-end

data/app/views/layouts/docs.html.erb

@@ -1,40 +0,0 @@
-<html>
-<head>
-  <%= stylesheet_link_tag "docs", media: "all" %>
-  <link href='//fonts.googleapis.com/css?family=Lato|Source+Code+Pro|Fjalla+One' rel='stylesheet' type='text/css'>
-  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/styles/default.min.css">
-</head>
-
-<body>
-  <div class="content">
-    <div class="sidebar">
-      <h1>Administrate</h1>
-
-      <ul class="sidebar-links">
-        <li><a href="/">Home</a></li>
-        <li><a href="https://github.com/thoughtbot/administrate/issues/new">Feedback</a></li>
-      </ul>
-
-      <h3>Documentation</h3>
-
-      <ul class="sidebar-links">
-        <li><a href="/">README</a></li>
-        <li><a href="/getting_started">Getting Started</a></li>
-        <li><a href="/customizing_dashboards">Customizing Dashboards</a></li>
-        <li><a href="/customizing_page_views">Customizing Page Views</a></li>
-        <li><a href="/customizing_attribute_partials">Customizing Attribute Partials</a></li>
-        <li><a href="/adding_custom_field_types">Adding Custom Field Types</a></li>
-        <li><a href="/customizing_controller_actions">Customizing Controller Actions</a></li>
-        <li><a href="/authentication">Authentication</a></li>
-      </ul>
-    </div>
-
-    <div class="main">
-      <%= yield %>
-    </div>
-  </div>
-
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
-  <script>hljs.initHighlightingOnLoad();</script>
-</body>
-</html>