good_times 0.0.1

data/lib/good_times.rb

@@ -0,0 +1,35 @@
+require 'json/ext'
+require 'couchrest'
+require_relative 'good_times/query_result'
+require_relative 'good_times/design_doc_helper'
+
+class GoodTimes < CouchRest::Document
+
+  include DesignDocHelper
+
+  class << self
+
+    # alias :find :get
+
+    def query(method, view, options)
+      meta = class << self; self end
+      meta.instance_eval {
+        send(:define_method,"query_#{method.to_s}") do |*opts|
+          results = @design.view(view, options.merge(opts.first || {}))
+          if options[:include_docs] 
+            results["rows"].map! {|row| self.new(row["doc"]) }
+          end
+          QueryResult.new(results)
+        end
+      }
+    end
+
+    def get(id)
+      new database.get(id) rescue nil
+    end
+
+  end
+
+end
+
+

data/lib/good_times/design_doc_helper.rb

@@ -0,0 +1,58 @@
+#   DesignDocHelper makes the following assumptions:
+#     1) if you don't have a design doc created and you call views it will create that for you
+#     2) when looking at your views, you will get the doc["views"] initially pulled from database, this means you can alter the design doc by hand after the class is loaded and DesignDocHelper won't know. Views are indexes created in the database. Any mismatch will resolve to what is in the db.
+#     3) the views macro can only be called after a database has been specified (through use_database)
+#     4) views specified in you class will overwrite the views in your couchdb
+#     5) you will keep anything else already defined (lists, shows, etc)
+
+module DesignDocHelper
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def use_database(db)
+      super
+      @design =
+        begin
+          database.get("_design/#{design_doc_name}")
+        rescue RestClient::ResourceNotFound
+          nil
+        end
+    end
+
+    # must be called only after use_database has been called
+    def views_setup(views)
+      initialize_design_doc(views) and return unless @design
+      if @design["views"] != views
+        update_design_doc(views)
+      end
+    end
+
+    def views
+      @design["views"] if @design
+    end
+
+    private
+
+    def initialize_design_doc(views)
+      @design = CouchRest::Design.new
+      @design.name = design_doc_name
+      @design.database = database
+      @design["views"] = views
+      @design.save
+    end
+
+    def update_design_doc(views)
+      @design['views'] = views
+      @design.save
+    end
+
+    def design_doc_name
+      self.name.downcase
+    end
+  end
+
+end

data/lib/good_times/query_result.rb

@@ -0,0 +1,15 @@
+class QueryResult
+  include Enumerable
+
+  attr_reader :total_rows, :offset, :rows
+
+  def initialize(results)
+    results.each do |key, value|
+      instance_variable_set("@#{key.to_s}", value)
+    end
+  end
+
+  def each(&block)
+    @rows.each {|row| block.call(row)}
+  end
+end

data/lib/good_times/version.rb

@@ -0,0 +1,3 @@
+class GoodTimes
+  VERSION = '0.0.1'
+end

data/spec/good_times_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+class NewMapper < GoodTimes
+  use_database TESTDB
+end
+
+describe GoodTimes do
+  describe ".query" do
+
+    before :each do
+      NewMapper.views_setup("by_id" => {"map" => "function(doc) { emit(doc._id, null) } "})
+      NewMapper.query(:all, :by_id, {:include_docs => true})
+    end
+
+    it "returns a QueryResult object" do
+      NewMapper.query_all.should be_an_instance_of(QueryResult)
+    end
+
+    it "calls a specific view on a design doc" do
+      # expect
+      NewMapper.instance_variable_get("@design").should_receive(:view).with(:by_id, anything()).and_return({"total_rows"=>0, "offset"=>0, "rows"=>[]})
+
+      # when
+      NewMapper.query_all
+    end
+
+    it "defines new methods on the class" do
+      NewMapper.should respond_to(:query_all)
+    end
+
+  end
+
+  it "should have CouchRest::Document as its ancestor" do
+    NewMapper.ancestors.should include(CouchRest::Document)
+  end
+
+  describe ".get" do
+    it "should retrieve a document by id" do
+      TESTDB.save_doc({"_id" => "1234"})
+      nm = NewMapper.get("1234")
+      nm.class.should == NewMapper
+      nm["_id"].should == "1234"
+    end
+    it "should return nil if no document exists" do
+      nm = NewMapper.get("nonexistent")
+      nm.should == nil
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: good_times
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- George South
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchrest
+  requirement: &70138512240520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70138512240520
+description: Connecting couchrest functionality while keeping the couchdb paradigm
+email: ecuageo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/good_times.rb
+- lib/good_times/version.rb
+- lib/good_times/query_result.rb
+- lib/good_times/design_doc_helper.rb
+- spec/good_times_spec.rb
+homepage: http://rubygems.org/gems/good_times
+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.10
+signing_key: 
+specification_version: 3
+summary: Connecting couchrest functionality while keeping the couchdb paradigm
+test_files:
+- spec/good_times_spec.rb