RubyGems - yarn - Versions diffs - 0.1.0 → 0.1.1 - Diffend - OSS supply chain security and management platform

yarn 0.1.0 → 0.1.1

Files changed (87) hide show

data/lib/rack/handler/yarn.rb +3 -7
data/lib/yarn/abstract_handler.rb +19 -4
data/lib/yarn/directory_lister.rb +3 -2
data/lib/yarn/error_page.rb +3 -0
data/lib/yarn/logging.rb +7 -0
data/lib/yarn/parser.rb +3 -0
data/lib/yarn/rack_handler.rb +4 -0
data/lib/yarn/request_handler.rb +23 -13
data/lib/yarn/response.rb +8 -1
data/lib/yarn/server.rb +16 -3
data/lib/yarn/statuses.rb +53 -52
data/lib/yarn/version.rb +2 -1
metadata +27 -108
data/.autotest +0 -5
data/.gitignore +0 -11
data/.rspec +0 -2
data/Gemfile +0 -7
data/LICENCE +0 -22
data/Rakefile +0 -4
data/cucumber.yml +0 -3
data/features/concurrency.feature +0 -13
data/features/dynamic_request.feature +0 -18
data/features/logger.feature +0 -16
data/features/parser.feature +0 -15
data/features/rack.feature +0 -15
data/features/server.feature +0 -14
data/features/static_request.feature +0 -25
data/features/step_definitions/concurrency_steps.rb +0 -34
data/features/step_definitions/parser_steps.rb +0 -23
data/features/step_definitions/rack_steps.rb +0 -16
data/features/step_definitions/server_steps.rb +0 -42
data/features/step_definitions/web_steps.rb +0 -15
data/features/support/env.rb +0 -20
data/features/support/hooks.rb +0 -5
data/spec/helpers.rb +0 -92
data/spec/rack/handler/yarn_spec.rb +0 -21
data/spec/spec_helper.rb +0 -17
data/spec/yarn/abstract_handler_spec.rb +0 -98
data/spec/yarn/directory_lister_spec.rb +0 -41
data/spec/yarn/error_page_spec.rb +0 -33
data/spec/yarn/logging_spec.rb +0 -53
data/spec/yarn/parser_spec.rb +0 -122
data/spec/yarn/rack_handler_spec.rb +0 -55
data/spec/yarn/request_handler_spec.rb +0 -164
data/spec/yarn/response_spec.rb +0 -36
data/spec/yarn/server_spec.rb +0 -102
data/test_objects/.gitignore +0 -10
data/test_objects/config.ru +0 -6
data/test_objects/index.html +0 -13
data/test_objects/jquery.js +0 -8865
data/test_objects/rails_test/.gitignore +0 -5
data/test_objects/rails_test/Gemfile +0 -34
data/test_objects/rails_test/README +0 -261
data/test_objects/rails_test/Rakefile +0 -7
data/test_objects/rails_test/app/assets/images/rails.png +0 -0
data/test_objects/rails_test/app/assets/javascripts/application.js +0 -6
data/test_objects/rails_test/app/assets/stylesheets/application.css +0 -7
data/test_objects/rails_test/app/assets/stylesheets/scaffolds.css.scss +0 -56
data/test_objects/rails_test/app/mailers/.gitkeep +0 -0
data/test_objects/rails_test/app/models/.gitkeep +0 -0
data/test_objects/rails_test/app/views/layouts/application.html.erb +0 -15
data/test_objects/rails_test/app/views/posts/_form.html.erb +0 -25
data/test_objects/rails_test/app/views/posts/edit.html.erb +0 -6
data/test_objects/rails_test/app/views/posts/index.html.erb +0 -20
data/test_objects/rails_test/app/views/posts/new.html.erb +0 -5
data/test_objects/rails_test/app/views/posts/show.html.erb +0 -15
data/test_objects/rails_test/config.ru +0 -4
data/test_objects/rails_test/config/database.yml +0 -25
data/test_objects/rails_test/config/locales/en.yml +0 -5
data/test_objects/rails_test/doc/README_FOR_APP +0 -2
data/test_objects/rails_test/lib/assets/.gitkeep +0 -0
data/test_objects/rails_test/lib/tasks/.gitkeep +0 -0
data/test_objects/rails_test/log/.gitkeep +0 -0
data/test_objects/rails_test/public/404.html +0 -26
data/test_objects/rails_test/public/422.html +0 -26
data/test_objects/rails_test/public/500.html +0 -26
data/test_objects/rails_test/public/favicon.ico +0 -0
data/test_objects/rails_test/public/robots.txt +0 -5
data/test_objects/rails_test/script/rails +0 -6
data/test_objects/rails_test/test/fixtures/.gitkeep +0 -0
data/test_objects/rails_test/test/fixtures/posts.yml +0 -9
data/test_objects/rails_test/test/functional/.gitkeep +0 -0
data/test_objects/rails_test/test/integration/.gitkeep +0 -0
data/test_objects/rails_test/test/unit/.gitkeep +0 -0
data/test_objects/rails_test/vendor/assets/stylesheets/.gitkeep +0 -0
data/test_objects/rails_test/vendor/plugins/.gitkeep +0 -0
data/yarn.gemspec +0 -29

