exercism-config 0.33.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9e8cca313d6d01dfe39b0882911c1b7f2cb84cbf4a0808bff22f5233f35648
-  data.tar.gz: 8b4c36afd9237e51db22d8dd7f4699a4bb9187c164ba8a265e8d7a506ddc8457
+  metadata.gz: d53a8ce7ad6afe4b50df38aecc7af7708bb1a761749ac35ece53a0615da3f82b
+  data.tar.gz: 481ca893d9488040b2a7ae2ec842c922aaf8e6eae43e84cbb05933253fabf15c
 SHA512:
-  metadata.gz: 795386b3214b418f01e6945662e1496d5a1ca4ffe8fef3d3e614da19e1f20a34c11ddb2bf7f5fa23623b2d4fd6017b5013225e7089965281e77e3e517ef6a631
-  data.tar.gz: c1161d4fe4594278563dcea81dd5c6d09d13ee421855e12d74b5ea75b710f61e87f0344f7e90a0312a40c12ba39b0fe5b32c59e1819afc1e8b06cb7125735db9
+  metadata.gz: 19e81f83e28fbe70e72b9f65df2802ca0dfa83e14abc69b62166df590464e6b6c5b66cd39897b35b4073f3a111de68a566b0b90a33581faaa0169f901c6fefb9
+  data.tar.gz: c88d61bec133716c6af5a4308dd883b1a1786a85ba3d3f9b1f4bd302b1ed983181f6a450293a6b467d3f110f634d2da96e806eea5dbb128ae5423a6035b3c9aa

data/.gitignore

@@ -9,4 +9,4 @@
 node_modules/
 Gemfile.lock
 
-exercism_config-*.gem
+exercism-config-*.gem

data/.rubocop.yml

@@ -74,6 +74,10 @@ Style/ZeroLengthPredicate:
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Naming/FileName:
+  Exclude:
+    - "lib/exercism-config.rb"
+
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 

data/README.md

