tolaria 1.2.1 → 2.0.0

data/app/helpers/admin/view_helper.rb

@@ -38,11 +38,6 @@ module Admin::ViewHelper
     lookup_context.template_exists?("admin/#{template_path}", [], true)
   end
 
-  # True if Ransack filtering parameters are present
-  def currently_filtering?
-    params[:q].present? && params[:q].is_a?(Hash) && params[:q].keys.reject{|key| key == "s"}.any?
-  end
-
   # Attempt to automatically construct a default text search
   # field name for Ransack from a given model's table settings
   def ransack_text_search_chain(model)
@@ -58,12 +53,14 @@ module Admin::ViewHelper
     return %{Are you sure you want to delete the #{resource.model_name.human.downcase} “#{Tolaria.display_name(resource)}”? This action is not reversible.}
   end
 
+  # Returns the correct value to pass to the `url:` of `form_for`,
+  # based on the current controller.action_name
   def contextual_form_url
     case controller.action_name
-    when "edit", "update"
-      url_for(action:"show", id:@resource.id)
-    when "new", "create"
-      url_for(action:"index")
+    when "edit"
+      url_for(action:"update", id:@resource.id)
+    when "new"
+      url_for(action:"create")
     else
       nil
     end

data/app/views/admin/tolaria_resource/_form_buttons.html.erb

@@ -1,5 +1,5 @@
 <% if @managed_class.allows? :index %>
-  <%= link_to url_for(action:"index", q:params[:q]), class:"button -cancel" do %>
+  <%= link_to url_for(action:"index", q:ransack_params, p:page_param), class:"button -cancel" do %>
     <%= fontawesome_icon :close %>
     Cancel
   <% end %>
@@ -17,5 +17,3 @@
   <%= fontawesome_icon :check %>
   <%= @resource.persisted?? "Save" : "Create" %>
 <% end %>
-
-

data/app/views/admin/tolaria_resource/_index_table.html.erb

@@ -70,6 +70,6 @@
     <p class="pagination-desc"><%= page_entries_info @resources %></p>
   <% end %>
 
-  <%= paginate @resources, theme:"admin", window:2 %>
+  <%= paginate @resources, theme:"admin", window:2, param_name:"p" %>
 
 <% end %>

data/app/views/admin/tolaria_resource/edit.html.erb

@@ -6,19 +6,28 @@
 
 <%= form_for [:admin, @resource], url:contextual_form_url, builder:Admin::FormBuilder, html:{class:"resource-form"}  do |form_builder| %>
 
-  <% if params[:q].present? %>
-    <% params[:q].each do |key, value| %>
+  <% if page_param.present? %>
+
+  <% end %>
+
+  <% if ransack_params.present?  %>
+    <% ransack_params.each do |key, value| %>
+      <% next if value.respond_to?(:keys) %>
       <%= hidden_field_tag "q[#{key}]", value %>
     <% end %>
   <% end %>
 
+  <% if page_param.present? %>
+    <%= hidden_field_tag :p, page_param %>
+  <% end %>
+
   <div class="main-controls">
     <div class="main-controls-left">
       <h1>
         <span class="crumb">
           <%= fontawesome_icon @managed_class.icon %>
           <% if @managed_class.allows? :index %>
-            <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:params[:q]) %>
+            <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params, p:page_param) %>
           <% else %>
             <%= @managed_class.model_name.human.pluralize.titleize %>
           <% end %>

data/app/views/admin/tolaria_resource/index.html.erb

@@ -26,7 +26,7 @@
     <% end %>
 
     <% if @managed_class.allows?(:new) %>
-      <%= link_to url_for(action:"new", q:params[:q]), class:"button -primary" do %>
+      <%= link_to url_for(action:"new", q:ransack_params, p:page_param), class:"button -primary" do %>
         <%= fontawesome_icon :plus %>
         New <%= @managed_class.model_name.human.titleize %>
       <% end %>
@@ -38,6 +38,3 @@
 
 <%= render "admin/tolaria_resource/search_form" %>
 <%= render "admin/tolaria_resource/index_table" %>
-
-
-

data/app/views/admin/tolaria_resource/show.html.erb

