straptible 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3accf78857a747632066bc02d7afff4b2f7dc0a5
+  data.tar.gz: 1888116854daed1a9a73d68333058491ebfa3d3a
+SHA512:
+  metadata.gz: 45bc96efb44e90afdf239bc6edfaa0e1e6187e4898f0db1ffc52b9ad3d6e7e19f2f061a058008c89bee76ea24a97237fa316cee2f02c47da269a534f709bfc37
+  data.tar.gz: 6d2e2cb465444997e631636ebd6c5b7ebb55671c66f0384df36766a127dec6acbe4cf223f0552d8508411aa2f0d0afc116aabac2efa4d0de1286baba172c8086

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rubocop', github: 'bbatsov/rubocop'
+
+# Specify your gem's dependencies in straptible.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aptible, Inc.
+
+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,31 @@
+# ![](lib/straptible/rails/templates/icon-72.png) Straptible
+
+[![Gem Version](https://badge.fury.io/rb/straptible.png)](https://rubygems.org/gems/straptible)
+[![Build Status](https://secure.travis-ci.org/aptible/straptible.png?branch=master)](http://travis-ci.org/aptible/straptible)
+
+A tool for bootstrapping new applications, document repositories, etc. according to Aptible's hyperopinionated best practices.
+
+
+## Usage
+
+    gem install straptible
+
+Then, to create a new project, first choose your flavor:
+
+| Flavor Name | Description |
+| ---------:| ------- |
+| `webapp` (*coming soon*) | Rails web app |
+| `api` | Rails API — similar to `webapp`, but tailored and stripped down for a JSON API |
+| `gem` (*coming soon*) | Ruby gem |
+| `docs` (*coming soon*) | Document repository |
+
+Then, run:
+
+    straptible <flavor> <path> [options...]
+
+
+## Copyright and License
+
+MIT License, see [LICENSE](LICENSE.md) for details.
+
+Copyright (c) 2013 [Aptible](https://www.aptible.com), [Frank Macreery](https://github.com/fancyremarker), and contributors.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks
+
+task default: :ci

data/bin/straptible

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'active_support/inflector'
+
+def require_lib(name)
+  path = File.join('..', 'lib', *(name.split('::').map(&:underscore)))
+  require_relative path
+end
+
+def usage(dest = $stdout)
+  dest.puts 'Usage: straptible <flavor> <path> [options...]'
+end
+
+flavor = ARGV.shift
+case flavor
+when 'api'
+  require_lib 'Straptible::Rails::Generators::Api'
+  Straptible::Rails::Generators::Api.start
+when nil
+  usage($stderr)
+  exit 1
+else
+  $stderr.puts "Unknown flavor: #{flavor}"
+  usage($stderr)
+  exit 1
+end

data/lib/straptible/rails/builders/api.rb

@@ -0,0 +1,42 @@
+require_relative 'base'
+
+module Straptible
+  module Rails
+    module Builders
+      class Api < Base
+        def gemfile
+          copy_file 'Gemfile.api', 'Gemfile'
+        end
+
+        def database_yml
+          # No-op (handled by :config step)
+        end
+
+        def config
+          directory 'config.api', 'config'
+        end
+
+        def leftovers
+          restructure_app
+          remove_error_pages
+          super
+        end
+
+        def restructure_app
+          remove_dir 'app/assets'
+          remove_dir 'app/controllers/concerns'
+          remove_dir 'app/helpers'
+          remove_dir 'app/mailers'
+          remove_dir 'app/views/layouts'
+          empty_directory 'app/decorators'
+        end
+
+        def remove_error_pages
+          remove_file 'public/404.html'
+          remove_file 'public/422.html'
+          remove_file 'public/500.html'
+        end
+      end
+    end
+  end
+end

data/lib/straptible/rails/builders/base.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+
+module Straptible
+  module Rails
+    module Builders
+      class Base < ::Rails::AppBuilder
+        def readme
+          template 'README.md.tt'
+        end
+
+        def rakefile
+          template 'Rakefile.tt'
+        end
+
+        def vendor
+          # No-op (don't create vendor/ directory)
+        end
+
+        def db
+          empty_directory_with_keep_file 'db'
+        end
+
+        def leftovers
+          rspec
+          icons
+        end
+
+        def rspec
+          create_file '.rspec', '--color --format documentation'
+          copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+        end
+
+        def icons
+          remove_file 'public/favicon.ico'
+          copy_file 'favicon.ico', 'public/favicon.ico'
+          copy_file 'icon-72.png', 'public/icon-72.png'
+        end
+      end
+    end
+  end
+end

data/lib/straptible/rails/generators/api.rb

@@ -0,0 +1,16 @@
+require_relative 'base'
+require_relative '../builders/api'
+
+module Straptible
+  module Rails
+    module Generators
+      class Api < Base
+        protected
+
+        def get_builder_class
+          Straptible::Rails::Builders::Api
+        end
+      end
+    end
+  end
+end

data/lib/straptible/rails/generators/base.rb

@@ -0,0 +1,42 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+require_relative '../builders/base'
+
+module Straptible
+  module Rails
+    module Generators
+      class Base < ::Rails::Generators::AppGenerator
+        # Override default Rails generator options
+        # REVIEW: Is there a less monkey-patchy way to do this?
+        class_option :database,         type: :string,
+                                        aliases: '-d',
+                                        default: 'postgresql'
+
+        class_option :skip_test_unit,   type: :boolean,
+                                        aliases: '-T',
+                                        default: true
+
+        class_option :skip_javascript,  type: :boolean,
+                                        aliases: '-J',
+                                        default: true
+
+        def self.start
+          tmpl_path = File.join('..', 'templates')
+          tmpl_root = File.expand_path(tmpl_path, File.dirname(__FILE__))
+          source_root tmpl_root
+          source_paths << tmpl_root
+          source_paths << ::Rails::Generators::AppGenerator.source_root
+
+          super
+        end
+
+        protected
+
+        def get_builder_class
+          Straptible::Rails::Builders::Base
+        end
+      end
+    end
+  end
+end

data/lib/straptible/rails/templates/Gemfile.api

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rails'
+gem 'pg'
+gem 'draper'
+gem 'rabl'
+
+group :development, :test do
+  gem 'annotate'
+  gem 'aptible-tasks'
+  gem 'rubocop', github: 'bbatsov/rubocop'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'pry'
+end

data/lib/straptible/rails/templates/README.md.tt

@@ -0,0 +1,10 @@
+# ![](public/icon-72.png) <%= app_const_base %>
+
+[![Build Status](https://secure.travis-ci.org/aptible/<%= app_name %>.png?branch=master)](http://travis-ci.org/aptible/<%= app_name %>)
+
+A tool for bootstrapping new applications, document repositories, etc. according to Aptible's hyperopinionated best practices.
+
+
+## Copyright
+
+Copyright (c) 2013 [Aptible](https://www.aptible.com). All rights reserved.

data/lib/straptible/rails/templates/Rakefile.tt

@@ -0,0 +1,6 @@
+require File.expand_path('../config/application', __FILE__)
+
+<%= app_const %>.load_tasks
+
+# Load shared Aptible Rake tasks
+Aptible::Tasks.load_tasks

data/lib/straptible/rails/templates/config.api/application.rb.tt

@@ -0,0 +1,12 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_record/railtie'
+require 'action_controller/railtie'
+
+Bundler.require(:default, Rails.env)
+
+module <%= app_const_base %>
+  class Application < Rails::Application
+    config.assets.enabled = false
+  end
+end

data/lib/straptible/rails/templates/config.api/database.yml.tt

@@ -0,0 +1,15 @@
+development:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= app_name %>_development
+  pool: 5
+  username: aptible
+  password:
+
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= app_name %>_test
+  pool: 5
+  username: aptible
+  password:

data/lib/straptible/rails/templates/config.api/environment.rb.tt

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+<%= app_const %>.initialize!

data/lib/straptible/rails/templates/config.api/environments/development.rb.tt

@@ -0,0 +1,12 @@
+<%= app_const %>.configure do
+  config.cache_classes = false
+
+  config.eager_load = false
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.active_support.deprecation = :log
+
+  config.active_record.migration_error = :page_load
+end

data/lib/straptible/rails/templates/config.api/environments/production.rb.tt

@@ -0,0 +1,18 @@
+<%= app_const %>.configure do
+  config.cache_classes = true
+
+  config.eager_load = true
+
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  config.serve_static_assets = false
+
+  config.log_level = :info
+
+  config.i18n.fallbacks = true
+
+  config.active_support.deprecation = :notify
+
+  config.log_formatter = ::Logger::Formatter.new
+end

data/lib/straptible/rails/templates/config.api/environments/test.rb.tt

@@ -0,0 +1,17 @@
+<%= app_const %>.configure do
+  config.cache_classes = true
+
+  config.eager_load = false
+
+  config.serve_static_assets  = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection = false
+
+  config.active_support.deprecation = :stderr
+end

data/lib/straptible/rails/templates/config.api/initializers/filter_parameter_logging.rb

@@ -0,0 +1 @@
+Rails.application.config.filter_parameters += [:password]

data/lib/straptible/rails/templates/config.api/initializers/rabl.rb

@@ -0,0 +1,4 @@
+Rabl.configure do |config|
+  config.include_json_root = true
+  config.include_child_root = false
+end

data/lib/straptible/rails/templates/config.api/initializers/secret_token.rb.tt

@@ -0,0 +1,3 @@
+<%= app_const %>.config.secret_key_base =
+  '<%= SecureRandom.hex(32) %>' +
+  '<%= SecureRandom.hex(32) %>'

data/lib/straptible/rails/templates/config.api/initializers/session_store.rb.tt

@@ -0,0 +1 @@
+<%= app_const %>.config.session_store :cookie_store

data/lib/straptible/rails/templates/config.api/initializers/wrap_parameters.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end

data/lib/straptible/rails/templates/config.api/routes.rb.tt

@@ -0,0 +1,2 @@
+<%= app_const %>.routes.draw do
+end

data/lib/straptible/rails/templates/gitignore

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

data/lib/straptible/rails/templates/initializers/filter_parameter_logging.rb

@@ -0,0 +1 @@
+Rails.application.config.filter_parameters += [:password]

data/lib/straptible/rails/templates/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  config.use_transactional_fixtures = true
+
+  config.infer_base_class_for_anonymous_controllers = false
+
+  config.order = 'random'
+end

data/lib/straptible/version.rb

@@ -0,0 +1,3 @@
+module Straptible
+  VERSION = '0.1.0'
+end

data/lib/straptible.rb

@@ -0,0 +1,4 @@
+require 'straptible/version'
+
+module Straptible
+end

data/spec/integration/api_spec.rb

@@ -0,0 +1,71 @@
+describe 'straptible api' do
+  before :all do
+    rel_tmp = '../../tmp/spec'
+    @tmpdir = File.expand_path(rel_tmp, File.dirname(__FILE__))
+    FileUtils.mkdir_p @tmpdir
+    FileUtils.rm_rf File.join(@tmpdir, 'foobar')
+
+    rel_straptible = '../../bin/straptible'
+    @straptible = File.expand_path(rel_straptible, File.dirname(__FILE__))
+  end
+
+  context 'with no additional arguments' do
+    before :all do
+      `#{@straptible} api #{File.join(@tmpdir, 'foobar')} -B`
+    end
+
+    after :all do
+      FileUtils.rm_r File.join(@tmpdir, 'foobar')
+    end
+
+    it 'does not include a test/ directory' do
+      File.exist?(File.join(@tmpdir, 'foobar', 'test')).should be_false
+    end
+
+    it 'includes a spec/ directory' do
+      File.exist?(File.join(@tmpdir, 'foobar', 'spec')).should be_true
+    end
+
+    it 'does not include a README.rdoc' do
+      File.exist?(File.join(@tmpdir, 'foobar', 'README.rdoc')).should be_false
+    end
+
+    it 'includes an appropriate README.md' do
+      readme = File.join(@tmpdir, 'foobar', 'README.md')
+      File.exist?(readme).should be_true
+      File.read(readme).should match /\#.*public\/icon-72.png.*Foobar/
+    end
+
+    it 'does not include HTML error pages' do
+      Dir.glob('public/*.html').should be_empty
+    end
+
+    it 'does not include app/assets/ or app/mailers/' do
+      app = File.join(@tmpdir, 'foobar', 'app')
+      File.exist?(File.join(app, 'assets')).should be_false
+      File.exist?(File.join(app, 'mailers')).should be_false
+    end
+
+    it 'includes app/decorators/' do
+      app = File.join(@tmpdir, 'foobar', 'app')
+      File.exist?(File.join(app, 'decorators')).should be_true
+    end
+  end
+
+  context 'executing bundle install' do
+    before :all do
+      # TODO: Figure out how to do this offline
+      `#{@straptible} api #{File.join(@tmpdir, 'foobar')}`
+    end
+
+    after :all do
+      FileUtils.rm_rf File.join(@tmpdir, 'foobar')
+    end
+
+    it 'passes Rubocop muster' do
+      `cd #{File.join(@tmpdir, 'foobar')} && rake rubocop`
+      $CHILD_STATUS.exitstatus.should == 0
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Load shared spec files
+Dir["#{File.dirname(__FILE__)}/shared/**/*.rb"].each do |file|
+  require file
+end
+
+# Require library up front
+require 'straptible'

data/straptible.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'straptible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'straptible'
+  spec.version       = Straptible::VERSION
+  spec.authors       = ['Frank Macreery']
+  spec.email         = ['frank@macreery.com']
+  spec.description   = %q{A tool for bootstrapping new Aptible projects}
+  spec.summary       = %q{A tool for bootstrapping new Aptible projects}
+  spec.homepage      = 'https://github.com/aptible/straptible'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'aptible-tasks', '~> 0.1.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: straptible
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for bootstrapping new Aptible projects
+email:
+- frank@macreery.com
+executables:
+- straptible
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/straptible
+- lib/straptible.rb
+- lib/straptible/rails/builders/api.rb
+- lib/straptible/rails/builders/base.rb
+- lib/straptible/rails/generators/api.rb
+- lib/straptible/rails/generators/base.rb
+- lib/straptible/rails/templates/Gemfile.api
+- lib/straptible/rails/templates/README.md.tt
+- lib/straptible/rails/templates/Rakefile.tt
+- lib/straptible/rails/templates/config.api/application.rb.tt
+- lib/straptible/rails/templates/config.api/database.yml.tt
+- lib/straptible/rails/templates/config.api/environment.rb.tt
+- lib/straptible/rails/templates/config.api/environments/development.rb.tt
+- lib/straptible/rails/templates/config.api/environments/production.rb.tt
+- lib/straptible/rails/templates/config.api/environments/test.rb.tt
+- lib/straptible/rails/templates/config.api/initializers/filter_parameter_logging.rb
+- lib/straptible/rails/templates/config.api/initializers/rabl.rb
+- lib/straptible/rails/templates/config.api/initializers/secret_token.rb.tt
+- lib/straptible/rails/templates/config.api/initializers/session_store.rb.tt
+- lib/straptible/rails/templates/config.api/initializers/wrap_parameters.rb
+- lib/straptible/rails/templates/config.api/routes.rb.tt
+- lib/straptible/rails/templates/favicon.ico
+- lib/straptible/rails/templates/gitignore
+- lib/straptible/rails/templates/icon-72.png
+- lib/straptible/rails/templates/initializers/filter_parameter_logging.rb
+- lib/straptible/rails/templates/spec_helper.rb
+- lib/straptible/version.rb
+- spec/integration/api_spec.rb
+- spec/spec_helper.rb
+- straptible.gemspec
+homepage: https://github.com/aptible/straptible
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A tool for bootstrapping new Aptible projects
+test_files:
+- spec/integration/api_spec.rb
+- spec/spec_helper.rb