fixings 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Harry Brundage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# Fixings
+
+A Rails setup that makes you not have to think and works nice and good.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixings'
+```
+
+Add this line to your test helper:
+
+```ruby
+require 'fixings/test_help
+```
+
+Copy this file to `.rubocop.yml`
+
+```yml
+inherit_gem:
+  fixings:
+    - .rubocop.yml
+```
+
+And then set up the followings things in the app:
+
+#### Sentry (via sentry-raven)
+
+Sentry is auto included and lightly configured. Set it up for the specific application with something like this in `config/initializers/sentry.rb`:
+
+```ruby
+Raven.configure do |config|
+  if Rails.env.production?
+    config.dsn = ENV["BACKEND_SENTRY_DSN"]
+  end
+end
+```
+
+#### Log Tags (via rails-semantic-logger)
+
+Fixings sets up `rails-semantic-logger` and configures it to log to STDOUT in all environments, in plain text for development and in JSON for production.
+
+To add more details from the request context, add keys to the `config.log_tags` hash in your `config/application.rb`:
+
+```ruby
+class Application < Rails::Application
+    # ...
+    config.log_tags[:user_id] = ->(request) { request.session[:current_user_id] }
+    config.log_tags[:account_id] = ->(request) { request.session[:current_account_id] }
+end
+```
+
+#### Flipper
+
+Fixings sets up Flipper for beta flag flipping.
+
+#### VCR for testing
+
+Fixings sets up VCR for testing and configures it to run for every test case automatically. It also automatically filters the `Authorization` headers from saved cassettes. You probably have parameters you want to filter out:
+
+
+```ruby
+ENV["SHOPIFY_OAUTH_ACCESS_TOKEN"] ||= "test_access_token"
+
+VCR.configure do |config|
+  config.filter_sensitive_data("<SHOPIFY_OAUTH_ACCESS_TOKEN>") { ENV["SHOPIFY_OAUTH_ACCESS_TOKEN"] }
+
+  config.fixings_query_matcher_param_exclusions << "appsecret_proof"
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hornairs/fixings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hornairs/fixings/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fixings project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hornairs/fixings/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fixings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/lint

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -ex
+bundle exec rufo --check lib fixings.gemspec
+bundle exec rubocop

data/bin/lintfix

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -x
+bundle exec rufo lib fixings.gemspec
+bundle exec rubocop -a

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixings.gemspec

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require_relative "lib/fixings/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fixings"
+  spec.version = Fixings::VERSION
+  spec.authors = ["Harry Brundage"]
+  spec.email = ["harry.brundage@gmail.com"]
+
+  spec.summary = "Easy rails setup with infrastructure and a bunch of handy correctness pieces"
+  spec.homepage = "https://github.com/airhorns/fixings"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/airhorns/fixings"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "active_record_query_trace"
+  spec.add_runtime_dependency "annotate"
+  spec.add_runtime_dependency "ar_transaction_changes"
+  spec.add_runtime_dependency "bcrypt"
+  spec.add_runtime_dependency "flipper"
+  spec.add_runtime_dependency "flipper-active_record"
+  spec.add_runtime_dependency "flipper-active_support_cache_store"
+  spec.add_runtime_dependency "flipper-ui"
+  spec.add_runtime_dependency "health_check"
+  spec.add_runtime_dependency "letter_opener"
+  spec.add_runtime_dependency "letter_opener_web"
+  spec.add_runtime_dependency "marginalia"
+  spec.add_runtime_dependency "oj"
+  spec.add_runtime_dependency "rack-cors"
+  spec.add_runtime_dependency "rails", "~> 6.0"
+  spec.add_runtime_dependency "rails-middleware-extensions"
+  spec.add_runtime_dependency "rails_semantic_logger"
+
+  spec.add_runtime_dependency "bullet"
+  spec.add_runtime_dependency "rubocop"
+  spec.add_runtime_dependency "rubocop-performance"
+  spec.add_runtime_dependency "rubocop-rails"
+  spec.add_runtime_dependency "rufo"
+
+  spec.add_runtime_dependency "minitest-ci"
+  spec.add_runtime_dependency "minitest-snapshots"
+  spec.add_runtime_dependency "mocha"
+  spec.add_runtime_dependency "timecop"
+  spec.add_runtime_dependency "vcr"
+  spec.add_runtime_dependency "webmock"
+
+  spec.add_runtime_dependency "sentry-raven"
+end

