arkenstone 0.1.0

data/README.md

@@ -0,0 +1,41 @@
+# Arkenstone
+
+[![Build Status](https://travis-ci.org/ngscheurich/arkenstone.svg?branch=master)](https://travis-ci.org/ngscheurich/arkenstone)
+[![Code Climate](https://codeclimate.com/github/ngscheurich/arkenstone/badges/gpa.svg)](https://codeclimate.com/github/ngscheurich/arkenstone)
+
+The Arkenstone is a Ruby on Rails application generator set up to use my
+preferred development configuration. It is heavily influenced by thoughtbot’s
+Suspenders; I simply prefer to have something that I’ve pruned from infancy
+and just totally *get*, you know?
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "arkenstone"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install arkenstone
+
+## Usage
+
+The Arkenstone provides you with the command line application `arkenstone`,
+which behaves essentially like `rails new`. To create a Rails app with
+The Arkenstone, simply:
+
+	$ arkenstone path/to/app
+
+Check out the `--help` option to see the available configuration options.
+
+---
+
+[(ↄ) Copyleft](http://www.gnu.org/licenses/copyleft.en.html)
+Nicholas Gunther Scheurich under the
+[GNU General Public License](http://www.gnu.org/licenses/gpl.txt)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/arkenstone.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "arkenstone/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "arkenstone"
+  spec.version       = Arkenstone::VERSION
+  spec.license       = "GPL-3.0"
+  spec.author        = "Nicholas Scheurich"
+  spec.email         = "nick@scheurich.me"
+
+  spec.summary       = "A Rails bootstrapper"
+  spec.description   = <<-EOS
+The Arkenstone is a Ruby on Rails application generator set up to use my
+preferred development configuration. It is heavily influenced by thoughtbot’s
+Suspenders; I simply prefer to have something that I’ve pruned from infancy
+and just totally *get*, you know?
+  EOS
+  spec.homepage      = "https://github.com/ngscheurich/arkenstone"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "bin"
+  spec.executables   = ["arkenstone"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", "~>4.2", ">=4.2.0"
+
+  spec.add_development_dependency "bitters", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "pry", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

data/bin/arkenstone

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "pathname"
+
+source_path = (Pathname.new(__FILE__).dirname + "../lib").expand_path
+$LOAD_PATH << source_path
+
+require "arkenstone"
+
+module Arkenstone
+  class AppBuilder < Rails::AppBuilder
+    GEM_PATH = (Pathname.new(__FILE__).dirname + "..").expand_path
+  end
+end
+
+templates_relative = File.join("..", "lib/arkenstone/templates")
+templates_root = File.expand_path(templates_relative, File.dirname(__FILE__))
+Arkenstone::AppGenerator.source_root templates_root
+Arkenstone::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root
+Arkenstone::AppGenerator.source_paths << templates_root
+Arkenstone::AppGenerator.start

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arkenstone"
+
+require "pry"
+Pry.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/lib/arkenstone.rb

@@ -0,0 +1,12 @@
+require "arkenstone/version"
+require "arkenstone/generators/app_generator"
+require "arkenstone/app_builder"
+
+begin
+  require "pry"
+rescue LoadError
+  puts "Pry is not installed; debugging via `binding.pry` will not be available."
+end
+
+module Arkenstone
+end

data/lib/arkenstone/app_builder.rb

@@ -0,0 +1,118 @@
+module Arkenstone
+  class AppBuilder < Rails::AppBuilder
+    def gemfile
+      template "Gemfile.erb", "Gemfile"
+    end
+
+    def readme
+      template "README.md.erb", "README.md"
+    end
+
+    def set_ruby_version
+      create_file ".ruby-version", "#{Arkenstone::RUBY_VERSION}\n"
+    end
+
+    def set_up_authentication
+      template "user.rb", "app/models/user.rb"
+      inject_into_file(
+        "app/controllers/application_controller.rb",
+        "  include Clearance::Controller\n\n",
+        after: "class ApplicationController < ActionController::Base"
+      )
+    end
+
+    def create_simple_form_files
+      copy_file "simple_form.rb", "config/initializers/simple_form.rb"
+      copy_file "simple_form.en.yml", "config/locales/simple_form.en.yml"
+      copy_file "_form.html.erb", "lib/templates/html/scaffold/_form.html.erb"
+    end
+
+    def set_up_database
+      template "database.yml.erb", "config/database.yml",
+               force: true
+    end
+
+    def customize_application_layout
+      template "application.html.erb", "app/views/layouts/application.html.erb",
+               force: true
+    end
+
+    def config_travis_ci
+      template ".travis.yml.erb", ".travis.yml"
+    end
+
+    def create_partials_directory
+      empty_directory "app/views/application"
+    end
+
+    def create_flashes_partial
+      copy_file "_flashes.html.erb", "app/views/application/_flashes.html.erb"
+    end
+
+    def create_factories_file
+      copy_file "factories.rb", "spec/factories.rb"
+    end
+
+    def set_up_rspec
+      bundle_command "exec rails generate rspec:install"
+    end
+
+    def customize_rails_helper
+      remove_file "spec/rails_helper.rb"
+      copy_file "rails_helper.rb", "spec/rails_helper.rb"
+    end
+
+    def set_up_database_cleaner
+      copy_file "database_cleaner.rb", "spec/support/database_cleaner.rb"
+    end
+
+    def clean_up_ruby_files
+      files = `grep '^ *#[^!]' -l -r --include=*.rb .`.split("\n")
+
+      files.each do |file|
+        gsub_file file, /^ *#.*\n/, ""
+        gsub_file file, /\n$/, ""
+      end
+    end
+
+    def set_up_style_sheets
+      remove_file "app/assets/stylesheets/application.css"
+      copy_file "application.scss",
+                "app/assets/stylesheets/application.scss"
+    end
+
+    def set_up_bitters
+      run "bitters install --path app/assets/stylesheets"
+    end
+
+    def configure_locale
+      template "en.yml.erb", "config/locales/en.yml",
+               force: true
+    end
+
+    def create_home_page
+      template "home.html.erb", "app/views/pages/home.html.erb"
+      copy_file "high_voltage.rb", "config/initializers/high_voltage.rb"
+    end
+    
+    def create_binstubs
+      copy_file "rails", "bin/rails", force: true
+      copy_file "rake", "bin/rake", force: true
+      copy_file "spring", "bin/spring"
+    end
+
+    def initialize_git_repo
+      git :init
+    end
+
+    def create_initial_git_commit
+      git add: "."
+      git commit: "-m 'Initial commit [via Arkenstone]'"
+    end
+
+    def create_github_repo
+      run "hub create"
+      git push: "origin master"
+    end
+  end
+end

data/lib/arkenstone/generators/app_generator.rb

@@ -0,0 +1,56 @@
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Arkenstone
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :skip_test, type: :boolean, aliases: "-T", default: true,
+                 desc: "Skip test files"
+
+    class_option :skip_spring, type: :boolean, default: true,
+                 desc: "Don't install Spring application preloader"
+
+    class_option :authentication, type: :boolean, aliases: "-A", default: false,
+                 desc: "Create User model and configure authentication"
+
+    class_option :database, type: :string, aliases: "-d", default: "postgresql",
+                 desc: "Configure for selected database (options: #{DATABASES.join("/")})"
+
+    class_option :github, type: :boolean, aliases: "-H", default: false,
+                 desc: "Create a GitHub repository with the same name as the project"
+
+    def finish_template
+      invoke :forge_the_arkenstone
+      super
+    end
+
+    def forge_the_arkenstone
+      build :set_ruby_version
+      build :set_up_authentication if options[:authentication]
+      build :create_simple_form_files
+      build :customize_application_layout
+      build :set_up_database
+      build :config_travis_ci
+      build :create_factories_file
+      build :create_partials_directory
+      build :create_flashes_partial
+      build :set_up_rspec
+      build :customize_rails_helper
+      build :set_up_database_cleaner
+      build :clean_up_ruby_files
+      build :set_up_style_sheets
+      build :set_up_bitters
+      build :configure_locale
+      build :create_home_page
+      build :create_binstubs
+      build :initialize_git_repo
+      build :create_initial_git_commit
+      build :create_github_repo if options[:github]
+    end
+
+    protected
+
+    def get_builder_class
+      Arkenstone::AppBuilder
+    end
+  end
+end

data/lib/arkenstone/templates/.travis.yml.erb

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - <%= Arkenstone::RUBY_VERSION %>

data/lib/arkenstone/templates/Gemfile.erb

@@ -0,0 +1,52 @@
+source "https://rubygems.org"
+
+ruby "<%= Arkenstone::RUBY_VERSION %>"
+
+gem "autoprefixer-rails"
+gem "bitters"
+gem "bourbon"
+gem "coffee-rails", "~> 4.1.0"
+gem "flutie"
+gem "haml-rails", "~> 0.9"
+gem "high_voltage"
+gem "jbuilder", "~> 2.0"
+gem "jquery-rails"
+gem "neat"
+gem "normalize-rails", "~> 3.0.0"
+gem "pg"
+gem "puma"
+gem "rails", "4.2.4"
+gem "sass-rails", "~> 5.0"
+gem "simple_form", "3.2.1"
+gem "title"
+gem "sdoc", "~> 0.4.0", group: :doc
+gem "sqlite3"
+gem "turbolinks"
+gem "uglifier", ">= 1.3.0"
+
+<% if options[:authentication] %>
+  gem "clearance"
+<% end %>
+
+group :development do
+  gem "faker"
+  gem "spring"
+  gem "quiet_assets"
+  gem "web-console", "~> 2.0"
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "dotenv-rails"
+  gem "factory_girl_rails"
+  gem "pry-byebug"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 3.4.0"
+end
+
+group :test do
+  gem "capybara-webkit"
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "timecop"
+end

data/lib/arkenstone/templates/README.md.erb

@@ -0,0 +1 @@
+# <%= app_name %>

data/lib/arkenstone/templates/_flashes.html.erb

@@ -0,0 +1,3 @@
+<% flash.each do |key, value| %>
+  <div class="flash flash--#{key}"><%= value %></div>
+<% end %>

data/lib/arkenstone/templates/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

data/lib/arkenstone/templates/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="ROBOTS" content="NOODP" />
+    <meta name="viewport" content="initial-scale=1" />
+    <title><%%= page_title %></title>
+    <%%= stylesheet_link_tag "application", media: "all" %>
+    <%%= csrf_meta_tags %>
+  </head>
+
+  <body class="<%%= body_class %>">
+    <%%= yield %>
+    <%%= javascript_include_tag "application" %>
+  </body>
+</html>

data/lib/arkenstone/templates/application.scss

@@ -0,0 +1,7 @@
+@charset "utf-8";
+
+@import "normalize-rails";
+@import "bourbon";
+@import "base/grid-settings";
+@import "neat";
+@import "base/base";

data/lib/arkenstone/templates/database.yml.erb

@@ -0,0 +1,12 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+test:
+  <<: *default
+  database: <%= app_name %>_test

data/lib/arkenstone/templates/database_cleaner.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:deletion)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :deletion
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end