rails_wizard 0.1.0

data/README.markdown

@@ -0,0 +1,95 @@
+# RailsWizard Gem 
+
+The RailsWizard gem is both the official repository of recipes for
+[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.
+
+## Installation
+
+Installation is simple:
+
+    gem install rails_wizard
+
+## Usage
+
+The primary usage of the `rails_wizard` gem is to utilize its
+interactive terminal command to build a Rails template. To get started,
+you can simply run the command thusly:
+
+    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.
+
+### Specifying Recipes
+
+If you wish to skip the interactive recipe selector, you may provide
+instead a list of recipes with the `-r` option:
+
+    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.
+
+### Listing Recipes
+
+You can also print out a simple list of recipes:
+
+    rails_wizard list
+
+Or print out a list of recipes for a specific category:
+
+    rails_wizard list persistence
+
+# RailsWizard Recipes
+
+Previously stored in MongoDB, the RailsWizard 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].
+
+If you're looking for the web app source code, it now lives at
+[rails_wizard.web][3].
+
+## Submitting a Recipe
+
+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:
+
+    gem 'supergem'
+
+    after_bundler do
+      generate "supergem:install"
+    end
+
+    __END__
+
+    category: templating
+    name: SuperGem
+    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
+RailsWizard could properly parse and understand your recipe file.
+
+For more information on all available options for authoring recipes,
+please see the 
+
+## License
+
+RailsWizard and its recipes are distributed under the MIT License.
+
+[1]:http://railswizard.org/
+[2]:https://github.com/intridea/rails_wizard/tree/master/recipes
+[3]:https://github.com/intridea/rails_wizard.web

data/bin/rails_wizard

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+$:.push File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'rails_wizard/command'
+
+RailsWizard::Command.start

data/lib/rails_wizard.rb

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

data/lib/rails_wizard/command.rb

@@ -0,0 +1,78 @@
+require 'rails_wizard'
+require 'thor'
+
+module RailsWizard
+  class Command < Thor
+    include Thor::Actions
+    desc "new APP_NAME", "create a new Rails app"
+    method_option :recipes, :type => :array, :aliases => "-r"
+    def new(name)
+      if options[:recipes]
+        run_template(name, options[:recipes])
+      else
+        @recipes = []
+
+        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)
+          elsif RailsWizard::Recipes.list.include?(recipe)
+            @recipes << recipe
+            puts
+            puts "> #{green}Added '#{recipe}' to template.#{clear}"
+          else
+            puts
+            puts "> #{red}Invalid recipe, please try again.#{clear}"
+          end
+        end
+      end
+    end
+
+    desc "list [CATEGORY]", "list available recipes (optionally by category)"
+    def list(category = nil)
+      if category
+        recipes = RailsWizard::Recipes.for(category).map{|r| RailsWizard::Recipe.from_mongo(r) }
+      else
+        recipes = RailsWizard::Recipes.list_classes
+      end
+
+      recipes.each do |recipe|
+        puts recipe.key.ljust(15) + "# #{recipe.description}"
+      end
+    end
+
+    no_tasks do
+      def cyan; "\033[36m" end
+      def clear; "\033[0m" end
+      def bold; "\033[1m" end
+      def red; "\033[31m" end
+      def green; "\033[32m" end
+      def yellow; "\033[33m" end
+
+      def print_recipes
+        puts
+        puts
+        puts
+        if @recipes && @recipes.any?
+          puts "#{green}#{bold}Your Recipes:#{clear} " + @recipes.join(", ")
+          puts
+        end
+        puts "#{bold}#{cyan}Available Recipes:#{clear} " + RailsWizard::Recipes.list.join(', ')
+        puts
+      end
+
+      def run_template(name, recipes)
+        puts
+        puts
+        puts "#{bold}Generating and Running Template..."
+        puts
+        file = Tempfile.new('template')        
+        template = RailsWizard::Template.new(recipes)
+        file.write template.compile
+        file.close
+        system "rails new #{name} -m #{file.path} #{template.args.join(' ')}"
+      ensure
+        file.unlink
+      end
+    end
+  end
+end

data/lib/rails_wizard/config.rb

@@ -0,0 +1,86 @@
+require 'active_support/ordered_hash'
+
+module RailsWizard
+  class Config
+    attr_reader :questions
+
+    def initialize(schema)
+      @questions = ActiveSupport::OrderedHash.new
+      schema.each do |hash| 
+        key = hash.keys.first
+        details = hash.values.first
+
+        kind = details['type']
+        raise ArgumentError, "Unrecognized question type, must be one of #{QUESTION_TYPES.keys.join(', ')}" unless QUESTION_TYPES.keys.include?(kind)
+        @questions[key] = QUESTION_TYPES[kind].new(details)
+      end
+    end
+
+    def compile(values = {})
+      result = []
+      result << "config = #{values.inspect}"
+      @questions.each_pair do |key, question|
+        result << "config['#{key}'] = #{question.compile} unless config.key?('#{key}')"
+      end
+      result.join("\n")
+    end
+
+    class Prompt
+      attr_reader :prompt, :details
+      def initialize(details)
+        @details = details
+        @prompt = details['prompt']
+      end
+
+      def compile
+        "#{question} if #{conditions}"
+      end
+
+      def question
+        "ask_wizard(#{prompt.inspect})"
+      end
+
+      def conditions
+        [config_conditions, recipe_conditions].join(' && ')
+      end
+
+      def config_conditions
+        if details['if']
+          "config['#{details['if']}']"
+        elsif details['unless']
+          "!config['#{details['unless']}']"
+        else
+          'true'
+        end
+      end
+
+      def recipe_conditions
+        if details['if_recipe']
+          "recipe?('#{details['if_recipe']}')"
+        elsif details['unless_recipe']
+          "!recipe?('#{details['unless_recipe']}')"
+        else
+          'true'
+        end
+      end
+    end
+
+    class TrueFalse < Prompt
+      def question 
+        "yes_wizard?(#{prompt.inspect})"
+      end
+    end
+
+    class MultipleChoice < Prompt
+      def question
+        "multiple_choice(#{prompt.inspect}, #{@details['choices'].inspect})"
+      end 
+    end
+
+    QUESTION_TYPES = {
+      'boolean' => TrueFalse,
+      'string' => Prompt,
+      'multiple_choice' => MultipleChoice
+    }
+  end
+end