data/lib/fixings.rake

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+  require "annotate"
+  task :set_annotation_options do # rubocop:disable Rails/RakeEnvironment
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      "additional_file_patterns" => [],
+      "routes" => "false",
+      "models" => "true",
+      "position_in_routes" => "before",
+      "position_in_class" => "before",
+      "position_in_test" => "before",
+      "position_in_fixture" => "before",
+      "position_in_factory" => "before",
+      "position_in_serializer" => "before",
+      "show_foreign_keys" => "true",
+      "show_complete_foreign_keys" => "false",
+      "show_indexes" => "true",
+      "simple_indexes" => "false",
+      "model_dir" => "app/models",
+      "root_dir" => "",
+      "include_version" => "false",
+      "require" => "",
+      "exclude_tests" => "false",
+      "exclude_fixtures" => "false",
+      "exclude_factories" => "false",
+      "exclude_serializers" => "false",
+      "exclude_scaffolds" => "true",
+      "exclude_controllers" => "true",
+      "exclude_helpers" => "true",
+      "exclude_sti_subclasses" => "false",
+      "ignore_model_sub_dir" => "false",
+      "ignore_columns" => nil,
+      "ignore_routes" => nil,
+      "ignore_unknown_models" => "false",
+      "hide_limit_column_types" => "integer,bigint,boolean",
+      "hide_default_column_types" => "json,jsonb,hstore",
+      "skip_on_db_migrate" => "false",
+      "format_bare" => "true",
+      "format_rdoc" => "false",
+      "format_markdown" => "false",
+      "sort" => "false",
+      "force" => "false",
+      "frozen" => "false",
+      "classified_sort" => "true",
+      "trace" => "false",
+      "wrapper_open" => nil,
+      "wrapper_close" => nil,
+      "with_comment" => "true",
+    )
+  end
+
+  Annotate.load_tasks
+end
+
+namespace :db do
+  desc "Truncate all existing data. Provided by the fixings gem"
+  task :truncate => "db:load_config" do
+    ActiveRecord::Base.establish_connection
+    ActiveRecord::Base.connection.tables.each do |table|
+      next if table == "schema_migrations"
+      ActiveRecord::Base.connection.execute("TRUNCATE #{table} CASCADE")
+    end
+  end
+end
+
+# frozen_string_literal: true
+require "English"
+require "optparse"
+
+namespace :job do
+  desc "Run a Que job inline. Used by other infrastructure components. Provided by the fixings gem"
+  task :run_inline => :environment do
+    options = { args: [] }
+
+    optparse = OptionParser.new do |opts|
+      opts.on("-j", "--job-class ARG", "what job class to execute") do |klass|
+        options[:job_class] = klass.constantize
+      end
+
+      opts.on("-a", "--args ARG", "JSON serialized array of arguments to pass to class") do |args|
+        options[:args] = JSON.parse(args)
+      end
+
+      opts.on("-h", "--help", "Display this screen") do
+        puts opts
+        exit
+      end
+    end
+
+    begin
+      args = optparse.order!(ARGV) { }
+      optparse.parse!(args)
+
+      mandatory = [:job_class]
+      missing = mandatory.select { |param| options[param].nil? }
+      if !missing.empty?
+        puts "Missing options: #{missing.join(", ")}"
+        puts optparse
+        exit
+      end
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+      puts $ERROR_INFO.to_s
+      puts optparse
+      exit
+    end
+
+    Rails.logger.info "Running job inline", job_class: options[:job_class], args: options[:args]
+    options[:job_class].run(*options[:args])
+    true
+  end
+end

data/lib/fixings.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "fixings/version"
+
+module Fixings
+end
+
+require "fixings/railtie" if defined?(Rails)

data/lib/fixings/app_release.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Fixings::AppRelease
+  def self.current
+    @current ||= begin
+      release_file = Rails.root.join("RELEASE").to_s
+
+      if File.exist?(release_file)
+        File.read(release_file).chomp
+      elsif ENV["RELEASE"]
+        ENV["RELEASE"]
+      else
+        "unknown"
+      end
+    end
+  end
+end

