administrador 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 361baa81c14f79a48e2f8f6779c85b5a21ce05f6a34d2b4e4cccb0f92f5ba8f0
+  data.tar.gz: d697b0fe6a177328e22d3754ec141e89669845aadaf4c39e37d9571efc3689b9
+SHA512:
+  metadata.gz: 9ce528d1ae3157a7748b582360b2958efa5cfbc2ada15c59c76cae420122d2d57c3823971568a9e272a20a7afc117fb75ebe3e117c551c48008a69aac6cdd9cc
+  data.tar.gz: 85447dedab01ce3c5d0c3833eebe531e81f32b883e4cd6bb102fe5083c736befc79bfdf38727ecafe234f605303cc82b3443f9a57a9ebb97b19ed8c70b49f912

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Roberto Vasquez Angel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Administrador
+
+Yet another rails admin UI.
+
+Why do we need another one?
+
+Most admin UIs need to be hacked or bent to support engines. This admin UI thinks
+engines first, main-app second. ;)
+
+## Philosophy
+
+Administrador thinks in engines, resources and services.
+
+## Prerequisites
+
+If you are using rails <= 4.0 you have to add the responders gem to you Gemfile:
+
+```ruby
+gem 'responders'
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrador'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install administrador
+```
+
+Run the rails generator:
+```bash
+$ rails g administrador:install
+```
+
+## Configuration
+
+Look at the initializer at config/initializers/administrador.rb for configuration
+options.
+
+### Adding and engine to administrador
+
+```ruby
+Administrador.configure do |config|
+  config.register_engine 'Blorgh::Engine', {}
+end
+```
+### Stylesheets and Javascripts
+
+Administrador assumes, that you have an application.js and application.css in your engine.
+For example if you have a Blorgh-Engine, you should have following files inside the engine:
+
+/app/assets/javascripts/blorgh/application.js
+/app/assets/stylesheets/blorgh/application.css
+
+## Usage
+
+Go to /en/backend and enjoy your admin UI.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Administrador'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/config/administrador_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/administrador .js
+//= link_directory ../stylesheets/administrador .css

data/app/assets/javascripts/administrador/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require rao-component/acts_as_list
+//= require_tree .

data/app/assets/stylesheets/administrador/application/bootstrap-btn-responsive.css

@@ -0,0 +1,7 @@
+@media only screen and (min-width: 0px) and (max-width: 767px) {
+  .btn-responsive {
+    .btn-text {
+      display: none;
+    }
+  }
+}

data/app/assets/stylesheets/administrador/application/bootstrap-btn-xs.css

@@ -0,0 +1,6 @@
+.btn-xs {
+  padding: .125rem .25rem;
+  font-size: .75rem;
+  line-height: 1.25;
+  border-radius: .2rem;
+}

data/app/assets/stylesheets/administrador/application/bootstrap-circular-buttons.css

@@ -0,0 +1,30 @@
+.btn-circle.btn-lg {
+    width: 50px;
+    height: 50px;
+    border-radius: 25px;
+    font-size: 18px;
+    line-height: 1.33;
+}
+
+.btn-circle.btn-xl {
+    width: 70px;
+    height: 70px;
+    padding: 10px 16px;
+    border-radius: 35px;
+    font-size: 24px;
+    line-height: 1.33;
+}
+
+.btn-circle {
+    width: 30px;
+    height: 30px;
+    padding: 6px 0px;
+    border-radius: 15px;
+    text-align: center;
+    font-size: 12px;
+    line-height: 1.42857;
+}
+
+.btn-circle.btn-lg i {
+  line-height: 2.4rem;
+}

data/app/assets/stylesheets/administrador/application/bootstrap-table-xs.css

@@ -0,0 +1,7 @@
+table.table-xs {
+  font-size: .75rem;
+}
+
+table.table-xs th, table.table-xs td {
+  padding: 0.25rem;
+}

