dry_crud 1.4.0 → 1.5.0

data/README.rdoc

@@ -1,40 +1,42 @@
 = DRY CRUD
 
-DRY CRUD generates simple and extendable controller, views and helpers that support you to DRY up the CRUD code in your Rails project. Start with these elements and build a clean base to efficiently develop your application upon. First, you need to install the gem with
+DRY CRUD generates simple and extendable controller, views and helpers that support you to DRY up the CRUD code in your Rails project. Start with these elements and build a clean base to efficiently develop your application upon. 
 
-  gem install dry_crud
+Create your Rails application directly with the DRY CRUD application template:
 
-In order to use the generator, you have to register the gem in your Rails application's +Gemfile+. Add the following lines:
-
-  group :development do
-    gem 'dry_crud'
-  end
-
-Don't worry, it's a simple development dependency. You may even savely remove it after you have run in once. So now, you should run the generator to get the goodies:
+  rails new [APP_NAME] -m https://raw.github.com/codez/dry_crud/master/template.rb
+  
+If your application already exists or you prefer the DIY way, then install the Gem (<tt>gem install dry_crud</tt>), add it to your Gemfile and run the generator. You may remove the Gemfile entry again afterwards, it is not required anymore.
 
   rails generate dry_crud
+  
+If you prefer HAML templates instead of ERB, run
+
+  rails generate dry_crud -t haml
 
 To integrate DRY CRUD into your code, only a few additions are required:
 
 * For uniform CRUD functionality, just subclass your controllers from +CrudController+. 
 * Overwrite the <tt>:to_s</tt> method of your models for a human-friendly representation in captions.
 
-Version 1.4 and higher are built for Rails 3.1. As of Rails 3.1, views are inheritable as well, so a core functionality of DRY CRUD got into the Rails core itself. For Rails 3.0, use version 1.3.1 or refer to the rails-3.0 branch. If you need a version for Rails 2.3, please get version 0.6.0 of the gem or go to the rails-2.3 branch on Github. DRY CRUD 1.3 is fully compatible with Ruby 1.8.7, Ruby 1.9.2 and JRuby.
+Version 1.5 and higher are built for Rails 3.2. As of Rails 3.1, views are inheritable as well, so a core functionality of DRY CRUD got into the Rails core itself. For Rails 3.0, use version 1.3.1 or refer to the rails-3.0 branch. If you need a version for Rails 2.3, please get version 0.6.0 of the gem or go to the rails-2.3 branch on Github. DRY CRUD 1.3 and above are fully compatible with Ruby 1.8.7, Ruby 1.9.2 and JRuby.
 
 == Overview
 
