RubyGems - tanuki - Versions diffs - 0.1.3 - Mend

tanuki 0.1.3

Files changed (36) hide show

data/LICENSE +19 -0
data/README.rdoc +19 -0
data/app/tanuki/controller/controller.rb +3 -0
data/app/tanuki/controller/default.thtml +5 -0
data/app/tanuki/controller/index.thtml +1 -0
data/app/tanuki/controller/link.thtml +7 -0
data/app/tanuki/object/object.rb +3 -0
data/app/tanuki/page/missing/default.thtml +2 -0
data/app/tanuki/page/missing/missing.rb +9 -0
data/app/user/page/index/default.thtml +121 -0
data/app/user/page/index/index.rb +2 -0
data/bin/tanuki +55 -0
data/lib/tanuki/application.rb +111 -0
data/lib/tanuki/argument/base.rb +27 -0
data/lib/tanuki/argument/integer.rb +15 -0
data/lib/tanuki/argument/integer_range.rb +22 -0
data/lib/tanuki/argument/string.rb +15 -0
data/lib/tanuki/argument.rb +41 -0
data/lib/tanuki/configurator.rb +93 -0
data/lib/tanuki/context.rb +36 -0
data/lib/tanuki/controller_behavior.rb +324 -0
data/lib/tanuki/i18n.rb +33 -0
data/lib/tanuki/launcher.rb +20 -0
data/lib/tanuki/loader.rb +131 -0
data/lib/tanuki/module_extensions.rb +27 -0
data/lib/tanuki/object_behavior.rb +32 -0
data/lib/tanuki/template_compiler.rb +145 -0
data/lib/tanuki/version.rb +6 -0
data/lib/tanuki.rb +22 -0
data/schema/tanuki/l10n/en/controller.yml +13 -0
data/schema/tanuki/l10n/en/page.yml +31 -0
data/schema/tanuki/l10n/ru/controller.yml +13 -0
data/schema/tanuki/l10n/ru/page.yml +31 -0
data/schema/tanuki/models/controller.yml +18 -0
data/schema/tanuki/models/page.yml +48 -0
metadata +168 -0

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Anatoly Ressin, Dimitry Solovyov
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc ADDED Viewed

