webmachine 1.6.0 → 2.0.0

data/lib/webmachine/trace/fsm.rb

@@ -23,39 +23,46 @@ module Webmachine
       # Adds the request to the trace.
       # @param [Webmachine::Request] request the request to be traced
       def trace_request(request)
-        response.trace << {
-          :type => :request,
-          :method => request.method,
-          :path => request.uri.request_uri.to_s,
-          :headers => request.headers,
-          :body => request.body.to_s
-        } if trace?
+        if trace?
+          response.trace << {
+            type: :request,
+            method: request.method,
+            path: request.uri.request_uri.to_s,
+            headers: request.headers,
+            body: request.body.to_s
+          }
+        end
       end
 
       # Adds the response to the trace and then commits the trace to
       # separate storage which can be discovered by the debugger.
       # @param [Webmachine::Response] response the response to be traced
       def trace_response(response)
-        response.trace << {
-          :type => :response,
-          :code => response.code.to_s,
-          :headers => response.headers,
-          :body => trace_response_body(response.body)
-        } if trace?
+        if trace?
+          response.trace << {
+            type: :response,
+            code: response.code.to_s,
+            headers: response.headers,
+            body: trace_response_body(response.body)
+          }
+        end
       ensure
-        Webmachine::Events.publish('wm.trace.record', {
-          :trace_id => resource.object_id.to_s,
-          :trace => response.trace
-        }) if trace?
+        if trace?
+          Webmachine::Events.publish('wm.trace.record', {
+            trace_id: resource.object_id.to_s,
+            trace: response.trace
+          })
+        end
       end
 
       # Adds a decision to the trace.
       # @param [Symbol] decision the decision being processed
       def trace_decision(decision)
-        response.trace << {:type => :decision, :decision => decision} if trace?
+        response.trace << {type: :decision, decision: decision} if trace?
       end
 
       private
+
       # Works around streaming encoders where possible
       def trace_response_body(body)
         case body

data/lib/webmachine/trace/resource_proxy.rb

@@ -14,7 +14,7 @@ module Webmachine
       # including body-producing or accepting methods, encoders and
       # charsetters.
       CALLBACK_REFERRERS = [:content_types_accepted, :content_types_provided,
-                            :encodings_provided, :charsets_provided]
+        :encodings_provided, :charsets_provided]
 
       # Creates a {ResourceProxy} that decorates the passed
       # {Webmachine::Resource} such that callbacks invoked by the
@@ -46,6 +46,7 @@ module Webmachine
       end
 
       private
+
       # Proxy a given callback to the inner resource, decorating with traces
       def proxy_callback(callback, *args)
         # Log inputs and attempt
@@ -56,20 +57,20 @@ module Webmachine
         resource.response.trace << result(_result)
         _result
       rescue => exc
-        exc.backtrace.reject! {|s| s.include?(__FILE__) }
+        exc.backtrace.reject! { |s| s.include?(__FILE__) }
         resource.response.trace << exception(exc)
         raise
       end
 
       # Creates a log entry for the entry to a resource callback.
       def attempt(callback, args)
-        log = {:type => :attempt}
+        log = {type: :attempt}
         method = resource.method(callback)
         if method.owner == ::Webmachine::Resource::Callbacks
           log[:name] = "(default)##{method.name}"
         else
           log[:name] = "#{method.owner.name}##{method.name}"
-          log[:source] = method.source_location.join(":") if method.respond_to?(:source_location)
+          log[:source] = method.source_location.join(':') if method.respond_to?(:source_location)
         end
         unless args.empty?
           log[:args] = args
@@ -79,15 +80,15 @@ module Webmachine
 
       # Creates a log entry for the result of a resource callback
       def result(result)
-        {:type => :result, :value => result}
+        {type: :result, value: result}
       end
 
       # Creates a log entry for an exception that was raised from a callback
       def exception(e)
-        {:type => :exception,
-          :class => e.class.name,
-          :backtrace => e.backtrace,
-          :message => e.message }
+        {type: :exception,
+         class: e.class.name,
+         backtrace: e.backtrace,
+         message: e.message}
       end
 
       # Adds proxy methods for callbacks that are dynamically referred to.

