admin_assistant 2.2.0 → 2.2.1

data/Rakefile

@@ -57,7 +57,7 @@ begin
     gem.email = "sera@fhwang.net"
     gem.homepage = "http://github.com/fhwang/admin_assistant"
     gem.authors = ["Francis Hwang"]
-    gem.add_dependency "will_paginate", "3.0.pre2"
+    gem.add_dependency "will_paginate", "3.0"
     gem.add_dependency "dynamic_form"
     gem.files.exclude "rails_3_0/**/*"
     gem.files.exclude "rails_3_1/**/*"

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.2.1

data/admin_assistant.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{admin_assistant}
-  s.version = "2.2.0"
+  s.version = "2.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Francis Hwang"]
-  s.date = %q{2011-08-06}
+  s.date = %q{2011-09-17}
   s.description = %q{admin_assistant is a Rails plugin that automates a lot of features typically needed in admin interfaces.}
   s.email = %q{sera@fhwang.net}
   s.extra_rdoc_files = [
@@ -51,23 +51,20 @@ Gem::Specification.new do |s|
     "lib/admin_assistant/search.rb",
     "lib/admin_assistant/show_view.rb",
     "lib/admin_assistant/virtual_column.rb",
-    "lib/images/sort-asc.png",
-    "lib/images/sort-desc.png",
-    "lib/javascripts/admin_assistant.js",
-    "lib/javascripts/jquery.tokeninput.js",
-    "lib/stylesheets/activescaffold.css",
-    "lib/stylesheets/default.css",
-    "lib/stylesheets/token-input.css",
     "lib/views/_polymorphic_field_search.html.erb",
     "lib/views/_token_input.html.erb",
     "lib/views/form.html.erb",
     "lib/views/index.html.erb",
     "lib/views/multi_form.html.erb",
     "lib/views/show.html.erb",
-    "rails_3_0/.gitignore",
     "rails_3_0/lib/tasks/.gitkeep",
     "rails_3_0/public/stylesheets/.gitkeep",
     "rails_3_0/vendor/plugins/.gitkeep",
+    "rails_3_1/app/mailers/.gitkeep",
+    "rails_3_1/lib/assets/.gitkeep",
+    "rails_3_1/lib/tasks/.gitkeep",
+    "rails_3_1/log/.gitkeep",
+    "rails_3_1/vendor/plugins/.gitkeep",
     "tasks/admin_assistant_tasks.rake",
     "uninstall.rb",
     "vendor/ar_query/MIT-LICENSE",
@@ -79,6 +76,13 @@ Gem::Specification.new do |s|
     "vendor/ar_query/spec/ar_query_spec.rb",
     "vendor/ar_query/tasks/ar_query_tasks.rake",
     "vendor/ar_query/uninstall.rb",
+    "vendor/assets/images/sort-asc.png",
+    "vendor/assets/images/sort-desc.png",
+    "vendor/assets/javascripts/admin_assistant.js",
+    "vendor/assets/javascripts/jquery.tokeninput.js",
+    "vendor/assets/stylesheets/admin_assistant.css",
+    "vendor/assets/stylesheets/admin_assistant_activescaffold.css",
+    "vendor/assets/stylesheets/token-input.css",
     "website/_layouts/api.html",
     "website/_layouts/api1.html",
     "website/_layouts/default.html",
@@ -158,14 +162,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<will_paginate>, ["= 3.0.pre2"])
+      s.add_runtime_dependency(%q<will_paginate>, ["= 3.0"])
       s.add_runtime_dependency(%q<dynamic_form>, [">= 0"])
     else
-      s.add_dependency(%q<will_paginate>, ["= 3.0.pre2"])
+      s.add_dependency(%q<will_paginate>, ["= 3.0"])
       s.add_dependency(%q<dynamic_form>, [">= 0"])
     end
   else
-    s.add_dependency(%q<will_paginate>, ["= 3.0.pre2"])
+    s.add_dependency(%q<will_paginate>, ["= 3.0"])
     s.add_dependency(%q<dynamic_form>, [">= 0"])
   end
 end

data/config/routes.rb

