HACKING

   1 = Unicorn Hacker's Guide
   2
   3 == Polyglot Infrastructure
   4
   5 Like Mongrel, we use Ruby where it makes sense, and Ragel with C where
   6 it helps performance.  All of the code that actually runs your Rack
   7 application is written Ruby, Ragel or C.
   8
   9 As far as tests and documentation goes, we're not afraid to embrace Unix
  10 and use traditional Unix tools where they make sense and get the job
  11 done.
  12
  13 === Tests
  14
  15 Tests are good, but slow tests make development slow, so we make tests
  16 faster (in parallel) with GNU make (instead of Rake) and avoiding
  17 RubyGems.
  18
  19 Users of GNU-based systems (such as GNU/Linux) usually have GNU make installed
  20 as "make" instead of "gmake".
  21
  22 Since we don't load RubyGems by default, loading Rack properly requires
  23 setting up RUBYLIB to point to where Rack is located.  Not loading
  24 RubyGems drastically lowers the time to run the full test suite.  You
  25 may setup a "local.mk" file in the top-level working directory to setup
  26 your RUBYLIB and any other environment variables.  A "local.mk.sample"
  27 file is provided for reference.
  28
  29 Running the entire test suite with 4 tests in parallel:
  30
  31   gmake -j4 test
  32
  33 Running just one unit test:
  34
  35   gmake test/unit/test_http_parser.rb
  36
  37 Running just one test case in a unit test:
  38
  39   gmake test/unit/test_http_parser.rb--test_parse_simple.n
  40
  41 === HttpServer
  42
  43 We strive to write as little code as possible while still maintaining
  44 readability.  However, readability and flexibility may be sacrificed for
  45 performance in hot code paths.  For Ruby, less code generally means
  46 faster code.
  47
  48 Memory allocation should be minimized as much as practically possible.
  49 Buffers for IO#readpartial are preallocated in the hot paths to avoid
  50 building up garbage.  Hash assignments use frozen strings to avoid the
  51 duplication behind-the-scenes.
  52
  53 We spend as little time as possible inside signal handlers and instead
  54 defer handling them for predictability and robustness.  Most of the
  55 Unix-specific things are in the Unicorn::HttpServer class.  Unix systems
  56 programming experience will come in handy (or be learned) here.
  57
  58 === Documentation
  59
  60 We use RDoc 2.4.x with Darkfish for documentation as much as possible,
  61 if you're on Ruby 1.8 you want to install the latest "rdoc" gem.  Due to
  62 the lack of RDoc-to-manpage converters we know about, we're writing
  63 manpages in Markdown and converting to troff/HTML with Pandoc.
  64
  65 === Ruby/C Compatibility
  66
  67 We target Ruby 1.8.6+, 1.9 and will target Rubinius as it becomes
  68 production-ready.  We need the Ruby implementation to support fork,
  69 exec, pipe, UNIX signals, access to integer file descriptors and
  70 ability to use unlinked files.
  71
  72 All of our C code is OS-independent and should run on compilers
  73 supported by the versions of Ruby we target.
  74
  75 === Ragel Compatibility
  76
  77 We target the latest released version of Ragel and will update our code
  78 to keep up with new releases.  Packaged tarballs and gems include the
  79 generated source code so they will remain usable if compatibility is
  80 broken.
  81
  82 == Contributing
  83
  84 Contributions are welcome in the form of patches, pull requests, code
  85 review, testing, documentation, user support or any other feedback is
  86 welcome.  The mailing list is the central coordination point for all
  87 user and developer feedback and bug reports.
  88
  89 === Submitting Patches
  90
  91 Follow conventions already established in the code and do not exceed 80
  92 characters per line.
  93
  94 Inline patches (from "git format-patch -M") to the mailing list are
  95 preferred because they allow code review and comments in the reply to
  96 the patch.
  97
  98 We will adhere to mostly the same conventions for patch submissions as
  99 git itself.  See the Documentation/SubmittingPatches document
 100 distributed with git on on patch submission guidelines to follow.  Just
 101 don't email the git mailing list or maintainer with Unicorn patches :)
 102
 103 == Running Development Versions
 104
 105 It is easy to install the contents of your git working directory:
 106
 107 Via RubyGems (RubyGems 1.3.5+ recommended for prerelease versions):
 108
 109   gmake install-gem
 110
 111 Without RubyGems (via setup.rb):
 112
 113   gmake install
 114
 115 It is not at all recommended to mix a RubyGems installation with an
 116 installation done without RubyGems, however.