hoboken 0.0.1 → 0.9.0

data/lib/hoboken/actions.rb

@@ -1,17 +1,21 @@
+# frozen_string_literal: true
+
 module Hoboken
+  # Custom actions.
+  #
   module Actions
     def gem(name, opts={})
-      verbose = opts.has_key?(:verbose) ? opts.delete(:verbose) : true
-      version = opts.has_key?(:version) ? opts.delete(:version) : nil
+      verbose = opts.key?(:verbose) ? opts.delete(:verbose) : true
+      version = opts.key?(:version) ? opts.delete(:version) : nil
 
-      parts = [name.inspect]
-      parts << "~> #{version}".inspect unless version.nil? || version.empty?
+      parts = ["'#{name}'"]
+      parts << "'~> #{version}'" unless version.nil? || version.empty?
       opts.each { |k, v| parts << "#{k}: #{v.inspect}" }
-      append_file("Gemfile", "\ngem #{parts.join(", ")}", verbose: verbose)
+      append_file('Gemfile', "gem #{parts.join(', ')}\n", verbose: verbose)
     end
 
     def indent(text, num_spaces)
-      text.gsub(/^/, 1.upto(num_spaces).map { |n| " " }.join)
+      text.gsub(/^/, 1.upto(num_spaces).map { |_| ' ' }.join)
     end
   end
 end

data/lib/hoboken/add_ons/github_action.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Github action that runs CI task.
+    #
+    class GithubAction < ::Hoboken::Group
+      def add_action_yml_file
+        empty_directory('.github/workflows')
+        template('hoboken/templates/github_action.tt', '.github/workflows/ruby.yml')
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/heroku.rb

@@ -1,34 +1,19 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Heroku deployment support.
+    #
     class Heroku < ::Hoboken::Group
-      def add_gem
-        gem "foreman", version: "0.63.0", group: :development
-      end
-
-      def procfile
-        create_file("Procfile") do
-          "web: bundle exec thin start -p $PORT -e $RACK_ENV"
-        end
-      end
-
       def slugignore
-        create_file(".slugignore") do
-          "tags\n/test\n/tmp"
+        create_file('.slugignore') do
+          "spec\ntags\n/test\n/tmp"
         end
       end
 
       def fix_stdout_for_logging
