tolaria 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6bbe4f07c4384a212775e975ce8eb3ebdc9bac7
-  data.tar.gz: 7c73d1de0b10a9e9b66245132190eea2c1671287
+  metadata.gz: c447de7756733e7206984d95df7b1cc2745b65a8
+  data.tar.gz: 9cafe04bae67cf2248f4a90c5c19e0f684739095
 SHA512:
-  metadata.gz: ef6b210ab9493676b17282ba7f9f15ee1bd072e6f679cda2cfde50fdc7464cc1109ff97d51c7d3486428359869bd1387847cccfa817e9bfed089d093c2fcb6a0
-  data.tar.gz: 17f7e9f64856fcd583071c69da4e5ad02ea6ad411758e06bb69c175b49b0a0f580b0fd81c9f9b8198491879f7196a945677aa4da5bab022525d88104dc773e29
+  metadata.gz: 7cfa153900abd851aea97fc0d79dfb012a35218f448c690a098d495bdf5bdbc4fe26499e16bd27b9a7578e75e07f3a1613ac0ba71447bbcfe2b8ef77f04e877d
+  data.tar.gz: 8c6ca85bfd80d7544dfb3b5d3623147c6a29c0e161963823f2392c42f7f82060ee62a76bca94f214d84f86ba591095e2d9815a532b8e5ed9b53d134a384e87f6

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+script: "rake test"

data/README.md

@@ -1,5 +1,7 @@
 ## Tolaria
 
