admin_interface 1.4.3 → 2.1.7

data/app/helpers/admin/base_helper.rb

@@ -38,6 +38,12 @@ module Admin::BaseHelper
     time.nil? ? '' : I18n.l(time)
   end
 
+  # This is a replacement for Ransack's sort_link (https://github.com/ernie/ransack/blob/master/lib/ransack/helpers/form_helper.rb).
+  # It works for @search stuff and without @search stuff.
+  def order_link(ransack, attribute, options = {})
+    ransack ? sort_link(ransack, attribute, options) : attribute.to_s.humanize # FIXME: Model.human_attribute_name("title")
+  end
+
 # Following are extra helper for kaminari gem (pagination).
 # It shows similar to Redmine.
 

data/app/inputs/country_code_input.rb

@@ -0,0 +1,10 @@
+# Simple Form gem custom input (see: https://github.com/plataformatec/simple_form).
+#
+# Usage (in your simple_form):
+#   <%= form.input :country_code, :as => :country_code %> 
+#
+class CountryCodeInput < SimpleForm::Inputs::Base
+  def input
+    @builder.country_code_select(attribute_name, input_options.delete(:priority), input_html_options) #, priority_countries, options)
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  admin_interface:
+    # TODO

data/lib/admin_interface/engine.rb

@@ -1,4 +1,12 @@
-# Configure Rails 3.1 to include assets.
+# Require gems
+require 'kaminari' # pagination
+require 'ransack' # search
+require 'inherited_resources' # simple controllers
+require 'simple_form' # simple forms
+require 'dynamic_form' # error_messages method
+require 'country_code_select' # country_select when having country_code attributes in your simple_forms
+
+# Configure Rails 3.x to include assets.
 module AdminInterface
 
   class Engine < ::Rails::Engine
@@ -8,6 +16,8 @@ module AdminInterface
     # Load helpers
     # FIXME: Does this work correctly with __FILE__ instead of File.dirname(__FILE__)
     config.autoload_paths << File.expand_path("../../../app/helpers", __FILE__)
+    # simple_form gem inputs (for country_helper)
+    # config.autoload_paths << File.expand_path("../../../app/inputs", __FILE__) # FIXME: this seems to be auto loaded
   end
 
 end

data/lib/admin_interface/version.rb

@@ -0,0 +1,11 @@
+# Version (also for Jeweler Gem, see: https://github.com/technicalpickles/jeweler)
+module AdminInterface
+  module Version
+    MAJOR = 2
+    MINOR = 1
+    PATCH = 7
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/lib/generators/admin_interface/scaffold_generator.rb