data/lib/webmachine/trace/trace_resource.rb

@@ -7,15 +7,14 @@ module Webmachine
     # includes serving the static files (the PNG flow diagram, CSS and
     # JS for the UI) and the HTML for the individual traces.
     class TraceResource < Resource
-
-      MAP_EXTERNAL = %w{static map.png}
-      MAP_FILE = File.expand_path("../static/http-headers-status-v3.png", __FILE__)
-      SCRIPT_EXTERNAL = %w{static wmtrace.js}
-      SCRIPT_FILE = File.expand_path("../#{SCRIPT_EXTERNAL.join '/'}", __FILE__)
-      STYLE_EXTERNAL = %w{static wmtrace.css}
-      STYLE_FILE = File.expand_path("../#{STYLE_EXTERNAL.join '/'}", __FILE__)
-      TRACELIST_ERB = File.expand_path("../static/tracelist.erb", __FILE__)
-      TRACE_ERB = File.expand_path("../static/trace.erb", __FILE__)
+      MAP_EXTERNAL = %w[static map.png]
+      MAP_FILE = File.expand_path('../static/http-headers-status-v3.png', __FILE__)
+      SCRIPT_EXTERNAL = %w[static wmtrace.js]
+      SCRIPT_FILE = File.expand_path("../#{SCRIPT_EXTERNAL.join "/"}", __FILE__)
+      STYLE_EXTERNAL = %w[static wmtrace.css]
+      STYLE_FILE = File.expand_path("../#{STYLE_EXTERNAL.join "/"}", __FILE__)
+      TRACELIST_ERB = File.expand_path('../static/tracelist.erb', __FILE__)
+      TRACE_ERB = File.expand_path('../static/trace.erb', __FILE__)
 
       # The ERB template for the trace list
       def self.tracelist
@@ -30,15 +29,15 @@ module Webmachine
       def content_types_provided
         case request.path_tokens
         when []
-          [["text/html", :produce_list]]
+          [['text/html', :produce_list]]
         when MAP_EXTERNAL
-          [["image/png", :produce_file]]
+          [['image/png', :produce_file]]
         when SCRIPT_EXTERNAL
-          [["text/javascript", :produce_file]]
+          [['text/javascript', :produce_file]]
         when STYLE_EXTERNAL
-          [["text/css", :produce_file]]
+          [['text/css', :produce_file]]
         else
-          [["text/html", :produce_trace]]
+          [['text/html', :produce_trace]]
         end
       end
 
@@ -73,12 +72,12 @@ module Webmachine
         # TODO: Add support for IO objects as response bodies,
         # allowing server optimizations like sendfile or chunked
         # downloads
-        open(@file, "rb") {|io| io.read }
+        File.binread(@file)
       end
 
       def produce_list
-        base   = request.uri.path.chomp("/")
-        traces = Trace.traces.map {|t| [ t, "#{base}/#{t}" ] }
+        base = request.uri.path.chomp('/')
+        traces = Trace.traces.map { |t| [t, "#{base}/#{t}"] }
         self.class.tracelist.result(binding)
       end
 
@@ -96,22 +95,22 @@ module Webmachine
         tres = data.pop.dup
         treq.delete :type
         tres.delete :type
-        [ MultiJson.dump(treq), MultiJson.dump(tres), MultiJson.dump(encode_decisions(data)) ]
+        [MultiJson.dump(treq), MultiJson.dump(tres), MultiJson.dump(encode_decisions(data))]
       end
 
       def encode_decisions(decisions)
-        decisions.inject([]) do |list, event|
+        decisions.each_with_object([]) do |event, list|
           case event[:type]
           when :decision
             # Don't produce new decisions for sub-steps in the graph
-            unless event[:decision].to_s =~ /[a-z]$/
+            unless /[a-z]$/.match?(event[:decision].to_s)
               list << {'d' => event[:decision], 'calls' => []}
             end
           when :attempt
             list.last['calls'] << {
-              "call" => event[:name],
-              "source" => event[:source],
-              "input" => event[:args] && event[:args].inspect
+              'call' => event[:name],
+              'source' => event[:source],
+              'input' => event[:args] && event[:args].inspect
             }
           when :result
             list.last['calls'].last['output'] = event[:value].inspect
