flexible_admin 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Josh Crews
+
+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.textile

@@ -0,0 +1,61 @@
+h1. Flexible Admin
+
+h3. Reason for being
+
+Flexible Admin is a Rails 3.1 Admin tool to generate an attractive data admin to handle login, data CRUD, search and sort while leaving an easy way to customize the particular needs of an app's custom admin functions.
+
+I have found myself loving other admins for Rails, but many projects need enough admin customization that the value of a engines/magic was offset by the difficulty of customizing.
+
+h4. Distinctions from other Rails admin gems
+
+Flexible admin generates controller and view files for every model that you are managing, then invites you to get your hands dirty for the customizations of the admin.
+
+It keeps the amount of generated code down by leveraging these gems/libraries to do the heavy lifting
+
+# Devise for login
+# Bootstrap for style
+# inherited_resources for rest controllers
+# Database Tables (js) for table searching and sorting
+
+h2. Getting Started
+
+In your Gemfile
+
+<code>gem 'flexible_admin'</code>
+
+run <code>bundle install</code>
+
+run <code>rails generate flexible_admin:install</code>
+
+run <code>rake db:migrate</code> to create admin_users tables
+
+h2. Adding models
+
+run <code>rails generate flexible_admin Post</code> to generate a admin/posts controller, /admin/posts route, and add Posts to the admin navigation
+
+h2. Editing views and controllers
+
+Edit views directly in the app/views/admin, app/views/layouts/admin and app/views/controllers/admin
+
+h3. Dashboard
+
+You can (and should) edit the /admin view at app/views/admin/index.html.  It starts out blank.
+
+h3. Sidebar
+
+Every view file does or can have a <code>content_for :sidebar</code> block where you can content for the sidebar
+
+
+h2. Testing
+
+h3. Gem tests
+
+Flexible Admin as a gem is tested with rspec.  The specs cover that the generator generates the right files.  It does not test that you can actually admin in anything after the generator runs.
+
+h4. Working with the tests gotchas
+
+The generator specs really on a dummy Rails app in the spec/dummy folder.  That dummy app has some models, a schema, and a db/test.sqlite3 that matter for the tests.  You might have to dig into those if you are having problems modding the specs.  One of the generators reads the models and the database columns to generate the admin forms, and so the dummy app has those files to test off it.
+
+h2. License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FlexibleAdminmin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_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/lib/flexible_admin/version.rb

@@ -0,0 +1,3 @@
+module FlexibleAdmin
+  VERSION = "0.0.1"
+end

data/lib/flexible_admin.rb

@@ -0,0 +1,2 @@
+module FlexibleAdmin
+end

data/lib/generators/flexible_admin/flexible_admin_generator.rb