@@ -0,0 +1,154 @@
+require 'rails/generators/resource_helpers'
+module AdminInterface
+  module Generators
+    class Scaffold < Rails::Generators::NamedBase
+
+      desc <<DESC
+Description:
+    Scaffolds a admin controller and views.
+DESC
+
+      # See: http://railsapi.com/doc/rails-v3.0.7/classes/Rails/Generators/ResourceHelpers.html
+      include Rails::Generators::ResourceHelpers
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      CONTROLLER_PATH = 'app/controllers/admin'
+      # MODEL_PATH = 'app/models/admin'
+      VIEW_PATH = 'app/views/admin'
+
+      # default_options :skip_timestamps => false, :skip_migration => false, :force_plural => false
+
+      def controller_plural_name
+        @name.pluralize.downcase
+      end
+
+      alias_method  :controller_file_name,  :controller_file_name
+      alias_method  :controller_table_name, :controller_plural_name
+
+      def check_class_collisions # TODO
+        # Check for class naming collisions.
+        # class_collisions class_path, "Admin::#{class_name}Controller"
+      end
+
+      def copy_controller_files
+        template 'scaffold/controller.rb', File.join(CONTROLLER_PATH, class_path, "#{controller_file_name}_controller.rb")
+      end
+
+      def create_admin_scaffold
+        @name = file_name
+        
+        if @name == @name.pluralize && !options[:force_plural]
+          puts "Plural version of the model detected, using singularized version.  Override with --force-plural."
+          @name = @name.singularize
+        end
+
+        for action in scaffold_views
+          template(
+            "scaffold/view_#{action}.html.erb",
+            File.join(VIEW_PATH, controller_class_path, controller_file_name, "#{action}.html.erb")
+          )
+        end
+        template 'scaffold/view_form_partial.html.erb', File.join(VIEW_PATH, controller_class_path, controller_file_name, "_form.html.erb")
+
+        readme 'scaffold/INSTALL'
+      end
+
+    private
+
+      def scaffold_views
+        %w[ index show new edit ]
+      end
+
+      # def create_admin_scaffold
+      #   @name = file_name
+      # 
+      #   if @name == @name.pluralize && !options[:force_plural]
+      #     logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      #     @name = @name.singularize
+      #   end
+      # 
+      #   @controller_name = @name.pluralize
+      # 
+      #   base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+      #   @controller_class_name_without_nesting, @controller_underscore_name, @controller_plural_name = inflect_names(base_name)
+      #   @controller_singular_name=base_name.singularize
+      #   if @controller_class_nesting.empty?
+      #     @controller_class_name = @controller_class_name_without_nesting
+      #   else
+      #     @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+      #   end
+      # end
+      # 
+      # def manifest
+      #   # Check for class naming collisions.
+      #   # m.class_collisions("Admin::#{controller_class_name}Controller")
+      #   # m.class_collisions(class_name)
+      # 
+      #   # Controller, helper, views, test and stylesheets directories.
+      #   # m.directory(File.join('app/models', class_path))
+      #   directory(File.join(CONTROLLER_PATH, controller_class_path))
+      #   # m.directory(File.join('app/helpers', controller_class_path))
+      #   directory(File.join(VIEW_PATH, controller_class_path, controller_file_name))
+      #   # m.directory(File.join('app/views/layouts', controller_class_path))
+      #   # m.directory(File.join('test/functional', controller_class_path))
+      #   # m.directory(File.join('test/unit', class_path))
+      #   # m.directory(File.join('test/unit/helpers', class_path))
+      #   # m.directory(File.join('public/stylesheets', class_path))
+      # 
+      #   for action in scaffold_views
+      #     template(
+      #       "view_#{action}.html.erb",
+      #       File.join(VIEW_PATH, controller_class_path, controller_file_name, "#{action}.html.erb")
+      #     )
+      #   end
+      #   template 'view_form_partial.html.erb', File.join(VIEW_PATH, controller_class_path, controller_file_name, "_form.html.erb")
+      # 
+      #   # Layout and stylesheet.
+      #   # m.template('layout.html.erb', File.join('app/views/layouts', controller_class_path, "#{controller_file_name}.html.erb"))
+      #   # m.template('style.css', 'public/stylesheets/scaffold.css')
+      # 
+      #   template(
+      #     'controller.rb', File.join(CONTROLLER_PATH, controller_class_path, "#{controller_file_name}_controller.rb")
+      #   )
+      # 
+      #   # m.template('functional_test.rb', File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+      #   # m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
+      #   # m.template('helper_test.rb',     File.join('test/unit/helpers',    controller_class_path, "#{controller_file_name}_helper_test.rb"))
+      # 
+      #   # m.route_resources controller_file_name
+      # 
+      #   # m.dependency 'model', [name] + @args, :collision => :skip
+      #   
+      #   readme 'INSTALL'
+      # end
+      # 
+      # protected
+      #   # Override with your own usage banner.
+      #   def banner
+      #     "Usage: #{$0} scaffold ModelName [field:type, field:type]"
+      #   end
+      # 
+      #   def add_options!(opt)
+      #     opt.separator ''
+      #     opt.separator 'Options:'
+      #     opt.on("--skip-timestamps",
+      #            "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      #     opt.on("--skip-migration",
+      #            "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      #     opt.on("--force-plural",
+      #            "Forces the generation of a plural ModelName") { |v| options[:force_plural] = v }
+      #   end
+      # 
+      #   def scaffold_views
+      #     %w[ index show new edit ]
+      #   end
+      # 
+      #   def model_name
+      #     class_name.demodulize
+      #   end
+
+    end
+  end
+end

data/lib/generators/admin_interface/setup_generator.rb

