orats 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4bc22e389f267cb7c91d4081a11145f69d59297
-  data.tar.gz: 0454520ee8678acdf340bdcbc634177341fef0e3
+  metadata.gz: 66a58907a4dafd0eb57bc65c7f12e02524679c39
+  data.tar.gz: df5a93aa96dc07b40fa3ebf212e4a1c96b9af7f5
 SHA512:
-  metadata.gz: cb75ed8fe941ddda50d5ef7672c33e6a23057e5cb72deb5fe52214e6a6edb83630debd7890de2c53ee1a866d58b1f70611121519a9e9e8f049546ea034519fae
-  data.tar.gz: ac83b57976aef1165be7fefc093d6995b47fec97ac16db99987e3fe1675fda6f4720c542a3e96c1f1e51feb528acc6d78c5bb4ee491760e0c3de4b221db027e3
+  metadata.gz: c30c65f3f67960fad4bd4b3d6e84e494234e672067cc77bb9c198210d0178a82bd359b012fe358af4c62813738df3b74a91134f76a770752a2bd3ac63bdf6980
+  data.tar.gz: b85fe941237de1008c6b72fa388b42946fd444ab14be0cca0d03af2f06c38e6ce7836eb2919895773caa8d17a1302f4e8b2de8e4c9d9d72f3c76d93add1f785e

data/README.md

@@ -2,16 +2,13 @@
 
 ## 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.
+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.
 
 ## What version of Rails and Ruby are you targeting?
 
 #### Rails 4.1.x and Ruby 2.1.x
 
