el 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODMwZTM2NDNkZmZhOGU2NTJkNzg5OTJmZGEzNDg5YTE4ODg3MGMwNQ==
+  data.tar.gz: !binary |-
+    MjNmOWIyOWU5YmZkY2I0NTIxOGI5YjA2NTQ4YmQ3ZWMyOTI5MDlhZg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDU4MDIyZmVjZTczZmIxMDY4OWMzZGM2OGNiZGQ5YTgwYzdhYWY0MTA2ZWFj
+    MzFiNWFlMjM1MTE1MWE3ZTEwZTRjY2RlZDA4ZDg4MDdkYmJkMTZkNDc2Y2Uz
+    ZDM1MGQ1ODFmNjE4ZjFhZDIyMjgyNDc4ZTg4NGI4MjBhMjU0ZjM=
+  data.tar.gz: !binary |-
+    ZWMwNmE1MjYyN2EwM2UwMGQ4NDhmM2E2NjA2ZjQ2NGU5OTUzMTg3MTY5ZmNh
+    ZDNiMWRkM2M3YWZhMjQxNWY5ZTU2MGFkZjRkNzI5NjVlODBjYTc4Y2Y1NWU4
+    MGQ4YzA1ZGYzM2IyMDkxZmRmYjdjMmM2NWFlNmViNDZiYWZlODg=

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+gemspec
+gem 'rake',     '~> 10'
+gem 'specular', '>= 0.2.1'
+gem 'sonar',    '>= 0.1.5'

data/LICENSE

@@ -0,0 +1,19 @@
+
+Copyright (c) 2013 Silviu Rusu <slivuz@gmail.com>
+
+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.md