@@ -3,7 +3,7 @@
 ![Tests](https://github.com/exercism/config/workflows/Tests/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/513edbd6599a2de3218d/maintainability)](https://codeclimate.com/github/exercism/config/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/513edbd6599a2de3218d/test_coverage)](https://codeclimate.com/github/exercism/config/test_coverage)
-[![Gem Version](https://badge.fury.io/rb/exercism_config.svg)](https://badge.fury.io/rb/exercism_config)
+[![Gem Version](https://badge.fury.io/rb/exercism-config.svg)](https://badge.fury.io/rb/exercism-config)
 
 When terraform creates Exercism's infrastructure, it writes endpoints and DNS entries to DynamoDB.
 This gem allows you to trivially retrieve that data.
@@ -17,10 +17,9 @@ Simply include this gem in your Gemfile, require it, and then refer to the objec
 
 ```ruby
 # Gemfile
-gem 'exercism_config'
+gem 'exercism-config'
 
 # Your code
-require 'exercism_config'
+require 'exercism-config'
 ExercismConfig.config.webservers_alb_dns_name
 ```
-

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'exercism_config'
+require 'exercism-config'
 
 # 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.

data/bin/rubocop-quick

@@ -1,4 +1,4 @@
 #!/bin/bash
 
-git diff --name-status --staged | grep '^[MA]' | grep -o '\\s\\+.*rb' | xargs bundle exec rubocop --except Metrics --auto-correct --format quiet --force-exclusion lib/exercism_config.rb && \
-git diff --name-status --staged | grep '^[MA]' | grep -o '\\s\\+.*rb' | xargs git add
+git diff --name-status --staged | grep '^[MA]' | grep -o '\s\+.*rb' | xargs bundle exec rubocop --except Metrics --auto-correct --format quiet --force-exclusion lib/exercism-config.rb && \
+git diff --name-status --staged | grep '^[MA]' | grep -o '\s\+.*rb' | xargs git add

data/bin/setup_exercism_config

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'exercism_config'
+require 'exercism-config'
 require 'erb'
 require 'yaml'
 
-env = ExercismConfig::DetermineEnvironment.call
-if env == :production
+if Exercism.env.production?
   puts 'Aborted! This script should not be run in production.'
   exit
 end
@@ -17,7 +16,7 @@ def create_table(client)
     attribute_definitions: [
       {
         attribute_name: 'id',
-        attribute_type: 'S'
+        attribute_type: 'S' 
       }
     ],
     key_schema: [
@@ -71,9 +70,9 @@ settings_file =
   elsif ENV['EXERCISM_DOCKER']
     File.expand_path('../settings/docker.yml', __dir__)
   elsif ENV['EXERCISM_CI']
-    File.expand_path('../settings/test-ci.yml', __dir__)
+    File.expand_path('../settings/ci.yml', __dir__)
   else
-    File.expand_path('../settings/development.yml', __dir__)
+    File.expand_path('../settings/local.yml', __dir__)
   end
 
 puts "Using settings file: #{settings_file}"

data/bin/setup_exercism_local_aws

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 require "bundler/setup"
-require "exercism_config"
+require "exercism-config"
 
 # Only allow this to run in development
-return unless Exercism.environment == :development
+return if Exercism.env.production?
 
 puts "Create AWS/DynamoDB tables..."
 
@@ -15,7 +15,7 @@ Exercism.config.dynamodb_client = ExercismConfig::SetupDynamoDBClient.()
 
 # We don't need this running for CI atm as none of our
 # tests actually hit s3. Although we might choose to change this
-unless ENV["EXERCISM_CI"]
+unless ENV["EXERCISM_CI"] || ENV["EXERCISM_SKIP_S3"]
   begin
     ExercismConfig::SetupS3Client.().create_bucket(bucket: Exercism.config.aws_iterations_bucket)
   rescue Seahorse::Client::NetworkingError => e

data/lib/{exercism_config.rb → exercism-config.rb}

@@ -3,6 +3,7 @@ require 'mandate'
 require 'ostruct'
 require 'json'
 
+require_relative 'exercism_config/environment'
 require_relative 'exercism_config/determine_environment'
 require_relative 'exercism_config/generate_aws_settings'
 require_relative 'exercism_config/setup_dynamodb_client'
@@ -14,11 +15,15 @@ require_relative 'exercism_config/version'
 require_relative 'exercism/config'
 
 module Exercism
-  class ConfigError < RuntimeError
+  class ConfigError < RuntimeError; end
+
+  def self.env
+    @env ||= ExercismConfig::DetermineEnvironment.()
   end
 
   def self.environment
-    @environment ||= ExercismConfig::DetermineEnvironment.()
+    puts "Exercism.environment is deprecated. Use Exercism.env"
+    env
   end
 
   def self.config

data/lib/exercism/config.rb

@@ -1,12 +1,26 @@
 module Exercism
   class Config < OpenStruct
+    PROPS_WITH_TEST_SUFFIX = %i[
+      dynamodb_tooling_jobs_table
+    ].freeze
+
     def initialize(data, aws_settings)
       super(data)
       self.aws_settings = aws_settings
     end
 
+    PROPS_WITH_TEST_SUFFIX.each do |prop|
+      define_method prop do
+        Exercism.env.test? ? "#{super()}-test" : super()
+      end
+    end
+
     def to_json(*_args)
-      to_h.to_json
+      hash = to_h
+      PROPS_WITH_TEST_SUFFIX.each do |prop|
+        hash[prop] = send(prop)
+      end
+      hash.to_json
     end
   end
 end

data/lib/exercism_config/determine_environment.rb

@@ -6,11 +6,7 @@ module ExercismConfig
       env = ENV['EXERCISM_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV']
       raise Exercism::ConfigError, 'No environment set - set one of EXERCISM_ENV, RAILS_ENV or APP_ENV' unless env
 
-      unless %w[development test production].include?(env)
-        raise Exercism::ConfigError, "environment must be one of development, test or production. Got #{env}."
-      end
-
-      env.to_sym
+      Environment.new(env)
     end
   end
 end

data/lib/exercism_config/environment.rb

@@ -0,0 +1,49 @@
+module ExercismConfig
+  class Environment
+    ALLOWED_ENVS = %{development test production}
+    private_constant :ALLOWED_ENVS
+
+    def initialize(raw_env)
+      @env = raw_env.to_s
+
+      unless ALLOWED_ENVS.include?(env)
+        raise Exercism::ConfigError, "environment must be one of development, test or production. Got #{env}."
+      end
+    end
+
+    def ==(other)
+      env == other.to_s
+    end
+
+    def eql?(other)
+      env == other.to_s
+    end
+
+    def hash
+      env.hash
+    end
+
+    def to_s
+      env
+    end
+
+    def inspect
+      env
+    end
+
+    def development?
+      env == "development"
+    end
+
+    def test?
+      env == "test"
+    end
+
+    def production?
+      env == "production"
+    end
+
+    private
+    attr_reader :env
+  end
+end

data/lib/exercism_config/generate_aws_settings.rb

@@ -13,26 +13,17 @@ module ExercismConfig
 
     memoize
     def aws_access_key_id
-      case Exercism.environment
-      when :development, :test
-        'FAKE'
-      end
+      Exercism.env.production? ? nil : 'FAKE'
     end
 
     memoize
     def aws_secret_access_key
-      case Exercism.environment
-      when :development, :test
-        'FAKE'
-      end
+      Exercism.env.production? ? nil : 'FAKE'
     end
 
     memoize
     def profile
-      case Exercism.environment
-      when :production
-        'exercism_staging'
-      end
+      Exercism.env.production? ? nil : 'exercism_staging'
     end
   end
 end

data/lib/exercism_config/retrieve.rb

@@ -3,7 +3,7 @@ module ExercismConfig
     include Mandate
 
     def call
-      return generate_mock if Exercism.environment == :test
+      return generate_mock if Exercism.env.test?
 
       retrieve_from_dynamodb
     end
@@ -14,11 +14,11 @@ module ExercismConfig
       require 'yaml'
 
       filename = if ENV["EXERCISM_CI"]
-                   'test-ci'
+                   'ci'
                  elsif ENV["EXERCISM_DOCKER"]
-                   'test-docker'
+                   'docker'
                  else
-                   'test-local'
+                   'local'
                  end
 
       settings_file = File.expand_path("../../../settings/#{filename}.yml", __FILE__)
@@ -36,13 +36,6 @@ module ExercismConfig
         h[item['id']] = item['value']
       end
 
-      # Tweak things for dynamodb when we're running in test mode
-      if Exercism.environment == :test
-        %w[dynamodb_tooling_jobs_table].each do |key|
-          data[key] = "#{data[key]}-test"
-        end
-      end
-
       aws_settings = GenerateAwsSettings.()
       Exercism::Config.new(data, aws_settings)
     rescue Exercism::ConfigError

data/lib/exercism_config/setup_dynamodb_client.rb

@@ -15,14 +15,11 @@ module ExercismConfig
     end
 
     private
-    attr_reader :environment
 
     memoize
     def config_endpoint
-      return nil unless %i[development test].include?(Exercism.environment)
-      if Exercism.environment == :test && ENV['EXERCISM_CI']
-        return "http://127.0.0.1:#{ENV['DYNAMODB_PORT']}"
-      end
+      return nil if Exercism.env.production?
+      return "http://127.0.0.1:#{ENV['DYNAMODB_PORT']}" if Exercism.env.test? && ENV['EXERCISM_CI']
 
       host = ENV['EXERCISM_DOCKER'] ? 'dynamodb:8000' : 'localhost:3040'
       "http://#{host}"

data/lib/exercism_config/setup_s3_client.rb

@@ -18,11 +18,10 @@ module ExercismConfig
     end
 
     private
-    attr_reader :environment
 
     memoize
     def config_endpoint
-      return nil unless %i[development test].include?(Exercism.environment)
+      return nil if Exercism.env.production?
       return "http://127.0.0.1:#{ENV['S3_PORT']}" if ENV['EXERCISM_CI']
 
       host = ENV['EXERCISM_DOCKER'] ? 's3:9090' : 'localhost:3041'

data/lib/exercism_config/version.rb

@@ -1,3 +1,3 @@
 module ExercismConfig
-  VERSION = '0.33.0'.freeze
+  VERSION = '0.38.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exercism-config
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -147,20 +147,19 @@ files:
 - bin/setup_exercism_config
 - bin/setup_exercism_local_aws
 - exercism_config.gemspec
+- lib/exercism-config.rb
 - lib/exercism/config.rb
-- lib/exercism_config.rb
 - lib/exercism_config/determine_environment.rb
+- lib/exercism_config/environment.rb
 - lib/exercism_config/generate_aws_settings.rb
 - lib/exercism_config/retrieve.rb
 - lib/exercism_config/setup_dynamodb_client.rb
 - lib/exercism_config/setup_s3_client.rb
 - lib/exercism_config/version.rb
 - package.json
-- settings/development.yml
+- settings/ci.yml
 - settings/docker.yml
-- settings/test-ci.yml
-- settings/test-docker.yml
-- settings/test-local.yml
+- settings/local.yml
 - yarn.lock
 homepage: https://exercism.io
 licenses: []

data/settings/test-docker.yml

@@ -1,9 +0,0 @@
-anycable_redis_url: redis://some_anycable_redis_url:1234/9
-anycable_rpc_host: 1.2.3.4:9876543
-aws_iterations_bucket: some-iterations-bucket
-dynamodb_tooling_jobs_table: some_tooling_table
-spi_url: http://some_url:1234
-tooling_orchestrator_url: http://some_orchestrator_url:1234
-
-mysql_master_endpoint: mysql
-mysql_port: 3306

data/settings/test-local.yml

@@ -1,9 +0,0 @@
-anycable_redis_url: redis://some_anycable_redis_url:1234/9
-anycable_rpc_host: 1.2.3.4:9876543
-aws_iterations_bucket: some-iterations-bucket
-dynamodb_tooling_jobs_table: some_tooling_table
-spi_url: http://some_url:1234
-tooling_orchestrator_url: http://some_orchestrator_url:1234
-
-mysql_master_endpoint: localhost
-mysql_socket: /tmp/mysql.sock