@@ -4,19 +4,15 @@ require "rack/handler"
 module Rack
   module Handler
+    # Yarn webserver
     class Yarn
+      # Takes a Rackup file and an options Hash.
       def self.run(app, options={})
         options = options.merge({ rack: app })
         @server = ::Yarn::Server.new(options)
         @server.start
       end
-      def self.valid_options
-        {
-          "Host=HOST" => "Hostname to listen on (default: 127.0.0.1)",
-          "Port=PORT" => "Port to listen on (default: 3000)"
-        }
-      end
     end
   end
 end

data/lib/yarn/abstract_handler.rb CHANGED

@@ -4,9 +4,13 @@ require 'parslet'
 module Yarn
+  # Error for empty requests.
   class EmptyRequestError < StandardError; end
+  # Error if parsing the request fails.
   class ProcessingError < StandardError; end
+  # Base class for the handler classes.
+  # Built using the Template Method design pattern.
   class AbstractHandler
     include Logging
@@ -19,6 +23,10 @@ module Yarn
       @response = Response.new
     end
+    # The template method which drives the handlers.
+    # Starts by setting common headers and parses the request,
+    # prepares the response, returns it to the client, and closes
+    # the connection.
     def run(session)
       set_common_headers
       @session = session
@@ -37,6 +45,7 @@ module Yarn
       end
     end
+    # Invokes the parser upon the request
     def parse_request
       raw_request = read_request
       raise EmptyRequestError if raw_request.empty?
@@ -49,9 +58,11 @@ module Yarn
       end
     end
+    # Only implemented in the actual handler classes.
     def prepare_response
     end
+    # returns the reqponse by writing it to the socket.
     def return_response
       begin
         @session.puts "HTTP/1.1 #{@response.status} #{STATUS_CODES[@response.status]}"
@@ -66,6 +77,9 @@ module Yarn
       end
     end
+    # Reads the request from the socket.
+    # If a Content-Length header is given, that means there is an accompanying
+    # request body. The body is read according to the set Content-Length.
     def read_request
       input = []
       while (line = @session.gets) do
@@ -83,10 +97,7 @@ module Yarn
       input.join
     end
-    def persistent?
-      return @request[:headers]["Connection"] == "keep-alive"
-    end
+    # Sets common headers like server name and date.
     def set_common_headers
       @response.headers[:Server] = "Yarn webserver v#{VERSION}"
@@ -97,6 +108,7 @@ module Yarn
       @response.headers[:Connection] = "Close"
     end
+    # Extracts the path from the parsed request
     def extract_path
       path = @request[:uri][:path].to_s
       if path[0] == "/" && path != "/"
@@ -105,14 +117,17 @@ module Yarn
       path.gsub(/%20/, " ").strip
     end
+    # Proxy to getting the request body.
     def post_body
       @request ? @request[:body].to_s : ""
     end
+    # Proxy for getting the request path.
     def request_path
       @request[:uri][:path] if @request
     end
+    # Proxy for the clients address.
     def client_address
       begin
         @session.peeraddr(:numeric)[2] if @session

data/lib/yarn/directory_lister.rb CHANGED

@@ -1,10 +1,10 @@
-require 'yarn/logging'
 module Yarn
+  # Creates directory listings in HTML
   class DirectoryLister
     include Logging
+    # Creates a directory listing for the given path.
     def self.list(path)
       response = []
       response << <<-EOS
@@ -49,6 +49,7 @@ module Yarn
       return response
     end
+    # Formats file sizes into more readable formats.
     def self.format_size(size)
       count = 0
       while  size >= 1024 and count < 4

data/lib/yarn/error_page.rb CHANGED

