rango 0.2.4.1 → 0.2.5.1

data/CHANGELOG

@@ -84,3 +84,13 @@
   * Ripple support in stack generator
   * Removed Erubis support, since it doesn't support <%= block(&block) %> so it's useless for us
   * Specs are green again
+
+= Version 0.2.5
+  * Conventional rendering mixin for high-level rendering methods like autorender
+  * Added RESTController class as a base class for REST controllers
+  * Added CRUDMixin with controller CRUD methods
+  * UrlHelper#url can work not just as url(:post, @post.id) but also as url(:post, @post)
+  * Action args mixin doesn't raise argument error if there are some splat or block arguments
+  * Template caching
+  * Fixed gemspec to find executables
+  * First simple MIME support

data/lib/rango/controller.rb

@@ -95,7 +95,9 @@ module Rango
       if (300..399).include?(status)
         exception = Redirection.new(absolute_uri(location))
         exception.status = status
-        exception.headers["Set-Cookie"] = response["Set-Cookie"] # otherwise it don't save cookies
+        if response["Set-Cookie"]
+          exception.headers["Set-Cookie"] = response["Set-Cookie"] # otherwise it don't save cookies
+        end
         block.call(exception) unless block.nil?
         raise exception
       else

data/lib/rango/core_ext.rb

@@ -23,6 +23,12 @@ class String
     return self if self !~ /_/ && self =~ /[A-Z]+.*/
     split('_').map{|e| e.capitalize}.join
   end
+
+  # TODO: this certainly isn't the way to go,
+  # but we need to get & refactor extlib at first
+  def pluralize
+    "#{self}s"
+  end
 end
 
 class Hash

data/lib/rango/mixins/action_args.rb

@@ -21,16 +21,8 @@ module Rango
       view       = self.method(action)
       parameters = view.parameters.map! { |type, name| [type, name.to_s] }
       names      = parameters.map { |type, name| name }
-      types      = parameters.map { |type, name| type }
       required   = parameters.map { |type, name| name if type.eql?(:req) }.compact
 
-      # validate types
-      if types.include?(:rest)
-        raise ArgumentError, "View can't have splat argument. Use just this: def #{action}(#{names[0..-2].join(", ")})"
-      elsif types.include?(:block)
-        raise ArgumentError, "View can't have block argument. Use just this: def #{action}(#{names[0..-2].join(", ")})"
-      end
-
       # validate names
       unless (extra_keys = required - self.params.keys).empty?
         raise ArgumentError, "Following keys aren't available in params: #{extra_keys.inspect}\nAvailable keys: #{self.params.keys.inspect}"

data/lib/rango/mixins/conventional_rendering.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+# Use with explicit or implicit rendering mixin
+module Rango
+  module ConventionalRendering
+    def self.template_dirname=(template_dirname)
+      @@template_dirname = template_dirname
+    end
+
+    def self.template_dirname
+      @@template_dirname
+    rescue NameError
+      name     = self.class.name
+      constant = name.gsub("::", "/")
+      dirname  = constant.camel_case
+      @@template_dirname = dirname
+    end
+
+    def template_dirname
+      self.class.template_dirname
+    end
+
+    # @example
+    #   def template_basename
+    #     case request["router.action"]
+    #     when "show"
+    #       self.class.name.singularize
+    #     when "index"
+    #     else
+    #     end
+    #   end
+    #
+    # @api plugin
+    def template_basename
+      request["router.action"]
+    end
+
+    def template_path
+      File.join(template_dirname, template_basename)
+    end
+
+    def render_relative(template, context = nil)
+      if context
+        super File.join(template_dirname, template), context
+      else
+        super File.join(template_dirname, template)
+      end
+    end
+
+    def autorender(context = nil)
+      if context
+        render_relative template_basename, context
+      else
+        render_relative template_basename
+      end
+    end
+
+    def display(object)
+      autorender
+    rescue TemplateNotFound
+      callback = self.formats[request.action]
+      callback.call
+    end
+  end
+end

