busker 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 479d0314b2b96aa30c911d939ad80b2bc8b1df76
-  data.tar.gz: 7d9aba7ffc423e2c566a7dfab46abcebad2c8925
+  metadata.gz: 356d2a430d4617987f16ae6e79c6f1647e9c0621
+  data.tar.gz: babff57610dcad7cb004c785b2b5b701482bc30b
 SHA512:
-  metadata.gz: 78b54d4eff9e762c78a661791b9539348ec0f4cd44dee41800531881ed78ddd9d9546f7eb4d8f12fd48c41d8b7a2d57fe6f9ff7bcc779c316252b78460378f10
-  data.tar.gz: 86396ccdde4f1dc4f304842c439a70b2b08292aab40275eb9bbd71005cf7aede2e0bbd52ae87cf88e721db38190176f8bda082a8245b1e76f2a58c06b97a8dd5
+  metadata.gz: 38305ab76fc8c86aaa4f6fadb079462ce31c75301ec3637f8ff25ae2c1094f49da5717c7d33c249c3efbef277d0f80ba7d83677fcbc73a15f57ed3732a95bab2
+  data.tar.gz: ec4059f506ea03c897490ed6e4dc13c8d18b06c1cc0ca4eab7dc5c4efa209e7eede3a4efc63928872e3de134e317eb832ff559500b287dfb9a6496489b70023e

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/README.md

@@ -1,10 +1,18 @@
-# Busker
+# Busker :walking::notes:
 
 An extremely simple web framework. It's called Busker as a reference to
 Sinatra. It mimics Sinatra in some aspects while still trying to stay a
 true wanderer of the streets.
 
-## Installation
+## Design principles :page_with_curl:
+
+* Small code base that is easily understandable, hackable and embeddable
+* No dependencies except what is in the Ruby Standard Lib
+* Backward compatibility to older Ruby versions
+* Ease of use / Some minor resemblance to Sinatra, hence the name
+* It's not meant as a complete web framework but concentrates on the basics
+
+## Installation :floppy_disk:
 
 Add this line to your application's Gemfile:
 
@@ -18,73 +26,97 @@ Or install it yourself as:
 
     $ gem install busker
 
