Blueprint

Blueprint is the Rails application starter used at datarockets.

TODO: fix it

Add this line to your application's Gemfile:

gem 'blueprint'

And then execute:

$ bundle

Or install it yourself as:

$ gem install blueprint

For creating rails application run:

$ blueprint new APP_NAME

Guide for creating and editing generators.

Add command for generator in lib/blueprint/generator/cli.rb.

Example:

command :new do |c|
  c.syntax = 'blueprint new APP_PATH'
  c.summary = 'Generate rails application'
  c.description = 'Generate rails application with default settings and dependecies'
  c.action do |args, _options|
    Blueprint::Generator::RailsApp.new(name: args[0]).run!
  end
end

Extending class of Blueprint::Generator::Base:

require 'blueprint/generator/base'

module Blueprint
  module Generator
    class RailsApp < Base
    end
  end
end

Create folder for files and templates for your application on folder lib/blueprint/generator/templates/ and override folder name on generator class

def self.template_path
  'rails_app'
end

Override ask_questions method for creating config hash. Question list.

def ask_questions
  config[:bootstrap] = agree("Would you like initialize bootstrap on your application?")
end

Override execute method for creating generator script.

def execute
  shell "rails new #{name} --skip-bundle --database=postgresql --no-rc --skip-test-unit"
end

List with commands for creating execute script:

Variable lists in generator class and erb templates

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blueprint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.