+[![Build Status](https://travis-ci.org/Threespot/tolaria.svg?branch=master)](https://travis-ci.org/Threespot/tolaria)
+
 Tolaria is a [content management system](https://en.wikipedia.org/wiki/Content_management_system) (CMS) framework for [Ruby on Rails](https://en.wikipedia.org/wiki/Ruby_on_Rails). It greatly speeds up the necessary—but repetitive—task of creating useful admin panels, forms, and model workflows for site authors.
 
 [![](https://cloud.githubusercontent.com/assets/769083/8262095/ccb2b68e-169d-11e5-9378-0d098eb22c22.png)](https://cloud.githubusercontent.com/assets/769083/7573791/56eda172-f7f6-11e4-8df7-36015cf5cf85.png)
@@ -99,7 +101,7 @@ You can configure Tolaria's passcode paranoia in the initializer you installed a
 
 ### Managing a Model
 
-Inside your ActiveRecord definition for your model, call `manage_with_tolaria`, passing configuration in the `using` Hash. [Refer to the documentation for all of the options](#FIXME).
+Inside your ActiveRecord definition for your model, call `manage_with_tolaria`, passing configuration in the `using` Hash. [Refer to the documentation for all of the options](http://www.rubydoc.info/gems/tolaria/ActiveRecord%2FBase.manage_with_tolaria).
 
 The icon system uses [Font Awesome][fa], and you'll need to pass one of [the icon names][fa] for the `icon` key.
 
@@ -128,7 +130,7 @@ By default, Tolaria will build a simple index screen for each model. You'll like
 
 If your model was `BlogPost`, you'll need to create a file in your project at: `app/views/admin/blog_posts/_index.html.erb`.
 
-See the [TableHelper documentation](#FIXME) for more information.
+See the [TableHelper documentation](http://www.rubydoc.info/gems/tolaria/Admin/TableHelper) for more information.
 
 ```erb
 <% # app/views/admin/blog_posts/_index.html.erb %>
@@ -161,7 +163,7 @@ Tolaria provides a very basic show/inspect screen for models. You'll want to pro
 
 If your model was `BlogPost`, you'll need to create a file in your project at: `app/views/admin/blog_posts/_show.html.erb`.
 
-See the [TableHelper documentation](#FIXME) for more information.
+See the [TableHelper documentation](http://www.rubydoc.info/gems/tolaria/Admin/TableHelper) for more information.
 
 ```erb
 <% # app/views/admin/blog_posts/_show.html.erb %>
@@ -274,11 +276,11 @@ If your model was `BlogPost`, you'll need to create a file in your project at  `
 
 ### Provided Form Fields
 
-You can use all of the Rails-provided fields on your forms, but Tolaria also comes with a set of advanced, JavaScript-backed fields. Make sure to [review the documentation for the form builder](#FIXME) to get all the details.
+You can use all of the Rails-provided fields on your forms, but Tolaria also comes with a set of advanced, JavaScript-backed fields. Make sure to [review the documentation for the form builder](http://www.rubydoc.info/gems/tolaria/Admin/FormBuilder) to get all the details.
 
 #### Markdown Composer
 
-The [`markdown_composer` helper](#FIXME) will generate a very fancy Markdown editor, which includes text snippet tools and a fullscreen mode with live previewing.
+The [`markdown_composer` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Amarkdown_composer) will generate a very fancy Markdown editor, which includes text snippet tools and a fullscreen mode with live previewing.
 
 **Important:** You cannot use this field properly if you do not set up `Tolaria.config.markdown_renderer`. Without it, the live preview will only use `simple_format`!
 
@@ -292,7 +294,7 @@ The [`markdown_composer` helper](#FIXME) will generate a very fancy Markdown edi
 
 #### Searchable Select
 
-The [`searchable_select` helper](#FIXME) displays a [Chosen select field](http://harvesthq.github.io/chosen/) that authors can filter by typing.
+The [`searchable_select` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Asearchable_select) displays a [Chosen select field](http://harvesthq.github.io/chosen/) that authors can filter by typing.
 
 ```
 <%= f.label :title, "Topics" %>
@@ -304,7 +306,7 @@ The [`searchable_select` helper](#FIXME) displays a [Chosen select field](http:/
 
 #### Image Association Select
 
-The [`image_association_select` helper](#FIXME) displays a `searchable_select` that provides an instant preview of the currently selected model as an image.
+The [`image_association_select` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Aimage_association_select) displays a `searchable_select` that provides an instant preview of the currently selected model as an image.
 
 ```erb
 <%= f.label :featured_image_id, "Featured Image" %>
@@ -316,7 +318,7 @@ The [`image_association_select` helper](#FIXME) displays a `searchable_select` t
 
 #### Timestamp Field
 
-The [`timestamp_field` helper](#FIXME) displays a text field that validates a provided timestamp and recovers to a template if blanked.
+The [`timestamp_field` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Atimestamp_field) displays a text field that validates a provided timestamp and recovers to a template if blanked.
 
 ```erb
 <%= f.label :published_at, "Publishing Date" %>
@@ -328,7 +330,7 @@ The [`timestamp_field` helper](#FIXME) displays a text field that validates a pr
 
 #### Slug Field
 
-The [`slug_field` helper](#FIXME) allows you to show the parameterized value of a field in a given pattern preview.
+The [`slug_field` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Aslug_field) allows you to show the parameterized value of a field in a given pattern preview.
 
 ```erb
 <%= f.label :title %>
@@ -340,7 +342,7 @@ The [`slug_field` helper](#FIXME) allows you to show the parameterized value of
 
 #### Swatch Field
 
-The [`swatch_field` helper](#FIXME) validates and displays a given hexadecimal color.
+The [`swatch_field` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Aswatch_field) validates and displays a given hexadecimal color.
 
 ```erb
 <%= f.label :color %>
@@ -352,7 +354,7 @@ The [`swatch_field` helper](#FIXME) validates and displays a given hexadecimal c
 
 #### Image Field
 
-The [`image_field` helper](#FIXME) displays a button that makes uploading an image a little more pleasant than a regular `file_field`.
+The [`image_field` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Aimage_field) displays a button that makes uploading an image a little more pleasant than a regular `file_field`.
 
 ```erb
 <%= f.label :portrait %>
@@ -364,7 +366,7 @@ The [`image_field` helper](#FIXME) displays a button that makes uploading an ima
 
 #### Attachment Field
 
-The [`attachment_field` helper](#FIXME) displays a button that makes uploading an arbirary file a little more pleasant than a regular `file_field`.
+The [`attachment_field` helper](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Aattachment_field) displays a button that makes uploading an arbirary file a little more pleasant than a regular `file_field`.
 
 ```erb
 <%= f.label :portrait %>
@@ -392,7 +394,7 @@ If you need to run two or more `select` controls together (like for `date_select
 
 #### Hints
 
-[Inline help](#FIXME) is useful for reminding administrators about what should be provided for each field. Use `f.hint` to present a hint for a field.
+[Inline help](http://www.rubydoc.info/gems/tolaria/Tolaria%2FFormBuildable%3Ahint) is useful for reminding administrators about what should be provided for each field. Use `f.hint` to present a hint for a field.
 
 ![hint](https://cloud.githubusercontent.com/assets/769083/7888576/8d20f8a6-0607-11e5-80ea-2c8f66ad7449.png)
 
@@ -489,7 +491,7 @@ If you want to add additional Sass or JavaScript to the admin system, you can cr
 
 Tolaria comes with a test suite and a demo server that the test suite exercises.
 
-To run tests, first clone the repo:
+To run tests, first clone the repo or your fork of it:
 
 ```shell
 $ git clone -o github git@github.com:threespot/tolaria.git
@@ -530,6 +532,7 @@ Our work stands on the shoulders of giants, and we're very thankful to the many
 - [The jQuery Foundation](https://jquery.org)
 - [Jeremy Ashkenas](https://twitter.com/jashkenas)
 - [The Harvest Team](https://www.getharvest.com/about/meet-the-team)
+- [Font Awesome and Dave Gandy](http://fontawesome.io/icons/)
 
 ### About Threespot
 

data/app/assets/stylesheets/admin/components/forms/_nested_fields.scss

@@ -1,5 +1,7 @@
 .has-many {
 
+  margin: 0 0 16px;
+
   h3 {
     @include clearfix;
     display: block;

data/app/controllers/tolaria/resource_controller.rb

@@ -33,7 +33,7 @@ class Tolaria::ResourceController < Tolaria::TolariaController
 
     if @resource.save
       flash[:success] = "#{random_blingword} You created the #{@managed_class.model_name.human} “#{display_name}”."
-      return redirect_to url_for([:admin, @managed_class.klass])
+      return redirect_to form_completion_redirect_path(@managed_class, @resource)
     else
       log_validation_errors!
       flash.now[:error] = "Your changes couldn’t be saved. Please correct the following errors:"
@@ -55,7 +55,7 @@ class Tolaria::ResourceController < Tolaria::TolariaController
 
     if @resource.save
       flash[:success] = "#{random_blingword} You updated the #{@managed_class.model_name.human.downcase} “#{display_name}”."
-      return redirect_to url_for([:admin, @managed_class.klass])
+      return redirect_to form_completion_redirect_path(@managed_class, @resource)
     else
       log_validation_errors!
       flash.now[:error] = "Your changes couldn’t be saved. Please correct the following errors:"
@@ -73,11 +73,11 @@ class Tolaria::ResourceController < Tolaria::TolariaController
       @resource.destroy
     rescue ActiveRecord::DeleteRestrictionError => e
       flash[:restricted] = "You cannot delete “#{display_name}” because other items are using it."
-      return redirect_to url_for([:admin, @managed_class.klass])
+      return redirect_to form_completion_redirect_path(@managed_class, @resource)
     end
 
     flash[:destructive] = "You deleted the #{@managed_class.model_name.human.downcase} “#{display_name}”."
-    return redirect_to url_for([:admin, @managed_class.klass])
+    return redirect_to form_completion_redirect_path(@managed_class)
 
   end
 
@@ -89,6 +89,20 @@ class Tolaria::ResourceController < Tolaria::TolariaController
     ["Done!", "Okay!", "Success!"].sample
   end
 
+  # Returns a path we should redirect to when the form is completed successfully.
+  # Handles route forbidding cases.
+  def form_completion_redirect_path(managed_class, resource = nil)
+    if managed_class.allows? :index
+      url_for([:admin, managed_class.klass])
+    elsif managed_class.allows?(:show) && resource.present?
+      url_for(action:"show", id:resource.id)
+    elsif managed_class.allows?(:edit) && resource.present?
+      url_for(action:"edit", id:resource.id)
+    else
+      Tolaria.config.defaut_redirect
+    end
+  end
+
   # Load the Tolaria managed class for this controller
   def load_managed_class!
     @managed_class ||= Tolaria.managed_classes.find do |managed_class|

data/app/helpers/admin/table_helper.rb

@@ -1,7 +1,7 @@
 module Admin::TableHelper
 
   # Returns a `<table class="index-table">` tag with the appropriate wrapper
-  # and the given +content+ or block content inside it.
+  # and the given `content` or block content inside it.
   def index_table(content = nil, &block)
     content_tag :div, class:"index-table-wrap" do
       content_tag :table, class:"index-table" do
@@ -10,7 +10,7 @@ module Admin::TableHelper
     end
   end
 
-  # Returns a `<table class="show-table">` tag with the given +content+
+  # Returns a `<table class="show-table">` tag with the given `content`
   # or block content inside it.
   def show_table(content = nil, &block)
     content_tag :table, class:"show-table" do
@@ -29,20 +29,19 @@ module Admin::TableHelper
   end
 
   # Returns a `<tr>` with two `<td>`s suitable for use in a `table.show-table`.
-  # The given +label+ is placed inside the first `<td>`, while the +value+
+  # The given `label` is placed inside the first `<td>`, while the `value`
   # is placed in the second `<td>`. Options are forwarded to `content_tag`
   # for the *second* `<td>`.
   #
-  # If +label+ is a symbol, it is assumed to be a method on a variable named
+  # If `label` is a symbol, it is assumed to be a method on a variable named
   # `@resource` in the current template, and the `<tr>` is constructed
   # automatically for you by converting the symbol to a human-readable label
-  # and calling the named method on @resource to get the +value+.
+  # and calling the named method on @resource to get the `value`.
   #
-  # ==== Signatures
+  # #### Signatures
   #
   #     # Set the values yourself, and a class on the second `<td>`
   #     show_tr "Slug", resource.slug, class:"monospace"
-  #
   #     # Attempt to auto-fill the row based on a method name
   #     show_tr :slug
   def show_tr(label, value = nil, options = nil)
@@ -70,22 +69,20 @@ module Admin::TableHelper
   end
 
   # Returns a `<th>` tag, suitable for use inside a `table.index-table`.
-  # +field_or_label+ may be any string, or a symbol naming a model column.
-  # +sort+ may be `true`, `false`, or a symbol. See the signtures below.
+  # `field_or_label` may be any string, or a symbol naming a model column.
+  # `sort` may be `true`, `false`, or a symbol. See the signtures below.
   #
   # If the column is sortable, the `<th>` will contain a Ransack sort link
   # that allows the end-user to organize the table by that column.
   #
-  # ==== Signatures
-  #
-  #    # Create a header that sorts a named column
-  #    index_th(:title, sort:true)
-  #
-  #    # Create a header that sorts a column, with custom label
-  #    index_th("Strange Title", sort: :title)
+  # #### Signatures
   #
-  #    # Create a header that can't be sorted
-  #    index_th("Strange Title", sort:false)
+  #     # Create a header that sorts a named column
+  #     index_th(:title, sort:true)
+  #     # Create a header that sorts a column, with custom label
+  #     index_th("Strange Title", sort: :title)
+  #     # Create a header that can't be sorted
+  #     index_th("Strange Title", sort:false)
   def index_th(field_or_label, sort:true)
 
     case field_or_label
@@ -110,9 +107,9 @@ module Admin::TableHelper
   end
 
   # Returns a `<td>` tag, suitable for use inside a `table.index-table`.
-  # If +method_or_content+ is a symbol, it will call that method on the
-  # given +resource+ to obtain the content of the `<td>`. Otherwise
-  # it expects +method_or_content+ or a passed block to provide suitable string.
+  # If `method_or_content` is a symbol, it will call that method on the
+  # given `resource` to obtain the content of the `<td>`. Otherwise
+  # it expects `method_or_content` or a passed block to provide suitable string.
   #
   # #### Special Options
   #
@@ -139,8 +136,16 @@ module Admin::TableHelper
       image = image_tag(image, size:"18x18", alt:"")
     end
 
+    if @managed_class.allows? :edit
+      link = url_for(action:"edit", id:resource.id)
+    elsif @managed_class.allows? :show
+      link = url_for(action:"show", id:resource.id)
+    else
+      link = "#" # Guh, painted ourseves into a corner here
+    end
+
     return content_tag(:td, options) do
-      link_to("#{image}#{content}".html_safe, url_for(action:"edit", id:resource.id))
+      link_to("#{image}#{content}".html_safe, link)
     end
 
   end
@@ -151,7 +156,7 @@ module Admin::TableHelper
   end
 
   # Returns a `<td>` tag, suitable for use inside a `table.index-table`.
-  # The tag contains buttons to edit, inspect, and delete the given +resource+.
+  # The tag contains buttons to edit, inspect, and delete the given `resource`.
   def actions_td(resource)
 
     links = []

data/app/helpers/admin/view_helper.rb

@@ -17,7 +17,8 @@ module Admin::ViewHelper
     end
   end
 
-  # Returns an `<i>` tag that displays a Font Awesome icon
+  # Returns an `<i>` tag that displays the Font Awesome icon for the given `icon`.
+  # Names much match those from [the Font Awesome site](http://fontawesome.io/icons/).
   def fontawesome_icon(icon = "", options = {})
     icon = icon.to_s.parameterize.tr("_", "-")
     content_tag :i, nil, options.reverse_merge({
@@ -32,7 +33,7 @@ module Admin::ViewHelper
     return "https://secure.gravatar.com/avatar/#{digest}?d=retro&s=36"
   end
 
-  # Returns true if a partial is available at "admin/#{template_path}"
+  # Returns true if a partial is available at `"admin/#{template_path}"`
   def admin_template_exists?(template_path)
     lookup_context.template_exists?("admin/#{template_path}", [], true)
   end
@@ -57,9 +58,9 @@ 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 a `<span>` tag that displays the given +label+ as a pill
+  # Returns a `<span>` tag that displays the given `label` as a pill
   # status badge. You can change the color of the pill by providing a
-  # six-digit hexadecimal +color+, or passing one of the predefined
+  # six-digit hexadecimal `color` string, or passing one of the predefined
   # color names: `:green`, `:red`, `:blue`, `:black`, `:grey`.
   def pill(label, color: :black)
 

data/app/models/administrator.rb

@@ -37,8 +37,8 @@ class Administrator < ActiveRecord::Base
   # and passcode inside the time window
   # -----------------------------------------------------------------------------
 
-  # Initialize +passcode+, +passcode_expires_at+,
-  # +auth_token+, and +account_unlocks_at+ for a new admin.
+  # Initialize `passcode`, `passcode_expires_at`,
+  # `auth_token`, and `account_unlocks_at` for a new admin.
   # To prevent passcode system fields from being null,
   # we fill them with an immediately expired passcode.
   def initialize_authentication!
@@ -66,7 +66,7 @@ class Administrator < ActiveRecord::Base
     return plaintext_passcode
   end
 
-  # Attempt to authenticate the account with the given plaintext +passcode+.
+  # Attempt to authenticate the account with the given plaintext `passcode`.
   # Returns true if the passcode was valid, false otherwise.
   def authenticate!(passcode)
 

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

@@ -1,6 +1,8 @@
-<%= link_to url_for([:admin, @managed_class.klass]), class:"button" do %>
-  <%= fontawesome_icon :close %>
-  Cancel
+<% if @managed_class.allows? :index %>
+  <%= link_to url_for([:admin, @managed_class.klass]), class:"button" do %>
+    <%= fontawesome_icon :close %>
+    Cancel
+  <% end %>
 <% end %>
 
 <%= button_tag type:"submit", name:nil, class:"button -primary" do %>

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

@@ -11,7 +11,11 @@
       <h1>
         <span class="crumb">
           <%= fontawesome_icon @managed_class.icon %>
-          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural) %>
+          <% if @managed_class.allows? :index %>
+            <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural) %>
+          <% else %>
+            <%= @managed_class.model_name.human.pluralize.titleize %>
+          <% end %>
         </span>
         <%= content_for :title %>
       </h1>

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

@@ -6,7 +6,11 @@
     <h1>
       <span class="crumb">
         <%= fontawesome_icon @managed_class.icon %>
-        <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural) %>
+        <% if @managed_class.allows? :index %>
+          <%= link_to @managed_class.model_name.human.pluralize.titleize, url_for(action:"index", controller:@managed_class.plural) %>
+        <% else %>
+          <%= @managed_class.model_name.human.pluralize.titleize %>
+        <% end %>
       </span>
       <%= content_for :title %>
     </h1>

data/lib/tolaria.rb

@@ -21,7 +21,7 @@ require "tolaria/manage"
 require "tolaria/active_record"
 require "tolaria/help_links"
 require "tolaria/routes"
-require "tolaria/introspection"
+require "tolaria/display_name"
 require "tolaria/categories"
 require "tolaria/markdown"
 require "tolaria/form_buildable"

data/lib/tolaria/active_record.rb

@@ -1,12 +1,12 @@
 # Adds a new DSL method to ActiveRecord model definition, allowing the
 # developer to configure a model to manage with Tolaria.
 # The developer passes a hash of configuration options which are
-# forwarded as keyword arguments to Tolaria.manage
+# forwarded as keyword arguments to `Tolaria.manage`.
 
 class ActiveRecord::Base
 
   # Register a model with Tolaria and allow administrators to manage it
-  # in the admin interface. Accepts one named parameter, +using+
+  # in the admin interface. Accepts one named parameter, `using`
   # which should be a Hash of options below.
   #
   # #### Options
@@ -18,8 +18,7 @@ class ActiveRecord::Base
   #   Items with lower priority are sorted first.
   #   The default is 10.
   # - `:icon` - The Font Awesome icon to use for this model.
-  #   Should be one of the names on the Font Awesome site at
-  #   http://fortawesome.github.io/Font-Awesome/icons/
+  #   Should be one of the names on [the Font Awesome site](http://fortawesome.github.io/Font-Awesome/icons/)
   #   The default is `"file-o"`.
   # - `:permitted_params` - A array of parameter names to pass to
   #   `params.permit()` for this model/form.
@@ -37,6 +36,22 @@ class ActiveRecord::Base
   #   Tolaria will pass this array as the `only:` option to the router.
   #   The default includes all CRUD actions:
   #   `[:index, :show, :new, :create, :edit, :update, :destroy]`
+  #
+  # #### Example
+  #
+  #     class BlogPost < ActiveRecord::Base
+  #       manage_with_tolaria using: {
+  #         icon: "file-o",
+  #         category: "Settings",
+  #         priority: 5,
+  #         permit_params: [
+  #           :title,
+  #           :body,
+  #           :author_id,
+  #         ]
+  #       }
+  #     end
+
   def self.manage_with_tolaria(using:{})
     @tolaria_management_options = using
     if Tolaria.safe_management

data/lib/tolaria/categories.rb

@@ -7,8 +7,8 @@ module Tolaria
     (self.config.menu_categories + self.managed_classes.collect(&:category)).uniq
   end
 
-  # Returns all of the managed classes for the given +category+,
-  # sorted by their priority
+  # Returns all of the managed classes for the given `category`,
+  # sorted by their priority.
   def self.classes_for_category(category)
     classes = Tolaria.managed_classes.select do |managed_class|
       managed_class.category == category

data/lib/tolaria/config.rb

@@ -1,20 +1,35 @@
 module Tolaria
 
-  # Tolaria’s config is a class so that an exception is raised
-  # if you try to configure a key that doesn't exist. See default_config.rb
+  # Tolaria’s configuration is a class so that an exception is raised
+  # if you try to configure a key that doesn't exist.
+  # Refer to the comments in the initializer that Tolaria generated for
+  # you when you ran `rails generate tolaria:install`.
   class Configuration
+    # The cost factor for bcrypt
     attr_accessor :bcrypt_cost
+    # The name of the company using this admin interface
     attr_accessor :company_name
+    # The default redirect path when administrators log in or no better path exists
     attr_accessor :default_redirect
+    # An array of method names Tolaria uses to attempt to convert a model to a string
     attr_accessor :display_name_methods
+    # The `From` header for emails Tolaria sends
     attr_accessor :from_address
+    # An array of hashes for configuring Help Links
     attr_accessor :help_links
+    # The number of seconds that an administrator is locked out when they hit the rate-limit
     attr_accessor :lockout_duration
+    # The number of times an administrator can flunk their passcode challenge or request a token before Tolaria disables their account.
     attr_accessor :lockout_threshold
+    # A string that names a Markdown renderer for Tolaria to use.
     attr_accessor :markdown_renderer
+    # An array of configured menu category labels
     attr_accessor :menu_categories
+    # The default page size Tolaria uses when paginating
     attr_accessor :page_size
+    # The number of seconds that a generated passcode is valid
     attr_accessor :passcode_lifespan
+    # The default array of permitted params (internal use only)
     attr_accessor :permitted_params
   end
 
@@ -28,10 +43,9 @@ module Tolaria
 
   # Configure Tolaria, block-style. Use something similar to:
   #
-  #    Tolaria.configure do |config|
+  #     Tolaria.configure do |config|
   #       # Assign to config properties here
-  #    end
-  #
+  #     end
   def self.configure(&block)
     yield @configuration ||= Tolaria::Configuration.new
   end

data/lib/tolaria/default_config.rb

@@ -1,51 +1,28 @@
+# This file initializes Tolaria's default configuration, which the developer
+# is expected to override.
+#
+# Please see lib/generators/tolaria/install/templates/tolaria_initializer.rb
+# and config.rb for details.
+
 Tolaria.configure do |config|
 
-  # The name of the company or group using this admin interface.
-  # Used in system navigation and HTML page titles.
   config.company_name = "Company Name"
+  config.from_address = "Rails <tolaria@example.org>"
 
-  # Redirect the users to this route by default when logging in.
   config.default_redirect = :admin_administrators
 
-  # Tolaria sends authentication emails. Set the value of the From header here.
-  config.from_address = "Rails <tolaria@example.org>"
-
-  # You can assign models to a category group them on the nav menu.
-  # Add/modify categories by changing the array below.
-  # Categories first in the array will be first on the menu.
   config.menu_categories = ["Settings"]
 
-  # The cost factor for bcrypt.
-  # It is VERY DANGEROUS to set this below 10 for production.
-  # Use 1 in test mode to speed up your test suite.
   config.bcrypt_cost = Rails.env.test?? 1 : 13
-
-  # The length of time that emailed passcodes should be valid.
-  # It is STRONGLY RECOMMENDED that you keep this under 30 minutes.
   config.passcode_lifespan = 10.minutes
-
-  # The number of times an administrator can flunk their passcode
-  # challenge or request a token before Tolaria disables their account.
   config.lockout_threshold = 10
-
-  # The length of time that an administrator’s account is disabled
-  # after they trip the lockout threshold.
   config.lockout_duration = 1.hour
 
-  # An array of hashes used to construct HelpLinks
   config.help_links = []
 
-  # Tolaria does not come bundled with a Markdown processing strategy.
-  # You must provide a string that names a Ruby constant that can process Markdown.
-  # The constant must respond to render(document), returning a string of HTML.
-  # For example: if you provide "MyMarkDownRenderer", Tolaria will
-  # call MyMarkdownRenderer.render(document).
   config.markdown_renderer = nil
+  config.page_size = 15
 
-  # Tolaria attempts to convert models to a pretty “display”
-  # string for presenting in forms and listings.
-  # The methods below are tried in order on models until one responds.
-  # Must be an array of symbols.
   config.display_name_methods = %i[
     admin_name
     display_name
@@ -59,11 +36,6 @@ Tolaria.configure do |config|
     id
   ]
 
-  # The number of items on each page when paginating models.
-  config.page_size = 15
-
-  # Default permitted_params for all forms.
-  # End-developers probably shouldn’t change this.
   config.permitted_params = %i[
     _method
     authenticity_token

data/lib/tolaria/{introspection.rb → display_name.rb}

@@ -1,7 +1,7 @@
 module Tolaria
 
   # Using this method, you can attempt to get a pretty “display”
-  # string for presenting the passed +resource+ as a label.
+  # string for presenting the passed `resource` as a label.
   def self.display_name(resource)
     Tolaria.config.display_name_methods.each do |method_name|
       if resource.respond_to?(method_name)

data/lib/tolaria/form_buildable.rb

@@ -2,7 +2,7 @@ module Tolaria
   module FormBuildable
 
     # Returns a `p.hint` used to explain a nearby form field containing
-    # the given +hint_text+.
+    # the given `hint_text`.
     def hint(hint_text)
       content_tag(:p, content_tag(:span, hint_text.chomp), class:"hint")
     end
@@ -29,7 +29,7 @@ module Tolaria
 
     # Creates a `searchable_select` that also shows a dynamic image preview of the selected record.
     # Useful for previewing images or avatars chosen by name.
-    # +preview_url_method+ should be a method name to call on the associated model instance
+    # `preview_url_method` should be a method name to call on the associated model instance
     # that returns a fully-qualified URL to the image preview.
     def image_association_select(method, collection, value_method, text_method, preview_url_method, options = {})
       render(partial:"admin/shared/forms/image_association_select", locals: {
@@ -44,7 +44,7 @@ module Tolaria
       })
     end
 
-    # Renders a Markdown composer element for editing +method+,
+    # Renders a Markdown composer element for editing `method`,
     # with fullscreen previewing and some text assistance tools.
     # Requires that you set `Tolaria.config.markdown_renderer`.
     # Options are forwarded to `text_area`.
@@ -57,7 +57,7 @@ module Tolaria
     end
 
     # Returns a file upload field with a more pleasant interface than browser
-    # file inputs. Changes messaging if the +method+ already exists.
+    # file inputs. Changes messaging if the `method` already exists.
     # Options are forwarded to the hidden `file_field`.
     def attachment_field(method, options = {})
       render(partial:"admin/shared/forms/attachment_field", locals: {
@@ -68,7 +68,7 @@ module Tolaria
     end
 
     # Returns an image upload field with a more pleasant interface than browser
-    # file inputs. Changes messaging if the +method+ already exists.
+    # file inputs. Changes messaging if the `method` already exists.
     #
     # #### Special Options
     #
@@ -147,10 +147,10 @@ module Tolaria
     # You must use `f.has_many_header` inside the block to create headers.
     #
     # If you need to pass an ordered collection or otherwise not allow automatically
-    # determining the association objects from the +association+ symbol you can
-    # pass the collection manually as +association_objects+.
+    # determining the association objects from the `association` symbol you can
+    # pass the collection manually as `association_objects`.
     #
-    # If +allow_create+ is `false` then the button to append a new model
+    # If `allow_create` is `false` then the button to append a new model
     # instance will be disabled. The default is `true`.
     def has_many(association, association_objects = nil, allow_create:true, &block)
 
@@ -180,7 +180,7 @@ module Tolaria
     end
 
     # Creates a header suitable for use inside `has_many` for separating
-    # form elements. If +allow_destroy+ is `true`, controls will be exposed that allow
+    # form elements. If `allow_destroy` is `true`, controls will be exposed that allow
     # removing nested instances of the model. The default is `false` to match Rails’.
     def has_many_header(allow_destroy:false)
       render(partial:"admin/shared/forms/has_many_header", locals: {

data/lib/tolaria/help_links.rb

@@ -2,6 +2,9 @@ module Tolaria
 
   @help_links = []
 
+  # Reads `Tolaria.config.help_links` and constructs an internal array
+  # of HelpLink objects with the given options.
+  # Call `Tolaria.help_links` to receive the results.
   def self.initialize_help_links!
     @help_links = []
     self.config.help_links.each do |hashy|
@@ -9,10 +12,12 @@ module Tolaria
     end
   end
 
+  # Returns all of Tolaria's configured Help Links.
   def self.help_links
     @help_links ||= []
   end
 
+  # Class representing a configured Tolaria help link.
   class HelpLink
 
     # The title of the link
@@ -25,11 +30,11 @@ module Tolaria
     attr_reader :link_to
 
     # Create a new HelpLink with the passed settings.
-    # You must provide +title+, the title of the link.
+    # You must provide `title`, the title of the link.
     # To configure automatic rendering of a Markdown file, provide
-    # a string +slug+ and the path to a +markdown_file+.
+    # a string `slug` and the path to a `markdown_file`.
     # A route to view the file will be constructed for you at `/admin/help/:slug`.
-    # To link to an arbirary path or URI, provide it as +link_to+.
+    # To link to an arbitrary path or URI, provide it as `link_to`.
     def initialize(title:, slug:nil, markdown_file:nil, link_to:nil)
       @title = title.to_s.freeze
       @slug = slug.to_s.freeze
@@ -38,22 +43,22 @@ module Tolaria
       validate!
     end
 
-    # True if this HelpLink is a link to an arbirary path
+    # True if this HelpLink is a link to an arbitrary path.
     def link_type?
       link_to.present?
     end
 
-    # True if this HelpLink is a Markdown file
+    # True if this HelpLink is a Markdown file.
     def markdown_type?
       markdown_file.present?
     end
 
-    # Quack like an ActiveRecord::Base model
+    # Quack like an ActiveRecord::Base model, returns slug.
     def to_param
       slug
     end
 
-    # Raises RuntimeError if this HelpLink is incorrectly configured
+    # Raises RuntimeError if this HelpLink is incorrectly configured.
     def validate!
 
       if title.blank?

data/lib/tolaria/manage.rb

@@ -9,7 +9,7 @@ module Tolaria
     @safe_mangagment
   end
 
-  # Set the value of Tolaria.safe_management. +bool+ should be truthy.
+  # Set the value of Tolaria.safe_management. `bool` should be truthy.
   # Don't call this method directly.
   def self.safe_management=(bool)
     @safe_mangagment = !!bool
@@ -47,7 +47,7 @@ module Tolaria
 
   end
 
-  # Discard a managed class instance for the given ActiveRecord::Base
+  # Discard a managed class instance for the given ActiveRecord::Base class
   def self.discard_managed_class(klass)
     @managed_classes.delete_if do |managed_class|
       klass.to_s == managed_class.klass.to_s

data/lib/tolaria/managed_class.rb

@@ -1,7 +1,6 @@
-# This class wraps an ActiveRecord::Base descendant
-# and stores information that Tolaria needs to track about it
-
 module Tolaria
+
+  # Wraps an ActiveRecord::Base descendant and stores information that Tolaria needs to track about it
   class ManagedClass
 
     # The ActiveRecord::Base model we’re managing
@@ -13,7 +12,7 @@ module Tolaria
     # Items are sorted with lowest priority first in the menu
     attr_accessor :priority
 
-    # The FontAwesome icon to use for this resource
+    # The Font Awesome icon to use for this resource
     attr_accessor :icon
 
     # An array of options to pass to `params.permit` for this model
@@ -29,7 +28,7 @@ module Tolaria
     attr_accessor :controller_name
 
     # An array of the route actions allowed on this resource.
-    # Tolaria will pass this array as the `only:` option to the router
+    # Tolaria will pass this array as the `:only` option to the router
     attr_accessor :allowed_actions
 
     # A stored symbol for the `params.permit` key for this resource
@@ -87,4 +86,5 @@ module Tolaria
     delegate :plural, to: :model_name
 
   end
+
 end

data/lib/tolaria/markdown.rb

@@ -1,13 +1,13 @@
 module Tolaria
 
-  # A class to contain a workflow for rendering Markdown.
-  # If no renderer has been configured, defer to simple_format.
+  # Contains a workflow for rendering Markdown.
+  # If no renderer has been configured, defers to `simple_format`.
   class MarkdownRendererProxy
 
     include ::ActionView::Helpers::TextHelper
 
     # Calls the configured Markdown renderer, if none exists
-    # then uses simple_format to return more than nothing.
+    # then uses `simple_format` to return more than nothing.
     def render(document)
       if Tolaria.config.markdown_renderer.nil?
         return simple_format(document)

data/lib/tolaria/random_tokens.rb

@@ -2,12 +2,13 @@ module Tolaria
   module RandomTokens
 
     # Returns a 32-character random, alphanumeric string suitable for stronger
-    # tokens use like cookies and API keys
+    # token use like with cookies and API keys.
     def self.auth_token
       SecureRandom.base64(32).delete("+/=")[0..31]
     end
 
-    # Returns a six-digit numeric code suitable for use as a one-time passphrase
+    # Returns a six-digit numeric code suitable for use as a one-time passphrase.
+    # Leading zeroes are possible, encompassing `000000`-`999999`.
     def self.passcode
       "%06d" % SecureRandom.random_number(1_000_000)
     end

data/lib/tolaria/reload.rb

@@ -4,7 +4,7 @@ module Tolaria
   # to force Rails to autoload/reload all model files.
   def self.reload!
 
-    # Re/Initalize HelpLinks
+    # Re/Initialize HelpLinks
     self.initialize_help_links!
 
     # Manage the models included with the engine

data/lib/tolaria/version.rb

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

data/test/integration/forbidden_routes_test.rb

@@ -0,0 +1,105 @@
+require "test_helper"
+
+class CreateCardsMigration < ActiveRecord::Migration
+  def change
+    create_table :cards, force:true do |t|
+      t.timestamps null:false
+      t.string :title
+    end
+  end
+end
+
+class ForbiddenRoutesTest < ActionDispatch::IntegrationTest
+
+  def setup
+    ActiveRecord::Migration.verbose = false
+    CreateCardsMigration.new.exec_migration(ActiveRecord::Base.connection, :up)
+  end
+
+  def teardown
+    CreateCardsMigration.new.exec_migration(ActiveRecord::Base.connection, :down)
+    ActiveRecord::Migration.verbose = true
+  end
+
+  test "handles classes with only the index action" do
+
+    class ::Card < ActiveRecord::Base
+      manage_with_tolaria using:{
+        allowed_actions: [:index]
+      }
+    end
+
+    # Re-draw the routes and reload Tolaria
+    Rails.application.routes.draw do
+      Tolaria.draw_routes(self)
+    end
+
+    sign_in_dummy_administrator!
+    visit admin_cards_path
+    assert page.has_content?("Cards")
+    refute page.has_content?("Create Card")
+
+    # Unseat the Card class so that it doesn't leak out of this test
+    assert Tolaria.discard_managed_class(Card), "should discard class"
+    Object.send(:remove_const, :Card)
+
+  end
+
+  test "handles classes with only the show action" do
+
+    class ::Card < ActiveRecord::Base
+      manage_with_tolaria using:{
+        allowed_actions: [:show]
+      }
+    end
+
+    # Re-draw the routes and reload Tolaria
+    Rails.application.routes.draw do
+      Tolaria.draw_routes(self)
+    end
+
+    Card.create(title:"Urza")
+
+    sign_in_dummy_administrator!
+    visit admin_card_path(Card.first.id)
+    assert page.has_content?("Urza")
+    refute page.has_content?("Delete")
+
+    # Unseat the Card class so that it doesn't leak out of this test
+    assert Tolaria.discard_managed_class(Card), "should discard class"
+    Object.send(:remove_const, :Card)
+
+  end
+
+  test "handles avoiding the index" do
+
+    class ::Card < ActiveRecord::Base
+      manage_with_tolaria using:{
+        allowed_actions: [:show, :update, :edit, :destroy, :create, :new]
+      }
+    end
+
+    # Re-draw the routes and reload Tolaria
+    Rails.application.routes.draw do
+      Tolaria.draw_routes(self)
+    end
+
+    Card.create(title:"Urza")
+
+    sign_in_dummy_administrator!
+    visit admin_card_path(Card.first.id)
+    assert page.has_content?("Urza")
+    assert page.has_content?("Delete")
+    assert page.has_content?("Edit")
+
+    assert_raises ActionView::Template::Error do
+      visit new_admin_card_path
+    end
+
+    # Unseat the Card class so that it doesn't leak out of this test
+    assert Tolaria.discard_managed_class(Card), "should discard class"
+    Object.send(:remove_const, :Card)
+
+  end
+
+end

data/tolaria.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "capybara", "~> 2.4"
   s.add_development_dependency "minitest", "~> 5.7"
-  s.add_development_dependency "rdoc", "~> 4"
+  s.add_development_dependency "yard", "~> 0.6"
   s.add_development_dependency "redcarpet", "~> 3"
   s.add_development_dependency "sqlite3", "~> 1.3"
   s.add_development_dependency "timecop", "~> 0.7"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tolaria
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Corey Csuhta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -124,19 +124,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.7'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +189,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - ".yardopts"
 - CNAME
 - CONTRIBUTING.md
@@ -327,10 +328,10 @@ files:
 - lib/tolaria/categories.rb
 - lib/tolaria/config.rb
 - lib/tolaria/default_config.rb
+- lib/tolaria/display_name.rb
 - lib/tolaria/engine.rb
 - lib/tolaria/form_buildable.rb
 - lib/tolaria/help_links.rb
-- lib/tolaria/introspection.rb
 - lib/tolaria/manage.rb
 - lib/tolaria/managed_class.rb
 - lib/tolaria/markdown.rb
@@ -394,6 +395,7 @@ files:
 - test/demo/public/422.html
 - test/demo/public/500.html
 - test/demo/public/favicon.ico
+- test/integration/forbidden_routes_test.rb
 - test/integration/help_link_test.rb
 - test/integration/interface_test.rb
 - test/integration/router_test.rb
@@ -486,6 +488,7 @@ test_files:
 - test/demo/public/422.html
 - test/demo/public/500.html
 - test/demo/public/favicon.ico
+- test/integration/forbidden_routes_test.rb
 - test/integration/help_link_test.rb
 - test/integration/interface_test.rb
 - test/integration/router_test.rb