-## Usage
-
-    require 'busker'
-
-    Busker::Busker.new do
-      # minimal route definition
-      route '/' do
-        "Busker version: #{Busker::VERSION}"
-      end
-
-      # respond to multiple HTTP methods, overwrite response content_type
-      route '/info', [:GET, :POST, :PUT, :DELETE] do |params, request, response|
-        response.content_type = 'text/plain'
-        request.inspect
-      end
-
-      # usage of URL params, render template with variable
-      route '/template', :GET do |params|
-        @title = params[:title] || 'no title'
-        if params[:external]
-          render './template.erb'
-        else
-          render :template
-        end
-      end
-
-      # usage of dynamic route params
-      route '/item/:id' do |params|
-        "requested item with id: #{params[:id]}"
-      end
-
-      # list all defined routes
-      route '/routes' do |params, request, response|
-        response.content_type = 'text/plain'
-        @_[:routes].keys.map{|e| e.join("\n")}.join("\n\n")
-      end
-    end.start
-
-    __END__
-    @@ template
-    <h1><%= @title %></h1>
-
-## Design principles
-
-* Small code base that is easily to understandable and hackable
-* Such a tiny code base that you can just copy it into your one-file-project without the need to require a Gem
-* No dependencies except what is in the Ruby Standard Lib
-* Backward compatibility to older Ruby versions
-* Some minor resemblance to Sinatra
-* Ease of use
-* It's not meant as a complete web framework like Rails but concentrates on the basics
+Or copy the code into your project ... it's tiny!
+
+## Usage :boom:
+
+```ruby
+require 'busker'
+
+Busker::Busker.new do
+
+  # minimal route definition
+  route '/' do
+    "Busker version: #{Busker::VERSION}"
+  end
+
+  # respond to multiple HTTP methods, overwrite response content_type
+  route '/info', [:GET, :POST, :PUT, :DELETE] do |params, request, response|
+    response.content_type = 'text/plain'
+    request.inspect
+  end
+
+  # usage of URL params, render template with variable
+  route '/template', :GET do |params|
+    @title = params[:title] || 'no title'
+    if params[:external]
+      render './template.erb'
+    else
+      render :template
+    end
+  end
+
+  # usage of dynamic route params
+  route '/item/:id' do |params|
+    "requested item with id: #{params[:id]}"
+  end
+
+  # list all defined routes
+  route '/routes', :GET do |params, request, response|
+    response.content_type = 'text/plain'
+    @_[:routes].keys.map{|k| "#{k[:methods].join('/')} #{k[:path]}"}.join("\n")
+  end
+
+  # implicit route definitions
+  route :implicit
+  route '/implicit/something'
+
+end.start # notice the call to start
+
+# inline templates like in Sinatra
+__END__
+@@ template
+<h1><%= @title %></h1>
+
+@@ /implicit
+<h1><%= @params.inspect %></h1>
+
+@@ /implicit/something
+<h1><%= @request.inspect %></h1>
+
+```
+
+## Questions :grey_question:
+
+### Why not use Sinatra?
+
+Sinatra is about 2000 lines of code (nothing you would directly, as in copy the code, embed in your single-file project) while Busker is less than 50 lines of code. Plus Sinatra depends on Rack and Tilt. Both external Gems while one of Buskers design principles is to only rely on modules that are within the Ruby Standard Library.
+
+This makes it literally small and deployable enough to be used in a tiny single file project. This is great for toy projects, educational purposes, payloads, embedded projects ...
+
+But that all being said, you should probably use Rails or Sinatra for your project.
+
+### When shouldn't I use Busker?
+
+**I wouldn't consider Busker to be "production ready" by any means. (WEBrick is not the smartest choice for production environments! [Read here why](http://www.madebymarket.com/blog/dev/ruby-web-benchmark-report.html))** It's something to play around and have fun with. I haven't made exhaustive benchmarks or in depths security checks. And I would love to get honest, constructive opinions (considering the design principles).
 
-## TODO / Ideas
+## TODO / Ideas :bulb:
 
+* More tests! (especially integration tests with Capybara)
 * Improve render method, allow yield etc
 * Improve error handling, honor production/development environment?
-* Tests? ;)
 * Auto reload?
+* A fork that doesn't need WEBrick?
 * Anything cool that doesn't break the design principles ...
 
-## Contributing
+## Contributing :construction:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+4. Don't forget to write- and run tests for your new feature (run rspec)!
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
 
 Or just use GitHubs on page editing ...
 it will do all of the above for you and is reasonable given the size of the source.

data/Rakefile

@@ -1,2 +1 @@
 require "bundler/gem_tasks"
-

data/busker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["pachacamac@users.noreply.github.com"]
   spec.summary       = %q{An extremely simple web framework}
   spec.description   = %q{An extremely simple web framework. It mimics Sinatra in some aspects while still trying to stay a true wanderer of the streets.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/pachacamac/busker"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/busker.rb

@@ -6,7 +6,7 @@ require 'erb'
 module Busker
   class Busker
     def initialize(opts={}, &block)
-      @_ = {:routes => {}}
+      @_ = {:routes => {}} #using @_ to store instance variables so they're less likely to get overwritten unintentionally while still allowing easy access when needed
       instance_eval(&block) if block_given?
       opts[:Port] ||= opts.delete(:port) || 8080
       opts[:DocumentRoot] ||= opts.delete(:document_root) || File.expand_path('./')
@@ -14,10 +14,10 @@ module Busker
       @_[:server].mount_proc '' do |rq, rs| #request, response
         begin
           rs.status, rs.content_type, method = nil, 'text/html', rq.request_method.tr('-', '_').upcase
-          route, handler = @_[:routes].find{|k,v| k.first.include?(method) && k.last.match(rq.path_info)}
+          route, handler = @_[:routes].find{|k,v| k[:methods].include?(method) && k[:matcher].match(rq.path_info)}
           params = Hash[ CGI::parse(rq.query_string||'').map{|k,v| [k.to_sym,v[0]]} + #url params
                          rq.query.map{|k,v| [k.to_sym, v]} + #query params
-                         ($~ ? $~.names.map(&:to_sym).zip($~.captures) : []) ] #dynamic route params
+                         ($~ ? $~.names.map(&:to_sym).zip($~.captures) : []) ] #dynamic route params. $~ is the info of the last match (see line 17)
           rs.status, rs.body = route ? [rs.status || 200, handler[:block].call(params, rq, rs)] : [404, 'not found']
         rescue => e
           @_[:server].logger.error "#{e.message}\n#{e.backtrace.map{|line| "\t#{line}"}.join("\n")}"