@@ -0,0 +1,19 @@
+= Tanuki
+Tanuki is a web application framework inspired by the MVVM pattern with focus
+on DRY code and extensibility. Tanuki tries to keep its looks close to
+idiomatic Ruby, so you would feel at home.
+== Quick Start
+Fire up the terminal and type:
+  $ gem install tanuki
+  $ tanuki create test
+  $ ruby test/main.rb
+View the result at: http://localhost:3000
+== Resources
+{Home Page}[http://bitbucket.org/dimituri/tanuki]

data/app/tanuki/controller/controller.rb ADDED Viewed

@@ -0,0 +1,3 @@
+class Tanuki_Controller < Tanuki_Object
+  include Tanuki::ControllerBehavior
+end

data/app/tanuki/controller/default.thtml ADDED Viewed

@@ -0,0 +1,5 @@
+% if visual_child
+<%! visual_child.default_view -%>
+% else
+<%! index_view -%>
+% end

data/app/tanuki/controller/index.thtml ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= self.class %> is under construction

data/app/tanuki/controller/link.thtml ADDED Viewed

@@ -0,0 +1,7 @@
+% if current?
+<span class="active"><%= self %></span>
+% elsif active?
+<a class="active" href="<%= self.link %>"><%= self %></a>
+% else
+<a href="<%= self.link %>"><%= self %></a>
+% end

data/app/tanuki/object/object.rb ADDED Viewed

@@ -0,0 +1,3 @@
+class Tanuki_Object
+  include Tanuki::ObjectBehavior
+end

data/app/tanuki/page/missing/default.thtml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>Oh no!</h1>
2	+ <p>Tanuki broke free at <%= ctx.env['REQUEST_URI'] %>!</p>

data/app/tanuki/page/missing/missing.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class Tanuki_Page_Missing < Tanuki_Controller
+  def visual_parent
+    nil
+  end
+  def result_type
+    :not_found
+  end
+end

data/app/user/page/index/default.thtml ADDED Viewed

@@ -0,0 +1,121 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <title>Welcome to Tanuki</title>
+    <style type="text/css" media="screen">
+    body {
+        margin: 0;
+        padding: 0;
+        font-family: 'Trebuchet MS', Helvetica, sans-serif;
+        font-size: 11pt;
+        background-color: #f5f4ef;
+        color: #000305;
+    }
+    #header {
+        margin: 0 auto;
+        width: 540px;
+    }
+    div.top {
+        background-color: #fff;
+        margin: 0 auto 20px auto;
+        padding: 15px 20px 0 20px;
+        width: 540px;
+        border-radius: 10px;
+        -moz-border-radius: 10px;
+        -webkit-border-radius: 10px;
+    }
+    h1 {
+        margin: 20px 0;
+        padding: 0;
+        font-size: 22pt;
+    }
+    h1 em {
+        display: block;
+        font-style: normal;
+        font-size: 12pt;
+        color: #777a7c;
+    }
+    h2 {
+        margin: 0 0 15px 0;
+        padding: 0;
+        font-size: 16pt;
+    }
+    #next ol {
+        margin: 0;
+        padding-bottom: 25px;
+    }
+    #next li {
+        margin: 0;
+        padding: 0;
+        font-size: 16pt;
+        font-weight: bold;
+        color: #c74451;
+    }
+    #next li span {
+        font-size: 11pt;
+        font-weight: normal;
+        color: #000305;
+    }
+    code {
+        font-family: 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', Menlo, Monaco, Consolas, 'Courier New', monospace;
+        font-size: 10pt;
+        background-color: #fffccc;
+        padding: 1px 3px;
+    }
+    #env div {
+        padding-bottom: 25px;
+    }
+    #env table {
+        margin: 0;
+        padding: 0;
+        border-collapse: collapse;
+        color: #444;
+    }
+    #env table th {
+        text-align: left;
+    }
+    #env table td {
+        padding-left: 20px;
+        font-size: 10pt;
+    }
+    </style>
+</head>
+<body>
+    <div id="header">
+        <h1>It Works! <em>You have been granted one Tanuki.</em></h1>
+    </div>
+    <div class="top" id="next">
+        <h2>What to do next</h2>
+        <div>
+            <p>Here's a few suggestions to get things going:</p>
+            <ol>
+                <li><span>To use a database, describe its contents in <code>schema/user</code>.</span></li>
+                <li><span>To generate models from your schema, type <code>rake tanuki:models</code>.</span></li>
+                <li><span>To add or edit controllers, navigate to <code>app/user</code>.</span></li>
+            </ol>
+        </div>
+    </div>
+    <div class="top" id="env">
+        <h2>Your setup</h2>
+        <div><table>
+            <tr><th>Ruby</th><td><%= RUBY_VERSION %> (<%= RUBY_RELEASE_DATE %>) [<%= RUBY_PLATFORM %>]</td></tr>
+            <tr><th>Rack</th><td><%= Rack.version %> (on <%= ctx.env['SERVER_SOFTWARE'] %>)</td></tr>
+            <tr><th>Tanuki</th><td><%= Tanuki::VERSION %></td></tr>
+        </table></div>
+    </div>
+</body>
+</html>

data/app/user/page/index/index.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class User_Page_Index < Tanuki_Controller
2	+ end

