railsqs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7081ede2a0efa99e1833f0dd1e329ab285fb0199
+  data.tar.gz: d44e00090ea78895644250d25cfa90c9c23f374d
+SHA512:
+  metadata.gz: 675976cb7f541f64ff7aa1a869149567af0f27402a0352e4126b139c5887701e75a03579a911c7cfd50471be39c978e6d8600f0d9c593605d943fb9cb40ed52b
+  data.tar.gz: 7c38316111e4e93933ca848c8a377ec6a36f04ef8a2b85fc24486d79c4d2c65cf3ad32b2d6cd3541390c1e9f841f388a2324b087953d80d35f7bd3469aacf995

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+*.swp
+/.bundle
+/tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    railsqs (1.0.0)
+      bitters (~> 0.10.0)
+      bundler (~> 1.3)
+      rails (= 4.2.0.beta2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0.beta2)
+      actionpack (= 4.2.0.beta2)
+      actionview (= 4.2.0.beta2)
+      activejob (= 4.2.0.beta2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.3)
+    actionpack (4.2.0.beta2)
+      actionview (= 4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      rack (~> 1.6.0.beta)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.3)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.3)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      builder (~> 3.1)
+    activerecord (4.2.0.beta2)
+      activemodel (= 4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      arel (>= 6.0.0.beta1, < 6.1)
+    activesupport (4.2.0.beta2)
+      i18n (>= 0.7.0.beta1, < 0.8)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (6.0.0.beta1)
+    bitters (0.10.1)
+      bourbon (>= 3.2)
+      sass (>= 3.2)
+      thor
+    bourbon (4.0.2)
+      sass (~> 3.3)
+      thor
+    builder (3.2.2)
+    erubis (2.7.0)
+    globalid (0.3.0)
+      activesupport (>= 4.1.0)
+    hike (1.2.3)
+    i18n (0.7.0.beta1)
+    json (1.8.1)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.2)
+    mini_portile (0.6.0)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    rack (1.6.0.beta)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.2.0.beta2)
+      actionmailer (= 4.2.0.beta2)
+      actionpack (= 4.2.0.beta2)
+      actionview (= 4.2.0.beta2)
+      activejob (= 4.2.0.beta2)
+      activemodel (= 4.2.0.beta2)
+      activerecord (= 4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0.beta2)
+      sprockets-rails (~> 3.0.0.beta1)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.4)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0.beta2)
+      actionpack (= 4.2.0.beta2)
+      activesupport (= 4.2.0.beta2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    sass (3.4.5)
+    sprockets (2.12.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (3.0.0.beta1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  railsqs!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2012 Mike Burns and thoughtbot, inc.
+
+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,3 @@
+# Rails Quick Start (railsqs)
+
+Based on the excellent gem suspenders by thoughtbot.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+

data/bin/railsqs

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'railsqs'
+
+
+templates_root = File.expand_path(File.join("..", "templates"), File.dirname(__FILE__))
+Railsqs::AppGenerator.source_root templates_root
+Railsqs::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Railsqs::AppGenerator.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+# Run this script immediately after cloning the codebase.
+
+# Exit if any subcommand fails
+set -e
+
+# Set up Ruby dependencies via Bundler
+bundle install
+
+# Add binstubs to PATH in ~/.zshenv like this:
+#   export PATH=".git/safe/../../bin:$PATH"
+mkdir -p .git/safe

data/lib/railsqs/actions.rb

@@ -0,0 +1,25 @@
+module Railsqs
+  module Actions
+    def replace_in_file(relative_path, find, replace)
+      path = File.join(destination_root, relative_path)
+      contents = IO.read(path)
+      unless contents.gsub!(find, replace)
+        raise "#{find.inspect} not found in #{relative_path}"
+      end
+      File.open(path, "w") { |file| file.write(contents) }
+    end
+
+    def action_mailer_host(rails_env, host)
+      host_config = "config.action_mailer.default_url_options = { host: '#{host}' }"
+      configure_environment(rails_env, host_config)
+    end
+
+    def configure_environment(rails_env, config)
+      inject_into_file(
+        "config/environments/#{rails_env}.rb",
+        "\n\n  #{config}",
+        before: "\nend"
+      )
+    end
+  end
+end

data/lib/railsqs/app_builder.rb

@@ -0,0 +1,270 @@
+module Railsqs
+  class AppBuilder < Rails::AppBuilder
+    include Railsqs::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def raise_on_delivery_errors
+      replace_in_file 'config/environments/development.rb',
+        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+    end
+
+    def raise_on_unpermitted_parameters
+      config = <<-RUBY
+    config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+
+      inject_into_class "config/application.rb", "Application", config
+    end
+
+    def provide_setup_script
+      template 'bin_setup.erb', 'bin/setup', port_number: port_number, force: true
+      run 'chmod a+x bin/setup'
+    end
+
+    def provide_dev_prime_task
+      copy_file 'development_seeds.rb', 'lib/tasks/development_seeds.rake'
+    end
+
+    def configure_generators
+      config = <<-RUBY
+
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.stylesheets false
+    end
+
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        %{require Rails.root.join("config/smtp")\n}
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => 'config.action_mailer.raise_delivery_errors = false'
+    end
+
+    def enable_rack_deflater
+      config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => "config.serve_static_assets = false\n"
+    end
+
+
+    def setup_staging_environment
+      staging_file = 'config/environments/staging.rb'
+      copy_file 'staging.rb', staging_file
+
+      config = <<-RUBY
+
+Rails.application.configure do
+  # ...
+end
+      RUBY
+
+      append_file staging_file, config
+    end
+
+    def setup_secret_token
+      template 'secrets.yml', 'config/secrets.yml', force: true
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_nav
+      copy_file '_navigation.html.erb', 'app/views/application/_navigation.html.erb'
+    end
+
+    def create_shared_footer
+      copy_file '_footer.html.erb', 'app/views/application/_footer.html.erb'
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.html.erb', 'app/views/application/_flashes.html.erb'
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.html.erb', 'app/views/application/_javascript.html.erb'
+    end
+
+    def create_application_layout
+      template 'railsqs_layout.html.erb.erb',
+        'app/views/layouts/application.html.erb',
+        force: true
+    end
+
+    def remove_turbolinks
+      replace_in_file 'app/assets/javascripts/application.js',
+        /\/\/= require turbolinks\n/,
+        ''
+      inject_into_file 'app/assets/javascripts/application.js',
+        "//= require bootstrap-sprockets\n", after: "jquery_ujs\n"
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        force: true
+    end
+
+    def create_database
+      bundle_command 'exec rake db:create db:migrate'
+    end
+
+    def replace_gemfile
+      remove_file 'Gemfile'
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def enable_database_cleaner
+
+    end
+
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
+    def configure_minitest_spinach
+      # TODO
+      #remove_file "spec/rails_helper.rb"
+      #remove_file "spec/spec_helper.rb"
+      #copy_file "rails_helper.rb", "spec/rails_helper.rb"
+      #copy_file "spec_helper.rb", "spec/spec_helper.rb"
+    end
+
+
+    def configure_time_zone
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_time_formats
+      remove_file 'config/locales/en.yml'
+      copy_file 'config_locales_en.yml', 'config/locales/en.yml'
+    end
+
+    def configure_rack_timeout
+      copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', "localhost:#{port_number}"
+      action_mailer_host 'test', 'www.example.com'
+      action_mailer_host 'staging', "staging.#{app_name}.com"
+      action_mailer_host 'production', "#{app_name}.com"
+    end
+
+    def fix_i18n_deprecation_warning
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def generate_spinach
+
+    end
+
+    def setup_puma
+      copy_file 'puma.rb', 'config/puma.rb'
+    end
+    
+    def setup_foreman
+      copy_file 'sample.env', '.sample.env'      
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      copy_file 'application.css.scss',
+        'app/assets/stylesheets/application.css.scss'
+      copy_file 'bootstrap.scss', 'app/assets/stylesheets/bootstrap.css.scss'
+    end
+
+    def install_bitters
+      run "bitters install --path app/assets/stylesheets"
+    end
+
+    def gitignore_files
+      remove_file '.gitignore'
+      copy_file 'railsqs_gitignore', '.gitignore'
+    end
+
+
+    def setup_homepage
+      bundle_command 'exec rails g controller Homepages show'
+      replace_in_file 'config/routes.rb', "get 'homepages/show'", "root 'homepages#show'"
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+
+    def copy_miscellaneous_files
+      copy_file 'errors.rb', 'config/initializers/errors.rb'
+    end
+
+    def customize_error_pages
+      meta_tags =<<-EOS
+  <meta charset="utf-8" />
+  <meta name="ROBOTS" content="NOODP" />
+  <meta name="viewport" content="initial-scale=1" />
+      EOS
+
+      %w(500 404 422).each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, :after => "<head>\n"
+        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
+      end
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Rails\.application\.routes\.draw do.*end/m,
+        "Rails.application.routes.draw do\nend"
+    end
+
+    def setup_default_rake_task
+
+    end
+
+    def run_initial_setup
+      run 'bin/setup'
+    end
+
+    private
+
+    def generate_secret
+      SecureRandom.hex(64)
+    end
+
+    def port_number
+      @port_number ||= [3000, 4000, 5000, 7000, 8000, 9000].sample
+    end
+  end
+end

data/lib/railsqs/generators/app_generator.rb

@@ -0,0 +1,177 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Railsqs
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
+      :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :github, :type => :string, :aliases => '-G', :default => nil,
+      :desc => 'Create Github repository and add remote origin pointed to repo'
+
+    def finish_template
+      invoke :railsqs_customization
+      super
+    end
+
+    def railsqs_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_secret_token
+      invoke :create_railsqs_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :install_bitters
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_homepage
+      invoke :setup_git
+      invoke :setup_database
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :enable_database_cleaner
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_newrelic
+      build :configure_smtp
+      build :enable_rack_deflater
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_railsqs_views
+      say 'Creating railsqs views'
+      build :create_partials_directory
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_shared_nav
+      build :create_shared_footer
+      build :create_application_layout
+    end
+
+    def setup_coffeescript
+      say 'Setting up CoffeeScript defaults'
+      build :remove_turbolinks
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_time_zone
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :setup_puma
+      build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def install_bitters
+      say 'Install Bitters'
+      build :install_bitters
+    end
+
+    def setup_homepage
+      build :setup_homepage      
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def outro
+      build :run_initial_setup
+      say 'Congratulations! You just pulled our railsqs.'      
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    protected
+
+    def get_builder_class
+      Railsqs::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/railsqs/version.rb

@@ -0,0 +1,5 @@
+module Railsqs
+  RAILS_VERSION = "4.2.0.beta2"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "1.0.0"
+end