rails_wizard 0.1.0

data/recipes/omniauth.rb

@@ -0,0 +1,15 @@
+gem 'omniauth', '~> 0.2.0'
+
+after_bundler do
+  file 'app/controllers/sessions_controller.rb', "class SessionsController < ApplicationController\n  def callback\n    auth # Do what you want with the auth hash!\n  end\n\n  def auth; request.env['omniauth.auth'] end\nend"
+  route "match '/auth/:provider/callback', :to => 'sessions#callback'"
+end
+
+__END__
+
+name: OmniAuth
+description: "A basic setup of OmniAuth with a SessionsController to handle the request and callback phases."
+author: mbleigh
+
+exclusive: authentication
+category: authentication

data/recipes/prototype.rb

@@ -0,0 +1,11 @@
+# No extra code required.
+
+__END__
+
+name: Prototype
+description: "Use the default Javascript libraries and helpers."
+author: mbleigh
+
+exclusive: javascript_framework
+category: assets
+tags: [javascript, framework, defaults]

data/recipes/redis.rb

@@ -0,0 +1,11 @@
+gem 'redis'
+
+__END__
+
+name: Redis
+description: "Add Redis as a persistence engine to your application."
+author: mbleigh
+
+exclusive: key_value
+category: persistence
+tags: [key_value, cache, session_store]

data/recipes/rightjs.rb

@@ -0,0 +1,17 @@
+gem 'right-rails'
+
+after_bundler do
+  generate 'right_rails'
+end
+
+__END__
+
+name: RightJS
+description: "Use RightJS in place of Prototype for this application."
+author: mbleigh
+
+exclusive: javascript_framework
+category: assets
+tags: [javascript, framework]
+
+args: ["-J"]

data/recipes/rspec.rb

@@ -0,0 +1,21 @@
+gem 'rspec-rails', '>= 2.0.1', :group => [:development, :test]
+
+inject_into_file "config/initializers/generators.rb", :after => "Rails.application.config.generators do |g|\n" do
+  "    g.test_framework = :rspec\n"
+end
+
+after_bundler do
+  generate 'rspec:install'
+end
+
+__END__
+
+name: RSpec
+description: "Use RSpec for unit testing for this Rails app."
+author: mbleigh
+
+exclusive: unit_testing
+category: testing
+
+args: ["-T"]
+

data/recipes/sass.rb

@@ -0,0 +1,13 @@
+unless recipes.include? 'haml'
+  gem 'haml', '>= 3.0.0'
+end
+
+__END__
+
+name: SASS
+description: "Utilize SASS (through the HAML gem) for really awesome stylesheets!"
+author: mbleigh
+
+exclusive: css_replacement 
+category: assets
+tags: [css]

data/recipes/sequel.rb

@@ -0,0 +1,13 @@
+gem 'sequel-rails'
+
+application "require 'sequel-rails/railtie'"
+
+__END__
+
+name: Sequel
+description: "Utilize Sequel as the primary ORM for your application."
+author: mbleigh
+
+exclusive: orm
+category: persistence
+tags: [orm, sql]

data/recipes/slim.rb

@@ -0,0 +1,11 @@
+gem 'slim'
+gem 'slim-rails'
+
+__END__
+
+name: Slim
+description: "Use Slim as the default templating engine."
+author: mbleigh
+
+category: templating
+exclusive: templating

data/recipes/test_unit.rb

@@ -0,0 +1,11 @@
+# No additional code required.
+
+__END__
+
+name: Test::Unit
+description: "Utilize the default Rails test facilities."
+author: mbleigh
+
+exclusive: unit_testing
+category: testing
+tags: [defaults]

