rails-maker 0.1.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2011 Quick Left
+
+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,87 @@
+The rails-maker
+===========
+Generate a Rails 3 app with the application templates Quick Left uses to start their projects off right!
+
+
+### What you get
+
+The rails-maker provides a set of templates to generate Rails 3 applications.
+Everything is configured and ready to rock your next Rails 3 project.
+We hope it saves you a mess of time!
+
+* Default: A base Rails 3 application with Devise and Cancan for
+  authentication and authorization. Roles are stored in the database
+  with a HABTM relationship between the role and user models. You also get
+  a basic admin to manage users. The rails-maker also rolls in all of the things
+  we like to have setup in our apps like: haml, sass, jquery, cucumber,
+  capybara, mocha, factory_girl, rspec, timecop, autotest, evergreen,
+  jasmine, will_paginate, friendly_id and hoptoad_notifier.
+
+        rails-maker new my_app
+        rails-maker new my_app default
+
+* Async: A Rails 3 application with the basic setup complete for running
+  fully async on the Thin web server. Included gems are thin,
+  rack-fiber_pool, mysql2, and rspec.
+
+        rails-maker new my_app async
+
+
+### Quick Start
+
+    gem install rails-maker
+
+    rails-maker new my_app
+
+
+### Options ( in default template )
+
+    rails-maker new my_app --no-auth
+
+    rails-maker new my_app --no-roles
+
+    rails-maker new my_app --no-admin
+
+
+### Testing generated default app
+
+    rake spec
+    rake cucumber
+    rake spec:javascripts
+    bundle exec autotest
+
+
+### Issues
+
+Please report issues to the [the rails-maker issue tracker](http://github.com/koteus/rails-maker/issues/).
+
+
+### Development
+
+    bundle install
+    bundle exec cucumber
+
+Running `bundle exec cucumber` will take some time.  It runs the CLI tool with different option combinations and tests
+those outputs with aruba.
+
+
+### Patches/Pull Requests
+
+* Fork it.
+* Add tests for it.
+* Make your changes.
+* Commit.
+* Send a pull request.
+
+
+### Thanks
+
+All of the contributors to the many awesome open source projects that make up rails-maker and allow us to do our job everyday.
+Also, thanks go out to the crew at thoughtbot for writing suspenders.  It's what gave us the idea to package up our
+templates into a gem in the first place.
+
+
+### Copyright
+
+Copyright (c) 2010-2011 Collin Schaafsma & Quick Left. See LICENSE for details.
+

data/bin/rails-maker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# Requires
+begin
+  require 'rails-maker'
+rescue LoadError
+  $:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  require 'rubygems'
+  require 'rails-maker'
+end
+
+# Setup Constants
+RailsMaker::GEM_ROOT = File.expand_path( File.dirname( __FILE__ ) + '/../' )
+
+# Run
+RailsMaker::CLI.start(ARGV)

data/lib/rails-maker.rb

@@ -0,0 +1,8 @@
+require 'rails-maker/cli'
+require 'rails-maker/version'
+
+module RailsMaker
+  autoload :Errors , 'rails-maker/errors'
+  autoload :TemplateRunner , 'rails-maker/template_runner'
+end
+

data/lib/rails-maker/cli.rb

@@ -0,0 +1,44 @@
+require 'thor'
+require 'thor/actions'
+
+module RailsMaker
+
+  class CLI < Thor
+
+    include Thor::Actions
+
+    desc 'new [app]', 'Create a new Rails application'
+    long_desc <<-D
+      The rails-maker will ask you a few questions to determine what features you
+      would like to generate. Based on your answers it will setup a new Rails application.
+    D
+
+    def new(project, template_name = 'default')
+
+      # Require the template runner
+      require "#{RailsMaker::GEM_ROOT}/templates/#{template_name}/#{template_name}.rb"
+
+      # Invoke the template runner
+      # invoke "RailsMaker:Templates:#{template_name}:on_invocation"
+      # invoke RailsMaker::Templates::Default.on_invocation
+
+      # Execute the template
+      exec(<<-COMMAND)
+        rails new #{project} \
+          --template=#{RailsMaker::GEM_ROOT}/templates/#{template_name}/bootstrap.rb \
+          --skip-test-unit \
+          --skip-prototype
+      COMMAND
+
+    end
+
+    desc 'version', "Prints the rails-maker's version information"
+    def version
+      say "The rails-maker version #{RailsMaker::VERSION}"
+    end
+    map %w(-v --version) => :version
+
+  end
+
+end
+

data/lib/rails-maker/errors.rb

@@ -0,0 +1,11 @@
+module RailsMaker
+
+	module Errors
+
+		class TemplateRunnerNotImplementedError < StandardError; end
+		class TemplateRunnerInvocationNotImplementedError < StandardError; end
+
+	end
+
+end
+

data/lib/rails-maker/template_runner.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require 'thor/actions'
+require 'thor/group'
+
+module RailsMaker
+
+  class TemplateRunner < Thor::Group
+
+    # Define the Standard Arguments in any base template class
+    def self.extended(base)
+      base.class_eval do
+        argument :project, :type => :string
+      end
+    end
+
+    # Includes
+    include Thor::Actions
+
+    # The method to run when the template is invoked. This is used to
+    # parse custom options from the command line or complete any other
+    # setup prior to invoking the system command that will construct
+    # the project.
+    def on_invocation
+      raise RailsMaker::Errors::TemplateRunnerInvocationNotImplementedError.new("Template did not define an on_invocation method!")
+    end
+
+  end
+
+end
+

data/lib/rails-maker/version.rb

@@ -0,0 +1,3 @@
+module RailsMaker
+  VERSION = "0.1.1"
+end

data/spec/railsmaker_cli_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe RailsMaker::CLI do
+
+  it "should raise an error if a bad template name is passed in" do
+    lambda {
+      instance = RailsMaker::CLI.new
+      instance.new( "app" , "default" )
+    }.should raise_error
+  end
+
+end
+

data/spec/railsmaker_template_runner_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class TestTemplate1 < ::RailsMaker::TemplateRunner
+  def on_invocation
+    return "hi"
+  end
+end
+
+class TestTemplate2 < ::RailsMaker::TemplateRunner
+end
+
+describe RailsMaker::TemplateRunner do
+
+  it "should not raise an error if the on_invocation method is implemented" do
+    lambda {
+      TestTemplate1.new.on_invocation
+    }.should_not raise_error
+  end
+
+  it "should raise an error if the on_invocation method isn't implemented" do
+    lambda {
+      TestTemplate2.new.on_invocation
+    }.should raise_error
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'rails-maker'
+RailsMaker::GEM_ROOT = File.expand_path( File.dirname( __FILE__ ) + '/../' )

data/templates/default/bootstrap.rb

@@ -0,0 +1,76 @@
+require "net/http"
+require "net/https"
+require "uri"
+require 'rbconfig'
+
+say "Building Application with the rails-maker..."
+
+def get_remote_https_file(source, destination)
+  uri = URI.parse(source)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  request = Net::HTTP::Get.new(uri.request_uri)
+  response = http.request(request)
+  path = File.join(destination_root, destination)
+  File.open(path, "w") { |file| file.write(response.body) }
+end
+
+git :init
+
+run 'rm .gitignore'
+create_file '.gitignore' do
+<<-FILE
+.bundle
+.DS_Store
+log/*.log
+tmp/**/*
+config/database.yml
+db/*.sqlite3
+public/system/**/**/**/*
+.idea/*
+.sass-cache/**/*
+*.swp
+public/uploads
+FILE
+end
+
+files = %w{
+  gemfile
+  haml_generator
+  rails_clean
+  application_layout
+  home_controller
+  css
+  test_suite
+  authentication
+  authorization
+  admin
+  db
+  db_seed
+}
+
+files.each do |file|
+  apply File.expand_path("../lib/#{file}.rb", __FILE__)
+end
+
+login_msg = (ENV['RAILSMAKER_ADMIN']) ? "Login to admin with email #{ENV['RAILSMAKER_USER_EMAIL']} and password #{ENV['RAILSMAKER_USER_PASSWORD']}" : ""
+
+say <<-D
+
+
+  ########################################################################
+
+  The rails-maker just added like 6 hours to your life.
+
+  Template Installed :: Default
+
+  Next run...
+
+  rake spec
+  rails s
+
+  #{login_msg}
+
+  ########################################################################
+D

data/templates/default/default.rb

@@ -0,0 +1,57 @@
+module RailsMaker
+
+  module Templates
+
+    class Default < RailsMaker::TemplateRunner
+
+      # Class Options
+      # @see https://github.com/wycats/thor/wiki/Groups
+      class_option :auth  , :type => :boolean , :default => true , :banner => "Sets up devise for authentication."
+      class_option :roles , :type => :boolean , :default => true , :banner => "Sets up cancan for authorization with rolify."
+      class_option :admin , :type => :boolean , :default => true , :banner => "Sets up very basic admin"
+
+      # Descriptions
+      desc "Runs the default rails-maker Rails stack task"
+
+      # The method to run when the template is invoked
+      def on_invocation  
+
+        # Dup our options so we can modify them
+        opts = options.dup
+
+        # Can't build an admin or roles without devise
+        unless opts[:auth]
+          opts[:admin] = false
+          opts[:roles] = false
+        end
+
+        # Env vars used in our template
+        ENV['RAILSMAKER_AUTH']  = "true" if opts[:auth]
+        ENV['RAILSMAKER_ADMIN'] = "true" if opts[:admin]
+        ENV['RAILSMAKER_ROLES'] = "true" if opts[:roles]
+        ENV['RAILSMAKER_USER_NAME'] = git_user_name if opts[:admin]
+        ENV['RAILSMAKER_USER_EMAIL'] = git_user_email if opts[:admin]
+        ENV['RAILSMAKER_USER_PASSWORD'] = user_password if opts[:admin]
+
+      end
+
+      private
+
+      def git_user_name
+        `git config --global user.name`.chomp.gsub('"', '\"') || 'admin'
+      end
+
+      def git_user_email
+        `git config --global user.email`.chomp || 'admin@ikitlab.com'
+      end
+
+      def user_password
+        'admin123'
+      end
+
+    end
+
+  end
+
+end
+

data/templates/default/lib/admin.rb

@@ -0,0 +1,29 @@
+say "Building admin"
+generate(:controller, "admin/dashboard index")
+route("match 'admin' => 'admin/dashboard#index'")
+
+# Do layout and SASS stuff
+apply File.expand_path("../admin/sass.rb", __FILE__)
+apply File.expand_path("../admin/layout.rb", __FILE__)
+
+create_file 'app/controllers/admin/base_controller.rb' do
+<<-RUBY
+class Admin::BaseController < ApplicationController
+  layout 'admin'
+  before_filter :authenticate_user!  
+  before_filter :verify_admin
+
+private
+  def verify_admin
+    redirect_to root_url unless current_user.role? :admin
+  end
+end
+RUBY
+end
+
+gsub_file 'app/controllers/admin/dashboard_controller.rb', /ApplicationController/, 'Admin::BaseController'
+
+# make a user admin
+apply File.expand_path("../admin/users.rb", __FILE__)
+apply File.expand_path("../admin/dashboard_spec.rb", __FILE__)
+apply File.expand_path("../admin/users_spec.rb", __FILE__)

data/templates/default/lib/admin/dashboard_spec.rb

@@ -0,0 +1,24 @@
+run 'rm spec/controllers/admin/dashboard_controller_spec.rb'
+
+create_file 'spec/controllers/admin/dashboard_controller_spec.rb' do
+<<-'FILE'
+  require 'spec_helper'
+  include Devise::TestHelpers
+
+  describe Admin::DashboardController do
+    before(:each) do
+      @user = @user ||=Factory.create(:admin)
+      sign_in @user
+    end
+
+    describe "GET 'index'" do
+      it "should be successful" do
+        get 'index'
+        response.should be_success
+      end
+    end
+
+  end
+
+FILE
+end