@@ -122,7 +121,6 @@ module Webmachine
               'message' => event[:message]
             }
           end
-          list
         end
       end
     end

data/lib/webmachine/trace.rb

@@ -9,10 +9,11 @@ module Webmachine
   # Contains means to enable the Webmachine visual debugger.
   module Trace
     module_function
+
     # Classes that implement storage for visual debugger traces.
     TRACE_STORES = {
-      :memory => Hash,
-      :pstore => PStoreTraceStore
+      memory: Hash,
+      pstore: PStoreTraceStore
     }
 
     DEFAULT_TRACE_SUBSCRIBER = Webmachine::Events.subscribe(
@@ -71,10 +72,10 @@ module Webmachine
 
     def trace_store
       @trace_store ||= begin
-                         opts = Array(@trace_store_opts).dup
-                         type = opts.shift
-                         TRACE_STORES[type].new(*opts)
-                       end
+        opts = Array(@trace_store_opts).dup
+        type = opts.shift
+        TRACE_STORES[type].new(*opts)
+      end
     end
     private :trace_store
 

data/lib/webmachine/translation.rb

@@ -1,7 +1,7 @@
 require 'set'
 require 'i18n'
 I18n.enforce_available_locales = true if I18n.respond_to?(:enforce_available_locales)
-I18n.config.load_path << File.expand_path("../locale/en.yml", __FILE__)
+I18n.config.load_path << File.expand_path('../locale/en.yml', __FILE__)
 
 module Webmachine
   # Provides an interface to the I18n library specifically for
@@ -12,8 +12,8 @@ module Webmachine
     # @param [Hash] options options to pass to I18n, including
     #   variables to interpolate.
     # @return [String] the interpolated string
-    def t(key, options={})
-      ::I18n.t(key, options.merge(:scope => :webmachine))
+    def t(key, options = {})
+      ::I18n.t(key, **options.merge(scope: :webmachine))
     end
   end
 end

data/lib/webmachine/version.rb

@@ -1,6 +1,6 @@
 module Webmachine
   # Library version
-  VERSION = "1.6.0".freeze
+  VERSION = '2.0.0'.freeze
 
   # String for use in "Server" HTTP response header, which includes
   # the {VERSION}.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmachine
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sean Cribbs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -42,16 +42,50 @@ dependencies:
   name: as-notifications
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: " webmachine is a toolkit for building HTTP applications in a declarative
   fashion, that avoids the confusion of going through a CGI-style interface like Rack.
   It is strongly influenced by the original Erlang project of the same name and shares
@@ -62,14 +96,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- RELEASING.md
-- Rakefile
 - documentation/adapters.md
 - documentation/authentication-and-authorization.md
 - documentation/configurator.md
@@ -87,11 +116,9 @@ files:
 - lib/webmachine.rb
 - lib/webmachine/adapter.rb
 - lib/webmachine/adapters.rb
-- lib/webmachine/adapters/httpkit.rb
 - lib/webmachine/adapters/lazy_request_body.rb
 - lib/webmachine/adapters/rack.rb
 - lib/webmachine/adapters/rack_mapped.rb
-- lib/webmachine/adapters/reel.rb
 - lib/webmachine/adapters/webrick.rb
 - lib/webmachine/application.rb
 - lib/webmachine/chunked_body.rb
@@ -146,44 +173,17 @@ files:
 - lib/webmachine/trace/trace_resource.rb
 - lib/webmachine/translation.rb
 - lib/webmachine/version.rb
-- memory_test.rb
-- spec/spec_helper.rb
-- spec/webmachine/adapter_spec.rb
-- spec/webmachine/adapters/httpkit_spec.rb
-- spec/webmachine/adapters/rack_mapped_spec.rb
-- spec/webmachine/adapters/rack_spec.rb
-- spec/webmachine/adapters/reel_spec.rb
-- spec/webmachine/adapters/webrick_spec.rb
-- spec/webmachine/application_spec.rb
-- spec/webmachine/chunked_body_spec.rb
-- spec/webmachine/configuration_spec.rb
-- spec/webmachine/cookie_spec.rb
-- spec/webmachine/decision/conneg_spec.rb
-- spec/webmachine/decision/falsey_spec.rb
-- spec/webmachine/decision/flow_spec.rb
-- spec/webmachine/decision/fsm_spec.rb
-- spec/webmachine/decision/helpers_spec.rb
-- spec/webmachine/dispatcher/rfc3986_percent_decode_spec.rb
-- spec/webmachine/dispatcher/route_spec.rb
-- spec/webmachine/dispatcher_spec.rb
-- spec/webmachine/errors_spec.rb
-- spec/webmachine/etags_spec.rb
-- spec/webmachine/events_spec.rb
-- spec/webmachine/headers_spec.rb
-- spec/webmachine/media_type_spec.rb
-- spec/webmachine/request_spec.rb
-- spec/webmachine/rescueable_exception_spec.rb
-- spec/webmachine/resource/authentication_spec.rb
-- spec/webmachine/response_spec.rb
-- spec/webmachine/trace/fsm_spec.rb
-- spec/webmachine/trace/resource_proxy_spec.rb
-- spec/webmachine/trace/trace_store_spec.rb
-- spec/webmachine/trace_spec.rb
-- webmachine.gemspec
-homepage: http://github.com/seancribbs/webmachine-ruby
+- pkg/webmachine-2.0.0.beta.gem
+homepage: https://github.com/webmachine/webmachine-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/webmachine/webmachine-ruby/issues
+  changelog_uri: https://github.com/webmachine/webmachine-ruby/blob/HEAD/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmachine/2.0.0
+  homepage_uri: https://github.com/webmachine/webmachine-ruby
+  source_code_uri: https://github.com/webmachine/webmachine-ruby
+  wiki_uri: https://github.com/webmachine/webmachine-ruby/wiki
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -192,48 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.9
 signing_key:
 specification_version: 4
 summary: webmachine is a toolkit for building HTTP applications,
-test_files:
-- spec/spec_helper.rb
-- spec/webmachine/trace/fsm_spec.rb
-- spec/webmachine/trace/resource_proxy_spec.rb
-- spec/webmachine/trace/trace_store_spec.rb
-- spec/webmachine/configuration_spec.rb
-- spec/webmachine/dispatcher/route_spec.rb
-- spec/webmachine/dispatcher/rfc3986_percent_decode_spec.rb
-- spec/webmachine/rescueable_exception_spec.rb
-- spec/webmachine/etags_spec.rb
-- spec/webmachine/chunked_body_spec.rb
-- spec/webmachine/adapter_spec.rb
-- spec/webmachine/headers_spec.rb
-- spec/webmachine/adapters/reel_spec.rb
-- spec/webmachine/adapters/rack_spec.rb
-- spec/webmachine/adapters/httpkit_spec.rb
-- spec/webmachine/adapters/webrick_spec.rb
-- spec/webmachine/adapters/rack_mapped_spec.rb
-- spec/webmachine/request_spec.rb
-- spec/webmachine/response_spec.rb
-- spec/webmachine/decision/fsm_spec.rb
-- spec/webmachine/decision/falsey_spec.rb
-- spec/webmachine/decision/flow_spec.rb
-- spec/webmachine/decision/helpers_spec.rb
-- spec/webmachine/decision/conneg_spec.rb
-- spec/webmachine/cookie_spec.rb
-- spec/webmachine/media_type_spec.rb
-- spec/webmachine/errors_spec.rb
-- spec/webmachine/resource/authentication_spec.rb
-- spec/webmachine/trace_spec.rb
-- spec/webmachine/application_spec.rb
-- spec/webmachine/events_spec.rb
-- spec/webmachine/dispatcher_spec.rb
-- ".gitignore"
+test_files: []

data/.gitignore

@@ -1,31 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.sw[^f]
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-doc
-.yardoc
-.bundle
-Gemfile.lock
-**/bin
-*.rbc
-.rvmrc
-.SyncID
-.SyncIgnore
-vendor

data/Gemfile

@@ -1,46 +0,0 @@
-require 'rbconfig'
-source 'https://rubygems.org'
-gemspec
-
-group :development do
-  gem "yard", "~> 0.9"
-  gem "rake", "~> 12.0"
-end
-
-group :test do
-  gem "rspec", "~> 3.0", ">= 3.6.0"
-  gem "rspec-its", "~> 1.2"
-  gem "rack", "~> 2.0"
-  gem "rack-test", "~> 0.7"
-  gem "websocket_parser", "~>1.0"
-end
-
-group :webservers do
-  gem 'reel', '~> 0.5.0'
-  gem 'http', '~> 0.6.0'
-  gem 'celluloid', '0.17.4' # Refactors in 0.18.0 break the tests
-  gem 'httpkit', :platform => [:mri, :rbx]
-end
-
-group :guard do
-  gem 'guard-rspec', '~> 4.7'
-  case RbConfig::CONFIG['host_os']
-  when /darwin/
-    gem 'rb-fsevent', '~> 0.10'
-    # gem 'growl_notify'
-    gem 'growl', '~> 1.0'
-  when /linux/
-    gem 'rb-inotify'
-    gem 'libnotify'
-  end
-end
-
-group :docs do
-  platform :mri_19, :mri_20 do
-    gem 'redcarpet', '~> 3.4'
-  end
-end
-
-platforms :jruby do
-  gem 'jruby-openssl'
-end

data/Guardfile

@@ -1,11 +0,0 @@
-gemset = ENV['RVM_GEMSET'] || 'webmachine'
-gemset = "@#{gemset}" unless gemset.to_s == ''
-
-rvms = %W[ 1.8.7 1.9.2 1.9.3 jruby rbx ].map {|v| "#{v}#{gemset}" }
-
-guard 'rspec', :cli => "--color --profile", :growl => true, :rvm => rvms do
-  watch(%r{^lib/webmachine/locale/.+$}) { "spec" }
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { "spec" }
-end

data/RELEASING.md

@@ -1,21 +0,0 @@
-1. Open `CHANGELOG.md` and summarize the changes made since the last release (hopefully better than the individual commit messages). The history can be grabbed with a simple git command (assuming the last version was 1.3.0:
-
-        $ git log --pretty=format:'  * %s' v1.3.0..HEAD
-
-2. Edit the version in `lib/webmachine/version.rb` according to semantic versioning rules.
-3. Commit both files.
-
-        $ git add CHANGELOG.md lib/webmachine/version.rb
-        $ git commit -m "chore(release): version $(ruby -r ./lib/webmachine/version.rb -e "puts Webmachine::VERSION")" && git push
-
-4. Release the gem.
-
-        $ bundle exec rake release
-
-5. If this is a new major or minor release, push a new stable branch, otherwise merge the commit into the stable branch (or master, depending on where you made the commit).
-
-        $ git push origin HEAD:1.3-stable
-        # or
-        $ git checkout 1.3-stable; git merge master; git push origin; git checkout master
-
-6. YOU'RE DONE!

data/Rakefile

@@ -1,44 +0,0 @@
-require "bundler/gem_tasks"
-
-begin
-  require 'yard'
-  require 'yard/rake/yardoc_task'
-  YARD::Rake::YardocTask.new do |doc|
-    doc.files = Dir["lib/**/*.rb"] + ['README.md']
-    doc.options = ["-m", "markdown"]
-  end
-rescue LoadError
-end
-
-desc "Validate the gemspec file."
-task :validate_gemspec do
-  Gem::Specification.load("webmachine.gemspec").validate
-end
-
-task :build => :validate_gemspec
-
-desc "Cleans up white space in source files"
-task :clean_whitespace do
-  no_file_cleaned = true
-
-  Dir["**/*.rb"].each do |file|
-    contents = File.read(file)
-    cleaned_contents = contents.gsub(/([ \t]+)$/, '')
-    unless cleaned_contents == contents
-      no_file_cleaned = false
-      puts " - Cleaned #{file}"
-      File.open(file, 'w') { |f| f.write(cleaned_contents) }
-    end
-  end
-
-  if no_file_cleaned
-    puts "No files with trailing whitespace found"
-  end
-end
-
-require 'rspec/core/rake_task'
-
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec