Git Product home page Git Product logo

couchbase-view-helpers's Introduction

Couchbase::ViewHelpers

After using Couchbase::View in a few projects, I quickly tired of having to reference the API docs for the specific options needed. This gem adds some simple methods to make configuring a View before the query is executed.

Installation

Add this line to your application's Gemfile:

gem 'couchbase-view-helpers'

And then execute:

$ bundle

Or install it yourself as:

$ gem install couchbase-view-helpers

Usage

require 'couchbase/model'

class Post < Couchbase::Model
  attribute :title
  attribute :body
  attribute :draft

  view :all, :by_draft_status
end

Normal View access:

drafts = Post.by_draft_status(key: true)
all    = Post.all(descending: true)

With ViewHelpers:

drafts = Post.by_draft_status.key(true)
all    = Post.all.desc

Supports will_paginate and kaminari style pagination. Normal View pagination:

page  = 3
per   = 20
skip  = (page - 1) * per
limit = per
page  = Post.all(skip: skip, limit: limit)

With ViewHelpers:

page = Post.all.paginate(page: 3, per_page: 20)
# or
page = Post.all.page(3).per(20)

TODO

  1. Full coverage of all options (key ranges, etc.)
  2. Integrate pagination and other defaults in the class level view declaration.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Bitdeli Badge

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.