cuba-contrib 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010, 2011 Michel Martens, Damian Janowski and Cyril David
+
+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.markdown

@@ -0,0 +1,142 @@
+# cuba-contrib
+
+[Cuba][cuba] is probably one of the tiniest rack-based micro
+frameworks around. Weighing in at only __138 LOC__, it has proven
+itself to be a very resilient tool in various web application domains.
+Check [the list of sites][sites] built using Cuba in order to
+grasp the endless possibilities.
+
+## STEP 1: Cuba::Prelude
+
+Cuba [does one thing, and it does it well][unix]. Cuba-contrib, on
+the other hand, layers requirement-specific functionality on
+top of it. This allows us to build simpler and lighter solutions.
+
+To get started with `Cuba::Contrib`, install it using RubyGems:
+
+``` bash
+$ gem install cuba          # if you haven't already done so
+$ gem install cuba-contrib
+```
+
+For the remainder of the examples below, we'll assume you
+always put your main cuba application in `app.rb` and your
+views in `views`.
+
+``` bash
+$ touch app.rb
+$ mkdir views
+```
+
+Now you can require it in your application
+
+``` ruby
+require "cuba"
+require "cuba/contrib"
+
+Cuba.plugin Cuba::Prelude
+```
+
+`Cuba::Prelude` adds the basic stuff you'll need:
+
+``` ruby
+Cuba.define do
+  on "about" do
+    # same as encodeURIComponent in javascript land
+    res.write urlencode("http://www.google.com")
+
+    # basically an alias for Rack::Utils.escape_html
+    res.write h("Cuba & Cuba Contrib")
+  end
+end
+```
+
+## STEP 2: Choose your templating
+
+### Here comes a new challenger: Mote
+
+We prefer to use our home-grown templating engine called
+[Mote][mote]. We do that by simply loading the plugin `Cuba::Mote`:
+
+``` ruby
+require "cuba"
+require "cuba/contrib"
+
+Cuba.plugin Cuba::Mote
+
+Cuba.define do
+  on "home" do
+    res.write view("home")
+  end
+
+  on "about" do
+    res.write partial("about")
+  end
+end
+```
+
+This assumes that you have a `views` folder, containing a `home.mote`
+and an `about.mote`.
+
+### Classic templating needs
+
+``` ruby
+require "cuba"
+require "cuba/contrib"
+
+Cuba.plugin Cuba::Rendering
+Cuba.set :template_engine, "haml"
+
+Cuba.define do
+  on "home" do
+    res.write view("home") # renders views/home.haml
+  end
+
+  on "about" do
+    res.write partial("about") # renders views/about.haml
+  end
+end
+```
+
+## STEP 3: Make your own plugins
+
+Authoring your own plugins is pretty straightforward.
+
+``` ruby
+module MyOwnHelper
+  def markdown(str)
+    BlueCloth.new(str).to_html
+  end
+end
+
+Cuba.plugin MyOwnHelper
+```
+
+that's the simplest kind of plugin you'll write. In fact,
+that's exactly how the `markdown` helper is written in
+`Cuba::TextHelpers`.
+
+A more complicated plugin for example, will make use of
+`Cuba::Settings` to provide default values:
+
+``` ruby
+module Rendering
+  def self.setup(app)
+    app.plugin Cuba::Settings # we need this for default values
+    app.set :template_engine, "erb"
+  end
+
+  def partial(template, locals = {})
+    render("#{template}.#{settings.template_engine}", locals)
+  end
+end
+
+Cuba.plugin Rendering
+```
+
+This sample plugin actually resembles how `Cuba::Rendering` works.
+
+[cuba]: http://cuba.is
+[sites]: http://cuba.is/sites
+[mote]: http://github.com/soveran/mote
+[unix]: http://en.wikipedia.org/wiki/Unix_philosophy

data/cuba-contrib.gemspec

@@ -0,0 +1,24 @@
+require "./lib/cuba/contrib/version"
+
+Gem::Specification.new do |s|
+  s.name              = "cuba-contrib"
+  s.version           = Cuba::Contrib::VERSION
+  s.summary           = "Cuba plugins and utilities."
+  s.description       = "Includes various helper tools for Cuba."
+  s.authors           = ["Cyril David"]
+  s.email             = ["me@cyrildavid.com"]
+  s.homepage          = "http://github.com/cyx/cuba-contrib"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.markdown",
+    "rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "cuba"
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "capybara"
+end

data/lib/cuba/contrib.rb

