app2engine 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 eregon
+
+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/README.md

@@ -0,0 +1,55 @@
+# app2engine
+
+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.
+
+This tool intend to do most of them for you.
+
+## Install
+
+    gem install app2engine
+
+## Synopsis
+
+Create an new app to convert it to an Engine (avoid using underscores):
+    
+    rails new myengine # 
+
+Run `app2engine` in the root directory of this app you want to make an Engine:
+
+    app2engine
+
+Then convert it with Rake:
+
+    rake engine:convert # or simply rake engine
+
+Follow the instructions: To the main app's Gemfile, add
+
+    gem 'myengine', :path => 'path/to/myengine'    
+
+Use extras if you want:
+
+    rake engine:extra
+
+## You are done setting up your engine
+
+If you want a little test:
+
+In your engine's dir:
+
+    rails g controller engine myaction
+
+In your main app's dir:
+
+    rails g controller base myaction
+
+`rails s` and surf on `/engine/myaction` and `/base/myaction` !
+
+(You can also verify routing is fine with `rake routes`)
+
+## Author
+
+Benoit Daloze

data/bin/app2engine

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'app2engine'
+
+if ARGV.delete("-h") or ARGV.delete("--help")
+  puts "#{File.basename($0)} [dir=.]: install the Rake tasks to the Rakefile (or create it)"
+  puts "  The App name is given from the directory. It will also be use in namespaces."
+else
+  App2Engine.install(ARGV.shift || ".")
+end

data/lib/app2engine.rb

@@ -0,0 +1,20 @@
+require 'app2engine/rake/tasks'
+
+module App2Engine
+  def install(dir)
+    unless File.directory?(dir) and
+        rakefile = File.join(dir, 'Rakefile') and File.exist?(rakefile) and
+        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
+  module_function :install
+end

data/lib/app2engine/files/__project__.gemspec

@@ -0,0 +1,7 @@
+Gem::Specification.new do |spec|
+  spec.name = "__DIR__"
+  spec.version = "0.0.1"
+  spec.summary = "__PROJECT__"
+  spec.authors = ["Me"]
+  spec.files = Dir["{app,config,public,lib}/**/*"]
+end

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

@@ -0,0 +1,3 @@
+module __PROJECT__
+  require '__DIR__/engine' if defined? Rails
+end

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

@@ -0,0 +1,10 @@
+require "__DIR__" # Require all the real code
+require "rails"
+
+module __PROJECT__
+  class Engine < Rails::Engine
+    initializer "static assets" do |app|
+      app.middleware.use ActionDispatch::Static, "#{root}/public"
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+class MigrationsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  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
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.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'
+  end
+end

data/lib/app2engine/rake/convert_tasks.rb

@@ -0,0 +1,56 @@
+module App2Engine
+  module Rake
+    class Tasks
+      def convert_tasks
+        tasks = %w[gemspec routes hierarchy initializers generators]
+        task :convert => tasks.map { |t| "engine:convert:" << t } do
+          puts
+          puts "Now your app should be ready to be used as an Engine".blue
+          puts "You have to add this to you main app's Gemfile:".red
+          puts "gem '#{@dir}', :path => 'relative/path/to/#{@dir}'"
+          puts "You may want to remove the dependency to app2engine in the Engine's Gemfile".blue
+        end
+        namespace :convert do
+          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')
+          add_file('lib/generators/__project__/migrations/migrations_generator.rb')
+        end
+      end
+    end # Tasks
+  end # Rake
+end # App2Engine

data/lib/app2engine/rake/extra_tasks.rb

@@ -0,0 +1,29 @@
+module App2Engine
+  module Rake
+    class Tasks
+      SASS = <<SASS
+    initializer "sass" do |app|
+      require 'sass/plugin/rack'
+      template_location = __PROJECT__::Engine.root.join('public/stylesheets/sass').to_s
+      css_location = __PROJECT__::Engine.root.join('public/stylesheets').to_s
+      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 }
+        namespace :extra do
+          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)
+        end
+      end
+
+    end # Tasks
+  end # Rake
+end # App2Engine

