rails3_devise_wizard 0.2

data/recipes/seed_database.rb

@@ -0,0 +1,35 @@
+# Application template recipe for the rails3_devise_wizard. Check for a newer version here:
+# https://github.com/fortuity/rails3_devise_wizard/blob/master/recipes/seed_database.rb
+
+
+after_bundler do
+
+  if recipes.include? 'devise'
+
+    if recipes.include? 'mongoid'
+      # create a default user
+      append_file 'db/seeds.rb' do <<-FILE
+puts 'EMPTY THE MONGODB DATABASE'
+Mongoid.master.collections.reject { |c| c.name =~ /^system/}.each(&:drop)
+puts 'SETTING UP DEFAULT USER LOGIN'
+user = User.create! :name => 'First User', :email => 'user@test.com', :password => 'please', :password_confirmation => 'please'
+puts 'New user created: ' << user.name
+FILE
+      end
+    end
+
+    run 'rake db:seed'
+
+  end
+
+end
+
+__END__
+
+name: SeedDatabase
+description: "Create a database seed file with a default user."
+author: fortuity
+
+requires: [devise]
+category: other
+tags: [utilities, configuration]

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/settingslogic.rb

@@ -0,0 +1,43 @@
+gem 'settingslogic'
+
+say_wizard "Generating config/application.yml..."
+
+append_file "config/application.rb", <<-RUBY
+
+require 'settings'
+RUBY
+
+create_file "lib/settings.rb", <<-RUBY
+class Settings < Settingslogic
+  source "#\{Rails.root\}/config/application.yml"
+  namespace Rails.env
+end
+
+RUBY
+
+create_file "config/application.yml", <<-YAML
+defaults: &defaults
+  cool:
+    saweet: nested settings
+  neat_setting: 24
+  awesome_setting: <%= "Did you know 5 + 5 = #{5 + 5}?" %>
+
+development:
+  <<: *defaults
+  neat_setting: 800
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+YAML
+
+__END__
+
+name: Settingslogic
+description: "A simple and straightforward settings solution that uses an ERB enabled YAML file and a singleton design pattern."
+author: elandesign
+
+category: other
+tags: [utilities, configuration]

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/recipes/users_page.rb

@@ -0,0 +1,103 @@
+# Application template recipe for the rails3_devise_wizard. Check for a newer version here:
+# https://github.com/fortuity/rails3_devise_wizard/blob/master/recipes/users_page.rb
+
+after_bundler do
+
+  if recipes.include? 'devise'
+
+    #----------------------------------------------------------------------------
+    # Create a users controller
+    #----------------------------------------------------------------------------
+    generate(:controller, "users show")
+    gsub_file 'app/controllers/users_controller.rb', /def show/ do
+    <<-RUBY
+before_filter :authenticate_user!
+
+  def show
+    @user = User.find(params[:id])
+RUBY
+    end
+
+    #----------------------------------------------------------------------------
+    # Modify the routes
+    #----------------------------------------------------------------------------
+    # @devise_for :users@ route must be placed above @resources :users, :only => :show@.
+    gsub_file 'config/routes.rb', /get \"users\/show\"/, '#get \"users\/show\"'
+    gsub_file 'config/routes.rb', /devise_for :users/ do
+    <<-RUBY
+devise_for :users
+  resources :users, :only => :show
+RUBY
+    end
+
+    #----------------------------------------------------------------------------
+    # Create a users show page
+    #----------------------------------------------------------------------------
+    if recipes.include? 'haml'
+      remove_file 'app/views/users/show.html.haml'
+      # There is Haml code in this script. Changing the indentation is perilous between HAMLs.
+      # We have to use single-quote-style-heredoc to avoid interpolation.
+      create_file 'app/views/users/show.html.haml' do <<-'HAML'
+%p
+  User: #{@user.name}
+HAML
+      end
+    else
+      append_file 'app/views/users/show.html.erb' do <<-ERB
+<p>User: <%= @user.name %></p>
+ERB
+      end
+    end
+
+    #----------------------------------------------------------------------------
+    # Create a home page containing links to user show pages
+    # (clobbers code from the home_page_users recipe)
+    #----------------------------------------------------------------------------
+    # set up the controller
+    remove_file 'app/controllers/home_controller.rb'
+    create_file 'app/controllers/home_controller.rb' do
+    <<-RUBY
+class HomeController < ApplicationController
+  def index
+    @users = User.all
+  end
+end
+RUBY
+    end
+
+    # modify the home page
+    if recipes.include? 'haml'
+      remove_file 'app/views/home/index.html.haml'
+      # There is Haml code in this script. Changing the indentation is perilous between HAMLs.
+      # We have to use single-quote-style-heredoc to avoid interpolation.
+      create_file 'app/views/home/index.html.haml' do
+      <<-'HAML'
+%h3 Home
+- @users.each do |user|
+  %p User: #{link_to user.name, user}
+HAML
+      end
+    else
+      remove_file 'app/views/home/index.html.erb'
+      create_file 'app/views/home/index.html.erb' do <<-ERB
+<h3>Home</h3>
+<% @users.each do |user| %>
+  <p>User: <%=link_to user.name, user %></p>
+<% end %>
+ERB
+      end
+    end
+
+  end
+
+end
+
+__END__
+
+name: UsersPage
+description: "Add a users controller and user show page with links from the home page."
+author: fortuity
+
+requires: [devise]
+category: other
+tags: [utilities, configuration]

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