data/lib/rango/mixins/crud.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module CRUDMixin
+  def index(&block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    set_context_value(collection_name, block.call)
+    autorender
+  end
+
+  def show(&block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    set_context_value(collection_name, block.call)
+    autorender
+  end
+
+  def new(&block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    set_context_value(collection_name, block.call)
+    autorender
+  end
+
+  def edit(&block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    set_context_value(collection_name, block.call)
+    autorender
+  end
+
+  def create(notice = "Created successfully", error = "Can't create", &block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    object = block.call
+    if object.save
+      message[:notice] = notice
+      redirect url(named_route, object)
+    else
+      message[:error] = error
+      render_relative "show"
+    end
+  end
+
+  def update(notice = "Updated successfully", error = "Can't update", &block)
+    raise ArgumentError, "You have to provide a block" if block.nil?
+    object = block.call
+    if object.save
+      message[:notice] = notice
+      redirect url(named_route, object)
+    else
+      message[:error] = error
+      render_relative "show"
+    end
+  end
+end

data/lib/rango/mixins/rendering.rb

@@ -4,56 +4,55 @@ require "rango/mixins/render"
 
 module Rango
   module FormatMixin
-    def self.extended
+    MIME_TYPES = Rack::Mime::MIME_TYPES
+    def self.included(controller)
+      controller.class_eval do
+        extend ClassMethods
+        extend Module.new {
+          def inherited(subclass)
+            subclass.formats = self.formats
+          end
+        }
+      end
     end
 
-    def inherited
+    def initialize(*args)
+      super(*args)
+      set_content_type
     end
 
-    attr_writer :format
-    def formats
-      @formats ||= Hash.new { |hash, format| hash[:html] if hash.has_key?(:html) }
+    def set_content_type # rango::controller
+      # accept ...
     end
-
-    # format(:json) do |object|
-    #   object.to_json
-    # end
-    def format(format, &block)
-      self.formats[:format] = block
-    end
-  end
-  module StackRendering
-    include Rango::RenderMixin
-    def template_dirname
-      self.class.name.gsub("::", "/").camel_case
-    end
-
-    def template_basename
-      request["router.action"]
-    end
-
-    #def template_basename
-    #  case request["router.action"]
-    #  when "show"
-    #    self.class.name.singularize
-    #  when "index"
-    #  else
-    #  end
-    #end
-
-    def template_path
-      File.join(template_dirname, template_basename)
+    def set_content_type
+      super
+      unless headers["Content-Type"]
+        format = request.router_params[:format]
+        unless format.nil?
+          mime = self.class::MIME_TYPES[format]
+          headers["Content-Type"] = mime
+        end
+      end
     end
 
-    def render(context = Hash.new)
-      super(self.template_path, self.scope, self.context.merge!(context))
-    end
+    module ClassMethods
+      attr_writer :format
+      def formats
+        @formats ||= Hash.new do |hash, format|
+          raise BadRequest, "Unsupported format"
+        end
+      end
 
-    def display(object)
-      render
-    rescue TemplateNotFound
-      callback = self.formats[request.action]
-      callback.call
+      # format(:json) do |object|
+      #   object.to_json
+      # end
+      def format(format = nil, &block)
+        if format
+          self.formats[:format] = block
+        else
+          self.formats.default_proc = block
+        end
+      end
     end
   end
 
@@ -89,6 +88,18 @@ module Rango
     def context
       @context ||= {request: self.request}
     end
+
+    def get_context_value(key)
+      @context[key]
+    end
+
+    def set_context_value(key, value)
+      @context[key] = value
+    end
+
+    def context_keys
+      @context.keys
+    end
   end
 
   module ImplicitRendering
@@ -100,5 +111,19 @@ module Rango
     def render(template) # so you can't specify context
       super template, self.scope
     end
+
+    def get_context_value(key)
+      instance_variable_get("@#{key}")
+    end
+
+    def set_context_value(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def context_keys
+      instance_variables.map do |name|
+        name[1..-1].to_sym
+      end
+    end
   end
 end

data/lib/rango/rest_controller.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require "rango/controller"
+require "rango/mixins/crud"
+require "rango/mixins/conventional_rendering"
+
+module Rango
+  class RESTController < Controller
+    include CRUDMixin
+    include ConventionalRendering
+    def self.object_name=(object_name)
+      @@object_name = object_name
+    end
+
+    def self.object_name
+      @@object_name
+    rescue NameError
+      @@object_name = begin
+        name = self.class.name
+        name.split("::").last.snake_case
+      end
+    end
+
+    # @api plugin
+    def object_name
+      self.class.object_name
+    end
+
+    def collection_name
+      @@collection_name ||= @@object_name.to_s.pluralize
+    end
+
+    def self.named_route=(named_route)
+      @@named_route = named_route
+    end
+
+    def self.named_route
+      @@named_route
+    rescue NameError
+      @@named_route = begin
+        name = self.class.name
+        name.split("::").last.snake_case
+      end
+    end
+
+    def named_route
+      self.class.named_route
+    end
+  end
+end

data/lib/rango/router/adapters/usher.rb

@@ -8,14 +8,46 @@ end
 
 Rango::Router.implement(:usher) do |env|
   # when usher routes to the default app, then usher.params is nil
-  env["rango.router.params"] = env["usher.params"] || Hash.new
+  env["rango.router.params"] = env["usher.params"] || Hash.new # TODO: nil
 end
 
 module Rango
   module UrlHelper
     # url(:login)
     def url(*args)
-      Rango::Router.app.router.generator.generate(*args)
+      generator  = Rango::Router.app.router.generator
+      route_name = args.shift
+      route = generator.usher.named_routes[route_name]
+      raise "No route found" if route.nil? # TODO: add RouteNotFound to usher and use it here as well
+      if args.empty?
+        generator.generate(route_name) # TODO: usher should probably have path.to_url
+      else
+        alts = route.paths.map(&:dynamic_keys) # one route can have multiple paths as /:id or /:id.:format
+        keys = alts.first
+        # FIXME: take a look at other alts as well !!!!
+        # keys = alts.find.with_index { |item, index|  }
+
+        # TODO: optional args
+        keys_generator = keys.each
+        args_generator = args.each
+        opts = Hash.new
+
+        keys.length.times do |index|
+          key = keys_generator.next
+          arg = args_generator.next
+          if arg.respond_to?(key) # post instance
+            opts[key] = arg.send(key)
+          else # it's already a slug
+            opts[key] = arg
+          end
+        end
+
+        generator.generate(route_name, opts)
+      end
     end
   end
 end
+
+
+# route = Rango::Router.app.router.generator.usher.named_routes[:admin_edit_sticker]
+# p route.paths.map(&:dynamic_keys)

data/lib/rango/templates/template.rb

@@ -28,7 +28,12 @@ module Rango
     # @since 0.0.2
     def initialize(path, scope = Object.new)
       self.path  = path#[scope.class.template_prefix.chomp("/"), template].join("/")
-      self.scope = scope.extend(TemplateHelpers)
+      self.scope = scope
+      self.scope.extend(TemplateHelpers)
+      # this enables template caching
+      unless Rango.development?
+        self.scope.extend(Tilt::CompileSite)
+      end
       self.scope.template = self
     end
 

data/lib/rango/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Rango
-  VERSION = "0.2.4.1"
+  VERSION = "0.2.5.1"
 end

data/rango.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   # files
   s.files = `git ls-files`.split("\n")
 
-  Dir["bin/*"].map(&File.method(:basename))
+  s.executables = Dir["bin/*"].map(&File.method(:basename))
   s.default_executable = "rango"
   s.require_paths = ["lib"]
 

data/spec/rango/mixins/action_args_spec.rb

@@ -19,10 +19,12 @@ describe Rango::ActionArgsMixin do
       "#{post} - #{msg}"
     end
 
-    def view_with_a_splat(*args)
+    def view_with_a_splat(id, *args)
+      id
     end
 
-    def view_with_a_block(&block)
+    def view_with_a_block(id, &block)
+      id
     end
   end
 
@@ -31,14 +33,16 @@ describe Rango::ActionArgsMixin do
     env.merge("rango.controller.action" => action)
   end
 
-  it "should raise argument error if there is a splat argument" do
-    env = env_for_action(:view_with_a_splat)
-    -> { controller.call(env) }.should raise_error(ArgumentError)
+  it "should ignore splat arguments" do
+    env = env_for_action(:view_with_a_splat, "/?id=12")
+    status, headers, body = controller.call(env)
+    body.should eql(["12"])
   end
 
-  it "should raise argument error if there is a block argument" do
-    env = env_for_action(:view_with_a_block)
-    -> { controller.call(env) }.should raise_error(ArgumentError)
+  it "should ignore block arguments" do
+    env = env_for_action(:view_with_a_block, "/?id=12")
+    status, headers, body = controller.call(env)
+    body.should eql(["12"])
   end
 
   it "should raise argument error if there are arguments which doesn't match any key in params" do
@@ -54,7 +58,6 @@ describe Rango::ActionArgsMixin do
 
   it "should call a view with arguments matching params[argument]" do
     env = env_for_action(:show, "/?id=12&msg=hi") # nevadi ze je tam toho vic
-    instance = controller.new(env)
     status, headers, body = controller.call(env)
     body.should eql(["12"])
   end

data/spec/rango/rest_controller_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require_relative "../spec_helper"
+
+require "rack/mock"
+require "rango/rest_controller"
+
+class TestRestController < Rango::RESTController
+end
+
+describe Rango::RESTController do
+  before(:each) do
+    env = Rack::MockRequest.env_for("/")
+    @controller = TestRestController.new(env)
+  end
+end

data/spec/rango_spec.rb

@@ -5,14 +5,15 @@ require "rango"
 
 
 describe Rango do
-  it "should has logger" do
-    #Rango.logger.should respond_to?(:debug)
-    #Rango.logger.should respond_to?(:info)
-    #Rango.logger.should respond_to?(:warn)
-    #Rango.logger.should respond_to?(:error)
-    #Rango.logger.should respond_to?(:fatal)
+  it "should have logger" do
+    Rango.logger.should respond_to?(:debug)
+    Rango.logger.should respond_to?(:info)
+    Rango.logger.should respond_to?(:warn)
+    Rango.logger.should respond_to?(:error)
+    Rango.logger.should respond_to?(:fatal)
   end
 
+  # what about logger vs. extlib logger (fatal!)
   describe ".boot" do
     # TODO
   end

data/stubs/stack/content/Gemfile.rbt

@@ -43,6 +43,7 @@ gem "rack-router"#, git: "git://github.com/carllerche/rack-router.git"
 gem "tilt"#, git: "git://github.com/rtomayko/tilt.git"
 gem "haml"#, git: "git://github.com/nex3/haml.git"
 gem "helpers"#, git: "git://github.com/botanicus/helpers.git"
+gem "formidable"#, git: "git://github.com/botanicus/formidable.git"
 gem "pupu"#, git: "git://github.com/botanicus/pupu.git"
 gem "media-path"#, git: "git://github.com/botanicus/media-path.git" # for asset helpers
 
@@ -96,7 +97,7 @@ end
 group(:test, :cucumber) do
   gem "rspec"#, git: "git://github.com/dchelimsky/rspec.git"
   gem "rack-test", require: "rack/test"#, git: "git://github.com/brynary/rack-test.git"
-  gem "webrat"#, git: "git://github.com/brynary/webrat.git"
+  gem "capybara"#, git: "git://github.com/jnicklas/capybara.git"
 end
 
 group(:cucumber) do

data/stubs/stack/content/lib/%name%/initializers/45_middlewares.rb.rbt

@@ -13,5 +13,16 @@ require "multigiri/minify"
 Rango.after_boot(:rackup) do
   <%= @name.camel_case %>.rackup do
     use Rango::Middlewares::Basic
+
+    use Multigiri::HTML do
+      use Multigiri::HTML5::Forms
+      use Multigiri::HTML5::Hidden
+      use Multigiri::EmailObfuscator
+      # use Multigiri::GoogleAnalytics, :my_tracking_code
+      use Multigiri::DefaultAttributes
+      if Rango.development?
+        use Multigiri::LinkChecker, SimpleLogger::Logger.new("log/links.log")
+      end
+    end
   end
 end

metadata

@@ -5,16 +5,16 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 4
+  - 5
   - 1
-  version: 0.2.4.1
+  version: 0.2.5.1
 platform: ruby
 authors: 
 - "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2010-03-23 00:00:00 +00:00
+date: 2010-05-08 00:00:00 +01:00
 default_executable: rango
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,8 +47,8 @@ dependencies:
   version_requirements: *id002
 description: ""
 email: stastny@101ideas.cz
-executables: []
-
+executables: 
+- rango
 extensions: []
 
 extra_rdoc_files: []
@@ -96,6 +96,8 @@ files:
 - lib/rango/mini.rb
 - lib/rango/mini_render.rb
 - lib/rango/mixins/action_args.rb
+- lib/rango/mixins/conventional_rendering.rb
+- lib/rango/mixins/crud.rb
 - lib/rango/mixins/filters.rb
 - lib/rango/mixins/logger.rb
 - lib/rango/mixins/message.rb
@@ -114,6 +116,7 @@ files:
 - lib/rango/rack/middlewares/encoding.rb
 - lib/rango/rack/middlewares/static.rb
 - lib/rango/rack/request.rb
+- lib/rango/rest_controller.rb
 - lib/rango/router.rb
 - lib/rango/router/adapters/crudtree.rb
 - lib/rango/router/adapters/rack_mount.rb
@@ -156,6 +159,7 @@ files:
 - spec/rango/mini_spec.rb
 - spec/rango/mixins/action_args_spec.rb
 - spec/rango/mixins/chainable_spec.rb
+- spec/rango/mixins/conventional_rendering_spec.rb
 - spec/rango/mixins/filters_spec.rb
 - spec/rango/mixins/http_caching_spec.rb
 - spec/rango/mixins/logger_spec.rb
@@ -169,6 +173,7 @@ files:
 - spec/rango/rack/middlewares/encoding_spec.rb
 - spec/rango/rack/middlewares/static_spec.rb
 - spec/rango/rack/request_spec.rb
+- spec/rango/rest_controller_spec.rb
 - spec/rango/router/adapters/crudtree_spec.rb
 - spec/rango/router/adapters/rack_mount_spec.rb
 - spec/rango/router/adapters/urlmap_spec.rb
@@ -276,13 +281,14 @@ has_rdoc: true
 homepage: http://github.com/botanicus/rango
 licenses: []
 
-post_install_message: "[\e[32mVersion 0.2.4\e[0m] Removed all helpers, if you need some, use http://github.com/botanicus/helpers\n\
-  [\e[32mVersion 0.2.4\e[0m] [FEATURE] Added rango/mailer with mail helper for sending e-mails\n\
-  [\e[32mVersion 0.2.4\e[0m] Rango.root & Rango.media_path are now instances of Pathname rather than String\n\
-  [\e[32mVersion 0.2.4\e[0m] rango/environments are no longer optional\n\
-  [\e[32mVersion 0.2.4\e[0m] Ripple support in stack generator\n\
-  [\e[32mVersion 0.2.4\e[0m] Removed Erubis support, since it doesn't support <%= block(&block) %> so it's useless for us\n\
-  [\e[32mVersion 0.2.4\e[0m] Specs are green again\n"
+post_install_message: "[\e[32mVersion 0.2.5\e[0m] Conventional rendering mixin for high-level rendering methods like autorender\n\
+  [\e[32mVersion 0.2.5\e[0m] Added RESTController class as a base class for REST controllers\n\
+  [\e[32mVersion 0.2.5\e[0m] Added CRUDMixin with controller CRUD methods\n\
+  [\e[32mVersion 0.2.5\e[0m] UrlHelper#url can work not just as url(:post, @post.id) but also as url(:post, @post)\n\
+  [\e[32mVersion 0.2.5\e[0m] Action args mixin doesn't raise argument error if there are some splat or block arguments\n\
+  [\e[32mVersion 0.2.5\e[0m] Template caching\n\
+  [\e[32mVersion 0.2.5\e[0m] Fixed gemspec to find executables\n\
+  [\e[32mVersion 0.2.5\e[0m] First simple MIME support\n"
 rdoc_options: []
 
 require_paths: