localized_scaffold 0.9

data/Gemfile

@@ -0,0 +1,6 @@
+# Localized Rails scaffolding with style...
+
+source 'http://rubygems.org'
+
+gem 'rails', '>= 3.0.0.beta3'
+gem 'devise', '>= 1.1.rc1'

data/README.rdoc

@@ -0,0 +1,273 @@
+= Localized Scaffold
+
+== About
+
+The "localized_scaffold" gem provides a Rails 3 generator for scaffolding
+with the same parameters as the orginal scaffold generator (it actually
+overwrites the original code) but producing localized views and localized
+controller flashes. It also generates a nicer user interface (for example with
+a title helper instead of generating h2) and produces a controller with some
+comments which also supports JSON. Localized Rails scaffolding with style...
+
+Just give it a try and toss it away if you don't like it -- it's pretty easy
+to have a test drive (see sample below).
+
+Rails 2: There is a Rails 2 compatible version which has to be installed as
+a Rails plugin instead of a gem. The latest Rails 2 version can be installed
+from branch "rails2".
+
+== Installation and usage
+
+Here are the steps to get a first impression about the generator:
+
+  rails foo
+  cd foo
+
+Edit the Gemfile to include "localized_scaffold" and optionally install the
+"will_paginate" gem to automatically add pagination using this library and to
+have everything around for authentication (see more on devise localization
+below):
+
+  vi Gemfile
+    gem 'localized_scaffold'
+    gem 'will_paginate', '>= 3.0.pre'
+
+  bundle install
+
+The generated code uses "form.error_messages" which was moved to a separate
+plugin in Rails 3 for some reason. Install the plugin or implement the method
+with your own code t osee error messages:
+
+  rails plugin install git://github.com/rails/dynamic_form.git
+
+A standard set of localization files will be installed in "config/locales" and
+a set of locale files is generated per scaffold. This setup has to be
+configured in the i18n configuration:
+
+  rake localized_scaffold:configure
+
+If you don't like a rake task to mess around with your application file, edit
+"config/application.rb") manually and add the following lines to the Rails
+initializer (only the two config lines...):
+
+  Rails::Initializer.run do |config|
+    config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '*.{rb,yml}')]
+    config.i18n.default_locale = :en
+  end
+
+Add more locale files by downloading them from a repository set up
+by Sven Fuchs at github (git://github.com/svenfuchs/rails-i18n.git) to
+"config/locales":
+
+  rake localized_scaffold:download_locales
+
+Have a look at the options supported by the generator:
+
+  rails generate localized_scaffold
+
+As a first test, just add a sample scaffold:
+
+  rails generate localized_scaffold bar name:string seats:integer
+  rake db:migrate
+
+  rails server
+
+Now open your browser and visit "http://localhost:3000/bars" to test the
+application and finally have a look at the localization files generated in
+"config/locales".
+
+And please contribute by sending in your localized versions of the default
+and standard locale files. :-)
+
+== One more thing...
+
+I couldn't resist to add a few small but powerful additions I need so often:
+Feel free to use or ignore them.
+
+=== Method to_s()
+
+Models should return something meaningful when to_s is called on their
+objects and optional option <code>--str</code> is used to do so. The to_s
+method of the model is generated to return the provided field (therefor the
+name of the option) and its fallback is the value of the searchbar option
+(see below) or the first attribute if that is missing as well. You can
+always modify the implementation of the method afterwards.
+
+Sample using "about" instead of default first attribute "name":
+
+  rails generate localized_scaffold company name:string about:text --str about
+
+=== Belongs to something
+
+There is an <code>--belongsto</code> option which can be used to generate
+model, controller and views for a "parent" belongs_to relationship like
+companies having many addresses or phone numbers.
+
+Here is a sample for exactly that:
+
+  rails generate localized_scaffold company name:string about:text
+
+  rails generate localized_scaffold address company_id:integer what:string \
+    street:string zip:string town:string state:string country:string \
+    --belongsto company --str town
+
+  rails generate localized_scaffold email company_id:integer kind:string \
+    address:string --belongsto company --str address
+
+There is only little linking between the interfaces and you should double
+check your routes, but after creating a new company at "/companies/new", you
+will be able to see all its addresses and add new ones at
+"/companies/1/addresses". Same for e-mail-addresses at "/companies/1/emails".
+
+=== Searchbar
+
+When there are lots of records, it makes sense to have an A B C picker and it
+would be nice to offer a simple search form for fast access to known objects.
+That's what the new <code>--searchbar</code> option does. It supports the
+<code>--belongsto</code> option but is also useful without.
+
+Here again a sample:
+
+  rails generate localized_scaffold company name:string about:text \
+    --searchbar name
+
+=== No show...
+
+Often the show view is not needed as the index view already displays all of
+its data. Just add this option to suppress its generation. The show action is
+still generated to support the XML and JSON format but for HTML the user will
+be redirected to the index page.
+
+Here is a sample:
+
+  rails generate localized_scaffold company name:string about:text --noshow
+
+=== Embedding in parent
+
+When having a belongs_to relationship, it might be nicer to not only link to
+that data from the show view of the "parent" but to actually embed a couple
+of items and use the index view only if more than a certain amount of items
+is available. That's what the <code>--embed</code> option is for:
+
+  rails generate localized_scaffold email company_id:integer what:string \
+    address:string --belongsto company --str address --embed 4
+
+=== Listify field values
+
+Some fields only allow a certain set of values and these values have to be
+localized as well. The listify option implements such a mechanism by creating
+a set of methods in the model and preparing the localization files. Sample:
+"salutation:mr,mrs,none kind:office,private,mobile,other"
+
+And a sample:
+
+  rails generate localized_scaffold email company_id:integer kind:string \
+    address:string --belongsto company --str address \
+    --listify "kind:office,private,other"
+
+There is still enough to do till you have a nice app and this is still
+scaffolding and nothing more, but these additional options should save some
+annoying work...
+
+== Demo
+
+As a wrap up, here is a complete sample of a simple phone book only using
+scaffolding:
+
+  rails phonebook
+  cd phonebook
+
+  vi Gemfile
+    gem 'localized_scaffold'
+    gem 'will_paginate', '>= 3.0.pre'
+
+  bundle install
+
+  rake localized_scaffold:download_locales
+  rake localized_scaffold:configure
+
+  rails plugin install git://github.com/rails/dynamic_form.git
+
+  vi config/application.rb
+    config.i18n.default_locale = :de # For example
+
+  rails generate localized_scaffold person salutation:string firstname:string \
+    lastname:string --searchbar lastname --listify "salutation:mr,mrs,none"
+
+  rails generate localized_scaffold phone person_id:integer kind:string \
+    number:string --belongsto person \
+    --listify "kind:office,private,mobile,fax,other" \
+    --str number --embed 5 --noshow
+
+  rails generate localized_scaffold email person_id:integer kind:string \
+    address:string --belongsto person --listify "kind:office,private,other" \
+    --str address --embed 5 --noshow
+
+  rake db:migrate
+
+  vi config/routes.rb
+    root :to => 'people#index'
+
+  rm public/index.html
+
+  rails server
+
+Now open http://localhost:3000/people to test the application and finally have
+a look at the localization files generated in "app/locale".
+
+== Devise
+
+There is an additional generator named "localized_devise_views" which does
+just would you would expect: It adds its own "devise_views.en.yml" etc. files
+and uses these files for localization of devise. The generated code also uses
+the title helper for title and headline which integrates better with the
+remaining application.
+
+Here are the additional steps to run a localized version of devise in the
+application above:
+
+  vi Gemfile
+    gem 'devise', '>= 1.1.rc1'
+
+  bundle install
+
+  rails generate devise_install
+
+  rails generate devise user
+
+  rails generate localized_devise_views user
+
+  rake db:migrate
+
+  vi app/controllers/application_controller.rb
+    before_filter :authenticate_user!, :except => [ :show, :index]
+
+  rails server
+
+Now open http://localhost:3000/people to test the application and check that
+you have to register to create a new person or edit an existing one.
+
+== Copyright & License
+
+Copyright (c) 2009, 2010 Jan Ulbrich
+
+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/generators/locales/standard.de-FO.yml