@@ -0,0 +1,177 @@
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+# keep generator idempotent, thanks
+
+module FlexibleAdmin
+  class FlexibleAdminGenerator < Rails::Generators::Base
+    namespace "flexible_admin"
+    source_root File.expand_path("../templates", __FILE__)
+    argument :model_name, :type => :string, :required => true, :desc => "Model name for admin section generation"
+
+    desc "flexible_admin resource generator, rails g flexible_admin Post"
+        
+    def creates_resource_views
+      template "resources/index.html.erb", "app/views/admin/#{resources_name}/index.html.erb"
+      template "resources/new.html.erb", "app/views/admin/#{resources_name}/new.html.erb"
+      template "resources/edit.html.erb", "app/views/admin/#{resources_name}/edit.html.erb"
+      template "resources/form.html.erb", "app/views/admin/#{resources_name}/_form.html.erb"
+    end
+    
+    def remove_any_namespace_admin_comments_in_routes
+      gsub_file 'config/routes.rb', /#\s*(namespace :admin do)/, ''
+    end
+    
+    def make_routes
+      if has_admin_route_namespace?
+        unless has_this_route_already?
+          routing_code = "
+      resources :#{resources_name}, :except => :show do
+        member do
+          get 'toggle'
+        end
+      end"
+          sentinel = /namespace :admin do$/
+          in_root do
+            inject_into_file 'config/routes.rb', "\n          #{routing_code}", { :after => sentinel, :verbose => true }
+          end
+        end
+      else
+        route_info = "
+    namespace :admin do
+      resources :#{resources_name}, :except => :show do
+        member do
+          get 'toggle'
+        end
+      end
+    end"
+        route(route_info)
+      end
+    end
+    
+    def create_resources_controller
+      template "admin_resources_controller.rb", "app/controllers/admin/resources_controller.rb"
+      template "resources_controller.rb", "app/controllers/admin/#{resources_name}_controller.rb"
+    end
+    
+    def add_to_navigation_menu
+      gsub_file 'app/views/layouts/admin/_navigation.html.erb', "models = %w(", "models = %w(#{resources_name} "
+    end    
+    
+    private
+        
+      def model
+        singular_name.classify.constantize
+      end
+    
+      def resources_name
+        model_name.tableize
+      end
+      
+      def singular_name
+        resources_name.singularize
+      end
+      
+      def instance_variable_resource
+        "@#{resources_name.singularize}"
+      end
+      
+      def upper_case_resources_name
+        upper_case_resource_name.pluralize
+      end
+      
+      def upper_case_resource_name
+        resources_name.classify.pluralize
+      end
+      
+      def table_column_headers
+        model_title = ["<th>#{model_title(model)}</th>"]
+        other_columns = table_column_names_for(model).collect{|column_name| "<th>#{column_name.titleize}</th>" }
+        (model_title + other_columns).join("\n      ")
+      end
+      
+      def model_title(model)
+        attributes = model.column_names
+        if attributes.include?("title")
+          "Title"
+        elsif attributes.include?("name")
+          "Name"
+        else
+          "#{model.name} ID"
+        end
+      end
+      
+      def table_rows
+        model_title_value = "<td><%= link_to #{model_title_value(model)}, edit_admin_#{singular_name}_path(#{singular_name}) %></td>"
+        other_columns = table_columns_for(model).collect do |column| 
+          if column.name =~ /_file_name/
+            column_name = column.name.split("_file_name").first
+            "<td><%= #{singular_name}.#{column_name}.url, :width => 24, :height => 24) %></td>"
+          elsif column.type == :datetime
+            "<td><%= #{singular_name}.#{column.name}.strftime(\"%F\") %></td>"
+          elsif column.type == :boolean
+            "<td><%= toggle(#{singular_name}, :#{column.name}) %></td>"
+          else
+            "<td><%= #{singular_name}.#{column.name} %></td>"
+          end
+        end
+        ([model_title_value] + other_columns).join("\n      ")
+      end
+      
+      def model_title_value(model)
+        attributes = model.column_names
+        if attributes.include?("title")
+          "#{singular_name}.title"
+        elsif attributes.include?("name")
+          "#{singular_name}.name"
+        else
+          "#{singular_name}.id"
+        end
+      end
+      
+      def columns_for(model)
+        rejections = %w( ^id$ _type$ type created_at created_on updated_at updated_on deleted_at reset_password_token reset_password_sent_at sign_in _content_type file_size).join("|")
+        model.columns.reject { |f| f.name.match(rejections) }
+      end
+            
+      def table_columns_for(model)
+        rejections = %w( ^id$ _type$ type password remember ^name$ ^title$ created_on updated_at updated_on deleted_at reset_password_token reset_password_sent_at sign_in _content_type file_size).join("|")
+        desired_columns = model.columns.reject { |f| f.name.match(rejections) }
+      end
+      
+      def table_column_names_for(model)
+        table_columns_for(model).collect { |c| c.name =~ /_file_name/ ? c.name.split("_file_name").first : c.name }
+      end
+      
+      def render_form_fields(model)
+        columns_for(model).collect do |column|
+          if column.type == :string && column.name =~ /_file_name/
+            column_name = column.name.split("_file_name").first
+            "<%= render 'admin/shared/file_field', :f => f, :what => :#{column_name} %>"
+          elsif column.type == :string && column.name =~ /encrypted_password/
+            "<%= render 'admin/shared/text_field', :f => f, :what => :password %>"
+          elsif column.type == :string && column.name =~ /email/
+            "<%= render 'admin/shared/email_field', :f => f, :what => :#{column.name} %>"
+          elsif column.type == :boolean
+            "<%= render 'admin/shared/checkbox_field', :f => f, :what => :#{column.name} %>"
+          elsif column.type == :text
+            "<%= render 'admin/shared/text_area_field', :f => f, :what => :#{column.name} %>"
+          else
+            "<%= render 'admin/shared/text_field', :f => f, :what => :#{column.name} %>"
+          end
+        end.join("\n")
+
+      end
+      
+      
+      def has_admin_route_namespace?
+        File.open(File.join(destination_root, 'config', 'routes.rb')).read.index("namespace :admin do")
+      end
+      
+      def has_this_route_already?
+        File.open(File.join(destination_root, 'config', 'routes.rb')).read.index("resources :#{resources_name}")
+      end
+      
+  end
+end