data/app/assets/stylesheets/administrador/application/colors.css

@@ -0,0 +1,7 @@
+body {
+  background-color: #F8F8FB;
+}
+
+#main-navbar nav.navbar {
+  background-color: #FFFFFF;
+}

data/app/assets/stylesheets/administrador/application/engine-sidebar.css

@@ -0,0 +1,7 @@
+#engine-sidebar .administrador-object-count {
+  margin-right: 1rem;
+}
+
+#engine-sidebar .list-group-item {
+  padding: 0.2rem 0.3rem;
+}

data/app/assets/stylesheets/administrador/application/layout.css

@@ -0,0 +1,43 @@
+body {
+  font-family: 'Poppins', sans-serif;
+}
+
+#main-navbar-tools .navbar-nav {
+  flex-direction: row;
+  flex-wrap: wrap;
+}
+
+#main-navbar-tools .navbar-nav li {
+  margin-left: 0.75rem;
+}
+
+#main-sidebar {
+  padding: 0;
+}
+
+@media (min-width: 768px) {
+  #main-sidebar {
+    min-height: 100vh;
+  }
+
+  #main-sidebar > .container-fluid > .row {
+    height: 100vh;
+  }
+}
+
+#main-sidebar-bottom-content {
+  width: 100%;
+  display: flex;
+  justify-content: space-between;
+  flex-wrap: wrap;
+}
+
+#main-sidebar-bottom-content .btn {
+  margin-bottom: 0.75rem;
+}
+
+#main-breadcrumbs ol.breadcrumb {
+  background-color: inherit !important;
+  padding-left: 0;
+  padding-right: 0;
+}

data/app/assets/stylesheets/administrador/application/page-actions.css

@@ -0,0 +1,3 @@
+.edit-actions .btn, .show-actions .btn, .index-actions .btn, .new-actions .btn, .create-actions, .btn {
+  margin-left: 0.5rem;
+}

data/app/assets/stylesheets/administrador/application/query_form.css

@@ -0,0 +1,8 @@
+.administrador-query-form {
+  margin-bottom: 0.75rem;
+}
+
+.administrador-query-form input, .administrador-query-form select {
+  margin-left: 0.5rem;
+  margin-right: 0.5rem;
+}

data/app/assets/stylesheets/administrador/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree ./application
+ *= require_self
+ */

data/app/concerns/administrador/controller/application_concern.rb

@@ -0,0 +1,15 @@
+module Administrador
+  module Controller
+    module ApplicationConcern
+      extend ActiveSupport::Concern
+
+      included do
+        view_helper Administrador::ApplicationViewHelper, as: :administrador_helper
+        view_helper Administrador::OffcanvasViewHelper,   as: :offcanvas
+        view_helper Administrador::BreadcrumbsViewHelper, as: :breadcrumbs
+
+        prepend Administrador::EngineRoutable::LocalizedConcern
+      end
+    end
+  end
+end

data/app/concerns/administrador/controller/engine_concern.rb

@@ -0,0 +1,21 @@
+module Administrador
+  module Controller
+    module EngineConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :engine_class
+      end
+
+      class_methods do
+        def engine_class
+          "#{name.deconstantize}::Engine".constantize
+        end
+      end
+
+      def engine_class
+        self.class.engine_class
+      end
+    end
+  end
+end

data/app/concerns/administrador/controller/resource_concern.rb

