admin_view 0.1.0 → 0.2.0

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.swp
 .bundle

data/README.md

@@ -1,8 +1,8 @@
 # admin_view
 
-Rails 3 generator of CRUD admin controllers, views and specs for existing models.
+Rails 3 generator of CRUD admin controllers, views and specs for existing ActiveRecord models.
 
-It uses [meta_search](https://github.com/ernie/meta_search) for search and [kaminari](https://github.com/amatsuda/kaminari) for pagination.
+It uses [meta_search](https://github.com/ernie/meta_search) for search and [kaminari](https://github.com/amatsuda/kaminari) for pagination. It also assumes that you have [dynamic_form](https://github.com/joelmoss/dynamic_form) plugin installed.
 
 Screenshot:
 
@@ -16,10 +16,15 @@ Include it in your Gemfile:
 
 Run the generator:
 
-	$ bundle exec admin_view User --search_by name_or_email
+	$ bundle exec rails g admin_view User --search_by name_or_email
 
 The `--search_by` option is not required - if you don't pass it, the form template will come out commented out. However, it's useful most of the time, and you can use any meta_search-compatible expression to search in string or text fields.
 
+Other options available are:
+
+* `--no_create` - omit functionality to create a new record
+* `--read_only` - omit create, edit and update functionality
+
 ## Contributing
 
 Yes! Feel free to fork the repo, make your changes in a topic branch and send us a pull request.

data/admin_view.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency("rails", ">= 3.0")
-  s.add_dependency("rspec-rails", ">= 2.4.0")
-  s.add_dependency("meta_search")
-  s.add_dependency("kaminari")
+  s.add_dependency("meta_search", ">= 1.0")
+  s.add_dependency("kaminari", ">= 0.12")
+  s.add_development_dependency("rspec-rails", ">= 2.4.0")
 end

data/lib/admin_view/version.rb

@@ -1,3 +1,3 @@
 module AdminView
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/admin_view_generator.rb

@@ -9,6 +9,10 @@ class AdminViewGenerator < Rails::Generators::NamedBase
 
   class_option :search_by, :type => :string, :desc => "The field or criteria to meta_search by (not required, but without a doubt recommended)"
 
+  class_option :no_create, :type => :boolean, :default => false, :desc => "Omit functionality to create a new record."
+
+  class_option :read_only, :type => :boolean, :default => false, :desc => "Omit create, edit and update functionality."
+
   def create_base_controller
     empty_directory "app/controllers/admin"
     path = File.join("app/controllers/admin", "base_controller.rb")
@@ -29,13 +33,16 @@ class AdminViewGenerator < Rails::Generators::NamedBase
     template "controller_spec.rb", File.join("spec/controllers/admin", "#{controller_file_name}_controller_spec.rb")
   end
 
+  def create_helper
+    empty_directory "app/helpers/admin"
+    template "base_helper.rb", File.join("app/helpers/admin", "base_helper.rb")
+  end
+
   def create_views
     empty_directory "app/views/admin/#{controller_file_name}"
-    if model_exists?(class_name)
-      @attributes = class_name.constantize.send(:columns)
-      available_views.each do |view|
-        template "views/#{view}.html.erb", File.join("app/views/admin", controller_file_name, "#{view}.html.erb")
-      end
+    @attributes = get_model_columns
+    available_views.each do |view|
+      template "views/#{view}.html.erb", File.join("app/views/admin", controller_file_name, "#{view}.html.erb")
     end
   end
 
@@ -50,7 +57,13 @@ class AdminViewGenerator < Rails::Generators::NamedBase
   protected
 
   def available_views
-    ["index", "new", "show", "edit", "_form"]
+    views = ["index", "new", "show", "edit", "_form"]
+
+    views.delete("new") if options[:no_create]
+
+    ["new", "edit", "_form"].each { |v| views.delete(v) } if options[:read_only]
+
+    views
   end
 
   def model_exists?(klass_name)
@@ -62,4 +75,12 @@ class AdminViewGenerator < Rails::Generators::NamedBase
     end
   end
 
+  def get_model_columns
+    if model_exists?(class_name)
+      class_name.constantize.send(:columns)
+    else
+      [] # allow user (and test) to generate the view files
+    end
+  end
+
 end

data/lib/generators/templates/base_helper.rb

@@ -0,0 +1,10 @@
+module Admin::BaseHelper
+
+  def sortable(column, title = nil)
+    title ||= column.titleize
+    css_class = (column == sort_column) ? "current #{sort_direction}" : nil
+    direction = (column == sort_column && sort_direction == "asc") ? "desc" : "asc"
+    link_to title, { :sort => column, :direction => direction }, { :class => css_class }
+  end
+
+end

data/lib/generators/templates/controller.rb

@@ -2,13 +2,14 @@ class Admin::<%= controller_class_name %>Controller < Admin::BaseController
 
   helper_method :sort_column, :sort_direction, :search_params
 
-  before_filter :find_<%= singular_table_name %>, :only => [:edit, :update, :show, :destroy]
+  before_filter :find_<%= singular_table_name %>, :only => [<% unless options[:read_only] %>:edit, :update,<% end %> :show, :destroy]
 
   def index
     @search = <%= class_name %>.search(params[:search])
     @<%= plural_table_name %> = find_<%= plural_table_name %>
   end
 
+  <% unless options[:no_create] or options[:read_only] %>
   def new
     @<%= singular_table_name %> = <%= class_name %>.new
   end
@@ -21,10 +22,12 @@ class Admin::<%= controller_class_name %>Controller < Admin::BaseController
       render :new
     end
   end
+  <% end -%>
 
   def show
   end
 
+  <% unless options[:read_only] %>
   def edit
   end
 
@@ -35,6 +38,7 @@ class Admin::<%= controller_class_name %>Controller < Admin::BaseController
       render :edit
     end
   end
+  <% end -%>
 
   def destroy
     @<%= singular_table_name %>.destroy

data/lib/generators/templates/controller_spec.rb

@@ -26,6 +26,7 @@ describe Admin::<%= controller_class_name %>Controller do
     end
   end
 
+  <% unless options[:no_create] or options[:read_only] %>
   describe "GET new" do
     it "assigns a new <%= singular_table_name %> as @<%= singular_table_name %>" do
       <%= class_name %>.stub(:new) { mock_<%= singular_table_name %> }
@@ -34,14 +35,6 @@ describe Admin::<%= controller_class_name %>Controller do
     end
   end
 
-  describe "GET edit" do
-    it "assigns the requested <%= singular_table_name %> as @<%= singular_table_name %>" do
-      <%= class_name %>.stub(:find).with("37") { mock_<%= singular_table_name %> }
-      get :edit, :id => "37"
-      assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
-    end
-  end
-
   describe "POST create" do
 
     describe "with valid params" do
@@ -73,6 +66,16 @@ describe Admin::<%= controller_class_name %>Controller do
     end
 
   end
+  <% end -%>
+
+  <% unless options[:read_only] %>
+  describe "GET edit" do
+    it "assigns the requested <%= singular_table_name %> as @<%= singular_table_name %>" do
+      <%= class_name %>.stub(:find).with("37") { mock_<%= singular_table_name %> }
+      get :edit, :id => "37"
+      assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+    end
+  end
 
   describe "PUT update" do
 
@@ -111,6 +114,7 @@ describe Admin::<%= controller_class_name %>Controller do
     end
 
   end
+  <% end -%>
 
   describe "DELETE destroy" do
     it "destroys the requested <%= singular_table_name %>" do

data/lib/generators/templates/views/index.html.erb

@@ -13,7 +13,9 @@
   <% end %>
 <%% end %>
 
+<% unless options[:no_create] or options[:read_only] %>
 <p><%%= link_to("Create a new <%= human_name %>", new_admin_<%= singular_table_name %>_path) %></p>
+<% end -%>
 
 <table class="sortable">
   <thead>
@@ -21,7 +23,9 @@
 <% @attributes.each do |attribute| -%>
       <th><%%= sortable "<%= attribute.name %>" %></th>
 <% end -%>
+<% unless options[:read_only] %>
       <th>Edit</th>
+<% end -%>
       <th>Delete</th>
     </tr>
   </thead>
@@ -33,7 +37,9 @@
 <% next if attribute.name == "id" -%>
         <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
 <% end -%>
+<% unless options[:read_only] %>
         <td><%%= link_to('Edit', edit_admin_<%= singular_table_name %>_path(<%= singular_table_name %>)) %></td>
+<% end -%>
         <td><%%= link_to('Delete', admin_<%= singular_table_name %>_path(<%= singular_table_name %>), :confirm => "Are you sure?", :method => :delete) %></td>
       </tr>
     <%% end %>

data/test/admin_view_generator_test.rb

@@ -1,13 +1,13 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
- 
+
 require 'generators/admin_view_generator'
- 
+
 class AdminViewGeneratorTest < Rails::Generators::TestCase
 
   destination File.expand_path("../tmp", File.dirname(__FILE__))
   setup :prepare_destination
   tests AdminViewGenerator
- 
+
   test "create the controllers and specs" do
     run_generator %w(User --search_by email)
 
@@ -15,5 +15,52 @@ class AdminViewGeneratorTest < Rails::Generators::TestCase
     assert_file "app/controllers/admin/users_controller.rb", /class Admin::UsersController < Admin::BaseController/
     assert_file "spec/controllers/admin/base_controller_spec.rb", /describe Admin::BaseController do/
     assert_file "spec/controllers/admin/users_controller_spec.rb", /describe Admin::UsersController do/
+    assert_file "app/views/admin/users/index.html.erb"
+    assert_file "app/views/admin/users/show.html.erb"
+    assert_file "app/views/admin/users/new.html.erb"
+    assert_file "app/views/admin/users/edit.html.erb"
+    assert_file "app/views/admin/users/_form.html.erb"
+    assert_file "app/helpers/admin/base_helper.rb", /def sortable/
+  end
+
+  test "--no-create option skips assets to create new record" do
+    run_generator %w(User --no_create)
+
+    assert_no_file "app/views/admin/users/new.html.erb"
+
+    content = File.read("tmp/app/views/admin/users/index.html.erb")
+    assert content !~ /Create a new/
+
+    content = File.read("tmp/app/controllers/admin/users_controller.rb")
+    assert content !~ /def new/
+    assert content !~ /def create/
+
+    controller_spec_content = File.read("tmp/spec/controllers/admin/users_controller_spec.rb")
+    assert controller_spec_content !~ /GET new/
+    assert controller_spec_content !~ /POST create/
+  end
+
+  test "--read_only skips create, edit and update" do
+    run_generator %w(User --read_only)
+
+    assert_no_file "app/views/admin/users/new.html.erb"
+    assert_no_file "app/views/admin/users/edit.html.erb"
+    assert_no_file "app/views/admin/users/_form.html.erb"
+
+    index_content = File.read("tmp/app/views/admin/users/index.html.erb")
+    assert index_content !~ /Create a new/
+    assert index_content !~ /Edit/
+
+    controller_content = File.read("tmp/app/controllers/admin/users_controller.rb")
+    assert controller_content !~ /def new/
+    assert controller_content !~ /def create/
+    assert controller_content !~ /def edit/
+    assert controller_content !~ /def update/
+
+    controller_spec_content = File.read("tmp/spec/controllers/admin/users_controller_spec.rb")
+    assert controller_spec_content !~ /GET new/
+    assert controller_spec_content !~ /POST create/
+    assert controller_spec_content !~ /GET edit/
+    assert controller_spec_content !~ /PUT update/
   end
 end

metadata

@@ -1,68 +1,86 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: admin_view
-version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Marko Anastasov
 - Darko Fabijan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-19 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-10-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &17270240 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
   prerelease: false
-  version_requirements: *17270240
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: &17269740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.4.0
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *17269740
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: meta_search
-  requirement: &17269360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: *17269360
-- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: kaminari
-  requirement: &17268900 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        version: "0.12"
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
   prerelease: false
-  version_requirements: *17268900
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
 description: Rails 3 generator of admin views and controllers for existing models.
-email:
+email: 
 - devs@renderedtext.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -74,6 +92,7 @@ files:
 - lib/generators/admin_view_generator.rb
 - lib/generators/templates/base_controller.rb
 - lib/generators/templates/base_controller_spec.rb
+- lib/generators/templates/base_helper.rb
 - lib/generators/templates/controller.rb
 - lib/generators/templates/controller_spec.rb
 - lib/generators/templates/views/_form.html.erb
@@ -83,28 +102,36 @@ files:
 - lib/generators/templates/views/show.html.erb
 - test/admin_view_generator_test.rb
 - test/test_helper.rb
+has_rdoc: true
 homepage: http://github.com/renderedtext/admin_view
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: admin_view
-rubygems_version: 1.8.8
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Rails 3 generator of admin views and controllers for existing models.
-test_files: []
+test_files: 
+- test/admin_view_generator_test.rb
+- test/test_helper.rb