trace_header 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 914ab944715eda159c81340d84f4368a865ca512ec57d437c1545bfec58ec300
+  data.tar.gz: 7678cc5033c4e283fe10ebddc5d68af836e60b7402a4d3fb702dba78b9946047
+SHA512:
+  metadata.gz: 4a214c910fa81a8ee6a2ef0b049cecaf589c92bc9f74ed1d3fd77500cd5b839d3813eefd12d104024baed952ec62af0c4c3f991ed542af260308f2997dd85502
+  data.tar.gz: cda2b1b11f265f691218c862e07be140ef1876ed3e55d40cefe1cbb0af23bc69bae4e18454c01ec6fad92cb99e57643529950ade306044bfc84d0bd42b994801

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in trace_header.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# TraceHeader
+
+*PLEASE DO NOT USE THIS GEM IN YOUR PRODUCTION ENVIRONMENT*
+
+Because This gem may change the behavior of your application.
+Also, this doesn't work concurrently.
+
+Use this gem only to learn about HTTP response headers and the Rack middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trace_header'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+WIP
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shioimm/trace_header.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trace_header"
+
+# 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/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/lib/trace_header/description.rb

@@ -0,0 +1,50 @@
+module Rack
+  class TraceHeader
+    module Description
+      MAXIMUM_LENGTH = 50
+
+      def display(result)
+        puts description(result)
+      end
+
+      private
+        def description(result)
+          <<~"TEXT"
+          ----------------------------------------------------
+
+          TraceHeader printing...
+
+          [Target Middleware]
+            #{result.target_app.class}\n
+          [New Headers]
+          #{detailed_description(result.new_headers)}
+          [Changed Headers]
+          #{detailed_description(result.changed_headers)}
+          ----------------------------------------------------
+          TEXT
+        end
+
+        def detailed_description(headers)
+          if headers.empty?
+            "  - Nothing added. -\n"
+          else
+            <<~"TEXT"
+              #{lined_description(headers).join("\n")}
+            TEXT
+          end
+        end
+
+        def lined_description(headers)
+          headers.flat_map do |header|
+            header.map { |field, value| "  - #{field}:  #{form(value)}" }
+          end
+        end
+
+        def form(text)
+          text.split(';').map do |str|
+            str.size > MAXIMUM_LENGTH ? str[0..MAXIMUM_LENGTH] + '...' : str
+          end.join(';')
+        end
+    end
+  end
+end

data/lib/trace_header/result.rb

@@ -0,0 +1,51 @@
+module Rack
+  class TraceHeader
+    class Result
+      attr_reader :target_app
+
+      def initialize(target_app, outputs)
+        @target_app  = target_app
+        @target_hash = outputs.find { |output| output[:middleware].eql?(target_app.class) }
+        @inner_hash  = outputs[outputs.index(@target_hash) + 1]
+      end
+
+      def new_headers
+        headers(new_fields)
+      end
+
+      def changed_headers
+        headers(changed_fields)
+      end
+
+      private
+
+        def common_fields
+          target_header.keys & prev_header.keys
+        end
+
+        def new_fields
+          target_header.keys - common_fields
+        end
+
+        def changed_fields
+          common_fields.select { |field| target_header[field] != prev_header[field] }
+        end
+
+        def target_header
+          @target_header ||= rack_app(@target_hash)[1]
+        end
+
+        def prev_header
+          @prev_header ||= rack_app(@inner_hash)[1]
+        end
+
+        def rack_app(hash)
+          hash[:app].call(hash[:env])
+        end
+
+        def headers(fields)
+          fields.map { |field| { field => target_header[field].to_s } }
+        end
+    end
+  end
+end

data/lib/trace_header/version.rb

@@ -0,0 +1,3 @@
+module TraceHeader
+  VERSION = "0.1.0"
+end

data/lib/trace_header.rb

@@ -0,0 +1,52 @@
+require 'trace_header/version'
+require 'active_support/core_ext'
+require_relative 'trace_header/description'
+require_relative 'trace_header/result'
+
+module Rack
+  class TraceHeader
+    include Description
+
+    def initialize(app)
+      @app       = app
+      @outputs   = []
+      @fixed_app = nil
+    end
+
+    def call(env)
+      tracer.enable { @app.call(env) }
+      display(result)
+      @fixed_app
+    end
+
+    private
+      using Module.new {
+        refine TracePoint do
+          def called_rack_middleware?
+            method_id.eql?(:call) && binding.local_variable_defined?(:env)
+          end
+        end
+      }
+
+      def tracer
+        TracePoint.new(:call, :return) do |tp|
+          if tp.called_rack_middleware?
+            if tp.event.eql?(:call) \
+              && !@outputs.find { |input| input[:middleware].eql? tp.defined_class }
+              @outputs << { middleware: tp.defined_class,
+                            app: tp.self.deep_dup,
+                            env: tp.binding.local_variable_get(:env).deep_dup }
+            end
+
+            if tp.event.eql?(:return)
+              @fixed_app = tp.return_value
+            end
+          end
+        end
+      end
+
+      def result
+        Rack::TraceHeader::Result.new(@app, @outputs)
+      end
+  end
+end

data/trace_header.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "trace_header/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trace_header"
+  spec.version       = TraceHeader::VERSION
+  spec.authors       = ["Misaki Shioi"]
+  spec.email         = ["shioi.mm@gmail.com"]
+
+  spec.summary       = %q{To inspect how the response headers would be changed by Rack middleware}
+  spec.description   = %q{TraceHedaer is to inspect how the response headers would be changed by Rack middleware, and display them in your terminal.}
+  spec.homepage      = "https://github.com/shioimm/trace_header"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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_dependency 'active_support'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: trace_header
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Misaki Shioi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: TraceHedaer is to inspect how the response headers would be changed by
+  Rack middleware, and display them in your terminal.
+email:
+- shioi.mm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trace_header.rb
+- lib/trace_header/description.rb
+- lib/trace_header/result.rb
+- lib/trace_header/version.rb
+- trace_header.gemspec
+homepage: https://github.com/shioimm/trace_header
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: To inspect how the response headers would be changed by Rack middleware
+test_files: []