-Gems will also be updated once they are proven to work on the target rails/ruby versions. The gems are locked using the
-pessimistic operator `~>` to ensure your installation works over time as long as rubygems.org's API is working.
+Gems will also be updated once they are proven to work on the target rails/ruby versions. The gems are locked using the pessimistic operator `~>` to ensure your installation works over time as long as rubygems.org's API is working.
 
 ## Contents
 - [System dependencies](#system-dependencies)
@@ -34,7 +31,7 @@ pessimistic operator `~>` to ensure your installation works over time as long as
         - [Ansible roles](#ansible-roles-used)
 - [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)
-    - [Create a project and provision a server](https://github.com/nickjj/orats/wiki/Create-a-project-and-provision-a-server)
+    - [Get your application on a server](https://github.com/nickjj/orats/wiki/Get-your-application-on-a-server)
 
 ## System dependencies
 
@@ -68,8 +65,7 @@ Or if you already have orats then run `gem update orats` to upgrade to the lates
 
 ## Commands
 
-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.
+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`
@@ -106,13 +102,11 @@ Here is an overview of the available commands. You can find out more information
 
 ### Base
 
-This is the starter template that every other template will append to. I feel like when I make a new project, 95% of the time
-it includes these features and when I do not want a specific thing it is much quicker to remove it than add it.
+This is the starter template that every other template will append to. I feel like when I make a new project, 95% of the time it includes these features and when I do not want a specific thing it is much quicker to remove it than add it.
 
 #### Changes vs the standard rails project
 
-All of the changes have git commits to go with them. After generating a project you can type `git reflog` to get a
-list of changes.
+All of the changes have git commits to go with them. After generating a project you can type `git reflog` to get a list of changes.
 
 - **Core changes**:
     - Use `postgres` as the primary SQL database
@@ -163,27 +157,21 @@ list of changes.
 
 `orats new myapp --pg-password=foo --skip-galaxy`
 
+#### Base FAQ
+
 ##### What is `--pg-password`?
 
-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.
+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 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/).
 
-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.
+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.
 
@@ -191,8 +179,6 @@ If you don't care about the ansible at all you could add `--skip-extras` to not
 
 If your redis server is configured to use a password then you must also pass in `--redis-password=foo`.
 
-#### Base FAQ
-
 ##### What's with the directory structure?
 
 Let's say you were to generate a new project at *~/tmp/myapp*, then you would get the following paths:
@@ -203,38 +189,29 @@ Let's say you were to generate a new project at *~/tmp/myapp*, then you would ge
 ~/tmp/myapp/services
 ```
 
-The **inventory** path contains the ansible inventory files for this project. This would be where your host addresses go
-along with configuration settings for this project.
+The **inventory** path contains the ansible inventory files for this project. This would be where your host addresses go along with configuration settings for this project.
 
-The **secrets** path contains the passwords for various things as well as ssh keypairs and ssl certificates. This path
-should be kept out of version control. You could also go 1 extra step and encrypt this directory locally.
+The **secrets** path contains the passwords for various things as well as ssh keypairs and ssl certificates. This path should be kept out of version control. You could also go 1 extra step and encrypt this directory locally.
 
-The **services** path contains your rails application. I like to call it services because you might have multiple services
-in 1 project.
+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-extras` you will not get the inventory, secrets or services directory. It will just generate `myapp` at the path you specify.
 
 <a name="base-what-do-i-need-to-configure-for-development"></a>
 ##### What do I need to configure for development?
 
-Pretty much everything is contained within environment variables. They are stored in the `.env` file located in the root
-directory of the rails application. It should be self explanatory. This file is also added to `.gitignore`.
+Pretty much everything is contained within environment variables. They are stored in the `.env` file located in the root directory of the rails application. It should be self explanatory. This file is also added to `.gitignore`.
 
 <a name="base-what-do-i-need-to-configure-for-production"></a>
 ##### What do I need to configure for production?
 
-If you are using ansible then you should open `inventory/group_vars/all.yml` and take a peek. Everything there has
-comments. Assuming you have everything hosted on 1 server then at minimum you will only need to change 
-`rails_deploy_git_url` to get going.
+If you are using ansible then you should open `inventory/group_vars/all.yml` and take a peek. Everything there has comments. Assuming you have everything hosted on 1 server then at minimum you will only need to change `rails_deploy_git_url` to get going.
 
 The above variable is the repo where your code is contained. Ansible will clone that repo in an idempotent way.
 
-You will also need to put the correct server IP(s) in `inventory/hosts`. At this point that's all you need to change to 
-successfully provision a server. 
+You will also need to put the correct server IP(s) in `inventory/hosts`. At this point that's all you need to change to successfully provision a server. 
 
-There are many other variables that you would likely change too such as adding your google analytics UA, S3 keys and
-all of the mail settings.
+There are many other variables that you would likely change too such as adding your google analytics UA, S3 keys and all of the mail settings.
 
 You may also want to tinker with the following values for performance reasons based on your server(s).
 
@@ -252,13 +229,11 @@ You may also want to tinker with the following values for performance reasons ba
 
 ### Auth
 
-This is the auth template which gets merged into the base template. It contains a basic authentication setup using
-devise and pundit.
+This is the auth template which gets merged into the base template. It contains a basic authentication setup using devise and pundit.
 
 #### Changes vs the base template
 
-All of the changes have git commits to go with them. After generating a project you can type `git reflog` to get a
-list of changes.
+All of the changes have git commits to go with them. After generating a project you can type `git reflog` to get a list of changes.
 
 - **Core**:
     - Handle authentication with `devise`
@@ -300,12 +275,12 @@ list of changes.
 
 `orats new myauthapp --auth --pg-password=foo --skip-galaxy`
 
+#### Auth FAQ
+
 ##### What do those flags do?
 
 You should read the [try the base template](#try-the-base-template) section to get an idea of what they do.
 
-#### Auth FAQ
-
 <a name="auth-what-do-i-need-to-configure-for-development"></a>
 ##### What do I need to configure for development?
 
@@ -318,17 +293,13 @@ You will want to change `ACTION_MAILER_DEVISE_DEFAULT_FROM` in `inventory/group_
 
 ### Play
 
-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.
+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.
+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.
+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

data/lib/orats/cli.rb

@@ -53,6 +53,7 @@ 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
     end
@@ -66,6 +67,7 @@ module Orats
 
       `--template` 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
     end
@@ -82,6 +84,7 @@ module Orats
 
       `--redis-password` to supply your development redis password []
     D
+
     def nuke(target_path)
       Commands::Nuke.new(target_path, options).init
     end
@@ -104,6 +107,7 @@ module Orats
 
       `--inventory` to supply an inventory file for comparison []
     D
+
     def outdated
       Commands::Outdated::Exec.new(nil, options).init
     end
@@ -112,15 +116,17 @@ module Orats
     long_desc <<-D
       `orats version` will print the current version.
     D
+
     def version
       puts "Orats version #{VERSION}"
     end
+
     map %w(-v --version) => :version
 
     private
 
-      def invoked?
-        caller_locations(0).any? { |backtrace| backtrace.label == 'invoke' }
-      end
+    def invoked?
+      caller_locations(0).any? { |backtrace| backtrace.label == 'invoke' }
+    end
   end
 end

data/lib/orats/commands/common.rb

@@ -12,26 +12,26 @@ module Orats
 
       RELATIVE_PATHS = {
           galaxyfile: 'templates/includes/Galaxyfile',
-          hosts: 'templates/includes/inventory/hosts',
-          inventory: 'templates/includes/inventory/group_vars/all.yml',
-          playbook: 'templates/play.rb',
-          version: 'version.rb'
+          hosts:      'templates/includes/inventory/hosts',
+          inventory:  'templates/includes/inventory/group_vars/all.yml',
+          playbook:   'templates/play.rb',
+          version:    'version.rb'
       }
 
       attr_accessor :remote_gem_version, :remote_paths, :local_paths
 
       def initialize(target_path = '', options = {})
         @target_path = target_path
-        @options = options
+        @options     = options
         @active_path = @target_path
 
-        @local_paths = {}
+        @local_paths  = {}
         @remote_paths = {}
 
         build_common_paths
 
         self.destination_root = Dir.pwd
-        @behavior = :invoke
+        @behavior             = :invoke
       end
 
       private
@@ -50,10 +50,10 @@ module Orats
 
       def build_common_paths
         @remote_paths[:version] = select_branch 'master', RELATIVE_PATHS[:version]
-        @remote_gem_version = gem_version
+        @remote_gem_version     = gem_version
 
         RELATIVE_PATHS.each_pair do |key, value|
-          @local_paths[key] = "#{base_path}/#{value}"
+          @local_paths[key]  = "#{base_path}/#{value}"
           @remote_paths[key] = select_branch @remote_gem_version, value
         end
       end
@@ -91,13 +91,13 @@ module Orats
         case check_for
           when :not_found
             command = 'which'
-            phrase = 'on your system path'
+            phrase  = 'on your system path'
           when :not_running
             command = 'ps cax | grep'
-            phrase = 'running'
+            phrase  = 'running'
           else
             command = ''
-            phrase = ''
+            phrase  = ''
         end
 
         processes.each do |process|
@@ -118,4 +118,4 @@ module Orats
       end
     end
   end
-end
+end

data/lib/orats/commands/new/exec.rb

@@ -24,6 +24,7 @@ module Orats
             gsub_postgres_info
             gsub_redis_info unless @options[:redis_password].empty?
             gsub_project_path
+            gsub_readme
 
             bundle_install
             bundle_binstubs
@@ -50,7 +51,8 @@ module Orats
         private
 
         def services_path
-          @options[:skip_extras] ?  @target_path : "#{@target_path}/services/#{File.basename @target_path}"
+          @options[:skip_extras] ? @target_path
+          : "#{@target_path}/services/#{File.basename @target_path}"
         end
       end
     end

data/lib/orats/commands/new/rails.rb

@@ -19,7 +19,7 @@ module Orats
           log_task 'Run custom rails template'
 
           @options[:template].include?('://') ? url_to_string(@options[:template])
-                                               : file_to_string(@options[:template])
+          : file_to_string(@options[:template])
 
           rails_template '', "--skip --template #{@options[:template]}"
         end
@@ -48,6 +48,13 @@ module Orats
           git_commit 'Update the project path'
         end
 
+        def gsub_readme
+          log_task 'Update the readme'
+          gsub_file "#{@active_path}/README.md", 'VERSION', VERSION
+
+          git_commit 'Update the version'
+        end
+
         def bundle_install
           log_task 'Run bundle install, this may take a while'
           run_from @active_path, 'bundle install'
@@ -79,16 +86,18 @@ module Orats
           log_task 'Add pages controller with static page'
           run_from @active_path, 'bundle exec rails g controller Pages home'
 
-          gsub_file "#{@active_path}/config/routes.rb", "  # root 'welcome#index'" do <<-S
+          gsub_file "#{@active_path}/config/routes.rb", "  # root 'welcome#index'" do
+            <<-S
   root 'pages#home'
-          S
+            S
           end
           gsub_file "#{@active_path}/config/routes.rb", "  get 'pages/home'\n\n", ''
 
           gsub_file "#{@active_path}/test/controllers/pages_controller_test.rb",
                     '"should get home"', "'expect home page'"
           gsub_file "#{@active_path}/app/views/pages/home.html.erb", /.*\n/, ''
-          append_file "#{@active_path}/app/views/pages/home.html.erb" do <<-S
+          append_file "#{@active_path}/app/views/pages/home.html.erb" do
+            <<-S
 <%
   title 'Welcome to Ruby on Rails'
   meta_description '...'
@@ -160,7 +169,7 @@ module Orats
     <%= image_tag '/apple-touch-icon-228x228-precomposed.png', size: '228x228', alt: 'A ruby image I found on Google' %>
   </div>
 </div>
-          S
+            S
           end
           git_commit 'Add pages controller with home page'
         end

data/lib/orats/commands/new/server.rb

@@ -8,11 +8,11 @@ module Orats
         def server_start
           @options[:skip_server_start] ? message = 'Start your' : message = 'Starting'
 
-          puts  '', '='*80
+          puts '', '='*80
           log_status_top 'action', "#{message} server with the following commands", :cyan
           log_status_bottom 'command', "cd #{@active_path}", :magenta, true
           log_status_bottom 'command', 'bundle exec foreman start', :magenta
-          puts  '='*80, ''
+          puts '='*80, ''
 
           attempt_to_start
         end

data/lib/orats/commands/outdated/compare.rb

@@ -8,10 +8,10 @@ module Orats
         end
 
         def remote_to_local_galaxyfiles
-          galaxyfile_diff = @remote_galaxyfile - @local_galaxyfile
+          galaxyfile_diff            = @remote_galaxyfile - @local_galaxyfile
           local_galaxyfile_as_string = @local_galaxyfile.join
-          local_galaxyfile_roles = @local_galaxyfile.size
-          roles_diff_count = galaxyfile_diff.size
+          local_galaxyfile_roles     = @local_galaxyfile.size
+          roles_diff_count           = galaxyfile_diff.size
 
           log_status_top 'roles', "Compare this version of orats' roles to the latest version:", :green
 
@@ -21,13 +21,13 @@ module Orats
             log_status_bottom 'message', "There are #{roles_diff_count} differences", :yellow
 
             galaxyfile_diff.each do |line|
-              name = line.split(',').first
+              name   = line.split(',').first
               status = 'outdated'
-              color = :yellow
+              color  = :yellow
 
               unless local_galaxyfile_as_string.include?(name)
                 status = 'missing'
-                color = :red
+                color  = :red
               end
 
               log_status_bottom status, name, color, true
@@ -38,7 +38,7 @@ module Orats
         end
 
         def remote_to_local(label, keyword, remote, local)
-          item_diff = remote - local
+          item_diff       = remote - local
           item_diff_count = item_diff.size
 
           log_remote_info label, "Compare this version of orats' #{label} to the latest version",
@@ -63,7 +63,7 @@ module Orats
                          'path', flag_path
 
           missing_count = log_unmatched(local, user, 'missing', :red)
-          extra_count = log_unmatched(user, local, 'extra', :yellow)
+          extra_count   = log_unmatched(user, local, 'extra', :yellow)
 
           if missing_count > 0
             log_results "#{missing_count} #{keyword} are missing",