data/spec/rails_wizard/config_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe RailsWizard::Config do
+  describe '#initialize' do
+    subject{ RailsWizard::Config.new(YAML.load(@schema)) }  
+    it 'should add a question key for each key of the schema' do
+      @schema = <<-YAML
+      - test:
+          type: string
+      YAML
+      subject.questions.should be_key('test')
+    end
+
+    it 'should instantiate the correct question type for each question' do
+      @schema = <<-YAML
+      - string:
+          type: string
+      - boolean:
+          type: boolean
+      - multiple_choice:
+          type: multiple_choice
+      YAML
+      subject.questions['string'].should be_kind_of(RailsWizard::Config::Prompt)
+      subject.questions['boolean'].should be_kind_of(RailsWizard::Config::TrueFalse)
+      subject.questions['multiple_choice'].should be_kind_of(RailsWizard::Config::MultipleChoice)
+    end
+
+    it 'should error on invalid question type' do
+      @schema = <<-YAML
+      - invalid
+        type: invalid
+      YAML
+      lambda{ subject }.should raise_error(ArgumentError)
+    end
+
+    describe '#compile' do
+      let(:lines) { subject.compile.split("\n") }
+      before do
+        @schema = <<-YAML
+        - string:
+            type: string
+            prompt: Give me a string?
+            if: is_true
+        - boolean:
+            type: boolean
+            prompt: Yes or no?
+            unless: is_false
+            if_recipe: awesome
+        - multiple_choice:
+            type: multiple_choice
+            choices: [[ABC, abc], [DEF, def]]
+            unless_recipe: awesome
+        YAML
+      end
+
+      it 'should include all questions' do
+        lines.size.should == 4
+      end
+
+      it 'should handle "if"' do
+        lines[1].should be_include("config['is_true']")
+      end
+
+      it 'should handle "unless"' do
+        lines[2].should be_include("!config['is_false']")
+      end
+
+      it 'should handle "if_recipe"' do
+        lines[2].should be_include("recipe?('awesome')")
+      end
+
+      it 'should handle "unelss_recipe"' do
+        lines[3].should be_include("!recipe?('awesome')")
+      end
+    end
+
+    describe RailsWizard::Config::Prompt do
+      subject{ RailsWizard::Config::Prompt }
+      it 'should compile to a prompt' do
+        subject.new({'prompt' => "What's your favorite color?"}).question.should == 'ask_wizard("What\'s your favorite color?")'
+      end
+    end
+
+    describe RailsWizard::Config::TrueFalse do
+      subject{ RailsWizard::Config::TrueFalse }
+      it 'should compile to a yes? question' do
+        subject.new({'prompt' => 'Yes yes?'}).question.should == 'yes_wizard?("Yes yes?")'
+      end
+    end
+
+    describe RailsWizard::Config::MultipleChoice do
+      subject{ RailsWizard::Config::MultipleChoice }
+      it 'should compile into a multiple_choice' do
+        subject.new({'prompt' => 'What kind of fruit?', 'choices' => [['Apples', 'apples'], ['Bananas', 'bananas']]}).question.should ==
+          'multiple_choice("What kind of fruit?", [["Apples", "apples"], ["Bananas", "bananas"]])'
+      end
+    end
+  end
+end

data/spec/rails_wizard/recipe_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe RailsWizard::Recipe do
+  context "with a generated recipe" do
+    subject{ RailsWizard::Recipe.generate('recipe_example', "# this is a test", :category => 'example', :name => "RailsWizard Example") }
+
+    context 'string setter methods' do
+      (RailsWizard::Recipe::ATTRIBUTES - ['config']).each do |setter|
+        it "should be able to set #{setter} with an argument" do
+          subject.send(setter + '=', "test")
+          subject.send(setter).should == 'test'
+        end
+
+        it 'should be able to get the value from the instance' do
+          subject.send(setter + '=', 'test')
+          subject.new.send(setter).should == subject.send(setter)
+        end
+      end
+    end
+
+    describe '.attributes' do
+      it 'should be accessible from the instance' do
+        subject.new.attributes.should == subject.attributes
+      end
+    end
+
+    describe '.generate' do
+      it 'should work with a string and hash as arguments' do
+        recipe = RailsWizard::Recipe.generate('some_key', '# some code', :name => "Example")
+        recipe.superclass.should == RailsWizard::Recipe
+      end
+
+      it 'should work with an IO object' do
+        file = StringIO.new <<-RUBY
+# this is an example
+
+__END__
+
+category: example
+name: This is an Example
+description: You know it's an exmaple.
+RUBY
+        recipe = RailsWizard::Recipe.generate('just_a_test', file)
+        recipe.template.should == '# this is an example'        
+        recipe.category.should == 'example'
+        recipe.name.should == 'This is an Example'
+      end
+
+      it 'should raise an exception if the file is incorrectly formatted' do
+        file = StringIO.new <<-RUBY
+# just ruby, no YAML
+RUBY
+        lambda{RailsWizard::Recipe.generate('testing',file)}.should raise_error(ArgumentError)
+      end
+    end
+
+    describe '#compile' do
+      it 'should say the name' do
+        subject.name = "Awesome Sauce"
+        subject.new.compile.should be_include("say_recipe 'Awesome Sauce'")
+      end
+
+      it 'should include the template' do
+        subject.template = "This is only a test."
+        subject.new.compile.should be_include(subject.template)
+      end
+    end
+  end
+
+  it 'should set default attributes' do
+    recipe = RailsWizard::Recipe.generate('abc','# test')
+    
+    RailsWizard::Recipe::DEFAULT_ATTRIBUTES.each_pair do |k,v|
+      recipe.send(k).should == v
+    end
+  end
+
+  context 'Comparable' do
+    subject{ RailsWizard::Recipe }
+    it 'a < b.run_after(a)' do
+      A = subject.generate('a', '#')
+      B = subject.generate('b', '#', :run_after => ['a'])
+
+      (A < B).should be_true
+    end
+
+    it 'a > b.run_before(a)' do
+      A = subject.generate('a', '#')
+      B = subject.generate('b', '#', :run_before => ['a'])
+      
+      (A > B).should be_true
+    end
+
+    after do
+      Object.send :remove_const, :A if defined?(A)
+      Object.send :remove_const, :B if defined?(B)
+    end
+  end
+end
+
+__END__
+
+this is a test

