landline 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cfe9c90223c0d5d2fdc054e3aa2f96e76cdfeada0e865e13ef72d87b08526ff
+  data.tar.gz: 5a3b62e85bdafa0f9470f42d6c6789c32a4eaf9f00df686188837c3b13c570ff
+SHA512:
+  metadata.gz: f89f80cab3f587d952a3aaca92fce4f715d7778475ffc7c36abc207b6e377a233d8450e8b051013c6bcd7c77f9271fbdf0c48b336e0961f0841437fb7fef4f07
+  data.tar.gz: 49a13a596296b21c9a8abedc9f1aaf479f7bdda3a20e0eeff874c2cb92f064df577e6b14067b31765cb4aeddbea46c35a54804a8ce77be66f47cdbf22b371a80

data/HACKING.md

@@ -0,0 +1,30 @@
+# Notes and things to consider on Landline hacking
+
+The structure of the Landline rewrite was specifically redesigned to allow for
+extensive modification and extension. So to keep things that way, you may
+want to consider the methodology of writing Landline code.
+
+## Recommendations
+
+To keep things beautiful, consider following recommendations:
+
+- **USE COMMON SENSE**. None of these guidelines will ever be adequate
+  enough to replace common sense.
+- **Code less, think with ~~portals~~ what you have**. To minimize code
+  overhead, try to use existing functionality to get the effect you want.
+  (i.e. if you want to append headers to a request when it traverses a path,
+  don't write a new class variable and handler for this - just create a new
+  DSL method that really just appends a preprocessor to the path. Or avoid
+  making something like this at all - after all, preprocessors exist
+  exactly for that reason.)
+- Preferably, **extend the DSL and not the class*. Extensive class
+  modifications make code a lot less maintainable, if it wasn't obvious
+  already. If it can't be helped, then at the very least use Rubocop.
+- Document classes as if the next maintainer after you has you at gunpoint.
+  Document thoroughly, use YARD tags and **never** skip on public method
+  docs and class docs. As an example, consider Landline::PatternMatching::Glob.
+- Unit tests suck for many reasons. However, if you're writing a class that
+  does not have any dependents and which is frequently used, consider making
+  a unit test for it. People that might have to fix things further along
+  will be very thankful.
+

data/LAYOUT.md

@@ -0,0 +1,59 @@
+# Internal structure of Landline lib
+
+Note: If you want to start hacking on Landline and extending it, follow this
+layout as closely as possible.
+
+## Core classes
+
+These are core classes of Landline and they are loaded as soon as the library is loaded.
+
+- Landline::Path [path.rb]
+- Landline::PathBinding [path.rb]
+- Landline::Probe [probe.rb]
+- Landline::ProbeBinding [probe.rb]
+- Landline::Node (parent of Path and Probe) [node.rb]
+- Landline::Server (Rack application interface) [server.rb]
+- Landline::ServerBinding [server.rb]
+- Landline::Request (Rack request wrapper) [request.rb]
+- Landline::Response (Rack response wrapper) [response.rb]
+- Landline::Pattern [pattern\_matching.rb]
+
+## Patterns
+
+These are classes that Landline::Pattern can interface with to create Patterns.
+
+- Landline::PatternMatching::ReMatch [pattern\_matching/rematch.rb]
+- Landline::PatternMatching::Glob [pattern\_matching/glob.rb]
+
+## DSL Method mixins
+
+These are module mixins that add common methods to DSL bindings.
+
+- Landline::DSL::PathConstructors [dsl/path\_constructors.rb]
+
+## Utilities
+
+These are self-contained classes and methods that add extra functionality to Landline.
+
+- Landline::Util::Lookup [util/lookup.rb]
+
+## Probe subclasses
+
+These are reactive request handlers with their own semantics, if needed.
+
+- Landline::Handler [probe/handler.rb]
+- Landline::GETHandler [probe/http\_method.rb]
+- Landline::POSTHandler [probe/http\_method.rb]
+- Landline::HEADHandler [probe/http\_method.rb]
+- Landline::PUTHandler [probe/http\_method.rb]
+- Landline::DELETEHandler [probe/http\_method.rb]
+- Landline::CONNECTHandler [probe/http\_method.rb]
+- Landline::OPTIONSHandler [probe/http\_method.rb]
+- Landline::TRACEHandler [probe/http\_method.rb]
+- Landline::PATCHHandler [probe/http\_method.rb]
+
+## Path subclasses
+
+These are navigation handlers with their own semantics.
+
+(currently none)