ey_rails_wizard 0.3.1 → 0.4.0

data/ChangeLog.md

@@ -1,5 +1,13 @@
 # ChangeLog
 
+## v0.4
+
+* SCROLLS ARE IN, "recipes" are out. Wizards use scrolls. Alchemists use recipes.
+* Scrolls have no dependencies on `eycloud` or `eycloud_recipes_on_deploy`; these are optional
+* `github` - GitHub repository creation
+* `resque` + `delayed_job` can install their admin consoles
+* `sidekiq` - high performance, low cost alternative to `resque` or `delayed_job`
+
 ## v0.3
 
 * Engine Yard support - Resque

data/README.md

@@ -1,10 +1,10 @@
 # Engine Yard Rails Wizard Gem 
 
-The Engine Yard RailsWizard gem is both the official repository of recipes for [Engine Yard RailsWizard][1] as well as a stand-alone tool to generate rails templates from the command line. The website and the gem are kept in version sync, so any recipes released to the gem will be simultaneously available on the web builder.
+The Engine Yard RailsWizard gem is both the official repository of scrolls for [Engine Yard RailsWizard][1] as well as a stand-alone tool to generate rails templates from the command line. The website and the gem are kept in version sync, so any scrolls released to the gem will be simultaneously available on the web builder.
 
 This is a fork of the original [RailsWizard gem][4] specifically for Engine Yard Cloud customers. We are very thankful to Michael Bleigh and Intridea for creating Rails Wizard.
 
-Generated applications may include EY Cloud recipes to setup/run required services.
+Generated applications may include EY Cloud scrolls to setup/run required services.
 
 ## Installation
 
@@ -18,35 +18,39 @@ The primary usage of the `ey_rails_wizard` gem is to utilize its interactive ter
 
     ey_rails_wizard new APP_NAME
 
-Where `APP_NAME` is the directory in which you wish to create the app (it mirrors the Rails creation syntax). You will then be guided through the recipe selection process and subsequently the Rails app generator will automatically run with the template and all appropriate command line options included.
+Where `APP_NAME` is the directory in which you wish to create the app (it mirrors the Rails creation syntax). You will then be guided through the scroll selection process and subsequently the Rails app generator will automatically run with the template and all appropriate command line options included.
 
-### Specifying Recipes
+### Specifying Scrolls
 
-If you wish to skip the interactive recipe selector, you may provide instead a list of recipes with the `-r` option:
+If you wish to skip the interactive scroll selector, you may provide instead a list of scrolls with the `-r` option:
 
     ey_rails_wizard new APP_NAME -r jquery mongo_mapper sass
 
-This will automatically generate a Rails template with the provided recipes and begin the app generator.
+This will automatically generate a Rails template with the provided scrolls and begin the app generator.
 
-### Listing Recipes
+### Listing Scrolls
 
-You can also print out a simple list of recipes:
+You can also print out a simple list of scrolls:
 
     ey_rails_wizard list
 
-Or print out a list of recipes for a specific category:
+Or print out a list of scrolls for a specific category:
 
     ey_rails_wizard list persistence
 
-# EY Rails Wizard Recipes
+# EY Rails Wizard Scrolls
 
-The Engine Yard Rails Wizard recipe collection now live in this GitHub repository to make them fork-friendly and available for use with the command-line tool. You can see all of the recipes in the [recipes directory][2].
+The Engine Yard Rails Wizard scroll collection now live in this GitHub repository to make them fork-friendly and available for use with the command-line tool. You can see all of the scrolls in the [scrolls directory][2].
 
 If you're looking for the web app source code, it now lives at [ey_rails_wizard.web][3].
 
-## Submitting a Recipe
+## Submitting a Scroll
 
-Submitting a recipe is actually a very straightforward process. Recipes are made of up **template code** and **YAML back-matter** stored in a ruby file. The `__END__` parsing convention is used so that each recipe is actually a valid, parseable Ruby file. The structure of a recipe looks something like this:
+Create new scrolls using:
+
+    rake new NAME=scroll-name
+
+Submitting a scroll is actually a very straightforward process. Scrolls are made of up **template code** and **YAML back-matter** stored in a ruby file. The `__END__` parsing convention is used so that each scroll is actually a valid, parseable Ruby file. The structure of a scroll looks something like this:
 
 ```ruby
 gem 'supergem'
@@ -63,16 +67,16 @@ description: Installs SuperGem which is useful for things
 author: mbleigh
 ```
 
-It's really that simple. The gem has RSpec tests that automatically validate each recipe in the repository, so you should run `rake spec` as a basic sanity check before submitting a pull request. Note that these don't verify that your recipe code itself works, just that Engine Yard Rails Wizard could properly parse and understand your recipe file.
+It's really that simple. The gem has RSpec tests that automatically validate each scroll in the repository, so you should run `rake spec` as a basic sanity check before submitting a pull request. Note that these don't verify that your scroll code itself works, just that Engine Yard Rails Wizard could properly parse and understand your scroll file.
 
-For more information on all available options for authoring recipes,
+For more information on all available options for authoring scrolls,
 please see the 
 
 ## License
 
-Engine Yard Rails Wizard and its recipes are distributed under the MIT License.
+Engine Yard Rails Wizard and its scrolls are distributed under the MIT License.
 
 [1]:http://railswizard.engineyard.com/
-[2]:https://github.com/engineyard/ey_rails_wizard/tree/master/recipes
+[2]:https://github.com/engineyard/ey_rails_wizard/tree/master/scrolls
 [3]:https://github.com/engineyard/ey_rails_wizard.web
 [4]:https://github.com/intridea/rails_wizard

data/Rakefile

@@ -13,14 +13,14 @@ task :clean do
   system 'rm -rf test_run'
 end
 
-desc "Execute a test run with the specified recipes."
+desc "Execute a test run with the specified scrolls."
 task :run => :clean do
-  recipes = ENV['RECIPES'].split(',')
+  scrolls = ENV['SCROLLS'].split(',')
 
   require 'tempfile'
   require 'rails_wizard'
 
-  template = RailsWizard::Template.new(recipes)
+  template = RailsWizard::Template.new(scrolls)
 
   begin
     dir = Dir.mktmpdir "rails_template"
@@ -36,10 +36,25 @@ task :run => :clean do
   end
 end
 
-desc "Prints out a template from the provided recipes."
+desc "Prints out a template from the provided scrolls."
 task :print do
   require 'rails_wizard'
 
-  recipes = ENV['RECIPES'].split(',')
-  puts RailsWizard::Template.new(recipes).compile
+  scrolls = ENV['SCROLLS'].split(',')
+  puts RailsWizard::Template.new(scrolls).compile
 end
+
+desc "Create a new template"
+task :new do
+  unless (name = ENV['NAME']) && name.size > 0
+    $stderr.puts "USAGE: rake new NAME=scroll-name"
+    exit 1
+  end
+  require 'active_support/inflector'
+  require 'erb'
+  require 'rails_wizard/template'
+  scroll = RailsWizard::Template.render("new_scroll", binding)
+  scroll_path = "scrolls/#{name}.rb"
+  File.open(scroll_path, "w") { |file| file << scroll }
+  `open #{scroll_path}`
+end

data/lib/rails_wizard.rb

@@ -1,10 +1,10 @@
-require 'rails_wizard/recipes'
-require 'rails_wizard/recipe'
+require 'rails_wizard/scrolls'
+require 'rails_wizard/scroll'
 require 'rails_wizard/config'
 require 'rails_wizard/template'
 
-Dir[File.dirname(__FILE__) + '/../recipes/*.rb'].each do |path|
+Dir[File.dirname(__FILE__) + '/../scrolls/*.rb'].each do |path|
   key = File.basename(path, '.rb')
-  recipe = RailsWizard::Recipe.generate(key, File.open(path))
-  RailsWizard::Recipes.add(recipe)
+  scroll = RailsWizard::Scroll.generate(key, File.open(path))
+  RailsWizard::Scrolls.add(scroll)
 end

data/lib/rails_wizard/command.rb

@@ -5,39 +5,40 @@ module RailsWizard
   class Command < Thor
     include Thor::Actions
     desc "new APP_NAME", "create a new Rails app"
-    method_option :recipes, :type => :array, :aliases => "-r"
+    method_option :scrolls, :type => :array, :aliases => "-s", :desc => "List scrolls, e.g. -s resque rails_basics jquery"
+    method_option :template, :type => :boolean, :aliases => "-t", :desc => "Only display template that would be used"
     def new(name)
-      if options[:recipes]
-        run_template(name, options[:recipes])
+      if options[:scrolls]
+        run_template(name, options[:scrolls], options[:template])
       else
-        @recipes = []
+        @scrolls = []
 
-        while recipe = ask("#{print_recipes}#{bold}Which recipe would you like to add? #{clear}#{yellow}(blank to finish)#{clear}")
-          if recipe == ''
-            run_template(name, @recipes)
+        while scroll = ask("#{print_scrolls}#{bold}Which scroll would you like to add? #{clear}#{yellow}(blank to finish)#{clear}")
+          if scroll == ''
+            run_template(name, @scrolls)
             break
-          elsif RailsWizard::Recipes.list.include?(recipe)
-            @recipes << recipe
+          elsif RailsWizard::Scrolls.list.include?(scroll)
+            @scrolls << scroll
             puts
-            puts "> #{green}Added '#{recipe}' to template.#{clear}"
+            puts "> #{green}Added '#{scroll}' to template.#{clear}"
           else
             puts
