i18n-instrument 1.0.0

data/spec/ruby_middleware_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe I18n::Instrument::Middleware, type: :request do
+  let(:recorded_params) { [] }
+  let(:config) { I18n::Instrument.config }
+  let(:control_file) do
+    File.join('spec', 'config', 'enable_i18n_instrumentation')
+  end
+
+  before(:each) do
+    I18n::Instrument.configure do |config|
+      config.on_record { |params| recorded_params << params }
+    end
+  end
+
+  def with_control_file
+    FileUtils.touch(control_file)
+    yield
+  ensure
+    File.unlink(control_file)
+  end
+
+  it "with default enable behavior, is disabled if the control file doesn't exist" do
+    expect { get('/tests') }.to_not change { recorded_params.size }.from(0)
+  end
+
+  it "with default enable behavior, is enabled if the control file exists" do
+    with_control_file do
+      expect { get('/tests') }.to change { recorded_params.size }.from(0).to(1)
+    end
+  end
+
+  context 'with instrumentation enabled' do
+    before(:each) do
+      config.on_check_enabled { true }
+    end
+
+    it 'records ruby I18n.t calls' do
+      expect { get('/tests') }.to change { recorded_params.size }.from(0).to(1)
+      expect(response).to be_success
+      params = recorded_params.first
+
+      expect(params[:source]).to eq('ruby')
+      expect(params[:trace]).to include('app/controllers/tests_controller.rb')
+      expect(params[:url]).to eq('/tests')
+      expect(params[:key]).to eq('en.foo.bar')
+      expect(params[:locale]).to eq('en')
+    end
+
+    it 'by default, renders a 500 for errors that happen during lookup' do
+      config.on_record { raise 'jelly beans' }
+      get '/tests'
+      expect(response).to_not be_success
+    end
+
+    # @TODO
+    it 'by default, renders a 500 for for errors that happen in the middleware stack' do
+      expect_any_instance_of(I18n::Instrument::Middleware).to(
+        receive(:handle_regular_request).and_raise('jelly beans')
+      )
+
+      get '/tests'
+      expect(response).to_not be_success
+    end
+
+    context 'with errors recorded' do
+      let(:recorded_errors) { [] }
+
+      before(:each) do
+        config.on_error { |e| recorded_errors << e }
+      end
+
+      it 'reports errors that happen during lookup' do
+        config.on_record { raise 'jelly beans' }
+        expect { get('/tests') }.to change { recorded_errors.size }.from(0).to(1)
+        expect(recorded_errors.first.message).to eq('jelly beans')
+        expect(response).to be_success
+      end
+
+      it 'reports errors that happen during the middleware stack' do
+        expect_any_instance_of(I18n::Instrument::Middleware).to(
+          receive(:handle_regular_request).and_raise('jelly beans')
+        )
+
+        expect { get '/tests' }.to change { recorded_errors.size }.from(0).to(1)
+        expect(response).to be_success
+      end
+    end
+  end
+
+  context 'with instrumentation disabled' do
+    before(:each) do
+      config.on_check_enabled { false }
+    end
+
+    it "doesn't record ruby I18n.t calls" do
+      expect { get('/tests') }.to_not change { recorded_params.size }.from(0)
+      expect(response).to be_success
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+$:.push(File.dirname(__FILE__))
+
+require 'pry-byebug'
+
+require 'rails'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+require 'rspec'
+require 'rspec/rails'
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'i18n/instrument'
+
+Dir.chdir('spec') do
+  require File.expand_path('../config/application', __FILE__)
+  I18n::Instrument::DummyApplication.initialize!
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: i18n-instrument
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n-debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Instrument calls to I18n.t in Ruby and JavaScript.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- i18n-instrument.gemspec
+- lib/assets/javascripts/i18n/instrument.js.erb
+- lib/i18n/instrument.rb
+- lib/i18n/instrument/configurator.rb
+- lib/i18n/instrument/middleware.rb
+- lib/i18n/instrument/railtie.rb
+- lib/i18n/instrument/version.rb
+- spec/Rakefile
+- spec/app/controllers/tests_controller.rb
+- spec/config/application.rb
+- spec/config/initializers/i18n_instrument.rb
+- spec/config/initializers/secret_token.rb
+- spec/config/routes.rb
+- spec/javascript_middleware_spec.rb
+- spec/log/development.log
+- spec/log/test.log
+- spec/ruby_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lumoslabs/i18n-instrument
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Instrument calls to I18n.t in Ruby and JavaScript.
+test_files: []