data/lib/fixings/railtie.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+require "active_record_query_trace"
+require "ar_transaction_changes"
+require "health_check"
+require "flipper"
+require "flipper-active_record"
+require "flipper-active_support_cache_store"
+require "flipper-ui"
+require "marginalia"
+require "oj"
+require "bcrypt"
+require "rails-middleware-extensions"
+require "rails_semantic_logger"
+require "rack/cors"
+require "sentry-raven"
+
+require "fixings/app_release"
+require "fixings/silent_log_middleware"
+
+if !Rails.env.production?
+  require "annotate"
+  require "bullet"
+  require "letter_opener"
+  require "letter_opener_web"
+end
+
+module Fixings
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.factory_bot suffix: "factory"
+    end
+
+    rake_tasks do
+      load "fixings.rake"
+    end
+
+    initializer "fixings.configure_active_record_query_trace" do
+      if Rails.env.development?
+        ActiveRecordQueryTrace.colorize = :light_purple
+        ActiveRecordQueryTrace.enabled = ENV["TRACE_QUERIES"].present?
+      end
+    end
+
+    initializer "fixings.configure_rack_cors_middleware" do |app|
+      app.middleware.insert_before 0, Rack::Cors do
+      end
+    end
+
+    initializer "fixings.configure_flipper" do |app|
+      Flipper.configure do |config|
+        config.default do
+          database_adapter = Flipper::Adapters::ActiveRecord.new
+          adapter = Flipper::Adapters::ActiveSupportCacheStore.new(database_adapter, Rails.cache, expires_in: 5.minutes)
+          Flipper.new(adapter)
+        end
+      end
+
+      app.middleware.use Flipper::Middleware::Memoizer
+    end
+
+    initializer "fixings.configure_sentry" do
+      Raven.configure do |config|
+        config.silence_ready = true
+        config.logger = SemanticLogger[Raven]
+
+        if Rails.env.production?
+          config.release = AppRelease.current
+        end
+      end
+    end
+
+    initializer "fixings.configure_development_logger" do |app|
+      STDOUT.sync = true
+      app.config.rails_semantic_logger.semantic = true
+
+      if Rails.env.development?
+        # Always log to stdout in development. Rails somehow magically makes this happen for the webserver but not for other processes
+        # like the jobs server
+        if SemanticLogger.appenders.all? { |appender| appender.instance_variable_get(:@log) != STDOUT }
+          pp.config.semantic_logger.add_appender(io: STDOUT, level: app.config.log_level, formatter: app.config.rails_semantic_logger.format)
+        end
+      else
+        # Use semantic_logger logging setup to log JSON to STDOUT
+        app.config.rails_semantic_logger.add_file_appender = false
+        app.config.rails_semantic_logger.format = :json
+        app.config.semantic_logger.add_appender(io: STDOUT, level: app.config.log_level, formatter: app.config.rails_semantic_logger.format)
+      end
+    end
+
+    initializer "fixings.configure_logging_middleware" do |app|
+      app.config.log_tags ||= {}
+      app.config.log_tags[:request_id] = :request_id
+      app.config.log_tags[:client_session_id] = ->(request) { request.headers["X-Client-Session-Id"] }
+
+      # Make sure that the semantic logger middleware which evaluats the above log_tags procs has a session on the request
+      app.middleware.move_after ActionDispatch::Session::CacheStore, RailsSemanticLogger::Rack::Logger, app.config.log_tags
+      app.middleware.insert_before ActionDispatch::Static, Fixings::SilentLogMiddleware, silence: ["/health_check", %r{^/assets/}, "/favicon.ico"]
+    end
+
+    initializer "fixings.configure_bullet" do
+      if Rails.env.development?
+        Bullet.enable = true
+        Bullet.rails_logger = true
+      end
+    end
+
+    initializer "fixings.docker_for_mac_web_console" do |app|
+      if Rails.env.development?
+        # Whitelist docker-for-mac ips for web console
+        app.config.web_console.permissions = ["172.18.0.0/16", "172.19.0.0/16"]
+      end
+    end
+  end
+end