@@ -0,0 +1,106 @@
+# Do not edit this file: "It will be overwritten by the localized_scaffold"
+# generator!"
+
+de-FO:
+  standard:
+    language: "Deutsch"
+
+    cmds:
+      account: "Einstellungen"
+      add: "Hinzufügen"
+      add_above: "Oberhalb hinzufügen"
+      add_below: "Unterhalb hinzufügen"
+      add_left: "Links hinzufügen"
+      add_right: "Rechts hinzufügen"
+      all: "Alle anzeigen"
+      answer: "Beantworten"
+      back: "Zurück"
+      browse_back: "Zurückblättern"
+      browse_forward: "Vorblättern"
+      cancel: "Abbrechen"
+      change: "Ändern"
+      close: "Schliessen"
+      copy: "Kopieren"
+      create: "Speichern"
+      create_and_continue: "Speichern und weiterbearbeiten"
+      delete: "Löschen"
+      destroy: "Löschen"
+      display: "Anzeigen"
+      done: "Fertig"
+      download: "Laden"
+      edit: "Bearbeiten"
+      find: "Finden"
+      generate: "Generieren"
+      help: "Hilfe"
+      hide: "Ausblenden"
+      home: "Startseite"
+      import: "Importieren"
+      invite: "Einladen"
+      larger: "Grösser"
+      login: "Anmelden"
+      logout: "Abmelden"
+      modify: "Ändern"
+      more: "Mehr"
+      more_information: "Mehr Information"
+      new: "Neu"
+      next: "Weiter"
+      next_page: "Weiter"
+      ok: "OK"
+      open: "Öffnen"
+      overview: "Übersicht"
+      owner: "Besitzer"
+      preview: "Vorschau"
+      previous_page: "Zurück"
+      print: "Druckansicht"
+      refresh: "Aktualisieren"
+      register: "Registrieren"
+      register_continue: "Registrierung fortsetzen"
+      remove: "Entfernen"
+      reply: "Antworten"
+      reset: "Zurücksetzen"
+      save: "Speichern"
+      save_and_continue: "Speichern und Weiterbearbeiten"
+      search: "Suchen"
+      select: "Auswählen"
+      send: "Senden"
+      settings: "Einstellungen"
+      show: "Anzeigen"
+      smaller: "Kleiner"
+      style: "Darstellung"
+      update: "Speichern"
+      upload: "Hochladen"
+      users: "Benutzer"
+
+    errors:
+      cant_close_window: "Konnte dieses Fenster nicht automatisch geschlossen werden?"
+      login_required: "Für diese Aktion müssen Sie sich autorisieren."
+      no_data: "Keine passenden Daten gefunden..."
+      no_javascript: "Javascript benötigt"
+      access_denied: "Auf die angeforderte Seite haben Sie keinen Zugriff!"
+
+    in_place_edit:
+      cancel: "Abbrechen"
+      click_to_edit: "Anklicken zum Bearbeiten..."
+      click_tools_to_edit: "Icons anklicken um zu bearbeiten..."
+      loading: "Laden..."
+      ok: "OK"
+      saving: "Speichern..."
+
+    labels:
+      and: "und"
+      and_or: "und/oder"
+      are_you_sure: "Sind Sie sicher?"
+      confirmed: "bestätigt"
+      hits: "%s Treffer"
+      hours: "Stunden"
+      loading: "Lade Daten..."
+      no: "Nein"
+      or: "oder"
+      page: "Seite"
+      searchterm: "Suchbegriff"
+      unconfirmed: "unbestätigt"
+      yes: "Ja"
+
+    googlemap:
+      incompatible_browser: "Dieser Browser kann Google Maps leider nicht darstellen."
+      loading: "Lade Google Map..."