@@ -1,13 +1,16 @@
 module Yarn
+  # HTML error pages
   module ErrorPage
+    # Makes the response a 404 error page
     def serve_404_page
       @response.status = 404
       fn = @request[:uri][:path] if @request
       @response.body = ["<html><head><title>404</title></head><body><h1>File #{fn} does not exist.</h1></body><html>"]
     end
+    # Makes the response a 505 error page
     def serve_500_page
       @response.status = 500
       @response.body = ["<h1>Yarn!?</h1>\nA server error occured."]

data/lib/yarn/logging.rb CHANGED

@@ -1,8 +1,11 @@
 require 'date'
 module Yarn
+  # Enables logging messages to $output.
   module Logging
+    # Logs a message to $output.
+    # Doesnt do anything unless logging or debugging is enabled.
     def log(msg)
       return nil unless $log
       if msg.respond_to?(:each)
@@ -14,15 +17,19 @@ module Yarn
       end
     end
+    # Appends DEBUG to a log message.
+    # Doesnt do anything if debugging is disabled.
     def debug(msg=nil)
       log "DEBUG: #{msg}" if $debug
     end
+    # Proxy for the output variable.
     def output
       out ||= $output || $stdout
       out
     end
+    # Returns a formattet timestamp.
     def timestamp
       current_time = DateTime.now
       "#{current_time.strftime("%d/%m/%y %H:%M:%S")} -"

data/lib/yarn/parser.rb CHANGED

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'parslet'
 module Yarn
+  # LPEG style HTTP parser.
   class Parser < Parslet::Parser
     # general rules
@@ -81,12 +82,14 @@ module Yarn
     # starts parsing from the beginning using the :request rule
     root(:request)
+    # Executes the parser on a given input string.
     def run(input)
       tree = parse input
       HeadersTransformer.new.apply tree
     end
   end
+  # Formats the headers into a Hash with the header-name as the key.
   class HeadersTransformer < Parslet::Transform
     rule(:_process_headers => subtree(:headers)) do
       hash = {}

data/lib/yarn/rack_handler.rb CHANGED

@@ -1,6 +1,7 @@
 require 'rack'
 module Yarn
+  # handler for Rack applications.
   class RackHandler < AbstractHandler
     attr_accessor :env, :opts
@@ -13,6 +14,7 @@ module Yarn
       @port = opts[:port].to_s
     end
+    # Prepares the response by setting the environment and calling the Rack app.
     def prepare_response
       begin
         make_env
@@ -24,6 +26,7 @@ module Yarn
       end
     end
+    # Creates and formats the Rack environment.
     def make_env
       input = StringIO.new("").set_encoding(Encoding::ASCII_8BIT)
       if has_body?
@@ -49,6 +52,7 @@ module Yarn
       return @env
     end
+    # Proxy for whether the request has body data.
     def has_body?
       value ||= !! @request[:body]
     end

data/lib/yarn/request_handler.rb CHANGED

@@ -1,5 +1,9 @@
 module Yarn
+  # handler for static and dynamic requests
   class RequestHandler < AbstractHandler
+    # Determines whether to serve a directory listing, the contetents of a file,
+    # or an error page.
     def prepare_response
       path = extract_path
@@ -19,17 +23,20 @@ module Yarn
       end
     end
+    # Sets the response for a static file.
     def serve_file(path)
       @response.body << read_file(path)
       @response.headers["Content-Type"] = get_mime_type path
       @response.status = 200
     end
+    # Sets the response for a dynamic file.
     def serve_ruby_file(path)
       @response.body << execute_script(path)
       @response.status = 200
     end
+    # Sets the reponse for a directory listing.
     def serve_directory(path)
       @response.status = 200
       if File.exists?("index.html") || File.exists?("/index.html")
@@ -41,6 +48,7 @@ module Yarn
       end
     end
+    # Reads the contents of a file into an Array.
     def read_file(path)
       file_contents = []
       File.open(path).each { |line| file_contents << line }
@@ -48,6 +56,7 @@ module Yarn
       file_contents
     end
+    # Evaluates the contents of a ruby file and returns the output.
     def execute_script(path)
       response = `ruby #{path} #{post_body}`
       if !! ($?.to_s =~ /1$/)
@@ -57,24 +66,25 @@ module Yarn
       end
     end
+    # Determines the MIME type based on the file extension.
     def get_mime_type(path)
       return false unless path.include? '.'
       filetype = path.split('.').last
       return case