@@ -7,7 +7,7 @@
       <span class="crumb">
         <%= fontawesome_icon @managed_class.icon %>
         <% if @managed_class.allows? :index %>
-          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:params[:q]) %>
+          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural, q:ransack_params, p:page_param) %>
         <% else %>
           <%= @managed_class.model_name.human.pluralize.titleize %>
         <% end %>

data/lib/tolaria.rb

@@ -9,12 +9,12 @@ require "kaminari"
 require "ransack"
 
 require "tolaria/version"
+require "tolaria/ransack"
 require "tolaria/engine"
 require "tolaria/config"
 require "tolaria/default_config"
 require "tolaria/random_tokens"
 require "tolaria/admin"
-
 require "tolaria/reload"
 require "tolaria/managed_class"
 require "tolaria/manage"

data/lib/tolaria/engine.rb

@@ -6,7 +6,6 @@ module Tolaria
       app.config.assets.precompile += %w[
         admin/admin.css
         admin/admin.js
-        admin/lib/no.js
         admin/favicon.ico
       ]
     end

data/lib/tolaria/ransack.rb

@@ -0,0 +1,43 @@
+# Until Ransack releases a new gem version, we have to patch in this
+# Rails 5 support from their master branch
+
+module Ransack
+  module Helpers
+    module FormHelper
+
+      def sort_link(search_object, attribute, *args, &block)
+        search, routing_proxy = extract_search_and_routing_proxy(search_object)
+        unless Search === search
+          raise TypeError, 'First argument must be a Ransack::Search!'
+        end
+        args.unshift(capture(&block)) if block_given?
+        s = SortLink.new(search, attribute, args, params, &block)
+        link_to(s.name, url(routing_proxy, s.url_options), s.html_options(args))
+      end
+
+      class SortLink
+
+        def initialize(search, attribute, args, params)
+          @search         = search
+          @params         = parameters_hash(params)
+          @field          = attribute.to_s
+          @sort_fields    = extract_sort_fields_and_mutate_args!(args).compact
+          @current_dir    = existing_sort_direction
+          @label_text     = extract_label_and_mutate_args!(args)
+          @options        = extract_options_and_mutate_args!(args)
+          @hide_indicator = @options.delete(:hide_indicator) || Ransack.options[:hide_sort_order_indicators]
+          @default_order  = @options.delete :default_order
+        end
+
+        private
+
+        def parameters_hash(params)
+          return params unless params.respond_to?(:to_unsafe_h)
+          params.to_unsafe_h
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tolaria/version.rb

@@ -2,7 +2,7 @@ module Tolaria
 
   # Returns Tolaria’s version number
   def self.version
-    Gem::Version.new("1.2.1")
+    Gem::Version.new("2.0.0")
   end
 
   module VERSION

data/test/demo/app/models/application_record.rb

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

data/test/demo/app/models/blog_post.rb

@@ -1,4 +1,4 @@
-class BlogPost < ActiveRecord::Base
+class BlogPost < ApplicationRecord
 
   has_and_belongs_to_many :topics, join_table:"blog_post_topics"
   has_many :footnotes

data/test/demo/app/models/footnote.rb

@@ -1,4 +1,4 @@
-class Footnote < ActiveRecord::Base
+class Footnote < ApplicationRecord
   belongs_to :blog_post
   validates_presence_of :description
   validates_presence_of :url

data/test/demo/app/models/image.rb

@@ -1,4 +1,4 @@
-class Image < ActiveRecord::Base
+class Image < ApplicationRecord
 
   validates_presence_of :title
   validates_presence_of :attachment_address

data/test/demo/app/models/legal_page.rb

@@ -1,4 +1,4 @@
-class LegalPage < ActiveRecord::Base
+class LegalPage < ApplicationRecord
 
   validates_presence_of :title
   validates_presence_of :summary

data/test/demo/app/models/miscellany.rb

@@ -1,12 +1,16 @@
-class Miscellany < ActiveRecord::Base
+class Miscellany < ApplicationRecord
 
   manage_with_tolaria using:{
     icon: "cogs",
     category: "Settings",
-    allowed_actions: [:index, :show, :edit],
+    allowed_actions: [:index, :edit, :update],
     permit_params: [
       :value
     ],
   }
 