data/lib/generators/flexible_admin/install_generator.rb

@@ -0,0 +1,99 @@
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+# keep generator idempotent, thanks
+
+module FlexibleAdmin
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "flexible_admin installation generator"
+    
+    def create_admin_view
+      template "admin_index.html.erb", "app/views/admin/index.html.erb"
+    end
+    
+    def create_admin_layout_view
+      template "admin_layout.html.erb", "app/views/layouts/admin/base.html.erb"
+      template "navigation.html.erb", "app/views/layouts/admin/_navigation.html.erb"
+      template "flash.html.erb", "app/views/layouts/admin/_flash.html.erb"
+    end
+    
+    def create_shared_form_files
+      template "forms/text_field.html.erb", "app/views/admin/shared/_text_field.html.erb"
+      template "forms/text_area_field.html.erb", "app/views/admin/shared/_text_area_field.html.erb"
+      template "forms/select_field.html.erb", "app/views/admin/shared/_select_field.html.erb"
+      template "forms/file_field.html.erb", "app/views/admin/shared/_file_field.html.erb"
+      template "forms/email_field.html.erb", "app/views/admin/shared/_email_field.html.erb"
+      template "forms/cktext_area_field.html.erb", "app/views/admin/shared/_cktext_area_field.html.erb"
+      template "forms/checkbox_field.html.erb", "app/views/admin/shared/_checkbox_field.html.erb"
+      template "forms/error_messages.html.erb", "app/views/admin/shared/_error_messages.html.erb"
+      template "forms/password_field.html.erb", "app/views/admin/shared/_password_field.html.erb"
+    end
+    
+    def create_admin_helper
+      template "admin_helper.rb", "app/helpers/admin_helper.rb"
+    end
+    
+    def create_stylesheets
+      template "stylesheets/bootstrap.sass", "app/assets/stylesheets/admin/bootstrap.sass"
+      template "stylesheets/application.css", "app/assets/stylesheets/admin/application.css"
+      template "stylesheets/demo_table.css", "app/assets/stylesheets/admin/datatables/demo_table.css"
+    end
+    
+    def creates_datatables_images
+      template "images/back_disabled.jpg", "app/assets/images/admin/datatables/back_disabled.jpg"
+      template "images/back_enabled.jpg", "app/assets/images/admin/datatables/back_enabled.jpg"
+      template "images/forward_disabled.jpg", "app/assets/images/admin/datatables/forward_disabled.jpg"
+      template "images/forward_enabled.jpg", "app/assets/images/admin/datatables/forward_enabled.jpg"
+      
+      template "images/sort_asc.png", "app/assets/images/admin/datatables/sort_asc.png"
+      template "images/sort_desc.png", "app/assets/images/admin/datatables/sort_desc.png"
+      template "images/sort_both.png", "app/assets/images/admin/datatables/sort_both.png"
+      template "images/sort_asc_disabled.png", "app/assets/images/admin/datatables/sort_asc_disabled.png"
+      template "images/sort_desc_disabled.png", "app/assets/images/admin/datatables/sort_desc_disabled.png"
+    end
+    
+    def creates_javascripts
+      template "javascripts/application.js", "app/assets/javascripts/admin/application.js"
+      template "javascripts/app.js", "app/assets/javascripts/admin/app.js"
+      template "javascripts/jquery.dataTables.js", "app/assets/javascripts/admin/jquery.dataTables.js"
+    end
+        
+    def make_admin_route
+      route("get '/admin' => 'admin#index'")
+    end
+    
+    def create_admin_controller
+      template "admin_controller.rb", "app/controllers/admin_controller.rb"
+    end
+    
+    def inherited_resources
+      gem 'inherited_resources'
+    end
+    
+    def devise
+      unless defined?(Devise)
+        say "Adding devise gem to your Gemfile:"
+        append_file "Gemfile", "\n", :force => true
+        gem 'devise'
+      end
+      
+      unless File.exists?(Rails.root.join("config/initializers/devise.rb"))
+        say "Installing devise"
+        generate "devise:install"
+      end
+      
+      unless File.exists?(Rails.root.join("app/models/admin_user.rb"))
+        generate "devise AdminUser"
+        template "user_sign_in.html.erb", "app/views/admin/admin_users/sessions/new.html.erb"
+        gsub_file 'config/routes.rb', "devise_for :admin_users", "devise_for :admin_users, :path_prefix => 'admin', :controllers => {:sessions => 'admin/admin_users/sessions' }"
+        template "admin_user_sessions_controller.rb", "app/controller/admin/admin_users/sessions_controller.rb"
+      end
+      
+      say "you now need to run 'rake db:migrate' to create the admin_users table", :blue
+    end
+
+  end
+end