-      when ["html", "htm"].include?(filetype)
-        "text/html"
-      when "txt" == filetype
-        "text/plain"
-      when "css" == filetype
-        "text/css"
-      when "js" == filetype
-        "text/javascript"
-      when ["png", "jpg", "jpeg", "gif", "tiff"].include?(filetype)
-        "image/#{filetype}"
-      when ["zip","pdf","postscript","x-tar","x-dvi"].include?(filetype)
-        "application/#{filetype}"
-      else false
+        when ["html", "htm"].include?(filetype)
+          "text/html"
+        when "txt" == filetype
+          "text/plain"
+        when "css" == filetype
+          "text/css"
+        when "js" == filetype
+          "text/javascript"
+        when ["png", "jpg", "jpeg", "gif", "tiff"].include?(filetype)
+          "image/#{filetype}"
+        when ["zip","pdf","postscript","x-tar","x-dvi"].include?(filetype)
+          "application/#{filetype}"
+        else false
       end
     end
   end

data/lib/yarn/response.rb CHANGED

@@ -1,5 +1,5 @@
 module Yarn
+  # Holds the response status, headers and body in an Array.
   class Response
     attr_accessor :content
@@ -8,30 +8,37 @@ module Yarn
       @content = [nil, {}, []]
     end
+    # HTTP status code set
     def status=(status)
       @content[0] = status
     end
+    # HTTP status code get
     def status
       @content[0]
     end
+    # Headers Hash set
     def headers=(headers)
       @content[1] = headers
     end
+    # Headers Hash get
     def headers
       @content[1]
     end
+    # Body Array set
     def body=(body)
       @content[2] = body
     end
+    # Body Array get
     def body
       @content[2]
     end
+    # Format to string
     def to_s
       @content
     end

data/lib/yarn/server.rb CHANGED

@@ -1,6 +1,8 @@
 require 'socket'
+# Yarn namespace
 module Yarn
+  # The heart of Yarn which starts a TCP server and forks workers which handles requests.
   class Server
     include Logging
@@ -17,6 +19,7 @@ module Yarn
     attr_accessor :host, :port, :socket, :workers
+    # Initializes a new Server with the given options Hash.
     def initialize(options={})
       # merge given options with default values
       opts = {
@@ -28,8 +31,7 @@ module Yarn
         rack: "off"
       }.merge(options)
-      @app = nil
-      @app = load_rack_app(opts[:rack]) unless opts[:rack] == "off"
+      @app = opts[:rack] == "off" ? nil : load_rack_app(opts[:rack])
       @opts = opts
       @host, @port, @num_workers = opts[:host], opts[:port], opts[:workers]
@@ -38,16 +40,19 @@ module Yarn
       $log = opts[:log] || opts[:debug]
     end
+    # Loads a Rack application from a given file path.
+    # If the file does not exist, the program exits.
     def load_rack_app(app_path)
       if File.exists?(app_path)
         config_file = File.read(app_path)
-        rack_application = eval("Rack::Builder.new { #{config_file} }")
+        rack_application = eval("Rack::Builder.new { #{config_file} }.to_app", TOPLEVEL_BINDING, app_path)
       else
         log "#{app_path} does not exist. Exiting."
         Kernel::exit
       end
     end
+    # Creates a new TCPServer and invokes init_workers
     def start
       trap("INT") { stop }
       @socket = TCPServer.new(@host, @port)
@@ -61,18 +66,24 @@ module Yarn
       Process.waitall
     end
+    # Applies TCP optimizations to the TCP socket
     def configure_socket
       TCP_OPTS.each { |opt| @session.setsockopt(*opt) }
     end
+    # Runs fork_worker @num_worker times
     def init_workers
       @num_workers.times { @workers << fork_worker }
     end
+    # Forks a new process with a worker
     def fork_worker
       fork { worker }
     end
+    # Contains the logic performed by each worker.  It first determines the
+    # handler type and then start an infinite loop listening for incomming
+    # requests. Upon receiving a request, it fires the run method on the handler.
     def worker
       trap("INT") { exit }
       handler = get_handler
@@ -83,10 +94,12 @@ module Yarn
       end
     end
+    # Returns the handler corresponding to whether a Rack application is present.
     def get_handler
       @app ? RackHandler.new(@app,@opts) : RequestHandler.new
     end
+    # Closes the TCPServer and exits with a message.
     def stop
       @socket.close if (@socket && !@socket.closed?)