+  def to_s
+    key
+  end
+
 end

data/test/demo/app/models/topic.rb

@@ -1,4 +1,4 @@
-class Topic < ActiveRecord::Base
+class Topic < ApplicationRecord
 
   has_and_belongs_to_many :blog_posts, join_table:"blog_post_topics"
 

data/test/demo/app/models/video.rb

@@ -1,4 +1,4 @@
-class Video < ActiveRecord::Base
+class Video < ApplicationRecord
 
   validates_presence_of :title
   validates_presence_of :youtube_id

data/test/demo/app/views/admin/legal_pages/_form.html.erb

@@ -1,5 +1,5 @@
 <%= f.label :title, "Title" %>
-<%= f.text_field :title, placeholder:"Page title" %>
+<%= f.text_field :title, placeholder:"Page title", disabled:true %>
 <%= f.hint "The title of this page." %>
 
 <%= f.label :slug, "URL Slug" %>

data/test/demo/app/views/admin/miscellany/_form.html.erb

@@ -0,0 +1,3 @@
+<%= f.label :value, "Value" %>
+<%= f.text_area :value, rows:3 %>
+<%= f.hint @resource.description %>

data/test/demo/config/application.rb

@@ -18,9 +18,5 @@ module Demo
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
-
   end
 end
-

data/test/demo/config/environments/test.rb

@@ -14,8 +14,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files   = true
-  config.static_cache_control = "public, max-age=3600"
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {"Cache-Control" => "public, max-age=3600"}
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local = true

data/test/demo/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -26,19 +25,17 @@ ActiveRecord::Schema.define(version: 20150610135235) do
     t.integer  "lockout_strikes",                default: 0, null: false
     t.integer  "total_strikes",                  default: 0, null: false
     t.integer  "sessions_created",               default: 0, null: false
+    t.index ["auth_token"], name: "index_administrators_on_auth_token"
+    t.index ["email"], name: "index_administrators_on_email"
   end
 
-  add_index "administrators", ["auth_token"], name: "index_administrators_on_auth_token"
-  add_index "administrators", ["email"], name: "index_administrators_on_email"
-
   create_table "blog_post_topics", force: :cascade do |t|
     t.integer "blog_post_id", null: false
     t.integer "topic_id",     null: false
+    t.index ["blog_post_id"], name: "index_blog_post_topics_on_blog_post_id"
+    t.index ["topic_id"], name: "index_blog_post_topics_on_topic_id"
   end
 
-  add_index "blog_post_topics", ["blog_post_id"], name: "index_blog_post_topics_on_blog_post_id"
-  add_index "blog_post_topics", ["topic_id"], name: "index_blog_post_topics_on_topic_id"
-
   create_table "blog_posts", force: :cascade do |t|
     t.datetime "created_at",   null: false
     t.datetime "updated_at",   null: false
@@ -57,10 +54,9 @@ ActiveRecord::Schema.define(version: 20150610135235) do
     t.integer  "blog_post_id", null: false
     t.text     "description"
     t.text     "url"
+    t.index ["blog_post_id"], name: "index_footnotes_on_blog_post_id"
   end
 
-  add_index "footnotes", ["blog_post_id"], name: "index_footnotes_on_blog_post_id"
-
   create_table "images", force: :cascade do |t|
     t.datetime "created_at",         null: false
     t.datetime "updated_at",         null: false
@@ -78,29 +74,26 @@ ActiveRecord::Schema.define(version: 20150610135235) do
     t.string   "slug",       null: false
     t.text     "summary",    null: false
     t.text     "body"
+    t.index ["slug"], name: "index_legal_pages_on_slug"
   end
 
-  add_index "legal_pages", ["slug"], name: "index_legal_pages_on_slug"
-
   create_table "miscellany", force: :cascade do |t|
     t.datetime "created_at",  null: false
     t.datetime "updated_at",  null: false
     t.string   "key",         null: false
     t.text     "value",       null: false
     t.text     "description", null: false
+    t.index ["key"], name: "index_miscellany_on_key"
   end
 
-  add_index "miscellany", ["key"], name: "index_miscellany_on_key"
-
   create_table "topics", force: :cascade do |t|
     t.datetime "created_at"
     t.datetime "updated_at"
     t.string   "label",      null: false
     t.string   "slug",       null: false
