godmin 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 113b40103476fc56d7a936799d5750fecd7d3697
-  data.tar.gz: ea1fd807681371728f6bb6e85645bb8cb3472faa
+  metadata.gz: 6c9bc1e136e1f026504ed65cd0199c7bed3b2ec4
+  data.tar.gz: 36d462277c7c058a619c2fb29afd86f42de87574
 SHA512:
-  metadata.gz: 6e636dd69f663e11110d39a5583def41339daff335ca41b670bbcdbfb5871fc486ba231349327205ffafa7d3bd2d9e766ed8c3794c71d79c375e7fa29989b677
-  data.tar.gz: c0e210a5a0ce0ad9d8a9338fe494fc8d9c0d056ba1ca499d4f2f29fad07579bd90caf1b20eabf452ada1ed6f9a3905fb11cb3ad8a3f26bec101b2f02c370ba8a
+  metadata.gz: e50bc8557f5bb7d677e75f6cc5e67f39221813f42d2e30539c8bc0d0bc874f6a52fe477fd3b4f9a84a34e911b7dab896c7a53d66f9d1fc4cf01c6d687ebaf042
+  data.tar.gz: 7185ab2665b695723c7422ee7007f6e11749ff9381ac5c51470342133dc220a2f482f29f3f7b885a2594964c12401db840481f3cac13359baf9aabcccd15671b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 0.9.6 - 2014-12-18
+Features
+- Bundled [datetimepicker](https://github.com/Eonasdan/bootstrap-datetimepicker/)
+- Exposed JavaScript API
+
+Notes
+- You must now require godmin in application.js and application.css
+- You can no longer use the `select-tag` class to initialize a select box
+
 ### 0.9.5 - 2014-12-15
 Bug fixes
 - Fixes Godmin::FormBuilder issue
@@ -29,4 +38,3 @@ Bug fixes
 - Removed rails executable from /bin folder.
 
 ### 0.9.0 - 2014-11-17
-Public release.

data/README.md

@@ -1,7 +1,7 @@
 # Godmin
 
 [![Gem Version](http://img.shields.io/gem/v/godmin.svg)](https://rubygems.org/gems/godmin)
-[![Build Status](https://travis-ci.org/varvet/godmin.svg?branch=master)](https://travis-ci.org/varvet/godmin)
+[![Build Status](https://img.shields.io/travis/varvet/godmin/master.svg)](https://travis-ci.org/varvet/godmin)
 [![Code Climate](https://codeclimate.com/github/varvet/godmin/badges/gpa.svg)](https://codeclimate.com/github/varvet/godmin)
 
 Godmin is an admin engine for Rails 4+.
@@ -25,6 +25,8 @@ Godmin is an admin engine for Rails 4+.
 	- [Shared authentication](#shared-authentication)
 - [Authorization](#authorization)
 - [Localization](#localization)
+- [JavaScript](#javascript)
+- [Plugins](#plugins)
 - [Contributors](#contributors)
 - [License](#license)
 
@@ -110,6 +112,8 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+Require statements are placed in both `app/assets/javascripts/application.js` and `app/assets/stylesheets/application.css`.
+
 If Godmin was installed inside an engine, a `require "godmin"` statement is placed in `{namespace}/lib/{namespace}.rb`.
 
 And finally, the `app/views/layouts` folder is removed by default, so as not to interfere with the Godmin layouts. It can be added back in case you wish to override the built in layouts.
@@ -165,12 +169,7 @@ By now we have a basic admin interface for managing articles.
 
 ## Controllers
 
-We have already seen two controller methods at play: `attrs_for_index` and `attrs_for_form`. Now we will look at four additional controller concepts, namely:
-
-- Scopes
-- Filters
-- Batch actions
-- Resource fetching
+We have already seen two controller methods at play: `attrs_for_index` and `attrs_for_form`. We will now look at some additional controller concepts.
 
 ### Scopes
 
@@ -195,9 +194,7 @@ end
 
 ### Filters
 
-Filters offer great flexibility when it comes to searching for resources.
-
-Filters can be created as follows:
+Filters offer great flexibility when it comes to searching for resources, and can be created as follows:
 
 ```ruby
 class ArticlesController < ApplicationController
@@ -240,8 +237,6 @@ class ArticlesController < ApplicationController
   def batch_action_publish(resources)
     resources.each { |r| r.update_attributes(published: true) }
   end
-
-  ...
 end
 ```
 
@@ -309,7 +304,7 @@ end
 
 ### Redirecting
 
-By default the user is redirected to the resource show page after create and update. To change this, there are four controller methods that can be overridden: `redirect_after_create`, `redirect_after_update`, `redirect_after_save`, and `redirect_after_destroy`.
+By default the user is redirected to the resource show page after create and update, and to the index page after destroy. To change this, there are four controller methods that can be overridden: `redirect_after_create`, `redirect_after_update`, `redirect_after_save`, and `redirect_after_destroy`.
 
 For instance, to have the article controller redirect to the index page after both create and update:
 
@@ -345,6 +340,8 @@ If you wish to change the behaviour for every resource controller, consider crea
 class ResourceController < ApplicationController
   include Godmin::Resource
 
+  protected
+
   def redirect_after_save
     resource_class.model_name.route_key.to_sym
   end
@@ -585,6 +582,73 @@ Godmin comes with built in support for English and Swedish.
 
 There is a view helper available named `translate_scoped` that can be used in overridden views. Please see the source code for information on how to use it.
 
+## JavaScript
+
+Godmin comes with a small set of JavaScript components and APIs.
+
+### Datetimepickers
+
+Make a [bootstrap-datetimepicker](https://github.com/Eonasdan/bootstrap-datetimepicker) out of a text field:
+
+```ruby
+f.text_field :date, data: { behavior: "datepicker" }
+f.text_field :date, data: { behavior: "timepicker" }
+f.text_field :date, data: { behavior: "datetimepicker" }
+```
+
+If the field is added post page render, it can be initialized manually:
+
+```js
+Godmin.Datetimepickers.initializeDatepicker($el);
+Godmin.Datetimepickers.initializeTimepicker($el);
+Godmin.Datetimepickers.initializeDatetimepicker($el);
+```
+
+Additional options can be passed down to bootstrap-datetimepicker:
+
+```js
+Godmin.Datetimepickers.initializeDatetimepicker($el, {
+  useMinutes: false,
+  useSeconds: false
+});
+```
+
+If you wish to translate the datetimepicker, add the following to your `app/assets/javascripts/application.js`:
+
+```js
+//= require moment
+//= require moment/{locale} // e.g. moment/sv
+//= require godmin
+```
+
+### Select boxes
+
+Make a [selectize.js](http://brianreavis.github.io/selectize.js/) select box out of a text field or select box:
+
+```ruby
+f.text_field :tag_list, data: { behavior: "select-box" }
+```
+
+If the field is added post page render, it can be initialized manually:
+
+```js
+Godmin.SelectBoxes.initializeSelectBox($el);
+```
+
+Additional options can be passed down to selectize:
+
+```js
+Godmin.SelectBoxes.initializeSelectBox($el, {
+	create: true
+});
+```
+
+## Plugins
+
+Some additional features are available as plugins:
+
+- [Godmin Uploads](https://github.com/varvet/godmin-uploads)
+
 ## Contributors
 
 https://github.com/varvet/godmin/graphs/contributors

data/app/assets/javascripts/godmin/batch-actions.js

@@ -0,0 +1,67 @@
+window.Godmin = window.Godmin || {};
+
+Godmin.BatchActions = (function() {
+  var $form;
+  var $selectAll;
+  var $selectNone;
+
+  function initialize() {
+    $form       = $('form[data-behavior~=batch-actions-form]');
+    $selectAll  = $form.find('[data-behavior~=batch-actions-select-all]');
+    $selectNone = $form.find('[data-behavior~=batch-actions-select-none]');
+
+    initializeEvents();
+    initializeState();
+  }
+
+  function initializeEvents() {
+    $form.find('[data-behavior~=batch-actions-select]').on('click', toggleCheckboxes);
+    $form.find('[data-behavior~=batch-actions-checkbox]').on('change', toggleActions);
+    $(document).delegate('[data-behavior~=batch-actions-action-link]', 'click', triggerAction);
+  }
+
+  function initializeState() {}
+
+  function setSelectToAll() {
+    $selectAll.removeClass('hidden');
+    $selectNone.addClass('hidden');
+  }
+
+  function setSelectToNone() {
+    $selectAll.addClass('hidden');
+    $selectNone.removeClass('hidden');
+  }
+
+  function toggleCheckboxes() {
+    if ($form.find('[data-behavior~=batch-actions-checkbox]:checked').length > 0) {
+      $form.find('[data-behavior~=batch-actions-checkbox]').prop('checked', false).trigger('change');
+      setSelectToAll();
+    } else {
+      $form.find('[data-behavior~=batch-actions-checkbox]').prop('checked', true).trigger('change');
+      setSelectToNone();
+    }
+  }
+
+  function toggleActions() {
+    if ($form.find('[data-behavior~=batch-actions-checkbox]:checked').length) {
+      $('[data-behavior~=batch-actions-action-link]').removeClass('hidden');
+      setSelectToNone();
+    } else {
+      $('[data-behavior~=batch-actions-action-link]').addClass('hidden');
+      setSelectToAll();
+    }
+  }
+
+  function triggerAction() {
+    $form.find('[data-behavior~=batch-actions-action]').val($(this).data('value'));
+    $form.submit();
+  }
+
+  return {
+    initialize: initialize
+  };
+})();
+
+$(function() {
+  Godmin.BatchActions.initialize();
+});

data/app/assets/javascripts/godmin/datetimepickers.js

@@ -0,0 +1,46 @@
+window.Godmin = window.Godmin || {};
+
+Godmin.Datetimepickers = (function() {
+  function initialize() {
+    initializeEvents();
+    initializeState();
+  }
+
+  function initializeEvents() {}
+
+  function initializeState() {
+    initializeDatepicker($('[data-behavior~=datepicker]'));
+    initializeTimepicker($('[data-behavior~=timepicker]'));
+    initializeDatetimepicker($('[data-behavior~=datetimepicker]'));
+  }
+
+  function initializeDatepicker($el, options) {
+    var defaults = {
+      pickTime: false
+    };
+    initializeDatetimepicker($el, $.extend(defaults, options));
+  }
+
+  function initializeTimepicker($el, options) {
+    var defaults = {
+      pickDate: false
+    };
+    initializeDatetimepicker($el, $.extend(defaults, options));
+  }
+
+  function initializeDatetimepicker($el, options) {
+    var defaults = {};
+    $el.datetimepicker($.extend(defaults, options));
+  }
+
+  return {
+    initialize: initialize,
+    initializeDatepicker: initializeDatepicker,
+    initializeTimepicker: initializeTimepicker,
+    initializeDatetimepicker: initializeDatetimepicker
+  };
+})();
+
+$(function() {
+  Godmin.Datetimepickers.initialize();
+});

data/app/assets/javascripts/godmin/{application.js → index.js}

@@ -12,8 +12,11 @@
 //
 //= require jquery
 //= require jquery_ujs
+//= require moment
 //= require bootstrap-sprockets
+//= require bootstrap-datetimepicker
 //= require selectize
-//= require godmin/batch_actions
+//= require godmin/batch-actions
+//= require godmin/datetimepickers
 //= require godmin/navigation
-//= require godmin/select_tags
+//= require godmin/select-boxes

data/app/assets/javascripts/godmin/navigation.js

@@ -1,9 +1,30 @@
-(function($) {
-  $(function() {
+window.Godmin = window.Godmin || {};
+
+Godmin.Navigation = (function() {
+  function initialize() {
+    initializeEvents();
+    initializeState();
+  }
+
+  function initializeEvents() {}
+
+  function initializeState() {
+    removeEmptyDropdowns();
+  }
+
+  function removeEmptyDropdowns() {
     $('.navbar-nav .dropdown').each(function() {
       if ($(this).find('li').length === 0) {
         $(this).remove();
       }
     });
-  });
-}(jQuery));
+  }
+
+  return {
+    initialize: initialize
+  };
+})();
+
+$(function() {
+  Godmin.Navigation.initialize();
+});

data/app/assets/javascripts/godmin/select-boxes.js

@@ -0,0 +1,31 @@
+window.Godmin = window.Godmin || {};
+
+Godmin.SelectBoxes = (function() {
+  function initialize() {
+    initializeEvents();
+    initializeState();
+  }
+
+  function initializeEvents() {}
+
+  function initializeState() {
+    initializeSelectBox($('[data-behavior~=select-box]'));
+  }
+
+  function initializeSelectBox($el, options) {
+    var defaults = {
+      inputClass: 'form-control selectize-input'
+    };
+
+    $el.selectize($.extend(defaults, options));
+  }
+
+  return {
+    initialize: initialize,
+    initializeSelectBox: initializeSelectBox
+  };
+})();
+
+$(function() {
+  Godmin.SelectBoxes.initialize();
+});

data/app/assets/stylesheets/godmin/{application.css.scss → index.css.scss}

@@ -10,9 +10,9 @@
  *
  *= require_self
  */
-
 @import "bootstrap-sprockets";
 @import "bootstrap";
+@import "bootstrap-datetimepicker";
 @import "selectize";
 @import "selectize.bootstrap3";
 

data/app/views/godmin/resource/_batch_actions.html.erb

@@ -1,6 +1,8 @@
 <% if batch_action_map.present? %>
-  <%= link_to translate_scoped("batch_actions.select_all"), "#", class: "btn btn-default batch-actions-select batch-actions-select-all" %>
-  <%= link_to translate_scoped("batch_actions.deselect_all"), "#", class: "btn btn-default batch-actions-select batch-actions-select-none hidden" %>
+  <%= link_to translate_scoped("batch_actions.select_all"), "#", class: "btn btn-default",
+    data: { behavior: "batch-actions-select batch-actions-select-all" } %>
+  <%= link_to translate_scoped("batch_actions.deselect_all"), "#", class: "btn btn-default hidden",
+    data: { behavior: "batch-actions-select batch-actions-select-none" } %>
 
   <div class="btn-group">
     <% batch_action_map.each do |name, options| %>
@@ -8,5 +10,5 @@
     <% end %>
   </div>
 
-  <%= hidden_field_tag "batch_action[action]", nil, id: "batch-actions-action" %>
+  <%= hidden_field_tag "batch_action[action]", nil, data: { behavior: "batch-actions-action" } %>
 <% end %>

data/app/views/godmin/resource/_form.html.erb

@@ -2,7 +2,7 @@
   <% attrs_for_form.each do |attr| %>
     <div class="form-group">
       <% if @resource_class.reflect_on_association(attr) %>
-        <%= f.association attr, error: false, input_html: { class: "form-control select-tag" } %>
+        <%= f.association attr, error: false, input_html: { class: "form-control", data: { behavior: "select-box" } } %>
       <% else %>
         <%= f.input attr, error: false, input_html: { class: "form-control" } %>
       <% end %>

data/app/views/godmin/resource/_table.html.erb

@@ -19,7 +19,8 @@
       <% end %>
         <% if batch_action_map.present? %>
           <td align="center">
-            <%= check_box_tag "batch_action[items][#{resource.id}]" %>
+            <%= check_box_tag "batch_action[items][#{resource.id}]", nil, nil,
+              data: { behavior: "batch-actions-checkbox" } %>
           </td>
         <% end %>
         <% attrs_for_index.each do |attr| %>

data/app/views/godmin/resource/index.html.erb

@@ -6,7 +6,7 @@
   <%= render partial: "filters" %>
 <% end %>
 
-<%= form_tag [:batch_action, @resource_class], id: "batch-actions-form" do %>
+<%= form_tag [:batch_action, @resource_class], data: { behavior: "batch-actions-form" } do %>
 
   <%= render partial: "actions" %>
 

data/app/views/layouts/godmin/_layout.html.erb

@@ -2,8 +2,8 @@
 <html>
   <head>
     <title>Godmin</title>
-    <%= stylesheet_link_tag "godmin/application", [Godmin.namespace, "application"].compact.join("/"), media: "all" %>
-    <%= javascript_include_tag "godmin/application", [Godmin.namespace, "application"].compact.join("/") %>
+    <%= stylesheet_link_tag [Godmin.namespace, "application"].compact.join("/"), media: "all" %>
+    <%= javascript_include_tag [Godmin.namespace, "application"].compact.join("/") %>
     <%= csrf_meta_tags %>
     <%= yield :head %>
   </head>