rrx_dev 0.1.2

data/README.md

@@ -0,0 +1,45 @@
+# RRXDev
+
+Opinionated core development dependencies and configuration for Ruby on Rails projects
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rrx_dev
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rrx_dev
+
+After installation, instrument your project by running `rrx_dev_setup`
+
+```shell
+# For Rails apps
+rrx_dev_setup app
+
+# For Rails gems
+rrx_dev_setup gem
+```
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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/dan-drew/rrx_dev. 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/dan-drew/rrx_dev/blob/main/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 RrxDev project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dan-drew/rrx_dev/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/rubocop.yml

@@ -0,0 +1,142 @@
+##
+# Extensions
+require:
+- rubocop-rails
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1.0
+  Exclude:
+    - 'xspecx/**/*'
+    - 'bin/**/*'
+    - 'lib/**/version.rb'
+    - 'Gemfile'
+    - 'db/schema.rb'
+
+##
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+##
+# Layout
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+##
+# Lint
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+##
+# Metric
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+##
+# Naming
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+##
+# Rails
+Rails/DynamicFindBy:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/CreateTableWithTimestamps:
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+##
+# Security
+Security/Eval:
+  Exclude:
+    - 'Gemfile'

data/exe/rrx_dev_setup

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'pathname'
+
+class Setup < Thor
+  include Thor::Actions
+
+  GEM_SPEC_APP_NAME = 'dummy'
+  GEM_SPEC_APP_ROOT = 'spec/dummy'
+
+  def self.exit_on_failure?
+    true
+  end
+
+  def self.source_root
+    File.join(__dir__, 'sources')
+  end
+
+  desc 'app', 'Initialize a new Rails app'
+
+  def app
+    editorconfig
+    rubocop
+    rspec
+    environment
+    instructions
+  end
+
+  desc 'gem', 'Initialize a new Rails gem'
+
+  def gem
+    @gem = true
+    app
+  end
+
+  private
+
+  def gem?
+    @gem
+  end
+
+  def editorconfig
+    copy_file 'editorconfig', '.editorconfig'
+  end
+
+  def rubocop
+    copy_file 'rubocop.yml', '.rubocop.yml'
+  end
+
+  def app_root
+    @app_root ||= Pathname(gem? ? GEM_SPEC_APP_ROOT : '')
+  end
+
+  def app_config
+    @app_config ||= app_root.join('config')
+  end
+
+  def app_environments
+    @app_environments ||= app_config.join('environments')
+  end
+
+  def environment
+    directory 'config', app_config
+  end
+
+  def rspec
+    copy_file 'rspec', '.rspec'
+    empty_directory 'spec/factories'
+    empty_directory 'spec/support'
+    empty_directory 'spec/models'
+    empty_directory 'spec/requests'
+    copy_file 'spec/spec_helper.rb'
+
+    # Override rails_helper and make sure it loads the Rails environment for the app
+    # or the gem's spec dummy app
+    copy_file 'spec/rails_helper.rb' do |content|
+      content.sub '../config/environment', "../#{app_config}/environment"
+    end
+
+    create_spec_app if gem?
+  end
+
+  ##
+  # Create a dummy Rails app for testing
+  def create_spec_app
+    in_root do
+      unless Dir.exist?(GEM_SPEC_APP_ROOT)
+        inside('spec') do
+          run 'rails new --api -G --skip-docker -M --skip-active-job --skip-bootsnap -C -A -J -T -B dummy'
+        end
+        %w[development test production].each do |environment|
+          remove_file app_environments.join("#{environment}.rb")
+        end
+      end
+    end
+  end
+
+  def instructions
+    puts <<~DOC
+
+      ## Fixing/linting with Rubocop
+
+      ### RubyMine: Run Rubocop autocorrect on save
+
+      1. Go to File > Settings > Editor > Inspections
+      1. Search for 'Rubocop'
+      1. Check the box next to "Run 'rubocop -a' on save"
+
+      ref: https://www.jetbrains.com/help/ruby/rubocop.html
+
+    DOC
+  end
+end
+
+Setup.start

data/exe/sources/config/environments/development.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/integer/time'
+
+Rails.application.configure do
+  config.cache_classes = false
+  config.eager_load = false
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+    config.cache_store = :null_store
+  end
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/exe/sources/config/environments/production.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/integer/time'
+
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = true
+  config.consider_all_requests_local = false
+
+  config.cache_store = :memory_store, { size: 64.megabytes }
+
+  config.active_support.deprecation = :notify
+  config.active_support.disallowed_deprecation = :log
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/exe/sources/config/environments/test.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext/integer/time'
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  config.cache_classes = false
+  config.eager_load = false
+  config.consider_all_requests_local       = true
+  config.cache_store = :null_store
+  config.action_dispatch.show_exceptions = false
+  config.active_support.deprecation = :stderr
+  config.active_support.disallowed_deprecation = :raise
+  config.active_support.disallowed_deprecation_warnings = []
+  config.action_controller.perform_caching = false
+  config.action_controller.allow_forgery_protection = false
+end