-        prepend_file("config.ru", "$stdout.sync = true\n")
-      end
-
-      def replace_server_rake_task
-        gsub_file("Rakefile", /desc.*server.*{rack_env}"\)\nend$/m) do
-<<TASK
-desc "Start the development server with Foreman"
-task :server do
-  exec("foreman start")
-end
-TASK
+        insert_into_file('config.ru', after: /# frozen_string_literal: true/) do
+          "\n\n$stdout.sync = true"
         end
       end
 

data/lib/hoboken/add_ons/internationalization.rb

@@ -1,19 +1,23 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Internationalization support using sinatra-r18n.
+    #
     class Internationalization < ::Hoboken::Group
       def add_gem
-        gem "sinatra-r18n", version: "1.1.5"
-        insert_into_file("app.rb", after: /require "sinatra("|\/base")/) do
-          "\nrequire \"sinatra/r18n\""
+        gem 'sinatra-r18n', version: '5.0'
+        insert_into_file('app.rb', after: %r{require 'sinatra('|/base')}) do
+          "\nrequire 'sinatra/r18n'"
         end
-        insert_into_file("app.rb", after: /Sinatra::Base/) do
+        insert_into_file('app.rb', after: /Sinatra::Base/) do
           "\n    register Sinatra::R18n"
         end
       end
 
       def translations
-        empty_directory("i18n")
-        template("hoboken/templates/en.yml.tt", "i18n/en.yml")
+        empty_directory('i18n')
+        template('hoboken/templates/en.yml.tt', 'i18n/en.yml')
       end
 
       def reminders

data/lib/hoboken/add_ons/metrics.rb

@@ -1,34 +1,59 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # Add metrics (flog, flay, simplecov).
+    #
     class Metrics < ::Hoboken::Group
       def add_gems
-        gem "flog", version: "2.5.3", group: :test
-        gem "flay", version: "1.4.3", group: :test
-        gem "simplecov", version: "0.7.1", require: false, group: :test
+        gem 'flog', version: '4.6', group: :test
+        gem 'flay', version: '2.12', group: :test
+        gem 'simplecov', version: '0.21', require: false, group: :test
       end
 
       def copy_task_templates
-        empty_directory("tasks")
-        template("hoboken/templates/metrics.rake.tt", "tasks/metrics.rake")
+        empty_directory('tasks')
+        template('hoboken/templates/metrics.rake.tt', 'tasks/metrics.rake')
       end
 
-      def simplecov_snippet
-        insert_into_file "test/test_helper.rb", before: /require "test\/unit"/ do
-<<CODE
+      def simplecov_test_unit
+        return if rspec?
 
-require 'simplecov'
-SimpleCov.start do
-  add_filter "/test/"
-  coverage_dir 'tmp/coverage'
-end
+        insert_into_file 'test/test_helper.rb', before: snippet_location do
+          snippet('test')
+        end
+      end
+
+      def simplecov_rspec
+        return unless rspec?
 
-CODE
+        insert_into_file 'spec/spec_helper.rb', before: snippet_location do
+          snippet('rspec')
         end
       end
 
       def reminders
         say "\nGemfile updated... don't forget to 'bundle install'"
       end
+
+      private
+
+      def snippet(framework_folder)
+        <<~CODE
+          require 'simplecov'
+          SimpleCov.start do
+            add_filter '/bin/'
+            add_filter '/config/'
+            add_filter '/#{framework_folder}/'
+            coverage_dir 'tmp/coverage'
+          end
+
+        CODE
+      end
+
+      def snippet_location
+        %r{require 'bundler/setup'}
+      end
     end
   end
 end

data/lib/hoboken/add_ons/omniauth.rb

@@ -1,92 +1,163 @@
+# frozen_string_literal: true
+
 module Hoboken
   module AddOns
+    # OmniAuth authentication (allows you to select a provider).
+    #
     class OmniAuth < ::Hoboken::Group
       attr_reader :provider
 
       def add_gem
-        @provider = ask("Specify a provider (i.e. twitter, facebook. etc.): ").downcase
-        provider_version = ask("Specify provider version: ")
+        @provider = ask('Specify a provider (i.e. twitter, facebook. etc.): ').downcase
+        provider_version = ask('Specify provider version: ')
         gem gem_name, version: provider_version
       end
 
       def setup_middleware
-        insert_into_file("app.rb", after: /require "sinatra("|\/base")/) do
-          "\nrequire \"#{gem_name}\""
+        insert_into_file('app.rb', after: %r{require 'sinatra('|/base')}) do
+          "\nrequire '#{gem_name}'\nrequire 'sinatra/json'\n"
         end
 
-        snippet = <<-CODE
-
-use OmniAuth::Builder do
-  provider :#{provider}, ENV["#{provider.upcase}_KEY"], ENV["#{provider.upcase}_SECRET"]
-end
-
-CODE
+        snippet = <<~CODE
+          use OmniAuth::Builder do
+            provider :#{provider}, ENV['#{provider.upcase}_KEY'], ENV['#{provider.upcase}_SECRET']
+          end
+        CODE
 
-        text = modular? ? indent(snippet, 4) : snippet
-        insert_into_file("app.rb", after: /use Rack::Session::Cookie.+\n/) { text }
+        indentation = classic? ? 2 : 4
+        insert_into_file('app.rb', after: /use Rack::Session::Cookie.+\n/) do
+          "\n#{indent(snippet, indentation)}\n"
+        end
       end
 
+      # rubocop:disable Metrics/MethodLength
       def add_routes
-        routes = <<-CODE
-
+        routes = <<~CODE
 
-get "/login" do
-  '<a href="/auth/#{provider}">Login</a>'
-end
+          get '/login' do
+            '<a href="/auth/#{provider}">Login</a>'
+          end
 
-get "/auth/:provider/callback" do
-  # TODO: Insert real authentication logic...
-  MultiJson.encode(request.env['omniauth.auth'])
-end
+          get '/auth/:provider/callback' do
+            # TODO: Insert real authentication logic...
+            json request.env['omniauth.auth']
+          end
 
-get "/auth/failure" do
-  # TODO: Insert real error handling logic...
-  halt 401, params[:message]
-end
-CODE
+          get '/auth/failure' do
+            # TODO: Insert real error handling logic...
+            halt 401, params[:message]
+          end
+        CODE
 
-        if modular?
-          insert_into_file("app.rb", after: /get.+?end$/m) { indent(routes, 4) }
+        if classic?
+          append_file('app.rb', routes)
         else
-          append_file("app.rb", routes)
+          inject_into_class('app.rb', 'App') { indent(routes, 4) }
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
+      # rubocop:disable Metrics/MethodLength
       def add_tests
-        inject_into_class("test/unit/app_test.rb", "AppTest") do
-  <<-CODE
+        return if rspec?
+
+        inject_into_class('test/unit/app_test.rb', 'AppTest') do
+          <<-CODE
   setup do
     OmniAuth.config.test_mode = true
   end
 
-  test "GET /login" do
-    get "/login"
+  test 'GET /login' do
+    get '/login'
     assert_equal('<a href="/auth/#{provider}">Login</a>', last_response.body)
   end
 
-  test "GET /auth/#{provider}/callback" do
+  test 'GET /auth/#{provider}/callback' do
     auth_hash = {
-      "provider" => "#{provider}",
-      "uid" => "123545",
-      "info" => {
-        "name" => "John Doe"
+      provider: '#{provider}',
+      uid: '123545',
+      info: {
+        name: 'John Doe'
       }
     }
 
     OmniAuth.config.mock_auth[:#{provider}] = auth_hash
-    get "/auth/fitbit/callback"
+    get '/auth/#{provider}/callback'
     assert_equal(MultiJson.encode(auth_hash), last_response.body)
   end
 
-  test "GET /auth/failure" do
+  test 'GET /auth/failure' do
     OmniAuth.config.mock_auth[:#{provider}] = :invalid_credentials
-    get "/auth/failure"
+    get '/auth/failure'
     assert_response :not_authorized
   end
 
-  CODE
+          CODE
         end
       end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      def add_specs
+        return unless rspec?
+
+        append_file('spec/app_spec.rb') do
+          <<~CODE
+
+            # rubocop:disable RSpec/DescribeClass
+            RSpec.describe 'omniauth', rack: true do
+              before(:each) { OmniAuth.config.test_mode = true }
+
+              describe 'GET /login' do
+                before(:each) { get '/login' }
+
+                it { expect(last_response).to have_http_status(:ok) }
+                it { expect(last_response).to have_content_type(:html) }
+
+                it 'renders a template with a login link' do
+                  #{provider}_link = '<a href="/auth/#{provider}">Login</a>'
+                  expect(last_response.body).to include(#{provider}_link)
+                end
+              end
+
+              describe 'GET /auth/#{provider}/callback' do
+                let(:auth_hash) do
+                  {
+                    provider: '#{provider}',
+                    uid: '123545',
+                    info: {
+                      name: 'John Doe'
+                    }
+                  }
+                end
+
+                before(:each) do
+                  OmniAuth.config.mock_auth[:#{provider}] = auth_hash
+                  get '/auth/#{provider}/callback'
+                end
+
+                it { expect(last_response).to have_http_status(:ok) }
+                it { expect(last_response).to have_content_type(:json) }
+
+                it 'renders the auth hash result' do
+                  expect(last_response.body).to eq(JSON.generate(auth_hash))
+                end
+              end
+
+              describe 'GET /auth/failure' do
+                before(:each) do
+                  OmniAuth.config.mock_auth[:#{provider}] = :invalid_credentials
+                  get '/auth/failure'
+                end
+
+                it { expect(last_response).to have_http_status(:not_authorized) }
+              end
+            end
+            # rubocop:enable RSpec/DescribeClass
+          CODE
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
 
       def reminders
         say "\nGemfile updated... don't forget to 'bundle install'"
@@ -97,10 +168,6 @@ CODE
       def gem_name
         "omniauth-#{provider}"
       end
-
-      def modular?
-        @modular ||= File.readlines("app.rb").grep(/Sinatra::Base/).any?
-      end
     end
   end
 end

data/lib/hoboken/add_ons/rubocop.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Basic Rubocop YAML config.
+    #
+    class Rubocop < ::Hoboken::Group
+      def add_gems
+        gem 'rubocop', version: '1.12', group: %i[development test]
+        gem 'rubocop-rake', version: '0.5', group: %i[development test]
+        gem 'rubocop-rspec', version: '2.2', group: %i[development test] if rspec?
+      end
+
+      def rubocop_yml
+        template('hoboken/templates/rubocop.yml.tt', '.rubocop.yml')
+      end
+
+      def rake_task
+        create_file('tasks/rubocop.rake') do
+          <<~TEXT
+            # frozen_string_literal: true
+
+            require 'rubocop/rake_task'
+
+            RuboCop::RakeTask.new
+          TEXT
+        end
+      end
+
+      def ci_task
+        task_list = if rspec?
+                      '%w[rspec rubocop]'
+                    else
+                      "['test:all', 'rubocop']"
+                    end
+        gsub_file('Rakefile', /task ci:.*/, "task ci: #{task_list}")
+      end
+    end
+  end
+end