generapp 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60726e7855b19ef6434a1969d596d50a802a0714
+  data.tar.gz: 771789cc7e3b3c426a5ddf618532320f7a337df5
+SHA512:
+  metadata.gz: 8d1c68876bffe4e79761ee9f3d695723f453b3cc86f5f72600adbf3b6aa6804c1464d1b34185dbf87a375a996247737aa0b629c1853e469d4ec0640ebae9a092
+  data.tar.gz: 3b7a107d9920b1780a2e8ba6a1a8aad0193331be9c1ec2448dfaeb44f595589e53f30b94f8c578638631b3be220c045c7f86b554b50abb843964fe897452e7a6

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/fake_app/log/
+spec/tmp/
+gemfiles/*.lock
+
+# Idea
+.idea
+.idea/**/*
+
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - ruby-head
+
+sudo: false
+script: 'bundle exec rake'
+cache: bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+--markup markdown
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+MIT-LICENSE

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### master
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in generapp.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Koombea
+
+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,76 @@
+# Generapp
+[![Build Status](https://travis-ci.org/koombea/generapp.svg)](https://travis-ci.org/koombea/generapp)
+[![Coverage Status](https://coveralls.io/repos/koombea/generapp/badge.svg?branch=master&service=github)](https://coveralls.io/github/koombea/generapp?branch=master)
+
+A Rails app template to jump start your project with some of Koombea's best practices and recommendations. 
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install generapp
+
+## Usage
+
+Just run:
+
+    generapp my_project
+
+This will create a Rails app in `my_project` using the latest version of Ruby and Rails.
+
+## Gemfile
+
+To see the latest gems, look at Generapp's
+[Gemfile](templates/Gemfile.erb), which will be used as the project's Gemfile.
+
+Application gems included:
+* [Devise](https://github.com/plataformatec/devise) for user authentication
+* [Dalli](https://github.com/petergoldstein/dalli) for memcached client
+* [Honeybadger](https://github.com/honeybadger-io/honeybadger-ruby) for reporting 
+  errors to honeybadger.io
+* [jQuery Rails](https://github.com/rails/jquery-rails) for jQuery
+* [New Relic RPM](https://github.com/newrelic/rpm) for monitoring performance
+* [Postgres](https://github.com/ged/ruby-pg) for access to the Postgres database
+* [Rack Timeout](https://github.com/heroku/rack-timeout) to abort requests that are
+  taking too long
+* [Puma](https://github.com/puma/puma) to serve HTTP requests
+
+Development gems:
+* [Annotate](https://github.com/ctran/annotate_models) for annotating Rails classes 
+  with schema and routes info
+* [Better errors](https://github.com/charliesome/better_errors) for better error page 
+  for Rack apps
+* [Bullet](https://github.com/flyerhzm/bullet) for help killing N+1 queries and
+  unused eager loading
+* [Bundler Audit](https://github.com/rubysec/bundler-audit) for scanning the
+  Gemfile for insecure dependencies based on published CVEs
+* [Figaro](https://github.com/laserlemon/figaro) for Heroku-friendly Rails app
+  configuration using `ENV`
+* [lol_dba](https://github.com/plentz/lol_dba) for scanning missing indexes
+* [Pry Rails](https://github.com/rweng/pry-rails) for interactively exploring
+  objects
+* [Quiet Assets](https://github.com/evrone/quiet_assets) for muting assets
+  pipeline log messages
+* [rails-erd](https://github.com/voormedia/rails-erd) for generating Entity-Relationship Diagrams
+* [Spring](https://github.com/rails/spring) for fast Rails actions via
+  pre-loading
+
+Testing gems:
+
+* [Factory Girl](https://github.com/thoughtbot/factory_girl) for test data
+* [RSpec](https://github.com/rspec/rspec) for unit testing
+* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) for common
+  RSpec matchers
+* [Timecop](https://github.com/ferndopolis/timecop-console) for testing time
+
+## Contributing
+
+1. Fork it ( https://github.com/koombea/generapp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+MIT License. Copyright 2016 Koombea. https://koombea.com/

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+desc 'Run the test suite'
+task default: :rspec
+
+desc 'generate rdoc'
+task :rdoc do
+  sh 'yardoc'
+end

data/bin/generapp

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'generapp'
+
+if %w(-v --version).include? ARGV[0]
+  puts Generapp::VERSION
+  exit 0
+end
+
+templates_root = Generapp.templates
+Generapp::Generators::AppGenerator.source_root templates_root
+Generapp::Generators::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Generapp::Generators::AppGenerator.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/generapp.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generapp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generapp'
+  spec.version       = Generapp::VERSION
+  spec.authors       = ['Gustavo Bazan']
+  spec.email         = ['gustavo.bazan@koombea.com']
+
+  spec.summary       = 'Koombea Rails app generator'
+  spec.description   = <<-HERE
+Generapp is a Rails app generator with some of Koombea's defaults and practices.
+Feel free to use it to jump start your project and don't waste any time configuring basic things.
+  HERE
+
+  spec.homepage      = 'https://github.com/koombea/generapp'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.executables   = ['generapp']
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = ">= #{Generapp::RUBY_VERSION}"
+
+  spec.add_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'rails', Generapp::RAILS_VERSION
+  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'coveralls', '~>0.8.0', '>= 0.8.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7', '>= 0.8.0'
+end

data/lib/generapp/actions/configuration.rb

@@ -0,0 +1,34 @@
+module Generapp
+  module Actions
+    module Configuration
+      def setup_default_rake_task
+        append_file 'Rakefile' do
+          <<-EOS
+task(:default).clear
+task default: [:spec]
+
+if defined? RSpec
+  task(:spec).clear
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+end
+          EOS
+        end
+      end
+
+      def configure_puma
+        copy_file 'config/puma.rb', 'config/puma.rb'
+      end
+
+      def set_up_foreman
+        copy_file 'Procfile', 'Procfile'
+        copy_file 'Procfile.dev', 'Procfile.dev'
+      end
+
+      def generate_devise
+        generate 'devise:install'
+      end
+    end
+  end
+end

data/lib/generapp/actions/database.rb

@@ -0,0 +1,15 @@
+module Generapp
+  module Actions
+    module Database
+      def use_postgres_config_template
+        template 'config/postgresql_database.yml.erb',
+                 'config/database.yml',
+                 force: true
+      end
+
+      def create_database
+        bundle_command 'exec rake db:create db:migrate'
+      end
+    end
+  end
+end

data/lib/generapp/actions/develop.rb

@@ -0,0 +1,72 @@
+require 'generapp/actions/files'
+
+module Generapp
+  module Actions
+    module Develop
+      include Files
+
+      def raise_on_delivery_errors
+        replace_in_file 'config/environments/development.rb',
+                        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+      end
+
+      def add_bullet_gem_configuration
+        config = <<-RUBY
+  config.after_initialize do
+    Bullet.enable = true
+    Bullet.bullet_logger = true
+    Bullet.rails_logger = true
+  end
+        RUBY
+
+        inject_into_file(
+            'config/environments/development.rb',
+            config,
+            after: "config.action_mailer.raise_delivery_errors = true\n")
+      end
+
+      def configure_dalli
+        config = <<-RUBY
+
+  config.cache_store = :dalli_store, '127.0.0.1'
+
+        RUBY
+
+        inject_into_file(
+            'config/environments/development.rb',
+            config,
+            after: "config.action_mailer.raise_delivery_errors = true\n")
+      end
+
+      def configure_generators
+        config = <<-RUBY
+
+    config.generators do |g|
+      g.assets false
+      g.test_framework :rspec,
+        fixtures: true,
+        view_specs: false,
+        helper_specs: false,
+        routing_specs: false,
+        controller_specs: true,
+        request_specs: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+
+        RUBY
+
+        inject_into_class 'config/application.rb', 'Application', config
+      end
+
+      def generate_annotate
+        copy_file 'tasks/auto_annotate_models.rake',
+                  'lib/tasks/auto_annotate_models.rake'
+      end
+
+      def add_secrets
+        copy_file 'config/application.yml', 'config/application.yml.example'
+        copy_file 'config/application.yml', 'config/application.yml'
+      end
+    end
+  end
+end

data/lib/generapp/actions/files.rb

@@ -0,0 +1,14 @@
+module Generapp
+  module Actions
+    module Files
+      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
+    end
+  end
+end

data/lib/generapp/actions/production.rb

@@ -0,0 +1,17 @@
+module Generapp
+  module Actions
+    module Production
+      def configure_newrelic
+        template 'config/newrelic.yml.erb', 'config/newrelic.yml'
+      end
+
+      def configure_rack_timeout
+        rack_timeout_config = <<-RUBY
+Rack::Timeout.timeout = Integer(ENV['RACK_TIMEOUT'] || 10)
+        RUBY
+
+        append_file 'config/environments/production.rb', rack_timeout_config
+      end
+    end
+  end
+end

data/lib/generapp/actions/test.rb

@@ -0,0 +1,44 @@
+module Generapp
+  module Actions
+    module Test
+      def generate_rspec
+        generate 'rspec:install'
+      end
+
+      def configure_rspec
+        remove_file 'spec/rails_helper.rb'
+        copy_file 'spec/rails_helper.rb',
+                  'spec/rails_helper.rb'
+      end
+
+      def enable_database_cleaner
+        copy_file 'spec/database_cleaner.rb',
+                  'spec/support/database_cleaner.rb'
+      end
+
+      def enable_devise_tests
+        copy_file 'spec/devise.rb',
+                  'spec/support/devise.rb'
+      end
+
+      def provide_shoulda_matchers_config
+        copy_file 'spec/shoulda_matchers_config.rb',
+                  'spec/support/shoulda_matchers.rb'
+      end
+
+      def spec_folders
+        %w(spec/lib spec/controllers spec/helpers spec/support/matchers spec/support/mixins spec/support/shared_examples).each do |dir|
+          empty_directory_with_keep_file "#{dir}"
+        end
+      end
+
+      def configure_coverage
+        copy_file 'simplecov', '.simplecov'
+      end
+
+      def configure_ci
+        copy_file 'circle.yml', 'circle.yml'
+      end
+    end
+  end
+end

data/lib/generapp/actions/views.rb

@@ -0,0 +1,30 @@
+module Generapp
+  module Actions
+    module Views
+      def create_shared_directory
+        empty_directory_with_keep_file 'app/views/shared'
+      end
+
+      def create_shared_flashes
+        copy_file 'views/_flashes.html.erb',
+                  'app/views/shared/_flashes.html.erb'
+      end
+
+      def create_shared_javascripts
+        copy_file 'views/_javascript.html.erb',
+                  'app/views/shared/_javascript.html.erb'
+      end
+
+      def create_shared_head
+        template 'views/_head.html.erb.erb',
+                 'app/views/shared/_head.html.erb'
+      end
+
+      def create_application_layout
+        template 'views/generapp_layout.html.erb.erb',
+                 'app/views/layouts/application.html.erb',
+                 force: true
+      end
+    end
+  end
+end

data/lib/generapp/app_builder.rb

@@ -0,0 +1,54 @@
+require 'rails/generators/rails/app/app_generator'
+require 'generapp/actions/develop'
+require 'generapp/actions/test'
+require 'generapp/actions/production'
+require 'generapp/actions/views'
+require 'generapp/actions/configuration'
+require 'generapp/actions/database'
+
+module Generapp
+  class AppBuilder < ::Rails::AppBuilder
+    include Generapp::Actions::Develop
+    include Generapp::Actions::Test
+    include Generapp::Actions::Production
+    include Generapp::Actions::Views
+    include Generapp::Actions::Configuration
+    include Generapp::Actions::Database
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def gitignore
+      template 'generapp_gitignore', '.gitignore'
+    end
+
+    def gemfile
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def set_ruby_version
+      create_file '.ruby-version', "#{Generapp::RUBY_VERSION}\n"
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      copy_file 'application.scss',
+                'app/assets/stylesheets/application.scss'
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+    def setup_bundler_audit
+      copy_file 'tasks/bundler_audit.rake',
+                'lib/tasks/bundler_audit.rake'
+      append_file 'Rakefile', %{\ntask default: "bundler:audit"\n}
+    end
+
+    def setup_spring
+      bundle_command 'exec spring binstub --all'
+    end
+  end
+end