hoboken 0.0.1.beta2 → 0.10.0

data/lib/hoboken/add_ons/active_record.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # ActiveRecord database access via sinatra-activerecord gem.
+    #
+    class ActiveRecord < Hoboken::Group
+      def add_gems
+        gem 'sinatra-activerecord', version: '2.0'
+        gem 'sqlite3', version: '1.4', group: %i[development test]
+      end
+
+      def setup_directories
+        empty_directory('db/migrate')
+        empty_directory('tasks')
+      end
+
+      def copy_example_seeds_file
+        copy_file('hoboken/templates/seeds.rb', 'db/seeds.rb')
+      end
+
+      def copy_rake_task
+        copy_file('hoboken/templates/active_record.rake', 'tasks/active_record.rake')
+      end
+
+      def require_sinatra_activerecord
+        location = %r{require_relative '\.\./app'}
+        insert_into_file('config/environment.rb', before: location) do
+          "require 'sinatra/activerecord'\n\n"
+        end
+      end
+
+      def set_database_variable
+        snippet = "set :database, ENV['DATABASE_URL']"
+        snippet = "register Sinatra::ActiveRecordExtension\n#{snippet}" if modular?
+        indentation = classic? ? 2 : 6
+        location = /set :erb.+\n/
+        insert_into_file('config/environment.rb', after: location) do
+          "\n#{indent(snippet, indentation)}\n"
+        end
+      end
+
+      def setup_puma_config
+        insert_into_file('config/puma.rb', after: 'on_worker_boot do') do
+          "\n    ActiveRecord::Base.establish_connection"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def add_database_test_helper_class
+        return if rspec?
+
+        insert_into_file('test/test_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite3:db/test.db'\n"
+        end
+
+        snippet = <<~CODE
+          def run(*args, &block)
+            result = nil
+            ActiveRecord::Base.connection.transaction do
+              result = super
+              raise ActiveRecord::Rollback
+            end
+            result
+          end
+        CODE
+
+        insert_into_file('test/test_helper.rb', after: /include RackHelpers\n/) do
+          "\n#{indent(snippet, 6)}"
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      def add_database_spec_helper
+        return unless rspec?
+
+        insert_into_file('spec/spec_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite3:db/test.db'\n"
+        end
+
+        snippet = <<~CODE
+          config.around do |example|
+            ActiveRecord::Base.transaction do
+              example.run
+              ActiveRecord::Rollback
+            end
+          end
+        CODE
+
+        location = /RSpec\.configure do \|config\|\n/
+        insert_into_file('spec/spec_helper.rb', after: location) do
+          "#{indent(snippet, 2)}\n"
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>DATABASE_URL</td>
+              <td>Yes</td>
+              <td>
+                `sqlite3:db/test.db` (for the test environment <em>only</em>)
+              </td>
+              <td>
+                Connection URL to the database. The format varies according
+                database adapter. Refer to the documentation for the adapter
+                you're using for more information. Some examples:
+                <dl>
+                  <dt>Sqlite3</dt>
+                  <dd>`sqlite3:db/development.db`</dd>
+                  <dt>PostgreSQL</dt>
+                  <dd>`postgresql://localhost/myapp_development?pool=5`</dd>
+                </dl>
+              </td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        say "\nGemfile updated... don't forget to 'bundle install'"
+        say <<~TEXT
+
+          Notes:
+            * The sqlite3 gem has been installed for dev and test environments
+              only. You will need to specify a gem to use for production.
+
+            * You will need to specify an environment variable 'DATABASE_URL'
+              (either add it to .env or export it). For example, in your .env
+              file add: `DATABASE_URL=sqlite3:db/development.db`.
+        TEXT
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/airbrake.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Support for official Airbrake library for Ruby applications.
+    #
+    class Airbrake < ::Hoboken::Group
+      def add_gem
+        gem 'airbrake', version: '11.0'
+      end
+
+      def setup_config
+        template('hoboken/templates/airbrake.rb.tt', 'config/airbrake.rb')
+      end
+
+      def add_middleware
+        indentation = classic? ? 2 : 6
+        require_snippet = indent("require_relative 'airbrake'\n", indentation)
+        middleware_snippet = indent("use Airbrake::Rack::Middleware\n", indentation)
+        location = /configure :production do\n/
+
+        insert_into_file('config/environment.rb', after: location) do
+          "#{require_snippet}#{middleware_snippet}\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>AIRBRAKE_PROJECT_ID</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Airbrake project ID. Refer to the project's settings page in Airbrake</td>
+          </tr>
+          <tr>
+              <td>AIRBRAKE_PROJECT_KEY</td>
+              <td>Production Only</td>
+              <td>None</td>
+              <td>Airbrake project key. Refer to the project's settings page in Airbrake</td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        text = <<~TEXT
+
+          Gemfile updated... don't forget to 'bundle install'
+
+          You can configure a Airbrake settings in `config/airbrake.rb`. By
+          default Airbrake is set to only be used in production environments.
+          Don't forget to set your `AIRBRAKE_PROJECT_ID` and `AIRBRAKE_PROJECT_KEY`.
+        TEXT
+
+        say text, :green
+      end
+    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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Heroku deployment support.
+    #
+    class Heroku < ::Hoboken::Group
+      def slugignore
+        create_file('.slugignore') do
+          "spec\ntags\n/test\n/tmp"
+        end
+      end
+
+      def fix_stdout_for_logging
+        insert_into_file('config.ru', after: /# frozen_string_literal: true/) do
+          "\n\n$stdout.sync = true"
+        end
+      end
+
+      def reminders
+        say <<~TEXT
+          Ready to deploy to Heroku. See the Heroku docs[1] for details.
+
+          [1]: https://devcenter.heroku.com/articles/rack
+        TEXT
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/internationalization.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Internationalization support using sinatra-r18n.
+    #
+    class Internationalization < ::Hoboken::Group
+      def add_gem
+        gem 'sinatra-r18n', version: '5.0'
+        insert_into_file('app.rb', after: %r{require 'sinatra('|/base')}) do
+          "\nrequire 'sinatra/r18n'"
+        end
+        insert_into_file('config/environment.rb', after: /register Sinatra::Flash/) do
+          "\n      register Sinatra::R18n"
+        end
+      end
+
+      def translations
+        empty_directory('i18n')
+        template('hoboken/templates/en.yml.tt', 'i18n/en.yml')
+      end
+
+      def reminders
+        say "\nGemfile updated... don't forget to 'bundle install'"
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/metrics.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Add metrics (flog, flay, simplecov).
+    #
+    class Metrics < ::Hoboken::Group
+      def add_gems
+        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')
+      end
+
+      def simplecov_test_unit
+        return if rspec?
+
+        insert_into_file 'test/test_helper.rb', before: snippet_location do
+          snippet('test')
+        end
+      end
+
+      def simplecov_rspec
+        return unless rspec?
+
+        insert_into_file 'spec/spec_helper.rb', before: snippet_location do
+          snippet('spec')
+        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 '/db/migrate/'
+            add_filter '/#{framework_folder}/'
+            coverage_dir 'tmp/coverage'
+          end
+
+        CODE
+      end
+
+      def snippet_location
+        %r{require_relative '\.\./config/environment'}
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/omniauth.rb

@@ -0,0 +1,174 @@
+# 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: ')
+        gem gem_name, version: provider_version
+      end
+
+      def setup_middleware
+        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
+
+        indentation = classic? ? 2 : 6
+        location = /use Rack::Session::Cookie.+\n/
+        insert_into_file('config/environment.rb', after: location) do
+          "\n#{indent(snippet, indentation)}\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def add_routes
+        routes = <<~CODE
+
+          get '/login' do
+            '<a href="/auth/#{provider}">Login</a>'
+          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
+
+        if classic?
+          append_file('app.rb', routes)
+        else
+          inject_into_class('app.rb', 'App') { indent(routes, 4) }
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      def add_tests
+        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'
+    assert_equal('<a href="/auth/#{provider}">Login</a>', last_response.body)
+  end
+
+  test 'GET /auth/#{provider}/callback' do
+    auth_hash = {
+      provider: '#{provider}',
+      uid: '123545',
+      info: {
+        name: 'John Doe'
+      }
+    }
+
+    OmniAuth.config.mock_auth[:#{provider}] = auth_hash
+    get '/auth/#{provider}/callback'
+    assert_equal(MultiJson.encode(auth_hash), last_response.body)
+  end
+
+  test 'GET /auth/failure' do
+    OmniAuth.config.mock_auth[:#{provider}] = :invalid_credentials
+    get '/auth/failure'
+    assert_response :not_authorized
+  end
+
+          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 Metrics/BlockLength
+            RSpec.describe 'omniauth', rack: true do
+              before { OmniAuth.config.test_mode = true }
+
+              describe 'GET /login' do
+                before { 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 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 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 Metrics/BlockLength
+          CODE
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        say "\nGemfile updated... don't forget to 'bundle install'"
+      end
+
+      private
+
+      def gem_name
+        "omniauth-#{provider}"
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/rubocop.rb

@@ -0,0 +1,46 @@
+# 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-performance', version: '1.13', 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?
+        gem 'rubocop-sequel', version: '0.2', group: %i[development test] if sequel?
+      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
+
+            begin
+              require 'rubocop/rake_task'
+              RuboCop::RakeTask.new
+            # rubocop:disable Lint/SuppressedException
+            rescue LoadError
+            end
+            # rubocop:enable Lint/SuppressedException
+          TEXT
+        end
+      end
+
+      def ci_task
+        task_list = if rspec?
+                      '%w[spec rubocop]'
+                    else
+                      "['test:all', 'rubocop']"
+                    end
+        gsub_file('Rakefile', /task ci:.*/, "task ci: #{task_list}")
+      end
+    end
+  end
+end

data/lib/hoboken/add_ons/sequel.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Hoboken
+  module AddOns
+    # Database access via Sequel gem.
+    #
+    class Sequel < ::Hoboken::Group
+      def add_gems
+        gem 'sequel', version: '5.43'
+        gem 'sqlite3', version: '1.4', group: %i[development test]
+        gem 'rubocop-sequel', version: '0.2', group: %i[development test] if rubocop?
+      end
+
+      def setup_directories
+        empty_directory('db/migrate')
+        empty_directory('tasks')
+        empty_directory('tmp')
+      end
+
+      def copy_rake_task
+        copy_file('hoboken/templates/sequel.rake', 'tasks/sequel.rake')
+      end
+
+      def setup_db_config
+        template('hoboken/templates/db.rb.tt', 'config/db.rb')
+      end
+
+      def require_db_config
+        location = %r{require_relative '\.\./app'}
+        insert_into_file('config/environment.rb', before: location) do
+          "require_relative 'db'\n\n"
+        end
+      end
+
+      def setup_puma_config
+        insert_into_file('config/puma.rb', after: 'before_fork do') do
+          "\n    DB.disconnect if defined?(DB)"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def add_database_test_helper_class
+        return if rspec?
+
+        insert_into_file('test/test_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite://db/test.db'\n"
+        end
+
+        insert_into_file('test/test_helper.rb', after: %r{require 'test/unit'}) do
+          "\nrequire 'sequel'"
+        end
+
+        snippet = <<~CODE
+          def run(*args, &block)
+            result = nil
+            DB.transaction(rollback: :always) { result = super }
+            result
+          end
+        CODE
+
+        insert_into_file('test/test_helper.rb', after: /include RackHelpers\n/) do
+          "\n#{indent(snippet, 6)}"
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def add_database_spec_helper
+        return unless rspec?
+
+        insert_into_file('spec/spec_helper.rb', before: /ENV\['RACK_ENV'\] = 'test'/) do
+          "ENV['DATABASE_URL'] = 'sqlite://db/test.db'\n"
+        end
+
+        snippet = <<~CODE
+          config.around do |example|
+            DB.transaction(rollback: :always) { example.run }
+          end
+        CODE
+
+        location = /RSpec\.configure do \|config\|\n/
+        insert_into_file('spec/spec_helper.rb', after: location) do
+          "#{indent(snippet, 2)}\n"
+        end
+      end
+
+      def update_rubocop_config
+        return unless rubocop?
+
+        insert_into_file('.rubocop.yml', after: /require:\n/) do
+          "    - rubocop-sequel\n"
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def update_readme
+        snippet = <<~CODE
+          <tr>
+              <td>DATABASE_URL</td>
+              <td>Yes</td>
+              <td>
+                `sqlite://db/test.db` (for the test environment <em>only</em>)
+              </td>
+              <td>
+                Connection URL to the database. The format varies according
+                database adapter. Refer to the
+                <a href="https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html">
+                Sequel gem documentation</a> for more information. Some examples:
+                <dl>
+                  <dt>Sqlite3</dt>
+                  <dd>`sqlite://db/development.db`</dd>
+                  <dt>PostgreSQL</dt>
+                  <dd>`postgresql://localhost/myapp_development?pool=5`</dd>
+                </dl>
+              </td>
+          </tr>
+        CODE
+
+        insert_into_file('README.md', after: /<tbody>\n/) do
+          indent(snippet, 8)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reminders
+        say "\nGemfile updated... don't forget to 'bundle install'"
+        say <<~TEXT
+
+          Notes:
+            * The sqlite3 gem has been installed for dev and test environments only. You will need to specify a gem to use for production.
+            * You will need to specify an environment variable 'DATABASE_URL' (either add it to .env or export it)
+        TEXT
+      end
+    end
+  end
+end