orats 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66a58907a4dafd0eb57bc65c7f12e02524679c39
-  data.tar.gz: df5a93aa96dc07b40fa3ebf212e4a1c96b9af7f5
+  metadata.gz: 4074c37de6ccbdfd2b84f5ef94d306e0ae09a38c
+  data.tar.gz: 84e6cf532395d751261e71b6145b2808b3643e85
 SHA512:
-  metadata.gz: c30c65f3f67960fad4bd4b3d6e84e494234e672067cc77bb9c198210d0178a82bd359b012fe358af4c62813738df3b74a91134f76a770752a2bd3ac63bdf6980
-  data.tar.gz: b85fe941237de1008c6b72fa388b42946fd444ab14be0cca0d03af2f06c38e6ce7836eb2919895773caa8d17a1302f4e8b2de8e4c9d9d72f3c76d93add1f785e
+  metadata.gz: 9210ea048f5c610c5c5b291715f3b6204eeea37e25f066d6334282ce7a9170d521272a6bb8ba0f361f9b60f22e8cd54da13fb02d1b0c90c2397258ce399e2506
+  data.tar.gz: 85c99459d792ddf47ca77046c28c45bf95cbfce3459afc205017622b4793c3f409c514159c124b1f33105d053b6f9d6206e6fe3d3495f7c9a020778f4964cc3d

data/README.md