data/bin/tanuki ADDED Viewed

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+module Tanuki
+  class << self
+    def create(name)
+      require 'fileutils'
+      version
+      puts "\n creating #{name = name.downcase}"
+      FileUtils.mkdir name
+      puts " copying app/tanuki"
+      FileUtils.mkdir_p File.join(name, 'app', 'tanuki')
+      FileUtils.cp_r File.expand_path(File.join('..', '..', 'app', 'tanuki'), __FILE__), File.join(name, 'app')
+      puts " copying app/user"
+      FileUtils.mkdir_p File.join(name, 'app', 'user')
+      FileUtils.cp_r File.expand_path(File.join('..', '..', 'app', 'user'), __FILE__), File.join(name, 'app')
+      puts " creating cache"
+      FileUtils.mkdir(File.join(name, 'cache'))
+      puts " copying schema"
+      FileUtils.mkdir(File.join(name, 'schema'))
+      FileUtils.cp_r File.expand_path(File.join('..', '..', 'schema'), __FILE__), name
+      puts " writing main"
+      File.open(File.join(name, 'main.rb'), 'w') {|file| file.write "require 'tanuki'\nTanuki.development_application" }
+    end
+    def help
+      version
+      puts "\nbasic commands:\n"
+      {
+        'help'    => 'show help (this text)',
+        'create'  => 'create a new app with the given name',
+        'version' => 'show framework version'
+      }.each_pair {|k, v| puts ' %-7s   %s' % [k, v] }
+    end
+    def init
+      case ARGV[0]
+      when /\Ac(r(e(a(te?)?)?)?)?\Z/, '--create', '-c' then create(ARGV[1])
+      when /\Ah(e(lp?)?)?\Z/, '--help', '-h', nil then help
+      when /\Av(e(r(s(i(on?)?)?)?)?)?\Z/, '--version', '-v' then version
+      else create(ARGV[0])
+      end
+    end
+    def version
+      begin
+        require 'tanuki/version'
+      rescue LoadError
+        $:.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__)
+        require 'tanuki/version'
+      end
+      puts "Tanuki version #{VERSION}"
+    end
+  end
+end
+Tanuki.init if File.basename(__FILE__) == File.basename($0)

data/lib/tanuki/application.rb ADDED Viewed

@@ -0,0 +1,111 @@
+module Tanuki
+  # Tanuki::Application is the starting point for all framework applications.
+  # It contains core application functionality like configuration, request handling and view management.
+  class Application
+    @context = Loader.context = Context.new
+    @rack_middleware = {}
+    class << self
+      # Removes a given middleware from the Rack middleware pipeline
+      def discard(middleware)
+        @rack_middleware.delete(middleware)
+      end
+      # Runs the application with current settings
+      def run
+        rack_builder = Rack::Builder.new
+        @rack_middleware.each {|middleware, params| rack_builder.use(middleware, *params[0], &params[1]) }
+        rack_builder.run(rack_app)
+        srv = available_server
+        puts "A wild Tanuki appears!", "You used #{srv.name.gsub(/.*::/, '')} at #{@context.host}:#{@context.port}."
+        srv.run rack_builder.to_app, :Host => @context.host, :Port => @context.port
+      end
+      # Sets an option to value in the current context.
+      def set(option, value)
+        @context.send("#{option}=".to_sym, value)
+      end
+      # Adds a given middleware to the Rack middleware pipeline
+      def use(middleware, *args, &block)
+        @rack_middleware[middleware] = [args, block]
+      end
+      # Adds a template visitor block. This block must return a Proc.
+      #
+      #  visitor :escape do
+      #    s = ''
+      #    proc {|out| s << CGI.escapeHTML(out.to_s) }
+      #  end
+      #  visitor :printf do |format|
+      #    s = ''
+      #    proc {|out| s << format % out.to_s }
+      #  end
+      #
+      # It can later be used in a template via the visitor syntax.
+      #
+      #  <%_escape escaped_view %>
+      #  <%_printf('<div>%s</div>') formatted_view %>
+      def visitor(sym, &block)
+        ObjectBehavior.instance_eval { define_method "#{sym}_visitor".to_sym, &block }
+      end
+      private
+      # Returns the first available server from a server list in the current context.
+      def available_server
+        @context.server.each do |server_name|
+          begin
+            return Rack::Handler.get(server_name.downcase)
+          rescue LoadError
+          rescue NameError
+          end
+        end
+        raise "servers #{@context.server.join(', ')} not found"
+      end
+      # Returns an array of template outputs for controller ctrl in context ctx.
+      def build_body(ctrl, request_ctx)
+        arr = []
+        Launcher.new(ctrl, request_ctx).each &proc {|out| arr << out.to_s }
+      end
+      # Returns a Rack app block for Rack::Builder.
+      # This block is passed a request environment and returns and array of three elements:
+      # * a response status code,
+      # * a hash of headers,
+      # * an iterable body object.
+      # It is run on each request.
+      def rack_app
+        ctx = @context
+        proc do |env|
+          request_ctx = ctx.child
+          request_ctx.templates = {}
+          if match = env['REQUEST_PATH'].match(/^(.+)(?<!\$)\/$/)
+            loc = match[1]
+            loc << "?#{env['QUERY_STRING']}" unless env['QUERY_STRING'].empty?
+            [301, {'Location' => loc, 'Content-Type' => 'text/html; charset=utf-8'}, []]
+          else
+            request_ctx.env = env
+            result = ::Tanuki::ControllerBehavior.dispatch(request_ctx, ctx.i18n ? ::Tanuki::I18n : ctx.root_page,
+              Rack::Utils.unescape(env['REQUEST_PATH']).force_encoding('UTF-8'))
+            case result[:type]
+            when :redirect then
+              [302, {'Location' => result[:location], 'Content-Type' => 'text/html; charset=utf-8'}, []]
+            when :page then
+              [200, {'Content-Type' => 'text/html; charset=utf-8'}, build_body(result[:controller], request_ctx)]
+            else
+              [404, {'Content-Type' => 'text/html; charset=utf-8'}, build_body(result[:controller], request_ctx)]
+            end
+          end
+        end
+      end
+    end # end class << self
+  end # end Application
+end # end Tanuki

data/lib/tanuki/argument/base.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module Tanuki
+  module Argument
+    # Tanuki::Argument::Base is the base class for argument types.
+    class Base
+      attr_reader :default, :value
+      # Initializes the argument with a default value.
+      def initialize(default)
+        @value = @default = default
+      end
+      # Returns a string representation of the argument value.
+      def to_s
+        @value.to_s
+      end
+      # Sets the value with required rules.
+      def value=(obj)
+        @value = to_value(obj)
+      end
+    end # end Base
+  end # end Argument
+end # end Tanuki

data/lib/tanuki/argument/integer.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Tanuki
+  module Argument
+    # Tanuki::Argument::Integer is a class for Integer arguments.
+    class Integer < Base
+      # Returns argument value from a string representation.
+      def to_value(obj)
+        begin Kernel::Integer obj rescue @default end
+      end
+    end # end Integer
+  end # end Argument
+end # end Tanuki

data/lib/tanuki/argument/integer_range.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Tanuki
+  module Argument
+    # Tanuki::Argument::IntegerRange is a class for Integer arguments with a certain value range.
+    class IntegerRange < Integer
+      # Initializes the argument with a default value and allowed value range.
+      def initialize(range, default=nil)
+        super(default ? default : range.first)
+        @range = range
+      end
+      # Returns argument value from a string representation.
+      def to_value(obj)
+        i = super(obj)
+        @range.include?(i) ? i : @default
+      end
+    end # end IntegerRange
+  end # end Argument
+end # end Tanuki

data/lib/tanuki/argument/string.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Tanuki
+  module Argument
+    # Tanuki::Argument::String is a class for String arguments.
+    class String < Base
+      # Returns argument value from a string representation.
+      def to_value(obj)
+        obj.to_s
+      end
+    end # end String
+  end # end Argument
+end # end Tanuki

data/lib/tanuki/argument.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'tanuki/argument/base'
+require 'tanuki/argument/integer'
+require 'tanuki/argument/integer_range'
+require 'tanuki/argument/string'
+module Tanuki
+  # Tanuki::Argument contains basic classes and methods for controller arguments.
+  module Argument
+    @assoc = {}
+    class << self
+      # Remove argument association for a given type class.
+      def delete(klass)
+        @assoc.delete(klass)
+      end
+      # Associate a given type class with an argument class.
+      def store(klass, arg_class)
+        warn "Tanuki::Argument::Base is not an ancestor of `#{arg_class}'" unless arg_class.ancestors.include? Argument::Base
+        @assoc[klass] = arg_class
+      end
+      alias_method :[], :store
+      # Convert a given type object to an argument object.
+      def to_argument(obj, *args)
+        if @assoc.include?(klass = obj.class)
+          @assoc[klass].new(obj, *args)
+        else
+          Argument::String.new(obj.to_s)
+        end
+      end
+    end # end class << self
+  end # end Argument
+end # end Tanuki