@@ -0,0 +1,50 @@
+module Administrador
+  module Controller
+    module ResourceConcern
+      extend ActiveSupport::Concern
+
+      include Rao::ResourceController::RestActionsConcern
+      include Rao::ResourceController::ResourceConcern
+      include Rao::ResourceController::RestResourceUrlsConcern
+      include Rao::ResourceController::ResourceInflectionsConcern
+      include Rao::ResourceController::LocationHistoryConcern
+
+      included do
+        helper Rao::Component::ApplicationHelper
+      end
+
+      # You can exclude available actions so that buttons to that action are not included
+      # in the UI.
+      #
+      # Example:
+      #
+      #     # app/controllers/posts_controller.rb
+      #     class PostsController < ApplicationController
+      #       include Administrador::Controller::ResourcesConcern
+      #
+      #       def self.available_rest_actions
+      #         super - %i(edit new)
+      #       end
+      #     end
+      module AvailableRestActionsConcern
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :available_rest_actions
+        end
+
+        module ClassMethods
+          def available_rest_actions
+            %i(new create show edit update destroy)
+          end
+        end
+
+        def available_rest_actions
+          self.class.available_rest_actions
+        end
+      end
+
+      include AvailableRestActionsConcern
+    end
+  end
+end

data/app/concerns/administrador/controller/resources_concern.rb

@@ -0,0 +1,70 @@
+module Administrador
+  module Controller
+    module ResourcesConcern
+      extend ActiveSupport::Concern
+
+      include Rao::ResourcesController::RestActionsConcern
+      include Rao::ResourcesController::ResourcesConcern
+      include Rao::ResourcesController::RestResourceUrlsConcern
+      include Rao::ResourcesController::ResourceInflectionsConcern
+      include Rao::ResourcesController::LocationHistoryConcern
+      include Rao::ResourcesController::SortingConcern
+      include Rao::ResourcesController::BatchActionsConcern
+      include Rao::ResourcesController::KaminariConcern if Administrador.features?(:kaminari)
+      include Rao::Query::Controller::QueryConcern if Administrador.features?(:rao_query)
+
+      included do
+        helper Rao::Component::ApplicationHelper
+        view_helper Rao::Query::ApplicationHelper , as: :query_helper if Administrador.features?(:rao_query)
+      end
+
+      def load_collection_scope
+        with_conditions_from_query(super)
+      end if Administrador.features?(:rao_query)
+
+
+      module ResourcesCountConcern
+        extend ActiveSupport::Concern
+        module ClassMethods
+          def resource_count
+            resource_class.count
+          end
+        end
+      end
+      include ResourcesCountConcern
+
+      # You can exclude available actions so that buttons to that action are not included
+      # in the UI.
+      #
+      # Example:
+      #
+      #     # app/controllers/posts_controller.rb
+      #     class PostsController < ApplicationController
+      #       include Administrador::Controller::ResourcesConcern
+      #
+      #       def self.available_rest_actions
+      #         super - %i(edit new)
+      #       end
+      #     end
+      module AvailableRestActionsConcern
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :available_rest_actions
+        end
+
+        module ClassMethods
+          def available_rest_actions
+            %i(index new create show edit update destroy)
+          end
+        end
+
+        def available_rest_actions
+          self.class.available_rest_actions
+        end
+      end
+
+      include AvailableRestActionsConcern
+    end
+  end
+end

data/app/concerns/administrador/controller/service_concern.rb

@@ -0,0 +1,17 @@
+module Administrador
+  module Controller
+    module ServiceConcern
+      extend ActiveSupport::Concern
+
+      include Rao::ServiceController::RestActionsConcern
+      include Rao::ServiceController::ServiceConcern
+      include Rao::ServiceController::RestServiceUrlsConcern
+      include Rao::ServiceController::ServiceInflectionsConcern
+      include Rao::ServiceController::LocationHistoryConcern
+
+      included do
+        helper Rao::Component::ApplicationHelper
+      end
+    end
+  end
+end

data/app/concerns/administrador/engine_routable/localized_concern.rb