data/lib/app2engine/rake/tasks.rb

@@ -0,0 +1,140 @@
+require 'fileutils'
+
+require 'rake'
+
+require 'app2engine/rake/convert_tasks'
+require 'app2engine/rake/extra_tasks'
+
+require 'term/ansicolor'
+class String
+  [:green, :red, :black, :blue].each { |method|
+    define_method(method) {
+      Term::ANSIColor.send(method, self)
+    }
+  }
+end
+
+module App2Engine
+  module Rake
+    class Tasks
+      FILES_PATH = File.expand_path("../../files", __FILE__)
+
+      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
+        end
+        desc "Alias for engine:convert"
+        task :engine => "engine:convert"
+      end
+
+      def define_task(name, description, &block)
+        desc description
+        task(name) {
+          puts name.to_s.capitalize.blue
+          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
+      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
+          already_done dir
+        else
+          FileUtils.mkdir_p(dir)
+          status "Create #{dir}/".green
+        end
+      end
+      
+      def move_dir dir, to
+        if File.directory? to
+          already_done dir
+        else
+          FileUtils.mv(dir, to)
+          status "Move #{dir} to #{to}".green
+        end
+      end
+      
+      def add_file file
+        contents = file_contents(file)
+        file = resolve_name(file)
+        if File.exist? file
+          already_done file
+        else
+          File.open(file, 'w') { |fh| fh.write(contents) }
+          status "Create #{file}".green
+        end
+      end
+      
+      def append_to_file file, contents
+        file = resolve_name(file)
+        if File.read(file).include?(contents)
+          already_done file
+        else
+          File.open(file, 'a') { |fh|
+            fh.puts
+            fh.puts contents
+          }
+          status "Append #{file}".green
+        end
+      end
+      
+      def append_in_class(file, what)
+        file = resolve_name(file)
+        what = resolve_contents(what)
+        if File.read(file).include?(what)
+          already_done file
+        else
+          lines = File.readlines(file)
+          class_indent = lines.find { |line| line =~ /^\s*class .+$/ }.split(//).index('c')
+          class_end = lines.rindex { |line| line =~ /^\s{#{class_indent}}end\s*$/ }
+          what = what.split("\n").map { |line| line.chomp + "\n" }
+          lines = lines[0...class_end] + ["\n"] + what + lines[class_end..-1]
+          File.open(file, 'w') { |fh| fh.write(lines.join) }
+          status "Append #{file}".green
+        end
+      end
+      
+      def replace_line(file, line, by)
+        line = line.chomp + "\n"
+        by = by.chomp + "\n"
+        lines = File.readlines(file)
+        if lines.include? by
+          already_done(file)
+        else
+          if i = lines.index(line)
+            lines[i] = by
+            File.open(file, 'w') { |fh| fh.write(lines.join) }
+            status "Edit #{file}".green
+          else
+            status "#{file}: line '#{line}' not found".red
+          end
+        end
+      end
+    end # Tasks
+  end # Rake
+end # App2Engine

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: app2engine
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- eregon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-04 00:00:00 +02:00
+default_executable: app2engine
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Ease the convertion of a Rails 3 app in an Engine
+email: eregontp@gmail.com
+executables: 
+- app2engine
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- bin/app2engine
+- lib/app2engine.rb
+- lib/app2engine/files/__project__.gemspec
+- lib/app2engine/files/lib/__project__.rb
+- lib/app2engine/files/lib/__project__/engine.rb
+- lib/app2engine/files/lib/generators/__project__/migrations/migrations_generator.rb
+- lib/app2engine/rake/convert_tasks.rb
+- lib/app2engine/rake/extra_tasks.rb
+- lib/app2engine/rake/tasks.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/eregon/app2engine
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Convert a Rails 3 app to an Engine
+test_files: []
+