@@ -1,7 +1,8 @@
 # In development mode, we need to ensure that all controllers are loaded,
 # because that's how AdminAssistant knows what routes to create
 unless Rails.configuration.cache_classes
-  Find.find("#{Rails.root}/app/controllers") do |path|
+  controllers_path = "#{Rails.root}/app/controllers"
+  AdminAssistant.all_files_under(controllers_path).each do |path|
     if path =~ /\.rb$/
       require path
     end

data/lib/admin_assistant.rb

@@ -19,6 +19,22 @@ class AdminAssistant
   self.default_inputs = {}
   self.routes = []
   
+  # From http://stackoverflow.com/questions/3974087/how-to-make-rubys-find-find-follow-symlinks
+  def self.all_files_under(*paths)
+    paths.flatten!
+    paths.map! { |p| Pathname.new(p) }
+    files = paths.select { |p| p.file? }
+    (paths - files).each do |dir|
+      files << all_files_under(dir.children)
+    end
+    files.flatten.map(&:to_s)
+  end
+  
+  def self.app_uses_sprockets?
+    # For now, we assume you're using Sprockets if app/assets exists.
+    File.exist?("#{Rails.root}/app/assets")
+  end
+
   def self.profile(msg)
     if self.request_start_time
       Rails.logger.info "#{msg}: #{Time.now - self.request_start_time}"
@@ -28,7 +44,7 @@ class AdminAssistant
   def self.template_file(template_name)
     "#{File.dirname(__FILE__)}/views/#{template_name}.html.erb"
   end
-
+  
   attr_reader   :base_settings, :controller_class, :form_settings, 
                 :index_settings, :model_class, :show_settings
   attr_accessor :actions, :custom_destroy, :default_search_matches_on

data/lib/admin_assistant/helper.rb

@@ -1,10 +1,12 @@
 class AdminAssistant
   module Helper
     def admin_assistant_includes(opts = {})
-      theme = opts[:theme] || 'default'
-      tags = stylesheet_link_tag("admin_assistant/#{theme}")
+      ss_name = "admin_assistant/admin_assistant"
+      ss_name << "_#{opts[:theme]}" if opts[:theme]
+      tags = stylesheet_link_tag(ss_name)
       tags << stylesheet_link_tag("admin_assistant/token-input")
-      js_dir = Pathname.new(Rails.root) + "public/javascripts/admin_assistant"
+      js_dir =
+        Pathname.new(Rails.root) + "public/javascripts/admin_assistant"
       Dir.entries(js_dir).each do |entry|
         if entry =~ /\.js$/
           tags << javascript_include_tag("admin_assistant/#{entry}")

data/lib/admin_assistant/index.rb

@@ -148,7 +148,7 @@ class AdminAssistant
         add_base_condition_sqls
         search.add_to_query @ar_query
         @ar_query.total_entries = optimized_total_entries
-        records = @index.model_class.paginate(:all, @ar_query.to_hash)
+        records = @index.model_class.paginate(@ar_query.to_hash)
         if caching_total_entries? && @ar_query.to_hash[:total_entries].nil?
           cache_total_entries records.total_entries
         end

data/lib/admin_assistant/init.rb

@@ -4,10 +4,16 @@ require 'pathname'
 class AdminAssistant
   def self.init
     gem_root = File.dirname(__FILE__) + "/../.."
-    %w(stylesheets javascripts images).each do |asset_type|
+    copy_into_public = %w(images)
+    unless app_uses_sprockets?
+      copy_into_public.concat(%w(stylesheets javascripts))
+    end
+    copy_into_public.each do |asset_type|
       asset_dir = "#{Rails.root}/public/#{asset_type}/admin_assistant"
-      FileUtils.mkdir(asset_dir) unless File.exist?(asset_dir)
-      FileUtils.cp_r(Dir.glob("#{gem_root}/lib/#{asset_type}/*"), asset_dir)
+      FileUtils.mkdir_p(asset_dir) unless File.exist?(asset_dir)
+      FileUtils.cp_r(
+        Dir.glob("#{gem_root}/vendor/assets/#{asset_type}/*"), asset_dir
+      )
     end
   end
 end