-            puts "> #{red}Invalid recipe, please try again.#{clear}"
+            puts "> #{red}Invalid scroll, please try again.#{clear}"
           end
         end
       end
     end
 
-    desc "list [CATEGORY]", "list available recipes (optionally by category)"
+    desc "list [CATEGORY]", "list available scrolls (optionally by category)"
     def list(category = nil)
       if category
-        recipes = RailsWizard::Recipes.for(category).map{|r| RailsWizard::Recipe.from_mongo(r) }
+        scrolls = RailsWizard::Scrolls.for(category).map{|r| RailsWizard::Scroll.from_mongo(r) }
       else
-        recipes = RailsWizard::Recipes.list_classes
+        scrolls = RailsWizard::Scrolls.list_classes
       end
 
-      recipes.each do |recipe|
-        puts recipe.key.ljust(15) + "# #{recipe.description}"
+      scrolls.each do |scroll|
+        puts scroll.key.ljust(15) + "# #{scroll.description}"
       end
     end
 
@@ -49,28 +50,33 @@ module RailsWizard
       def green; "\033[32m" end
       def yellow; "\033[33m" end
 
-      def print_recipes
+      def print_scrolls
         puts
         puts
         puts
-        if @recipes && @recipes.any?
-          puts "#{green}#{bold}Your Recipes:#{clear} " + @recipes.join(", ")
+        if @scrolls && @scrolls.any?
+          puts "#{green}#{bold}Your Scrolls:#{clear} " + @scrolls.join(", ")
           puts
         end
-        puts "#{bold}#{cyan}Available Recipes:#{clear} " + RailsWizard::Recipes.list.join(', ')
+        puts "#{bold}#{cyan}Available Scrolls:#{clear} " + RailsWizard::Scrolls.list.join(', ')
         puts
       end
 
-      def run_template(name, recipes)
+      def run_template(name, scrolls, display_only = false)
         puts
         puts
         puts "#{bold}Generating and Running Template..."
         puts
         file = Tempfile.new('template')        
-        template = RailsWizard::Template.new(recipes)
+        template = RailsWizard::Template.new(scrolls)
         file.write template.compile
         file.close
-        system "rails new #{name} -m #{file.path} #{template.args.join(' ')}"
+        if display_only
+          puts "Template stored to #{file.path}"
+          puts File.read(file.path)
+        else
+          system "rails new #{name} -m #{file.path} #{template.args.join(' ')}"
+        end
       ensure
         file.unlink
       end

data/lib/rails_wizard/config.rb

@@ -41,7 +41,7 @@ module RailsWizard
       end
 
       def conditions
-        [config_conditions, recipe_conditions].join(' && ')
+        [config_conditions, scroll_conditions].join(' && ')
       end
 
       def config_conditions
@@ -54,11 +54,11 @@ module RailsWizard
         end
       end
 
-      def recipe_conditions
-        if details['if_recipe']
-          "recipe?('#{details['if_recipe']}')"
-        elsif details['unless_recipe']
-          "!recipe?('#{details['unless_recipe']}')"
+      def scroll_conditions
+        if details['if_scroll']
+          "scroll?('#{details['if_scroll']}')"
+        elsif details['unless_scroll']
+          "!scroll?('#{details['unless_scroll']}')"
         else
           'true'
         end

data/lib/rails_wizard/{recipe.rb → scroll.rb}

@@ -5,7 +5,7 @@ require 'yaml'
 require 'erb'
 
 module RailsWizard
-  class Recipe
+  class Scroll
     extend Comparable
     
     def self.<=>(another)
@@ -28,7 +28,7 @@ module RailsWizard
       if template_or_file.respond_to?(:read)
         file = template_or_file.read
         parts = file.split(/^__END__$/)
-        raise ArgumentError, "The recipe file must have YAML matter after an __END__" unless parts.size == 2
+        raise ArgumentError, "The scroll file must have YAML matter after an __END__" unless parts.size == 2
         template = parts.first.strip
         attributes = YAML.load(parts.last).inject({}) do |h,(k,v)|
           h[k.to_sym] = v
@@ -38,12 +38,12 @@ module RailsWizard
         template = template_or_file
       end
  
-      recipe_class = Class.new(RailsWizard::Recipe) 
-      recipe_class.attributes = attributes
-      recipe_class.template = template
-      recipe_class.key = key
+      scroll_class = Class.new(RailsWizard::Scroll) 
+      scroll_class.attributes = attributes
+      scroll_class.template = template
+      scroll_class.key = key
 
-      recipe_class
+      scroll_class
     end
 
     ATTRIBUTES.each do |setter|
@@ -81,7 +81,7 @@ module RailsWizard
     end
 
     def self.compile
