couchbase-view-helpers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5969f1cea529b81ff69da1548e5c9b2f7be735b4
+  data.tar.gz: 2afb4775d2c4c33dbdf643226dcd81a392d8226b
+SHA512:
+  metadata.gz: cc590a24a51ca43a029adddf07737c81aa365fe7e8525b67c9b0f440e1d79ba3a370256b0ebb91b60f5dc0de0fee6fc7f6262fb1b7b5629a334c15d0cc93c2c5
+  data.tar.gz: fb2ee19d585f62ad1110c721d873a99e80b672ea85725774331340386c534774cac0d5781aa0192db8acb705c3a706f6ceb4a657f606243194f0d3a2c55799b7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in couchbase-view_helpers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Evans
+
+MIT License
+
+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,78 @@
+# 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

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/couchbase-view-helpers.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'couchbase/view_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'couchbase-view-helpers'
+  spec.version       = Couchbase::ViewHelpers::VERSION
+  spec.authors       = ['Mike Evans']
+  spec.email         = ['mike@urlgonomics.com']
+  spec.description   = %q{Adds syntactic sugar to Couchbase view options hashes.}
+  spec.summary       = %q{Adds syntactic sugar to Couchbase view options hashes.}
+  spec.homepage      = 'https://github.com/mje113/couchbase-view-helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'couchbase', '~> 1.3.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/couchbase/view_helpers/paginate_params.rb

@@ -0,0 +1,21 @@
+module Couchbase
+
+  module ViewHelpers
+    class PaginateParams
+
+      PER_PAGE_DEFAULT = 100
+
+      def initialize(params = {})
+        @page     = (params[:page]     || 1).to_i
+        @per_page = (params[:per_page] || PER_PAGE_DEFAULT).to_i
+      end
+
+      def to_h
+        {
+          skip: (@page - 1) * @per_page,
+          limit: @per_page
+        }
+      end
+    end
+  end
+end

data/lib/couchbase/view_helpers/version.rb

@@ -0,0 +1,5 @@
+module Couchbase
+  module ViewHelpers
+    VERSION = '1.0.0'
+  end
+end

data/lib/couchbase/view_helpers.rb

@@ -0,0 +1,87 @@
+require 'couchbase/view_helpers/version'
+
+module Couchbase
+
+  module ViewHelpers
+
+    # Keys
+    def key(key)
+      add_param(key: key)
+    end
+
+    def keys(*keys)
+      add_param(keys: Array(keys).flatten)
+    end
+
+    # Pagination
+    def paginate(params = {})
+      add_param(PaginateParams.new(params).to_h)
+    end
+
+    def page(page_num)
+      paginate(page: page_num)
+    end
+
+    def per(per_page)
+      paginate(per_page: per_page)
+    end
+
+    # Ordering
+    def order(direction)
+      add_param(descending: (direction.to_s =~ /^asc/i) != 0)
+    end
+
+    def desc
+      order('desc')
+    end
+
+    def asc
+      order('asc')
+    end
+
+    # Grouping
+    def group(group = true)
+      add_param(group: group)
+    end
+
+    def group_level(group_level)
+      add_param(group_level: group_level)
+    end
+    alias_method :level, :group_level
+
+    # Reducing
+    def reduce(reduce = true)
+      add_param(reduce: reduce)
+    end
+
+    # Freshness
+    def stale(stale = :ok)
+      add_param(stale: stale)
+    end
+
+    def fresh
+      stale(false)
+    end
+
+    def update_after
+      stale(:update_after)
+    end
+
+    # Docs
+    def include_docs(docs = true)
+      add_param(include_docs: docs)
+    end
+
+    def no_docs
+      include_docs(false)
+    end
+
+    protected
+
+    def add_param(param)
+      @params.merge!(param)
+      self
+    end
+
+  end
+end

data/lib/couchbase.rb

@@ -0,0 +1,10 @@
+require 'couchbase'
+require 'couchbase/view_helpers'
+require 'couchbase/view_helpers/paginate_params'
+require 'couchbase/view_helpers/version'
+
+module Couchbase
+  class View
+    include ViewHelpers
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require_relative '../lib/couchbase'
+
+class MockView
+  include Couchbase::ViewHelpers
+
+  attr_accessor :params
+  def initialize(params = {})
+    @params = params
+  end
+end

data/test/test_integration.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestIntegration < MiniTest::Unit::TestCase
+
+  def setup
+    @view = Couchbase::View.new('bucket', 'endpoint')
+  end
+
+  def test_has_public_methods
+    %i(key keys paginate page per order desc asc).each do |meth|
+      assert @view.respond_to?(meth), "View not responding to #{meth}"
+    end
+  end
+
+end