-In most Rails applications, you have some models that require basic CRUD (create, read, update, delete) functionality. There are various possibilities like Rails scaffolding, {Inherited Resources}[https://github.com/josevalim/inherited_resources] or {Dry Scaffold}[http://github.com/grimen/dry_scaffold]. Still, various parts in your application remain duplicated. While you might pull up common methods into a common superclass controller, most views still contain very similar code.
+In most Rails applications, you have some models that require basic CRUD (create, read, update, delete) functionality. There are various possibilities like Rails scaffolding, {Inherited Resources}[https://github.com/josevalim/inherited_resources] or {Dry Scaffold}[http://github.com/grimen/dry_scaffold]. Still, various parts in your application remain duplicated. While you might pull up common methods into a common superclass controller, most views still contain very similar code. And then you also have to remember the entire API of these frameworks.
 
 Enter DRY CRUD.
 
 <b>
-The main idea of DRY CRUD is to concentrate basic functionality of your application, like CRUD actions, uniform formatting, forms and tables into specifically extendable units. DRY CRUD generates various foundation classes that you may freely adapt to your application's needs. For each model, you may transparently customize arbitrary parts or just fallback to the general behavior. This applies not only for controllers, but also for view templates and helpers. There is no black box your code depends on. You lay the foundation that fits your application best.
+The main idea of DRY CRUD is to concentrate basic functionality of your application, like CRUD actions, uniform formatting, forms and tables into specifically extendable units. DRY CRUD generates various foundation classes that you may browse easily and adapt freely to your application's needs. For each model, you may transparently customize arbitrary parts or just fallback to the general behavior. This applies not only for controllers, but also for view templates and helpers. There is no black box your code depends on. You lay the foundation that fits your application best.
 </b>
 
 DRY CRUD is a Rails generator. All code resides in your application and is open for you to inspect and to extend. You may pick whatever you consider useful or adapt what is not sufficient. Even if you do not require any CRUD functionality, you might find some helpers simplifying your work. There are no runtime dependencies to the dry_crud gem. Having said this, DRY CRUD does not want to provide a maximum of functionality that requires a lot of configuration, but rather a clean and lightweight foundation to build your application's requirements upon. This is why DRY CRUD comes as a generator and not as a Rails plugin.
 
 DRY CRUD does not depend on any other plugins, but easily allows you to integrate them in order to unify the behavior of your CRUD controllers. You might even use the plugins mentioned above to adapt your generated +CrudController+ base class. All classes come with thorough tests that provide you with a solid foundation for implementing your own adaptions.
 
+A basic CSS gets you started with your application's layout. For advanced needs, DRY CRUD supports the styles and classes used in {Bootstrap}[http://twitter.github.com/bootstrap/]. A great design never was so close.
+
 If you find yourself adapting the same parts of DRY CRUD for your applications over and over, please feel free to {fork me on Github}[http://github.com/codez/dry_crud].
 
 See the Examples section for some use cases and the Generated Files section below for details on the single classes and templates.
@@ -83,12 +85,6 @@ In <tt>app/views/list/index.html.erb</tt>, add the following line for the pagina
    <%= will_paginate @entries %>
 
 And we are done again. All our controllers inheriting from +ListController+, including above +PeopleController+, now have paginated index views. Because our customization for the people table is in the separate <tt>_list</tt> partial, no further modifications are required. 
-If the current page should be remembered while viewing or editing an entry, just add :page to the remembered_params in <tt>ListController::Memory</tt>:
-
-  controller.remember_params = [:q, :sort, :sort_dir, :page]
-  
-In this case, you should also pass the parameter <tt>page=1</tt> with a hidden field in your <tt>list/_search.html.erb</tt> to start displaying search results at page one.
-
 
 ==== Special formatting for selected attributes
 
@@ -101,7 +97,7 @@ In <tt>app/helpers/people.rb</tt>:
   
 Should you have attributes with the same name for multiple models that you want to be formatted the same way, you may define a helper method <tt>format_{attr}</tt> for these attributes.
 
-By the way: The method <tt>:f</tt> in +StandardHelper+ uniformly formats arbitrary values according to their class.  
+By the way: The method <tt>:f</tt> in +StandardHelper+ uniformly formats arbitrary values according to their class.
 
 
 ==== Filtering the index list
@@ -185,11 +181,23 @@ Even +belongs_to+ associations are automatically rendered with a select field. B
 
 Yes, it's bad practice to use finder logic in your views! Define the variable <tt>@hometowns</tt> in your controller instead (as shown in the example above), and you do not even have to specify the <tt>:list</tt> option.
 
+
+=== Nested Resources
+
+In case you define nested resources, your +CrudController+ subclass should know. Listing and creating entries as well as displaying links for these resources is dependent on the nesting hierarchy. This is how you declare the namespaces and parent resources in your controller:
+
+  self.nesting = :my_namspace, ParentResource
+  
+This declaration is for a controller nested in +parent_resources+ within a +:my_namespace+ scope. +ParentResource+ is the corresponding +ActiveRecord+ model. The request param +:parent_resource_id+ is used to load the parent entry, which in turn is used to filter the entries listed and created in your controller.
+
+The <tt>ListController::Nesting</tt> module defines this basic behaviour. For more complex setups, have a look there and adjust it to your needs.
+
+
 === Internationalization (I18N)
 
 All text strings used are externalized to an english locale yaml. The keys are organized by controller and template name plus a generic global scope. 
 
-To represent the controller hierarchy used by <tt>render_inheritable</tt>, a special translation helper <tt>:ti</tt> looks up keys along this hierarchy in the following order:
+To represent your controller hierarchy, a special translation helper <tt>:ti</tt> looks up keys along the hierarchy in the following order:
   {controller_name}.{template_name}.{key}
   {controller_name}.{action_name}.{key}
   {controller_name}.global.{key}
@@ -215,7 +223,7 @@ All generated files are supposed to provide a reasonable foundation for the CRUD
 
 {controller/crud_controller.rb}[http://codez.ch/dry_crud/?q=CrudController]:: Abstract controller providing basic CRUD actions. This implementation mainly follows the one of the Rails scaffolding controller and responses to HTML and XML requests. Some enhancements were made to ease extendability. Several protected helper methods are there to be (optionally) overriden by subclasses. With the help of additional callbacks, it is possible to hook into the action procedures without overriding the entire method. This class is based on +ListController+.
 
-{controller/list_controller.rb}[http://codez.ch/dry_crud/?q=ListController]:: Abstract controller providing a basic list action. There are two sub-modules that provide search and sort functionality for the table displayed in the list action. A third sub-module remembers the list parameters in order to return to an identical list.
+{controller/list_controller.rb}[http://codez.ch/dry_crud/?q=ListController]:: Abstract controller providing a basic list action. Use this controller if you require read-only functionality. There are two sub-modules that provide search and sort functionality for the table displayed in the list action. A third sub-module remembers the list parameters in order to return to an identical list.
 
 
 === Helpers:
@@ -275,9 +283,9 @@ views/layouts/crud.html.erb:: An example layout showing how to use the <tt>@titl
 
 views/layouts/_menu.html.erb:: An empty file to put your menu items into. Included from <tt>crud.html.erb</tt>.
 
-public/stylesheets/crud.css:: A simple CSS with all the classes and ids used in the CRUD code. 
+app/assets/stylesheets/crud.scss:: A simple SCSS with all the classes and ids used in the CRUD code. 
 
-public/images/action/*.png:: Some sample action icons from the {Open Icon Library}[http://openiconlibrary.sourceforge.net].
+app/assets/images/action/*.png:: Some sample action icons from the {Open Icon Library}[http://openiconlibrary.sourceforge.net].
 
 
 === Tests:
@@ -291,4 +299,4 @@ public/images/action/*.png:: Some sample action icons from the {Open Icon Librar
 test/several other tests:: Testing the provided implementation and a great base to test your adaptions of the CRUD code.
 
 
-
+{<img src="https://secure.travis-ci.org/codez/dry_crud.png" />}[http://travis-ci.org/codez/dry_crud]

data/Rakefile

@@ -19,16 +19,6 @@ task :test => ['test:app:init'] do
   end
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test| 
-    test.libs << "test/test_app/test"
-    test.test_files = Dir[ "test/test_app/test/**/*_test.rb" ]
-    test.rcov_opts = ['--text-report',
-                      '-i', '"test\/test_app\/app\/.*"',
-                      '-x', '"\/Library\/Ruby\/.*"']
-    test.verbose = true
-end
-
 namespace :test do
   namespace :app do
     task :environment do
@@ -41,7 +31,7 @@ namespace :test do
     desc "Create a rails test application"
     task :create do
       unless File.exist?(TEST_APP_ROOT)
-        sh "rails new #{TEST_APP_ROOT}"
+        sh "rails new #{TEST_APP_ROOT} --skip-bundle"
         FileUtils.cp(File.join(File.dirname(__FILE__), 'test', 'templates', 'Gemfile'), TEST_APP_ROOT)
         sh "cd #{TEST_APP_ROOT}; bundle install" # update Gemfile.lock
         FileUtils.rm_f(File.join(TEST_APP_ROOT, 'test', 'performance', 'browsing_test.rb'))
@@ -52,21 +42,64 @@ namespace :test do
     task :generate_crud => [:create, :environment] do
       require File.join(GENERATOR_ROOT, 'dry_crud_generator')
     
-      DryCrudGenerator.new('', {:force => true}, :destination_root => TEST_APP_ROOT).invoke_all
+      DryCrudGenerator.new('', {:force => true, :templates => ENV['HAML'] ? 'haml' : 'erb'}, :destination_root => TEST_APP_ROOT).invoke_all
     end
    
-    desc "Initializes the test application with a couple of classes"
-    task :init => :generate_crud do
+    desc "Populates the test application with some models and controllers"
+    task :populate => :generate_crud do
+      # copy test app templates
       FileUtils.cp_r(File.join(File.dirname(__FILE__), 'test', 'templates', '.'), TEST_APP_ROOT)
+      
+      # replace some unused files
       FileUtils.rm_f(File.join(TEST_APP_ROOT, 'public', 'index.html'))
-      FileUtils.mv(File.join(TEST_APP_ROOT, 'app', 'views', 'layouts', 'crud.html.erb'),
-                   File.join(TEST_APP_ROOT, 'app', 'views', 'layouts', 'application.html.erb'), 
-                   :force => true)
+      layouts = File.join(TEST_APP_ROOT, 'app', 'views', 'layouts')
+      FileUtils.mv(File.join(layouts, 'crud.html.erb'),
+                   File.join(layouts, 'application.html.erb'), 
+                   :force => true) if File.exists?(File.join(layouts, 'crud.html.erb'))
+      FileUtils.mv(File.join(layouts, 'crud.html.haml'),
+                   File.join(layouts, 'application.html.haml'), 
+                   :force => true) if File.exists?(File.join(layouts, 'crud.html.haml'))
+                   
+      # remove unused template type, erb or haml
+      exclude = ENV['HAML'] ? 'erb' : 'haml'
+      Dir.glob(File.join(TEST_APP_ROOT, 'app', 'views', '**', "*.#{exclude}")).each do |f|
+        FileUtils.rm(f)
+      end
+      
+      # migrate the database
       FileUtils.cd(TEST_APP_ROOT) do
-        sh "rake db:migrate db:seed RAILS_ENV=development"
-        sh "rake db:migrate RAILS_ENV=test"  # db:test:prepare does not work for jdbcsqlite3
+        sh "rake db:migrate db:seed RAILS_ENV=development --trace"
+        sh "rake db:migrate RAILS_ENV=test --trace"  # db:test:prepare does not work for jdbcsqlite3
       end
     end
+   
+    desc "Initializes the test application with a couple of classes"
+    task :init => [:populate, 
+                   :customize]
+                   
+    desc "Customize some of the functionality provided by dry_crud"
+    task :customize => ['test:app:add_pagination'
+                        #'test:app:use_bootstrap'
+                       ]
+    
+    desc "Adds pagination to the test app"
+    task :add_pagination => :generate_crud do
+      list_ctrl = File.join(TEST_APP_ROOT, 'app', 'controllers', 'list_controller.rb')
+      file_replace(list_ctrl, "@entries = list_entries", 
+                              "@entries = list_entries.page(params[:page]).per(10)")
+      file_replace(File.join(TEST_APP_ROOT, 'app', 'views', 'list', 'index.html.erb'), 
+                   "<%= render 'list' %>", "<%= paginate @entries %>\n\n<%= render 'list' %>")
+      file_replace(File.join(TEST_APP_ROOT, 'app', 'views', 'list', 'index.html.haml'), 
+                   "= render 'list'", "= paginate @entries\n\n= render 'list'")
+    end
+    
+    desc "Use Boostrap in the test app"
+    task :use_bootstrap => :generate_crud do
+       file_replace(File.join(TEST_APP_ROOT, 'app', 'assets', 'stylesheets', 'application.css'), " *= require_self", "*= require twitter/bootstrap\n *= require_self")
+       file_replace(File.join(TEST_APP_ROOT, 'app', 'assets', 'javascripts', 'application.js'), "//= require_tree .", "//= require twitter/bootstrap\n//= require_tree .")
+       FileUtils.rm(File.join(TEST_APP_ROOT, 'app', 'assets', 'stylesheets', 'sample.scss'))
+    end
+   
   end
 end
 
@@ -91,6 +124,18 @@ task :site => :rdoc do
   end
 end
 
+if RUBY_VERSION == '1.8.7' && RUBY_PLATFORM != 'java'
+	require 'rcov/rcovtask'
+	Rcov::RcovTask.new do |test| 
+	    test.libs << "test/test_app/test"
+	    test.test_files = Dir[ "test/test_app/test/**/*_test.rb" ]
+	    test.rcov_opts = ['--text-report',
+	                      '-i', '"test\/test_app\/app\/.*"',
+	                      '-x', '"\/Library\/Ruby\/.*"']
+	    test.verbose = true
+	end
+end
+
 # :package task
 Gem::PackageTask.new(DRY_CRUD_GEMSPEC) do |pkg|
   if Rake.application.top_level_tasks.include?('release')
@@ -125,3 +170,12 @@ task :release do
   puts " $ rake repackage"
   puts " $ gem push pkg/dry_crud-#{version}.gem"
 end
+
+
+def file_replace(file, expression, replacement)
+  return unless File.exists?(file)
+  text = File.read(file)
+  replaced = text.gsub(expression, replacement)
+  puts "WARN: Nothing replaced in '#{file}' for '#{expression}'" if text == replaced
+  File.open(file, "w") { |f| f.puts replaced }
+end

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/lib/generators/dry_crud/dry_crud_generator.rb

@@ -2,15 +2,24 @@ require 'rails/generators'
 
 class DryCrudGenerator < Rails::Generators::Base
 
+  class_options %w(templates -t) => 'erb'
+  
+  
   def self.source_root
      File.join(File.dirname(__FILE__), 'templates')
   end
 
   def install_dry_crud
     # copy everything in template subfolders
+    exclude = options[:templates].downcase == 'haml' ? '.erb' : '.haml'
+    
     Dir.chdir(self.class.source_root) do
-      Dir.glob("*").each do |f|
-        directory(f) if File.directory?(f)
+      Dir.glob(File.join('**', '**')).sort.each do |file_source|
+      	if !File.directory?(file_source) && 
+      	   !file_source.ends_with?(exclude) && 
+      	   file_source != 'INSTALL'
+        	copy_file(file_source) 
+        end
       end
     end
 

data/lib/generators/dry_crud/templates/app/assets/stylesheets/crud.scss

@@ -0,0 +1,64 @@
+
+.right {
+  text-align: right;
+}
+
+.center {
+  text-align: center;
+}
+
+.labeled {
+  vertical-align: top;
+  padding-bottom: 5px;
+  clear: both;
+}
+
+.labeled label {
+  width: 120px;
+  padding-right: 5px;
+  float: left;
+}
+
+.labeled .value {
+  margin-left: 130px;
+}
+
+.labeled .value p {
+  margin: 0;
+}
+
+.control-group {
+  clear: both;
+}
+
+.control-group label {
+  float: left;
+  width: 120px;
+  padding-top: 5px;
+  padding-right: 5px;
+}
+
+.controls {
+  margin-left: 130px;
+}
+
+.required {
+  font-size: 80%;
+  vertical-align: top;
+  margin-left: 2px;
+}
+
+#error_explanation h2 {
+  font-size: 100%;
+  margin-top: 0px;
+}
+
+#error_explanation ul {
+  margin-bottom: 5px;
+}
+
+.controls div.field_with_errors {
+  background-color: #da9;
+  display: inline-block;
+  padding: 1px 1px;
+}

data/lib/generators/dry_crud/templates/app/assets/stylesheets/sample.scss

@@ -0,0 +1,258 @@
+$container_width: 1000px;
+$theme_color: #2580a2;
+
+body, div, p, td, th {
+  font-family: Verdana, Geneva, Helvetica, Arial, sans-serif;
+  font-size: 13px;
+}
+
+body {
+  text-align: center;
+  margin: 0;
+  background-color: #ddf;
+}
+
+.container {
+  padding: 20px 20px;
+  margin: 0 auto;
+  text-align: left;
+  max-width: $container_width;
+  min-width: $container_width - 200px;
+  height: 100%;
+  background-color: #f6f6ff;
+  -moz-box-shadow: 0px 0px 5px $theme_color;
+  -webkit-box-shadow: 0px 0px 5px $theme_color;
+  box-shadow: 0px 0px 5px $theme_color;
+}
+
+#content {
+  clear: both;
+  padding-top: 5px;
+}
+
+h1 {
+  font-size: 150%;
+  margin: 30px 0 15px 0;
+}
+
+.table thead tr:nth-child(odd), .table thead tr:nth-child(even) {
+  background-color: #D0D0D0;
+}
+
+.table tr:nth-child(odd) {
+  background-color: #F8F8F8;
+}
+
+.table tr:nth-child(even) { 
+  background-color: #F0F0F0;
+}
+
+td {
+  vertical-align: top;
+}
+
+td p {
+  margin: 0;
+}
+
+a {
+  color: #2580a2;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+a:visited {
+  color:  #2580a2;
+}
+
+a img {
+  border: none;
+}
+
+.table {
+  margin-top: 10px;
+}
+
+table.table {
+  border-collapse: collapse;
+  width: 100%;
+  padding: 0;
+}
+
+/* div rendered if no entries available for list */
+div.table {}
+
+table.table th {
+  text-align: left;  
+  background-color: $theme_color;
+  color: white;
+  font-weight: bold;
+  padding: 2px 4px;
+}
+
+table.table th a {
+  color: white;  
+  text-decoration: none;
+}
+
+table.table td {
+  padding: 2px 4px;  
+}
+
+table.table td.action {
+  width: 20px;
+  text-align: center;
+}
+
+label {
+  font-style: italic;
+}
+
+.form-actions {
+  margin-left: 130px;
+}
+
+a.action {
+  padding: 0 5px;
+}
+
+a[class^="icon-"] {
+  margin-right: 5px;
+  margin-left: 5px;
+}
+
+a[class^="icon-"] img {
+  vertical-align: text-top;
+}
+
+[class^="icon-"] {
+  width: 16px;
+  height: 16px;
+  display: inline-block;
+  background: no-repeat;
+  vertical-align: top;
+}
+
+.icon-plus { background-image: image-url('actions/add.png'); }
+.icon-remove { background-image: image-url('actions/delete.png'); }
+.icon-pencil { background-image: image-url('actions/edit.png'); }
+.icon-list { background-image: image-url('actions/list.png'); }
+.icon-zoom-in { background-image: image-url('actions/show.png'); }
+
+input, textarea {
+  font-family: Verdana, Geneva, Helvetica, Arial, sans-serif;
+  font-size: 10px;
+}
+
+input[type=text], input[type=password] {
+  width: 180px;
+}
+
+input[type=number] {
+  width: 80px;
+}
+
+textarea {
+  width: 180px;
+  height: 80px;
+}
+
+.cancel {
+  font-size: 80%;
+  margin-left: 7px;
+}
+
+.alert {
+  margin: 15px;
+  padding: 5px 10px;
+}
+
+.alert-success {
+  border: solid 2px #6a6;
+  background-color: #afa;
+}
+
+.alert-error {
+  border: solid 2px #da9;
+  background-color: #fec;
+}
+
+.close {
+  float: right;
+}
+
+.pull-right {
+  float: right;
+}
+
+.pull-left {
+  float: left;
+}
+
+.navbar {
+  background: #333;
+  -moz-box-shadow: 0px 1px 1px $theme_color;
+  -webkit-box-shadow: 0px 1px 1px $theme_color;
+  box-shadow: 0px 1px 1px $theme_color;
+  padding: 0 20px;
+  max-width: $container_width;
+  min-width: $container_width - 200px;
+  height: 33px;
+  margin: -20px;
+}
+
+.brand {
+  float: left;
+  display: block;
+  font-weight: bold;
+  font-size: 130%;
+  color: #ddd;
+  padding: 5px;
+}
+
+a.brand:hover {
+  text-decoration: none;
+  color: #ddd;
+}
+
+.nav {
+  list-style: none;
+  margin: 0;
+  float: left;
+}
+
+.nav li {
+  float: left;
+  font-size: 110%;
+  margin: 0;
+  padding: 0;
+}
+
+.nav a {
+  background: #333 bottom right no-repeat;
+  color: #ddd;
+  display: block;
+  float: left;
+  margin: 0;
+  padding: 8px 12px 8px;
+  text-decoration: none;
+}
+
+.nav a:hover {
+  background: $theme_color bottom center no-repeat;
+  color: #fff;
+}
+
+footer {
+  margin: auto;
+  text-align: right;
+  max-width: $container_width;
+  min-width: $container_width - 200px;
+}
+
+footer * {
+  font-size: 80%;
+}