data/lib/generators/flexible_admin/templates/admin_controller.rb

@@ -0,0 +1,21 @@
+class AdminController < ApplicationController
+  before_filter :authenticate_admin_user!
+  layout 'admin/base'
+  
+  def index
+  end
+  
+  def toggle
+    @resource = resource
+    @resource.toggle(params[:field])
+    @resource.save
+    redirect_to :back, :notice => "#{resource.class.to_s} successfully updated"
+  end  
+      
+  private
+    def resource
+      params[:controller].extract_class
+    end
+    # helper_method :resource
+
+end

data/lib/generators/flexible_admin/templates/admin_helper.rb

@@ -0,0 +1,49 @@
+module AdminHelper
+  
+  def optional_label(form, field, label, cssclass = nil)
+    if label.present?
+      if cssclass.present?
+        form.label field, label, :class => cssclass
+      else
+        form.label field, label
+      end
+    else
+      if cssclass.present?
+        form.label field, label, :class => cssclass
+      else
+        form.label field
+      end
+    end
+  end
+  
+  def admin_nav_item(item)
+    content_tag(:li, link_to(item.humanize.titlecase, Rails.application.routes.url_helpers.send("admin_#{item}_path")), :class => active_if(controller_name == item))
+  end
+  
+  def active_if(selected)
+    if selected
+      "active"
+    else
+      nil
+    end
+  end
+  
+  def help_text_present?(all_variables)
+    all_variables.include?(:help)
+  end
+  
+  def toggle(resource, attribute)
+    if resource.send(attribute)
+      link_to "True", toggle_admin_path(resource, attribute)
+    else
+      link_to "False", toggle_admin_path(resource, attribute)
+    end
+  end
+  
+  private
+  
+    def toggle_admin_path(resource, field)
+      url_for(:controller => "admin/#{resource.class.name.pluralize.downcase}", :action => "toggle", :id => resource.id, :field => field)
+    end
+  
+end