@@ -1,5 +1,8 @@
 [![Gem Version](https://badge.fury.io/rb/orats.png)](http://badge.fury.io/rb/orats)
 
+##### Note
+This readme file is based off the master version of orats. If you want accurate documentation then make sure to select the branch for the latest *gem version* of orats.
+
 ## What is orats and what problem does it solve?
 
 It stands for opinionated rails application templates. The templates include solving tedious tasks that you would do for most projects. It handles creating a rails application with a bunch of opinions and optionally an ansible inventory/playbook so you can and provision your servers and deploy your apps effortlessly.
@@ -14,7 +17,19 @@ Gems will also be updated once they are proven to work on the target rails/ruby
 - [System dependencies](#system-dependencies)
 - [Installation](#installation)
 - [Commands](#commands)
-- [Templates](#templates)
+    - [Project](#project)
+    - [Inventory](#inventory)
+        - [Try it](#try-the-inventory-command)
+        - [FAQ](#inventory-faq)
+            - [What's with the sudo password](#whats-with-the-sudo-password)
+    - [Playbook](#playbook)
+        - [Try it](#try-the-playbook-command)
+        - [Ansible roles](#ansible-roles-used)
+    - [Diff](#diff)
+        - [Try it](#try-the-diff-command)
+    - [Templates](#templates)
+        - [Try it](#try-the-templates-command)
+- [Available templates](#available-templates)
     - [Base](#base)
         - [Try it](#try-the-base-template)
         - [FAQ](#base-faq)
@@ -26,9 +41,10 @@ Gems will also be updated once they are proven to work on the target rails/ruby
         - [FAQ](#auth-faq)
             - [Development configuration?](#auth-what-do-i-need-to-configure-for-development)
             - [Production configuration?](#auth-what-do-i-need-to-configure-for-production)
-    - [Play](#play)
-        - [Try it](#try-the-play-template)
-        - [Ansible roles](#ansible-roles-used)
+    - [Custom](#custom)
+        - [Try it](#try-the-custom-template)
+        - [FAQ](#custom-faq)
+            - [Any guides on how to make custom templates?](#any-guides-on-how-to-make-custom-templates)
 - [Wiki](https://github.com/nickjj/orats/wiki)
     - [What to look at after making a new project](https://github.com/nickjj/orats/wiki/What-to-look-at-after-making-a-new-project)
     - [Get your application on a server](https://github.com/nickjj/orats/wiki/Get-your-application-on-a-server)
@@ -68,37 +84,207 @@ Or if you already have orats then run `gem update orats` to upgrade to the lates
 Here is an overview of the available commands. You can find out more information about each command and flag by running  `orats help <command name>` from your terminal. You can also type `orats` on its own to see a list of all commands.
 
 - **Create a new orats project**:
-    - `orats new <TARGET_PATH> --pg-password=foo`
+    - `orats project <TARGET_PATH> --pg-password foo`
     - Configuration:
         - Optionally takes: `--pg-location [localhost]`
         - Optionally takes: `--pg-username [postgres]`
         - Optionally takes: `--redis-location [localhost]`
         - Optionally takes: `--redis-password []`
     - Template:
-        - Optionally takes: `--auth [false]`
         - Optionally takes: `--template []`
+        - Optionally takes: `--custom []`
     - Project:
-        - Optionally takes: `--skip-extras [false]`
+        - Optionally takes: `--skip-ansible [false]`
         - Optionally takes: `--skip-server-start [false]`
     - Ansible:
         - Optionally takes: `--sudo-password []`
         - Optionally takes: `--skip-galaxy [false]`
 
+- **Create an ansible inventory**:
+    - `orats inventory <TARGET_PATH>`
+    - Configuration:
+        - Optionally takes: `--sudo-password []`
+        - Optionally takes: `--skip-galaxy [false]`
+
 - **Create an ansible playbook**:
-    - `orats play <TARGET_PATH>`
+    - `orats playbook <TARGET_PATH>`
     - Template:
-        - Optionally takes: `--template []`
+        - Optionally takes: `--custom []`
 
 - **Delete a directory and optionally all data associated to it**:
     - `orats nuke <TARGET_PATH>`
     - Optionally takes: `--skip-data [false]`
 
-- **Detect whether or not orats, the playbook or inventory is outdated**:
-    - `orats outdated [options]`
-    - Optionally takes: `--playbook []`
+- **Compare differences between orats versions**:
+    - `orats diff [options]`
+    - Optionally takes: `--hosts []`
     - Optionally takes: `--inventory []`
+    - Optionally takes: `--playbook []`
+
+- **Get a list of available orats templates**:
+    - `orats templates`
+
+### Project
+
+The project command kicks off a new orats project. It will always use the 
+base template and optionally allows you to provide the `--template foo` flag 
+where `foo` would be an available template provided by orats.
+
+You can also supply your own custom template which is explained in the 
+[custom template](#custom) section.
+
+Get started by checking out what the [base template](#base) provides.
+
+### Inventory
+
+The project command automatically creates an inventory for you but it also 
+has an optional flag to skip doing it by providing `--skip-ansible`.
+
+In case you decided to `--skip-ansible` or decided to delete your inventory 
+from a really old project to let orats generate a new one for you then you can
+ generate a new inventory on its own.
+
+You may also consider using this command if you happen to use ansible but are
+ not interested in the orats project because here is what it does:
+
+#### Features
+
+- Create an `inventory` folder
+    - Create a `hosts` files
+        - Populate it with a few groups used by an orats project
+    - Create a `group_vars/all.yml` file
+        - Populate it with a bunch of configuration for an orats project
+- Create a `secrets` folder
+    - Generate strong passwords for:
+        - Your postgres user
+        - Your redis server
+        - Your mail account
+    - Generate tokens for:
+        - Rails
+        - Devise
+        - Devise pepper
+    - Create a single private/public ssh keypair
+        - This could be used to send to your servers
+    - Create self signed ssl certificates to test/support ssl
+    - Create a monit pem file for its optional http interface over ssl
+- Galaxy install the roles required by an orats project
+    - Optionally turned off with `--skip-galaxy`
+
+#### Try the inventory command
+
+`orats inventory myinventory`
+
+#### Inventory FAQ
+
+##### What's with the sudo password flag?
+
+Ansible can be installed in a number of ways. A common way is to build a  package or use a package manager. When you install ansible this way it
+ gets installed to `/etc/ansible`.
+ 
+ By default ansible will download roles from the galaxy to 
+ `/etc/ansible/roles` which will require sudo to write to.
+ 
+ If you installed ansible to your home directory then orats is smart enough 
+ not to use sudo. It will only try to use sudo when it detects a permission 
+ error.
+ 
+ You can also choose not to provide the `--sudo-password` flag but then you 
+ will be prompted for a sudo password about 90% of the way through the 
+ duration of the inventory command.
+
+### Playbook
+
+Building your application is only one piece of the puzzle. If you want to ship your application you have to host it somewhere. You have a few options when it comes to managed hosts like Heroku but they tend to be very expensive if you fall out of their free tier.
+
+The playbook template creates an ansible playbook that will provision a **ubuntu 12.04 LTS server**. It can be hosted anywhere as there are no hard requirements on any specific host.
+
+#### Server breakdown
+
+Everything is broken up into ansible roles so you can quickly scale out horizontally or by splitting up your server groups such that your database is on a separate server than your application.
+
+- **Security**:
+    - Logging into the server is only possible with an ssh key
+    - Root login is disable
+    - fail2ban is setup
+    - ufw (firewall) is setup to block any ports not exposed by you
+    - All stack specific processes are running with less privileges than root
+- **User**:
+    - A single deploy user is created
+- **Services and runtimes**:
+    - Postgres
+    - Redis
+    - NodeJS
+    - Ruby
+- **Process management**:
+    - Your rails app and sidekiq have `init.d` scripts
+    - Your rails app and sidekiq are monitored using `monit`
+
+#### Try the playbook command
+
+`orats playbook myplaybook`
+
+#### Ansible roles used
+
+- `nickjj.user` https://github.com/nickjj/ansible-user
+- `nickjj.security` https://github.com/nickjj/ansible-security
+- `nickjj.postgres` https://github.com/nickjj/ansible-postgres
+- `nickjj.ruby` https://github.com/nickjj/ansible-ruby
+- `nickjj.rails` https://github.com/nickjj/ansible-rails
+- `nickjj.whenever` https://github.com/nickjj/ansible-whenever
+- `nickjj.pumacorn` https://github.com/nickjj/ansible-pumacorn
+- `nickjj.sidekiq` https://github.com/nickjj/ansible-sidekiq
+- `nickjj.monit` https://github.com/nickjj/ansible-monit
+- `nickjj.nodejs` https://github.com/nickjj/ansible-nodejs
+- `nickjj.nginx` https://github.com/nickjj/ansible-nginx
+- `DavidWittman.redis` https://github.com/DavidWittman/ansible-redis
+
+All of the above roles will get installed and updated whenever you generate a new orats project.
+
+### Diff
+
+The goal of the diff command is to provide you a way to compare your current 
+orats gem to the latest orats gem. It can also compare the difference between
+ the orats generated version of an inventory/playbook to an 
+ inventory/playbook that you generated and have customized.
+ 
+ This comes in handy when you want to upgrade orats and your project. 
+ You will be able to see if your inventory/playbook are missing any variables
+  or roles and it will also detect custom variables/roles that you have added.
+   
+It allows you to make 2 different types of comparisons:
+
+#### Latest stable version of orats vs your version
+
+When doing this type of comparison it only compares the actual files contained in the orats source code, not your generated inventory/playbook.
+    
+This is the type of comparison that is made when you run the `diff` command 
+without any arguments. It is useful to run this from time to time to 
+see if you are missing out on any new features in the latest version.
 
-## Templates
+#### Your orats version vs your custom project files
+
+If you pass in the `--hosts`, `--inventory` and/or `--playbook` flags along 
+with a path to each of their files then it will compare the files contained 
+in the orats source code to your custom generated inventory/playbook.
+
+If you stick with the orats naming convention and directory structure there 
+are a few quality of life enhancements. If you supply the path to the 
+inventory folder it will do a comparison on both the inventory and hosts file for you. If you supply the path to a 
+playbook folder it will automatically choose the `site.yml` playbook.
+
+#### Try the diff command
+
+`orats diff`
+
+### Templates
+
+Return a list of available templates to choose from.
+
+#### Try the templates command
+
+`orats templates`
+
+## Available templates
 
 ### Base
 
@@ -129,9 +315,11 @@ All of the changes have git commits to go with them. After generating a project
         - Use the `dotenv` gem to manage environment variables
         - Use `foreman` to manage the app's processes
         - Use `bullet`, `rack mini profiler` and `meta_request` for profiling/analysis
+        - Set `scss`/`coffee` as the default generator engines
     - **Production mode only**:
         - Setup log rotation
         - Add popular file types to the assets precompile list
+        - Compress `css`/`js` when running `rake assets:precompile`
     - Change validation errors to output inline on each element instead of a big list
 - **Helpers**:
     - `title`, `meta_description`, `heading` to easily set those values per view
@@ -155,7 +343,7 @@ All of the changes have git commits to go with them. After generating a project
 
 #### Try the base template
 
-`orats new myapp --pg-password=foo --skip-galaxy`
+`orats project myapp --pg-password foo --skip-galaxy`
 
 #### Base FAQ
 
@@ -163,21 +351,21 @@ All of the changes have git commits to go with them. After generating a project
 
 Orats will automatically start your server (you can turn this off with a flag) and also run database migrations or generators depending on what you're doing.
 
-In order to do this it must know your postgres location, username and password. By default it will use localhost for the *location* and *postgres* as the username but if you need to supply those values because yours are different you can use `--pg-location=foo` and `--pg-username=bar`.
+In order to do this it must know your postgres location, username and password. By default it will use localhost for the *location* and *postgres* as the username but if you need to supply those values because yours are different you can use `--pg-location foo` and `--pg-username bar`.
 
 ##### What is `--skip-galaxy`?
 
-By default the new command will generate ansible related files for you so that you can manage this app's "inventory". It also automatically downloads the ansible roles from the [ansible galaxy](https://galaxy.ansible.com/).
+By default the project command will generate ansible related files for you so that you can manage this app's "inventory". It also automatically downloads the ansible roles from the [ansible galaxy](https://galaxy.ansible.com/).
 
 This was done to ensure each app you create has the correct ansible role version to go with it. However, if you installed ansible through apt or somewhere outside of your home directory then you will get permissions errors when it tries to download the roles.
 
-You can fix this by supplying `--sudo-password=foo` to the above command if you know ansible is installed outside of your home directory or you can just wait while the command runs and it will prompt you for your sudo password when it gets to that point because orats will attempt to use sudo only after it fails trying to install the roles without sudo.
+You can fix this by supplying `--sudo-password foo` to the above command if you know ansible is installed outside of your home directory or you can just wait while the command runs and it will prompt you for your sudo password when it gets to that point because orats will attempt to use sudo only after it fails trying to install the roles without sudo.
 
-If you don't care about the ansible at all you could add `--skip-extras` to not generate any ansible files.
+If you don't care about the ansible at all you could add `--skip-ansible` to not generate any ansible files.
 
 ##### Does your redis server use a password?
 
-If your redis server is configured to use a password then you must also pass in `--redis-password=foo`.
+If your redis server is configured to use a password then you must also pass in `--redis-password foo`.
 
 ##### What's with the directory structure?
 
@@ -195,7 +383,7 @@ The **secrets** path contains the passwords for various things as well as ssh ke
 
 The **services** path contains your rails application. I like to call it services because you might have multiple services in 1 project.
 
-If you run the command with `--skip-extras` you will not get the inventory, secrets or services directory. It will just generate `myapp` at the path you specify.
+If you run the command with `--skip-ansible` you will not get the inventory and services.
 
 <a name="base-what-do-i-need-to-configure-for-development"></a>
 ##### What do I need to configure for development?
@@ -273,7 +461,7 @@ All of the changes have git commits to go with them. After generating a project
 
 #### Try the auth template
 
-`orats new myauthapp --auth --pg-password=foo --skip-galaxy`
+`orats project myauthapp --auth --pg-password foo --skip-galaxy`
 
 #### Auth FAQ
 
@@ -291,50 +479,35 @@ You may want to change `ACTION_MAILER_DEVISE_DEFAULT_FROM` in `.env`.
 
 You will want to change `ACTION_MAILER_DEVISE_DEFAULT_FROM` in `inventory/group_vars/all.yml`.
 
-### Play
+### Custom
 
-Building your application is only one piece of the puzzle. If you want to ship your application you have to host it somewhere. You have a few options when it comes to managed hosts like Heroku but they tend to be very expensive if you fall out of their free tier.
+You can pass custom templates into both the `project` and `playbook` commands
+. It works exactly like passing a custom application template to `rails new`.
 
-The playbook template creates an ansible playbook that will provision a **ubuntu 12.04 LTS server**. It can be hosted anywhere as there are no hard requirements on any specific host.
+Pass in a custom template by providing the `--custom` flag along with either a local path or a URL.
 
-#### Server breakdown
+Here is a simple example of a custom template:
 
-Everything is broken up into ansible roles so you can quickly scale out horizontally or by splitting up your server groups such that your database is on a separate server than your application.
+```
+# /tmp/foo.rb
 
-- **Security**:
-    - Logging into the server is only possible with an ssh key
-    - Root login is disable
-    - fail2ban is setup
-    - ufw (firewall) is setup to block any ports not exposed by you
-    - All stack specific processes are running with less privileges than root
-- **User**:
-    - A single deploy user is created
-- **Services and runtimes**:
-    - Postgres
-    - Redis
-    - NodeJS
-    - Ruby
-- **Process management**:
-    - Your rails app and sidekiq have `init.d` scripts
-    - Your rails app and sidekiq are monitored using `monit`
+file 'app/components/foo.rb', <<-S
+  class Foo
+  end
+S
+```
 
-#### Try the play template
+#### Try the custom template
 
-`orats play myplaybook`
+`orats project /tmp/customexample -p foo --custom /tmp/foo.rb`
 
-#### Ansible roles used
+#### Custom FAQ
 
-- `nickjj.user` https://github.com/nickjj/ansible-user
-- `nickjj.security` https://github.com/nickjj/ansible-security
-- `nickjj.postgres` https://github.com/nickjj/ansible-postgres
-- `nickjj.ruby` https://github.com/nickjj/ansible-ruby
-- `nickjj.rails` https://github.com/nickjj/ansible-rails
-- `nickjj.whenever` https://github.com/nickjj/ansible-whenever
-- `nickjj.pumacorn` https://github.com/nickjj/ansible-pumacorn
-- `nickjj.sidekiq` https://github.com/nickjj/ansible-sidekiq
-- `nickjj.monit` https://github.com/nickjj/ansible-monit
-- `nickjj.nodejs` https://github.com/nickjj/ansible-nodejs
-- `nickjj.nginx` https://github.com/nickjj/ansible-nginx
-- `DavidWittman.redis` https://github.com/DavidWittman/ansible-redis
+<a name="any-guides-on-how-to-make-custom-templates"></a>
+##### Any guides on how to make custom templates?
+
+There's the official [rails guide on custom application templates]
+(http://guides.rubyonrails.org/rails_application_templates.html).
 
-All of the above roles will get installed and updated whenever you generate a new orats project.
+You can also view the [orats project templates](https://github.com/nickjj/orats/tree/master/lib/orats/templates) to use as inspiration. All of 
+the template files are self contained.

data/lib/orats/cli.rb

@@ -1,8 +1,9 @@
 require 'thor'
-require 'orats/commands/new/exec'
-require 'orats/commands/outdated/exec'
-require 'orats/commands/play'
+require 'orats/commands/project/exec'
+require 'orats/commands/inventory'
+require 'orats/commands/playbook'
 require 'orats/commands/nuke'
+require 'orats/commands/diff/exec'
 
 module Orats
   class CLI < Thor
@@ -11,15 +12,15 @@ module Orats
     option :pg_password, required: true, aliases: '-p'
     option :redis_location, default: 'localhost', aliases: '-n'
     option :redis_password, default: '', aliases: '-d'
-    option :auth, type: :boolean, default: false, aliases: '-a'
     option :template, default: '', aliases: '-m'
-    option :skip_extras, type: :boolean, default: false, aliases: '-E'
+    option :custom, default: '', aliases: '-c'
+    option :skip_ansible, type: :boolean, default: false, aliases: '-A'
     option :skip_server_start, type: :boolean, default: false, aliases: '-F'
     option :sudo_password, default: '', aliases: '-s'
     option :skip_galaxy, type: :boolean, default: false, aliases: '-G'
-    desc 'new TARGET_PATH [options]', ''
+    desc 'project TARGET_PATH [options]', ''
     long_desc <<-D
-      `orats new target_path --pg-password supersecret` will create a new rails project and it will also create an ansible inventory to go with it by default.
+      `orats project target_path --pg-password supersecret` will create a new rails project and it will also create an ansible inventory to go with it by default.
 
       You must supply at least this flag:
 
@@ -37,13 +38,13 @@ module Orats
 
       Template features:
 
-      `--auth` will include authentication and authorization [false]
+      `--template` accepts a template name which will get added in addition to the base template []
 
-      `--template` will let you supply a custom template, a url or file is ok but urls must start with http or https []
+      `--custom` will let you supply a custom template, a url or file is ok but urls must start with http or https []
 
       Project features:
 
-      `--skip-extras` skip creating the services directory and ansible inventory/secrets [false]
+      `--skip-ansible` skip creating the ansible related directories [false]
 
       `--skip-server-start` skip automatically running puma and sidekiq [false]
 
@@ -54,22 +55,39 @@ module Orats
       `--skip-galaxy` skip automatically installing roles from the galaxy [false]
     D
 
-    def new(target_path)
-      Commands::New::Exec.new(target_path, options).init
+    def project(target_path)
+      Commands::Project::Exec.new(target_path, options).init
     end
 
-    option :template, default: '', aliases: '-m'
-    desc 'play PATH [options]', ''
+    option :sudo_password, default: '', aliases: '-s'
+    option :skip_galaxy, type: :boolean, default: false, aliases: '-G'
+    desc 'inventory TARGET_PATH [options]', ''
     long_desc <<-D
-      `orats play target_path` will create an ansible playbook.
+      `orats inventory target_path` will create an ansible inventory.
+
+      Configuration:
+
+      `--sudo-password` to install ansible roles from the galaxy to a path outside of your user privileges []
+
+      `--skip-galaxy` skip automatically installing roles from the galaxy [false]
+    D
+
+    def inventory(target_path)
+      Commands::Inventory.new(target_path, options).init
+    end
+
+    option :custom, default: '', aliases: '-c'
+    desc 'playbook TARGET_PATH [options]', ''
+    long_desc <<-D
+      `orats playbook target_path` will create an ansible playbook.
 
       Template features:
 
-      `--template` will let you supply a custom template, a url or file is ok but urls must start with http or https []
+      `--custom` will let you supply a custom template, a url or file is ok but urls must start with http or https []
     D
 
-    def play(target_path)
-      Commands::Play.new(target_path, options).init
+    def playbook(target_path)
+      Commands::Playbook.new(target_path, options).init
     end
 
     option :skip_data, type: :boolean, default: false, aliases: '-D'
@@ -89,11 +107,12 @@ module Orats
       Commands::Nuke.new(target_path, options).init
     end
 
-    option :playbook, default: '', aliases: '-p'
+    option :hosts, default: '', aliases: '-h'
     option :inventory, default: '', aliases: '-i'
-    desc 'outdated [options]', ''
+    option :playbook, default: '', aliases: '-b'
+    desc 'diff [options]', ''
     long_desc <<-D
-      `orats outdated` will run various comparisons on orats and your ansible files.
+      `orats diff` will run various comparisons on orats and your ansible files.
 
       Help:
 
@@ -103,13 +122,32 @@ module Orats
 
       Options:
 
-      `--playbook` to supply a playbook file for comparison []
+      `--hosts` to supply a hosts file for comparison []
+
+      `--inventory` to supply an inventory directory/file for comparison []
+
+      `--playbook` to supply a playbook directory/file for comparison []
+
+      Quality of life features:
+
+      `--inventory` also accepts a path to your project's inventory folder,
+if you kept the default file names it will automatically compare both your
+hosts and group_vars/all.yml files.
 
-      `--inventory` to supply an inventory file for comparison []
+      `--playbook` also accepts a path to a playbook folder, if you kept the playbook name as `site.yml` it will automatically choose it.
+    D
+
+    def diff
+      Commands::Diff::Exec.new(nil, options).init
+    end
+
+    desc 'templates', ''
+    long_desc <<-D
+      `orats templates` will return a list of available orats templates.
     D
 
-    def outdated
-      Commands::Outdated::Exec.new(nil, options).init
+    def templates
+      Commands::Project::Exec.new.list_templates
     end
 
     desc 'version', ''