godmin 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8d8456ed97a4b0447080f6faecfcb647dec74de
-  data.tar.gz: 80c9d86243368a78a4f40d9b684a3aabb90c396a
+  metadata.gz: 19ea145e85a221046da2c5f9bac8653bf16fa24f
+  data.tar.gz: 9fa954f22350d6891ba27cbc999f6f54572fbbb8
 SHA512:
-  metadata.gz: 33c8e7b29d921d19f61057f023ffb15987fe9bee65c4544a2ec77b834d9a7c8775765d56c5ec3e91ae8601b11ad94c532c1664676d6e7e7b6b4c84ea30acd076
-  data.tar.gz: 8dcccc5c59e0b6b7890694ca06d9075779387aebc1a13f21122be7f4af97f491da77e4fd6c13b33ccfbd1fd7a7e78073afd33ec83d04e89079046a037a900e0a
+  metadata.gz: 8468f4af31b9a57d6cf81429294e7d97140cd9609c607af195c792d9971b84138ec3fddab1259115de77b38a0404bf4538d368e023ba07ef350d22c802cc6dc7
+  data.tar.gz: c4d0f3a0f7dd3e76a7909682d0e40aa6f3b97a61746e72673ab1a724def65863cf2905a59c8d646b62f9ba823e456c2ccec2cf070573c54bf16d485210c74e9f

data/.rubocop.yml

@@ -10,6 +10,9 @@ Metrics/LineLength:
 Metrics/ClassLength:
   Max: 300
 
+Metrics/ModuleLength:
+  Max: 300
+
 Metrics/MethodLength:
   Max: 25
 

data/.travis.yml

@@ -7,6 +7,7 @@ cache: bundler
 rvm:
   - 2.0.0
   - 2.1
