k_admin 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 548f45742b3750b2c763fba22d706d97791775f8766bdcbef01ecff5eb4e7846
+  data.tar.gz: d53eaf010835d0871d76abbdd21f7ed0f6efc67aac88f14a61e670115420d026
+SHA512:
+  metadata.gz: a1b809d333898acd3da1574910c6d975bc1bcfaa553c50393a83f04fa807ed2bb6da234bb53585b756454307132c5b7f7dfb72310e610a5711bc33e954ab6850
+  data.tar.gz: 40a4bf816a4c9dd82343ccddcd0063ee4b3ade073babf036d6def3e62a29bddbbdf9f4d8cecbf0ad8013f77093740785e2a00a8a23e7a4ac3c456904a71e281b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Ricardo Marques
+
+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,42 @@
+# KAdmin
+Simple admin interface for data administration.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_admin'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install k_admin
+```
+
+## Usage
+To add a resource to the admin dashboard just run the following command
+
+```ruby
+rails g admin_resource model_name
+```
+
+That'll create the following files, which you then can adapt to your model
+
+```bash
+/app/controllers/admin/model_name_controller.rb # model controller
+/app/decorators/model_name_decorator.rb # model decorator
+/app/views/admin/_form.html.erb # model form
+```
+
+All the remaining views/controllers logic will be defaulted to this engine files. To override them just create them on your local repo and you're good to go.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/kollegorna/k-admin. 
+
+## 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,32 @@
+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    = 'KAdmin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/admin/base_controller.rb

@@ -0,0 +1,12 @@
+class Admin::BaseController < ApplicationController
+  layout 'admin'
+
+  before_action :authenticate_user!
+  before_action :authorize_admin!
+
+  private
+
+  def authorize_admin!
+    authorize(User, :access_admin?)
+  end
+end

data/app/controllers/admin/resources_controller.rb

@@ -0,0 +1,67 @@
+class Admin::ResourcesController < Admin::BaseController
+  # generic controller for model admin manipulation
+  before_action :load_resource, only: [:show, :edit, :update, :destroy]
+
+  def new
+    @resource = resource_class.new.decorate
+    authorize @resource
+  end
+
+  def create
+    @resource = resource_class.new(resource_params)
+    authorize @resource
+
+    if @resource.save
+      redirect_to admin_resource_path
+    else
+      @resource = @resource.decorate
+      render :new
+    end
+  end
+
+  def index
+    @resources = paginate resource_class.all
+    @resource_class = resource_class
+  end
+
+  def show
+  end
+
+  def edit
+  end
+
+  def update
+    if @resource.update(resource_params)
+      redirect_to action: :show
+    else
+      render 'edit'
+    end
+  end
+
+  def destroy
+    if @resource.destroy
+      redirect_to admin_resource_path, notice: t("deleted")
+    end
+  end
+
+  private
+
+  def load_resource
+    @resource = resource_class.find(params[:id]).decorate
+    authorize @resource
+  end
+
+  def resource_class
+    # has to be defined by the subclass
+    fail 'not defined'
+  end
+
+  def resource_params
+    # has to be defined by the subclass
+    fail 'not defined'
+  end
+
+  def admin_resource_path
+    send("admin_#{resource_class.to_s.downcase.pluralize}_path")
+  end
+end

data/app/decorators/resource_decorator.rb

@@ -0,0 +1,15 @@
+class ResourceDecorator < ApplicationDecorator
+  delegate_all
+
+  def admin_path
+    model.persisted? ? helpers.send("admin_#{model_name.singular}_path", model) : helpers.send("admin_#{model_name.plural}_path")
+  end
+
+  def edit_admin_path
+    helpers.send("edit_admin_#{model_name.singular}_path", model)
+  end
+
+  def self.new_admin_path
+    helpers.send("new_admin_#{model_name.singular}_path")
+  end
+end

data/app/helpers/admin/forms_helper.rb

@@ -0,0 +1,5 @@
+module Admin::FormsHelper
+  def model_fiels_collection(model, field_name)
+    model.send(field_name.pluralize).keys.map { |field| [I18n.t("activerecord.attributes.#{model.to_s.downcase}.#{field_name.pluralize}.#{field}"), field] }
+  end
+end

data/app/views/admin/base/_resource.html.erb

@@ -0,0 +1,9 @@
+<tr>
+  <td>
+    <%= link_to resource.to_s, resource.decorate.admin_path %>
+  </td>
+
+  <td>
+    <%= link_to t("edit"), resource.decorate.edit_admin_path, class: "button hollow" %>
+  </td>
+</tr>

data/app/views/admin/base/edit.html.erb

@@ -0,0 +1,10 @@
+<%= render 'form' %>
+
+<% if policy(@resource).destroy? %>
+  <footer class="footer">
+    <%= button_to t("destroy"),
+        { action: 'destroy', id: @resource.id }, method: :delete,
+        data: { confirm: t("are_you_sure"), disable_with: t("deleting") },
+        class: 'button warning' %>
+  </footer>
+<% end %>

data/app/views/admin/base/index.html.erb

@@ -0,0 +1,16 @@
+<table class="stack">
+  <thead>
+  <tr>
+    <th><%= t(".name") %></th>
+    <th>&nbsp;</th>
+  </tr>
+  </thead>
+
+  <% @resources.each do |resource| %>
+    <%= render 'resource', resource: resource %>
+  <% end %>
+</table>
+
+<%= paginate @resources %>
+
+<%= link_to t(".add"), @resource_class.decorator_class.new_admin_path, class: "button" %>

data/app/views/admin/base/new.html.erb

@@ -0,0 +1 @@
+<%= render "form", resource: @resource %>

data/app/views/admin/base/show.html.erb

@@ -0,0 +1,7 @@
+<p>
+  <%= @resource %>
+</p>
+
+<p>
+  <%= link_to t("edit"), @resource.edit_admin_path, class: "button" %>
+</p>

data/app/views/layouts/admin.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Admin Dashboard</title>
+  <%= csrf_meta_tags %>
+
+  <!-- Using CDN, no customization of foundation so not requiring gem -->
+  <%= stylesheet_link_tag    'https://cdnjs.cloudflare.com/ajax/libs/foundation/6.4.3/css/foundation-float.css' %>
+  <%= javascript_include_tag 'https://cdnjs.cloudflare.com/ajax/libs/foundation/6.4.3/js/foundation.min.js' %>
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+</head>
+
+<body>
+  <%= render 'shared/admin/header' %>
+
+  <% # rendering partial header if existing %>
+  <%= render "admin/#{controller_name}/header" rescue nil %>
+
+  <%= yield %>
+
+  <%= render 'shared/footer' %>
+</body>
+</html>

data/app/views/shared/admin/_header.html.erb

@@ -0,0 +1,5 @@
+<h4><%= t(".header") %></h4>
+<ul>
+  <!-- TODO dynamic elements navbar -->
+  <li><%= t(".dashboard") %></li>
+</ul>

data/config/initializers/assets.rb

@@ -0,0 +1,4 @@
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/config/initializers/initializer.rb

@@ -0,0 +1 @@
+# Add initialization content here

data/config/locales/admin.en.yml

@@ -0,0 +1,9 @@
+---
+en:
+  shared:
+    admin:
+      header:
+        header: K-Admin Dashboard
+        dashboard: App
+    footer:
+      header: K-Admin Footer

data/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  namespace :admin do
+    # dynamically fetching routes from views folder
+    Dir.glob('app/views/admin/*').select { |f| File.directory? f }.map { |directory| directory.split('/').last.to_sym }.each do |resources|
+      resources resources
+    end
+  end
+end

data/lib/generators/admin_resource_generator.rb

@@ -0,0 +1,16 @@
+class AdminResourceGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  include Rails::Generators::ResourceHelpers
+
+  def create_controller_file
+    template "admin_resource/controller.rb", File.join("app/controllers/admin/", "#{controller_file_name}_controller.rb")
+  end
+
+  def create_decorator_file
+    template "admin_resource/decorator.rb", File.join("app/decorators/", "#{singular_name}_decorator.rb")
+  end
+
+  def create_view_file
+    copy_file "admin_resource/views/_form.html.erb", "app/views/admin/#{plural_name}/_form.html.erb"
+  end
+end

data/lib/generators/templates/admin_resource/controller.rb

@@ -0,0 +1,12 @@
+class Admin::<%= controller_class_name %>Controller < Admin::ResourcesController
+  private
+
+  def resource_class
+    <%= class_name %>
+  end
+
+  def resource_params
+    # add params here
+    params.require(:<%= singular_name %>).permit()
+  end
+end

data/lib/generators/templates/admin_resource/decorator.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Decorator < ResourceDecorator
+end

data/lib/generators/templates/admin_resource/views/_form.html.erb

@@ -0,0 +1,15 @@
+<%= simple_form_for @resource, url: @resource.admin_path do |f| %>
+  <!-- add input fields here (Example below) -->
+  <!-- div class="row">
+    <div class="small-12 columns">
+      <%= f.label :name %>
+      <%= f.input :name %>
+    </div>
+  </div -->
+
+  <div class="row">
+    <div class="small-12 columns">
+      <%= f.submit t("save"), class: "button" %>
+    </div>
+  </div>
+<% end %>

data/lib/k_admin.rb

@@ -0,0 +1,5 @@
+require "k_admin/engine"
+
+module KAdmin
+  # Your code goes here...
+end

data/lib/k_admin/engine.rb

@@ -0,0 +1,4 @@
+module KAdmin
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/k_admin/version.rb

@@ -0,0 +1,3 @@
+module KAdmin
+  VERSION = '0.2.0'
+end

data/lib/tasks/k_admin_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :k_admin do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: k_admin
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ricardo Marques
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple admin interface for data administration.
+email:
+- ricardo.ds.marques@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/k_admin_manifest.js
+- app/controllers/admin/base_controller.rb
+- app/controllers/admin/resources_controller.rb
+- app/decorators/resource_decorator.rb
+- app/helpers/admin/forms_helper.rb
+- app/views/admin/base/_resource.html.erb
+- app/views/admin/base/edit.html.erb
+- app/views/admin/base/index.html.erb
+- app/views/admin/base/new.html.erb
+- app/views/admin/base/show.html.erb
+- app/views/layouts/admin.html.erb
+- app/views/shared/admin/_header.html.erb
+- config/initializers/assets.rb
+- config/initializers/initializer.rb
+- config/locales/admin.en.yml
+- config/routes.rb
+- lib/generators/admin_resource_generator.rb
+- lib/generators/templates/admin_resource/controller.rb
+- lib/generators/templates/admin_resource/decorator.rb
+- lib/generators/templates/admin_resource/views/_form.html.erb
+- lib/k_admin.rb
+- lib/k_admin/engine.rb
+- lib/k_admin/version.rb
+- lib/tasks/k_admin_tasks.rake
+homepage: https://github.com/kollegorna/k-admin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Simple admin interface for data administration.
+test_files: []