-      "# >#{"[ #{name} ]".center(75,'-')}<\n\n# #{description}\nsay_recipe '#{name}'\n\n#{template}\n"
+      "# >#{"[ #{name} ]".center(75,'-')}<\n\n# #{description}\nsay_scroll '#{name}'\n\n#{template}\n"
     end
     def compile; self.class.compile end
 
@@ -95,8 +95,8 @@ module RailsWizard
     end
 
     def self.from_mongo(key)
-      return key if key.respond_to?(:superclass) && key.superclass == RailsWizard::Recipe
-      RailsWizard::Recipes[key]
+      return key if key.respond_to?(:superclass) && key.superclass == RailsWizard::Scroll
+      RailsWizard::Scrolls[key]
     end
 
     def self.get_binding

data/lib/rails_wizard/{recipes.rb → scrolls.rb}

@@ -1,14 +1,14 @@
 module RailsWizard
-  module Recipes
+  module Scrolls
     @@categories = {}
     @@list = {}
     
-    def self.add(recipe)
-      RailsWizard::Recipes.const_set ActiveSupport::Inflector.camelize(recipe.key), recipe
-      @@list[recipe.key] = recipe
-      (@@categories[recipe.category.to_s] ||= []) << recipe.key
-      @@categories[recipe.category.to_s].uniq!
-      recipe
+    def self.add(scroll)
+      RailsWizard::Scrolls.const_set ActiveSupport::Inflector.camelize(scroll.key), scroll
+      @@list[scroll.key] = scroll
+      (@@categories[scroll.category.to_s] ||= []) << scroll.key
+      @@categories[scroll.category.to_s].uniq!
+      scroll
     end
 
     def self.[](key)
@@ -31,8 +31,8 @@ module RailsWizard
       (@@categories[category.to_s] || []).sort
     end
 
-    def self.remove_from_category(category, recipe)
-      (@@categories[category.to_s] ||= []).delete(recipe.key)
+    def self.remove_from_category(category, scroll)
+      (@@categories[category.to_s] ||= []).delete(scroll.key)
     end
   end
 end

data/lib/rails_wizard/template.rb

@@ -1,16 +1,16 @@
 module RailsWizard
   class Template
-    attr_reader :recipes, :unknown_recipe_names
+    attr_reader :scrolls, :unknown_scroll_names
 
-    def initialize(recipes)
-      @unknown_recipe_names = []
-      @recipes = recipes.inject([]) do |list, name|
-        recipe = RailsWizard::Recipe.from_mongo(name)
-        if recipe
-          list << recipe
+    def initialize(scrolls)
+      @unknown_scroll_names = []
+      @scrolls = scrolls.inject([]) do |list, name|
+        scroll = RailsWizard::Scroll.from_mongo(name)
+        if scroll
+          list << scroll
         else
-          @unknown_recipe_names << name
-          $stderr.puts "Unknown recipe '#{name}'. Skipping."
+          @unknown_scroll_names << name
+          $stderr.puts "Unknown scroll '#{name}'. Skipping."
         end
         list
       end
@@ -27,30 +27,30 @@ module RailsWizard
     def render(template_name, binding = nil); self.class.render(template_name, binding) end
 
 
-    def resolve_recipes
-      @resolve_recipes ||= recipes_with_dependencies.sort
+    def resolve_scrolls
+      @resolve_scrolls ||= scrolls_with_dependencies.sort
     end
 
-    def recipe_classes
-      @recipe_classes ||= recipes.map { |name| RailsWizard::Recipe.from_mongo(name) }
+    def scroll_classes
+      @scroll_classes ||= scrolls.map { |name| RailsWizard::Scroll.from_mongo(name) }
     end
 
-    def recipes_with_dependencies
-      @recipes_with_dependencies ||= recipe_classes
+    def scrolls_with_dependencies
+      @scrolls_with_dependencies ||= scroll_classes
       
       added_more = false
-      for recipe in recipe_classes
-        recipe.requires.each do |requirement|
-          requirement = RailsWizard::Recipe.from_mongo(requirement)
-          count = @recipes_with_dependencies.size
-          (@recipes_with_dependencies << requirement).uniq!
-          unless @recipes_with_dependencies.size == count
+      for scroll in scroll_classes
+        scroll.requires.each do |requirement|
+          requirement = RailsWizard::Scroll.from_mongo(requirement)
+          count = @scrolls_with_dependencies.size
+          (@scrolls_with_dependencies << requirement).uniq!
+          unless @scrolls_with_dependencies.size == count
             added_more = true
           end
         end
       end
 
-      added_more ? recipes_with_dependencies : @recipes_with_dependencies
+      added_more ? scrolls_with_dependencies : @scrolls_with_dependencies
     end
 
     def compile
@@ -58,7 +58,7 @@ module RailsWizard
     end
 
     def args
-      recipes.map(&:args).uniq
+      scrolls.map(&:args).uniq
     end
 
     def custom_code?; false end