app2engine 0.0.2 → 0.0.3

data/README.md

@@ -15,8 +15,8 @@ This tool intend to do most of them for you.
 ## Synopsis
 
 Create an new app to convert it to an Engine (avoid using underscores):
-    
-    rails new myengine # 
+
+    rails new myengine
 
 Run `app2engine` in the root directory of this app you want to make an Engine:
 
@@ -28,7 +28,7 @@ Then convert it with Rake:
 
 Follow the instructions: To the main app's Gemfile, add
 
-    gem 'myengine', :path => 'path/to/myengine'    
+    gem 'myengine', :path => 'path/to/myengine'
 
 Use extras if you want:
 
@@ -50,6 +50,74 @@ In your main app's dir:
 
 (You can also verify routing is fine with `rake routes`)
 
+## Notes
+
+### Namespace them all !
+
+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.
+
+#### Models
+
+Models are behaving especially bad with Engines.
+
+In development, you need to load yourself the model, or only the model of the *engine* will be loaded.
+To keep the auto-reloading, I only found this workaround (in the *engine*/app/blog/posts.rb):
+
+    if File.exist?(app = Rails.root.join("app/models/blog/posts.rb").to_s)
+      load app
+    end
+
+This is counter-intuitive as you would feel that the mainapp should load the engine one if redefined.
+
+In production, however, not using this trick works, but letting it will not hurt.
+
+#### Controllers
+
+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:
+
+    load "myengine/app/controllers/test_controller.rb"
+
+There is the problem we do not know how to access that file,
+ because loading `app/controllers/test_controller.rb` would require the mainapp controller (again).
+
+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).
+
+#### Views
+
+Views in the mainapp overwrite the views corresponding in the engine.
+
+This is expected behavior, as you can mainly think that the paths of the engine are appended to the ones of the mainapp.
+
+#### public/ folder, static assets
+
+In development, public assets are served as expected, with the mainapp overwriting the engine.
+
+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.rb

@@ -7,12 +7,12 @@ module App2Engine
         gemfile  = File.join(dir, 'Gemfile')  and File.exist?(gemfile)
       raise "#{dir} is not a rails app"
     end
-    
+
     tasks = App2Engine::Rake::Tasks.new
-    
+
     puts "Appending the App2Engine tasks to the Rakefile"
     tasks.append_to_file(rakefile, "require 'app2engine/rake/tasks'\nApp2Engine::Rake::Tasks.new")
-    
+
     puts "Adding app2engine in the Gemfile (necessary for Rake tasks to run)"
     tasks.append_to_file(gemfile, "gem 'app2engine'")
   end

data/lib/app2engine/files/lib/__project__/engine.rb

@@ -4,7 +4,8 @@ require "rails"
 module __PROJECT__
   class Engine < Rails::Engine
     initializer "static assets" do |app|
-      app.middleware.use ActionDispatch::Static, "#{root}/public"
+      # app.middleware.use ActionDispatch::Static, "#{root}/public" # Old way, does not work in production
+      app.middleware.insert_after ActionDispatch::Static, ActionDispatch::Static, "#{root}/public"
     end
   end
 end

data/lib/app2engine/files/lib/generators/__project__/migrations/migrations_generator.rb

@@ -6,7 +6,7 @@ class MigrationsGenerator < Rails::Generators::Base
   def self.source_root
     @source_root ||= File.expand_path('../../templates', __FILE__)
   end
-  
+
   # Implement the required interface for Rails::Generators::Migration.
   def self.next_migration_number(dirname)
     if ActiveRecord::Base.timestamped_migrations
@@ -15,7 +15,7 @@ class MigrationsGenerator < Rails::Generators::Base
       "%.3d" % (current_migration_number(dirname) + 1)
     end
   end
-  
+
   def create_migration_file
     # migration_template 'create_posts.rb', 'db/migrate/create_blog_posts.rb'
     # migration_template '__DIR___create_posts.rb', 'db/migrate/__DIR___create_posts.rb'

data/lib/app2engine/rake/convert_tasks.rb

@@ -14,37 +14,37 @@ module App2Engine
           tasks.each { |t| send(t) }
         end
       end
-      
+
       def gemspec
         define_task(:gemspec, "add Jeweler to the Rakefile to allow to build a gem which can be referenced from the main app") do
           add_file('__project__.gemspec')
         end
       end
