toystore-couch 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+gemspec
+
+group(:development) do
+  gem 'rake',       '~> 0.8.7'
+  gem 'rspec',      '~> 2.3'
+  gem 'log_buddy',  '~> 0.5.0'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Pelle Braendgaard, John Nunemaker
+
+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.rdoc

@@ -0,0 +1,51 @@
+= Toystore Couch
+
+CouchDB integration for Toystore. Much of this is stolen whole sale from CouchRest Model https://github.com/couchrest/couchrest_model
+
+Currently it adds a few Couch necessities such as support for views (map reduce queries):
+
+==== Example views:
+ 
+  class Post
+    include Toy::Store
+    store :couch, CouchRest.database!("http://127.0.0.1:5984/agree2-development")
+    # view with default options
+    # query with Post.by_date
+    view_by :date, :descending => true
+ 
+    # view with compound sort-keys
+    # query with Post.by_user_id_and_date
+    view_by :user_id, :date
+ 
+    # view with custom map/reduce functions
+    # query with Post.by_tags :reduce => true
+    view_by :tags,                                                
+      :map =>                                                     
+        "function(doc) {                                          
+          if (doc['model'] == 'Post' && doc.tags) {                   
+            doc.tags.forEach(function(tag){                       
+              emit(doc.tag, 1);                                   
+            });                                                   
+          }                                                       
+        }",                                                       
+      :reduce =>                                                  
+        "function(keys, values, rereduce) {                       
+          return sum(values);                                     
+        }"                                                        
+  end
+
+== Install
+
+  $ gem install toystore-couch
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/toy/couch.rb

@@ -0,0 +1,20 @@
+require 'toy'
+require 'toy/attributes'
+require 'toy/couch/type'
+require 'toy/couch/design_doc'
+require 'toy/couch/views'
+require 'adapter/couch'
+
+
+module Toy
+  module Couch
+    extend ActiveSupport::Concern
+
+    included do
+      include DesignDoc
+      include Views
+    end
+  end
+end
+
+Toy.plugin(Toy::Couch)

data/lib/toy/couch/design_doc.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require 'couchrest'
+require 'couchrest/design'
+
+module Toy
+  module Couch
+    module DesignDoc
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def design_doc
+          @design_doc ||= ::CouchRest::Design.new(default_design_doc)
+        end
+
+        def design_doc_id
+          "_design/#{design_doc_slug}"
+        end
+
+        def design_doc_slug
+          self.to_s
+        end
+
+        def design_doc_uri
+          "#{store.client.root}/#{design_doc_id}"
+        end
+
+        # Retreive the latest version of the design document directly
+        # from the database. This is never cached and will return nil if
+        # the design is not present.
+        #
+        # Use this method if you'd like to compare revisions [_rev] which
+        # is not stored in the normal design doc.
+        def stored_design_doc
+          store.client.get(design_doc_id)
+        rescue RestClient::ResourceNotFound
+          nil
+        end
+
+        # Save the design doc onto a target database in a thread-safe way,
+        # not modifying the model's design_doc
+        #
+        # See also save_design_doc! to always save the design doc even if there
+        # are no changes.
+        def save_design_doc(force = false)
+          update_design_doc(force)
+        end
+
+        # Force the update of the model's design_doc even if it hasn't changed.
+        def save_design_doc!
+          save_design_doc(true)
+        end
+
+        private
+
+        # Writes out a design_doc to a given database if forced.
+        #
+        # Returns the original design_doc provided, but does 
+        # not update it with the revision.
+        def update_design_doc(force = false)
+          return design_doc unless force
+
+          # Load up the stored doc (if present), update, and save
+          saved = stored_design_doc
+          if saved
+            saved.merge!(design_doc)
+            store.client.save_doc(saved)
+          else
+            store.client.save_doc(design_doc)
+            design_doc.delete('_rev') # Prevent conflicts, never store rev as db specific
+          end
+
+          design_doc
+        end
+
+        def default_design_doc
+          {
+            "_id" => design_doc_id,
+            "language" => "javascript",
+            "views" => {
+              'all' => {
+                'map' => "function(doc) {
+                  if (doc['type'] == '#{self.to_s}') {
+                    emit(doc['_id'],1);
+                  }
+                }"
+              }
+            }
+          }
+        end
+
+      end # module ClassMethods
+
+    end
+  end
+end

data/lib/toy/couch/type.rb

@@ -0,0 +1,13 @@
+module Toy
+  module Couch
+    module Type
+      extend ActiveSupport::Concern
+      
+      module InstanceMethods
+        def persisted_attributes
+          super.merge("type"=>self.class.name)
+        end
+      end
+    end
+  end
+end

data/lib/toy/couch/version.rb

@@ -0,0 +1,5 @@
+module Toy
+  module Couch
+    VERSION = '0.1.0'
+  end
+end

data/lib/toy/couch/views.rb