+    t.index ["slug"], name: "index_topics_on_slug"
   end
 
-  add_index "topics", ["slug"], name: "index_topics_on_slug"
-
   create_table "videos", force: :cascade do |t|
     t.datetime "created_at",  null: false
     t.datetime "updated_at",  null: false

data/test/integration/filter_preservation_test.rb

@@ -25,7 +25,7 @@ class FilterPreservationTest < ActionDispatch::IntegrationTest
     find_link("Organization").click
     find_link("Nintendo").click
     first(".button.-cancel").click
-    assert page.current_url.include?("q[s]=organization+asc"), "filter not retained"
+    assert page.current_url.include?("q[s]=organization+asc"), "filter should be retained"
   end
 
   test "after filtering index, should retain filter on edit and save" do
@@ -58,4 +58,3 @@ class FilterPreservationTest < ActionDispatch::IntegrationTest
   end
 
 end
-

data/test/integration/forbidden_routes_test.rb

@@ -92,8 +92,8 @@ class ForbiddenRoutesTest < ActionDispatch::IntegrationTest
     assert page.has_content?("Delete")
     assert page.has_content?("Edit")
 
-    assert_raises ActionView::Template::Error do
-      visit new_admin_card_path
+    assert_raises ActionController::RoutingError do
+      visit "/admin/cards"
     end
 
     # Unseat the Card class so that it doesn't leak out of this test
@@ -102,4 +102,30 @@ class ForbiddenRoutesTest < ActionDispatch::IntegrationTest
 
   end
 
+  test "handles only allowed_actions index, edit, update" do
+
+    # Miscellany only allows index, edit, update
+    Miscellany.create(value:"Tchotchke", key:"tchotchke", description:"Test Tchotchke")
+
+    sign_in_dummy_administrator!
+    visit admin_miscellany_index_path
+    assert page.has_content?("tchotchke"), "should see the Miscellany on the index"
+
+    visit edit_admin_miscellany_path(Miscellany.first.id)
+    assert page.has_content?("Tchotchke"), "can see the Miscellany form"
+    assert page.has_content?("Save"), "can see the Miscellany form"
+
+    assert_raises ActionController::RoutingError do
+      visit "/admin/miscellany/new" # This route shouldn’t exist
+    end
+
+    assert_raises ActionController::RoutingError do
+      visit "/admin/miscellany/1" # This route shouldn’t exist
+    end
+
+    # Remove the test object
+    Miscellany.first.destroy
+
+  end
+
 end

data/test/integration/pagination_test.rb

@@ -0,0 +1,76 @@
+require "test_helper"
+
+class PaginationTest < ActionDispatch::IntegrationTest
+
+  def setup
+    BlogPost.destroy_all
+    50.times do
+      BlogPost.create!({
+        title: SecureRandom.uuid,
+        body: "X",
+        summary: "X",
+        published_at: Time.current,
+      })
+    end
+  end
+
+  def teardown
+    BlogPost.destroy_all
+  end
+
+  test "shows pagination and its usable" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts")
+    assert page.has_content?("Next")
+    assert page.has_content?("Last")
+    assert page.has_content?("3")
+    visit("/admin/blog_posts?p=3")
+    assert page.has_content?("Next")
+    assert page.has_content?("Last")
+    assert page.has_content?("First")
+    assert page.has_content?("Prev")
+  end
+
+  test "after paginating index, should retain page on edit and back with crumb" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".crumb a").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should retain page on edit and back with button" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-cancel").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should retain page on edit and save" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-save").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should retain page on edit and failed validation" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    fill_in("blog_post[title]", with:"")
+    first(".button.-save").click
+    first(".button.-cancel").click
+    assert page.current_url.include?("p=3"), "page should be retained"
+  end
+
+  test "after paginating index, should NOT retain page on save and review" do
+    sign_in_dummy_administrator!
+    visit("/admin/blog_posts?p=3")
+    first(".button.-edit").click # Open the editor form for a random blog post
+    first(".button.-save-and-review").click
+    assert page.current_url.exclude?("p=3"), "page should not have been retained"
+  end
+
+end