admin_view 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.swp
+.bundle
+Gemfile.lock
+bundle/
+pkg/*
+tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in admin_view.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Rendered Text: Darko Fabijan, Marko Anastasov
+
+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,31 @@
+# admin_view
+
+Rails 3 generator of CRUD admin controllers, views and specs for existing models.
+
+It uses [meta_search](https://github.com/ernie/meta_search) for search and [kaminari](https://github.com/amatsuda/kaminari) for pagination.
+
+Screenshot:
+
+![admin_view example screenshot](http://renderedtext.com/images/blog/admin_view.png)
+
+## Usage
+
+Include it in your Gemfile:
+
+	gem "admin_view"
+
+Run the generator:
+
+	$ bundle exec 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.
+
+## Contributing
+
+Yes! Feel free to fork the repo, make your changes in a topic branch and send us a pull request.
+
+If you're having a problem or found a bug, please open an issue in the GitHub [issue tracker](https://github.com/renderedtext/admin_view/issues).
+
+## License
+
+Copyright © 2011 [Rendered Text](http://renderedtext.com). admin_view is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+desc 'Test the admin_view plugin.'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.test_files = FileList['test/*_test.rb']
+  test.verbose = true
+end

data/admin_view.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "admin_view/version"
+
+Gem::Specification.new do |s|
+  s.name        = "admin_view"
+  s.version     = AdminView::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marko Anastasov", "Darko Fabijan"]
+  s.email       = ["devs@renderedtext.com"]
+  s.homepage    = "http://github.com/renderedtext/admin_view"
+  s.summary     = %q{Rails 3 generator of admin views and controllers for existing models.}
+  s.description = %q{Rails 3 generator of admin views and controllers for existing models.}
+
+  s.rubyforge_project = "admin_view"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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")
+end

data/lib/admin_view/version.rb

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

data/lib/generators/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates a CRUD admin controller, views and specs for an existing model.
+
+Example:
+    rails generate admin_view Model [--search_by column_name]

data/lib/generators/admin_view_generator.rb

@@ -0,0 +1,65 @@
+require 'rails/generators/resource_helpers'
+require 'rails/generators/named_base'
+
+class AdminViewGenerator < Rails::Generators::NamedBase
+
+  include Rails::Generators::ResourceHelpers
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  class_option :search_by, :type => :string, :desc => "The field or criteria to meta_search by (not required, but without a doubt recommended)"
+
+  def create_base_controller
+    empty_directory "app/controllers/admin"
+    path = File.join("app/controllers/admin", "base_controller.rb")
+    template("base_controller.rb", path) unless File.exists?(path)
+  end
+
+  def create_base_controller_spec
+    empty_directory "spec/controllers/admin"
+    path = File.join("spec/controllers/admin", "base_controller_spec.rb")
+    template("base_controller_spec.rb", path) unless File.exists?(path)
+  end
+
+  def create_controller
+    template "controller.rb", File.join("app/controllers/admin", "#{controller_file_name}_controller.rb")
+  end
+
+  def create_controller_rspec
+    template "controller_spec.rb", File.join("spec/controllers/admin", "#{controller_file_name}_controller_spec.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
+    end
+  end
+
+  def add_resource_route
+    return if not File.exists?("config/routes.rb")
+    route_config =  "namespace :admin do "
+    route_config << "resources :#{file_name.pluralize}"
+    route_config << " end"
+    route route_config
+  end
+
+  protected
+
+  def available_views
+    ["index", "new", "show", "edit", "_form"]
+  end
+
+  def model_exists?(klass_name)
+    begin
+      klass = Module.const_get(klass_name)
+      return klass.superclass == ActiveRecord::Base
+    rescue NameError
+      return false
+    end
+  end
+
+end

data/lib/generators/templates/base_controller.rb

@@ -0,0 +1,18 @@
+class Admin::BaseController < ApplicationController
+
+  before_filter :require_admin
+
+  protected
+
+  def require_admin
+    unless current_user.try(:admin?)
+      render404 and return false
+    end
+  end
+
+  def render404
+    render :file => File.join(Rails.root, 'public', '404.html'), :status => 404
+    return true
+  end
+
+end

data/lib/generators/templates/base_controller_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Admin::BaseController do
+
+  describe "GET 'index'" do
+
+    context "logged in as admin" do
+
+      it "renders index page" do
+        controller.stub_chain(:current_user, :admin?).and_return(true)
+        get :index
+        response.should render_template('index')
+      end
+
+    end
+
+    context "logged in as user" do
+
+      it "renders 404" do
+        controller.stub_chain(:current_user, :admin?).and_return(false)
+        get :index
+        response.should render_template('404.html')
+        response.response_code.should eql(404)
+      end
+
+    end
+
+    context "not logged in" do
+
+      it "renders 404" do
+        controller.stub(:current_user).and_return(nil)
+        get :index
+        response.should render_template('404.html')
+        response.response_code.should eql(404)
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/templates/controller.rb

@@ -0,0 +1,67 @@
+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]
+
+  def index
+    @search = <%= class_name %>.search(params[:search])
+    @<%= plural_table_name %> = find_<%= plural_table_name %>
+  end
+
+  def new
+    @<%= singular_table_name %> = <%= class_name %>.new
+  end
+
+  def create
+    @<%= singular_table_name %> = <%= class_name %>.new(params[:<%= singular_table_name %>])
+    if @<%= singular_table_name %>.save
+      redirect_to admin_<%= plural_table_name %>_path, :notice => "Successfully created <%= human_name.downcase %>."
+    else
+      render :new
+    end
+  end
+
+  def show
+  end
+
+  def edit
+  end
+
+  def update
+    if @<%= singular_table_name %>.update_attributes(params[:<%= singular_table_name %>])
+      redirect_to admin_<%= plural_table_name %>_path, :notice => "Successfully updated <%= human_name.downcase %>."
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @<%= singular_table_name %>.destroy
+    redirect_to admin_<%= plural_table_name %>_path, :notice => "<%= human_name %> has been deleted."
+  end
+
+  protected
+
+  def find_<%= singular_table_name %>
+    @<%= singular_table_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  def find_<%= plural_table_name %>
+    search_relation = @search.relation
+    search_relation.order(sort_column + " " + sort_direction).page params[:page]
+  end
+
+  def sort_column
+    <%= class_name %>.column_names.include?(params[:sort]) ? params[:sort] : "created_at"
+  end
+
+  def sort_direction
+    %w[asc desc].include?(params[:direction]) ? params[:direction] : "desc"
+  end
+
+  def search_params
+    {:search => params[:search]}
+  end
+
+end

data/lib/generators/templates/controller_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe Admin::<%= controller_class_name %>Controller do
+
+  def mock_<%= singular_table_name %>(stubs={})
+    (@mock_<%= singular_table_name %> ||= mock_model(<%= class_name %>).as_null_object).tap do |<%= singular_table_name %>|
+      <%= singular_table_name %>.stub(stubs) unless stubs.empty?
+    end
+  end
+
+  before { controller.stub(:require_admin) }
+
+  describe "GET index" do
+    it "assigns all <%= plural_table_name %> as @<%= plural_table_name %>" do
+      controller.stub(:find_<%= plural_table_name %>).and_return([mock_<%= singular_table_name %>])
+      get :index
+      assigns(:<%= plural_table_name %>).should eq([mock_<%= singular_table_name %>])
+    end
+  end
+
+  describe "GET show" do
+    it "assigns the requested <%= singular_table_name %> as @<%=singular_table_name %>" do
+      <%= class_name %>.stub(:find).with("37") { mock_<%= singular_table_name %> }
+      get :show, :id => "37"
+      assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+    end
+  end
+
+  describe "GET new" do
+    it "assigns a new <%= singular_table_name %> as @<%= singular_table_name %>" do
+      <%= class_name %>.stub(:new) { mock_<%= singular_table_name %> }
+      get :new
+      assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+    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
+      it "assigns a newly created <%= singular_table_name %> as @<%= singular_table_name %>" do
+        <%= class_name %>.stub(:new).with({'these' => 'params'}) { mock_<%= singular_table_name %>(:save => true) }
+        post :create, :<%= singular_table_name %> => {'these' => 'params'}
+        assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+      end
+
+      it "redirects to the created <%= singular_table_name %>" do
+        <%= class_name %>.stub(:new) { mock_<%= singular_table_name %>(:save => true) }
+        post :create, :<%= singular_table_name %> => {}
+        response.should redirect_to(admin_<%= plural_table_name %>_url)
+      end
+    end
+
+    describe "with invalid params" do
+      it "assigns a newly created but unsaved <%= singular_table_name %> as @<%= singular_table_name %>" do
+        <%= class_name %>.stub(:new).with({'these' => 'params'}) { mock_<%= singular_table_name %>(:save => false) }
+        post :create, :<%= singular_table_name %> => {'these' => 'params'}
+        assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+      end
+
+      it "re-renders the 'new' template" do
+        <%= class_name %>.stub(:new) { mock_<%= singular_table_name %>(:save => false) }
+        post :create, :<%= singular_table_name %> => {}
+        response.should render_template("new")
+      end
+    end
+
+  end
+
+  describe "PUT update" do
+
+    describe "with valid params" do
+      it "updates the requested <%= singular_table_name %>" do
+        <%= class_name %>.should_receive(:find).with("37") { mock_<%= singular_table_name %> }
+        mock_<%= singular_table_name %>.should_receive(:update_attributes).with({'these' => 'params'})
+        put :update, :id => "37", :<%= singular_table_name %> => {'these' => 'params'}
+      end
+
+      it "assigns the requested <%= singular_table_name %> as @<%= singular_table_name %>" do
+        <%= class_name %>.stub(:find) { mock_<%= singular_table_name %>(:update_attributes => true) }
+        put :update, :id => "1"
+        assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+      end
+
+      it "redirects to the <%= singular_table_name %>" do
+        <%= class_name %>.stub(:find) { mock_<%= singular_table_name %>(:update_attributes => true) }
+        put :update, :id => "1"
+        response.should redirect_to(admin_<%= plural_table_name %>_url)
+      end
+    end
+
+    describe "with invalid params" do
+      it "assigns the <%= singular_table_name %> as @<%= singular_table_name %>" do
+        <%= class_name %>.stub(:find) { mock_<%= singular_table_name %>(:update_attributes => false) }
+        put :update, :id => "1"
+        assigns(:<%= singular_table_name %>).should be(mock_<%= singular_table_name %>)
+      end
+
+      it "re-renders the 'edit' template" do
+        <%= class_name %>.stub(:find) { mock_<%= singular_table_name %>(:update_attributes => false) }
+        put :update, :id => "1"
+        response.should render_template("edit")
+      end
+    end
+
+  end
+
+  describe "DELETE destroy" do
+    it "destroys the requested <%= singular_table_name %>" do
+      <%= class_name %>.should_receive(:find).with("37") { mock_<%= singular_table_name %> }
+      mock_<%= singular_table_name %>.should_receive(:destroy)
+      delete :destroy, :id => "37"
+    end
+
+    it "redirects to the <%= plural_table_name %> list" do
+      <%= class_name %>.stub(:find) { mock_<%= singular_table_name %> }
+      delete :destroy, :id => "1"
+      response.should redirect_to(admin_<%= plural_table_name %>_url)
+    end
+  end
+
+end
+

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

@@ -0,0 +1,12 @@
+<%%= f.error_messages %>
+
+<% @attributes.each do |attribute| -%>
+  <% next if ["id", "created_at", "updated_at"].include?(attribute.name) -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.text_field :<%= attribute.name %> %>
+  </p>
+<% end -%>
+
+<%% label = @<%= singular_table_name %>.new_record? ? "Create" : "Update" -%>
+<%%= f.submit label %>

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

@@ -0,0 +1,5 @@
+<h1>Editing <%= human_name.downcase %></h1>
+
+<%%= form_for [:admin, @<%= singular_table_name %>] do |f| -%>
+  <%%= render "form", { :f => f } %>
+<%% end -%>

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

@@ -0,0 +1,43 @@
+<h2><%= human_name.pluralize %></h2>
+
+<%%= form_for @search, :url => admin_<%= plural_table_name %>_path, :html => {:method => :get} do |f| %>
+  <% if options[:search_by].blank? -%>
+  <!--
+  <% end %>
+  <!-- feel free to add further search options, eg foo_or_bar_contains -->
+  <%%= f.label :<%= options[:search_by] %>_contains, "Search by <%= options[:search_by] %>" %>
+  <%%= f.text_field :<%= options[:search_by] %>_contains %>
+  <%%= f.submit %>
+  <% if options[:search_by].blank? -%>
+  --><p>Set up your search form or delete.</p>
+  <% end %>
+<%% end %>
+
+<p><%%= link_to("Create a new <%= human_name %>", new_admin_<%= singular_table_name %>_path) %></p>
+
+<table class="sortable">
+  <thead>
+    <tr>
+<% @attributes.each do |attribute| -%>
+      <th><%%= sortable "<%= attribute.name %>" %></th>
+<% end -%>
+      <th>Edit</th>
+      <th>Delete</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+      <tr>
+        <td><%%= link_to(<%= singular_table_name %>.id, admin_<%= singular_table_name %>_path(<%= singular_table_name %>)) %></td>
+<% @attributes.each do |attribute| -%>
+<% next if attribute.name == "id" -%>
+        <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+        <td><%%= link_to('Edit', edit_admin_<%= singular_table_name %>_path(<%= singular_table_name %>)) %></td>
+        <td><%%= link_to('Delete', admin_<%= singular_table_name %>_path(<%= singular_table_name %>), :confirm => "Are you sure?", :method => :delete) %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<%%= paginate @<%= plural_table_name %> %>

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

@@ -0,0 +1,5 @@
+<h1>Create new <%= human_name.downcase %></h1>
+
+<%%= form_for [:admin, @<%= singular_table_name %>] do |f| -%>
+  <%%= render "form", { :f => f } %>
+<%% end -%>

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

@@ -0,0 +1,11 @@
+<h1><%= human_name.capitalize %> <%%= @<%= singular_table_name %>.id %></h1>
+
+<% @attributes.each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+<% end -%>
+
+<%%= link_to "Edit", edit_admin_<%= singular_table_name %>_path(@<%= singular_table_name %>) %> |
+<%%= link_to "Back", admin_<%= plural_table_name %>_path %>

data/test/admin_view_generator_test.rb

@@ -0,0 +1,19 @@
+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)
+
+    assert_file "app/controllers/admin/base_controller.rb", /class Admin::BaseController < ApplicationController/
+    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/
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'test/unit'
+require 'active_support/test_case'
+require 'rails/all'
+require 'rails/generators'
+require 'rails/generators/test_case'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: admin_view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marko Anastasov
+- Darko Fabijan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-19 00:00:00.000000000Z
+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
+  type: :runtime
+  prerelease: false
+  version_requirements: *17269740
+- !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
+  name: kaminari
+  requirement: &17268900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17268900
+description: Rails 3 generator of admin views and controllers for existing models.
+email:
+- devs@renderedtext.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- admin_view.gemspec
+- lib/admin_view/version.rb
+- lib/generators/USAGE
+- lib/generators/admin_view_generator.rb
+- lib/generators/templates/base_controller.rb
+- lib/generators/templates/base_controller_spec.rb
+- lib/generators/templates/controller.rb
+- lib/generators/templates/controller_spec.rb
+- lib/generators/templates/views/_form.html.erb
+- lib/generators/templates/views/edit.html.erb
+- lib/generators/templates/views/index.html.erb
+- lib/generators/templates/views/new.html.erb
+- lib/generators/templates/views/show.html.erb
+- test/admin_view_generator_test.rb
+- test/test_helper.rb
+homepage: http://github.com/renderedtext/admin_view
+licenses: []
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: admin_view
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Rails 3 generator of admin views and controllers for existing models.
+test_files: []