-      
+
       def routes
         define_task(:routes, "Change routes to not have a reference to the application, but to the main app") do
           replace_line('config/routes.rb', "#{@project}::Application.routes.draw do", "Rails.application.routes.draw do")
         end
       end
-      
+
       def hierarchy
         define_task(:hierarchy, "add the basic hierarchy for the Engine") do
           add_file('lib/__project__.rb')
           mkdir("lib/#{@dir}")
           add_file('lib/__project__/engine.rb')
-          
+
           mkdir("app/controllers/__project__")
           mkdir("app/models/__project__")
           mkdir("app/views/__project__")
         end
       end
-      
+
       def initializers
         define_task(:initializers, "remove initializers as they would conflict and create NameError") do
           move_dir('config/initializers', 'config/org_initializers')
         end
       end
-      
+
       def generators
         define_task(:generators, "add the basic code for generators (needed for migrations)") do
           mkdir('lib/generators/__project__/migrations/templates')

data/lib/app2engine/rake/extra_tasks.rb

@@ -9,7 +9,7 @@ module App2Engine
       Sass::Plugin.add_template_location(template_location, css_location)
     end
 SASS
-      
+
       def extra_tasks
         tasks = %w[sass]
         task :extra => tasks.map { |t| "engine:extra:" << t }
@@ -17,7 +17,7 @@ SASS
           tasks.each { |t| send(t) }
         end
       end
-      
+
       def sass
         define_task(:sass, "configure the project to be used with Sass") do
             append_in_class('lib/__project__/engine.rb', SASS)

data/lib/app2engine/rake/tasks.rb

@@ -7,7 +7,7 @@ require 'app2engine/rake/extra_tasks'
 
 require 'term/ansicolor'
 class String
-  [:green, :red, :black, :blue].each { |method|
+  [:green, :red, :black, :blue, :yellow, :white].each { |method|
     define_method(method) {
       Term::ANSIColor.send(method, self)
     }
@@ -22,7 +22,7 @@ module App2Engine
       def initialize
         @dir = File.basename(File.expand_path("."))
         @project = @dir.split(/[^A-Za-z0-9]/).map(&:capitalize).join # Camelize
-        
+
         namespace :engine do
           convert_tasks
           extra_tasks
@@ -38,28 +38,28 @@ module App2Engine
           block.call
         }
       end
-      
+
       # Templates conventions
       def resolve_contents(contents)
         contents.gsub("__PROJECT__", @project).gsub("__DIR__", @dir)
       end
-      
+
       def resolve_name(name)
         name.gsub("__project__", @dir)
       end
-      
+
       def status status
         puts "  #{status}"
       end
-      
+
       def already_done what
-        status "already done (#{what})".black
+        status "already done (#{what})".black # yellow
       end
-      
+
       def file_contents file
         resolve_contents File.read(File.join(FILES_PATH, file))
       end
-      
+
       def mkdir dir
         dir = resolve_name(dir)
         if File.directory? dir
@@ -69,7 +69,7 @@ module App2Engine
           status "Create #{dir}/".green
         end
       end
-      
+
       def move_dir dir, to
         if File.directory? to
           already_done dir
@@ -78,7 +78,7 @@ module App2Engine
           status "Move #{dir} to #{to}".green
         end
       end
-      
+
       def add_file file
         contents = file_contents(file)
         file = resolve_name(file)
@@ -89,7 +89,7 @@ module App2Engine
           status "Create #{file}".green
         end
       end
-      
+
       def append_to_file file, contents
         file = resolve_name(file)
         if File.read(file).include?(contents)
@@ -102,7 +102,7 @@ module App2Engine
           status "Append #{file}".green
         end
       end
-      
+
       def append_in_class(file, what)
         file = resolve_name(file)
         what = resolve_contents(what)
@@ -118,7 +118,7 @@ module App2Engine
           status "Append #{file}".green
         end
       end
-      
+
       def replace_line(file, line, by)
         line = line.chomp + "\n"
         by = by.chomp + "\n"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: app2engine
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - eregon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-04 00:00:00 +02:00
+date: 2010-08-05 00:00:00 +02:00
 default_executable: app2engine
 dependencies: 
 - !ruby/object:Gem::Dependency