data/test/test_paginate_params.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestPaginateParams < MiniTest::Unit::TestCase
+
+  def test_can_parse_params_into_view_params
+    paginator = Couchbase::ViewHelpers::PaginateParams.new({ page: 2, per_page: 20 })
+    assert_equal({ skip: 20, limit: 20 }, paginator.to_h)
+  end
+
+  def test_can_have_defaults
+    paginator = Couchbase::ViewHelpers::PaginateParams.new
+    assert_equal({ skip: 0, limit: 100 }, paginator.to_h)
+  end
+
+  def test_can_interface_with_view
+    view = MockView.new
+    view.paginate
+    assert_equal({ skip: 0, limit: 100 }, view.params)
+  end
+
+  def test_can_deal_wth_strings
+    paginator = Couchbase::ViewHelpers::PaginateParams.new({ page: '2', per_page: '20' })
+    assert_equal({ skip: 20, limit: 20 }, paginator.to_h)
+  end
+end

data/test/test_view_helpers.rb

@@ -0,0 +1,110 @@
+require 'helper'
+
+class TestViewHelpers < MiniTest::Unit::TestCase
+
+  def setup
+    @view = MockView.new
+  end
+
+  def test_can_set_key
+    assert_instance_of MockView, @view.key('foo')
+    assert_equal 'foo', @view.params[:key]
+  end
+
+  def test_can_set_keys
+    assert_instance_of MockView, @view.keys(['foo', 'bar'])
+    assert_equal ['foo', 'bar'], @view.params[:keys]
+  end
+
+  def test_can_set_keys_with_args
+    assert_instance_of MockView, @view.keys('foo', 'bar')
+    assert_equal ['foo', 'bar'], @view.params[:keys]
+  end
+
+  def test_can_paginate
+    assert_instance_of MockView, @view.paginate(page: 2, per_page: 20)
+    assert_equal 20, @view.params[:skip]
+    assert_equal 20, @view.params[:limit]
+  end
+
+  def test_can_paginate_by_page
+    assert_instance_of MockView, @view.page(2)
+    assert_equal 100, @view.params[:skip]
+    assert_equal 100, @view.params[:limit]
+  end
+
+  def test_can_paginate_by_per
+    assert_instance_of MockView, @view.per(20)
+    assert_equal 0,  @view.params[:skip]
+    assert_equal 20, @view.params[:limit]
+  end
+
+  def test_can_paginate_by_page_and_per
+    skip "need to persist"
+    assert_instance_of MockView, @view.page(2).per(20)
+    assert_equal 20, @view.params[:skip]
+    assert_equal 20, @view.params[:limit]
+  end
+
+  def test_can_set_order
+    assert_instance_of MockView, @view.order('asc')
+    refute false, @view.params[:descending]
+
+    @view.order('ascending')
+    refute false, @view.params[:descending]
+
+    @view.order('desc')
+    assert true, @view.params[:descending]
+  end
+
+  def test_can_set_order_by_desc
+    assert_instance_of MockView, @view.desc
+    assert true, @view.params[:descending]
+  end
+
+  def test_can_set_order_by_asc
+    assert_instance_of MockView, @view.asc
+    refute false, @view.params[:descending]
+  end
+
+  def test_can_group
+    assert_instance_of MockView, @view.group
+    assert @view.params[:group]
+
+    @view.group(false)
+    refute @view.params[:group]
+  end
+
+  def test_can_group_level
+    assert_instance_of MockView, @view.group_level(2)
+    assert_equal 2, @view.params[:group_level]
+
+    @view.level(3)
+    assert_equal 3, @view.params[:group_level]
+  end
+
+  def test_can_set_stale
+    assert_instance_of MockView, @view.stale
+    assert_equal :ok, @view.params[:stale]
+  end
+
+  def test_can_set_fresh
+    assert_instance_of MockView, @view.fresh
+    refute @view.params[:stale]
+  end
+
+  def test_can_set_update_after
+    assert_instance_of MockView, @view.update_after
+    assert_equal :update_after, @view.params[:stale]
+  end
+
+  def test_can_set_include_docs
+    assert_instance_of MockView, @view.include_docs
+    assert @view.params[:include_docs]
+  end
+
+  def test_can_set_no_docs
+    assert_instance_of MockView, @view.include_docs
+    assert @view.params[:include_docs]
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: couchbase-view-helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchbase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds syntactic sugar to Couchbase view options hashes.
+email:
+- mike@urlgonomics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- couchbase-view-helpers.gemspec
+- lib/couchbase.rb
+- lib/couchbase/view_helpers.rb
+- lib/couchbase/view_helpers/paginate_params.rb
+- lib/couchbase/view_helpers/version.rb
+- test/helper.rb
+- test/test_integration.rb
+- test/test_paginate_params.rb
+- test/test_view_helpers.rb
+homepage: https://github.com/mje113/couchbase-view-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Adds syntactic sugar to Couchbase view options hashes.
+test_files:
+- test/helper.rb
+- test/test_integration.rb
+- test/test_paginate_params.rb
+- test/test_view_helpers.rb