@@ -0,0 +1,59 @@
+module AdminInterface
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+
+      desc <<DESC
+Description:
+    Creates admin controller and needed routes.
+DESC
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # def copy_image_files
+      #   # Images
+      #   # Copy all images to public/images/admin
+      #   admin_image_dir = File.join('public', 'images', 'admin')
+      #   directory('images', admin_image_dir)
+      # end
+
+      def copy_controller_files
+        copy_file("setup/controllers/base_controller.rb", "app/controllers/admin/base_controller.rb")
+        copy_file("setup/controllers/resource_controller.rb", "app/controllers/admin/resource_controller.rb")    
+      end
+
+      def copy_view_files
+        copy_file("setup/views/layout.html.erb", "app/views/layouts/admin.html.erb")
+        copy_file("setup/views/index.html.erb", "app/views/admin/base/index.html.erb")
+      end
+
+      # def copy_javascript_files
+      #   copy_file("javascripts/jquery.admin.js", "public/javascripts/jquery.admin.js")
+      # end
+      # 
+      # def copy_stylesheet_files
+      #   copy_file("views/admin.css", "public/stylesheets/admin.css")
+      # end
+
+      # Helper files are kept in the Engine Gem.
+      # def copy_helper_files
+      #   copy_file("helpers/admin/base_helper.rb", "app/helpers/admin/base_helper.rb")
+      # end
+
+      def add_admin_route
+        route <<ROUTE
+namespace :admin do
+    root :to => 'base#index'
+    # resources :some_model do
+    #   delete 'destroy_all', :on => :collection
+    # end
+  end
+ROUTE
+      end
+
+      def show_readme
+        readme('setup/INSTALL')
+      end
+
+    end
+  end
+end

data/lib/generators/admin_interface/templates/scaffold/INSTALL

@@ -0,0 +1,12 @@
+Make sure the following is in your routes files:
+
+  namespace :admin do
+    root :to => 'base#index'
+    resources :model_name do
+      delete 'destroy_all', :on => :collection
+    end
+  end
+
+Next enabled a new tab in app/controllers/admin/base_controller.rb.
+
+Enjoy!

data/lib/generators/{admin_scaffold/templates → admin_interface/templates/scaffold}/view_edit.html.erb

@@ -1,11 +1,11 @@
 <div class="contextual">
-  <%%= link_to 'Show', [:admin, @<%= singular_name %>], :class => 'icon icon-details' %>
+  <%%= link_to 'Show', [:admin, @<%= singular_name %>], :class => 'icon icon-view' %>
   <%%= link_to 'Destroy', [:admin, @<%= singular_name %>], :confirm => 'Are you sure?', :method => :delete, :class => 'icon icon-del' %>
 </div>
 
-<h2>Editing <%= singular_name %></h2>
+<h2>Editing <%= singular_name.humanize %></h2>
 
-<%%= form_for(@<%= singular_name %>, :url => [:admin, @<%= singular_name %>], :html => {:class => 'tabular'}) do |form| %>
+<%%= simple_form_for(@<%= singular_name %>, :url => [:admin, @<%= singular_name %>], :html => {:class => 'tabular'}) do |form| %>
   <%%= form.error_messages %>
 
   <%%= render :partial => form %>

data/lib/generators/{admin_scaffold/templates → admin_interface/templates/scaffold}/view_form_partial.html.erb

@@ -8,9 +8,13 @@
 
 <div class="box">
 <% for attribute in attributes -%>
+  <% if false -%>
+  <!-- This is for normal forms -->
   <p>
     <%%= form.label :<%= attribute.name %> %>
     <%%= form.<%= attribute.field_type %> :<%= attribute.name %> %>
   </p>
+  <% end -%>
+  <%%= form.input :<%= attribute.name %> -%>
 <% end -%>
 </div>

data/lib/generators/{admin_scaffold/templates → admin_interface/templates/scaffold}/view_index.html.erb

@@ -1,5 +1,5 @@
 <div class="contextual">
-  <%%= link_to 'New <%= singular_name %>', new_admin_<%= singular_name %>_path, :class => 'icon icon-add' %>
+  <%%= link_to 'New <%= singular_name.humanize %>', new_admin_<%= singular_name %>_path, :class => 'icon icon-add' %>
   | <%%= search_form_for @search, :url => collection_url do |f| %>
       <%%
         # Check https://github.com/ernie/ransack for options.
@@ -12,7 +12,7 @@
 <h2>
   <%= # FIXME: parent? doesn't always work :S
     link_to(parent.to_s, [:admin, parent]) + " &gt;".html_safe if defined?(parent) && parent?
-   %>
+   -%>
   <%= plural_name.humanize %>
 </h2>
 
@@ -41,7 +41,7 @@
       <td><%%=h <%= singular_name %>.<%= attribute.name %> %></td>
 <% end -%>
       <td class="buttons">
-        <%%= link_to 'Show', [:admin, <%= singular_name %>], :class => 'icon icon-details' %>
+        <%%= link_to 'Show', [:admin, <%= singular_name %>], :class => 'icon icon-view' %>
         <%%= link_to 'Edit', edit_admin_<%= singular_name %>_path(<%= singular_name %>), :class => 'icon icon-edit' %>
         <%%= link_to 'Destroy', [:admin, <%= singular_name %>], :confirm => 'Are you sure?', :method => :delete, :class => 'icon icon-del' %>
       </td>