+  - 2.2
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+### 1.1.0 - 2015-12-08
+Features
+- Adds locale for pt-BR (Brazilian Portuguese) (https://github.com/varvet/godmin/pull/141)
+- New sandbox template with with more examples (https://github.com/varvet/godmin/pull/135)
+- Permits belongs to association by default (https://github.com/varvet/godmin/pull/149)
+- Enables responsive design (https://github.com/varvet/godmin/pull/146)
+- Batch actions now receive a relation instead of an array (https://github.com/varvet/godmin/pull/158)
+
+Bug fixes
+- Fixes a bug that masked errors in templates with a template not found error (https://github.com/varvet/godmin/pull/142)
+- Fixes a namespace issue with the authentication generator (https://github.com/varvet/godmin/pull/150)
+
 ### 1.0.0 - 2015-11-13
 Release of 1.0.0 :tada:
 

data/README.md

@@ -168,6 +168,11 @@ Using `attrs_for_index` we can control what fields are displayed in the table li
 attrs_for_form :title, :body, :published
 ```
 
+For quick prototyping, we could build the parameters this way (if appropriate).
+```ruby
+attrs_for_show *Article.column_names
+```
+
 By now we have a basic admin interface for managing articles.
 
 ## Resources
@@ -213,7 +218,7 @@ class ArticleService
 end
 ```
 
-There are four types of filters: `string`, `select`, `multiselect` and `checkboxes`, specified using the `as` parameter.
+There are three types of filters: `string`, `select` and `multiselect`, specified using the `as` parameter.
 
 When using `select` or `multiselect`, a collection must be specified. The collection must conform to the format used by Rails `options_for_select` helpers. It can be either an array consisting of name/value tuples, or a collection of ActiveRecords.
 
@@ -295,7 +300,7 @@ class ArticleService
 end
 ```
 
-To scope resources, e.g. based on the signed in user:
+To scope resources for quering and building, e.g. based on the signed in user:
 
 ```ruby
 class ArticleService
@@ -303,19 +308,19 @@ class ArticleService
 
   # The signed in admin user is available to all service objects via the options hash
   def resources_relation
-    options[:admin_user].articles
+    super.where(user: options[:admin_user])
   end
 end
 ```
 
-To add to the resources query, e.g. to change the default order:
+To add to the index page resources query, e.g. to change the default order:
 
 ```ruby
 class ArticleService
   include Godmin::Resources::ResourceService
 
-  def resources
-    super.order(author: :desc)
+  def resources(params)
+    super(params).order(author: :desc)
   end
 end
 ```
@@ -401,6 +406,36 @@ class ArticlesController < ApplicationController
 end
 ```
 
+#### Passing parameters to the service object
+
+Sometimes you want to pass additional params to the service object, other that those passed in `resource_params`. In order to do this, you need to pass them along when initializing the service object in the controller:
+
+```ruby
+class ArticlesController < ApplicationController
+  include Godmin::Resources::ResourceController
+
+  private
+
+  def resource_service
+    service = super
+    service.options[:some_param] = params[:some_param]
+    service
+  end
+end
+```
+
+You can then access it from the service object:
+
+```ruby
+class ArticleService
+  include Godmin::Resources::ResourceService
+
+  def some_method
+    options[:some_param]
+  end
+end
+```
+
 ### Redirecting
 
 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`.
@@ -481,6 +516,13 @@ end
 
 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`.
 
+You can also inherit from the default template as such:
+```ruby
+<%= render template: 'godmin/resource/show' %>
+
+<p>Append stuff here</p>
+```
+
 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.
 
 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).
@@ -737,12 +779,12 @@ end
 ```
 
 ### Batch action authorization
-Batch actions must be authorized in your policy if you are using Godmin's built in authorization functionality. The policy method is called once for each record before they are passed to the batch action method defined by the user. If a user is not allowed to "batch action" a particular record, it will be filtered out before passed to the batch action method. Note that this does not raise any `NotAuthorizedError`.
+Batch actions must be authorized in your policy if you are using Godmin's built in authorization functionality. The policy method is called with the relation containing all records to be processed.
 
 ```ruby
 class ArticlePolicy < Godmin::Authorization::Policy
   def batch_action_destroy?
-    @record.user_id == user.id
+    record.all? { |r| r.user_id == user.id }
   end
 end
 ```
@@ -832,6 +874,14 @@ If you wish to translate the datetimepicker, change `moment/en-gb` in your `app/
 
 Please note that the datepickers default to en-GB, not en-US, because Rails cannot automatically parse en-US dates.
 
+To use an alternative format, use the format option.
+
+```js
+Godmin.Datetimepickers.initializeDatepicker($elems, {
+  format: 'YYYY-MM-DD'
+});
+```
+
 ### Select boxes
 
 Make a [selectize.js](http://brianreavis.github.io/selectize.js/) select box out of a text field or select box:

data/Rakefile

@@ -1,34 +1,63 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Godmin'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Godmin"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
+load "rails/tasks/engine.rake"
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
-
 task default: :test
+
+namespace :sandbox do
+  desc "Push the sandbox app to GitHub which deploys it to Heroku"
+  task :deploy do
+    message = "Generated from: https://github.com/varvet/godmin/commit/#{`git rev-parse HEAD`.strip}"
+    template_path = File.expand_path("../template.rb", __FILE__)
+    Bundler.with_clean_env do
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir)
+        system("git clone git@github.com:varvet/godmin-sandbox.git")
+        if $CHILD_STATUS.success?
+          Dir.chdir("godmin-sandbox")
+          system("rm -rf *")
+          system("rails new . -d postgresql -m #{template_path} --without-engine")
+          if $CHILD_STATUS.success?
+            system("git add --all")
+            system("git commit -m '#{message}'")
+            system("git push origin master")
+          end
+        end
+      end
+    end
+  end
+
+  desc "Empty and reseed the database on Heroku"
+  task :reseed do
+    app = "godmin-sandbox"
+    Bundler.with_clean_env do
+      system("heroku run rake sandbox:reseed --app #{app}")
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 <%= render partial: "breadcrumb" %>
 
-<table class="table table-bordere table-striped">
+<table class="table table-striped">
   <% @resource_service.attrs_for_show.each do |attr| %>
     <tr>
       <th><%= @resource_class.human_attribute_name(attr) %></th>

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

@@ -5,6 +5,7 @@
     <%= 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 %>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
     <%= yield :head %>
   </head>
   <body>

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

@@ -2,9 +2,15 @@
   <nav class="navbar navbar-default navbar-static-top" role="navigation">
     <div class="container">
       <div class="navbar-header">
+        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#godmin-navbar-collapse" aria-expanded="false">
+          <span class="sr-only">Toggle navigation</span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
         <%= link_to t("godmin.title"), root_path, class: "navbar-brand" %>
       </div>
-      <div class="collapse navbar-collapse">
+      <div class="collapse navbar-collapse" id="godmin-navbar-collapse">
         <ul class="nav navbar-nav">
           <%= render partial: File.join(engine_wrapper.namespaced_path, "shared/navigation") %>
         </ul>

data/config/locales/en.yml

@@ -32,7 +32,7 @@ en:
       create: "%{resource} was successfully created"
       update: "%{resource} was successfully updated"
       destroy: "%{resource} was successfully destroyed"
-      batch_action: "%{number_of_affected_records} of %{total_number_of_records} %{resource} were affected"
+      batch_action: "%{number_of_records} %{resource} were affected"
     pagination:
       first: "First"
       last: "Last"

data/config/locales/pt-BR.yml

@@ -0,0 +1,44 @@
+pt-BR:
+  godmin:
+    title: Godmin
+    batch_actions:
+      buttons:
+        select_all: Selecionar todos
+        deselect_all: Remover seleção
+      confirm_message: Você tem certeza?
+    filters:
+      select:
+        placeholder:
+          one: Selecionar um
+          many: Selecionar vários
+      buttons:
+        apply: Filtrar
+        clear: Limpar filtro
+    actions:
+      label: Ações
+      show: Exibir
+      edit: Editar
+      destroy: Remover
+      confirm_message: Você tem certeza?
+      export: Exportar
+      export_as: Como
+    sessions:
+      sign_in: Entrar
+      sign_out: Sair
+      signed_in: Conectado
+      signed_out: Desconectado
+      failed_sign_in: Credenciais inválidas
+    flash:
+      create: "%{resource} foi criado com sucesso"
+      update: "%{resource} foi atualizado com sucesso"
+      destroy: "%{resource} foi removido com sucesso"
+      batch_action: "%{number_of_records} %{resource} foram modificados"
+    pagination:
+      first: "Primeiro"
+      last: "Último"
+      entries:
+        zero: "Nenhum %{resource} encontrado"
+        other: "Exibindo %{count} de %{total} %{resource}"
+    datetimepickers:
+      datepicker: ! "%d/%m/%Y"
+      datetimepicker: ! "%d/%m/%Y %H:%M"

data/config/locales/sv.yml

@@ -32,7 +32,7 @@ sv:
       create: "%{resource} skapades"
       update: "%{resource} uppdaterades"
       destroy: "%{resource} togs bort"
-      batch_action: "%{number_of_affected_records} av %{total_number_of_records} %{resource} påverkades"
+      batch_action: "%{number_of_records} %{resource} påverkades"
     pagination:
       first: "Första"
       last: "Sista"

data/godmin.gemspec

@@ -32,8 +32,9 @@ Gem::Specification.new do |gem|
 
   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 "minitest"
+  gem.add_development_dependency "poltergeist"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "sqlite3"
 end

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

@@ -33,7 +33,7 @@ class Godmin::AuthenticationGenerator < Godmin::Generators::NamedBase
         include Godmin::Authentication
 
         def admin_user_class
-          #{class_name}
+          #{full_class_name}
         end
       END
     end

data/lib/godmin/application_controller.rb

@@ -33,7 +33,7 @@ module Godmin
     end
 
     def append_view_paths
-      append_view_path Godmin::Resolver.new(controller_path, engine_wrapper)
+      append_view_path Godmin::Resolver.resolvers(controller_path, engine_wrapper)
     end
 
     def authentication_enabled?

data/lib/godmin/generators/named_base.rb

@@ -7,6 +7,14 @@ module Godmin
 
       private
 
+      def full_class_name
+        if namespace
+          "#{namespace}::#{class_name}"
+        else
+          class_name
+        end
+      end
+
       def class_name
         @class_name ||= name.classify
       end

data/lib/godmin/resolver.rb

@@ -1,7 +1,14 @@
 module Godmin
   class Resolver < ::ActionView::FileSystemResolver
-    def initialize(controller_path, engine_wrapper)
-      super ""
+    def self.resolvers(controller_path, engine_wrapper)
+      [
+        EngineResolver.new(controller_path, engine_wrapper),
+        GodminResolver.new(controller_path, engine_wrapper)
+      ]
+    end
+
+    def initialize(path, controller_path, engine_wrapper)
+      super(path)
       @controller_path = controller_path
       @engine_wrapper = engine_wrapper
     end
@@ -19,34 +26,53 @@ module Godmin
 
       templates
     end
+  end
+
+  # Matches templates such as:
+  #
+  # { name: index, prefix: articles } => app/views/resource/index
+  # { name: form, prefix: articles }  => app/views/resource/_form
+  # { name: title, prefix: columns }  => app/views/resource/columns/_title
+  class EngineResolver < Resolver
+    def initialize(controller_path, engine_wrapper)
+      super(File.join(engine_wrapper.root, "app/views"), controller_path, engine_wrapper)
+    end
 
-    # 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)
       [
-        File.join(@engine_wrapper.root, "app/views", resource_path_for_engine(prefix)),
-        File.join(Godmin::Engine.root, "app/views/godmin", default_path_for_godmin(prefix)),
-        File.join(Godmin::Engine.root, "app/views/godmin", resource_path_for_godmin(prefix))
+        resource_path_for_engine(prefix)
       ]
     end
 
-    private
-
     def resource_path_for_engine(prefix)
-      prefix.sub(/\A#{@controller_path}/, File.join(@engine_wrapper.namespaced_path, "resource"))
+      prefix.sub(/\A#{@controller_path}/, File.join(@engine_wrapper.namespaced_path, "resource")).sub(/\A\//, "")
     end
+  end
 
-    def resource_path_for_godmin(prefix)
-      prefix.sub(/\A#{@controller_path}/, "resource")
+  # Matches templates such as:
+  #
+  # { name: index, prefix: articles }      => godmin/app/views/godmin/resource/index
+  # { name: form, prefix: articles }       => godmin/app/views/godmin/resource/_form
+  # { name: welcome, prefix: application } => godmin/app/views/godmin/application/welcome
+  # { name: navigation, prefix: shared }   => godmin/app/views/godmin/shared/navigation
+  class GodminResolver < Resolver
+    def initialize(controller_path, engine_wrapper)
+      super(File.join(Godmin::Engine.root, "app/views/godmin"), controller_path, engine_wrapper)
+    end
+
+    def template_paths(prefix)
+      [
+        default_path_for_godmin(prefix),
+        resource_path_for_godmin(prefix)
+      ]
     end
 
     def default_path_for_godmin(prefix)
-      prefix.sub(/\A#{File.join(@engine_wrapper.namespaced_path)}/, "")
+      prefix.sub(/\A#{File.join(@engine_wrapper.namespaced_path)}/, "").sub(/\A\//, "")
+    end
+
+    def resource_path_for_godmin(prefix)
+      prefix.sub(/\A#{@controller_path}/, "resource").sub(/\A\//, "")
     end
   end
 end