data/website/quick_start.markdown

@@ -7,11 +7,13 @@ title:  Quick start
 This document assumes you are highly familiar with Ruby and Rails; if you are a beginning Rails user you might want to start with our <a href="/admin_assistant/tutorial.html">tutorial</a>.
 </div>
 
-1) Add the gem to your Gemfile, and install it with `bundle install`.
+### Add the gem to your Gemfile
 
     gem 'admin_assistant'
 
-2) admin\_assistant comes packaged with standard CSS and Javascript that you should include in whatever layout your admin controllers will be using. You'll also need to make sure to include jquery, if you're not including it already.
+### Include admin\_assistant's CSS and Javascript in your layout
+    
+admin\_assistant comes packaged with standard CSS and Javascript that you should include in whatever layout your admin controllers will be using. You'll also need to make sure to include jquery, if you're not including it already.
 
     <html>
       <head>
@@ -20,8 +22,23 @@ This document assumes you are highly familiar with Ruby and Rails; if you are a
       </head>
       ...
     </html>
+    
+If you're using Sprockets, which is the default in Rails 3.1, you should include the CSS and Javascript assets in the manifest files that you use for your admin layout.
 
-3) Setup an admin controller by attaching it to a model and using the admin layout:
+Javascript:
+
+    //= require admin_assistant
+    //= require jquery.tokeninput.js
+
+CSS:
+
+    //= require admin_assistant
+    //= require token-input
+
+
+### Setup an admin controller
+    
+Use the admin layout, and call `admin_assistant_for` with the model class.
 
     class Admin::BlogPostsController < ApplicationController
       layout 'admin'

data/website/tutorial.markdown

@@ -7,20 +7,26 @@ title:  Tutorial
 This document assumes you are a beginning Rails user; if you are familiar with Rails you might want to check out our <a href="/admin_assistant/quick_start.html">quick start</a>.
 </div>
 
-1) Add the gem to `Gemfile` in the root of your Rails project.
+### Add the gem to your Gemfile
+
+This is found at `Gemfile` in the root of your Rails project.
 
     gem 'admin_assistant'
     
-2) Install the gem locally.
+### Install the gem locally
 
     $ bundle install
     
-3) admin\_assistant uses jQuery. You may already have jQuery installed for your project, but if not, you can get it like so:
+### Install jQuery if you need to
+    
+admin\_assistant uses jQuery. You may already have jQuery installed for your project (it's the standard starting with Rails 3.1), but if not, you can get it like so:
 
     $ curl http://code.jquery.com/jquery-1.6.2.min.js > \
         public/javascripts/jquery-1.6.2.min.js
 
-4) If you don't have any admin controllers in your Rails project yet, you probably need to create a separate admin layout. Create a file called `app/views/layouts/admin.html.erb` like this:
+### Create a separate admin layout (without Sprockets)
+        
+If you don't have any admin controllers in your Rails project yet, you probably need to create a separate admin layout. Create a file called `app/views/layouts/admin.html.erb` like this:
 
     <html>
       <head>
@@ -33,12 +39,42 @@ This document assumes you are a beginning Rails user; if you are familiar with R
     </html>
     
 If you've already created an admin layout, you should add the javascript references, and the call to `admin_assistant_includes`. This includes the standard CSS and Javascript that are packed with admin\_assistant.
-    
-5) Create your new admin controller for a pre-existing model. We'll be using a BlogPost as an example but you should be able to use any model in your Rails app.
+
+### Create a separate admin layout (with Sprockets)
+
+Rails 3.1 recommends Sprockets as the default asset packager. If you're using Sprockets, you'll probably want to create separate `admin.js` and `admin.css` manifest files. `app/views/layouts/admin.html.erb` will look like this:
+
+    <html>
+      <head>
+        <%= javascript_include_tag "admin" %>
+        <%= stylesheet_link_tag "admin" %>
+      </head>
+      <body>
+        <%= yield %>
+      </body>
+    </html>
+
+And you will add admin\_assistant's assets to the manifest files, which you will most likely put at `app/assets/javascripts/admin.js` and `app/assets/stylesheets/admin.css`.
+
+Javascript:
+
+    //= require admin_assistant
+    //= require jquery.tokeninput.js
+
+CSS:
+
+    //= require admin_assistant
+    //= require token-input
+
+### Create an admin controller
+
+Create your new admin controller for a pre-existing model. We'll be using a BlogPost as an example but you should be able to use any model in your Rails app.
 
     ./script/generate controller admin/blog_posts
