kenji 0.7 → 1.0

data/README.md

@@ -5,23 +5,37 @@ Kenji is a lightweight backend framework for Ruby.
 
 ## Rationale
 
-Kenji believes that a traditional web application should be divided into two parts: an client application running in the browser (HTML/JS/CSS), and a backend API with which it communicates. Kenji is the backend side of the equation, while the front-end architecture is left up to the user. (Popular options are [backbone][] and [spine][].)
+Kenji believes that a traditional web application should be divided into two
+parts: an client application running in the browser (HTML/JS/CSS), and
+a backend API with which it communicates. Kenji is the backend side of the
+equation, while the front-end architecture is left up to the user. (Popular
+options are [backbone][] and [spine][].)
 
 [backbone]: http://documentcloud.github.com/backbone/
 [spine]: http://spinejs.com/
 
-Kenji believes that in order to keep clean and organized code, routes should be defined inline with their code.
+Kenji believes that in order to keep clean and organized code, routes should be
+defined inline with their code.
 
-Kenji believes that an app should be usable as a library from scripts or from the command line. An app should be automatable and testable.
+Kenji believes that an app should be usable as a library from scripts or from
+the command line. An app should be automatable and testable.
 
-Lastly, Kenji is opinionated, but only about things that directly pertain to routing and code architecture. Kenji believes in being a ligthweight module that only solves the problem it focuses on. Everything else is left up to the user. (ORM, data store, web server, message queue, front-end framework, deployment process, etc.)
+Lastly, Kenji is opinionated, but only about things that directly pertain to
+routing and code architecture. Kenji believes in being a ligthweight module
+that only solves the problem it focuses on. Everything else is left up to the
+user. (ORM, data store, web server, message queue, front-end framework,
+deployment process, etc.)
 
 
 ### Routing
 
-Kenji wants you to organize your code into logical units of code, aka. controllers. The controllers will automatically be selected based on the url requested, and the rest of the route is defined inline in the controller, with a domain-specific-language.
+Kenji wants you to organize your code into logical units of code, aka.
+controllers. The controllers will automatically be selected based on the url
+requested, and the rest of the route is defined inline in the controller, with
+a domain-specific-language.
 
