mini-train 0.1.0

data/README.md

@@ -0,0 +1,108 @@
+>There's a lady who sures
+>all that glitters is gold  
+>and she's buying a stairway to heaven  -- Led Zeppelin
+
+mini-train
+=====
+
+mini-train is an attempt to fork from a rack project(rack-golem) into
+a very simple web mini-framework (thats the name mini-train)
+
+Install with: (there are no gems yet, so don't try to install right now)
+
+    sudo gem install mini-train
+
+You can use config.ru as a start up file as for any rack app based
+
+    require 'models' # Loads your models and all ORM stuff
+    require 'app' # This is the main file
+    require 'json' # Some help from other gems
+    use Rack::ContentLength
+    use Rack::Session::Cookies
+    run App
+
+Now save this into app.rb
+
+    require 'minitrain'
+
+  	class App
+	    include Minitrain # Still no classes to inherit but don't worry just await!
+
+	    before do
+	      # Here you can do many things
+	      # In order to help you here are some variables you can read and override:
+	      # @r => the Rack::Request object
+	      # @res => the Rack::Response object
+	      # @action => Name of the public method that will handle the request
+	      # @action_arguments => Arguments for the action (really?)
+	    end
+
+      helpers do
+				#altough you can write many things in before block
+				#you always need helpers for your main app
+				def help(with)
+					"Helping the World!"
+				end
+			end
+			
+	    def index(*args)
+	      # When no public method is found
+	      # Of course you don't have to declare one and it is gonna use Controller#not_found instead
+	      # Still can have arguments
+	      @articles = Post.all
+	      erb :index
+	    end
+
+	    def post(id=nil)
+	      @post = Post[id]
+	      if @post.nil?
+	        not_found
+	      else
+	        erb :post
+	      end
+	    end
+	    
+	    def best_restaurants_json
+	      # mini-train replaces dots and dashes with underscores
+	      # So you can trigger this handler by visiting /best-restaurant.json
+	      json_response({
+	        'title' => 'Best restaurants in town',
+	        'list' => Restaurant.full_list
+	      })
+
+	    def say(listener='me', *words)
+	      "Hey #{listener} I don't need ERB to tell you that #{words.join(' ')}"
+	    end
+
+	    def not_found(*args)
+	      # This one is defined by mini-train but here we decided to override it
+	      # Like :index this method receives the arguments in order to make something with it
+	      Email.alert('Too many people are looking for porn here') if args.includes?("porn")
+	      super(args)
+	    end
+	    
+	    def error(err, *args)
+	      # Again this one is defined by mini-train and only shows up when RACK_ENV is not `nil` or `dev` or `development`
+	      # Default only prints "ERROR"
+	      # Here we're going to send the error message
+	      # One would rarely show that to the end user but this is just a demo
+	      err.message
+	    end
+
+	    after do
+	      Spy.analyse.send_info_to([:government, :facebook, :google, :james_bond])
+	      #this was a joke
+	    end
+
+	  end
+
+You need to provide the class Post in your models.
+Class Spy doesn't exist so you need to create it (he he, just kidding).
+
+WHAT mini-train DOES NOT
+===================
+
+- Support templates other than ERB (Slim, Haml and other tilt based templates has been added)
+- Session/Cookies administration (Like for many things, use a middleware instead ex: Rack::Session::Cookies)
+- Prepare the coffee (Emacs does but i had never used it, just geany)
+- So many things, but what is a fork for...

data/lib/minitrain.rb

@@ -0,0 +1,111 @@
+require 'rack'
+require 'tilt'
+
+module Minitrain
+  
+  def self.included(klass)
+    klass.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+    end
+  end
+  
+  module ClassMethods
+    attr_reader :before_block, :helpers_block, :after_block
+    def before(&block); @before_block = block; end
+    def helpers(&block); @helpers_block = block; end
+    def after(&block); @after_block = block; end
+    def dispatcher(&block); @dispatcher_block = block; end
+    def dispatcher_block
+      @dispatcher_block || proc{
+        @path_atoms = @r.path_info.split('/').find_all{|s| s!=''}
+        @action, *@action_arguments = @path_atoms
+        @action = @action.gsub(/[-.]/, '_') unless @action.nil?
+        unless public_methods.include?(@action)||(@action&&public_methods.include?(@action.to_sym))
+          if public_methods.include?('index')||public_methods.include?(:index) # For different RUBY_VERSION(s)
+            @action, @action_arguments = 'index', @path_atoms
+          else
+            @action, @action_arguments = 'not_found', @path_atoms
+          end
+        end
+        instance_eval(&self.class.before_block) unless self.class.before_block.nil?
+        instance_eval(&self.class.helpers_block) unless self.class.helpers_block.nil?
+        begin
+          @res.write(self.__send__(@action,*@action_arguments))
+        rescue ArgumentError => e
+          failed_method = e.backtrace[0][/`.*'$/][1..-2]
+          raise unless failed_method==@action
+          @res.write(self.__send__('not_found', @path_atoms))
+        end
+        instance_eval(&self.class.after_block) unless self.class.after_block.nil?
+      }
+    end
+  end
+  
+  module InstanceMethods
+    
+    DEV_ENV = [nil,'development','dev']
+    
+    def initialize(app=nil); @app = app; end
+    def call(env); dup.call!(env); end
+    
+    def call!(env)
+      catch(:response) {
+        @r = ::Rack::Request.new(env)
+        @res = ::Rack::Response.new
+        @session = env['rack.session'] || {}
+        begin
+          instance_eval(&self.class.dispatcher_block)
+        rescue => e
+          raise if DEV_ENV.include?(ENV['RACK_ENV'])
+          @res.write(self.__send__('error', e, @path_atoms))
+        end
+        @res.status==404&&!@app.nil? ? @app.call(env) : @res.finish
+      }
+    end
+    
+    def not_found(*args)
+      @res.status = 404
+      @res.headers['X-Cascade']='pass'
+      "NOT FOUND: #{@r.path_info}"
+    end
+    
+    def error(e, *args)
+      puts "\n", e.class, e.message, e.backtrace # Log the error anyway
+      @res.status = 500
+      "ERROR 500"
+    end
+    
+    def tpl(template, extention)
+			key = (template.to_s + extention.gsub(/[.]/,"_")).to_sym
+      @@tilt_cache ||= {}
+      if @@tilt_cache.has_key?(key)
+        template_obj = @@tilt_cache[key]
+      else
+        views_location = @r.env['views'] || ::Dir.pwd+'/views/'
+        views_location << '/' unless views_location[-1]==?/
+        template_obj = Tilt.new("#{views_location}#{template}#{extention}")
+        @@tilt_cache.store(key,template_obj) if ENV['RACK_ENV']=='production'
+      end
+      @res['Content-Type'] = "text/html;charset=utf-8"
+      template_obj.render(self)
+    end
+    
+		def erb(template)
+			tpl(template,'.erb')
+		end
+		
+		def slim(template)
+			tpl(template,'.slim')
+		end
+		
+		def haml(template)
+			tpl(template,'.haml')
+		end
+
+		def scss(template)
+			tpl(template,'.scss')
+		end
+  end
+  
+end

data/mini-train.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s| 
+  s.name = 'mini-train'
+  s.version = "0.1.0"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "An attempt to create a web mini-framework forked from an rack app (rack-golem)"
+  s.description = "This is a simplistic web framework"
+  s.files = `git ls-files`.split("\n").sort
+  s.require_path = './lib'
+  s.author = "Carlos Esquer"
+  s.email = "carlitos.esquer@gmail.com"
+  s.homepage = "http://rubymx.blogspot.com"
+  s.add_dependency(%q<tilt>, [">= 1.2.2"])
+  #s.add_development_dependency(%q<bacon>, "~> 1.1.0")
+end

data/sample/app.rb

@@ -0,0 +1,104 @@
+require 'minitrain'
+require 'slim'
+require 'yaml'
+require 'json'
+class App
+	include Minitrain # Still no classes to inherit but don't worry just await!
+
+	before do
+		# Here you can do many things
+		# In order to help you here are some variables you can read and override:
+		# @r => the Rack::Request object
+		# @res => the Rack::Response object
+		# @action => Name of the public method that will handle the request
+		# @action_arguments => Arguments for the action (really?)
+	end
+
+	helpers do
+		#altough you can write many things in before block
+		#we recommend you to write helpers here to give your app some structure
+		def simple
+			"<b>Siempre genera BOLD</b>"
+		end
+
+    def json_response(data=nil)
+			@res['Content-Type'] = "text/plain;charset=utf-8"
+			data.nil? ? "{}" : JSON.generate(data)
+    end
+    
+    def yaml_response(data=nil)
+			@res['Content-Type'] = "text/plain;charset=utf-8"
+			data.to_yaml
+    end
+    
+	end
+
+	def index(*args)
+		# When no public method is found
+		# Of course you don't have to declare one and it is gonna use Controller#not_found instead
+		# Still can have arguments
+		@articles = [{titulo: "hola mundo",contenido: "Este mundo material"},
+								 {titulo: "bienvenidos", contenido: "Nunca habra paz..."},
+								 {titulo: "el final", contenido: "como en los viejos tiempos"}
+								]
+		simple + (slim :index)
+		#"<h1>Bienvenido</h1><br><h3>Hola mundo...</h3>"
+	end
+
+	def post(id=nil)
+		@post = Post[id]
+		if @post.nil?
+			not_found
+		else
+			erb :post
+		end
+	end
+
+	def best_restaurants_json
+		# mini-train replaces dots and dashes with underscores
+		# So you can trigger this handler by visiting /best-restaurants.json
+		json_response({
+			'title' => 'Best restaurants in town',
+			'list' => "{ nuevo: 'artículo', antiguo: 'años'}"
+		})
+	end
+
+	def best_restaurants_yaml
+		#you can generate YAML responses (next time we will use XML)
+		yaml_response({
+			'title' => 'Best restaurants in town',
+			'list' => "{ nuevo: 'artículo', antiguo: 'años'}"
+		})
+	end
+	
+	def envy(*args)
+		@res['Content-Type'] = "text/html;charset=utf-8"
+		my_res = ""
+		my_res += "<p> Método: #{@r.request_method}</p>"
+		my_res += "<p> Metodo: #{@r.query_string}</p>"
+	end
+	
+	def say(listener='me', *words)
+		"Hey #{listener} I don't need ERB to tell you that #{words.join(' ')}"
+	end
+
+	def not_found(*args)
+		# This one is defined by mini-train but here we decided to override it
+		# Like :index this method receives the arguments in order to make something with it
+		#Email.alert('Too many people are looking for porn here') if args.includes?("porn")
+		super(args)
+	end
+
+	def error(err, *args)
+		# Again this one is defined by mini-train and only shows up when RACK_ENV is not `nil` or `dev` or `development`
+		# Default only prints "ERROR"
+		# Here we're going to send the error message
+		# One would rarely show that to the end user but this is just a demo
+		err.message
+	end
+
+	after do
+		#Spy.analyse.send_info_to([:government, :facebook, :google, :james_bond])
+	end
+end
+

data/sample/config.ru

@@ -0,0 +1,6 @@
+#require 'models' # Loads your models and all ORM stuff
+require './app' # This is the main file
+# Some help from other gems
+use Rack::ContentLength
+#use Rack::Session::Cookies
+run App.new

data/sample/views/index.erb

@@ -0,0 +1,8 @@
+<head>
+<link rel='stylesheet' type='text/css' href='http://fonts.googleapis.com/css?family=Play:400,700'/>
+<link rel="stylesheet" type="text/css" href="/css/layout.css"/>
+</head>
+<h1>Algunos artículos (.erb)...<h1>
+<% @articles.each do |art| %>
+<h2> <%= art[:titulo] %> </h2>
+<% end %>

data/sample/views/index.haml

@@ -0,0 +1,9 @@
+%head
+	%link{:rel=>'stylesheet', :type=>'text/css', :href=>'http://fonts.googleapis.com/css?family=Play:400,700'}
+	%link{:rel=>"stylesheet", :type=>"text/css", :href=>"/css/layout.css"}
+%body
+	%h1 Algunos artículos (.haml)...
+	%br
+	- @articles.each do |art|
+		%h2= art[:titulo]
+		%br

data/sample/views/index.slim

@@ -0,0 +1,11 @@
+head
+	link rel='stylesheet' type='text/css' href='http://fonts.googleapis.com/css?family=Play:400,700'
+	link rel="stylesheet" type="text/css" href="/css/layout.css"
+body
+	h1 Algunos artículos (.slim)...
+	br
+	- @articles.each do |art|
+		h2= art[:titulo]
+		br
+		.content=art[:contenido]
+	

data/test/minitrain-test.rb

@@ -0,0 +1,185 @@
+require 'minitest/autorun'
+require 'rack/lobster'
+require 'minitrain'
+
+# =========
+# = Basic =
+# =========
+
+class Basic
+  include Minitrain
+  def no_arg; 'nothing'; end  
+  def with_args(a,b); '%s+%s' % [a,b]; end 
+  def splat_arg(*a); a.join('+'); end
+  def test_throw
+    throw :response, [200,{'Content-Type'=>'text/html'},['Growl']]
+    'Grrr'
+  end
+  def best_restaurants_rss; '<xml>test</xml>'; end
+  private
+  def no_way; 'This is private'; end
+end
+BasicR = ::Rack::MockRequest.new(::Rack::Lint.new(Basic.new))
+BasicLobsterR = ::Rack::MockRequest.new(::Rack::Lint.new(Basic.new(::Rack::Lobster.new)))
+
+# ==========
+# = Filter =
+# ==========
+
+class Filter
+  include Minitrain
+  before{@res.write @action=='not_found' ? @action_arguments.join('+') : 'before+'}
+  after{@res.write '+after'}
+  def wrapped; 'wrapped'; end
+end
+FilterR = ::Rack::MockRequest.new(::Rack::Lint.new(Filter.new))
+
+# ===========
+# = Indexed =
+# ===========
+
+class Indexed
+  include Minitrain
+  before{ @res.write("action=#{@action} args=#{@action_arguments.join(',')} ") if @r['switch']=='true' }
+  def index(*a); a.join('+'); end
+  def exist(*a); a.join('+'); end
+end
+IndexedR = ::Rack::MockRequest.new(::Rack::Lint.new(Indexed.new))
+
+# ==================
+# = Simply indexed =
+# ==================
+
+class SimplyIndexed
+  include Minitrain
+  def index; 'index'; end
+  def will_fail; please_fail; end
+  private
+  def please_fail(num); 'ArgumentError baby'; end
+end
+SimplyIndexedR = ::Rack::MockRequest.new(::Rack::Lint.new(SimplyIndexed.new))
+SimplyIndexedUsedR = ::Rack::MockRequest.new(::Rack::Lint.new(SimplyIndexed.new(lambda{|env| [200,{},"#{3+nil}"]})))
+
+# =============
+# = Sessioned =
+# =============
+
+class Sessioned
+  include Minitrain
+  def set_val(val); @session[:val] = val; end
+  def get_val; @session[:val]; end
+end
+SessionedR = ::Rack::MockRequest.new(::Rack::Session::Cookie.new(::Rack::Lint.new(Sessioned.new)))
+
+# =============
+# = Helpers =
+# =============
+
+class UsingHelpers
+	include Minitrain
+	helpers { def hola(w); "Hola " + w; end }
+	def index; hola("mundo");	end
+end
+UsinghelpersR = ::Rack::MockRequest.new(::Rack::Lint.new(UsingHelpers.new))
+
+# =========
+# = Specs =
+# =========
+
+describe "Minitrain" do
+  
+  it "Should dispatch on a method with no arguments" do
+    assert_equal "nothing",BasicR.get('/no_arg').body
+  end
+  
+  it "Should dispatch on a method with arguments" do
+    assert_equal "a+b",BasicR.get('/with_args/a/b').body
+  end
+  
+  it "Should dispatch on a method with splat argument" do
+    assert_equal "a+b+c+d",BasicR.get('/splat_arg/a/b/c/d').body
+  end
+  
+  it "Should not dispatch if the method is private or does not exist" do
+    r = BasicR.get('/no_way')
+    assert_equal 404,r.status
+    assert_equal "NOT FOUND: /no_way",r.body
+    r = BasicR.get('/no')
+    assert_equal 404,r.status
+    assert_equal "NOT FOUND: /no",r.body
+  end
+  
+  it "Should dispatch to appropriate underscored action when name contains '-' or '.'" do
+    assert_equal "<xml>test</xml>",BasicR.get('/best-restaurants.rss').body
+  end
+  
+  it "Should only apply '-' and '.' substitution on action names" do
+    assert_equal 'best-restaurants.rss',IndexedR.get('/best-restaurants.rss').body
+  end
+  
+  it "Should follow the rack stack if response is 404 and there are middlewares below" do
+    r = BasicLobsterR.get("/no_way")
+    assert_equal 200,r.status
+  end
+  
+  it "Should provide filters" do
+    assert_equal "before+wrapped+after",FilterR.get('/wrapped').body
+  end
+  
+  it "Should provide arguments in filter when page is not_found" do
+    assert_equal "a+b+c+dNOT FOUND: /a/b/c/d+after",FilterR.get('/a/b/c/d').body
+  end
+  
+  it "Should send everything to :index if it exists and there is no matching method for first arg" do
+    assert_equal 'a+b+c+d',IndexedR.get('/exist/a/b/c/d').body
+    assert_equal 'a+b+c+d',IndexedR.get('/a/b/c/d').body
+    assert_equal '',IndexedR.get('/').body
+  end
+  
+  it "Should send not_found if there is an argument error on handlers" do
+    assert_equal 200,SimplyIndexedR.get('/').status
+    assert_equal 404,SimplyIndexedR.get('/unknown').status
+    assert_equal 404,SimplyIndexedR.get('/will_fail/useless').status
+    assert_raises(ArgumentError) { SimplyIndexedR.get('/will_fail') }
+  end
+  
+  it "Should handle errors without raising an exception unless in dev mode" do
+    assert_raises(ArgumentError) { SimplyIndexedR.get('/will_fail') }
+    ENV['RACK_ENV'] = 'development'
+    assert_raises(ArgumentError) { SimplyIndexedR.get('/will_fail') }
+    ENV['RACK_ENV'] = 'production'
+    @old_stdout = $stdout
+    $stdout = StringIO.new
+    res = SimplyIndexedR.get('/will_fail')
+    logged = $stdout.dup
+    $stdout = @old_stdout
+    assert_equal res.status,500
+    assert_match logged.string, /ArgumentError/
+    ENV['RACK_ENV'] = nil
+  end
+  
+  it "Should not use the error handler if the error occurs further down the rack stack" do
+    ENV['RACK_ENV'] = 'production'
+    assert_raises(TypeError) { SimplyIndexedUsedR.get('/not_found') }
+    ENV['RACK_ENV'] = nil
+  end
+  
+  it "Should set dispatch-specific variables correctly when defaulting to :index" do
+    assert_equal "action=index args=a,b,c,d a+b+c+d",IndexedR.get('/a/b/c/d?switch=true').body
+  end
+  
+  it "Should have a shortcut for session hash" do
+    res = SessionedR.get('/set_val/ichigo')
+    res_2 = SessionedR.get('/get_val', 'HTTP_COOKIE'=>res["Set-Cookie"])
+    assert_equal 'ichigo',res_2.body
+  end
+  
+  it "Should catch :response if needed" do
+    assert_equal BasicR.get('/test_throw').body,'Growl'
+  end
+  
+  it "Should response with the helpers content" do
+    assert_equal UsinghelpersR.get('/').body,'Hola mundo'
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: mini-train
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Carlos Esquer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &71720560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *71720560
+description: This is a simplistic web framework
+email: carlitos.esquer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/minitrain.rb
+- mini-train-0.1.0.gem
+- mini-train.gemspec
+- sample/app.rb
+- sample/config.ru
+- sample/views/index.erb
+- sample/views/index.haml
+- sample/views/index.slim
+- test/minitrain-test.rb
+homepage: http://rubymx.blogspot.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- ./lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An attempt to create a web mini-framework forked from an rack app (rack-golem)
+test_files: []