adminable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c8c3f78e6cda87d730a35355df1313ab3fd7674
-  data.tar.gz: 95a90979dce955f6408263afeb5b163a8e0104e5
+  metadata.gz: f528b224feece004bb0e267e9d3c7c59fc8cb82c
+  data.tar.gz: 1cef3dc442b2ac04713f0695762429afdf0b4637
 SHA512:
-  metadata.gz: 7fd364eb2250b70f05ff858899bbb8fe836d338d2c568808211d3f1c4390ace87d04b7f7a3eaea610f96d1d9a8b0b8ba5ebdd1112fcef180cb205f0f181ac2f9
-  data.tar.gz: e6b5dd483ccd126c981c3e0656fb8a02fff620937d1279f395400a6bd17267f7ea0c84d2f89a4e64d59c64561a16c33844bc331a1fa39a9795695f329ea9f5d8
+  metadata.gz: a463389478cd68106b2e48567d1efe341f6aff36f087b5c0067e5d84d42c825ca020bae79b6650c3158b4433f00767582c5c2357435fb717c77f2dd33e7b6276
+  data.tar.gz: de6a89ee40356740af5537167d0411cca5c922323339ff38a2d6be3c55b3264e2f3ab70e35194f1a48e3694db248aa32585e59df74a459bcd74f212616926d1e

data/README.md

@@ -1,15 +1,28 @@
 # Adminable
 