@@ -27,17 +27,20 @@ module Busker
     end
 
     def route(path, methods = ['GET'], opts={}, &block)
-      methods = (methods.is_a?(Array) ? methods : [methods]).map{|e| e.to_s.tr('-', '_').upcase}
+      path = "/#{path}" unless path[0] == '/'
+      methods = Array(methods).map{|e| e.to_s.tr('-', '_').upcase}
       matcher = Regexp.new("\\A#{path.gsub(/(:\w+)/){|m| "(?<#{$1[1..-1]}>\\w+)"}}\\Z")
-      @_[:routes][[methods, path, matcher]] = {:opts => opts, :block => block}
+      block ||= proc{|pa,rq,rs| @params,@request,@response = pa,rq,rs; render path}
+      @_[:routes][{:methods => methods, :path => path, :matcher => matcher}] = {:opts => opts, :block => block}
     end
 
     def render(name)
       @_[:templates] ||= (Hash[DATA.read.split(/^@@\s*(.*\S)\s*$/)[1..-1].map(&:strip).each_slice(2).to_a] rescue {})
-      ERB.new(@_[:templates][name.to_s] || File.read(name)).result(binding)
+      ERB.new(@_[:templates][name.to_s] || File.read(name.to_s)).result(binding)
     end
 
     def start
+      trap('INT'){@_[:server].stop}
       @_[:server].start ensure @_[:server].shutdown
     end
   end

data/lib/busker/version.rb

@@ -1,3 +1,3 @@
 module Busker
-  VERSION = "0.4.1"
+  VERSION = "0.6.0"
 end

data/spec/lib/busker_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'busker'
+
+describe Busker do
+  it 'has a version' do
+    expect(Busker::VERSION).to match(/\d+\.\d+\.\d+/)
+  end
+end
+
+describe Busker::Busker do
+  it 'can define a route via the initialize block' do
+    busker = Busker::Busker.new do
+      route '/path', :POST do
+        'trallala'
+      end
+    end
+    routes = busker.instance_variable_get('@_')[:routes]
+    expect(routes).to be_a Hash
+    expect(routes.size).to eql 1
+    key, value = routes.first
+    expect(key).to be_a Hash
+    expect(key[:methods]).to eql ['POST']
+    expect(key[:path]).to eql '/path'
+    expect(key[:matcher]).to be_a Regexp
+    expect(value).to be_a Hash
+    expect(value[:opts]).to be_a Hash
+    expect(value[:block]).to be_a Proc
+  end
+
+  # TODO: way more tests, including integration tests with capybara
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: busker
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - pachacamac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An extremely simple web framework. It mimics Sinatra in some aspects
   while still trying to stay a true wanderer of the streets.
 email:
@@ -47,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -54,7 +69,9 @@ files:
 - busker.gemspec
 - lib/busker.rb
 - lib/busker/version.rb
-homepage: ''
+- spec/lib/busker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pachacamac/busker
 licenses:
 - MIT
 metadata: {}
@@ -78,4 +95,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An extremely simple web framework
-test_files: []
+test_files:
+- spec/lib/busker_spec.rb
+- spec/spec_helper.rb