@@ -0,0 +1,21 @@
+module Administrador
+  module EngineRoutable
+    # This prevents missing method error when using localized
+    # engines. The localized gem fails to create a default route
+    # name for enginges without a locale soffix. For example if you
+    # have an engine named blorgh, the router should be named blorgh.
+    # With localized you get blorgh_en, blorgh_de and so on. This concern
+    # provides the router method without the locale as suffix.
+    module LocalizedConcern
+      def method_missing(m, *args, &block)
+        method_name_with_locale = "#{m}_#{I18n.locale}"
+
+        if respond_to?(method_name_with_locale)
+          send(method_name_with_locale, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/controllers/administrador/application_controller.rb

@@ -0,0 +1,5 @@
+module Administrador
+  class ApplicationController < Administrador::Configuration.base_controller_class_name.constantize
+    include Administrador::Controller::ApplicationConcern
+  end
+end

data/app/controllers/administrador/home_controller/base.rb

@@ -0,0 +1,7 @@
+module Administrador
+  class HomeController::Base < ApplicationController
+    include Administrador::Controller::EngineConcern
+
+    def index; end
+  end
+end

data/app/controllers/administrador/home_controller.rb

@@ -0,0 +1,6 @@
+module Administrador
+  class HomeController < Administrador::ApplicationController
+    def index
+    end
+  end
+end

data/app/controllers/administrador/resource_controller/base.rb

@@ -0,0 +1,7 @@
+module Administrador
+  module ResourceController
+    class Base < Administrador::ApplicationController
+      include Administrador::Controller::ResourceConcern
+    end
+  end
+end

data/app/controllers/administrador/resources_controller/base.rb

@@ -0,0 +1,7 @@
+module Administrador
+  module ResourcesController
+    class Base < Administrador::ApplicationController
+      include Administrador::Controller::ResourcesConcern
+    end
+  end
+end

data/app/controllers/administrador/service_controller/base.rb

@@ -0,0 +1,7 @@
+module Administrador
+  module ServiceController
+    class Base < Administrador::ApplicationController
+      include Administrador::Controller::ServiceConcern
+    end
+  end
+end

data/app/controllers/administrador/sidebar_controller/base.rb

@@ -0,0 +1,17 @@
+module Administrador
+  module SidebarController
+    class Base < Administrador::ApplicationController
+      layout false
+
+      def self.icon_name
+        :'ellipsis-v'
+      end
+
+      def show
+        respond_to do |format|
+          format.html
+        end
+      end
+    end
+  end
+end

data/app/jobs/administrador/application_job.rb

@@ -0,0 +1,4 @@
+module Administrador
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/administrador/application_mailer.rb

@@ -0,0 +1,6 @@
+module Administrador
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/administrador/application_record.rb

@@ -0,0 +1,5 @@
+module Administrador
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/view_helpers/administrador/application_view_helper.rb

@@ -0,0 +1,44 @@
+module Administrador
+  class ApplicationViewHelper < Rao::ViewHelper::Base
+    def engines
+      Administrador::Configuration.engines
+    end
+
+    def filter_attributes_for_form(attribute_names)
+      attribute_names.reject { |an| %w(id created_at updated_at).include?(an) }
+    end
+
+    def filter_attributes_for_show(attribute_names)
+      attribute_names.reject { |an| %w().include?(an) }
+    end
+
+    def flash_messages
+      c.render partial: 'administrador/application_view_helper/flash_messages', locals: { flash: bootstrapify_flash_keys(c.flash) }
+    end
+
+    def label_for(resource)
+      Administrador::Configuration.resource_label_methods.each do |method_name|
+        next unless resource.respond_to?(method_name)
+        return resource.send(method_name)
+      end
+    end
+
+    def render_engine_sidebars
+      engines.collect do |_, engine|
+        c.render partial: 'administrador/application_view_helper/render_engine_sidebars', locals: { engine: engine }
+      end.join.html_safe
+    end
+
+    private
+
+    def bootstrapify_flash_keys(flash)
+      flash.each_with_object({}) do |(key, value), memo|
+        memo[map_message_type_to_context(key)] = value
+      end
+    end
+
+    def map_message_type_to_context(message_type)
+      { success: "success", error: "danger", alert: "warning", notice: "info" }[message_type.to_sym] || message_type.to_s
+    end
+  end
+end