data/spec/rails_wizard/recipes/sanity_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+# This is a simple set of tests to make sure that
+# all of the recipes conform to the base requirements.
+
+RailsWizard::Recipes.list_classes.each do |recipe|
+  describe recipe do
+    it("should have a name"){ recipe.name.should be_kind_of(String) }    
+    it("should have a description"){ recipe.description.should be_kind_of(String) }
+    it("should have a template"){ recipe.template.should be_kind_of(String) }
+    it("should be able to compile"){ recipe.new.compile.should be_kind_of(String) }
+    
+    it "should have a string or nil category" do
+      if recipe.category
+        recipe.category.should be_kind_of(String)
+      end
+    end
+
+    it "should have a Config or nil config" do
+      if recipe.config
+        recipe.config.should be_kind_of(RailsWizard::Config)
+      end
+    end
+
+    it "should be in the list" do
+      RailsWizard::Recipes.list_classes.should be_include(recipe)
+      RailsWizard::Recipes.list.should be_include(recipe.key)
+    end
+  end
+end

data/spec/rails_wizard/recipes_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe RailsWizard::Recipes do
+  subject{ RailsWizard::Recipes }
+  let(:recipe){ RailsWizard::Recipe.generate("recipe_test", "# Testing", :name => "Test Recipe", :category => "test", :description => "Just a test.")}
+
+  before(:all) do
+    RailsWizard::Recipes.add(recipe)
+  end
+
+  it '.list_classes should include recipe classes' do
+    subject.list_classes.should be_include(recipe)
+  end
+
+  it '.list should include recipe keys' do
+    subject.list.should be_include('recipe_test')
+  end
+
+  describe '.for' do
+    it 'should find for a given category' do
+      RailsWizard::Recipes.for('test').should be_include('recipe_test')
+    end
+  end
+end

data/spec/rails_wizard/template_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe RailsWizard::Template do
+  subject{ RailsWizard::Template }
+  let(:recipe){ RailsWizard::Recipe.generate('name','# test') }
+
+  describe '#initialize' do
+    it 'should work with classes' do
+      subject.new([recipe]).recipes.should == [recipe]
+    end
+  end
+
+  describe '#recipes_with_dependencies' do
+    def r(*deps)
+      mock(:Class, :requires => deps, :superclass => RailsWizard::Recipe)
+    end
+
+    subject do
+      @template = RailsWizard::Template.new([]) 
+      @template.stub!(:recipes).and_return(@recipes)
+      @template.stub!(:recipe_classes).and_return(@recipes)
+      @template
+    end
+    
+    it 'should return the same number recipes if none have dependencies' do
+      @recipes = [r, r]
+      subject.recipes_with_dependencies.size.should == 2
+    end
+
+    it 'should handle simple dependencies' do
+      @recipes = [r(r, r), r(r)]
+      subject.recipes_with_dependencies.size.should == 5
+    end
+
+    it 'should handle multi-level dependencies' do
+      @recipes = [r(r(r))]
+      subject.recipes_with_dependencies.size.should == 3
+    end
+
+    it 'should uniqify' do
+      a = r
+      b = r(a)
+      c = r(r, a, b)
+      @recipes = [a,b,c]
+      subject.recipes_with_dependencies.size.should == 4
+    end
+  end
+end