data/lib/generators/admin_interface/templates/scaffold/view_new.html.erb

@@ -0,0 +1,10 @@
+<h2>New <%= singular_name.humanize %></h2>
+
+<%%= simple_form_for(@<%= singular_name %>, :url => [:admin, @<%= singular_name %>], :html => {:class => 'tabular'}) do |form| %>
+  <%%= form.error_messages %>
+
+  <%%= render :partial => form %>
+
+    <%%= form.submit 'Create' %>
+    <%%= link_to 'Back', admin_<%= plural_name %>_path %>
+<%% end %>

data/lib/generators/{admin_scaffold/templates → admin_interface/templates/scaffold}/view_show.html.erb

@@ -3,7 +3,7 @@
   <%%= link_to 'Destroy', [:admin, @<%= singular_name %>], :confirm => 'Are you sure?', :method => :delete, :class => 'icon icon-del' %>
 </div>
 
-<h2><%= singular_name.capitalize %> <%%= @<%= singular_name %>.id %></h2>
+<h2><%= singular_name.humanize %> <%%= @<%= singular_name %>.id %></h2>
 
 <div class="box">
 <% for attribute in attributes -%>

data/lib/generators/admin_interface/templates/setup/INSTALL

@@ -0,0 +1,2 @@
+Now add scaffolds using:
+  rails g admin_interface:scaffold YourModel the:string attributes:integer you_want:boolean in_your_admin_interface:string

data/lib/generators/admin_interface/templates/{controllers → setup/controllers}/base_controller.rb

@@ -20,8 +20,8 @@ class Admin::BaseController < ApplicationController
 
 private
 
-  ADMIN_USERNAME = 'admin'
-  ADMIN_PASSWORD = 'admin'
+  ADMIN_USERNAME = 'admin' # HTTP Basic admin username
+  ADMIN_PASSWORD = 'admin' # HTTP Basic admin password
 
   def http_authentication
     authenticate_or_request_with_http_basic do |username, password|

data/vendor/assets/stylesheets/admin_interface.css.scss

@@ -4,6 +4,11 @@
   color: #DD0000;
 }
 
+span.error {
+  color: #DD0000;
+  padding: 4px;
+}
+
 label.disabled {
   color: lightgray;
 }
@@ -14,7 +19,6 @@ div.input {
   height: 1%;
   margin: 0;
   padding: 5px 0 8px 180px;
-  border: 1px solid #D7D7D7;
 }
 
 /***** Custom additions to Redmine *****/
@@ -38,6 +42,12 @@ div.flash.alert {
   text-align: left;
 }
 
+/* Used for form hints */
+.hint {
+  display: block;
+  font-size: 0.8em;
+}
+
 /***** NOTE: Copied from Redmine (application) *****/
 
 /*
@@ -923,6 +933,11 @@ padding-bottom: 3px;
 .icon-call { background-image: image-url('admin/call.gif'); }
 .icon-call-in { background-image: image-url('admin/call_in.png'); }
 .icon-call-out { background-image: image-url('admin/call_out.png'); }
+.icon-slide-show { background-image: image-url('admin/slide_show.png'); }
+.icon-view { background-image: image-url('admin/view.png'); }
+.icon-map { background-image: image-url('admin/map.png'); }
+.icon-world { background-image: image-url('admin/world.png'); }
+.icon-page-go { background-image: image-url('admin/page_go.png'); }
 
 .icon-file { background-image: image-url('admin/files/default.png'); }
 .icon-file.text-plain { background-image: image-url('admin/files/text.png'); }
@@ -1072,7 +1087,7 @@ input[type="button"], input[type="submit"], input[type="reset"] { background-col
 input[type="button"]:hover, input[type="submit"]:hover, input[type="reset"]:hover { background-color: #ccccbb; }
 
 /* Fields */
-input[type="text"], input[type="password"], textarea, select { padding: 2px; border: 1px solid #d7d7d7; }
+input[type="text"], input[type="number"], input[type="tel"], input[type="email"], input[type="password"], input[type="url"], textarea, select { padding: 2px; border: 1px solid #d7d7d7; }
 input[type="text"], input[type="password"] { padding: 3px; }
 input[type="text"]:focus, input[type="password"]:focus, textarea:focus, select:focus { border: 1px solid #888866; }
 option { border-bottom: 1px dotted #d7d7d7; }