arkenstone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e89bd200f8cd6f7c287c5328df0e21fe7f50e13e
-  data.tar.gz: aae8281958c25d78cba66d8134d87f212ea6b9c3
+  metadata.gz: c7fd46f443ea20d4749e6c11f7a8e5a3fee2311f
+  data.tar.gz: 48a4dc33a72ed7b485d39e8ba34e22495adb9895
 SHA512:
-  metadata.gz: 711555134772363a6124262fe1c7156bb1df555588aa2c2b9d10e1625172de85794c9faab34eddd6ed0d06022f8e12e1688ce30d394b33a71ae04433f186ab5b
-  data.tar.gz: 38351343ebd8ec994e8ac647280785498acb9f32c928a842830f3d8412346df010fb3cd28b6152f86ebc95ce032d41b2db6009629aed972ec80f1c60088a04aa
+  metadata.gz: 59736589fdab7ebe84e29051b0fe62923f2d159be1905433d706f763d7a241ed17a8b4b1c8e86eed779c74b4b91f312ada8ee52ae49c0313a16b075abbd20e2b
+  data.tar.gz: fdc9f06d40f87504da7440e42dd96d1c5ebbb5fcdd1cca99634fbdcfd51ccba036fa843854b8e5b6ad4a9b4e60192700659c7973fcd14778b86a57ead4d64092

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .#*
+*.gem

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .ruby-style.yml

data/.ruby-style.yml

@@ -0,0 +1,245 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Metrics/LineLength:
+  Max: 90
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.0

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+
+ruby "2.3.0"
 
 gemspec

data/README.md

@@ -1,38 +1,48 @@
-# Arkenstone
+# The 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)
+[![Build Status](https://circleci.com/gh/ngscheurich/arkenstone.svg?&style=shield)](https://circleci.com/gh/ngscheurich/arkenstone)
+[![Code Coverage](https://codecov.io/github/ngscheurich/arkenstone/coverage.svg?branch=master)](https://codecov.io/github/ngscheurich/arkenstone?branch=master)
 
-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?
+The Arkenstone is a Ruby on Rails development environment generator. Its
+goal is to provide an easy way to spin up a new Vagrant box provisioned
+for Rails development.
 
 ## Installation
 
-Add this line to your application’s Gemfile:
+    $ gem install arkenstone
 
-```ruby
-gem "arkenstone"
-```
+## Usage
 
-And then execute:
+The Arkenstone provides you with the command line application `arkenstone`.
+To create a new Arkenstone environment:
 
-    $ bundle
+    $ arkenstone new path/to/app
 
-Or install it yourself with:
+Check out the `arkenstone help new` option to see the available
+configuration options.
 
-    $ gem install arkenstone
+Once, you’ve generated your new environment, `cd` over to `path/to/app`
+and run:
 
-## Usage
+    $ vagrant up
+
+Now go grab a cup of coffee or a glass of Scotch—this part might take a
+while. The Arkenstone is busy building a new Vagrant box and doing some
+initial work for you like:
 
-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:
+- Installing system software depencies
+- Building and installing Ruby
+- Installing and setting up PostgreSQL
+- Generating a new Rails app with [Suspenders](https://github.com/thoughtbot/suspenders)
 
-	$ arkenstone path/to/app
+When your new environment is complete, SSH into it and fire up
+the Rails server:
 
-Check out the `--help` option to see the available configuration options.
+    $ vagrant ssh
+    $ cd /vagrant && bin/rails server -b 0.0.0.0
+    
+You should now be able to visit your Rails app on your host machine at
+[http://localhost:3001](http://localhost:3001). Voilà!
 
 ---
 

data/arkenstone.gemspec

@@ -10,13 +10,11 @@ Gem::Specification.new do |spec|
   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.summary       = "A Rails development environment generator"
+  spec.description   = <<-DESC
+The Arkenstone is a Ruby on Rails development environment generator.
+Its goal is to provide an easy way to spin up a new Vagrant box provisioned for Rails development.
+DESC
   spec.homepage      = "https://github.com/ngscheurich/arkenstone"
 
   spec.files         = `git ls-files`.split("\n")
@@ -24,11 +22,10 @@ and just totally *get*, you know?
   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 "codecov", "~> 0"
   spec.add_development_dependency "pry", "~> 0.1"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
+  spec.add_development_dependency "thor", "~> 0"
 end

data/bin/arkenstone

@@ -7,15 +7,7 @@ $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
+Arkenstone::Forge.source_root templates_root
+Arkenstone::Forge.start(ARGV)

data/circle.yml

@@ -0,0 +1,9 @@
+dependencies:
+  override:
+    - bin/setup
+    - git config --global user.email "test@circleci.com"
+    - git config --global user.name "CircleCI"
+
+test:
+  override:
+    - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml

data/lib/arkenstone.rb

@@ -1,6 +1,5 @@
 require "arkenstone/version"
-require "arkenstone/generators/app_generator"
-require "arkenstone/app_builder"
+require "arkenstone/forge"
 
 begin
   require "pry"

data/lib/arkenstone/forge.rb

@@ -0,0 +1,41 @@
+require "thor"
+
+module Arkenstone
+  class Forge < Thor
+    include Thor::Actions
+
+    PROVISIONERS = %w(ansible).freeze
+
+    option :box,         type: :string, aliases: "-B", default: "ubuntu/trusty64",
+                         desc: "Vagrant base box"
+
+    option :port,        type: :numeric, default: "3001",
+                         desc: "Port on the host to forward Rails server to"
+
+    option :provider,    type: :string, aliases: "-P", default: "virtualbox",
+                         desc: "Vagrant VM provider"
+
+    option :provisioner, type: :string, aliases: "-p", default: "ansible",
+                         desc: "Vagrant provisioner (options: #{PROVISIONERS.join('/')})"
+
+    desc "new APP_PATH [options]", "Generate a new Rails environment at APP_PATH"
+    def new(app_path)
+      @app_path = app_path
+      vagrant
+      provisioner
+    end
+
+    private
+
+    def vagrant
+      template "Vagrantfile.erb", "#{@app_path}/Vagrantfile"
+    end
+
+    def provisioner
+      case options[:provisioner]
+      when "ansible"
+        directory "ansible", "#{@app_path}/provisioners/ansible"
+      end
+    end
+  end
+end