Remove direct dependency on Rails, keep ActiveSupport (#19)

* starting point, stubbing out the things we're borrowing from Rails

* everything working except no-rails

* make it work without rails but with activesupport

* clean up

* added some notes to the readme

* missing docs

* ensure top-level

* switch to railtie

* it actually loads rails

* remove silly env vars

* restore version constraint for activesupport

* update readme

* cleaner rails OR not-rails impl

* add sinatra example

Author: samandmoore

.travis.yml

@@ -7,6 +7,7 @@ gemfile:
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
   - gemfiles/rails_5_1.gemfile
+  - gemfiles/ruby.gemfile
 before_install:
   - gem update --system
   - gem update bundler

Appraisals

@@ -1,12 +1,23 @@
 appraise 'rails-4-2' do
   gem 'rails', '~> 4.2.0'
+  gem 'jdbc-sqlite3', platforms: :jruby
   gem 'activerecord-jdbcsqlite3-adapter', '~> 1.3.24', platforms: :jruby
+  gem 'sqlite3', '~> 1.3.10', platforms: :ruby
 end
 
 appraise 'rails-5-0' do
   gem 'rails', '~> 5.0.0'
+  gem 'jdbc-sqlite3', platforms: :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'sqlite3', '~> 1.3.10', platforms: :ruby
 end
 
 appraise 'rails-5-1' do
   gem 'rails', '~> 5.1.0'
+  gem 'jdbc-sqlite3', platforms: :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'sqlite3', '~> 1.3.10', platforms: :ruby
+end
+
+appraise 'ruby' do
 end

Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
 
 gemspec
-
-gem 'jdbc-sqlite3', platforms: :jruby
-gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
-gem 'sqlite3', '~> 1.3.10', platforms: :ruby

README.md

@@ -18,7 +18,8 @@ Check out [the Rails at Scale talk](https://www.youtube.com/watch?v=Nd9hnffxCP8)
 
 ## Getting Started
 
-WebValve is designed to work with Rails 4+.
+WebValve is designed to work with Rails 4+, but it also should work with
+non-Rails apps and gems.
 
 ### Installation
 
@@ -75,6 +76,8 @@ This will drop a new file in your config directory.
 # WebValve.whitelist_url 'https://example.com'
 ```
 
+If you're not using Rails, you can create this file for yourself.
+
 ### Registering a service
 
 Next, you will want create a `FakeService` and register
@@ -113,6 +116,9 @@ And it will automatically register it in `config/webvalve.rb`
 WebValve.register FakeBank
 ```
 
+Again, if you're not using Rails, you'll have to create this file
+yourself and update the config file manually.
+
 You'll also want to define an environment variable for the base url of
 your service.
 
@@ -141,7 +147,7 @@ have to configure WebValve at the beginning of each test. For RSpec, there
 is a configuration provided. 
 
 ```ruby
-# spec/rails_helper.rb
+# spec/spec_helper.rb
 require 'webvalve/rspec'
 ```
 
@@ -202,6 +208,13 @@ environments; however, it can be enabled in other environments by
 setting `WEBVALVE_ENABLED=true`. This can be useful for spinning up
 cheap, one-off environments for user-testing or demos.
 
+> Can I use WebValve without Rails?
+
+Yep! If you're not using Rails, you'll have to load the config file
+yourself. You will want to explicitly `require` each of your fake
+services in your `config/webvalve.rb`, `require` your config file, and
+call `WebValve.setup`  during your app's boot-up process.
+
 ## How to Contribute
 
 We would love for you to contribute! Anything that benefits the majority

Rakefile

@@ -4,25 +4,18 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
 Bundler::GemHelper.install_tasks
 
-if Rails.env.development? || Rails.env.test?
-  if defined? Dummy
-    task(:default).clear
-    if ENV['APPRAISAL_INITIALIZED'] || ENV['TRAVIS']
-      require 'rspec/core'
-      require 'rspec/core/rake_task'
-      RSpec::Core::RakeTask.new(:spec)
-      task default: :spec
-    else
-      require 'appraisal'
-      Appraisal::Task.new
-      task default: :appraisal
-    end
-  end
+task(:default).clear
+if ENV['APPRAISAL_INITIALIZED'] || ENV['TRAVIS']
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+else
+  require 'appraisal'
+  Appraisal::Task.new
+  task default: :appraisal
 end
 
 require 'yard'

examples/sinatra/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'sinatra'
+gem 'webvalve', path: '../../'

examples/sinatra/app.rb

@@ -0,0 +1,8 @@
+require 'sinatra'
+require 'net/http'
+require './config/webvalve'
+WebValve.setup
+
+get '/' do
+  Net::HTTP.get('faketwitter.test', '/')
+end

examples/sinatra/config.ru

@@ -0,0 +1,3 @@
+require './app'
+
+run Sinatra::Application

examples/sinatra/config/webvalve.rb

@@ -0,0 +1,4 @@
+require 'webvalve'
+require_relative '../webvalve/fake_twitter'
+
+WebValve.register FakeTwitter, url: FakeTwitter::URL

examples/sinatra/webvalve/fake_twitter.rb

@@ -0,0 +1,7 @@
+class FakeTwitter < WebValve::FakeService
+  URL = 'http://faketwitter.test'.freeze
+
+  get '/' do
+    json hello: 'world'
+  end
+end

gemfiles/rails_4_2.gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
+gem "rails", "~> 4.2.0"
 gem "jdbc-sqlite3", platforms: :jruby
 gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.24", platforms: :jruby
 gem "sqlite3", "~> 1.3.10", platforms: :ruby
-gem "rails", "~> 4.2.0"
 
 gemspec path: "../"

gemfiles/rails_5_0.gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
+gem "rails", "~> 5.0.0"
 gem "jdbc-sqlite3", platforms: :jruby
 gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
 gem "sqlite3", "~> 1.3.10", platforms: :ruby
-gem "rails", "~> 5.0.0"
 
 gemspec path: "../"

gemfiles/rails_5_1.gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
+gem "rails", "~> 5.1.0"
 gem "jdbc-sqlite3", platforms: :jruby
 gem "activerecord-jdbcsqlite3-adapter", platforms: :jruby
 gem "sqlite3", "~> 1.3.10", platforms: :ruby
-gem "rails", "~> 5.1.0"
 
 gemspec path: "../"

gemfiles/ruby.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

lib/tasks/webvalve_tasks.rake

@@ -1,4 +1,6 @@
 require 'set'
+require 'active_support'
+require 'active_support/core_ext'
 
 module WebValve
   ALWAYS_ENABLED_ENVS = %w(development test).freeze
@@ -16,9 +18,9 @@ class << self
     delegate :setup, :register, :whitelist_url, :reset, to: :manager
 
     def enabled?
-      if Rails.env.in?(ALWAYS_ENABLED_ENVS)
+      if env.in?(ALWAYS_ENABLED_ENVS)
         if ENV.key? 'WEBVALVE_ENABLED'
-          Rails.logger.warn(<<~MESSAGE)
+          logger.warn(<<~MESSAGE)
             WARNING: Ignoring WEBVALVE_ENABLED environment variable setting (#{ENV['WEBVALVE_ENABLED']})
             WebValve is always enabled in development and test environments.
           MESSAGE
@@ -33,16 +35,36 @@ def config_paths
       @config_paths ||= Set.new
     end
 
-    private
+    if defined?(::Rails)
+      delegate :env, :env=, :logger, :logger=, to: ::Rails
+    else
+      def env
+        @env ||= (ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development').inquiry
+      end
+
+      def env=(env)
+        @env = env&.inquiry
+      end
+
+      def logger
+        @logger ||= ActiveSupport::Logger.new(STDOUT).tap do |l|
+          l.formatter = ::Logger::Formatter.new
+        end
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+    end
 
     def manager
       WebValve::Manager.instance
     end
   end
 end
 
+require 'webvalve/railtie' if defined?(::Rails)
 require 'webvalve/instrumentation'
-require 'webvalve/engine'
 require 'webvalve/fake_service'
 require 'webvalve/fake_service_wrapper'
 require 'webvalve/fake_service_config'

lib/webvalve.rb

@@ -8,7 +8,7 @@ def initialize(service:, url: nil)
     end
 
     def should_intercept?
-      Rails.env.test? || # always intercept in test
+      WebValve.env.test? || # always intercept in test
         (WebValve.enabled? && !service_enabled_in_env?)
     end
 

lib/webvalve/fake_service_config.rb

@@ -1,3 +1,5 @@
+require 'active_support/log_subscriber'
+
 module WebValve
   module Instrumentation
     class LogSubscriber < ActiveSupport::LogSubscriber

lib/webvalve/instrumentation/log_subscriber.rb

@@ -1,3 +1,5 @@
+require 'active_support/notifications'
+
 module WebValve
   module Instrumentation
     class Middleware

lib/webvalve/instrumentation/middleware.rb

@@ -50,7 +50,7 @@ def whitelisted_urls
 
     def webmock_disable_options
       { allow_localhost: true }.tap do |opts|
-        opts[:allow] = whitelisted_url_regexps unless Rails.env.test?
+        opts[:allow] = whitelisted_url_regexps unless WebValve.env.test?
       end
     end
 

lib/webvalve/manager.rb

@@ -1,17 +1,15 @@
 module WebValve
-  class Engine < ::Rails::Engine
-    isolate_namespace WebValve
-
+  class Railtie < ::Rails::Railtie
     if WebValve.enabled?
-      initializer "webvalve.set_autoload_paths", before: :set_autoload_paths do |app|
+      initializer 'webvalve.set_autoload_paths', before: :set_autoload_paths do |app|
         WebValve.config_paths << app.root
 
         WebValve.config_paths.each do |root|
           app.config.eager_load_paths << root.join('webvalve').to_s
         end
       end
 
-      initializer "webvalve.setup" do
+      initializer 'webvalve.setup' do
         WebValve.config_paths.each do |root|
           path = root.join('config', 'webvalve.rb').to_s
           load path if File.exist?(path)

lib/webvalve/engine.rb lib/webvalve/railtie.rb

@@ -1,3 +1,2 @@
 Rails.application.routes.draw do
-  mount WebValve::Engine => "/webvalve"
 end

spec/dummy/config/routes.rb

@@ -1,3 +1,11 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__) if ENV['BUNDLE_GEMFILE'] =~ /rails/
+require 'rspec'
+require 'pry'
+require 'webvalve'
+
+Dir[File.join(__dir__, 'support/**/*.rb')].each { |f| require f }
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
@@ -18,5 +26,7 @@
   config.order = :random
   Kernel.srand config.seed
 
-  # config.profile_examples = 10
+  config.profile_examples = 10
+
+  config.include Helpers
 end

spec/rails_helper.rb

@@ -15,10 +15,10 @@ def with_env(opts = {})
   end
 
   def with_rails_env(env)
-    initial_env = Rails.env
-    Rails.env = env
+    initial_env = WebValve.env
+    WebValve.env = env
     yield
   ensure
-    Rails.env = initial_env
+    WebValve.env = initial_env
   end
 end

spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 RSpec.describe WebValve::FakeServiceConfig do
   let(:fake_service) do

spec/support/helpers.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 RSpec.describe WebValve::FakeService do
   subject do

spec/webvalve/fake_service_config_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 RSpec.describe WebValve::Manager do
 

spec/webvalve/fake_service_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 RSpec.describe WebValve do
   it 'delegates .setup to manager' do