Permalink
Browse files

Do housekeeping for a move from RubyForge to GitHub

* Assert the MIT License
* Rework the changelog into a RubyGem version history
* Switch to Markdown format for the readme and version history
* Correct encodings and line endings
  • Loading branch information...
1 parent d7c3856 commit 940e253cca4c9c85ffe833123f5807b63145fa51 @njonsson committed Nov 25, 2011
Showing with 255 additions and 262 deletions.
  1. +0 −100 CHANGELOG
  2. +74 −0 History.markdown
  3. +10 −0 MIT-LICENSE.markdown
  4. +0 −129 README
  5. +135 −0 README.markdown
  6. +1 −1 templates/form_trestle.rhtml
  7. +6 −3 templates/routes.rb
  8. +0 −1 templates/style.css
  9. +29 −28 trestle_generator.gemspec
View
100 CHANGELOG
@@ -1,100 +0,0 @@
-*SVN*
-
-
-*1.1.7.3* (August 17th, 2006)
-
-* Refactor redundant find expression. [vlad.zar@gmail.com]
-
-
-*1.1.7.2* (August 2nd, 2006)
-
-* Fix bug in routes that substitutes /:controller/:id/show for /:controller/:id. [carl@youngbloods.org]
-
-
-*1.1.7.1* (July 19th, 2006)
-
-* Assert bare template names instead of forcing a plural-model-name prefix. [njonsson]
-
-
-*1.1.7* (July 1st, 2006)
-
-* Add CHANGELOG to gemspec. [njonsson]
-
-* Create CHANGELOG. [njonsson]
-
-* Remove extended characters from gemspec description because of a bug in the Gem server indexing code. [njonsson]
-
-
-*1.1.6* (June 26th, 2006)
-
-* A bug inherited from scaffold generator: when a module is specified (e.g., Admin::People), the layout file gets created in app/views/layouts instead of in a subdirectory (e.g., app/views/layouts/admin). At runtime Rails renders all those views without a layout. [njonsson]
-
-
-*1.1.5* (May 17th, 2006)
-
-* Concatenation. [njonsson]
-
-* Anal-retentiveness is a virtue. [njonsson]
-
-* Shorten gem description to be friendlier to http://www.onestepback.org/gemwatch.rss. [njonsson]
-
-* Correct a README misstatement concerning the public interface of trestle controllers. [njonsson]
-
-* Add functional tests for #show, #edit and #destroy requests missing :id. [njonsson]
-
-
-*1.1.4* (May 11th, 2006)
-
-* Wrap source at column 80. [njonsson]
-
-* Add README to list of files installed by gem. [njonsson]
-
-* Minor wording change in README. [njonsson]
-
-* Remove dependency on Rails to better serve those running Rails from the application's vendor directory. [njonsson]
-
-* Swap constants in routes.rb for variables to suppress Ruby warning. [njonsson]
-
-
-*1.1.3* (May 11th, 2006)
-
-* Fix collision with existing migrations. Closes #4435. [njonsson]
-
-
-*1.1.2* (April 18th, 2006)
-
-* Conform to format of routes.rb from Rails trunk. [njonsson]
-
-* Update README and gemspec description to match web page. [njonsson]
-
-
-*1.1.0* (March 14th, 2006)
-
-* Remove extraneous spaces in source. [njonsson]
-
-* Swap index_without_id and index_with_id actions out for list and show, using routes to produce hierarchical URLs. [njonsson]
-
-
-*1.0.2* (January 27th, 2006)
-
-* Use singular_name instead of model_name for proper capitalization. [njonsson]
-
-
-*1.0.1* (January 10th, 2006)
-
-* Fix confusing �trestle� nomenclature. [njonsson]
-
-* Clarify narrative. [njonsson]
-
-* Use strings instead of symbols as arguments of TestCase#get and TestCase#post. [njonsson]
-
-
-*1.0.0* (January 3rd, 2006)
-
-* Gem can now be built but still needs extended summary text. [njonsson]
-
-* JavaScript-enable the Destroy action. [njonsson]
-
-* Remove arguments for using trestle instead of scaffold. [njonsson]
-
-* Initial import. [njonsson]
View
@@ -0,0 +1,74 @@
+Version history for the _Trestle Generator_ project
+===================================================
+
+<a name="v1.1.7.3"></a>1.1.7.3 (August 17th, 2006)
+--------------------------------------------------
+
+* Refactored a redundant find expression [[vlazar](http://github.com/vlazar "vlazar at GitHub")]
+
+<a name="v1.1.7.2"></a>1.1.7.2 (August 2nd, 2006)
+-------------------------------------------------
+
+* Fixed a bug in routes that substitutes _/:controller/:id/show_ for _/:controller/:id_ [[cayblood](http://github.com/cayblood "cayblood at GitHub")]
+
+<a name="v1.1.7.1"></a>1.1.7.1 (July 19th, 2006)
+------------------------------------------------
+
+* Asserted bare template names instead of forcing a plural-model-name prefix
+
+<a name="v1.1.7"></a>1.1.7 (July 1st, 2006)
+-------------------------------------------
+
+* Created the changelog
+* Removed extended characters from gemspec description
+
+<a name="v1.1.6"></a>1.1.6 (June 26th, 2006)
+--------------------------------------------
+
+* Fixed a bug inherited from scaffold generator: when a module is specified (e.g., _Admin::People_), the layout file gets created in _app/views/layouts_ instead of in a subdirectory (e.g., _app/views/layouts/admin_). At runtime Rails renders all those views without a layout
+
+<a name="v1.1.5"></a>1.1.5 (May 17th, 2006)
+-------------------------------------------
+
+* Shortened the gem description to be friendlier to http://www.onestepback.org/gemwatch.rss
+* Corrected a misstatement in the readme concerning the public interface of trestle controllers
+* Added functional tests for _#show_, _#edit_ and _#destroy_ requests missing _:id_
+
+<a name="v1.1.4"></a>1.1.4 (May 11th, 2006)
+-------------------------------------------
+
+* Added the readme to the list of files installed by the gem
+* Made a minor wording change in the readme
+* Removed a dependency on Rails to better serve those running Rails from the application's vendor directory
+* Swapped constants in _routes.rb_ for variables, to suppress a Ruby warning
+
+<a name="v1.1.3"></a>1.1.3 (May 11th, 2006)
+-------------------------------------------
+
+* Fixed a collision with existing migrations — closes [#4435](http://rubyforge.org/tracker/index.php?func=detail&aid=4435&group_id=1204&atid=4717 "Trestle Generator issue #4435 at RubyForge")
+
+<a name="v1.1.2"></a>1.1.2 (April 18th, 2006)
+---------------------------------------------
+
+* Conformed to the format of _routes.rb_ from Rails trunk
+* Updated the readme and gemspec description to match http://trestle.rubyforge.org
+
+<a name="v1.1.0"></a>1.1.0 (March 14th, 2006)
+---------------------------------------------
+
+* Swapped _index_without_id_ and _index_with_id_ actions out for _list_ and _show_, using routes to produce hierarchical URLs
+
+<a name="v1.0.2"></a>1.0.2 (January 27th, 2006)
+-----------------------------------------------
+
+* Used _singular_name_ instead of _model_name_ for proper capitalization
+
+<a name="v1.0.1"></a>1.0.1 (January 10th, 2006)
+-----------------------------------------------
+
+* Used strings instead of symbols as arguments of _TestCase#get_ and _TestCase#post_
+
+<a name="v1.0.0"></a>1.0.0 (January 3rd, 2006)
+----------------------------------------------
+
+(First release)
View
@@ -0,0 +1,10 @@
+The MIT License
+===============
+
+Source code for _Trestle Generator_ is Copyright © 2005–2006 [Nils Jonsson](mailto:nils@alumni.rice.edu?subject=Trestle%20Generator) and [contributors](http://github.com/njonsson/trestle-generator/contributors "Trestle Generator contributors at GitHub"), based on the scaffold generator in [Rails](http://github.com/rails/rails).
+
+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.
View
129 README
@@ -1,129 +0,0 @@
-================================================================================
-Trestle Generator
-================================================================================
-
-A drop-in replacement for Ruby on Rails�s scaffold generator
-
-Everybody loves scaffolding, and with good reason. It�s the feature of the Ruby
-on Rails framework that makes a database table editable on the web in mere
-seconds, and with just a few lines of generated Ruby code.
-
-The trestle generator is drop-in replacement for the Rails scaffold generator.
-It produces scaffolding that�s more like production-quality code while
-maintaining all the rapid goodness you know and love about Rails.
-
-Don�t drive your train across a gorge with nothing but a scaffold underneath it.
-Use a trestle instead!
-
-Trestles have two advantages over scaffolds:
-
-* More elegant handling of HTTP POST and GET requests
-* A streamlined URL structure that makes your application easier to use
-
-Downloading and installation is a breeze with RubyGems, the package manager
-that�s included in most Ruby distributions. Just type the following at a command
-line:
-
- gem install trestle_generator
-
-Generating trestles for your database tables is also a one-step process:
-
- script/generate trestle YourModelNameHere
-
---------------------------------------------------------------------------------
-Why switch from scaffolds to trestles? SAFETY
---------------------------------------------------------------------------------
-
-The trestle generator produces Rails views that use HTTP POST to request changes
-(instead of GET). It also generates Rails controllers that execute such changes
-only for HTTP POST requests. Well-behaved web applications must protect user
-data against unwanted changes, including those arising from errant HTTP GET
-requests such as Google Web Accelerator is known to make. The scaffolding
-provided by Rails v1.1 is better about this than Rails v1.0 was, but trestles
-solve the problem of GET vs POST more cleanly and comprehensively.
-
---------------------------------------------------------------------------------
-Why switch from scaffolds to trestles? USABILITY
---------------------------------------------------------------------------------
-
-Trestle controllers have just five actions (list, new, show, edit, and destroy).
-Contrast this with scaffold controllers which have eight actions to implement
-the same functionality. This is mostly a matter of taste, but Rails developers
-appreciate more than most that �less is more.�
-
-Just as important as aesthetics is the fact that trestle controllers better
-reflect GET and POST semantics, making for more intelligible HTTP conversations
-in your applications. (Apparently, Tobias L�tke wrote a postback_generator
-RubyGem with a similar philosophy, but trestles take the concept further.)
-
-Use trestles instead of scaffolding and you will find yourself throwing away and
-tweaking less code as you build out applications. As joyous as Ruby programming
-is, less code is still a good thing.
-
-Let�s look at some of the differences between trestles and scaffolds. A scaffold
-for a database table named �people� has the following HTTP interface:
-
-URL Result
-================================================================================
-/people Lists existing person records
-/people/list
---------------------------------------------------------------------------------
-/people/new Shows an empty person form
---------------------------------------------------------------------------------
-/people/create Creates a new person record from request parameters
---------------------------------------------------------------------------------
-/people/show/99 Shows the person record having ID 99
---------------------------------------------------------------------------------
-/people/edit/99 Shows a person form for the person record having ID 99
---------------------------------------------------------------------------------
-/people/update/99 Updates the person record having ID 99 using request
- parameters
---------------------------------------------------------------------------------
-/people/destroy/99 Deletes the person record having ID 99
-
-As of Rails v1.1, scaffold controllers reject requests to insert, update and
-delete records if the request is HTTP GET instead of POST. This is a safety
-improvement, but the design still leaves something to be desired.
-
-Contrast this with the HTTP interface of the equivalent trestle controller:
-
-URL HTTP Method Result
-================================================================================
-/people GET or POST Lists existing person records
---------------------------------------------------------------------------------
-/people/new GET Shows an empty person form
- POST Creates a new person record from request
- parameters
---------------------------------------------------------------------------------
-/people/99 GET or POST Shows the person record having ID 99
---------------------------------------------------------------------------------
-/people/99/edit GET Shows a person form for the person record
- having ID 99
- POST Updates the person record having ID 99 using
- request parameters
---------------------------------------------------------------------------------
-/people/99/destroy GET Redirects to /people/99/edit with a notice that
- the user must click the form�s Destroy button
- in order to destroy a record
- POST Deletes the person record having ID 99 after
- prompting the user for confirmation
-
-A trestle degrades gracefully if the user has JavaScript turned off. And the
-hierarchical nature of trestle URLs, wherein the ID comes before the verb, lets
-the user click the Up One Level button on the Google Toolbar to explore the
-application. (The Up One Level button clips one element off the end of the
-current URL.) Scaffold URLs do not play nicely with the Up One Level button.
-
-The trestle interface is not just pain relief for users without JavaScript and
-those who like the Up One Level button. If you type URLs by hand, you get a
-friendly notice��instead of a Rails exception��if a request is missing an ID.
-There is simply less opportunity for error. That�s a tried-and-true way to up
-the usability factor.
-
-Do yourself and your users a favor by switching from scaffolds to trestles.
-
-Visit the RubyForge page (http://trestle.rubyforge.org/) for this open-source
-project. Contact me at nils@alumni.rice.edu.
-
--- /\/. _/.
-Nils Jonsson
Oops, something went wrong.

0 comments on commit 940e253

Please sign in to comment.