data/lib/tanuki/configurator.rb ADDED Viewed

@@ -0,0 +1,93 @@
+module Tanuki
+  # Tanuki::Configurator is a scope for evaluating a Tanuki application configuration block.
+  # Use Tanuki::development_application and Tanuki::production_application to create such a block.
+  class Configurator
+    class << self
+      private
+      # Invokes Tanuki::Argument.store.
+      def argument(klass, arg_class)
+        Argument.store(klass, arg_class)
+      end
+      # Invokes Tanuki::Application.set.
+      def set(option, value)
+        Application.set(option, value)
+      end
+      # Invokes Tanuki::Application.use.
+      def use(middleware, *args, &block)
+        Application.use(middleware, *args, &block)
+      end
+      # Invokes Tanuki::Application.discard.
+      def discard(middleware)
+        Application.discard(middleware)
+      end
+      # Invokes Tanuki::Application.visitor.
+      def visitor(sym, &block)
+        Application.visitor(sym, &block)
+      end
+    end # end class << self
+  end # end Configurator
+  # Creates default configuration for development environments.
+  def self.development_application(&block)
+    Application.set :development, true
+    Application.instance_eval do
+      use Rack::CommonLogger
+      use Rack::Lint
+      use Rack::Reloader, 0
+      use Rack::ShowExceptions
+    end
+    common_application(&block)
+  end
+  # Creates default configuration for production environments.
+  def self.production_application(&block)
+    Application.set :development, false
+    common_application(&block)
+  end
+  private
+  # Creates default configuration for common environments.
+  def self.common_application(&block)
+    Application.instance_eval do
+      use Rack::Head
+      use Rack::ShowStatus
+      set :server, [:thin, :mongrel, :webrick]
+      set :host, '0.0.0.0'
+      set :port, 3000
+      set :root, File.expand_path('..', $0)
+      set :app_root, proc { File.join(root, 'app') }
+      set :cache_root, proc { File.join(root, 'cache') }
+      set :schema_root, proc { File.join(root, 'schema') }
+      set :root_page, ::User_Page_Index
+      set :missing_page, ::Tanuki_Page_Missing
+      set :i18n, false
+      set :language, nil
+      set :language_fallback, {}
+      set :languages, proc { language_fallback.keys }
+      set :best_language, proc {|lngs| language_fallback[language].each {|lng| return lng if lngs.include? lng }; nil }
+      set :best_translation, proc {|trn| language_fallback[language].each {|lng| return trn[lng] if trn.include? lng }; nil }
+      visitor :string do s = ''; proc {|out| s << out.to_s } end
+    end
+    Argument.instance_eval do
+      store Fixnum, Argument::Integer
+      store Bignum, Argument::Integer
+      store Range, Argument::IntegerRange
+      store String, Argument::String
+    end
+    Application.instance_eval { @context = @context.child }
+    Configurator.instance_eval(&block) if block_given?
+    Application.run
+  end
+end # end Tanuki

data/lib/tanuki/context.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module Tanuki
+  # Tanuki::Context is used to create unique environments for each request.
+  # Once a context variable has been set, it cannot be redefined.
+  # Child contexts are used to override parent context variables without changing them directly.
+  # Use Tanuki::Context#child to create new contexts.
+  class Context
+    # Create and return child context.
+    def child
+      Class.new(self.class).new
+    end
+    # Kernel#method_missing hook.
+    def method_missing(sym, arg=nil)
+      match = sym.to_s.match(/^([^=]+)(=)?$/)
+      self.class.instance_eval do
+        method_sym = match[1].to_sym
+        unless instance_methods(false).include? method_sym
+          if arg.is_a? Proc
+            define_method(method_sym, &arg)
+          else
+            define_method(method_sym) { arg }
+          end
+          return arg
+        else
+          raise "context entry `#{match[1]}' redefined, use Context#child"
+        end
+      end if match[2]
+      warn "#{__FILE__}:#{__LINE__}: warning: undefined context entry `#{sym}' for #{self}"
+      super
+    end
+  end # end Context
+end # end Tanuki