railsbricks 3.7.0

data/README.md

@@ -0,0 +1,81 @@
+# RailsBricks
+
+_Create **Rails** apps. **Faster**._
+
+---
+- Title: RailsBricks
+- Version: 3.7.0
+- Author: Nico Schuele (www.nicoschuele.com)
+- Github: https://github.com/nicoschuele/railsbricks
+- Twitter: @nicoschuele
+
+---
+
+<iframe src="https://player.vimeo.com/video/110340717" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+<p><a href="https://vimeo.com/110340717">RailsBricks 3</a> from <a href="https://vimeo.com/nicoschuele">nicoschuele</a> on <a href="https://vimeo.com">Vimeo</a>.</p>
+
+## Not Maintained Anymore!
+
+**Please note that RailsBricks is currently not maintained. I leave it here for legacy purpose. If you want to take over, [contact me](https://twitter.com/nicoschuele).**
+
+
+## Features
+
+* replaces the `rails new` command with `rbricks -n`
+* includes useful gems and sets them up for you
+* offers different UI choices for your web app
+* creates and configures a Devise authentication scheme
+* adds the necessary resources for a blog, contact form, and more
+* builds an admin zone
+* configures your mailers
+* inits local and remote git repositories
+* ...and much more to boost your productivity!
+
+## Prerequisites
+
+In order to use RailsBricks, you need the following:
+
+* A nix-based OS. That can be any flavour of Linux or OS X
+* Ruby (version 2.0+)
+* Some knowledge of Rails (!)
+
+## What about Windows?
+
+**RailsBricks doesn't run out of the box on Windows**. You will first need to install the [DevKit](http://rubyinstaller.org/downloads/) as well as the [tzinfo-data](https://github.com/tzinfo/tzinfo-data) gem.
+
+## Ruby support
+
+RailsBricks generates Rails apps with support for the current major Ruby release (currently, 2.0.0) + the current point release and the previous one, for example 2.2.2 & 2.2.3. If you need to use another version of Ruby, you will have to manually edit the Gemfile after the app gets created and update the following line with your chosen version number:
+
+`ruby '2.1.5'`
+
+## Install
+
+Like any other gem, you simply issue `gem install railsbricks`
+
+**Notice:** If you still have RailsBricks 1.x installed, remove it manually *before* installing RailsBricks 3.x
+
+## Usage
+
+To create a new app, just type `rbricks --new` and follow the wizard.
+
+## Contribute
+
+RailsBricks is currently not maintained and not accepting pull requests anymore. If you want to take over, [contact me](https://twitter.com/nicoschuele).
+
+
+## Acknowledgements
+
+* [Nikkau](https://github.com/Nikkau), for showing me how to segregate gems without using RVM
+* [Joelle Gobbo](http://ch.linkedin.com/pub/joelle-gobbo/32/4b5/a9b), for the elegant snippet used to generate a valid Rails app name
+* [Jim Meyer](https://github.com/purp), for forking RailsBricks and creating an alternative version I also use
+* [David Hsu](https://github.com/dvdhsu), for adding a new Brick: Devise authentication using only an email address
+* the authors of the many gems used by RailsBricks
+* the [Geneva.rb](http://www.meetup.com/genevarb/) Meetup Group for the beer!
+* David Camarena for producing a [fork](https://github.com/athalas/railsbricks) with support for MySQL
+* [Felix Wolfsteller](https://github.com/fwolfst) for doing a bit of cleanup
+* everyone who emailed me, gave feedback, opened an issue on Github, submitted a pull request, tweeted, etc. I truly love the Rails community.
+
+## License
+
+Released under GNU GPL-3. Copyright (c) 2014-2017 Nico Schuele. See LICENSE.txt for further details.

data/bin/rbricks

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/railsbricks"
+
+Railsbricks::main ARGV

data/lib/railsbricks.rb

@@ -0,0 +1,112 @@
+require_relative "railsbricks/version"
+require_relative "railsbricks/string_helpers"
+require_relative "railsbricks/errors"
+require_relative "railsbricks/menu"
+require_relative "railsbricks/app_generator"
+require_relative "railsbricks/config_helpers"
+
+class Railsbricks
+
+  def self.main(args)
+    # new app
+    if args[0] == '-n' || args[0] == '--new'
+      new_app
+    elsif args[0] == '-r' || args[0] == '--recreate-db'
+      recreate_db
+    elsif args[0] == '-a' || args[0] == '--annotate'
+      annotate
+    elsif args[0] == '--robocop'
+      prime_directives
+    elsif args[0] == '-v' || args[0] == '--version'
+      display_version
+    elsif args[0] == '--config'
+      display_config
+    else
+      display_help
+    end
+  end
+
+  def self.new_app
+    menu = Menu.new
+    @options = menu.new_app_menu
+    generator = AppGenerator.new(@options)
+    generator.generate_app
+  end
+
+  def self.recreate_db
+    options = ConfigHelpers.load_config
+    puts
+    StringHelpers.wputs "----> Recreating the database ...", :info
+    system "#{options["rake_command"]} db:drop"
+    system "#{options["rake_command"]} db:create:all"
+    system "#{options["rake_command"]} db:migrate"
+    system "#{options["rake_command"]} db:seed"
+    puts
+    StringHelpers.wputs "----> Database recreated.", :info
+    puts
+  end
+
+  def self.annotate
+    puts
+    StringHelpers.wputs "----> Annotating models and routes ...", :info
+    puts
+    system "bundle exec annotate"
+    system "bundle exec annotate --routes"
+    puts
+    StringHelpers.wputs "----> Models and routes annotated.", :info
+    puts
+  end
+
+  def self.prime_directives
+    Errors.display_error "1. Serve the public trust"
+    Errors.display_error "2. Protect the innocent"
+    Errors.display_error "3. Uphold the law"
+    Errors.display_error "4. Classified"
+  end
+
+  def self.display_version
+    puts
+    StringHelpers.wputs "RailsBricks #{Version.current} (#{Version.current_date})", :info
+    StringHelpers.wputs "source: https://github.com/nicoschuele/railsbricks", :help
+    StringHelpers.wputs "by Nico Schuele (www.nicoschuele.com)", :help
+    puts
+  end
+
+  def self.display_config
+    puts
+    StringHelpers.wputs "----> Retrieving your app's RailsBricks config values ...", :info
+    options = ConfigHelpers.load_config
+    puts
+    if options.count > 1
+      options.each do |k,v|
+        StringHelpers.wputs "#{k}: #{v}"
+      end
+    else
+      Errors.display_error "Config values couldn't be found. In most cases, this is because '#{ConfigHelpers::CONFIG_PATH}/config' is not within your app.", true
+    end
+    puts
+    StringHelpers.wputs "----> App config values retrieved.", :info
+  rescue
+    Errors.display_error "Config values couldn't be found. In most cases, this is because '#{ConfigHelpers::CONFIG_PATH}/config' is not within your app.", true
+  end
+
+  def self.display_help
+    puts
+    StringHelpers.wputs "RailsBricks usage:", :info
+    StringHelpers.wputs "------------------", :info
+    puts
+    puts "rbricks --new (or -n) :"
+    puts "  --> create a new RailsBricks app."
+    puts
+    puts "rbricks --recreate-db (or -r) :"
+    puts "  --> drop, create, migrate & seed the DB"
+    puts
+    puts "rbricks --config"
+    puts "  --> display your app config"
+    puts
+    puts "rbricks --version (or -v) :"
+    puts "  --> display the RailsBricks version"
+    puts
+  end
+
+end

data/lib/railsbricks/app_generator.rb

@@ -0,0 +1,338 @@
+require "fileutils"
+require "net/http"
+require "uri"
+require_relative "ui_helpers"
+require_relative "version"
+require_relative "string_helpers"
+require_relative "file_helpers"
+require_relative "gemfile_builder"
+require_relative "style_builder"
+require_relative "auth_builder"
+require_relative "post_builder"
+require_relative "config_helpers"
+
+class AppGenerator
+
+  attr_accessor :options
+
+  def initialize(options)
+    @options = options
+    @app_dir = Dir.pwd + "/#{@options[:app_name]}"
+    @rbricks_dir = File.dirname(__FILE__)
+  end
+
+  def generate_app
+    # Drop creation if necessary
+    if !@options[:generate]
+      wputs "App creation aborted...", :error
+      new_line
+      abort
+    end
+
+    # updating necessary global gems
+    update_essential_gems
+
+    # install Rails
+    install_rails
+
+    # copy foundation app to directory
+    create_foundation
+
+    # ui
+    StyleBuilder.build_style(@app_dir, @options)
+
+    # database config
+    config_db
+
+    # environment variables
+    config_env_var
+
+    # authentication
+    if @options[:devise]
+      AuthBuilder.build_auth(@app_dir, @options)
+    end
+
+    # contact form
+    add_contact_form
+
+    # google analytics
+    set_google_analytics
+
+    # post resource
+    if @options[:devise] && @options[:post_resources]
+      PostBuilder.build_post(@app_dir, @options)
+    elsif @options[:devise] && !@options[:post_resources]
+      PostBuilder.clean(@app_dir)
+    end
+
+    # prod settings
+    if @options[:production]
+      set_production
+    end
+
+    # Set app name
+    set_app_name
+
+    # build Gemfile
+    GemfileBuilder.build_gemfile(@app_dir, @options)
+
+    # install gems
+    bundle_install
+
+    # create database
+    create_database
+
+    # save config
+    ConfigHelpers.create_config(@app_dir, @options)
+
+    # annotate models and routes
+    annotate
+
+    # git
+    set_git
+
+    # Summary
+    new_line(2)
+    wputs "----> #{@options[:rails_app_name]} created successfully!", :help
+    if @options[:devise]
+      new_line
+      wputs "Admin username: #{@options[:devise_config][:scheme] == 'email' ? 'admin@example.com' : 'admin' }", :info
+      wputs "Admin password: 1234", :info
+    end
+    new_line
+    wputs "Run 'rails server' within #{@options[:app_name]} to start it.", :help
+    new_line
+
+  end
+
+  # Private/shortcut/alias methods
+
+  private
+
+  def update_essential_gems
+    new_line
+    wputs "----> Bundler ... ", :info
+    system "#{@options[:gem_command]} install bundler --no-rdoc --no-ri"
+    system "#{@options[:gem_command]} update bundler"
+    new_line
+    wputs "----> Bundler updated to their latest versions.", :info
+  rescue
+    Errors.display_error("Required gem (bundler) couldn't be updated properly. Stopping app creation.", true)
+    abort
+  end
+
+  def install_rails
+    new_line(2)
+    wputs "----> Installing Rails #{@options[:rails_version]} ...", :info
+    system "#{@options[:gem_command]} install rails -v #{@options[:rails_version]} --no-rdoc --no-ri"
+    new_line
+    wputs "----> Rails #{@options[:rails_version]} installed.", :info
+  rescue
+    Errors.display_error("Something went wrong and Rails #{@options[:rails_version]} couldn't be installed. Stopping app creation.", true)
+    abort
+  end
+
+  def create_foundation
+    FileUtils::mkdir_p @app_dir
+    FileUtils.cp_r(@rbricks_dir + "/foundation/.", @app_dir)
+
+  end
+
+  def config_db
+    new_line(2)
+    wputs "----> Configuring database ...", :info
+
+    if @options[:development_db] == "postgresql"
+      FileUtils.cp_r(@rbricks_dir + "/assets/database/postgresql.yml", @app_dir + "/config/database.yml")
+      FileHelpers.replace_string(/BRICK_DB_SERVER/, @options[:db_config][:server], @app_dir + "/config/database.yml")
+      FileHelpers.replace_string(/BRICK_DB_PORT/, @options[:db_config][:port].to_s, @app_dir + "/config/database.yml")
+      FileHelpers.replace_string(/BRICK_DB_NAME/, @options[:db_config][:name], @app_dir + "/config/database.yml")
+      FileHelpers.replace_string(/BRICK_DB_USERNAME/, @options[:db_config][:username], @app_dir + "/config/database.yml")
+      if @options[:db_config][:password].to_s == ''
+        FileHelpers.replace_string(/BRICK_DB_PASSWORD/, '', @app_dir + "/config/database.yml")
+      else
+        FileHelpers.replace_string(/BRICK_DB_PASSWORD/, "password: #{@options[:db_config][:password]}", @app_dir + "/config/database.yml")
+      end
+    else
+      FileUtils.cp_r(@rbricks_dir + "/assets/database/sqlite3.yml", @app_dir + "/config/database.yml")
+    end
+
+    new_line
+    wputs "----> Database configuration set.", :info
+  end
+
+
+  def config_env_var
+    new_line(2)
+    wputs "----> Setting environment variables ...", :info
+    FileUtils.cp_r(@rbricks_dir + "/assets/config/application.yml", @app_dir + "/config")
+    FileHelpers.replace_string(/BRICK_VERSION/, @options[:railsbricks_version], @app_dir + "/config/application.yml")
+
+    if @options[:email_settings]
+      FileHelpers.replace_string(/BRICK_SENDER/, @options[:email_config][:sender], @app_dir + "/config/application.yml")
+      FileHelpers.replace_string(/BRICK_SMTP_SERVER/, @options[:email_config][:smtp], @app_dir + "/config/application.yml")
+      FileHelpers.replace_string(/BRICK_MAILER_DOMAIN/, @options[:email_config][:domain], @app_dir + "/config/application.yml")
+      FileHelpers.replace_string(/BRICK_SMTP_PORT/, @options[:email_config][:port], @app_dir + "/config/application.yml")
+      FileHelpers.replace_string(/BRICK_SMTP_USERNAME/, @options[:email_config][:username], @app_dir + "/config/application.yml")
+      FileHelpers.replace_string(/BRICK_SMTP_PASSWORD/, @options[:email_config][:password], @app_dir + "/config/application.yml")
+    end
+
+    if @options[:production]
+      FileHelpers.replace_string(/BRICK_DOMAIN/, @options[:production_settings][:url], @app_dir + "/config/application.yml")
+    end
+
+    new_line
+    wputs "----> Environment variables set.", :info
+  end
+
+  def add_contact_form
+    if @options[:contact_form]
+      new_line(2)
+      wputs "----> Creating contact form ...", :info
+
+      # Views
+      FileUtils.mkdir_p(@app_dir + "/app/views/contact_mailer")
+      FileUtils.cp_r(@rbricks_dir + "/assets/views/pages/contact.html.erb", @app_dir + "/app/views/pages")
+      FileUtils.cp_r(@rbricks_dir + "/assets/views/contact_mailer/contact_message.html.erb", @app_dir + "/app/views/contact_mailer")
+
+      # Mailer
+      FileUtils.cp_r(@rbricks_dir + "/assets/mailers/contact_mailer.rb", @app_dir + "/app/mailers")
+
+      # Navbar link
+      FileHelpers.replace_string(/BRICK_CONTACT/, "<li><%= link_to \"Contact\", contact_path %></li>", @app_dir + "/app/views/layouts/_navigation_links.html.erb")
+
+      # Controller
+      FileHelpers.replace_string(/BRICK_CONTACT_CONTROLLER/, FileHelpers.get_file(:brick_contact_controller), @app_dir + "/app/controllers/pages_controller.rb")
+
+      # Routes
+      FileHelpers.replace_string(/BRICK_CONTACT_ROUTES/, FileHelpers.get_file(:brick_contact_routes), @app_dir + "/config/routes.rb")
+
+      new_line
+      wputs "----> Contact form created.", :info
+    else
+      # Navbar link
+      FileHelpers.replace_string(/BRICK_CONTACT/, '', @app_dir + "/app/views/layouts/_navigation_links.html.erb")
+      # Controller
+      FileHelpers.replace_string(/BRICK_CONTACT_CONTROLLER/, '', @app_dir + "/app/controllers/pages_controller.rb")
+      # Routes
+      FileHelpers.replace_string(/BRICK_CONTACT_ROUTES/, '', @app_dir + "/config/routes.rb")
+    end
+  end
+
+
+  def set_google_analytics
+    if @options[:google_analytics]
+      new_line(2)
+      wputs "----> Setting up Google Analytics ...", :info
+
+      FileUtils.cp_r(@rbricks_dir + "/assets/javascripts/analytics.js.coffee", @app_dir + "/app/assets/javascripts")
+      FileHelpers.replace_string(/BRICK_ANALYTICS/, FileHelpers.get_file(:brick_analytics), @app_dir + "/app/views/layouts/_footer.html.erb")
+      FileHelpers.replace_string(/BRICK_ANALYTICS_ID/, @options[:google_tracking_id], @app_dir + "/app/views/layouts/_footer.html.erb")
+      FileHelpers.replace_string(/BRICK_ANALYTICS_SCRIPT/, "\n//= require analytics", @app_dir + "/app/assets/javascripts/application.js")
+
+      new_line
+      wputs "----> Google Analytics set.", :info
+    else
+      FileHelpers.replace_string(/BRICK_ANALYTICS/, '', @app_dir + "/app/views/layouts/_footer.html.erb")
+      FileHelpers.replace_string(/BRICK_ANALYTICS_SCRIPT/, '', @app_dir + "/app/assets/javascripts/application.js")
+    end
+  end
+
+  def set_production
+    new_line(2)
+    wputs "----> Production settings ...", :info
+
+    if @options[:production_settings][:unicorn]
+      FileUtils.cp_r(@rbricks_dir + "/assets/procfile/Procfile", @app_dir)
+      FileUtils.cp_r(@rbricks_dir + "/assets/config/unicorn.rb", @app_dir + "/config")
+      wputs "--> Unicorn config created."
+    end
+
+    new_line
+    wputs "----> Production settings updated.", :info
+  end
+
+  def set_app_name
+    new_line(2)
+    wputs "----> Setting app name ...", :info
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/routes.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/Rakefile")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/app/helpers/application_helper.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/app/views/layouts/application.html.erb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/application.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/environment.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/environments/development.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/environments/test.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/environments/production.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/initializers/secret_token.rb")
+    FileHelpers.replace_string(/BRICK_APP_NAME/, @options[:rails_app_name], @app_dir + "/config/initializers/session_store.rb")
+    FileHelpers.replace_string(/BRICK_SESSION/, @options[:rails_app_name].downcase, @app_dir + "/config/initializers/session_store.rb")
+    new_line
+    wputs "----> App name set.", :info
+  end
+
+  def bundle_install
+    new_line(2)
+    wputs "----> Installing gems into 'vendor/bundle/' ...", :info
+    Dir.chdir "#{@app_dir}" do
+      system "bundle install --without production --path vendor/bundle"
+    end
+    new_line
+    wputs "----> Gems installed in 'vendor/bundle/'.", :info
+  end
+
+  def annotate
+    new_line(2)
+    wputs "----> Annotating models and routes ...", :info
+    Dir.chdir "#{@app_dir}" do
+      system "bundle exec annotate"
+      system "bundle exec annotate --routes"
+    end
+    new_line
+    wputs "----> Models and routes annotated.", :info
+  end
+
+  def create_database
+    new_line(2)
+    wputs "----> Creating database ...", :info
+    Dir.chdir "#{@app_dir}" do
+      system "#{@options[:rake_command]} db:create:all"
+      system "#{@options[:rake_command]} db:migrate"
+      system "#{@options[:rake_command]} db:seed"
+    end
+    new_line
+    wputs "----> Database created.", :info
+  end
+
+  def set_git
+    # Always copy .gitignore
+    FileUtils.cp_r(@rbricks_dir + "/assets/git/gitignore", @app_dir + "/.gitignore")
+
+    if @options[:local_git]
+      new_line(2)
+      wputs "----> Setting up Git ...", :info
+      Dir.chdir "#{@app_dir}" do
+        system "git init"
+        system "git add -A ."
+        system "git commit -m 'initial commit (RailsBricks #{@options[:railsbricks_version]})'"
+
+        if @options[:remote_git]
+          system "git remote add origin #{@options[:git_url]}"
+          system "git push origin master"
+        end
+      end
+
+      new_line
+      wputs "----> Git set up.", :info
+    end
+  end
+
+  def wputs(text, highlight = :none)
+    StringHelpers.wputs(text, highlight)
+  end
+
+  def new_line(lines=1)
+    StringHelpers.new_line(lines)
+  end
+
+end