@@ -0,0 +1,146 @@
+require 'couchrest/design'
+module Toy
+  module Couch
+    module Views
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        # This was pretty much stolen whole sale from CouchRest Model
+        # https://github.com/couchrest/couchrest_model/blob/master/lib/couchrest/model/views.rb
+        #
+        # Define a Couchstore.client view. The name of the view will be the concatenation
+        # of <tt>by</tt> and the keys joined by <tt>_and_</tt>
+        #  
+        # ==== Example views:
+        #  
+        #   class Post
+        #     include Toy::Store
+        #     store :couch, CouchRest.database!("http://127.0.0.1:5984/agree2-development")
+        #     # view with default options
+        #     # query with Post.by_date
+        #     view_by :date, :descending => true
+        #  
+        #     # view with compound sort-keys
+        #     # query with Post.by_user_id_and_date
+        #     view_by :user_id, :date
+        #  
+        #     # view with custom map/reduce functions
+        #     # query with Post.by_tags :reduce => true
+        #     view_by :tags,                                                
+        #       :map =>                                                     
+        #         "function(doc) {                                          
+        #           if (doc['model'] == 'Post' && doc.tags) {                   
+        #             doc.tags.forEach(function(tag){                       
+        #               emit(doc.tag, 1);                                   
+        #             });                                                   
+        #           }                                                       
+        #         }",                                                       
+        #       :reduce =>                                                  
+        #         "function(keys, values, rereduce) {                       
+        #           return sum(values);                                     
+        #         }"                                                        
+        #   end
+        #  
+        # <tt>view_by :date</tt> will create a view defined by this Javascript
+        # function:
+        #  
+        #   function(doc) {
+        #     if (doc['model'] == 'Post' && doc.date) {
+        #       emit(doc.date, null);
+        #     }
+        #   }
+        #  
+        # It can be queried by calling <tt>Post.by_date</tt> which accepts all
+        # valid options for CouchRest::Database#view. In addition, calling with
+        # the <tt>:raw => true</tt> option will return the view rows
+        # themselves. By default <tt>Post.by_date</tt> will return the
+        # documents included in the generated view.
+        #  
+        # Toy::Stor#view options can be applied at view definition
+        # time as defaults, and they will be curried and used at view query
+        # time. Or they can be overridden at query time.
+        #  
+        # Custom views can be queried with <tt>:reduce => true</tt> to return
+        # reduce results. The default for custom views is to query with
+        # <tt>:reduce => false</tt>.
+        #  
+        # Views are generated (on a per-model basis) lazily on first-access.
+        # This means that if you are deploying changes to a view, the views for
+        # that model won't be available until generation is complete. This can
+        # take some time with large databases. Strategies are in the works.
+        #  
+
+        def view_by(*keys)
+          include Type
+          opts = keys.pop if keys.last.is_a?(Hash)
+          opts ||= {}
+          ducktype = opts.delete(:ducktype)
+          unless ducktype || opts[:map]
+            opts[:guards] ||= []
+            opts[:guards].push "(doc['type'] == '#{self.to_s}')"
+          end
+          keys.push opts
+          design_doc.view_by(*keys)
+        end
+
+        # returns stored defaults if there is a view named this in the design doc
+        def has_view?(name)
+          design_doc && design_doc.has_view?(name)
+        end
+
+        # Check if the view can be reduced by checking to see if it has a
+        # reduce function.
+        def can_reduce_view?(name)
+          design_doc && design_doc.can_reduce_view?(name)
+        end
+
+        # Dispatches to any named view.
+        def view(name, query={}, &block)
+          query = query.dup # Modifications made on copy!
+          query[:raw] = true if query[:reduce]
+          raw = query.delete(:raw)
+          save_design_doc(store.client)
+          fetch_view_with_docs( name, query, raw, &block)
+        end
+
+        # Find the first entry in the view. If the second parameter is a string
+        # it will be used as the key for the request, for example:
+        #
+        #     Course.first_from_view('by_teacher', 'Fred')
+        #
+        # More advanced requests can be performed by providing a hash:
+        #
+        #     Course.first_from_view('by_teacher', :startkey => 'bbb', :endkey => 'eee')
+        #
+        def first_from_view(name, *args)
+          query = {:limit => 1}
+          case args.first
+          when String, Array
+            query.update(args[1]) unless args[1].nil?
+            query[:key] = args.first
+          when Hash
+            query.update(args.first)
+          end
+          view(name, query).first
+        end
+
+        private
+
+        def fetch_view_with_docs( name, opts, raw=false, &block)
+          if raw || (opts.has_key?(:include_docs) && opts[:include_docs] == false)
+            fetch_view( name, opts, &block)
+          else
+            opts = opts.merge(:include_docs => true)
+            view = fetch_view name, opts, &block
+            view['rows'].collect{|r| load(r['doc']['_id'], r['doc'])} if view['rows']
+          end
+        end
+
+        def fetch_view(view_name, opts, &block)
+          raise "A view needs a database to operate on (specify :database option, or use_database in the #{self.class} class)" unless store.client
+          design_doc.view_on(store.client, view_name, opts, &block)
+        end
+      end # module ClassMethods
+    end
+  end
+end

