rough_draft 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e09997bba0ca980cb909fd7dd485b4e795541bf2
+  data.tar.gz: d4ff2645264ca60db7a9912afbd27184b8611bff
+SHA512:
+  metadata.gz: 927607fa82f8eabb18743c62b3261075b3ce1750ac77fed9ecd5a0c76e833602d54d2f8e7ec70083eedc825a4778d645d86c3807ddcfb5fbee7a215b117b5316
+  data.tar.gz: ae4942594576a02fa1036a86c45840ee153bf6afcdd3f5256040543d9ab8981d5f9b23d5bbdf4b049fda6e4b80c33cde0b1599cf4326975a0e9bbbc136d63de3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Felchner
+
+MIT License
+
+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,21 @@
+# RoughDraft
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rough_draft'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rough_draft
+
+## Usage
+
+    $ rough_draft

data/bin/rough_draft

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

data/lib/rough_draft/actions.rb

@@ -0,0 +1,13 @@
+module  RoughDraft
+module  Actions
+  def copy_source_file(source)
+    copy_file source, source, force: true
+  end
+
+  def git_commit(message, options = {})
+    git :add    => '-A'
+    git :reset  => '-- config/settings/*' unless options[:include_settings]
+    git :commit => "-m '#{message}' --quiet --no-status"
+  end
+end
+end

data/lib/rough_draft/app_builder.rb