data/exe/sources/editorconfig

@@ -0,0 +1,109 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 120
+tab_width = 2
+ij_continuation_indent_size = 4
+ij_formatter_off_tag = @formatter:off
+ij_formatter_on_tag = @formatter:on
+ij_formatter_tags_enabled = true
+ij_smart_tabs = false
+ij_visual_guides = 
+ij_wrap_on_typing = false
+
+[.editorconfig]
+ij_editorconfig_align_group_field_declarations = false
+ij_editorconfig_space_after_colon = false
+ij_editorconfig_space_after_comma = true
+ij_editorconfig_space_before_colon = false
+ij_editorconfig_space_before_comma = false
+ij_editorconfig_spaces_around_assignment_operators = true
+
+[{*.bash,*.sh,*.zsh}]
+ij_shell_binary_ops_start_line = false
+ij_shell_keep_column_alignment_padding = false
+ij_shell_minify_program = false
+ij_shell_redirect_followed_by_space = false
+ij_shell_switch_cases_indented = false
+ij_shell_use_unix_line_separator = true
+
+[{*.gemspec,*.jbuilder,*.rake,*.rb,*.rbi,*.rbw,*.ru,*.thor,.simplecov,capfile,gemfile,guardfile,isolate,rakefile,steepfile,vagrantfile}]
+ij_ruby_align_group_field_declarations = true
+ij_ruby_align_multiline_parameters = true
+ij_ruby_blank_lines_around_class = 1
+ij_ruby_blank_lines_around_method = 1
+ij_ruby_chain_calls_alignment = 2
+ij_ruby_convert_brace_block_by_enter = true
+ij_ruby_empty_declarations_style = 1
+ij_ruby_force_newlines_around_visibility_mods = true
+ij_ruby_indent_private_methods = false
+ij_ruby_indent_protected_methods = false
+ij_ruby_indent_public_methods = false
+ij_ruby_indent_visibility_modifiers = true
+ij_ruby_indent_when_cases = false
+ij_ruby_keep_blank_lines_in_code = 1
+ij_ruby_keep_blank_lines_in_declarations = 1
+ij_ruby_keep_line_breaks = true
+ij_ruby_parentheses_around_method_arguments = true
+ij_ruby_spaces_around_assignment_operators = true
+ij_ruby_spaces_around_hashrocket = true
+ij_ruby_spaces_around_other_operators = true
+ij_ruby_spaces_around_pow_operators = true
+ij_ruby_spaces_around_range_operators = false
+ij_ruby_spaces_around_relational_operators = true
+ij_ruby_spaces_within_array_initializer_braces = true
+ij_ruby_spaces_within_braces = true
+ij_ruby_spaces_within_pipes = false
+ij_ruby_use_external_formatter = false
+
+[{*.har,*.json}]
+ij_json_array_wrapping = split_into_lines
+ij_json_keep_blank_lines_in_code = 0
+ij_json_keep_indents_on_empty_lines = false
+ij_json_keep_line_breaks = true
+ij_json_keep_trailing_comma = false
+ij_json_object_wrapping = split_into_lines
+ij_json_property_alignment = do_not_align
+ij_json_space_after_colon = true
+ij_json_space_after_comma = true
+ij_json_space_before_colon = false
+ij_json_space_before_comma = false
+ij_json_spaces_within_braces = false
+ij_json_spaces_within_brackets = false
+ij_json_wrap_long_lines = false
+
+[{*.markdown,*.md}]
+ij_markdown_force_one_space_after_blockquote_symbol = true
+ij_markdown_force_one_space_after_header_symbol = true
+ij_markdown_force_one_space_after_list_bullet = true
+ij_markdown_force_one_space_between_words = true
+ij_markdown_format_tables = true
+ij_markdown_insert_quote_arrows_on_wrap = true
+ij_markdown_keep_indents_on_empty_lines = false
+ij_markdown_keep_line_breaks_inside_text_blocks = true
+ij_markdown_max_lines_around_block_elements = 1
+ij_markdown_max_lines_around_header = 1
+ij_markdown_max_lines_between_paragraphs = 1
+ij_markdown_min_lines_around_block_elements = 1
+ij_markdown_min_lines_around_header = 1
+ij_markdown_min_lines_between_paragraphs = 1
+ij_markdown_wrap_text_if_long = true
+ij_markdown_wrap_text_inside_blockquotes = true
+
+[{*.yaml,*.yml}]
+ij_yaml_align_values_properties = do_not_align
+ij_yaml_autoinsert_sequence_marker = true
+ij_yaml_block_mapping_on_new_line = false
+ij_yaml_indent_sequence_value = true
+ij_yaml_keep_indents_on_empty_lines = false
+ij_yaml_keep_line_breaks = true
+ij_yaml_sequence_on_new_line = false
+ij_yaml_space_before_colon = false
+ij_yaml_spaces_within_braces = true
+ij_yaml_spaces_within_brackets = true

data/exe/sources/rspec

@@ -0,0 +1 @@
+--require rails_helper

data/exe/sources/rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rrx_dev: config/rubocop.yml
+
+##
+# Add project specific cops below

data/exe/sources/spec/rails_helper.rb

@@ -0,0 +1,28 @@
+# Standard rails_helper.rb
+# DO NOT MODIFY
+
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../config/environment', __dir__)
+# Prevent database truncation if the environment is production
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+require 'rspec/rails'
+
+# Pre-load support files
+require 'rrx_dev/spec'
+Dir[Rails.root.join('spec/support/**/*.rb')].sort.each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  Rails.logger.debug e.to_s.strip
+  exit 1 # rubocop:disable Rails/Exit
+end
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/exe/sources/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# Standard spec_helper.rb
+# DO NOT MODIFY
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/exe/sources/spec/swagger_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'didja_rails/rswag'
+
+swagger do
+  # List Swagger documents that will be generates by specs/integration tests
+  # NOTE: This MUST be kept in sync with config/initializers/api_docs.rb
+
+  # Add reusable schemas as additional hash parameters
+  #
+  # Example
+  #   doc 'v2/swagger.yaml', 'API v1', 'v1',
+  #     my_type: object(
+  #       prop_one: string
+  #     ),
+  #     other_type: object(
+  #       prop_two: integer
+  #     )
+  #
+  doc 'v1/swagger.yaml', 'API v1', 'v1'
+
+  # Add more docs for additional API versions
+  #
+  # doc 'v2/swagger.yaml', 'API v2', 'v2'
+end

data/lib/generators/swagger_generator.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module RrxDev
+  class SwaggerGenerator < Base
+    def generate!
+      copy_new_file 'spec/swagger_helper.rb'
+      copy_new_file 'config/initializers/api_docs.rb'
+      empty_directory 'spec/integration'
+    end
+  end
+end

data/lib/rrx_dev/rswag.rb

@@ -0,0 +1,75 @@
+# Rswag schema helpers
+
+def ref(to)
+  { '$ref': "#/components/schemas/#{to}" }
+end
+
+def object(optional: {}, additional: false, **properties)
+  {
+    type:                 :object,
+    required:             properties.keys.map(&:to_s),
+    properties:           properties.update(optional),
+    additionalProperties: additional
+  }.freeze
+end
+
+def prop_type(type, description = nil, **options)
+  t = { type: }.update(options)
+  t[:description] = description if description
+  t.freeze
+end
+
+def integer(description = nil)
+  prop_type :integer, description
+end
+
+def string(description = nil, **options)
+  prop_type :string, description, **options
+end
+
+def date_time(description = nil)
+  string description, format: :dateTime
+end
+
+def boolean(description = nil)
+  prop_type :boolean, description
+end
+
+def array(type, description = nil)
+  prop_type :array, description, items: type
+end
+
+def enum(vals, description = nil)
+  string description, enum: vals
+end
+
+class SwaggerConfig
+  def initialize
+    @docs = {}
+  end
+
+  def doc(file, name, version, **schemas)
+    @docs[file] = {
+      openapi:    '3.0.1',
+      info:       {
+        title:   name,
+        version:
+      },
+      components: { schemas: }
+    }
+  end
+
+  def config
+    RSpec.configure do |config|
+      config.swagger_root = Rails.root.join('swagger').to_s
+      config.swagger_format = :yaml
+      config.swagger_docs = @docs
+    end
+  end
+end
+
+def swagger(&block)
+  swagger_config = SwaggerConfig.new
+  swagger_config.instance_exec(&block)
+  swagger_config.config
+end

data/lib/rrx_dev/spec/factory_bot.rb

@@ -0,0 +1,9 @@
+require 'factory_bot_rails'
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end
+
+module Spec
+  module FactoryBot; end
+end

data/lib/rrx_dev/spec/global.rb

@@ -0,0 +1,25 @@
+require 'rspec/parameterized'
+
+module Global
+  def self.included(other)
+    other.let(:json_body) do
+      JSON.parse(response.body, object_class: HashWithIndifferentAccess)
+    end
+
+    other.let(:json_response) do
+      expect(response).to be_successful
+      json_body
+    end
+
+    other.let(:json_error) do
+      expect(response).not_to be_successful
+      json_body
+    end
+
+  end
+end
+
+RSpec.configure do |config|
+  config.include ActiveSupport::Testing::Assertions
+  config.include Global
+end