+
+### Edit your admin controller
     
-6) Open `app/controllers/admin/blog_posts_controller.rb` and set it up to use the admin layout and to use admin\_assistant for the BlogPost model:
+Open `app/controllers/admin/blog_posts_controller.rb` and set it up to use the admin layout and to use admin\_assistant for the BlogPost model:
 
     class Admin::BlogPostsController < ApplicationController
       layout 'admin'
@@ -46,9 +82,13 @@ If you've already created an admin layout, you should add the javascript referen
       admin_assistant_for BlogPost
     end
 
-7) If you were already running your Rails app with `./script/server` etc, you should restart it.
+### Restart your Rails app
+    
+If you were already running your Rails app with `./script/server` etc, you should restart it.
+
+### Check out the controller
 
-8) Visit `/admin/blog_posts` in your browser and you'll see something like this:
+Visit `/admin/blog_posts` in your browser and you'll see something like this:
 
 ![index](/admin_assistant/img/blog_posts-index.png)
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: admin_assistant
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 2
   - 2
-  - 0
-  version: 2.2.0
+  - 1
+  version: 2.2.1
 platform: ruby
 authors: 
 - Francis Hwang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-06 00:00:00 -04:00
+date: 2011-09-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,13 +26,11 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 1923831917
+        hash: 7
         segments: 
         - 3
         - 0
-        - pre
-        - 2
-        version: 3.0.pre2
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -93,23 +91,20 @@ files:
 - lib/admin_assistant/search.rb
 - lib/admin_assistant/show_view.rb
 - lib/admin_assistant/virtual_column.rb
-- lib/images/sort-asc.png
-- lib/images/sort-desc.png
-- lib/javascripts/admin_assistant.js
-- lib/javascripts/jquery.tokeninput.js
-- lib/stylesheets/activescaffold.css
-- lib/stylesheets/default.css
-- lib/stylesheets/token-input.css
 - lib/views/_polymorphic_field_search.html.erb
 - lib/views/_token_input.html.erb
 - lib/views/form.html.erb
 - lib/views/index.html.erb
 - lib/views/multi_form.html.erb
 - lib/views/show.html.erb
-- rails_3_0/.gitignore
 - rails_3_0/lib/tasks/.gitkeep
 - rails_3_0/public/stylesheets/.gitkeep
 - rails_3_0/vendor/plugins/.gitkeep
+- rails_3_1/app/mailers/.gitkeep
+- rails_3_1/lib/assets/.gitkeep
+- rails_3_1/lib/tasks/.gitkeep
+- rails_3_1/log/.gitkeep
+- rails_3_1/vendor/plugins/.gitkeep
 - tasks/admin_assistant_tasks.rake
 - uninstall.rb
 - vendor/ar_query/MIT-LICENSE
@@ -121,6 +116,13 @@ files:
 - vendor/ar_query/spec/ar_query_spec.rb
 - vendor/ar_query/tasks/ar_query_tasks.rake
 - vendor/ar_query/uninstall.rb
+- vendor/assets/images/sort-asc.png
+- vendor/assets/images/sort-desc.png
+- vendor/assets/javascripts/admin_assistant.js
+- vendor/assets/javascripts/jquery.tokeninput.js
+- vendor/assets/stylesheets/admin_assistant.css
+- vendor/assets/stylesheets/admin_assistant_activescaffold.css
+- vendor/assets/stylesheets/token-input.css
 - website/_layouts/api.html
 - website/_layouts/api1.html
 - website/_layouts/default.html

data/rails_3_0/.gitignore

@@ -1,4 +0,0 @@
-.bundle
-db/*.sqlite3
-log/*.log
-tmp/