data/lib/toystore-couch.rb

@@ -0,0 +1 @@
+require 'toy/couch'

data/spec/helper.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+log_path  = root_path.join('log')
+log_path.mkpath
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:development)
+
+require 'toy/couch'
+require 'support/constants'
+
+STORE = CouchRest.database!("http://127.0.0.1:5984/toystore-couch-test")
+
+Logger.new(log_path.join('test.log')).tap do |log|
+  LogBuddy.init(:logger => log)
+  Toy.logger = log
+end
+
+RSpec.configure do |c|
+  c.include(Support::Constants)
+
+  c.before(:each) do
+    STORE.recreate!
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--timeout
+20

data/spec/support/constants.rb

@@ -0,0 +1,41 @@
+module Support
+  module Constants
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def uses_constants(*constants)
+        before { create_constants(*constants) }
+      end
+    end
+
+    def create_constants(*constants)
+      constants.each { |constant| create_constant(constant) }
+    end
+
+    def remove_constants(*constants)
+      constants.each { |constant| remove_constant(constant) }
+    end
+
+    def create_constant(constant)
+      remove_constant(constant)
+      Kernel.const_set(constant, Model(constant))
+    end
+
+    def remove_constant(constant)
+      Kernel.send(:remove_const, constant) if Kernel.const_defined?(constant)
+    end
+
+    def Model(name=nil)
+      Class.new.tap do |model|
+        model.class_eval """
+          def self.name; '#{name}' end
+          def self.to_s; '#{name}' end
+        """ if name
+        model.send(:include, Toy::Store)
+        model.store(:couch, STORE)
+      end
+    end
+  end
+end

data/spec/toy/couch/type_spec.rb

@@ -0,0 +1,21 @@
+require 'helper'
+describe Toy::Couch::Type do
+  uses_constants('User')
+
+  before(:each) do
+    User.identity_map_off
+    User.send :include, Toy::Couch::Type
+    User.attribute(:name, String)
+    User.attribute(:state, String)
+  end
+
+  describe "revisioning" do
+    before(:each) do
+      @john = User.create(:name => 'John', :state=>"CA")
+    end
+
+    it "performs view" do
+      @john.persisted_attributes["type"].should == "User"
+    end
+  end
+end

data/spec/toy/couch/views_spec.rb

@@ -0,0 +1,36 @@
+require 'helper'
+describe Toy::Couch::Views do
+  uses_constants('User')
+
+  before(:each) do
+    User.identity_map_off
+    User.attribute(:name, String)
+    User.attribute(:state, String)
+    User.view_by :state
+    User.view_by :name
+  end
+
+  describe "revisioning" do
+    before(:each) do
+      @john = User.create(:name => 'John', :state=>"CA")
+      @bill = User.create(:name => 'Bill', :state=>"FL")
+      @miguel = User.create(:name => 'Miguel', :state=>"FL")
+    end
+
+    it "performs view" do
+      all = User.view(:all)
+      all.should include(@john)
+      all.should include(@bill)
+      all.should include(@miguel)
+      
+      User.view(:by_state, :key=>"FL").should include(@miguel)
+      User.view(:by_state, :key=>"FL").should include(@bill)
+
+      User.view(:by_state, :key=>"CA").should include(@john)
+      
+      User.view(:by_name, :key=>"John").should include(@john)
+      
+      User.first_from_view(:by_name, "John").should == @john
+    end
+  end
+end

data/toystore-couch.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "toy/couch/version"
+
+Gem::Specification.new do |s|
+  s.name        = "toystore-couch"
+  s.version     = Toy::Couch::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Pelle Braendgaard']
+  s.email       = ['pelle@stakeventures.com']
+  s.homepage    = ''
+  s.summary     = %q{CouchDB integration for Toystore}
+  s.description = %q{CouchDB integration for Toystore}
+
+  s.add_dependency('toystore', '~> 0.7.0')
+  s.add_dependency('adapter-couch', '~> 0.1.2')
+
+  s.files         = `git ls-files`.split("\n") - ['specs.watchr']
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: toystore-couch
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pelle Braendgaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: toystore
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: adapter-couch
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id002
+description: CouchDB integration for Toystore
+email: 
+- pelle@stakeventures.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/toy/couch.rb
+- lib/toy/couch/design_doc.rb
+- lib/toy/couch/type.rb
+- lib/toy/couch/version.rb
+- lib/toy/couch/views.rb
+- lib/toystore-couch.rb
+- spec/helper.rb
+- spec/spec.opts
+- spec/support/constants.rb
+- spec/toy/couch/type_spec.rb
+- spec/toy/couch/views_spec.rb
+- toystore-couch.gemspec
+has_rdoc: true
+homepage: ""
+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.6.2
+signing_key: 
+specification_version: 3
+summary: CouchDB integration for Toystore
+test_files: 
+- spec/helper.rb
+- spec/spec.opts
+- spec/support/constants.rb
+- spec/toy/couch/type_spec.rb
+- spec/toy/couch/views_spec.rb