data/generators/locales/standard.de.yml

@@ -0,0 +1,106 @@
+# Do not edit this file: "It will be overwritten by the localized_scaffold"
+# generator!"
+
+de:
+  standard:
+    language: "Deutsch"
+
+    cmds:
+      account: "Einstellungen"
+      add: "Hinzufügen"
+      add_above: "Oberhalb hinzufügen"
+      add_below: "Unterhalb hinzufügen"
+      add_left: "Links hinzufügen"
+      add_right: "Rechts hinzufügen"
+      all: "Alle anzeigen"
+      answer: "Beantworten"
+      back: "Zurück"
+      browse_back: "Zurückblättern"
+      browse_forward: "Vorblättern"
+      cancel: "Abbrechen"
+      change: "Ändern"
+      close: "Schliessen"
+      copy: "Kopieren"
+      create: "Speichern"
+      create_and_continue: "Speichern und weiterbearbeiten"
+      delete: "Löschen"
+      destroy: "Löschen"
+      display: "Anzeigen"
+      done: "Fertig"
+      download: "Laden"
+      edit: "Bearbeiten"
+      find: "Finden"
+      generate: "Generieren"
+      help: "Hilfe"
+      hide: "Ausblenden"
+      home: "Startseite"
+      import: "Importieren"
+      invite: "Einladen"
+      larger: "Grösser"
+      login: "Anmelden"
+      logout: "Abmelden"
+      modify: "Ändern"
+      more: "Mehr"
+      more_information: "Mehr Information"
+      new: "Neu"
+      next: "Weiter"
+      next_page: "Weiter"
+      ok: "OK"
+      open: "Öffnen"
+      overview: "Übersicht"
+      owner: "Besitzer"
+      preview: "Vorschau"
+      previous_page: "Zurück"
+      print: "Druckansicht"
+      refresh: "Aktualisieren"
+      register: "Registrieren"
+      register_continue: "Registrierung fortsetzen"
+      remove: "Entfernen"
+      reply: "Antworten"
+      reset: "Zurücksetzen"
+      save: "Speichern"
+      save_and_continue: "Speichern und Weiterbearbeiten"
+      search: "Suchen"
+      select: "Auswählen"
+      send: "Senden"
+      settings: "Einstellungen"
+      show: "Anzeigen"
+      smaller: "Kleiner"
+      style: "Darstellung"
+      update: "Speichern"
+      upload: "Hochladen"
+      users: "Benutzer"
+
+    errors:
+      cant_close_window: "Konnte dieses Fenster nicht automatisch geschlossen werden?"
+      login_required: "Für diese Aktion musst Du Dich autorisieren."
+      no_data: "Keine passenden Daten gefunden..."
+      no_javascript: "Javascript benötigt"
+      access_denied: "Auf die angeforderte Seite hast Du keinen Zugriff!"
+
+    in_place_edit:
+      cancel: "Abbrechen"
+      click_to_edit: "Anklicken zum Bearbeiten..."
+      click_tools_to_edit: "Icons anklicken um zu bearbeiten..."
+      loading: "Laden..."
+      ok: "OK"
+      saving: "Speichern..."
+
+    labels:
+      and: "und"
+      and_or: "und/oder"
+      are_you_sure: "Bist Du sicher?"
+      confirmed: "bestätigt"
+      hits: "%s Treffer"
+      hours: "Stunden"
+      loading: "Lade Daten..."
+      no: "Nein"
+      or: "oder"
+      page: "Seite"
+      searchterm: "Suchbegriff"
+      unconfirmed: "unbestätigt"
+      yes: "Ja"
+
+    googlemap:
+      incompatible_browser: "Dieser Browser kann Google Maps leider nicht darstellen."
+      loading: "Lade Google Map..."