@@ -0,0 +1,437 @@
+require 'rails/generators/rails/app/app_generator'
+require 'rough_draft/actions'
+
+module  RoughDraft
+class   AppBuilder < Rails::AppBuilder
+  include RoughDraft::Actions
+
+  def readme
+    template 'README.md.erb', 'README.md'
+  end
+
+  def gemfile
+    template 'Gemfile.erb', 'Gemfile'
+  end
+
+  def gitignore
+    copy_file 'kompanee-gitignore', '.gitignore'
+  end
+
+  def app
+    super
+
+    remove_file                    'app/controllers/concerns'
+    remove_file                    'app/models/concerns'
+
+    empty_directory_with_keep_file 'app/assets/fonts'
+
+    empty_directory_with_keep_file 'app/assets/images/backgrounds'
+    empty_directory_with_keep_file 'app/assets/images/decorations'
+    empty_directory_with_keep_file 'app/assets/images/emails'
+    empty_directory_with_keep_file 'app/assets/images/icons'
+    empty_directory_with_keep_file 'app/assets/images/logos'
+    empty_directory_with_keep_file 'app/assets/images/placeholders'
+    empty_directory_with_keep_file 'app/assets/images/text'
+    empty_directory_with_keep_file 'app/assets/images/ui'
+  end
+
+  def public_directory
+    super
+
+    remove_file 'public/favicon.ico'
+  end
+
+  def config
+    super
+
+    remove_commented_route_lines
+
+    staging_environment
+  end
+
+  def database_yml
+    if options[:database] == 'postgresql'
+      template 'config/database-example.yml.erb', 'config/database.yml'
+    else
+      super
+    end
+
+    copy_file "#{destination_root}/config/database.yml", 'config/database-example.yml'
+  end
+
+  def db
+    super
+
+    bundle_command 'exec rake db:drop:all db:create:all db:migrate db:test:prepare'
+  end
+
+  def git_repo
+    git               :init     => '--quiet'
+    git_commit        'Initial App Generation'
+    git               :branch   => 'rough-draft --quiet'
+    git               :checkout => 'rough-draft --quiet'
+  end
+
+  def git_finalize
+    git_commit        'Completed Template Initialization'
+    git               :checkout => 'master --quiet'
+    git               :merge    => '--no-ff rough-draft --quiet --no-edit'
+    git               :branch   => '-D rough-draft --quiet'
+  end
+
+  def ruby_version
+    template          'ruby-version.erb', '.ruby-version'
+
+    git_commit        'Add .ruby-version'
+  end
+
+  def environment_banners
+    empty_directory   'app/assets/images/decorations/environment-banners'
+    copy_source_file  'app/assets/images/decorations/environment-banners/development-banner.png'
+    copy_source_file  'app/assets/images/decorations/environment-banners/test-banner.png'
+    copy_source_file  'app/assets/images/decorations/environment-banners/staging-banner.png'
+
+    git_commit        'Add Environment Banners'
+  end
+
+  def raise_on_delivery_errors
+    gsub_file         'config/environments/development.rb',
+                      'raise_delivery_errors = false',
+                      'raise_delivery_errors = true'
+
+    git_commit        'Raise Delivery Errors in Development'
+  end
+
+  def raise_on_unpermitted_parameters
+    action_on_unpermitted_parameters = <<-RUBY
+
+
+  # Raise an ActionController::UnpermittedParameters exception when
+  # a parameter is not explcitly permitted but is passed anyway.
+  config.action_controller.action_on_unpermitted_parameters = :raise
+    RUBY
+
+    inject_into_file(
+      'config/environments/development.rb',
+      action_on_unpermitted_parameters.chomp,
+      before: "\nend"
+    )
+
+    git_commit                      'Raise Errors in Development when unpermitted parameters are used'
+  end
+
+  def setup_script
+    copy_source_file                'bin/setup'
+    chmod                           'bin/setup', 0755
+
+    git_commit                      'Generate setup script'
+  end
+
+  def disable_generators
+    config = <<-RUBY
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+    RUBY
+
+    inject_into_class               'config/application.rb', 'Application', config
+
+    git_commit                      'Disable generators'
+  end
+
+  def rspec
+    generate                        'rspec:install'
+
+    empty_directory_with_keep_file  'spec/shared_examples'
+    empty_directory_with_keep_file  'spec/support'
+    empty_directory_with_keep_file  'spec/helpers'
+    empty_directory_with_keep_file  'spec/acceptance'
+
+    copy_source_file                'spec/spec_helper.rb'
+
+    git_commit                      'Setup RSpec'
+  end
+
+  def factories
+    copy_source_file                'spec/factories/user.rb'
+    copy_source_file                'spec/factories/all_factories_are_valid_spec.rb'
+
+    git_commit                      'Setup Factories'
+  end
+
+  def travis
+    template                        'travis.yml.erb', '.travis.yml'
+
+    git_commit                      'Setup Travis CI'
+  end
+
+  def rack_deflator
+    config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+
+    RUBY
+
+    inject_into_file  'config/environments/production.rb',
+                      config.chomp,
+                      after: "config.serve_static_assets = false\n"
+
+    staging_environment
+
+    git_commit                      'Setup Rack Deflator'
+  end
+
+  def stylesheets
+    remove_file                     'app/assets/stylesheets/application.css'
+
+    get                             'http://necolas.github.io/normalize.css/latest/normalize.css', 'app/assets/stylesheets/normalize.scss'
+    copy_file                       'app/assets/stylesheets/application.css.scss'
+
+    git_commit                      'Setup Base Stylesheets'
+  end
+
+  def disable_turbolinks
+    gsub_file                       'app/assets/javascripts/application.js',
+                                    %r{//= require turbolinks\n},
+                                    ''
+
+    git_commit                      'Disable Turbolinks'
+  end
+
+  def human_text
+    template                        'public/humans.txt.erb', 'public/humans.txt'
+
+    git_commit                      'Add human.txt'
+  end
+
+  def helpers
+    remove_file                     'app/helpers/application_helper.rb'
+
+    git_commit                      'Remove uneeded helper'
+  end
+
+  def views
+    replace_application_layout
+    install_shared_partials
+    install_maintenance_page
+  end
+
+  def devise
+    route                           "root :to => 'devise/sessions#new'"
+    comment_lines                   'config/routes.rb', /root/
+
+    git_commit                      'Add Default (Commented) Devise Route'
+  end
+
+  def simple_form
+    generate                        'simple_form:install'
+    remove_dir                      'lib/templates'
+
+    git_commit                      'Configure SimpleForm'
+  end
+
+  def chamber
+    uncomment_lines                 'Gemfile', /chamber/
+    bundle_command                  'update'
+    run                             "cd #{destination_root} && chamber init"
+
+    git_commit                      'Configure Chamber'
+
+    remove_file                     'config/secrets.yml'
+    create_file                     'config/settings.yml', '', force: true
+    empty_directory                 'config/settings'
+    template                        'config/settings/http.yml.erb', 'config/settings/http.yml'
+
+    git_commit                      'Setup default settings files'
+  end
+
+  def i18n
+    template                        'config/initializers/i18n.rb.erb', 'config/initializers/i18n.rb'
+
+    git_commit                      'Configure i18n'
+  end
+
+  def xml_parsing
+    copy_source_file                'config/initializers/xml.rb'
+
+    git_commit                      'Disable XML Parsing'
+  end
+
+  def dirty_url
+    uncomment_lines                 'Gemfile', /dirty_url/
+    bundle_command                  'update'
+
+    git_commit                      'Install dirty_url for default_url_options'
+  end
+
+  def rack_timeout
+    copy_source_file                'config/initializers/rack_timeout.rb'
+
+    git_commit                      'Configure Rack Timeout'
+  end
+
+  def unicorn
+    copy_source_file                'config/unicorn.rb'
+
+    git_commit                      'Configure Unicorn'
+  end
+
+  def foreman
+    copy_source_file                'Procfile'
+
+    git_commit                      'Configure Foreman'
+  end
+
+  def mail_safe
+    copy_source_file                'config/initializers/mail_safe.rb'
+
+    git_commit                      'Configure Mail Safe'
+  end
+
+  def skylight
+    bundle_command                  'exec skylight setup'
+    template                        'config/initializers/skylight.rb.erb', 'config/initializers/skylight.rb'
+
+    require 'yaml'
+    skylight_config               = YAML.load(File.read("#{destination_root}/config/skylight.yml"))
+    remove_file                     'config/skylight.yml'
+    create_file                     'config/settings/skylight.yml' do
+      <<-SKYLIGHT
+skylight:
+  _secure_application:    "#{skylight_config['application']}"
+  _secure_authentication: "#{skylight_config['authentication']}"
+      SKYLIGHT
+    end
+
+    git_commit                      'Configure Skylight'
+  end
+
+  def code_climate
+    template                        'config/settings/code_climate.yml.erb', 'config/settings/code_climate.yml'
+
+    git_commit                      'Configure CodeClimate'
+  end
+
+  def bugsnag
+    copy_source_file                'config/initializers/bugsnag.rb'
+    template                        'config/settings/bugsnag.yml.erb', 'config/settings/bugsnag.yml'
+
+    git_commit                      'Configure BugSnag'
+  end
+
+  def database_seeding
+    remove_file                     'db/seeds.rb'
+
+    copy_source_file                'lib/tasks/db-seed.rake'
+    copy_source_file                'db/seed.rb'
+    copy_source_file                'db/samplize.rb'
+
+    git_commit                      'Setup Database Seeding and Sampling Tasks'
+  end
+
+  def database_backup
+    copy_source_file                'lib/tasks/db-backup.rake'
+
+    git_commit                      'Setup Database Backup Tasks'
+  end
+
+  def smtp
+    copy_source_file                'config/initializers/action_mailer.rb'
+    template                        'config/settings/smtp.yml.erb', 'config/settings/smtp.yml'
+
+    git_commit                      'Configure SMTP Options'
+  end
+
+  def locales
+    copy_file                       'config/locales/date-formats-en.yml', 'config/locales/en.yml', force: true
+
+    git_commit                      'Add default date/time formats'
+  end
+
+  def github_repo(repo_name)
+    run                             "hub create #{repo_name}"
+  end
+
+  def heroku_specific_gems
+    uncomment_lines                 'Gemfile', /rails_12factor/
+    bundle_command                  'update'
+
+    git_commit                      'Add Heroku-specific gems'
+  end
+
+  def heroku_apps
+    valid_heroku_app_name=app_name.gsub(/_/, '-')
+
+    run "heroku create #{valid_heroku_app_name}-production --remote=production"
+    run "heroku create #{valid_heroku_app_name}-staging --remote=staging"
+    run "heroku config:add RACK_ENV=staging RAILS_ENV=staging --app=#{valid_heroku_app_name}-staging --remote=staging"
+  end
+
+  def heroku_remotes
+    valid_heroku_app_name=app_name.gsub(/_/, '-')
+
+    remotes = <<-RUBY
+
+# Set up staging and production git remotes
+git remote add staging git@heroku.com:#{valid_heroku_app_name}-staging.git
+git remote add production git@heroku.com:#{valid_heroku_app_name}-production.git
+    RUBY
+
+    append_file                     'bin/setup', remotes
+
+    git_commit                      'Add staging and production remotes to setup script'
+  end
+
+  def secret_token
+    gsub_file                       'config/initializers/secret_token.rb', /\s=\s.*/, ' = Chamber.env.application.secret_key'
+    template                        'config/settings/application.yml.erb', 'config/settings/application.yml'
+
+    git_commit                      'Secure the Secure Application Token'
+  end
+
+  def secure_configuration_settings
+    run                             "cd #{destination_root} && chamber secure"
+
+    git_commit                      'Add all configuration settings', :include_settings => true
+  end
+
+  private
+
+  def remove_commented_route_lines
+    gsub_file         'config/routes.rb', /\s+#.*/, ''
+    gsub_file         'config/routes.rb', /\n\n/, "\n"
+  end
+
+  def staging_environment
+    copy_file         File.expand_path('config/environments/production.rb'), 'config/environments/staging.rb', force: true
+  end
+
+  def replace_application_layout
+    template          'app/views/layouts/application.html.erb.erb', 'app/views/layouts/application.html.erb', force: true
+
+    git_commit        'Replace the default application layout'
+  end
+
+  def install_shared_partials
+    directory         'app/views/shared'
+    copy_source_file  'app/views/shared/_flashes.html.erb'
+    copy_source_file  'app/views/shared/_javascript.html.erb'
+
+    git_commit        'Add shared partials'
+  end
+
+  def install_maintenance_page
+    template          'public/maintenance.html.erb.erb', 'public/maintenance.html.erb'
+
+    git_commit        'Add basic maintenance page'
+  end
+end
+end

data/lib/rough_draft/app_generator.rb

@@ -0,0 +1,137 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'rough_draft/app_builder'
+
+module  RoughDraft
+class   AppGenerator < Rails::Generators::AppGenerator
+  class_option :database,       :type     => :string,
+                                :aliases  => '-d',
+                                :default  => 'postgresql',
+                                :desc     => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+  class_option :heroku,         :type     => :boolean,
+                                :aliases  => '-H',
+                                :default  => false,
+                                :desc     => 'Create staging and production Heroku apps'
+
+  class_option :skip_test_unit, :type     => :boolean,
+                                :aliases  => '-T',
+                                :default  => true,
+                                :desc     => 'Skip Test::Unit files'
+
+  class_option :skip_bundle,    :type     => :boolean,
+                                :aliases  => '-B',
+                                :default  => true,
+                                :desc     => "Don't run bundle install"
+
+  class_option :github,         :type     => :string,
+                                :aliases  => '-G',
+                                :default  => nil,
+                                :desc     => 'Create Github repository and add remote origin pointed to repo'
+
+  def finish_template
+    super
+
+    build :git_repo
+
+    bundle_command 'install'
+
+    # Development
+    build :ruby_version
+    build :environment_banners
+    build :raise_on_delivery_errors
+    build :raise_on_unpermitted_parameters
+    build :setup_script
+    build :disable_generators
+
+    # Test
+    build :rspec
+    build :factories
+    build :travis
+
+    # Production
+    build :rack_deflator
+
+    # Stylesheets
+    build :stylesheets
+
+    # Javascript
+    build :disable_turbolinks
+
+    # Views
+    build :human_text
+    build :helpers
+    build :views
+
+    # Gem Configuration
+    build :devise
+    build :simple_form
+    build :chamber
+    build :i18n
+    build :xml_parsing
+    build :dirty_url
+    build :rack_timeout
+    build :unicorn
+    build :foreman
+    build :mail_safe
+    build :skylight
+    build :code_climate
+    build :bugsnag
+
+    # Database
+    build :database_seeding
+    build :database_backup
+
+    # Mail
+    build :smtp
+
+    # Formats and Localization
+    build :locales
+
+    # Github
+    if !options[:skip_git] && options[:github]
+      build :github_repo, options[:github]
+    end
+
+    # Heroku
+    if options[:heroku]
+      build :heroku_specific_gems
+      build :heroku_apps
+      build :heroku_remotes
+    end
+
+    # Security
+    build :secret_token
+    build :secure_configuration_settings
+
+    bundle_command 'update'
+
+    build :git_finalize
+
+    say ''
+    say 'Congratulations'
+    say 'You just made a rough draft of your Rails app!!'
+    say ''
+  end
+
+  private
+
+  def slack_room
+    @@slack_room ||= ask "What is the Slack room you would like CI notifications posted to?"
+  end
+
+  def code_climate_repo_token
+    @@code_climate_repo_token ||= ask "What is the repo token for this app on Code Climate?"
+  end
+
+  def bugsnag_api_key
+    @@bugsnag_api_key ||= ask "What is the API key for this app on BugSnag?"
+  end
+
+  protected
+
+  def get_builder_class
+    RoughDraft::AppBuilder
+  end
+end
+end

data/lib/rough_draft/version.rb

@@ -0,0 +1,3 @@
+module RoughDraft
+  VERSION = "1.0.0"
+end

data/lib/rough_draft.rb

@@ -0,0 +1,2 @@
+require 'rough_draft/version'
+require 'rough_draft/app_generator'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rough_draft
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- jfelchner
+- m5rk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: ''
+email: support@chirrpy.com
+executables:
+- rough_draft
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- bin/rough_draft
+- lib/rough_draft.rb
+- lib/rough_draft/actions.rb
+- lib/rough_draft/app_builder.rb
+- lib/rough_draft/app_generator.rb
+- lib/rough_draft/version.rb
+homepage: https://github.com/thekompanee/blueprints/rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset = UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rough_draft
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails Generator a la The Kompanee
+test_files: []
+has_rdoc: