adminka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a34b2dd7f9d23fe3f3a59cfa2f3947c3966fcf2a
+  data.tar.gz: 28ab198bbe91d2439e667374da7bbeb0d1ea5071
+SHA512:
+  metadata.gz: 614ef4ca93cf29c526af9dd20fb5e91b574ae59c04da4228dcd69ab44adcf90dea6ed642ba064ee083cfabca060e7af9adaba0d08943aea047a29bf4bfd1e38b
+  data.tar.gz: 2be02187948eb60c4121764d647d1f0aabf7c3193ce3a83a265b5d958a16fc9cac4d519b16337a99a60d8399d29953922fd450b971290edd67467ea9946689b2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Igor
+
+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,150 @@
+# Adminka
+Main goal of that plugin isn't to provide an admin dashboard with huge scope of functionality and 
+tasty features but to provided simple GUI for CRUD and ability to scale it with own features.
+Plugin uses awesome [gem Devise](https://github.com/plataformatec/devise) for users' authentication,
+[gem Kaminari](https://github.com/kaminari/kaminari) for pagination and [gem Carrierwave](https://github.com/carrierwaveuploader/carrierwave)
+for file uploads.
+
+## Usage
+
+After plugin migrations are done the next step will be mounting plugin to app routes. Insert in your routes.rb
+```ruby
+  mount Adminka::Engine => 'admin_panel', as: "adminka"
+```
+Mounting path title is up to you(e.g. admin_panel, my_adminka etc.), the only thing should be
+permanent is alias 'adminka'.
+
+Congratulations! Now you can move to yourappdomain/admin_panel and you'll see login form. Of course at first you need to register
+system admin. Fill in all standard fields and press Sign up. You will be redirected to root_path because newly created
+admin should be activated to proceed. For activation, in your database you need to change in table adminka_admins field is_active to TRUE.
+Only now your admin will be allowed to access main menu.
+
+The next step will be a creation of proper resource to manage. Let it be user resource.
+After resource creation you should pass routes to plugin by doing like this
+```ruby
+Rails.application.routes.draw do
+
+  resources :cities
+
+  mount Adminka::Engine => 'admin_panel', as: "adminka"
+
+  Adminka::Engine.routes.draw do
+    resources :users
+  end
+end
+```
+and now you have restful routes to manage user resource. Then move to your controllers folder, create folder adminka and
+and proper controller for you resource(e.g. users_controller).Don't forget that adminka controllers should be namespaced and inside
+each resource controller you must initialize constant MODEL which holds name of proper model. See example below
+
+```ruby
+class Adminka::UsersController < Adminka::CrudController
+  MODEL = 'User'
+end
+```
+
+Now let's provide an ability to upload avatar for users. Just install Carrierwave and follow installation instructions. As a result, for example,
+you will have attribute avatar for User model and UserUploader. Well done! You can upload image for user.
+The another point is pagination, it will help to manage huge amount of entities. So, we need to install Kaminari. Just add gem to your gemfile and
+run bundle.That's all. The complete model should look like this:
+
+```ruby
+class User < ApplicationRecord
+  paginates_per 5
+
+  belongs_to :city
+  mount_uploader :avatar, AvatarUploader
+
+  validates :first_name, :last_name, presence:  true
+end
+
+```
+
+
+And the last step is creation model for resource. Adminka plugin uses .yml files to store models
+data. Thus you need to move to your models folder, create folder adminka and to create user.yml file inside it.
+You can see example in test/dummy/app/models/adminka directory. Below I'll provide short description of file structure:
+
+1. Parent field *user* - it should be equal to model name.
+2. *title* - left sidebar menu item title. It can be arbitrary(e.g. user, client etc).
+3. *attributes* - contains info about model attributes, their types and separate them for each resource actions(C,R,U,D).
+4. *list* - attributes, which will be shown by index action where resources list is present.
+5. *show* - attributes, which will be shown by show action.
+6. *edit* - attributes, which can be updated. Need to pay more attention to that feature. Each attribute should contain
+    it's title and type. Type title corresponds to html field types(e.g. radio, select, text etc). For some types you need to
+    provide more details:
+    * Type *radio* should contain field *value* and nested fields in format key: value
+    * Type *select* should have a foreign key name. For example, User belongs_to City, so the field name is city_id, then
+    *value* attribute contains proper parent model name(e.g. City), *attributes* field contains two subfields: *id*(mandatory field)
+     and field which contains parent model field value(e.g. *title* City title). So you have id and you want to get title of City by
+     using relation.
+7. If your field contains image url, just assign it to type: *image*.
+8. *search* - list of fields you want to provide search for(e.g. first_name, last_name)
+    
+**You can find model structure example in engine's root directory /test/dummy/app/models/adminka**    
+
+## Views
+Plugin uses some defaults views and layouts and of course you can change them according to your needs. For that purpose plugin provides
+views generator, just run
+
+```bash
+$ rails g adminka:views
+```
+and you'll get all needed views in views/adminka directory and views/layouts/adminka.
+
+## Controllers
+If you need custom behavior you can generate plugin controllers and override proper actions by running:
+
+```bash
+$ rails g adminka:controllers
+```
+
+## I18n
+
+To generate translation files run:
+
+```bash
+$ rails g adminka:locale
+```
+    
+## Installation
+
+```ruby
+gem 'adminka'
+```
+or if you prefer latest updates
+
+```ruby
+gem 'adminka', github: 'rockandruby/adminka'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install adminka
+```
+
+First of all after gem installation you need to copy migrations to your app by executing
+```bash
+$ rails adminka:install:migrations
+```
+and then migrate. 
+
+## Demo
+
+[Demo app](https://adminka.herokuapp.com)
+##### Test credentials:
+
+> Login: bullet6666@mail.ru
+
+> Password: 123456
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Adminka'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+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 << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/adminka_manifest.js

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

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

@@ -0,0 +1,28 @@
+// 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 jquery
+//= require jquery_ujs
+//= require bootstrap-sprockets
+//= require_tree .
+
+function readURL(input) {
+    if (input.files && input.files[0]) {
+        var reader = new FileReader();
+
+        reader.onload = function (e) {
+            $('#image_prev').attr('src', e.target.result)
+        };
+
+        reader.readAsDataURL(input.files[0]);
+    }
+}

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

@@ -0,0 +1,21 @@
+@import "bootstrap-sprockets";
+@import "bootstrap";
+
+.notice{
+  color: green;
+}
+
+#image_prev{
+  padding-top: 20px;
+  width: 20%;
+}
+
+.navbar{
+  background-color: #337ab7 !important;
+}
+h3, thead{
+  color: #337ab7 !important;
+}
+.dropdown-toggle{
+  color: white !important;
+}

data/app/controllers/adminka/admin_controller.rb

@@ -0,0 +1,32 @@
+module Adminka
+  class AdminController < ActionController::Base
+    protect_from_forgery with: :exception
+    before_action :check_auth, except: [:new, :create]
+
+    layout proc { admin_signed_in? ? 'adminka/admin' : 'adminka/auth' }
+
+    def initialize
+      super
+      @menu = {}
+      Dir.glob(Rails.root + 'app/models/adminka/*.yml') do |f|
+        @menu.merge! YAML.load(File.read(f))
+      end
+    end
+
+    protected
+
+    def check_auth
+       if !admin_signed_in?
+         redirect_to new_admin_session_path
+       elsif admin_signed_in? && !current_admin.is_active
+         flash[:alert] = t('adminka.activate_acc')
+         redirect_to '/'
+       end
+    end
+
+    def after_sign_out_path_for(resource_or_scope)
+      new_admin_session_path
+    end
+
+  end
+end

data/app/controllers/adminka/admins/registrations_controller.rb

@@ -0,0 +1,61 @@
+class Adminka::Admins::RegistrationsController < Devise::RegistrationsController
+  before_action :configure_sign_up_params, only: [:create]
+  before_action :configure_account_update_params, only: [:update]
+
+  # layout 'adminka/admin', only: :edit
+  # GET /resource/sign_up
+  # def new
+  #   super
+  # end
+
+  # POST /resource
+  # def create
+  #   super
+  # end
+
+  # GET /resource/edit
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource
+  # def update
+  #   super
+  # end
+
+  # DELETE /resource
+  # def destroy
+  #   super
+  # end
+
+  # GET /resource/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+
+  protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  def configure_sign_up_params
+    devise_parameter_sanitizer.permit(:sign_up, keys: %i(first_name last_name))
+  end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  def configure_account_update_params
+    devise_parameter_sanitizer.permit(:account_update, keys: %i(first_name last_name))
+  end
+
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+end

data/app/controllers/adminka/admins/sessions_controller.rb

@@ -0,0 +1,26 @@
+class Adminka::Admins::SessionsController < Devise::SessionsController
+# before_action :configure_sign_in_params, only: [:create]
+  layout 'adminka/auth'
+
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.permit(:sign_in, keys: [:attribute])
+  # end
+end

data/app/controllers/adminka/crud_controller.rb

@@ -0,0 +1,60 @@
+module Adminka
+  class CrudController < AdminController
+    include Staff
+
+    before_action :check_auth
+
+    def initialize
+      super
+      @config = @menu[self.class::MODEL.downcase]
+      @model = Object.const_get(self.class::MODEL)
+    end
+
+    def index
+      @q = @model.ransack(params[:q])
+      @entities = @q.result.select(select_fields('list')).page(params[:page])
+    end
+
+    def create
+      @entity = @model.new(entity_params)
+      return render :new unless @entity.save
+      flash[:notice] = t('adminka.create')
+      redirect_to @entity
+    end
+
+    def new
+      @entity = @model.new
+    end
+
+    def show
+      @entity = @model.select(select_fields('show')).find(params[:id])
+    end
+
+    def edit
+      @entity = @model.select(select_fields('edit')).find(params[:id])
+    end
+
+    def update
+      @entity = @model.find(params[:id])
+      if @entity.update(entity_params)
+        flash[:notice] = t('adminka.update')
+        redirect_to @entity
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @model.find(params[:id]).destroy
+      flash[:notice] = t('adminka.delete')
+      redirect_to adminka.send("#{@model.to_s.downcase.pluralize}_path")
+    end
+
+    private
+
+    def entity_params
+      params.require(@model.to_s.downcase.to_sym).permit(select_fields('edit'))
+    end
+
+  end
+end