@@ -0,0 +1,77 @@
+## Espresso Lungo
+
+<a href="https://travis-ci.org/espresso/espresso-lungo">
+<img src="https://travis-ci.org/espresso/espresso-lungo.png" align="right"></a>
+
+### Extra Functionality for [Espresso Framework](https://github.com/espresso/espresso)
+
+## Install
+
+```bash
+$ gem install el
+```
+
+or add `gem 'el'` to your `Gemfile`
+
+## Load
+
+Ignore this if `el` added to `Gemfile` and `Bundler.require` used.
+
+Otherwise you'll have to load `el` gem explicitly.
+
+Just add `require 'el'` to the top of your app.
+
+That's all. Now your `Espresso` applications contains extra functionality.
+
+## Use
+
+### CRUD
+
+[Intro](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#intro) |
+[Resource](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#resource) |
+[Excluded Params](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#excluded-params) |
+[Root](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#root) |
+[Response](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#response) |
+[Error Handler](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#error-handler) |
+[Access Restriction](https://github.com/espresso/espresso-lungo/blob/master/docs/CRUD.md#access-restriction)
+
+### Assets
+
+[Specialized Tags](https://github.com/espresso/espresso-lungo/blob/master/docs/Assets.md#specialized-tags) |
+[Mapper](https://github.com/espresso/espresso-lungo/blob/master/docs/Assets.md#assets-mapper) |
+[Sprockets](https://github.com/espresso/espresso-lungo/blob/master/docs/Assets.md#sprockets)
+
+### Content Helpers
+
+[content_for](https://github.com/espresso/espresso-lungo/blob/master/docs/ContentHelpers.md#content_for) |
+[capture_html](https://github.com/espresso/espresso-lungo/blob/master/docs/ContentHelpers.md#capture_html)
+
+### [Tag Factory](https://github.com/espresso/espresso-lungo/blob/master/docs/TagFactory.md)
+
+### [Cache Manager](https://github.com/espresso/espresso-lungo/blob/master/docs/Cache.md)
+
+
+## Contributing
+
+  - Fork `el` repository
+  - optionally create a new branch
+  - make your changes
+  - submit a pull request
+
+<hr>
+
+<p>
+  Issues/Bugs:
+  <a href="https://github.com/espresso/espresso-lungo/issues">
+    github.com/espresso/espresso-lungo/issues</a>
+</p>
+<p>
+  Mailing List: <a href="https://groups.google.com/forum/?fromgroups#!forum/espresso-framework">
+  groups.google.com/.../espresso-framework</a>
+</p>
+<p>
+  IRC channel: #espressorb on irc.freenode.net
+</p>
+
+
+### Author - [Silviu Rusu](https://github.com/slivu).  License - [MIT](https://github.com/espresso/espresso-lungo/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rake'
+require 'bundler/gem_helper'
+require './test/setup'
+Dir['./test/**/test__*.rb'].each { |f| require f }
+
+tasks = %w[crud assets content_helpers tag_factory cache ipcm]
+
+namespace :test do
+
+  def run unit
+    puts "\n***\nTesting %s ..." % unit
+    session = session(unit)
+    session.run /ELTest__#{unit}/
+    puts session.failures if session.failed?
+    puts session.summary
+    session.exit_code == 0 || fail
+  end
+
+  def session unit
+    session = Specular.new
+    session.boot do
+      include Sonar
+      include ELSpecHelper
+    end
+    session.before do |tested_app|
+      if tested_app && EUtils.is_app?(tested_app)
+        tested_app.use Rack::Lint
+        app tested_app.mount
+        map tested_app.base_url
+      end
+    end
+    session
+  end
+
+  tasks.each do |t|
+    desc 'Run %s tests' % t
+    task t do
+      run t
+    end
+  end
+end
+
+desc 'Run all tests'
+task test: tasks.reject {|t| t == 'ipcm'}.map {|u| 'test:' + u}
+task default: :test
+
+Bundler::GemHelper.install_tasks

data/docs/Assets.md

@@ -0,0 +1,157 @@
+
+## Specialized Tags
+
+`Espresso Lungo` offers specialized helpers for JavaScript, CSS and image tags.
+
+```ruby
+js_tag :application
+#=> <script src="/assets/application.js" ...
+
+css_tag :application
+#=> <link href="/assets/application.css" ...
+
+png_tag 'icons/edit'
+#=> <img src="/assets/icons/edit.png">
+```
+
+Other helpers:
+
+  - jpg_tag
+  - jpeg_tag
+  - png_tag
+  - gif_tag
+  - tif_tag
+  - tiff_tag
+  - bmp_tag
+  - svg_tag
+  - xpm_tag
+
+
+Specialized helpers will use assets URL as prefix:
+
+```ruby
+# --- app.rb ---
+class App < E
+  # ...
+
+  def index
+    render
+  end
+end
+
+app = E.new do
+  assets_url '/public'
+end
+
+# --- view/app/index.erb ---
+
+js_tag :ui
+#=> <script src="/public/ui.js" ...
+
+png_tag 'images/header'
+#=> <img src="/public/images/header.png"
+```
+
+If you need to load some asset directly, without assets URL prefix, use `:src` option for js/images and `:href` for css:
+
+```ruby
+js_tag src: "/jquery"
+#=> <script src="/jquery.js" ...
+
+css_tag href: "http://my.cdn/theme"
+#=> <link href="http://my.cdn/theme.css" ...
+
+png_tag src: 'icons/edit'
+#=> <img src="icons/edit.png">
+```
+
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Assets Mapper
+
+`assets_mapper` allow to avoid repetitive path typing when loading assets.
+
+**Example:** - long way:
+
+```ruby
+js_tag  'vendor/jquery'
+
+js_tag  'vendor/bootstrap/js/bootstrap'
+css_tag 'vendor/bootstrap/css/bootstrap'
+
+js_tag  'vendor/select2/select2.min'
+css_tag 'vendor/select2/select2'
+```
+
+**Example:** - using `assets_mapper`
+
+```ruby
+assets_mapper :vendor do
+  js_tag  'jquery'
+  
+  cd 'bootstrap'
+  js_tag  'js/bootstrap'
+  css_tag 'css/bootstrap'
+  
+  cd '../select2'
+  js_tag  'select2.min'
+  css_tag 'select2'
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Sprockets
+
+To enable and use Sprockets, simply call `assets_url` at app level:
+
+```ruby
+app = E.new
+app.assets_url '/assets'
+app.assets.append_path 'assets'
+app.run
+```
+
+**Note:** by default no paths will be added to Sprockets environment, so it is up to you to do this by using `assets.append_path` or `assets.prepend_path`.
+
+**Note:** Sprockets environment will use app root as base path, so folders containing assets should reside in your app root.
+
+```ruby
+app = E.new do
+  assets_url '/assets'
+  assets.append_path 'assets'
+  assets.append_path 'public'
+end
+app.run
+```
+
+`assets` method can be used to fully setup Sprockets environment:
+
+```ruby
+app = E.new do
+  assets_url '/assets'
+  assets.compile = true
+  assets.compress = false
+  assets.js_compressor = :uglifier
+  # etc.
+end
+
+app.run
+```
+
+To access assets inside controllers/templates, use `assets` method as well:
+
+```ruby
+class App < E
+  # ...
+
+  def some_action
+    assets['application.js'] #=> #<Sprockets::BundledAsset ...>
+  end
+
+end
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**

data/docs/CRUD.md

@@ -0,0 +1,255 @@
+
+## CRUD Helper
+
+`crudify` method will automatically create CRUD actions that will map HTTP requests to corresponding methods on given Resource.
+
+<pre>
+Request                      Resource
+-------------------------------------
+GET     /id                  #get(id)
+
+POST    /   with POST data   #create(params)
+
+PUT     /id with POST data   #get(id).update(params) for DataMapper
+                             #get(id).update_attributes(params) for ActiveRecord
+
+PATCH   /id with POST data   #get(id).update(params) for DataMapper
+                             #get(id).update_attributes(params) for ActiveRecord
+
+DELETE  /id                  #get(id).destroy
+
+HEAD    /id                  #get(id)
+
+OPTIONS /                    returns actions available to client
+</pre>
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Resource
+
+
+First argument is required and should provide the CRUDified resource.<br>
+Resource should respond to `get` and `create` methods.<br>
+Objects created/returned by resource should respond to `update`/`update_attributes` and `destroy` methods.
+
+If your resource/objects behaves differently, you can map its methods by passing them as options.<br>
+
+**Example:** - Force destroying objects
+
+```ruby
+crudify ModelName, :delete => :destroy!
+```
+
+**Example:** - Using a resource that creating records by `new` instead of `create`
+
+```ruby
+crudify ModelName, :post => :new
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Excluded Params
+
+By default all params will be sent to resource.
+
+Good enough, however sometimes you need to exclude some of them.
+
+This is easily accomplished by using `:exclude` option.
+
+To exclude a single param, pass it as a string.
+
+```ruby
+crudify Resource, :exclude => '__stream_uuid__'
+```
+
+To exclude multiple params, pass them as an array.
+
+```ruby
+crudify Resource, :exclude => ['__stream_uuid__', 'user']
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Root
+
+
+By default, `crudify` will create actions that respond to controllers root path.
+
+```ruby
+class App < E
+  map '/'
+
+  crudify SomeModel
+end
+```
+
+This will create following actions:
+
+  - get_index
+  - head_index
+  - post_index
+  - put_index
+  - patch_index
+  - delete_index
+  - options_index
+
+
+To route CRUD actions to a different path, simply pass it as second argument:
+
+```ruby
+class App < E
+  map '/'
+
+  crudify UsersModel, :users
+end
+```
+
+This will create following actions:
+
+  - get_users
+  - head_users
+  - post_users
+  - put_users
+  - patch_users
+  - delete_users
+  - options_users
+
+
+**IMPORTANT!** When you need to override some CRUD action, define it using the corresponding verb.<br>
+Verbless actions will have no effect cause **verbified actions has priority over verbless ones, regardless definition order**:
+
+```ruby
+class App < E
+  map '/'
+
+  crudify SomeModel
+
+  def index
+    # will have no effect at all
+  end
+
+  def get_index
+    # will override crudified method that responds to GET requests
+  end
+end
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+
+## Response
+
+Crudifier will try to return the value of primary key of extracted/created/updated object.
+
+By default `:id` is used as primary key.
+
+To use a custom primary key, pass it via `:pkey` option:
+
+```ruby
+crudify Resource, :pkey => 'prodID'
+```
+
+If objects created by your resource does respond to `:[]` and does contain the pkey column, the value of `object[pkey column]` will be returned.
+
+Otherwise if objects created by your resource does respond to a method of same name as `pkey`,
+the value of `object.send(pkey)` will be returned.
+
+Otherwise the object itself will be returned.
+
+However, if you have a custom logic rather than simply return primary key, use a block.
+
+The block will receive the object as first argument:
+
+```ruby
+crudify UsersModel do |obj|
+  case
+    when post?, put?, patch?
+      obj.id
+    when head?
+      last_modified obj.last_modified
+    else
+      content_type '.json'
+      obj.to_json
+  end
+end
+```
+
+This will return object ID on POST, PUT, and PATCH requests.<br>
+
+On HEAD requests, the framework is always sending an empty body,
+so we only update the headers.<br>
+This way the client may decide when to fetch the object.
+
+On GET requests it will convert the object to JSON before it is sent to client.<br>
+Also `content_type` is used to set proper content type.
+
+DELETE action does not need a handler cause it ever returns an empty string.
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**
+
+## Error Handler
+
+If your objects responds to `:errors` method, 
+crudifier will try to extract and format errors accordingly.
+
+In case of errors, crudifier will behave depending on given options and proc.
+
+If a proc given, crudifier will NOT halt the request.<br>
+It will pass error to given proc via second argument instead.
+
+To halt the request when a proc given, set `:halt_on_errors` to true.
+
+If no proc given, request will be halted unconditionally.
+
+By default the 500 status code will be used when halting.
+
+To use a custom status code pass it via `:halt_with` option.
+
+## Access Restriction
+
+
+Using `auth` will instruct client to require authorization.<br>
+Access can be restricted to some or all actions.
+
+In example below we will restrict access to Create, Update and Delete actions:
+
+```ruby
+class App < E
+  # ...
+
+  auth :post_index, :put_index, :patch_index, :delete_index do |user, pass|
+    [user, pass] = ['admin', 'someReally?secretPass']
+  end
+
+  crudify ModelName
+end
+```
+
+Now, when the client will want to POST, PUT, PATCH, DELETE,
+it will be asked for authorization.
+
+And an OPTIONS request will return all actions for authorized clients and
+only GET, HEAD, OPTIONS for non-authorized clients.
+
+If a root path given, `crudify` will create actions that responds to that root,
+thus actions name will contain given root.
+
+In example below, `crudify` will create actions like `get_users`, `post_users`, `put_users` etc.<br>
+That's why we should specify proper action name in `auth` for authorization to work:
+
+```ruby
+class App < E
+  # ...
+
+  auth :post_users, :put_users, :patch_users, :delete_users do |user, pass|
+    [user, pass] = ['admin', 'someReally?secretPass']
+  end
+
+  crudify UsersModel, :users
+end
+```
+
+**[ [contents &uarr;](https://github.com/espresso/espresso-lungo#use) ]**