+[![Gem Version](https://badge.fury.io/rb/adminable.svg)](https://badge.fury.io/rb/adminable)
+[![Build Status](https://travis-ci.org/droptheplot/adminable.svg?branch=master)](https://travis-ci.org/droptheplot/adminable)
+[![Code Climate](https://codeclimate.com/github/droptheplot/adminable/badges/gpa.svg)](https://codeclimate.com/github/droptheplot/adminable)
+[![Test Coverage](https://codeclimate.com/github/droptheplot/adminable/badges/coverage.svg)](https://codeclimate.com/github/droptheplot/adminable/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/droptheplot/adminable.svg)](https://gemnasium.com/github.com/droptheplot/adminable)
+
+
 Simple admin interface for Ruby on Rails applications.
 
 ## Features
 
-* Built with common Rails controllers without DSL.
+* Built with common Rails controllers with a small DSL.
 * Supports namespaced models.
-* Has simple search with Ransack.
-* Uses Bootstrap 4.0.
+* Has simple search with [Ransack](https://github.com/activerecord-hackery/ransack).
+* Uses [Bootstrap](https://github.com/twbs/bootstrap) 4.0.
+* Handles a lot of associations with [Clusterize.js](https://github.com/NeXTs/Clusterize.js).
+* Has built-in WYSIWYG editor [TinyMCE](https://github.com/tinymce/tinymce).
 * Mobile friendly.
 
+![Example1](https://raw.githubusercontent.com/droptheplot/adminable/master/screenshots/1.png)
+
+![Example2](https://raw.githubusercontent.com/droptheplot/adminable/master/screenshots/2.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,55 +41,103 @@ Or install it yourself as:
 $ gem install adminable
 ```
 
-## Built-in Attributes
+## Getting Started
 
-List of attributes with default modifiable parameters.
+First things first. Add routes and create `application_controller.rb` class using generator:
 
-##### String
+```bash
+rails g adminable:install
+# => create app/controllers/adminable/application_controller.rb
+# => insert config/routes.rb
+```
 
-* show: `true`
-* center: `false`
+#### Generating Resources
 
-##### Text
+For example you have model `User`, then run:
 
-* show: `true`
-* center: `false`
-* wysiwyg: `true`
+```bash
+rails g adminable:resource user
+# => create  app/controllers/adminable/users_controller.rb
+```
 
-##### Integer
+For namespaced models, like `Blog::Post`, use:
 
-* show: `true`
-* center: `true`
+```bash
+rails g adminable:resource blog/post
+# => create  app/controllers/adminable/blog/posts_controller.rb
+```
 
-##### Float
+#### Customizing Attributes
 
-* show: `true`
-* center: `true`
+You can update attributes with simple DSL inside `set_attributes` block:
 
-##### Decimal
+##### For existing attributes
 
-* show: `true`
-* center: `true`
+```ruby
+  set(name, options = {})
+```
 
-##### DateTime
+##### For new attributes
 
-* show: `true`
-* center: `false`
+```ruby
+  add(name, type, options = {})
+```
+
+##### Attributes Parameters
+
+* `index` - *(true/false)* - Shows attribute on index page.
+* `form` - *(true/false)* - Shows attribute on new/edit page.
+* `center` - *(true/false)* - Adds `text-align: center` for attribute value on index page.
+* `search` - *(true/false)* - Enables search for this attribute.
+
+##### Examples
+
+```ruby
+class Adminable::Blog::PostsController < Adminable::ResourcesController
+  set_attributes do |attributes|
+    # Enables search for title column
+    attributes.set :title, search: true
+
+    # Hides title from new and edit pages
+    attributes.set :title, form: true
+
+    # Adds wysiwyg plugin and hides from index table
+    attributes.set :text, wysiwyg: true, index: false
 
-##### Boolean
+    # Adds new attribute `password` with type `string` and some options
+    attributes.add :password, :string, wysiwyg: true, index: false
 
-* show: `true`
-* center: `true`
+    # Adds new attribute `author`
+    attributes << Adminable::Attributes::Types::String.new(:author)
 
-##### Belongs To
+    # Allows search for multiple attributes
+    attributes.set :title, :body, search: true
+  end
+end
+```
+
+##### See Also
 
-* show: `true`
-* center: `false`
+* Configured controller for Devise model: [app/controllers/adminable/users_controller.rb](https://github.com/droptheplot/adminable/blob/master/spec/dummy/app/controllers/adminable/users_controller.rb)
 
-##### Has Many
+## Built-in Attributes
 
-* show: `true`
-* center: `false`
+List of attributes with default parameters.
+
+|            | index | form | center | wysiwyg |
+|------------|-------|------|--------|---------|
+| String     |   +   |   +  |        |         |
+| Text       |   +   |   +  |        |    +    |
+| Integer    |   +   |   +  |    +   |         |
+| Float      |   +   |   +  |    +   |         |
+| Decimal    |   +   |   +  |    +   |         |
+| Date       |   +   |   +  |        |         |
+| DateTime   |   +   |   +  |        |         |
+| Time       |   +   |   +  |        |         |
+| Timestamp  |   +   |   +  |        |         |
+| Boolean    |   +   |   +  |    +   |         |
+| Belongs To |       |   +  |        |         |
+| Has Many   |       |   +  |        |         |
 
 ## Contributing
 

data/app/assets/javascripts/adminable/scripts.js

@@ -4,12 +4,13 @@ $(document).ready(function() {
       scrollId: 'clusterizeScrollArea',
       contentId: 'clusterizeContentArea'
     });
-  };
+  }
 
-  $('.toggleCheckbox').click(function() {
-    var checkbox = $(this).children('input[type=checkbox]');
-    checkbox.prop('checked', !checkbox.prop('checked'));
-    $(this).toggleClass('active');
+  $('.uncheck-associations').click(function() {
+    var inputs = $(this).parent().next().next('.associations').find('input[type=radio], input[type=checkbox]');
+    inputs.each(function(index, value) {
+      value.checked = false;
+    });
   });
 
   tinymce.init({
@@ -17,4 +18,6 @@ $(document).ready(function() {
     menubar: false,
     statusbar: false
   });
+
+  $('[data-toggle="tooltip"]').tooltip();
 });

data/app/assets/stylesheets/adminable/application.scss

@@ -1,3 +1,18 @@
 $font-size-root: 14px !default;
 
 @import 'bootstrap';
+
+.associations {
+  border: 1px solid $input-border-color;
+  border-radius: $border-radius;
+  .association {
+    padding: .75rem;
+    &:not(:last-child) {
+      border-bottom: 1px solid $gray-lighter;
+    }
+  }
+}
+
+.uncheck-associations {
+  cursor: pointer;
+}

data/app/controllers/adminable/application_controller.rb

@@ -1,7 +1,4 @@
 module Adminable
   class ApplicationController < ActionController::Base
-    def welcome
-      redirect_to polymorphic_path(Adminable::Configuration.resources.first.route)
-    end
   end
 end

data/app/controllers/adminable/resources_controller.rb

@@ -1,17 +1,28 @@
 module Adminable
   class ResourcesController < ApplicationController
-    before_action :set_resource
+    def initialize(*)
+      @resource = Adminable::Configuration.find_resource(resource_model)
+
+      super
+    end
+
     before_action :set_entry, only: [:edit, :update, :destroy]
 
     before_action do
-      append_view_path Adminable::Engine.root.join('app/views/adminable', controller_name)
-      append_view_path Adminable::Engine.root.join('app/views/adminable/resources')
+      append_view_path(
+        [
+          Adminable::Engine.root.join('app/views/adminable', controller_name),
+          Adminable::Engine.root.join('app/views/adminable/resources')
+        ]
+      )
     end
 
     def index
       @q = @resource.model.ransack(params[:q])
-      @entries = @q.result.includes(*@resource.includes).all
-                   .page(params[:page]).per(25)
+      @entries = Adminable::EntriesPresenter.new(
+        @q.result.includes(*@resource.includes).order(id: :desc)
+                                              .page(params[:page]).per(25)
+      )
     end
 
     def new
@@ -21,6 +32,7 @@ module Adminable
     def edit
     end
 
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def create
       @entry = @resource.model.new(resource_params)
 
@@ -31,7 +43,7 @@ module Adminable
                       resource: @resource.model.model_name.human
                     )
       else
-        flash.now[:alert] = @entry.errors.full_messages
+        flash.now[:alert] = @entry.errors.full_messages.first
         render :new
       end
     end
@@ -44,7 +56,7 @@ module Adminable
                       resource: @resource.model.model_name.human
                     )
       else
-        flash.now[:alert] = @entry.errors.full_messages
+        flash.now[:alert] = @entry.errors.full_messages.first
         render :edit
       end
     end
@@ -59,25 +71,38 @@ module Adminable
                   )
     end
 
-    private
-
-      def set_resource
-        @resource = Adminable::Configuration.find_resource(resource_model).clone
-
-        @resource.attributes.index = index_attributes
-        @resource.attributes.form = form_attributes
-      end
-
-      def set_entry
-        @entry = @resource.model.find(params[:id])
+    # Calls from children controller class to manage resource attributes
+    # @example Update attributes for Adminable::Blog::PostsController
+    #   # app/controllers/adminable/blog/posts_controller.rb
+    #
+    #   set_attributes do |attributes|
+    #     # Enables search for title column
+    #     attributes.set :title, search: true
+    #
+    #     # Hides title from new and edit pages
+    #     attributes.set :title, form: true
+    #
+    #     # Adds wysiwyg plugin and hides from index table
+    #     attributes.set :text, wysiwyg: true, index: false
+    #
+    #     # Adds new attribute `password` with type `string` and some options
+    #     attributes.add :password, :string, wysiwyg: true, index: false
+    #
+    #     # Adds new attribute `author`
+    #     attributes << Adminable::Attributes::Types::String.new(:author)
+    #   end
+    def self.set_attributes
+      before_action do
+        @resource.attributes.configure { yield(@resource.attributes) }
       end
+    end
 
-      def index_attributes
-        @resource.attributes.index
-      end
+    private
 
-      def form_attributes
-        @resource.attributes.form
+      def set_entry
+        @entry = Adminable::EntryPresenter.new(
+          @resource.model.find(params[:id])
+        )
       end
 
       def resource_model
@@ -86,7 +111,7 @@ module Adminable
 
       def resource_params
         params.require(@resource.model.model_name.param_key).permit(
-          *@resource.attributes.form.values.map(&:strong_parameter)
+          *@resource.attributes.form.map(&:strong_parameter)
         )
       end
   end

data/app/models/concerns/adminable/resource_concern.rb

@@ -0,0 +1,15 @@
+module Adminable
+  module ResourceConcern
+    extend ActiveSupport::Concern
+
+    def adminable
+      %i(title name email login id).each do |name|
+        begin
+          return OpenStruct.new(name: public_send(name))
+        rescue NoMethodError
+          next
+        end
+      end
+    end
+  end
+end

data/app/views/adminable/resources/_form.html.haml

@@ -1,14 +1,10 @@
-= form_for @entry do |f|
-  - @resource.attributes.form.each_value do |attribute|
-    - if attribute.show?
-      %fieldset.form-group
-        = render attribute.form_partial_path, f: f, entry: @entry,
-          attribute: attribute
+= form_for @entry, method: (@entry.persisted? ? :patch : :post) do |f|
+  - @resource.attributes.form.each do |attribute|
+    %fieldset.form-group
+      = render attribute.form_partial_path, entry: @entry, attribute: attribute
   %fieldset.form-group
     = f.submit t('adminable.buttons.submit'), class: 'btn btn-primary'
     = link_to t('adminable.buttons.back'), polymorphic_path(@resource.model),
       class: 'btn btn-secondary-outline'
     - if @entry.persisted?
-      = link_to t('adminable.buttons.delete'), polymorphic_path(@entry),
-        class: 'btn btn-danger-outline pull-xs-right', method: :delete,
-        data: { confirm: t('adminable.ui.confirm') }
+      = @entry.link_to_delete

data/app/views/adminable/resources/_search.html.haml

@@ -1,9 +1,9 @@
 .card.bg-faded
   .card-block
     = search_form_for @q do |f|
-      - @resource.attributes.ransack.each_value do |attribute|
+      - @resource.attributes.search.each do |attribute|
         %fieldset.form-group
           = f.label attribute.ransack_name, @resource.model.human_attribute_name(attribute.name),
             class: 'text-muted'
           = f.search_field attribute.ransack_name, class: 'form-control'
-      = f.submit class: 'btn btn-primary-outline'
+      = f.submit t('adminable.buttons.search'), class: 'btn btn-primary-outline'

data/app/views/adminable/resources/edit.html.haml

@@ -1,5 +1,5 @@
 .row
   .col-md-8.col-md-offset-2
     %h1.m-b-3
-      = t('adminable.titles.edit', resource: @resource.model.model_name.human)
+      = t('adminable.titles.edit', resource: @resource.model.model_name.human, id: @entry.id)
     = render 'form'

data/app/views/adminable/resources/form/_belongs_to.html.haml

@@ -1,3 +1,13 @@
-= render 'adminable/shared/label', f: f, attribute: attribute
-= f.select attribute.key, attribute.options_for_select(entry),
-  { include_blank: I18n.t('adminable.ui.not_selected') }, { class: 'form-control c-select' }
+= render 'adminable/shared/label', attribute: attribute
+= hidden_field_tag "#{@resource.model.model_name.param_key}[#{attribute.key}]", nil
+#clusterizeScrollArea.clusterize-scroll.associations
+  #clusterizeContentArea.clusterize-content
+    - attribute.association.all.each do |association_entry|
+      .association
+        %label.c-input.c-radio.m-a-0
+          = radio_button_tag "#{@resource.model.model_name.param_key}[#{attribute.key}]",
+            association_entry.id, entry.send(attribute.key) == association_entry.id
+          %span.c-indicator
+          = link_to association_entry.to_name,
+            edit_polymorphic_path(association_entry),
+            target: '_blank'

data/app/views/adminable/resources/form/_boolean.html.haml

@@ -1,3 +1,6 @@
-= f.label attribute.name do
-  = f.check_box attribute.name
+%label.c-input.c-checkbox
+  = hidden_field_tag "#{@resource.model.model_name.param_key}[#{attribute.name}]", 0
+  = check_box_tag "#{@resource.model.model_name.param_key}[#{attribute.name}]", 1,
+    entry.send(attribute.key)
+  %span.c-indicator
   = @resource.model.human_attribute_name(attribute.name)

data/app/views/adminable/resources/form/_date.html.haml

@@ -0,0 +1,3 @@
+= render 'adminable/shared/label', attribute: attribute
+= date_field_tag "#{@resource.model.model_name.param_key}[#{attribute.name}]",
+  entry[attribute.name], class: 'form-control'

data/app/views/adminable/resources/form/_datetime.html.haml

@@ -1,2 +1,3 @@
-= render 'adminable/shared/label', f: f, attribute: attribute
-= f.datetime_field attribute.name, class: 'form-control'
+= render 'adminable/shared/label', attribute: attribute
+= datetime_field_tag "#{@resource.model.model_name.param_key}[#{attribute.name}]",
+  entry[attribute.name], class: 'form-control'