admin-theme 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in admin-theme.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,32 @@
+Except for those files subject to other licenses (as noted in the file or in
+documentation accompanying the file), all files contained within this directory
+are distributed under the following license:
+
+ - * -
+
+Copyright (c) 2012 Nihad Abbasov <http://github.com/narkoz>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+ - * -

data/README.md

@@ -0,0 +1,115 @@
+# Admin Theme [![build status](https://secure.travis-ci.org/simmetria/admin-theme.png)](https://secure.travis-ci.org/simmetria/admin-theme)
+
+Admin theme is a fork of [Web App Theme](https://github.com/pilu/web-app-theme) generator. See [demo](http://pilu.github.com/web-app-theme).  
+It aims the same goal as a main branch: to generate admin panels quickly.
+
+Changes from main branch:
+
+* Rails 3.1+ compatibility
+* Asset pipeline integration
+* Auto generation of resources
+* Improved I18n support
+* Only default theme included
+* Kaminari for pagination (optional)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'admin-theme'
+```
+
+If you want to paginate records in admin panel also add:
+
+```ruby
+gem 'kaminari'
+gem 'kaminari-admin-theme'
+```
+
+Run `bundle install`
+
+## Usage
+
+1. First time you need to setup admin-theme:
+
+  ```sh
+  rails generate admin_theme:setup
+  ```
+
+  This will generate some controllers, views for admin panel and prepare assets:
+
+  ```sh
+  create  app/views/layouts/admin.html.erb
+  create  app/views/admin/shared/_sidebar.html.erb
+  create  app/views/admin/dashboard/show.html.erb
+  create  app/controllers/admin/base_controller.rb
+  create  app/controllers/admin/dashboard_controller.rb
+  insert  config/routes.rb
+  create  app/assets/stylesheets/admin.css
+  create  app/assets/javascripts/admin.js
+  ```
+
+  You can pass `app_name` option to specify the application name:
+
+  ```sh
+  rails generate admin_theme:setup --app_name="Custom name"
+  ```
+
+  After you will be able to access admin panel at `localhost:3000/admin`.
+
+2. Move application stylesheets to `another_dir` and change `application.css` to not load admin-theme stylesheets:
+
+  ```patch
+  --*= require_tree .
+  ++*= require_tree ./another_dir
+  ```
+
+3. You can now use admin-theme resource generator to generate necessary resources in admin panel:
+
+  ```sh
+  rails generate admin_theme:resource posts # assuming you have a model named Post
+  ```
+
+  If you want to enable pagination:
+
+  ```sh
+  rails generate admin_theme:resource posts --pagination
+  ```
+
+  If you want to generate resource with different name you can explicitly specify the model name in the second parameter:
+
+  ```sh
+  rails generate admin_theme:resource items post # assuming you have a model named Post
+  ```
+
+## i18n
+
+See [`config/locales`](https://github.com/simmetria/admin-theme/tree/master/config/locales) for available translations.  
+You can add one by yourself in `config/locales`:
+
+```yaml
+time:
+  formats:
+    admin-theme: "%d %b %Y [%H:%M]"
+
+admin-theme:
+  save: Save
+  cancel: Cancel
+  list: List
+  edit: Edit
+  new: New
+  show: Show
+  delete: Delete
+  confirm: Are you sure?
+  created_at: Created at
+  all: All
+  or: or
+```
+
+## Credits
+
+* Web App Theme: [Andrea Franz](http://gravityblast.com)
+* Icons: [FAMFAMFAM Silk icons](http://www.famfamfam.com/lab/icons/silk)
+* Buttons: Particletree - Rediscovering the Button Element
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc 'Run features'
+task :spinach do
+  system 'bundle exec spinach'
+end
+
+task :default => :spinach

data/admin-theme.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/admin-theme/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nihad Abbasov"]
+  gem.email         = ["mail@narkoz.me"]
+  gem.description   = %q{Allows to generate admin panels quickly}
+  gem.summary       = %q{Admin panel generator}
+  gem.homepage      = "https://github.com/simmetria/admin-theme"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "admin-theme"
+  gem.require_paths = ["lib"]
+  gem.version       = Admin::Theme::VERSION
+
+  gem.add_runtime_dependency 'rails', '~> 3.1'
+  gem.add_runtime_dependency 'thor',  '~> 0.14'
+
+  gem.add_development_dependency 'spinach'
+end

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en:
+  time:
+    formats:
+      admin-theme: "%d %b %Y [%H:%M]"
+
+  admin-theme:
+    save: Save
+    cancel: Cancel
+    list: List
+    edit: Edit
+    new: New
+    show: Show
+    delete: Delete
+    confirm: Are you sure?
+    created_at: Created at
+    updated_at: Updated at
+    all: All
+    or: or

data/features/resource_generator.feature

@@ -0,0 +1,9 @@
+Feature: Test admin-theme resource generation
+
+  Scenario: Generate an admin-theme resource
+    Given a new rails app
+    And I install 'admin-theme' gem
+    And I run 'rails generate admin_theme:setup'
+    When I run 'rails generate admin_theme:resource posts'
+    Then the posts resource in admin panel should be generated
+    And the routes file should be modified

data/features/setup_generator.feature

@@ -0,0 +1,8 @@
+Feature: Test admin-theme setup
+
+  Scenario: Setup admin-theme
+    Given a new rails app
+    And I install 'admin-theme' gem
+    When I run 'rails generate admin_theme:setup'
+    Then the necessary files should be generated
+    And the assets and routes files should be modified

data/features/steps/test_admin_theme_resource_generation.rb

@@ -0,0 +1,31 @@
+class TestAdminThemeResourceGeneration < Spinach::FeatureSteps
+  include Helpers
+
+  Given 'a new rails app' do
+    `rails new #{app_name}`
+  end
+
+  And 'I install \'admin-theme\' gem' do
+    in_app_dir { `echo "'admin-theme', github: 'simmetria/admin-theme'" >> Gemfile && bundle` }
+  end
+
+  And 'I run \'rails generate admin_theme:setup\'' do
+    in_app_dir { `rails g admin_theme:setup` }
+  end
+
+  When 'I run \'rails generate admin_theme:resource posts\'' do
+    in_app_dir { @output = `rails g admin_theme:resource posts` }
+  end
+
+  Then 'the posts resource in admin panel should be generated' do
+    resource_files.each { |f| @output.must_include f }
+    @output.scan('create').size.must_equal 6
+    @output.scan('insert').size.must_equal 1
+    @output.scan('gsub').size.must_equal 1
+  end
+
+  And 'the routes file should be modified' do
+    routes = read_file('config/routes.rb')
+    routes.must_include "resources :posts"
+  end
+end

data/features/steps/test_admin_theme_setup.rb

@@ -0,0 +1,36 @@
+class TestAdminThemeSetup < Spinach::FeatureSteps
+  include Helpers
+
+  Given 'a new rails app' do
+    `rails new #{app_name}`
+  end
+
+  And 'I install \'admin-theme\' gem' do
+    in_app_dir { `echo "'admin-theme', github: 'simmetria/admin-theme'" >> Gemfile && bundle` }
+  end
+
+  When 'I run \'rails generate admin_theme:setup\'' do
+    in_app_dir { @output = `rails g admin_theme:setup` }
+  end
+
+  Then 'the necessary files should be generated' do
+    setup_files.each { |f| @output.must_include f }
+    @output.scan('create').size.must_equal 7
+    @output.scan('insert').size.must_equal 1
+  end
+
+  And 'the assets and routes files should be modified' do
+    routes = read_file('config/routes.rb')
+    routes.must_include "namespace :admin do"
+    routes.must_include "root :to => 'dashboard#show', :as => 'dashboard'"
+
+    stylesheet = read_file('app/assets/stylesheets/admin.css')
+    stylesheet.must_include "*= require web-app-theme"
+    stylesheet.must_include "*= require web-app-theme/default"
+    stylesheet.must_include "*= require_self"
+
+    javascript = read_file('app/assets/javascripts/admin.js')
+    javascript.must_include "//= require jquery"
+    javascript.must_include "//= require jquery_ujs"
+  end
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'minitest/spec'

data/features/support/helpers.rb

@@ -0,0 +1,39 @@
+module Helpers
+  def app_name
+    @app_name = "tmp/test_app#{rand(10..100)}"
+  end
+
+  def in_app_dir(&block)
+    Dir.chdir(@app_name, &block)
+  end
+
+  def read_file(file)
+    in_app_dir { File.read(file) }
+  end
+
+  def setup_files
+    [
+      "app/views/layouts/admin.html.erb",
+      "app/views/admin/shared/_sidebar.html.erb",
+      "app/views/admin/dashboard/show.html.erb",
+      "app/controllers/admin/base_controller.rb",
+      "app/controllers/admin/dashboard_controller.rb",
+      "config/routes.rb",
+      "app/assets/stylesheets/admin.css",
+      "app/assets/javascripts/admin.js"
+    ]
+  end
+
+  def resource_files
+    [
+      "app/controllers/admin/posts_controller.rb",
+      "config/routes.rb",
+      "app/views/admin/posts/_form.html.erb",
+      "app/views/admin/posts/edit.html.erb",
+      "app/views/admin/posts/index.html.erb",
+      "app/views/admin/posts/new.html.erb",
+      "app/views/admin/posts/show.html.erb",
+      "app/views/layouts/admin.html.erb"
+    ]
+  end
+end

data/lib/admin-theme.rb

@@ -0,0 +1,7 @@
+require 'admin-theme/version'
+
+module Admin
+  module Theme
+    class Engine < Rails::Engine; end
+  end
+end

data/lib/admin-theme/version.rb

@@ -0,0 +1,5 @@
+module Admin
+  module Theme
+    VERSION = "1.0.1"
+  end
+end

data/lib/generators/admin_theme/resource/controllers/admin_resource_controller.erb

@@ -0,0 +1,46 @@
+class Admin::<%= plural_model_name %>Controller < Admin::BaseController
+  before_filter :find_<%= resource_name %>, :only => [:show, :edit, :update, :destroy]
+
+  def index
+    @<%= plural_resource_name %> = <%= model_name %>.<%= model_scope %>
+  end
+
+  def show
+  end
+
+  def new
+    @<%= resource_name %> = <%= model_name %>.new
+  end
+
+  def create
+    @<%= resource_name %> = <%= model_name %>.new(params[:<%= resource_name %>])
+
+    if @<%= resource_name %>.save
+      redirect_to <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :notice => "<%= model_name %> was successfully created."
+    else
+      render :new
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    if @<%= resource_name %>.update_attributes(params[:<%= resource_name %>])
+      redirect_to <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :notice => "<%= model_name %> was successfully updated."
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    @<%= resource_name %>.destroy
+    redirect_to <%= controller_routing_path %>_path, :notice => "<%= model_name %> was successfully deleted."
+  end
+
+  private
+
+  def find_<%= resource_name %>
+    @<%= resource_name %> = <%= model_name %>.find params[:id]
+  end
+end

data/lib/generators/admin_theme/resource/resource_generator.rb

@@ -0,0 +1,93 @@
+require 'rails/generators/generated_attribute'
+
+module AdminTheme
+  class ResourceGenerator < Rails::Generators::Base
+    desc "Creates the resource in admin panel."
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :resource,   :type => :string
+    argument :model_name, :type => :string, :required => false
+
+    class_option :pagination, :type => :boolean, :default => false, :desc => 'Specify if you use kaminari to paginate'
+
+    def initialize(args, *options)
+      super(args, *options)
+      initialize_views_variables
+    end
+
+    def generate_controller
+      template "../controllers/admin_resource_controller.erb", "app/controllers/admin/#{plural_resource_name}_controller.rb"
+      inject_into_file "config/routes.rb", "    resources :#{plural_resource_name}\n", :after => "namespace :admin do\n"
+    end
+
+    def generate_views
+      template "view_form.html.erb",   "app/views/admin/#{plural_resource_name}/_form.html.erb"
+      template "view_edit.html.erb",   "app/views/admin/#{plural_resource_name}/edit.html.erb"
+      template "view_index.html.erb",  "app/views/admin/#{plural_resource_name}/index.html.erb"
+      template "view_new.html.erb",    "app/views/admin/#{plural_resource_name}/new.html.erb"
+      template "view_show.html.erb",   "app/views/admin/#{plural_resource_name}/show.html.erb"
+
+      # Add link to resource in admin layout
+      gsub_file("app/views/layouts/admin.html.erb", /\<div\s+id=\"main-navigation\">.*\<\/ul\>/mi) do |match|
+        match.gsub!(/\<\/ul\>/, "")
+        %|#{match}  <li class="<%= controller_name == '#{plural_resource_name}' ? 'active' : '' %>">
+          <%= link_to "#{plural_model_name}", #{controller_routing_path}_path %>
+        </li>
+      </ul>|
+      end
+    end
+
+    private
+
+    def initialize_views_variables
+      @base_name, @controller_class_path, @controller_file_path,
+      @controller_class_nesting, @controller_class_nesting_depth = extract_modules("admin/#{resource}")
+
+      @controller_routing_path = @controller_file_path.gsub(/\//, '_')
+      @model_name = @base_name.singularize unless @model_name
+      @model_name = @model_name.camelize
+    end
+
+    def controller_routing_path
+      @controller_routing_path
+    end
+
+    def singular_controller_routing_path
+      @controller_routing_path.singularize
+    end
+
+    def model_name
+      @model_name
+    end
+
+    def plural_model_name
+      @model_name.pluralize
+    end
+
+    def resource_name
+      @model_name.underscore
+    end
+
+    def plural_resource_name
+      resource_name.pluralize
+    end
+
+    def model_scope
+      if options.pagination
+        'page(params[:page]).per(20)'
+      else
+        'all'
+      end
+    end
+
+    def extract_modules(name)
+      modules   = name.include?('/') ? name.split('/') : name.split('::')
+      name      = modules.pop
+      path      = modules.map { |m| m.underscore }
+      file_path = (path + [name.underscore]).join('/')
+      nesting   = modules.map { |m| m.camelize }.join('::')
+
+      [name, path, file_path, nesting, modules.size]
+    end
+  end
+end