data/lib/rails_wizard/recipe.rb

@@ -0,0 +1,106 @@
+require 'rails_wizard/config'
+
+require 'active_support/inflector'
+require 'yaml'
+require 'erb'
+
+module RailsWizard
+  class Recipe
+    extend Comparable
+    
+    def self.<=>(another)
+      return -1 if another.run_after.include?(self.key) || self.run_before.include?(another.key)
+      return 1 if another.run_before.include?(self.key) || self.run_after.include?(another.key)
+      0
+    end
+
+    ATTRIBUTES = %w(key args category name description template config exclusive tags run_before run_after requires)
+    DEFAULT_ATTRIBUTES = {
+      :category => 'other',
+      :args => [],
+      :tags => [],
+      :run_after => [],
+      :run_before => [],
+      :requires => []
+    }
+
+    def self.generate(key, template_or_file, attributes = {})
+      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
+        template = parts.first.strip
+        attributes = YAML.load(parts.last).inject({}) do |h,(k,v)|
+          h[k.to_sym] = v
+          h
+        end.merge!(attributes)
+      else
+        template = template_or_file
+      end
+ 
+      recipe_class = Class.new(RailsWizard::Recipe) 
+      recipe_class.attributes = attributes
+      recipe_class.template = template
+      recipe_class.key = key
+
+      recipe_class
+    end
+
+    ATTRIBUTES.each do |setter|
+      class_eval <<-RUBY
+        def self.#{setter}
+          attributes[:#{setter}]
+        end
+
+        def self.#{setter}=(val)
+          attributes[:#{setter}] = val
+        end
+
+        def #{setter}
+          self.class.#{setter}
+        end
+      RUBY
+    end
+
+    # The attributes hash containing any set values for
+    def self.attributes
+      @attributes ||= DEFAULT_ATTRIBUTES.dup
+    end
+
+    def self.attributes=(hash)
+      attributes.merge! hash
+    end
+
+    def self.config
+      return nil unless attributes[:config]
+      RailsWizard::Config.new(attributes[:config])
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def self.compile
+      "# >#{"[ #{name} ]".center(75,'-')}<\n\n# #{description}\nsay_recipe '#{name}'\n\n#{template}\n"
+    end
+    def compile; self.class.compile end
+
+    def self.to_mongo(value)
+      case value
+        when Class
+          value.key
+        when String
+          value
+      end
+    end
+
+    def self.from_mongo(key)
+      return key if key.respond_to?(:superclass) && key.superclass == RailsWizard::Recipe
+      RailsWizard::Recipes[key]
+    end
+
+    def self.get_binding
+      binding
+    end
+  end
+end

data/lib/rails_wizard/recipes.rb

@@ -0,0 +1,38 @@
+module RailsWizard
+  module Recipes
+    @@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
+    end
+
+    def self.[](key)
+      @@list[key.to_s]
+    end
+
+    def self.list
+      @@list.keys.sort
+    end
+
+    def self.list_classes
+      @@list.values.sort_by{|c| c.key}
+    end
+
+    def self.categories
+      @@categories.keys.sort
+    end
+
+    def self.for(category)
+      (@@categories[category.to_s] || []).sort
+    end
+
+    def self.remove_from_category(category, recipe)
+      (@@categories[category.to_s] ||= []).delete(recipe.key)
+    end
+  end
+end

data/lib/rails_wizard/template.rb

@@ -0,0 +1,57 @@
+module RailsWizard
+  class Template
+    attr_reader :recipes
+
+    def initialize(recipes)
+      @recipes = recipes.map{|r| RailsWizard::Recipe.from_mongo(r)}
+    end
+
+    def self.template_root
+      File.dirname(__FILE__) + '/../../templates'
+    end
+
+    def self.render(template_name, binding = nil)
+      erb = ERB.new(File.open(template_root + '/' + template_name + '.erb').read)
+      erb.result(binding)
+    end
+    def render(template_name, binding = nil); self.class.render(template_name, binding) end
+
+
+    def resolve_recipes
+      @resolve_recipes ||= recipes_with_dependencies.sort
+    end
+
+    def recipe_classes
+      @recipe_classes ||= recipes.map{|r| RailsWizard::Recipe.from_mongo(r)}
+    end
+
+    def recipes_with_dependencies
+      @recipes_with_dependencies ||= recipe_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
+            added_more = true
+          end
+        end
+      end
+
+      added_more ? recipes_with_dependencies : @recipes_with_dependencies
+    end
+
+    def compile
+      render 'layout', binding
+    end
+
+    def args
+      recipes.map(&:args).uniq
+    end
+
+    def custom_code?; false end
+    def custom_code; nil end
+  end
+end