-The canonical Hello World example for the URL `/hello/world` in Kenji would look like this, in `controller/hello.rb`:
+The canonical Hello World example for the URL `/hello/world` in Kenji would
+look like this, in `controller/hello.rb`:
 
 ```ruby
 class HelloController < Kenji::Controller
@@ -55,7 +69,8 @@ end
 
 ### Data Transport
 
-JSON is used as the singular data transport for Kenji. Requests are assumed to have:
+JSON is used as the singular data transport for Kenji. Requests are assumed to
+have:
 
     Content-Type: application/json; charset=utf-8
     Accept: application/json; charset=utf-8
@@ -63,10 +78,11 @@ JSON is used as the singular data transport for Kenji. Requests are assumed to h
 
 ## Usage
 
-Getting started with Kenji could not be any easier. All it takes is a few lines and a terminal:
+Getting started with Kenji could not be any easier. All it takes is a few lines
+and a terminal:
 
     $ gem install kenji         # (once kenji is on the rubygems main source)
-    $ kenji-init app_name; cd app_name
+    $ kenji init app_name; cd app_name
     $ rackup                    # launch the webserver
 
 And already, your app is ready to go:
@@ -78,12 +94,18 @@ And already, your app is ready to go:
 ## Requirements & Assumptions
 
 - Requires RubyGems and Bundler.
-- Requires Rack
-- Requires Ruby 1.9.
+- Requires Rack ~> 1.5.3.
+- Requires Ruby >= 1.9.3.
 
 
 ## Changelog
 
+#### 0.7
+
+- Pass can now contain variables, that get set as @ivars on the controller.
+  Thanks @nicotaing.
+- Accessors for `response_headers`
+
 #### 0.6.5
 
 - Automatically handle CORS / Access-Control.

data/bin/{kenji-init → kenji}

@@ -1,6 +1,14 @@
 #!/usr/bin/env ruby
 
-path = File.expand_path('.' << '/' << (ARGV.first || '.'))
+
+unless ARGV.first == 'init'
+  puts 'Usage: kenji init [project-name]'
+  Process.exit
+end
+
+puts 'Initializing a new Kenji project... :)'
+
+path = File.expand_path('.' << '/' << (ARGV[1] || '.'))
 app_name =  File.basename(path)
 
 Dir.mkdir(path) unless File.directory?(path)

data/inited/lib/README.md

@@ -0,0 +1,2 @@
+This is where you might put supporting libraries for your Kenji app. The
+structure of this is left up to you.

data/lib/kenji/version.rb

@@ -1,5 +1,5 @@
 
 module Kenji
-  VERSION = '0.7'
+  VERSION = '1.0'
 end
 

data/lib/kenji.rb

@@ -27,6 +27,11 @@ module Kenji
     #
     #   - :auto_cors => true | false    # automatically deal with
     #                                     CORS / Access-Control
+    #   - :root_controller => Object    # when set, Kenji will not attempt to
+    #                                     discover controllers based on
+    #                                     convention, but rather will always
+    #                                     use this controller. use `pass` to
+    #                                     build a controller hierarchy
     #
     def initialize(env, root, options = {})
       @headers = {
@@ -38,7 +43,8 @@ module Kenji
       @env = env
       
       @options = {
-        auto_cors: true
+        auto_cors: true,
+        root_controller: nil
       }.merge(options)
     end
 
@@ -57,21 +63,28 @@ module Kenji
 
 
         # new routing code
+        method = @env['REQUEST_METHOD'].downcase.to_sym
+
         segments = path.split('/')
-        segments = segments.drop(1) if segments.first == ''       # discard leading /'s empty segment
-        segments.unshift('')
-
-        acc = ''; out = '', success = false
-        while head = segments.shift
-          acc = "#{acc}/#{head}"
-          if controller = controller_for(acc)                     # if we have a valid controller 
-            begin
-              method = @env['REQUEST_METHOD'].downcase.to_sym
-              subpath = '/'+segments.join('/')
-              out = controller.call(method, subpath).to_json
+        segments = segments.unshift('') unless segments.first == ''    # ensure existence of leading /'s empty segment
+
+        if @options[:root_controller]
+          controller = controller_instance(@options[:root_controller])
+          subpath = segments.join('/')
+          out = controller.call(method, subpath).to_json
+          success = true
+        else
+          acc = ''; out = '', success = false
+          while head = segments.shift
+            acc = "#{acc}/#{head}"
+            if controller = controller_for(acc)                   # if we have a valid controller 
+              begin
+                subpath = '/'+segments.join('/')
+                out = controller.call(method, subpath).to_json
+              end
+              success = true
+              break
             end
-            success = true
-            break
           end
         end
 
@@ -137,8 +150,7 @@ module Kenji
       response = {            # default structure. TODO: figure out if i really want to keep this 
         :status => code,
         :message => message
-      }
-      hash.each { |k,v| response[k]=v }
+      }.merge(hash)
       throw(:KenjiRespondControlFlowInterrupt, [@status, @headers, [response.to_json]])
     end
 
@@ -164,7 +176,8 @@ module Kenji
       end
     end
 
-    # Will attempt to fetch the controller, and verify that it is a implements call 
+    # Will attempt to fetch the controller, and verify that it is a implements
+    # call.
     #
     def controller_for(subpath)
       subpath = '/_' if subpath == '/'
@@ -173,7 +186,15 @@ module Kenji
       require path
       controller_name = subpath.split('/').last.sub(/^_/, 'Root')
       controller_class = Object.const_get(controller_name.to_s.to_camelcase+'Controller')
-      return unless controller_class.method_defined?(:call) && controller_class.instance_method(:call).arity == 2 # ensure protocol compliance
+      controller_instance(controller_class)
+    end
+
+    # Attempts to instantiate the controller class, set up as a Kenji
+    # controller.
+    #
+    def controller_instance(controller_class)
+      # ensure protocol compliance
+      return unless controller_class.method_defined?(:call) && controller_class.instance_method(:call).arity == 2
       controller = controller_class.new
       controller.kenji = self if controller.respond_to?(:kenji=)
       return controller if controller

data/spec/5/controllers/main.rb

@@ -0,0 +1,10 @@
+module Spec5
+  class MainController < Kenji::Controller
+    get '/' do
+      { :foo => 'bar' }
+    end
+    get '/path' do
+      { :baz => 'bar' }
+    end
+  end
+end

data/spec/kenji_spec.rb

@@ -9,9 +9,9 @@ require 'kenji'
 
 # NOTE: these tests make use of the controllers defined in test/controllers.
 
-def app_for(path)
+def app_for(path, opts={})
   lambda do |env|
-    kenji = Kenji::Kenji.new(env, File.dirname(__FILE__)+'/'+path)
+    kenji = Kenji::Kenji.new(env, File.dirname(__FILE__)+'/'+path, opts)
     kenji.stderr = double(puts: nil)
     kenji.call
   end
@@ -158,4 +158,31 @@ describe Kenji::Kenji, 'expected reponses' do
     end
   end
 
+  context '5' do
+    before do
+      require File.expand_path('./5/controllers/main.rb', File.dirname(__FILE__))
+    end
+
+    def app; app_for('5', root_controller: Spec5::MainController); end
+
+    it "should use main controller for /" do
+      get '/'
+      expected_response = { :foo => 'bar' }.to_json
+      last_response.body.should == expected_response
+      last_response.status.should == 200
+    end
+
+    it "should use main controller for /path" do
+      get '/path'
+      expected_response = { :baz => 'bar' }.to_json
+      last_response.body.should == expected_response
+      last_response.status.should == 200
+    end
+
+    it "should 404 on main controller" do
+      put '/main/foo/foo_id/pass/pass_id'
+      last_response.status.should == 404
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kenji
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '1.0'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -95,7 +95,7 @@ description: A lightweight Ruby web framework.
 email:
 - kenneth@ballenegger.com
 executables:
-- kenji-init
+- kenji
 extensions: []
 extra_rdoc_files: []
 files:
@@ -104,20 +104,16 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/kenji-init
+- bin/kenji
 - inited/.gitignore
 - inited/Gemfile
 - inited/README.md
 - inited/__APP_NAME__
 - inited/config.ru
-- inited/configuration/README
 - inited/controllers/main.rb
-- inited/lib/README
-- inited/models/README
+- inited/lib/README.md
 - inited/public/humans.txt
 - inited/public/index.html
-- inited/scripts/README
-- inited/tmp/README
 - inited/tmp/always_restart.txt
 - kenji.gemspec
 - lib/kenji.rb
@@ -131,6 +127,7 @@ files:
 - spec/4/controllers/bar.rb
 - spec/4/controllers/main.rb
 - spec/4/controllers/pass.rb
+- spec/5/controllers/main.rb
 - spec/kenji_spec.rb
 homepage: https://github.com/kballenegger/kenji
 licenses: []
@@ -164,5 +161,6 @@ test_files:
 - spec/4/controllers/bar.rb
 - spec/4/controllers/main.rb
 - spec/4/controllers/pass.rb
+- spec/5/controllers/main.rb
 - spec/kenji_spec.rb
 has_rdoc: 

data/inited/configuration/README

@@ -1 +0,0 @@
-This is where configuration goes.

data/inited/models/README

@@ -1 +0,0 @@
-This is where models go.

data/inited/scripts/README

@@ -1 +0,0 @@
-This is where scripts go.

data/inited/tmp/README

@@ -1 +0,0 @@
-This folder is for Rack & Passenger to use.