data/generators/locales/standard.en.yml

@@ -0,0 +1,106 @@
+# Do not edit this file: "It will be overwritten by the localized_scaffold"
+# generator!"
+
+en:
+  standard:
+    language: "English"
+
+    cmds:
+      account: "Account settings"
+      add: "Add"
+      add_above: "Add above"
+      add_below: "Add below"
+      add_left: "Add left"
+      add_right: "Add right"
+      all: "Show all"
+      answer: "Answer"
+      back: "Back"
+      browse_back: "Previous"
+      browse_forward: "Next"
+      cancel: "Cancel"
+      change: "Change"
+      close: "Close"
+      copy: "Copy"
+      create: "Create"
+      create_and_continue: "Create and continue editing"
+      delete: "Delete"
+      destroy: "Delete"
+      display: "Show"
+      done: "Done"
+      download: "Download"
+      edit: "Edit"
+      find: "Find"
+      generate: "Generate"
+      help: "Help"
+      hide: "Hide"
+      home: "Homepage"
+      import: "Import"
+      invite: "Invite"
+      larger: "Larger"
+      login: "Login"
+      logout: "Logout"
+      modify: "Modify"
+      more: "More"
+      more_information: "More information"
+      new: "New"
+      next: "Next"
+      next_page: "Next"
+      ok: "OK"
+      open: "Open"
+      overview: "Overview"
+      owner: "Owner"
+      preview: "Preview"
+      previous_page: "Previous"
+      print: "Print"
+      refresh: "Refresh"
+      register: "Register"
+      register_continue: "Continue registration"
+      remove: "Remove"
+      reply: "Reply"
+      reset: "Reset"
+      save: "Save"
+      save_and_continue: "Save and continue editing"
+      search: "Search"
+      select: "Select"
+      send: "Send"
+      settings: "Settings"
+      show: "Show"
+      smaller: "Smaller"
+      style: "Style"
+      update: "Update"
+      upload: "Upload"
+      users: "Users"
+
+    errors:
+      cant_close_window: "Couldn't the window be closed automatically?"
+      login_required: "You have to authenticate for this action."
+      no_data: "No matching data found..."
+      no_javascript: "Javascript needed"
+      access_denied: "You are not allowed to open the page you requested!"
+
+    in_place_edit:
+      cancel: "Cancel"
+      click_to_edit: "Click to edit..."
+      click_tools_to_edit: "Click tool icons to modify..."
+      loading: "Loading..."
+      ok: "OK"
+      saving: "Saving..."
+
+    labels:
+      and: "and"
+      and_or: "and/or"
+      are_you_sure: "Are you sure?"
+      confirmed: "confirmed"
+      hits: "%s hits"
+      hours: "hours"
+      loading: "Loading data..."
+      no: "No"
+      or: "or"
+      page: "Page"
+      searchterm: "Search term"
+      unconfirmed: "unconfirmed"
+      yes: "Yes"
+
+    googlemap:
+      incompatible_browser: "This web browser can't display Google Maps."
+      loading: "Loading Google Map..."

