admin-panel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66df4e9a3092fddf326c23404ad72b5bab8dedb0
+  data.tar.gz: f6fc832605453bb2cd6adfbae5589313dd9fa162
+SHA512:
+  metadata.gz: ff55ce389b1186867a88e0ea5dcd7855f405c5313a1d69bd78d53a8a3d96db947ce5eae531af1e40982ebe88e4195f68677b9d0159b75ecc5b1fa437fb4f08be
+  data.tar.gz: 7144c2efae1b7517d346965735ca7e75d2794ced6d4f40b10bea177f30a1852fdace4244e2ea4abf2df4e2f32e3163110fce2e4b8894528e5dfab366904fb5fd

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+tmp/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    admin-panel (0.1.0)
+      bootstrap-sass (~> 3.1)
+      devise (~> 3.2)
+      railties (>= 4.0.0)
+      sass-rails (>= 4.0.0)
+      simple_form (>= 3.1.0.rc1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ammeter (1.0.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    bcrypt (3.1.7)
+    bootstrap-sass (3.1.1.1)
+      sass (~> 3.2)
+    builder (3.2.2)
+    devise (3.2.4)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    orm_adapter (0.5.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.1)
+      rspec-support (~> 3.0.0)
+    rspec-rails (3.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    sass (3.2.19)
+    sass-rails (4.0.3)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.0)
+      sprockets (~> 2.8, <= 2.11.0)
+      sprockets-rails (~> 2.0)
+    simple_form (3.1.0.rc1)
+      actionpack (~> 4.0)
+      activemodel (~> 4.0)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    warden (1.2.3)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  admin-panel!
+  ammeter (~> 1.0)
+  bundler (~> 1.5)
+  rake (~> 10.0)
+  rspec (~> 3.0)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Michał Matyas
+
+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,55 @@
+Admin Panel
+===========
+
+This gem has been created as a recruitment task I was given. It's a set of generators to create administration panel for your website.
+
+Installation
+------------
+
+Start with adding these gems to your Gemfile:
+
+```ruby
+gem 'admin-panel', '~> 0.1.0'
+gem 'devise', '~> 3.2'
+gem 'simple_form', '3.1.0.rc1'
+gem 'bootstrap-sass', '~> 3.1'
+```
+
+Then do @bundle install@ and run the installer:
+
+```bash
+$ rails generate admin_panel:install
+```
+
+Using the scaffolder
+--------------------
+
+The scaffolder has basically the same syntax as the Rails one, except there's currently no support for custom namespace.
+
+```bash
+$ rails generate admin_panel:scaffold NAME [field:type field:type ...]
+```
+
+Running tests
+-------------
+
+Tests can be run using @rake spec@. They are written using rspec and [ammeter](https://github.com/alexrothenberg/ammeter)
+
+Thanks
+------
+
+This gem was based mostly on two different pieces of software: [bootstrap-generators](https://github.com/decioferreira/bootstrap-generators) and [rails-admin-scaffold](https://github.com/dhampik/rails-admin-scaffold)
+
+TODO
+----
+
+Currently this gem is pretty much one-evening project, I'm not sure if I'll continue it's development past this point.
+
+Things that'd be nice to have:
+
+- support for anything more than Active Record
+- support for anything more than Erb (haml, slim)
+- namespace change support and more configuration options
+- kaminari/will_paginate support 
+- I liked the idea of copying the files to your project during install at first but now it just seems silly; I should probably rewrite everything from scratch to work more similarly to Devise, including the ability to extend default controllers where necessary
+- I was also supposed to add Carrierwave support too but ran out of time

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec

data/admin-panel.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'admin-panel/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'admin-panel'
+	spec.version       = AdminPanel::VERSION
+
+	spec.authors       = ['Michał Matyas']
+	spec.email         = ['michal@higher.lv']
+	spec.summary       = 'Generates Twitter Bootstrap based admin panel with scaffolder'
+	spec.description   = 'Generates Twitter Bootstrap based admin panel with scaffolder. Project is quite opinionated, requires Rails 4, SASS, SimpleForm and Devise.'
+	spec.homepage      = 'https://github.com/d4rky-pl/admin-panel'
+	spec.license       = 'MIT'
+
+	spec.files         = `git ls-files`.split($/)
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency 'bundler', '~> 1.5'
+	spec.add_development_dependency 'rake', '~> 10.0'
+	spec.add_development_dependency 'rspec', '~> 3.0'
+	spec.add_development_dependency 'ammeter', '~> 1.0'
+
+	spec.add_runtime_dependency 'railties', '>= 4.0.0'
+	spec.add_runtime_dependency 'sass-rails', '>= 4.0.0'
+	spec.add_runtime_dependency 'bootstrap-sass', '~> 3.1'
+	spec.add_runtime_dependency 'simple_form', '>= 3.1.0.rc1'
+	spec.add_runtime_dependency 'devise', '~> 3.2'
+end

data/lib/admin-panel/version.rb

@@ -0,0 +1,3 @@
+module AdminPanel
+	VERSION = "0.1.0"
+end

data/lib/generators/admin_panel/install/install_generator.rb

@@ -0,0 +1,69 @@
+require 'rails/generators'
+
+module AdminPanel
+	module Generators
+		class InstallGenerator < ::Rails::Generators::Base
+			desc 'Generate basic admin panel with authentication namespaced as Admin'
+			source_root ::File.expand_path('../templates', __FILE__)
+
+			class_option :template_engine
+
+			def install_devise
+				invoke 'devise:install'
+			end
+
+			def install_simple_form
+				invoke 'simple_form:install', [], ['--bootstrap']
+			end
+
+			attr_reader :app_name
+
+			def copy_layout
+				@app_name = ::Rails.application.class.to_s.split("::").first.humanize
+				extension = "html.#{options[:template_engine]}"
+
+				template "layouts/admin/application.#{extension}", "app/views/layouts/admin/application.#{extension}"
+				[ '_messages', '_navigation'].each do |file|
+					filename = "#{file}.#{extension}"
+					copy_file "layouts/admin/#{filename}", "app/views/layouts/admin/#{filename}"
+				end
+			end
+
+			def copy_assets
+				directory 'assets', 'app/assets'
+			end
+
+			def copy_helpers
+				directory 'helpers', 'app/helpers'
+			end
+
+			def copy_scaffold
+				directory 'controllers', 'app/controllers'
+				directory 'views', 'app/views'
+			end
+
+			def create_admin_model
+				invoke 'active_record:devise', ['admin'], ['--routes', false]
+				append_to_file 'db/seeds.rb', %Q(
+Admin.create!({ email: 'admin@example.com', password: 'administrator' })
+)
+			end
+
+			def create_routes
+				route %Q(
+  devise_for :admin,
+           :only => [:sessions, :passwords],
+           :controllers => { :sessions => 'admin/sessions', :passwords => 'admin/passwords' }
+
+  namespace :admin do
+    get '/', to: 'dashboard#index', as: :dashboard
+  end
+)
+			end
+
+			def show_install_message
+				readme "README"
+			end
+		end
+	end
+end

data/lib/generators/admin_panel/install/templates/README

@@ -0,0 +1,10 @@
+===============================================================================
+
+  Remember to invoke these commands after the installation process is done:
+
+    $ rake db:migrate
+    $ rake db:seed
+
+  Your default account is set to admin@example.com , password: administrator
+
+===============================================================================

data/lib/generators/admin_panel/install/templates/assets/javascripts/admin.js

@@ -0,0 +1 @@
+//= require 'bootstrap'

data/lib/generators/admin_panel/install/templates/assets/stylesheets/admin.css.scss

@@ -0,0 +1 @@
+@import 'bootstrap';

data/lib/generators/admin_panel/install/templates/controllers/admin/dashboard_controller.rb

@@ -0,0 +1,3 @@
+class Admin::DashboardController < ApplicationController
+	include Administrable
+end

data/lib/generators/admin_panel/install/templates/controllers/admin/passwords_controller.rb

@@ -0,0 +1,4 @@
+class Admin::PasswordsController < Devise::PasswordsController
+	helper AdminHelper
+	layout 'admin/application'
+end

data/lib/generators/admin_panel/install/templates/controllers/admin/sessions_controller.rb

@@ -0,0 +1,4 @@
+class Admin::SessionsController < Devise::SessionsController
+	helper AdminHelper
+	layout 'admin/application'
+end

data/lib/generators/admin_panel/install/templates/controllers/concerns/administrable.rb

@@ -0,0 +1,9 @@
+module Administrable
+	extend ActiveSupport::Concern
+
+	included do
+		before_filter :authenticate_admin!
+		helper AdminHelper
+		layout 'admin/application'
+	end
+end

data/lib/generators/admin_panel/install/templates/helpers/admin_helper.rb

@@ -0,0 +1,19 @@
+module AdminHelper
+	def admin_pages
+		# TODO: something more elegant
+		non_scaffold_pages = %w(dashboard sessions passwords)
+
+		Dir.glob(Rails.root.join('app', 'controllers', 'admin', '*.rb')).map do |path|
+			filename = File.basename(path)
+			resource_name = filename.sub(/_controller\.rb$/, '')
+
+			unless non_scaffold_pages.include? resource_name
+				{
+					name: resource_name.humanize,
+					controller: "#{resource_name}",
+					url: self.send("admin_#{resource_name}_path")
+				}
+			end
+		end.compact
+	end
+end

data/lib/generators/admin_panel/install/templates/layouts/admin/_messages.html.erb

@@ -0,0 +1,8 @@
+<% flash.each do |name, msg| %>
+	<% if msg.is_a?(String) %>
+		<div class="alert alert-<%= name.to_s == 'notice' ? 'success' : 'danger' %>">
+			<button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
+			<%= content_tag :div, msg, :id => "flash_#{name}" %>
+		</div>
+	<% end %>
+<% end %>

data/lib/generators/admin_panel/install/templates/layouts/admin/_navigation.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-default" role="navigation">
+	<div class="container-fluid">
+		<div class="navbar-header">
+			<a class="navbar-brand" href="<%= admin_dashboard_path %>">App name</a>
+		</div>
+
+		<% if admin_signed_in? %>
+			<ul class="nav navbar-nav">
+				<% admin_pages.each do |page| %>
+					<li class="<%= controller_name == page[:controller] ? 'active' : '' %>">
+						<a href="<%= page[:url] %>"><%= page[:name] %></a>
+					</li>
+				<% end %>
+			</ul>
+			<ul class="nav navbar-nav navbar-right">
+				<li><%= link_to 'Sign out', destroy_admin_session_path, method: :delete %></li>
+			</ul>
+		<% end %>
+	</div>
+</nav>

data/lib/generators/admin_panel/install/templates/layouts/admin/application.html.erb

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title><%%= content_for?(:title) ? yield(:title) : "<%= app_name.underscore.titleize %>" %></title>
+	<meta name="description" content="<%%= content_for?(:description) ? yield(:description) : "<%= app_name.underscore.titleize %>" %>">
+	<%%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+	<%%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+	<%%= csrf_meta_tags %>
+</head>
+<body>
+	<header>
+		<%%= render partial: 'layouts/admin/navigation' %>
+	</header>
+	<main role="main">
+		<div class="container">
+			<%%= render partial: 'layouts/admin/messages' %>
+			<%%= yield %>
+		</div>
+	</main>
+</body>
+</html>