@@ -0,0 +1,22 @@
+class Cuba
+  CONTRIB_ROOT = File.expand_path("../../", File.dirname(__FILE__))
+
+  def self.plugin(mixin)
+    include mixin
+    extend  mixin::ClassMethods if defined?(mixin::ClassMethods)
+
+    mixin.setup(self) if mixin.respond_to?(:setup)
+  end
+
+  # TODO: remove this as soon as cuba core implements this.
+  def session
+    env["rack.session"]
+  end
+
+  autoload :Prelude,    "cuba/contrib/prelude"
+  autoload :Rendering,  "cuba/contrib/rendering"
+  autoload :Settings,   "cuba/contrib/settings"
+  autoload :Mote,       "cuba/contrib/mote"
+  autoload :TextHelpers, "cuba/contrib/text_helpers"
+  autoload :FormHelpers, "cuba/contrib/form_helpers"
+end

data/lib/cuba/contrib/form_helpers.rb

@@ -0,0 +1,107 @@
+class Cuba
+  module FormHelpers
+    include Cuba::Prelude
+
+    def cuba_contrib_partial(template, locals = {})
+      partial(cuba_contrib_path("%s.mote" % template), locals)
+    end
+
+    def cuba_contrib_path(*args)
+      File.join(Cuba::CONTRIB_ROOT, "views", *args)
+    end
+
+    def cuba_contrib_form(record)
+      view(cuba_contrib_path("form"), model: record)
+    end
+
+    def select_options(pairs, selected = nil, prompt = nil)
+      "".tap do |ret|
+        ret << option_tag(prompt, "") if prompt
+
+        pairs.each do |label, value|
+          ret << option_tag(label, value, selected)
+        end
+      end
+    end
+
+    def option_tag(label, value, selected = nil)
+      cuba_contrib_partial("option", selected: selected, value: value, label: label)
+    end
+
+    def datefield(model, field, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("textfield",
+          name: field_name(model, field),
+          value: model.send(field),
+          class: "date"
+        )
+      end
+    end
+
+    def textfield(model, field, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("textfield",
+          name: field_name(model, field),
+          value: model.send(field)
+        )
+      end
+    end
+
+    def password_field(model, field, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("password",
+          name: field_name(model, field)
+        )
+      end
+    end
+
+    def filefield(model, field, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("file",
+          name: field_name(model, field)
+        )
+      end
+    end
+
+    def textarea(model, field, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("textarea",
+          name: field_name(model, field),
+          value: model.send(field)
+        )
+      end
+    end
+
+    def dropdown(model, field, options, hint = nil)
+      input(model, field, hint) do
+        cuba_contrib_partial("select",
+          name: field_name(model, field),
+          options: select_options(options, model.send(field))
+        )
+      end
+    end
+
+    def input(model, field, hint)
+      cuba_contrib_partial("field",
+        label: humanize(field),
+        input: yield,
+        hint: hint,
+        error: localize_errors(model, field).join(", ")
+      )
+    end
+
+    def localize_errors(model, field)
+      model.errors[field].map do |err|
+        unless settings.localized_errors[err]
+          raise "No localized error defined for: #{err}"
+        end
+
+        settings.localized_errors[err] % { field: humanize(field) }
+      end
+    end
+
+    def field_name(model, field)
+      "#{underscore(model.class.name)}[#{field}]"
+    end
+  end
+end

data/lib/cuba/contrib/mote.rb

@@ -0,0 +1,49 @@
+require "mote"
+
+class Cuba
+  module Mote
+    include ::Mote::Helpers
+
+    def self.setup(app)
+      app.plugin Cuba::Settings
+
+      app.set :views,  File.expand_path("views", Dir.pwd)
+      app.set :layout, "layout"
+    end
+
+    def partial(template, locals = {})
+      mote(mote_path(template), locals)
+    end
+
+    def view(template, locals = {})
+      raise NoLayout.new(self) unless settings.layout
+
+      partial(
+        settings.layout,
+        locals.merge(mote_vars(partial(template, locals)))
+      )
+    end
+
+    def mote_path(template)
+      return template if template.end_with?(".mote")
+
+      File.expand_path("#{template}.mote", settings.views)
+    end
+
+    def mote_vars(content)
+      { content: content, session: session }
+    end
+
+    class NoLayout < StandardError
+      attr :instance
+
+      def initialize(instance)
+        @instance = instance
+      end
+
+      def message
+        "Missing Layout: Try doing #{instance.class}.set :layout, 'layout'"
+      end
+    end
+  end
+end

data/lib/cuba/contrib/prelude.rb

@@ -0,0 +1,14 @@
+require "uri"
+
+class Cuba
+  module Prelude
+    def urlencode(str)
+      URI.encode_www_form_component(str)
+    end
+
+    def escape_html(str)
+      Rack::Utils.escape_html(str)
+    end
+    alias :h :escape_html
+  end
+end

data/lib/cuba/contrib/rendering.rb

@@ -0,0 +1,41 @@
+require "tilt"
+
+class Cuba
+  module Rendering
+    def self.setup(app)
+      app.plugin Cuba::Settings
+      app.set :template_engine, "erb"
+      app.set :views, File.expand_path("views", Dir.pwd)
+    end
+
+    def view(template, locals = {})
+      partial("layout", { content: partial(template, locals) }.merge(locals))
+    end
+
+    def partial(template, locals = {})
+      render("#{settings.views}/#{template}.#{settings.template_engine}", locals)
+    end
+
+    # Render any type of template file supported by Tilt.
+    #
+    # @example
+    #
+    #   # Renders home, and is assumed to be HAML.
+    #   render("home.haml")
+    #
+    #   # Renders with some local variables
+    #   render("home.haml", site_name: "My Site")
+    #
+    #   # Renders with HAML options
+    #   render("home.haml", {}, ugly: true, format: :html5)
+    #
+    #   # Renders in layout
+    #   render("layout.haml") { render("home.haml") }
+    #
+    def render(template, locals = {}, options = {}, &block)
+      _cache.fetch(template, locals) {
+        Tilt.new(template, 1, options)
+      }.render(self, locals, &block)
+    end
+  end
+end

data/lib/cuba/contrib/settings.rb

@@ -0,0 +1,20 @@
+class Cuba
+  module Settings
+    def settings
+      self.class
+    end
+
+    module ClassMethods
+      def set(key, value)
+        metaclass.send :attr_accessor, key
+
+        send :"#{key}=", value
+      end
+
+    private
+      def metaclass
+        class << self; self; end
+      end
+    end
+  end
+end

data/lib/cuba/contrib/text_helpers.rb

@@ -0,0 +1,35 @@
+class Cuba
+  module TextHelpers
+    def markdown(str)
+      require "bluecloth"
+
+      BlueCloth.new(str).to_html
+    end
+
+    def truncate(str, length, ellipses = "...")
+      return str if str.length <= length
+
+      sprintf("%.#{length}s#{ellipses}", str)
+    end
+
+    def nl2br(str)
+      str.gsub(/\n|\r\n/, "<br>")
+    end
+
+    def currency(amount, unit = "$")
+      "#{unit} %.2f" % amount
+    end
+
+    def titlecase(str)
+      str.to_s.tr("_", " ").gsub(/(^|\s)([a-z])/) { |char| char.upcase }
+    end
+
+    def humanize(str)
+      titlecase(str.to_s.tr("_", " ").gsub(/_id$/, ""))
+    end
+
+    def underscore(str)
+      str.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').downcase
+    end
+  end
+end

data/lib/cuba/contrib/version.rb

@@ -0,0 +1,5 @@
+class Cuba
+  module Contrib
+    VERSION = "0.0.1"
+  end
+end

data/rakefile

@@ -0,0 +1,7 @@
+task :test do
+  require "cutest"
+
+  Cutest.run(Dir["test/*.rb"])
+end
+
+task :default => :test

data/test/contrib.rb

@@ -0,0 +1,68 @@
+require_relative "helper"
+
+scope do
+  module Helper
+    def clean(str)
+      str.strip
+    end
+  end
+
+  Cuba.plugin Helper
+
+  Cuba.define do
+    on default do
+      res.write clean " foo "
+    end
+  end
+
+  test do
+    _, _, body = Cuba.call({ "PATH_INFO" => "", "SCRIPT_NAME" => "" })
+
+    assert_response body, ["foo"]
+  end
+end
+
+scope do
+  module Number
+    def num
+      1
+    end
+  end
+
+  module Plugin
+    def self.setup(app)
+      app.plugin Number
+    end
+
+    def bar
+      "baz"
+    end
+
+    module ClassMethods
+      def foo
+        "bar"
+      end
+    end
+  end
+
+  Cuba.reset!
+
+  Cuba.plugin Plugin
+
+  Cuba.define do
+    on default do
+      res.write bar
+      res.write num
+    end
+  end
+
+  test do
+    assert_equal "bar", Cuba.foo
+  end
+
+  test do
+    _, _, body = Cuba.call({ "PATH_INFO" => "", "SCRIPT_NAME" => "" })
+
+    assert_response body, ["baz", "1"]
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require "cuba"
+require "cuba/contrib"
+
+def assert_response(body, expected)
+  arr = []
+  body.each { |line| arr << line }
+
+  assert_equal arr, expected
+end

data/test/mote.rb

@@ -0,0 +1,37 @@
+require_relative "helper"
+
+Cuba.plugin Cuba::Mote
+
+Cuba.set :views, "./test/views"
+
+Cuba.define do
+  on "frag" do
+    res.write partial("frag", foo: "Bar")
+  end
+
+  on "" do
+    res.write view("home", title: "Hola")
+  end
+
+  on "abs_path" do
+    res.write view("./test/views/custom/abs_path.mote", title: "Absolute")
+  end
+end
+
+test do
+  _, _, body = Cuba.call({ "PATH_INFO" => "/", "SCRIPT_NAME" => "" })
+
+  assert_response body, ["<title>Hola</title>\n<h1>Home</h1>"]
+end
+
+test do
+  _, _, body = Cuba.call({ "PATH_INFO" => "/frag", "SCRIPT_NAME" => "" })
+
+  assert_response body, ["<h1>Bar</h1>"]
+end
+
+test do
+  _, _, body = Cuba.call({ "PATH_INFO" => "/abs_path", "SCRIPT_NAME" => "" })
+
+  assert_response body, ["<title>Absolute</title>\n<h1>Abs Path</h1>"]
+end

data/test/rendering.rb

@@ -0,0 +1,42 @@
+require_relative "helper"
+
+Cuba.plugin Cuba::Rendering
+Cuba.views = "./test/views"
+
+Cuba.define do
+  on "home" do
+    res.write view("home", name: "Agent Smith", title: "Home")
+  end
+
+  on "about" do
+    res.write partial("about", title: "About Cuba")
+  end
+end
+
+test "partial" do
+  _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
+
+  assert_response body, ["<h1>About Cuba</h1>"]
+end
+
+test "view" do
+  _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+  assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
+end
+
+test "partial with str as engine" do
+  Cuba.template_engine = "str"
+
+  _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
+
+  assert_response body, ["<h1>About Cuba</h1>"]
+end
+
+test "view with str as engine" do
+  Cuba.template_engine = "str"
+
+  _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+  assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"]
+end

data/test/settings.rb

@@ -0,0 +1,24 @@
+require_relative "helper"
+
+Cuba.plugin Cuba::Settings
+Cuba.set :foo, "bar"
+
+Cuba.define do
+  on default do
+    res.write settings.foo
+  end
+end
+
+test do
+  assert_equal "bar", Cuba.foo
+end
+
+test do
+  _, _, body = Cuba.call({ "PATH_INFO" => "", "SCRIPT_NAME" => "" })
+  assert_response body, ["bar"]
+end
+
+test do
+  Cuba.foo = "baz"
+  assert_equal "baz", Cuba.foo
+end

data/test/text_helper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require_relative "helper"
+
+setup do
+  obj = Object.new
+  obj.extend Cuba::TextHelpers
+end
+
+test "truncate" do |helper|
+  assert_equal "the q...", helper.truncate("the quick brown", 5)
+
+  assert_equal "same string", helper.truncate("same string", 11)
+end
+
+test "markdown" do |helper|
+  assert_equal "<h1>Hola Mundo</h1>", helper.markdown("# Hola Mundo")
+end
+
+test "nl2br" do |helper|
+  assert_equal "Hi<br>there<br>Joe", helper.nl2br("Hi\nthere\r\nJoe")
+end
+
+test "currency" do |helper|
+  assert_equal "$ 2.22", helper.currency(2.221)
+  assert_equal "€ 2.22", helper.currency(2.221, "€")
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: cuba-contrib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: &2152741820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152741820
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: &2152741300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152741300
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &2152740680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152740680
+description: Includes various helper tools for Cuba.
+email:
+- me@cyrildavid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.markdown
+- rakefile
+- lib/cuba/contrib/form_helpers.rb
+- lib/cuba/contrib/mote.rb
+- lib/cuba/contrib/prelude.rb
+- lib/cuba/contrib/rendering.rb
+- lib/cuba/contrib/settings.rb
+- lib/cuba/contrib/text_helpers.rb
+- lib/cuba/contrib/version.rb
+- lib/cuba/contrib.rb
+- cuba-contrib.gemspec
+- test/contrib.rb
+- test/helper.rb
+- test/mote.rb
+- test/rendering.rb
+- test/settings.rb
+- test/text_helper.rb
+homepage: http://github.com/cyx/cuba-contrib
+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: Cuba plugins and utilities.
+test_files: []