godmin 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 142e127c459d99fcaffc7277c23302b39ed55fdd
-  data.tar.gz: 0d33f7c04855780ceb0b20fc48fbe5e226cc738a
+  metadata.gz: b77a64dfd0387ecd63d1b0dc2259a977cefcb664
+  data.tar.gz: a97772f66980a9d1d9def89509f1d24868337bf0
 SHA512:
-  metadata.gz: ce10bc5fc5b5cebe832a9fb95da78c8a37c7121f3e1b1efd6b1494a76e72b8a458e62c3032925a7cc31e2d57c7e31a7400955c91aaddc49aafaacb39d31f7bb0
-  data.tar.gz: e6a2b6e898e3a7e5280cef2f4ffa6edcde3b9af2411e84308abff1680bca9a7af5ba6cd01e724111c5c7b32927574a0101382a704e01047c4061fa2dfc29e789
+  metadata.gz: 5baf4c943138e0fc2195ca47c710ac0d4a7d4892564ae6a9c3bfedaca6fa7a650a892b12a14e7ba021d4a34db73e4b458fca4c1f5612bf84d83c3a46a48c5e32
+  data.tar.gz: 924ead99ee3ff13a41c58d10f5dc5bf5b5c2857e8144c28643461e1ff271841e2f770d56fd4b2665d1b32ed5033c243bc4c86fed7a6811dc54a544deaaef66d4

data/.gitignore

@@ -21,6 +21,7 @@ config/initializers/secret_token.rb
 .DS_Store
 *.swp
 /test/dummy/log/*
+/test/dummy/tmp/*
 /test/dummy/db/*.sqlite3
 Gemfile.lock
 tags

data/.travis.yml

@@ -1,7 +1,13 @@
 bundler_args: --without debug
 
 script: "bundle exec rake test"
+sudo: false
+cache: bundler
 
 rvm:
   - 2.0.0
   - 2.1
+
+addons:
+  code_climate:
+    repo_token: 7e7ee66c976bdfe7a0d40d41958b97a1cf8a03b0462df5cba415f624c07c2071

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+### 0.12.1 - 2015-09-07
+Bug fixes
+- Fixes issue where column ordering on index table didn't work (https://github.com/varvet/godmin/issues/124)
+
+Other
+- Adds integration tests
+- Removes the namespace config in `initializers/godmin.rb`
+
+In order to upgrade:
+- Remove the `initializers/godmin.rb` file
+
 ### 0.12.0 - 2015-06-30
 Features
 - Adds new navigation helpers for building a custom navbar (https://github.com/varvet/godmin/issues/54)

data/Gemfile

@@ -9,3 +9,8 @@ gemspec
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
+
+# The dummy app loads whatever is specified in this gemfile, therefore
+# we add the admin engine used by the dummy app here
+gem "admin", path: "test/dummy/admin", group: [:test, :development]
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -3,8 +3,11 @@
 [![Gem Version](http://img.shields.io/gem/v/godmin.svg)](https://rubygems.org/gems/godmin)
 [![Build Status](https://img.shields.io/travis/varvet/godmin/master.svg)](https://travis-ci.org/varvet/godmin)
 [![Code Climate](https://img.shields.io/codeclimate/github/varvet/godmin.svg)](https://codeclimate.com/github/varvet/godmin)
+[![Test Coverage](https://codeclimate.com/github/varvet/godmin/badges/coverage.svg)](https://codeclimate.com/github/varvet/godmin/coverage)
 
-Godmin is an admin framework for Rails 4+.
+Godmin is an admin framework for Rails 4+. Use it to build dedicated admin sections for your apps, or stand alone admin apps such as internal tools. It has support for common features such as scoping, filtering and performing batch actions on your models.
+
+Godmin differs from tools like [ActiveAdmin](http://activeadmin.info/) and [RailsAdmin](https://github.com/sferik/rails_admin) in how admin sections are created. Rather than being DSL-based, Godmin is a set of opt-in modules and helpers that can be applied to regular Rails apps and engines. An admin section built with Godmin is just that, a regular Rails app or Rails engine, with regular routes, controllers and views. That means there is less to learn, because you already know most of it, and fewer constraints on what you can do. After all, administrators are users too, and what better way to provide them with a tailor made experience than building them a Rails app?
 
 ![Screenshot](https://raw.githubusercontent.com/varvet/godmin/master/screenshot.png)
 
@@ -23,7 +26,7 @@ Godmin is an admin framework for Rails 4+.
 	- [Exporting](#exporting)
 - [Views](#views)
   - [Forms](#forms)
-	- [Navigation](#navigation)
+  - [Navigation](#navigation)
 - [Authentication](#authentication)
 	- [Built in authentication](#built-in-authentication)
 	- [Shared authentication](#shared-authentication)
@@ -92,15 +95,6 @@ Godmin should be up and running at `localhost:3000/admin`
 
 Installing Godmin does a number of things to the Rails application.
 
-A `config/initializers/godmin.rb` is created:
-```ruby
-Godmin.configure do |config|
-  config.namespace = nil
-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 application controller is modified as such:
 ```ruby
 class ApplicationController < ActionController::Base

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

@@ -1,10 +1,10 @@
 <div class="row">
-  <div class="col-md-8">
+  <div class="col-md-6 col-md-offset-3">
     <div class="jumbotron">
-      <h1>Welcome aboard</h1>
+      <h1>Welcome</h1>
       <p>
-        You are now experiencing, first-hand, the power of Godmin:
-        an admin framework for Rails 4+, tweakable to the max.
+        You are running Godmin <%= Godmin::VERSION %>.
+        Add your own root route to the routes file in order to remove this page.
       </p>
       <p>
         <a href="https://github.com/varvet/godmin/" class="btn btn-primary btn-lg" role="button">
@@ -13,53 +13,5 @@
         </a>
       </p>
     </div>
-    <div class="row">
-      <div class="col-md-6">
-        <div class="panel panel-default">
-          <div class="panel-heading">Scopes</div>
-          <div class="panel-body">
-            <p>Scopes are a way of sectioning resources, useful for quick navigation.</p>
-            <%= link_to "Read more about scopes", "#" %>
-          </div>
-        </div>
-      </div>
-      <div class="col-md-6">
-        <div class="panel panel-default">
-          <div class="panel-heading">Filters</div>
-          <div class="panel-body">
-            <p>Filters offer great flexibility when it comes to searching for resources.</p>
-            <%= link_to "Read more about filters", "#" %>
-          </div>
-        </div>
-      </div>
-    </div>
-    <div class="row">
-      <div class="col-md-6">
-        <div class="panel panel-default">
-          <div class="panel-heading">Batch actions</div>
-          <div class="panel-body">
-            <p>Batch actions are an easy way to perform the same action on multiple resources.</p>
-            <%= link_to "Read more about batch actions", "#" %>
-          </div>
-        </div>
-      </div>
-      <div class="col-md-6">
-        <div class="panel panel-default">
-          <div class="panel-heading">Resource fetching</div>
-          <div class="panel-body">
-            <p>Control which resources to fetch, and apply arbitrary conditions, such as sorting.</p>
-            <%= link_to "Read more about resource fetching", "#" %>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-  <div class="col-md-4">
-    <div class="panel panel-default">
-      <div class="panel-heading">Version</div>
-      <div class="panel-body">
-        You are running Godmin <%= Godmin::VERSION %>
-      </div>
-    </div>
   </div>
 </div>

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

@@ -6,7 +6,7 @@
         <%= f.hidden_field :order, value: params[:order] %>
 
         <% @resource_service.filter_map.each do |name, options| %>
-          <%= partial_override "filters/#{name}", f: f, name: name, options: options do %>
+          <%= partial_override "#{controller_path}/filters/#{name}", f: f, name: name, options: options do %>
             <%= f.filter_field(name, options) %>
           <% end %>
         <% end %>

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

@@ -6,7 +6,7 @@
           <th></th>
         <% end %>
         <% @resource_service.attrs_for_index.each do |attr| %>
-          <th>
+          <th class="column-<%= attr %>">
             <%= column_header attr %>
           </th>
         <% end %>
@@ -28,7 +28,7 @@
             </td>
           <% end %>
           <td>
-            <%= render partial: "columns/actions", locals: { resource: resource } %>
+            <%= render partial: "#{controller_path}/columns/actions", locals: { resource: resource } %>
           </td>
         </tr>
       <% end %>

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

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

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

@@ -6,10 +6,10 @@
       </div>
       <div class="collapse navbar-collapse">
         <ul class="nav navbar-nav">
-          <%= render partial: "shared/navigation" %>
+          <%= render partial: File.join(engine_wrapper.namespaced_path, "shared/navigation") %>
         </ul>
         <ul class="nav navbar-nav navbar-right">
-          <%= render partial: "shared/navigation_aside" %>
+          <%= render partial: File.join(engine_wrapper.namespaced_path, "shared/navigation_aside") %>
         </ul>
       </div>
     </div>

data/godmin.gemspec

@@ -24,13 +24,16 @@ Gem::Specification.new do |gem|
   gem.add_dependency "bootstrap_form", "~> 2.2.0"
   gem.add_dependency "coffee-rails", [">= 4.0", "< 4.2"]
   gem.add_dependency "csv_builder", "~> 2.1.1"
+  gem.add_dependency "jquery-rails", ">= 3.0"
   gem.add_dependency "momentjs-rails", ">= 2.8.1"
   gem.add_dependency "rails", "~> 4.0"
   gem.add_dependency "sass-rails", ">= 4.0"
   gem.add_dependency "selectize-rails", "~> 0.12.0"
 
-  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "m"
   gem.add_development_dependency "minitest"
   gem.add_development_dependency "minitest-reporters"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "sqlite3"
 end

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

@@ -1,16 +1,6 @@
 require "godmin/generators/base"
 
 class Godmin::InstallGenerator < Godmin::Generators::Base
-  def create_initializer
-    create_file "config/initializers/godmin.rb" do
-      <<-END.strip_heredoc
-        Godmin.configure do |config|
-          config.namespace = #{namespace ? "\"#{namespaced_path.join("/")}\"" : "nil"}
-        end
-      END
-    end
-  end
-
   def create_routes
     inject_into_file "config/routes.rb", before: /^end/ do
       <<-END.strip_heredoc.indent(2)

data/lib/godmin.rb

@@ -1,12 +1,15 @@
 require "bootstrap-sass"
 require "bootstrap_form"
 require "csv_builder"
+require "jquery-rails"
 require "momentjs-rails"
+require "sass-rails"
 require "selectize-rails"
 require "godmin/application_controller"
 require "godmin/authentication"
 require "godmin/authorization"
 require "godmin/engine"
+require "godmin/engine_wrapper"
 require "godmin/paginator"
 require "godmin/resolver"
 require "godmin/resources/resource_controller"
@@ -14,10 +17,4 @@ require "godmin/resources/resource_service"
 require "godmin/version"
 
 module Godmin
-  mattr_accessor :namespace
-  self.namespace = nil
-
-  def self.configure
-    yield self
-  end
 end

data/lib/godmin/application_controller.rb

@@ -17,8 +17,9 @@ module Godmin
 
       helper_method :authentication_enabled?
       helper_method :authorization_enabled?
+      helper_method :engine_wrapper
 
-      before_action :prepend_view_paths
+      before_action :append_view_paths
 
       layout "godmin/application"
     end
@@ -27,9 +28,12 @@ module Godmin
 
     private
 
-    def prepend_view_paths
-      prepend_view_path Godmin::GodminResolver.new(controller_name)
-      prepend_view_path Godmin::EngineResolver.new(controller_name)
+    def engine_wrapper
+      EngineWrapper.new(self.class)
+    end
+
+    def append_view_paths
+      append_view_path Godmin::Resolver.new(controller_path, engine_wrapper)
     end
 
     def authentication_enabled?

data/lib/godmin/authorization.rb

@@ -22,7 +22,7 @@ module Godmin
     end
 
     def policy(record)
-      policies[record] ||= PolicyFinder.find(record).new(admin_user, record)
+      policies[record] ||= PolicyFinder.find(record, engine_wrapper.namespace).new(admin_user, record)
     end
 
     def policies

data/lib/godmin/authorization/policy_finder.rb

@@ -2,9 +2,10 @@ module Godmin
   module Authorization
     class PolicyFinder
       class << self
-        def find(object)
+        def find(object, namespace = nil)
           return object.policy_class if object.respond_to?(:policy_class)
           return object.class.policy_class if object.class.respond_to?(:policy_class)
+
           klass =
             if object.respond_to?(:model_name)
               object.model_name
@@ -18,8 +19,8 @@ module Godmin
               object.class
             end
 
-          if Godmin.namespace
-            "#{Godmin.namespace.classify}::#{klass}Policy"
+          if namespace
+            "#{namespace}::#{klass}Policy"
           else
             "#{klass}Policy"
           end.constantize

data/lib/godmin/engine_wrapper.rb

@@ -0,0 +1,49 @@
+module Godmin
+  class EngineWrapper
+    attr_reader :engine
+
+    def initialize(controller)
+      @engine = find_engine(controller)
+    end
+
+    def namespace
+      @namespace ||= engine.railtie_namespace
+    end
+
+    def namespaced?
+      @namespaced ||= namespace.present?
+    end
+
+    def namespaced_path
+      @namespaced_path ||= begin
+        if namespaced?
+          namespace.name.classify.split("::").map(&:underscore)
+        else
+          []
+        end
+      end
+    end
+
+    def root
+      engine.root
+    end
+
+    private
+
+    def find_engine(controller)
+      engine_module = find_engine_module(controller)
+
+      if engine_module
+        "#{engine_module}::Engine".constantize
+      else
+        Rails.application
+      end
+    end
+
+    def find_engine_module(controller)
+      controller.parents.find do |parent|
+        parent.respond_to?(:use_relative_model_naming?) && parent.use_relative_model_naming?
+      end
+    end
+  end
+end

data/lib/godmin/helpers/tables.rb

@@ -4,11 +4,11 @@ module Godmin
       def column_header(attribute)
         if @resource_class.column_names.include?(attribute.to_s)
           direction =
-            if params[:order]
-              if params[:order].split("_").first == attribute.to_s
-                params[:order].split("_").last == "desc" ? "asc" : "desc"
-              else
-                params[:order].split("_").last
+            if params[:order].present?
+              if params[:order].match(/\A#{attribute.to_s}_(asc|desc)\z/)
+                $1 == "desc" ? "asc" : "desc"
+              elsif params[:order].match(/\A\w+_(asc|desc)\z/)
+                $1
               end
             else
               "desc"
@@ -20,7 +20,7 @@ module Godmin
       end
 
       def column_value(resource, attribute)
-        partial_override "columns/#{attribute}", resource: resource do
+        partial_override "#{controller_path}/columns/#{attribute}", resource: resource do
           column_value = resource.send(attribute)
 
           if column_value.is_a?(Date) || column_value.is_a?(Time)

data/lib/godmin/resolver.rb

@@ -1,56 +1,52 @@
 module Godmin
   class Resolver < ::ActionView::FileSystemResolver
-    attr_accessor :namespace, :controller_name
+    def initialize(controller_path, engine_wrapper)
+      super ""
+      @controller_path = controller_path
+      @engine_wrapper = engine_wrapper
+    end
 
     def find_templates(name, prefix, partial, details)
-      template = []
-
-      template_paths(prefix, partial).each do |path|
-        template = super(name, path, partial, details)
-
-        break if template.present?
+      templates = []
+
+      template_paths(prefix).each do |path|
+        if templates.present?
+          break
+        else
+          templates = super(name, path, partial, details)
+        end
       end
 
-      template
+      templates
     end
 
-    def template_paths(prefix, _partial)
-      prefix = clean_prefix(prefix)
+    # Matches templates such as:
+    #
+    # { name: index, prefix: articles }      => [app/views/resource/index, godmin/app/views/godmin/resource/index]
+    # { name: form, prefix: articles }       => [app/views/resource/_form, godmin/app/views/godmin/resource/_form]
+    # { name: title, prefix: columns }       => [app/views/resource/columns/_title]
+    # { name: welcome, prefix: application } => [godmin/app/views/godmin/application/welcome]
+    # { name: navigation, prefix: shared }   => [godmin/app/views/godmin/shared/navigation]
+    def template_paths(prefix)
       [
-        [namespace, controller_name, prefix],
-        [namespace, controller_name],
-        [namespace, prefix],
-        [namespace, "resource", prefix],
-        [namespace, "resource"],
-        [namespace]
-      ].map { |path| path.compact.join("/") }.compact
+        File.join(@engine_wrapper.root, "app/views", resource_path_for_engine(prefix)),
+        File.join(Godmin::Engine.root, "app/views/godmin", resource_path_for_godmin(prefix)),
+        File.join(Godmin::Engine.root, "app/views/godmin", default_path_for_godmin(prefix))
+      ]
     end
 
     private
 
-    def clean_prefix(prefix)
-      prefix.gsub(/^#{namespace}\//, "")
+    def resource_path_for_engine(prefix)
+      prefix.sub(/\A#{@controller_path}/, File.join(@engine_wrapper.namespaced_path, "resource"))
     end
-  end
 
-  class EngineResolver < Resolver
-    def initialize(controller_name)
-      super [Godmin.namespace, "app/views"].compact.join("/")
-      self.namespace = Godmin.namespace
-      self.controller_name = controller_name
+    def resource_path_for_godmin(prefix)
+      prefix.sub(/\A#{@controller_path}/, "resource")
     end
 
-    def template_paths(prefix, _partial)
-      return [] if prefix =~ /^godmin\//
-      super
-    end
-  end
-
-  class GodminResolver < Resolver
-    def initialize(controller_name)
-      super [Godmin::Engine.root, "app/views"].compact.join("/")
-      self.namespace = "godmin"
-      self.controller_name = controller_name
+    def default_path_for_godmin(prefix)
+      prefix.sub(/\A#{File.join(@engine_wrapper.namespaced_path)}/, "")
     end
   end
 end