godmin 0.11.2 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1a5334ebb2e228023a6cccfb705a553f905e078
-  data.tar.gz: f09f0016aee8d29946cc866b95f063bfbffdaba7
+  metadata.gz: 142e127c459d99fcaffc7277c23302b39ed55fdd
+  data.tar.gz: 0d33f7c04855780ceb0b20fc48fbe5e226cc738a
 SHA512:
-  metadata.gz: a8272a05585b9d93f37780dcaa03dc82c37a4ce5c6d17c8d0a5b2caf34b4ebf05b348ff15dea6b4848478ad2f829d0c34653aac377508c6160a0dc9f01875a86
-  data.tar.gz: cc0614cc0e8017d93fd82d983c657bd0908ef282fcee3576f5a044fdd673b30faf657c1819534ffbd7c8fa69118bb326c2bc28ce82e5fcae58c34e18dbaf2cb9
+  metadata.gz: ce10bc5fc5b5cebe832a9fb95da78c8a37c7121f3e1b1efd6b1494a76e72b8a458e62c3032925a7cc31e2d57c7e31a7400955c91aaddc49aafaacb39d31f7bb0
+  data.tar.gz: e6a2b6e898e3a7e5280cef2f4ffa6edcde3b9af2411e84308abff1680bca9a7af5ba6cd01e724111c5c7b32927574a0101382a704e01047c4061fa2dfc29e789

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+---
+engines:
+  rubocop:
+    enabled: true
+  eslint:
+    enabled: true
+  csslint:
+    enabled: true
+  bundler-audit:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+  - "**.js"
+  - "**.jsx"
+  - "**.css"
+exclude_paths:
+- config/**/*
+- test/**/*
+- vendor/**/*
+- tmp/**/*

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### 0.12.0 - 2015-06-30
+Features
+- Adds new navigation helpers for building a custom navbar (https://github.com/varvet/godmin/issues/54)
+
+Other
+- Removes the godmin router method
+
+In order to upgrade:
+- Remove the `godmin do` block from the `config/routes.rb` file
+- Specify a root route if there is none already
+- Create a `shared/_navigation.html.erb` partial if there is none already
+
+Bug fixes
+- Fixes issue with authentication generator not modifying the application controller
+
 ### 0.11.2 - 2015-06-22
 Bug fixes
 - Fixes broken collection select helper

data/README.md

@@ -6,6 +6,8 @@
 
 Godmin is an admin framework for Rails 4+.
 
+![Screenshot](https://raw.githubusercontent.com/varvet/godmin/master/screenshot.png)
+
 - [Installation](#installation)
 	- [Standalone installation](#standalone-installation)
 	- [Engine installation](#engine-installation)
@@ -18,8 +20,10 @@ Godmin is an admin framework for Rails 4+.
 	- [Resource fetching, building and saving](#resource-fetching-building-and-saving)
 	- [Redirecting](#redirecting)
 	- [Pagination](#pagination)
+	- [Exporting](#exporting)
 - [Views](#views)
   - [Forms](#forms)
+	- [Navigation](#navigation)
 - [Authentication](#authentication)
 	- [Built in authentication](#built-in-authentication)
 	- [Shared authentication](#shared-authentication)
@@ -97,16 +101,6 @@ end
 
 If Godmin was installed inside an engine, as in the previous section, the namespace is the underscored name of the engine, e.g. `"admin"`.
 
-The `config/routes.rb` file is modified as such:
-```ruby
-Rails.application.routes.draw do
-  godmin do
-  end
-end
-```
-
-Resource routes placed within the `godmin` block are automatically added to the default navigation.
-
 The application controller is modified as such:
 ```ruby
 class ApplicationController < ActionController::Base
@@ -118,6 +112,8 @@ Require statements are placed in both `app/assets/javascripts/application.js` an
 
 If Godmin was installed inside an engine, a `require "godmin"` statement is placed in `{namespace}/lib/{namespace}.rb`.
 
+An `app/views/shared/_navigation.html.erb` partial is created.
+
 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.
 
 ## Getting started
@@ -138,9 +134,13 @@ This does a number of things.
 It inserts a route in the `config/routes.rb` file:
 
 ```ruby
-godmin do
-  resources :articles
-end
+resources :articles
+```
+
+It inserts a `navbar_item` in the `app/views/shared/_navigation.html.erb` partial:
+
+```erb
+<%= navbar_item Article %>
 ```
 
 It creates a controller:
@@ -175,7 +175,7 @@ By now we have a basic admin interface for managing articles.
 
 As we saw in the example above, resources are divided into controllers and service objects. Actions, redirects, params permitting etc go in the controller while resource fetching, building, sorting, filtering etc go in the service object. This makes the service objects small and easy to test.
 
-We have already seen two methods at play: `attrs_for_index` and `attrs_for_form`. We will now look at some additional resource concepts.
+We have already seen three methods at play: `attrs_for_index`, `attrs_for_show` and `attrs_for_form`. We will now look at some additional resource concepts.
 
 ### Scopes
 
@@ -466,20 +466,30 @@ class ArticlesService
 end
 ```
 
+### Exporting
+
+The `attrs_for_export` method in the service object makes it possible to mark attributes or methods on the model as exportable. When implemented, an export button will appear on the index page with options for both CSV and JSON export.
+
+```ruby
+class ArticlesService
+  include Godmin::Resources::Service
+
+  attrs_for_export :id, :title, :created_at, :updated_at
+end
+```
+
 ## Views
 
 It's easy to override view templates and partials in Godmin, both globally and per resource. All you have to do is place a file with an identical name in your `app/views` directory. For instance, to override the `godmin/resource/index.html.erb` template for all resources, place a file under `app/views/resource/index.html.erb`. If you only wish to override it for articles, place it instead under `app/views/articles/index.html.erb`.
 
 If you wish to customize the content of a table column, you can place a partial under `app/views/{resource}/columns/{column_name}.html.erb`, e.g. `app/views/articles/columns/_title.html.erb`. The resource is available to the partial through the `resource` variable.
 
-Oftentimes, the default form provided by Godmin doesn't cut it. The `godmin/resource/_form.html.erb` partial is therefore one of the most common to override per resource. See below for more on form building.
-
-Likewise, the `godmin/shared/_navigation.html.erb` partial can be overridden to build a custom navigation bar.
-
 The full list of templates and partials that can be overridden [can be found here](https://github.com/varvet/godmin/tree/master/app/views/godmin).
 
 ### Forms
 
+Oftentimes, the default form provided by Godmin doesn't cut it. The `godmin/resource/_form.html.erb` partial is therefore one of the most common to override per resource.
+
 Godmin comes with its own FormBuilder that automatically generates bootstrapped markup. It is based on the [Rails Bootstrap Forms](https://github.com/bootstrap-ruby/rails-bootstrap-forms) FormBuilder, and all its methods are directly available. In addition it has a few convenience methods that can be leveraged.
 
 The `input` method will automatically detect the type of field from the database and generate an appropriate form field:
@@ -490,6 +500,48 @@ form_for @resource do |f|
 end
 ```
 
+### Navigation
+
+Godmin comes with built in view helpers for generating the navbar.
+
+The `navbar_item` helper generates a link in the navbar. It can be used in a number of different ways.
+
+```ruby
+# Links to the index page of the article resource
+navbar_item Article
+
+# Links to a custom path with a custom link text
+navbar_item Article, articles_path(scope: :published) do
+  "Published articles"
+end
+
+# Links to a custom path with a custom link text without specifying resource
+navbar_item "Some text", some_path
+```
+
+The `show` option can be passed a proc that evaluates to true or false. This is used to control if the link should be shown or not. By default it checks against the resource policy object if authorization is enabled.
+
+```ruby
+navbar_item Article, show: -> { show? }
+```
+
+The `icon` option can be passed a glyphicon:
+
+```ruby
+navbar_item Article, icon: "book"
+```
+
+The `navbar_dropdown` and `navbar_divider` helpers can be used to build dropdown menus.
+
+```ruby
+navbar_dropdown "Multiple things" do
+  navbar_item Article
+  navbar_item Comment
+  navbar_divider
+  navbar_item User
+end
+```
+
 ## Authentication
 
 Multiple authentication scenarios are supported. Godmin comes with a lightweight built in authentication solution that can be used to sign in to the admin section via the admin interface. In addition, when running an admin engine, it is possible to set up a shared authentication solution so that administrators can sign in via the main app.
@@ -779,6 +831,8 @@ If you wish to translate the datetimepicker, add the following to your `app/asse
 //= require godmin
 ```
 
+Please note that the datepickers default to en-GB, not en-US, because Rails cannot automatically parse en-US dates.
+
 ### Select boxes
 
 Make a [selectize.js](http://brianreavis.github.io/selectize.js/) select box out of a text field or select box:

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

@@ -13,6 +13,7 @@
 //= require jquery
 //= require jquery_ujs
 //= require moment
+//= require moment/en-gb
 //= require bootstrap-sprockets
 //= require bootstrap-datetimepicker
 //= require selectize

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

@@ -9,9 +9,25 @@ Godmin.Navigation = (function() {
   function initializeEvents() {}
 
   function initializeState() {
+    setActiveLink();
     removeEmptyDropdowns();
   }
 
+  function setActiveLink() {
+    var $links = $('.nav.navbar-nav a[href="' + window.location.pathname + window.location.search + '"]');
+
+    if ($links.length) {
+      addActiveClass($links);
+    } else {
+      addActiveClass($('.nav.navbar-nav a[href="' + window.location.pathname + '"]'));
+    }
+  }
+
+  function addActiveClass($links) {
+    $links.closest('li').addClass('active');
+    $links.closest('li.dropdown').addClass('active');
+  }
+
   function removeEmptyDropdowns() {
     $('.navbar-nav .dropdown, .breadcrumb .dropdown').each(function() {
       if ($(this).find('li').length === 0) {

data/app/views/godmin/shared/_navigation.html.erb

@@ -1,29 +0,0 @@
-<ul class="nav navbar-nav">
-  <% Godmin.resources.each do |resource| %>
-    <% if policy(resource).index? %>
-      <% if controller.controller_name == resource.to_s %>
-        <li class="active">
-      <% else %>
-        <li>
-      <% end %>
-        <%= link_to resource.to_s.classify.constantize.model_name.human(count: 2), resource %>
-      </li>
-    <% end %>
-  <% end %>
-</ul>
-<ul class="nav navbar-nav navbar-right">
-  <% if authentication_enabled? &&
-        admin_user.singleton_class.include?(Godmin::Authentication::User) &&
-        admin_user_signed_in? %>
-    <li class="dropdown">
-      <a href="#" class="dropdown-toggle" data-toggle="dropdown">
-        <%= admin_user.login %> <span class="caret"></span>
-      </a>
-      <ul class="dropdown-menu" role="menu">
-        <li>
-          <%= link_to translate_scoped("sessions.sign_out"), session_path, method: :delete %>
-        </li>
-      </ul>
-    </li>
-  <% end %>
-</ul>

data/app/views/godmin/shared/_navigation_aside.html.erb

@@ -0,0 +1,7 @@
+<% if authentication_enabled? &&
+      admin_user.singleton_class.include?(Godmin::Authentication::User) &&
+      admin_user_signed_in? %>
+  <li>
+    <%= link_to translate_scoped("sessions.sign_out"), session_path, method: :delete %>
+  </li>
+<% end %>

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

@@ -4,8 +4,13 @@
       <div class="navbar-header">
         <%= link_to t("godmin.title"), root_path, class: "navbar-brand" %>
       </div>
-      <div class="collapse navbar-collapse navbar-ex1-collapse">
-        <%= render partial: "shared/navigation" %>
+      <div class="collapse navbar-collapse">
+        <ul class="nav navbar-nav">
+          <%= render partial: "shared/navigation" %>
+        </ul>
+        <ul class="nav navbar-nav navbar-right">
+          <%= render partial: "shared/navigation_aside" %>
+        </ul>
       </div>
     </div>
   </nav>

data/config/locales/en.yml

@@ -40,5 +40,5 @@ en:
         zero: "No %{resource} found"
         other: "Showing %{count} out of %{total} %{resource}"
     datetimepickers:
-      datepicker: ! "%m/%d/%Y"
-      datetimepicker: ! "%m/%d/%Y%l:%M %p"
+      datepicker: ! "%d/%m/%Y"
+      datetimepicker: ! "%d/%m/%Y %H:%M"

data/lib/generators/godmin/authentication/authentication_generator.rb

@@ -28,7 +28,7 @@ class Godmin::AuthenticationGenerator < Godmin::Generators::NamedBase
   end
 
   def modify_application_controller
-    inject_into_file File.join("app/controllers", namespaced_path, "application_controller.rb"), after: "Godmin::Application\n" do
+    inject_into_file File.join("app/controllers", namespaced_path, "application_controller.rb"), after: "Godmin::ApplicationController\n" do
       <<-END.strip_heredoc.indent(namespace ? 4 : 2)
         include Godmin::Authentication
 

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

@@ -14,12 +14,15 @@ class Godmin::InstallGenerator < Godmin::Generators::Base
   def create_routes
     inject_into_file "config/routes.rb", before: /^end/ do
       <<-END.strip_heredoc.indent(2)
-        godmin do
-        end
+        root to: "application#welcome"
       END
     end
   end
 
+  def create_navigation
+    create_file File.join("app/views", namespaced_path, "shared/_navigation.html.erb")
+  end
+
   def modify_application_controller
     inject_into_file File.join("app/controllers", namespaced_path, "application_controller.rb"), after: "ActionController::Base\n" do
       <<-END.strip_heredoc.indent(namespace ? 4 : 2)

data/lib/generators/godmin/resource/resource_generator.rb

@@ -4,9 +4,13 @@ class Godmin::ResourceGenerator < Godmin::Generators::NamedBase
   argument :attributes, type: :array, default: [], banner: "attribute attribute"
 
   def add_route
-    inject_into_file "config/routes.rb", after: "godmin do\n" do
-      <<-END.strip_heredoc.indent(4)
-        resources :#{file_name.pluralize}
+    route "resources :#{file_name.pluralize}"
+  end
+
+  def add_navigation
+    append_to_file File.join("app/views", namespaced_path, "shared/_navigation.html.erb") do
+      <<-END.strip_heredoc
+        <%= navbar_item #{class_name} %>
       END
     end
   end

data/lib/godmin.rb

@@ -8,7 +8,6 @@ require "godmin/authentication"
 require "godmin/authorization"
 require "godmin/engine"
 require "godmin/paginator"
-require "godmin/rails"
 require "godmin/resolver"
 require "godmin/resources/resource_controller"
 require "godmin/resources/resource_service"
@@ -18,9 +17,6 @@ module Godmin
   mattr_accessor :namespace
   self.namespace = nil
 
-  mattr_accessor :resources
-  self.resources = []
-
   def self.configure
     yield self
   end

data/lib/godmin/application_controller.rb

@@ -1,5 +1,6 @@
 require "godmin/helpers/application"
 require "godmin/helpers/forms"
+require "godmin/helpers/navigation"
 require "godmin/helpers/translations"
 
 module Godmin
@@ -11,6 +12,7 @@ module Godmin
 
       helper Godmin::Helpers::Application
       helper Godmin::Helpers::Forms
+      helper Godmin::Helpers::Navigation
       helper Godmin::Helpers::Translations
 
       helper_method :authentication_enabled?

data/lib/godmin/helpers/navigation.rb

@@ -0,0 +1,52 @@
+module Godmin
+  module Helpers
+    module Navigation
+      def navbar_item(resource, url = resource, show: nil, icon: nil, **options)
+        show ||= lambda do
+          resource.is_a?(String) ? true : policy(resource).index?
+        end
+
+        return unless show.call
+
+        link_text =
+          if block_given?
+            capture do
+              yield
+            end
+          else
+            resource.respond_to?(:model_name) ? resource.model_name.human(count: :many) : resource
+          end
+
+        content_tag :li do
+          link_to url, options do
+            if icon.present?
+              concat content_tag :span, "", class: "glyphicon glyphicon-#{icon}"
+              concat " "
+            end
+            concat link_text
+          end
+        end
+      end
+
+      def navbar_dropdown(title)
+        dropdown_toggle = link_to "#", class: "dropdown-toggle", data: { toggle: "dropdown" } do
+          concat "#{title} "
+          concat content_tag :span, "", class: "caret"
+        end
+
+        dropdown_menu = content_tag :ul, class: "dropdown-menu" do
+          yield
+        end
+
+        content_tag :li, class: "dropdown" do
+          concat dropdown_toggle
+          concat dropdown_menu
+        end
+      end
+
+      def navbar_divider
+        content_tag :li, "", class: "divider"
+      end
+    end
+  end
+end

data/lib/godmin/version.rb

@@ -1,3 +1,3 @@
 module Godmin
-  VERSION = "0.11.2"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: godmin
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
 platform: ruby
 authors:
 - Jens Ljungblad
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -207,6 +207,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -244,6 +245,7 @@ files:
 - app/views/godmin/resource/show.json.jbuilder
 - app/views/godmin/sessions/new.html.erb
 - app/views/godmin/shared/_navigation.html.erb
+- app/views/godmin/shared/_navigation_aside.html.erb
 - app/views/layouts/godmin/_content.html.erb
 - app/views/layouts/godmin/_layout.html.erb
 - app/views/layouts/godmin/application.html.erb
@@ -275,10 +277,10 @@ files:
 - lib/godmin/helpers/batch_actions.rb
 - lib/godmin/helpers/filters.rb
 - lib/godmin/helpers/forms.rb
+- lib/godmin/helpers/navigation.rb
 - lib/godmin/helpers/tables.rb
 - lib/godmin/helpers/translations.rb
 - lib/godmin/paginator.rb
-- lib/godmin/rails.rb
 - lib/godmin/resolver.rb
 - lib/godmin/resources/resource_controller.rb
 - lib/godmin/resources/resource_service.rb

data/lib/godmin/rails.rb

@@ -1,31 +0,0 @@
-module ActionDispatch::Routing
-  class Mapper
-    def godmin
-      override_resources do
-        yield
-      end
-
-      unless has_named_route?(:root)
-        root to: "application#welcome"
-      end
-    end
-
-    private
-
-    def override_resources
-      def resources(*resources)
-        unless Godmin.resources.include?(resources.first)
-          Godmin.resources << resources.first
-        end
-
-        super
-      end
-
-      yield
-
-      def resources(*resources, &block)
-        super(*resources, &block)
-      end
-    end
-  end
-end