data/generators/localized_devise_views_generator.rb

@@ -0,0 +1,100 @@
+# Localized Rails scaffolding with style...
+
+require 'rails/generators/erb'
+require 'rails/generators/resource_helpers'
+require 'rails/generators/erb/scaffold/scaffold_generator'
+
+require File.join(File.dirname(__FILE__), 'localized_scaffold_generator')
+
+require 'find'
+
+# LocalizedDeviseViewsGenerator implements a generator doing the same as the
+# devise_views generator shipped with devise but adding localization the same
+# way as supported by the LocalizedScaffoldGenerator.
+#
+# Devise supports some localization but only for flashes and not for views.
+# This generator adds its own "devise_views.en.yml" etc. files and uses these
+# files for further localization. It also uses the title helper for title and
+# headline which integrated better with the remaining application.
+#
+# The generator was not written from scratch but hijacks basic functionality
+# from the scaffolding generator overwriting lookup rules to use the right
+# templates.
+
+class LocalizedDeviseViewsGenerator < Erb::Generators::Base
+  desc "Creates a set of localized views for Devise using the provided model name
+to access the user.
+
+The required NAME parameter is the name of the model devise was installed to
+run with (same you called \"rails generate devise\" with e.g. \"user\")."
+
+  include Rails::Generators::ResourceHelpers
+
+  # Returns a path relative to the generators directory optionally appending
+  # the provided filename.
+  #
+  # Parameters:
+  #
+  # [filename] Filename or array of filenames to add (defaults to none)
+
+  def self.generator_path(filename = '')
+    return File.join(File.expand_path(File.dirname(__FILE__)), 
+      'templates', 'devise', filename)
+  end
+
+  # Creates the views directory.
+
+  def create_root_folder
+    empty_directory File.join('app', 'views', 'devise')
+  end
+
+  # Generates all views in the views directory.
+
+  def copy_view_files
+    views = available_views
+
+    views.each do |filename|
+      template LocalizedDeviseViewsGenerator.generator_path(['views', filename]),
+        File.join('app', 'views', 'devise', filename)
+    end
+  end
+
+  # Copy locale files.
+  
+  def copy_standard_locales
+    locales = LocalizedDeviseViewsGenerator.generator_path('locales')
+
+    Dir.entries(locales).delete_if { |f| not f.match(/.*\.yml$/) }.each do |l|
+      template File.join(locales, l), File.join('config', 'locales', l)
+    end
+  end
+
+  # Copy of the scaffold layout and css file.
+
+  def copy_layout_and_stylesheet_files
+    template File.join(File.dirname(LocalizedDeviseViewsGenerator.generator_path),
+      'erb', 'scaffold', filename_with_extensions(:layout)),
+      File.join('app', 'views', 'layouts', filename_with_extensions('scaffold'))
+
+    template File.join(File.dirname(LocalizedDeviseViewsGenerator.generator_path),
+      'rails', 'stylesheets', 'templates', 'scaffold.css'),
+      File.join('public', 'stylesheets', 'scaffold.css')
+  end
+
+  def name
+    return @name.downcase
+  end
+
+protected
+
+  # Returns the views to generate.
+
+  def available_views
+    genpath = LocalizedDeviseViewsGenerator.generator_path('views')
+    views = []
+
+    Find.find(genpath) { |f| views << f.sub(genpath, '') if File.stat(f).file? }
+
+    return views
+  end
+end