app2engine 0.0.4 → 0.0.5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 eregon
+Copyright (c) 2010 Benoit Daloze
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,12 +2,18 @@
 
 Convert a Rails 3 app to an Engine.
 
-The structure of a standard Rails application is very similar to what you need for an Engine.
-
-But a few details need to be changed.
+The structure of a standard Rails application is very similar to what you need for an Engine, but a few details need to be changed.
 
 This tool intend to do most of them for you.
 
+## enginex
+
+[`enginex`](http://github.com/josevalim/enginex) from José Valim is a similar tool, except it generates the structure of an Engine instead of converting.
+
+If app2engine does not work as expected, I recommend to use enginex, since it is likely more up-to-date and made by a member of the Rails core team.
+
+app2engine however keep all its interest as a light solution for converting applications.
+
 ## Install
 
     gem install app2engine
@@ -26,7 +32,9 @@ Then convert it with Rake:
 
     rake engine:convert # or simply rake engine
 
-Follow the instructions: To the main app's Gemfile, add
+Follow the instructions:
+
+To the main app's Gemfile, add
 
     gem 'myengine', :path => 'path/to/myengine'
 
@@ -34,6 +42,22 @@ Use extras if you want:
 
     rake engine:extra
 
+### Static assets (public/ folder) in production
+
+In Production environment, you must comment (or set to `true`) the line in mainapp/config/environments/production.rb
+
+Change
+
+    config.serve_static_assets = false
+
+to
+
+    config.serve_static_assets = true # This is needed to serve static assets from engines
+
+Because the engine modify the static assets by appending its own public folder.
+
+(A workaround may be to config your server to serve both the engine and the mainapp public files)
+
 ## You are done setting up your engine
 
 If you want a little test:
@@ -56,16 +80,6 @@ In your main app's dir:
 
 The folders `{controllers,models,views}/myengine` are created because you should namespace your engine.
 
-### Production
-
-In Production environment, you must comment (or set to `true`) the line in mainapp/config/environments/production.rb
-
-    # Disable Rails's static asset server
-    # In production, Apache or nginx will already do this
-    config.serve_static_assets = false
-
-Because the engine modify the static assets by appending its own public folder. (A workaround may be to config you server)
-
 ### Code reloading / overwriting / load order
 
 This is a discussion about what happen if you want to modify behavior in the mainapp.
@@ -90,7 +104,8 @@ In production, however, not using this trick works, but letting it will not hurt
 Controllers of the mainapp overwrite the one of the engine, completely.
 (The one of the engine will not be loaded if there is the same in the mainapp)
 
-You then have to load the engine controller yourself, adding this at the top of the mainapp controller:
+You then have to load the engine controller yourself, if you want also the old controller,
+ by adding this at the top of the mainapp controller:
 
     load "myengine/app/controllers/test_controller.rb"
 
@@ -99,7 +114,7 @@ There is the problem we do not know how to access that file,
 
 So again a workaround, I created a symlink in the mainapp root (called myengine) to the engine root.
 
-In production, you also need to load the file itself (but you could do a simple `require` as it will loaded once, so no need to change anything).
+In production, you also need to load the file itself (but you could do a simple `require` as it would be loaded once, so no need to change anything).
 
 #### Views
 
@@ -114,10 +129,6 @@ In development, public assets are served as expected, with the mainapp overwriti
 In production, however, the engine files do not seem to be served at all.
 (and if you do not do the trick said upper with serve\_static\_assets, even the mainapp files will not load)
 
-Update:
-  It seems it works with changing syntax in the "static assets" initializer of the engine. The gem is then updated.
-  (delete your lib/myengine/engine.rb, and call again `rake engine` and `rake engine:extra` if you want)
-
 ## Author
 
 Benoit Daloze

data/lib/app2engine/rake/convert_tasks.rb

@@ -41,7 +41,7 @@ module App2Engine
 
       def initializers
         define_task(:initializers, "remove initializers as they would conflict and create NameError") do
-          Dir['config/initializers/*.rb'].each { |file| comment_whole_file(file) }
+          Dir['config/initializers/{secret_token,session_store}.rb'].each { |file| comment_whole_file(file) }
         end
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: app2engine
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - eregon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-05 00:00:00 +02:00
+date: 2010-10-03 00:00:00 +02:00
 default_executable: app2engine
 dependencies: 
 - !ruby/object:Gem::Dependency