data/lib/generators/flexible_admin/templates/admin_layout.html.erb

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+
+<html>
+
+<head>
+  <meta charset="utf-8" />
+
+  <title>Flexible Admin</title>
+  <%%= stylesheet_link_tag 'admin/application' %>
+  <%%= javascript_include_tag 'admin/application' %>
+  <%%= csrf_meta_tag %>
+</head>
+
+<body>
+  
+  <%%= render 'layouts/admin/navigation' %>
+
+  <div class="container-fluid">
+    <div class="sidebar">
+
+    </div><!-- .sidebar -->
+    <div class="content">
+      <%%= render 'layouts/admin/flash', :flash => flash %>
+      <%%= yield :layout %>
+    </div>
+  </div>
+
+</body>
+
+</html>

data/lib/generators/flexible_admin/templates/admin_resources_controller.rb

@@ -0,0 +1,7 @@
+class Admin::ResourcesController < AdminController
+  inherit_resources
+  defaults :route_prefix => 'admin'
+  respond_to :html
+  actions :all, :except => :show
+  
+end

data/lib/generators/flexible_admin/templates/admin_user_sessions_controller.rb

@@ -0,0 +1,3 @@
+class Admin::AdminUsers::SessionsController < Devise::SessionsController
+  layout 'admin/base'
+end

data/lib/generators/flexible_admin/templates/flash.html.erb

@@ -0,0 +1,9 @@
+<%% if flash.present? %>
+	<div id="flash" class="clearfix">
+	  <%% flash.each do |key, value| -%>
+  	  <div class="alert-message <%%= key %>" data-alert="alert">
+        <p><%%= value %></p>
+      </div>
+	  <%% end -%>
+	</div>
+<%% end %>

data/lib/generators/flexible_admin/templates/forms/checkbox_field.html.erb

@@ -0,0 +1,10 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <div class="input-prepend">
+      <label class="add-on"><%%= f.check_box what %></label>
+    </div>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/cktext_area_field.html.erb

@@ -0,0 +1,9 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.cktext_area what, :toolbar => 'Easy', :width => 800, :height => 400 %>
+    <%%= content_tag(:span, help, :class => 'help-block') if help_text_present?(local_variables) %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/email_field.html.erb

@@ -0,0 +1,8 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.email_field what %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/error_messages.html.erb

@@ -0,0 +1,10 @@
+<%% if item.errors.any? %>
+  <div class="alert-message block-message error">
+    <p><strong>You got an error!</strong></p>
+    <ul>
+      <%% item.errors.full_messages.each do |msg| %>
+        <li><%%= msg %></li>
+      <%% end %>
+    </ul>    
+  </div>
+<%% end %>

data/lib/generators/flexible_admin/templates/forms/file_field.html.erb

@@ -0,0 +1,8 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.file_field what %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/password_field.html.erb

@@ -0,0 +1,6 @@
+<div class="clearfix">
+  <%%= f.label what %>
+  <div class="input">
+    <%%= f.password_field what %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/select_field.html.erb

@@ -0,0 +1,8 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.select what, collection %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/text_area_field.html.erb

@@ -0,0 +1,9 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.text_area what, :class => 'span6', :rows => 10 %>
+    <%%= content_tag(:span, help, :class => 'help-block') if help_text_present?(local_variables) %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/forms/text_field.html.erb

@@ -0,0 +1,9 @@
+<%% label ||= nil %>
+
+<div class="clearfix">
+  <%%= optional_label(f, what, label) %>
+  <div class="input">
+    <%%= f.text_field what, :class => 'span6' %>
+    <%%= content_tag(:span, help, :class => 'help-block') if help_text_present?(local_variables) %>
+  </div>
+</div><!-- /clearfix -->

data/lib/generators/flexible_admin/templates/javascripts/app.js

@@ -0,0 +1,5 @@
+$(document).ready(function() {
+  $("#flash").delay(6000).fadeOut(3000);
+  $('.sortable').dataTable();    
+});
+