couch_potato 1.17.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a78d19f65a75932bb6f60639fc9ad3dff0151e9c7de7f8cbc31e1b61038f7fa8
-  data.tar.gz: c5383ffd3db50bd45d727a84b62588dcd70d6ea3d07ac96559e1318c145fb057
+  metadata.gz: 46b162f592d8c1c7dada2e150793fbfc5f8c76c1e9bb8a3364f8f2895505335b
+  data.tar.gz: eca37db69c74f6f58ec6bb518028a100e9b74ce1bfbe7edce16b899c5caa7406
 SHA512:
-  metadata.gz: 38aa7ce10b0f12429789ecc0f25e34b276f98eadedac900f2ea18b7c1845549be28becb624d4da1c89506d814fa403b7f9647f960f3be534ac47b02c839f6866
-  data.tar.gz: e0b48a96f9a485d0765b066b5e5bca043058b85af246775abdf2bf3afb598bf691b09ae156182b9ecf1ff9dcc0acdee3bb5cc899a8722d0a75bdff9ded965b7b
+  metadata.gz: c4f8edddc5e9a667bb09cb1fa9c5ee5bbb6f374088f27d039bfedd21ce59f13be2a963803bb40be0677916ab9d1d3543eb325849dd5f05010089092ceb0ce891
+  data.tar.gz: 4952e15f37cce9db1e07032f8588a24d28d990cba4e657b657cd4621cf8786a08af9289daadcc1c65a1f6d7f55ea4aef447f7e7e409c488bb706e6ea39e61c4f

data/.github/workflows/ruby.yml

@@ -16,19 +16,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "jruby"]
+        ruby: ["3.2", "3.3", "jruby"]
         gemfile:
-          - "active_support_7_0"
-          - "active_support_7_1"
+          - "active_support_7_2"
+          - "active_support_8_0"
         exclude:
           - ruby: "jruby"
-            gemfile: "active_support_7_0"
+            gemfile: "active_support_8_0"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up CouchDB
-        uses: cobot/couchdb-action@v4
+        uses: cobot/couchdb-action@v5
         with:
-          couchdb version: "2.3.1"
+          couchdb-version: "2.3.1"
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -36,3 +36,5 @@ jobs:
           bundler-cache: true
       - name: Run tests
         run: bundle exec rake spec_ci
+        env:
+          DATABASE: http://admin:admin@localhost:5984/couch_potato_test

data/CHANGES.md

@@ -1,5 +1,16 @@
 ## Changes
 
+# 1.19.0 / rspec-matchers 4.2.0
+
+- add `single_design_document` config option
+- remove support for lists and lib
+
+# 1.18.0
+
+- add testing Rails 7.2/8 on CI
+- change gemspec to allow for Rails 8
+- remove support for Rails < 7.2
+
 # 1.17.0
 
 - filter out nil ids for loading multiple documents

data/README.md

@@ -80,6 +80,12 @@ Another switch allows you to store each CouchDB view in its own design document.
 CouchPotato::Config.split_design_documents_per_view = true
 ```
 
+With the following switch, couch potato only creates a single design document for all views:
+
+```ruby
+CouchPotato::Config.single_design_document = true
+```
+
 If you are using more than one database from your app, you can create aliases:
 
 ```ruby
@@ -95,6 +101,7 @@ Create a `config/couchdb.yml`:
 default: &default
   split_design_documents_per_view: true # optional, default is false
   digest_view_names: true # optional, default is false
+  single_design_document: true # optional, default is false
   default_language: :erlang # optional, default is javascript
   database_host: "http://127.0.0.1:5984"
 
@@ -299,7 +306,7 @@ user.valid? # => false
 user.errors[:name] # => ['can't be blank']
 ```
 
-#### Finding stuff / views / lists
+#### Finding stuff / views
 
 In order to find data in your CouchDB you have to create a [view](http://books.couchdb.org/relax/design-documents/views) first. Couch Potato offers you to create and manage those views for you. All you have to do is declare them in your classes:
 
@@ -403,14 +410,6 @@ class User
 end
 ```
 
-commonJS modules can also be used in custom views:
-
-```ruby
-class User
-  view :all, :map => "function(doc) { emit(null, require("views/lib/test").test)}", :lib => {:test => "exports.test = 'test'"}, :include_docs => true, :type => :custom
-end
-```
-
 If you don't want the results to be converted into models the raw view is your friend:
 
 ```ruby
@@ -450,49 +449,6 @@ You can pass in your own view specifications by passing in `:type => MyViewSpecC
 
 If turned on, Couch Potato will append an MD5 digest of the map function to each view name. This makes sure (together with split_design_documents_per_view) that no views/design documents are ever updated. Instead, new ones are created. Since reindexing can take a long time once your database is larger, you want to avoid blocking your app while CouchDB is busy. Instead, you create a new view, warm it up, and only then start using it.
 
-##### Lists
-
-CouchPotato also supports [CouchDB lists](http://books.couchdb.org/relax/design-documents/lists). With lists you can process the result of a view query with another JavaScript function. This can be useful for example if you want to filter your results, or add some data to each document.
-
-Defining a list works similarly to views:
-
-```ruby
-class User
-  include CouchPotato::Persistence
-
-  property :first_name
-  view :with_full_name, key: first_namne, list: :add_last_name
-  view :all, key: :first_name
-
-  list :add_last_name, <<-JS
-    function(head, req) {
-      var row;
-      send('{"rows": [');
-      while(row = getRow()) {
-        row.doc.name = row.doc.first_name + ' doe';
-        send(JSON.stringify(row));
-      };
-      send(']}');
-    }
-  JS
-end
-
-CouchPotato.database.save User.new(first_name: 'joe')
-CouchPotato.database.view(User.with_full_name).first.name # => 'joe doe'
-```
-
-You can also pass in the list at query time:
-
-```ruby
-CouchPotato.database.view(User.all(list: :add_last_name))
-```
-
-And you can pass parameters to the list:
-
-```ruby
-CouchPotato.database.view(User.all(list: :add_last_name, list_params: {filter: '*'}))
-```
-
 #### Associations
 
 Not supported. Not sure if they ever will be. You can implement those yourself using views and custom methods on your models.

data/Rakefile

@@ -26,7 +26,7 @@ end
 
 desc 'Run all specs for all gemfiles'
 task :spec do
-  %w(7_1 7_0).each do |version|
+  %w(7_2 8_0).each do |version|
     Bundler.with_original_env do
       puts "Running tests with ActiveSupport #{version.sub('_', '.')}"
       sh "env BUNDLE_GEMFILE=gemfiles/active_support_#{version} bundle install"

data/couch_potato.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.version     = CouchPotato::VERSION
   s.platform    = Gem::Platform::RUBY
 
-  s.add_dependency 'activemodel', ['>= 5.0', '< 8.0']
+  s.add_dependency 'activemodel', ['>= 7.2', '< 8.1']
   s.add_dependency 'couchrest', '~>2.0.0'
   s.add_dependency 'json', '~> 2.3'
 

data/gemfiles/{active_support_7_0 → active_support_7_2}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'railties', '~>7.0.8'
+gem 'railties', '~>7.2.1'
 gem 'activemodel'
 gem 'execjs'
 

data/gemfiles/{active_support_7_1 → active_support_8_0}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'railties', '~>7.1.3'
+gem 'railties', '~>8.0.1'
 gem 'activemodel'
 gem 'execjs'
 

data/lib/couch_potato/database.rb

@@ -273,8 +273,6 @@ module CouchPotato
           map: spec.map_function,
           reduce: spec.reduce_function
         } },
-        ({ spec.list_name => spec.list_function } unless spec.list_name.nil?),
-        spec.lib,
         spec.language
       ).query_view!(spec.view_parameters)
     end

data/lib/couch_potato/persistence.rb

@@ -12,16 +12,20 @@ require File.dirname(__FILE__) + '/persistence/type_caster'
 require File.dirname(__FILE__) + '/persistence/revisions'
 require File.dirname(__FILE__) + '/forbidden_attributes_protection'
 require File.dirname(__FILE__) + '/view/custom_views'
-require File.dirname(__FILE__) + '/view/lists'
 require File.dirname(__FILE__) + '/view/view_query'
 
 
 module CouchPotato
   module Persistence
+    module TrackModels
+      def inherited(child)
+        super
+        CouchPotato.models << child
+      end
+    end
 
     def self.included(base) #:nodoc:
-      base.send :include, Properties, Callbacks, Json, CouchPotato::View::CustomViews,
-        CouchPotato::View::Lists
+      base.send :include, Properties, Callbacks, Json, CouchPotato::View::CustomViews
       base.send :include, DirtyAttributes, GhostAttributes, Attachments
       base.send :include, MagicTimestamps, ActiveModelCompliance,
         ForbiddenAttributesProtection, Revisions
@@ -31,9 +35,8 @@ module CouchPotato
         alias_method :id, :_id
         alias_method :id=, :_id=
 
-        def self.inherited(child)
-          super
-          CouchPotato.models << child
+        class << self
+          prepend TrackModels
         end
       end
 

data/lib/couch_potato/version.rb

@@ -1,4 +1,4 @@
 module CouchPotato
-  VERSION = '1.17.0'.freeze
-  RSPEC_VERSION = '4.1.0'.freeze
+  VERSION = '1.19.0'.freeze
+  RSPEC_VERSION = '4.2.0'.freeze
 end

data/lib/couch_potato/view/base_view_spec.rb

@@ -3,7 +3,7 @@
 module CouchPotato
   module View
     class BaseViewSpec
-      attr_reader :reduce_function, :lib, :list_name, :list_function, :design_document, :view_name, :klass, :options, :language
+      attr_reader :reduce_function, :design_document, :view_name, :klass, :options, :language
       attr_accessor :view_parameters
 
       private :klass, :options
@@ -11,7 +11,7 @@ module CouchPotato
       def initialize(klass, view_name, options, view_parameters)
         normalized_view_parameters = ViewParameters.normalize_view_parameters view_parameters
 
-        @list_name = normalized_view_parameters.delete(:list) || options[:list]
+
         @language = options[:language] || Config.default_language
 
         assert_valid_view_parameters normalized_view_parameters
@@ -19,16 +19,12 @@ module CouchPotato
         @options = options
         @view_name = compute_view_name(view_name,
                                        options.key?(:digest_view_name) ? options[:digest_view_name] : Config.digest_view_names)
-        @design_document = translate_to_design_doc_name(klass.to_s, @view_name, @list_name)
-        @list_params = normalized_view_parameters.delete :list_params
-
-        @list_function = klass.lists(@list_name) if @list_name
+        @design_document = design_doc_name
         @view_parameters = {}
         %i[group include_docs descending group_level limit].each do |key|
           @view_parameters[key] = options[key] if options.include?(key)
         end
         @view_parameters.merge!(normalized_view_parameters)
-        @view_parameters.merge!(@list_params) if @list_params
       end
 
       def process_results(results)
@@ -42,10 +38,16 @@ module CouchPotato
       private
 
       def compute_view_name(view_name, digest)
+        name = if CouchPotato::Config.single_design_document
+          "#{translate_to_design_doc_name(klass.to_s, view_name)}-#{view_name}"
+        else 
+          view_name
+        end
+
         if digest
-          "#{view_name}-#{Digest::MD5.hexdigest(map_function + reduce_function.to_s)}"
+          "#{name}-#{Digest::MD5.hexdigest(map_function + reduce_function.to_s)}"
         else
-          view_name
+          name
         end
       end
 
@@ -56,10 +58,18 @@ module CouchPotato
       end
 
       def valid_view_parameters
-        %w[list_params key keys startkey startkey_docid endkey endkey_docid limit stale descending skip group group_level reduce include_docs inclusive_end]
+        %w[key keys startkey startkey_docid endkey endkey_docid limit stale descending skip group group_level reduce include_docs inclusive_end]
+      end
+
+      def design_doc_name
+        if CouchPotato::Config.single_design_document
+          'couch_potato'
+        else
+          translate_to_design_doc_name(klass.to_s, view_name)
+        end
       end
 
-      def translate_to_design_doc_name(klass_name, view_name, list_name)
+      def translate_to_design_doc_name(klass_name, view_name)
         klass_name = klass_name.dup
         klass_name.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
         klass_name.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
@@ -68,7 +78,6 @@ module CouchPotato
 
         if CouchPotato::Config.split_design_documents_per_view
           doc_name += "_view_#{view_name}" if view_name.present?
-          doc_name += "_list_#{list_name}" if list_name.present?
         end
         doc_name
       end

data/lib/couch_potato/view/custom_view_spec.rb

@@ -13,10 +13,6 @@ module CouchPotato
         options[:reduce]
       end
 
-      def lib
-        options[:lib]
-      end
-
       def view_parameters
         {:include_docs => options[:include_docs] || false}.merge(super)
       end

data/lib/couch_potato/view/custom_views.rb

@@ -9,9 +9,21 @@ require 'couch_potato/view/view_parameters'
 module CouchPotato
   module View
     module CustomViews
+      module TrackViews
+        def inherited(child)
+          super
+          CouchPotato.views << child
+        end
+      end
 
       def self.included(base) #:nodoc:
         base.extend ClassMethods
+        CouchPotato.views << base
+        base.class_eval do
+          class << self
+            prepend TrackViews
+          end
+        end
       end
 
       module ClassMethods

data/lib/couch_potato/view/flex_view_spec.rb

@@ -96,7 +96,7 @@ module CouchPotato
       end
 
       delegate :view_name, :view_parameters, :design_document, :map_function,
-               :reduce_function, :list_name, :lib, :language, to: :view_spec_delegate
+               :reduce_function, :language, to: :view_spec_delegate
 
       def process_results(results)
         results = Results.new(results)

data/lib/couch_potato/view/raw_view_spec.rb

@@ -1,6 +1,6 @@
 module CouchPotato
   module View
-    # A view for custom map/reduce functions that returns the raw data fromcouchdb
+    # A view for custom map/reduce functions that returns the raw data from couchdb
     #
     # example:
     #   view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw, :reduce => nil
@@ -10,7 +10,7 @@ module CouchPotato
     #   view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw, :results_filter => lambda{|results| results['rows].map{|row| row['value']}}
     #
     # example:
-    #   view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw, :lib => {:module => "exports.name = 'module';"
+    #   view :my_custom_view, :map => "function(doc) { emit(doc._id, null); }", :type => :raw"
     class RawViewSpec < BaseViewSpec
       def map_function
         options[:map]
@@ -19,10 +19,6 @@ module CouchPotato
       def reduce_function
         options[:reduce]
       end
-
-      def lib
-        options[:lib]
-      end
     end
   end
 end

data/lib/couch_potato/view/view_query.rb

@@ -2,18 +2,13 @@ module CouchPotato
   module View
     # Used to query views (and create them if they don't exist). Usually you won't have to use this class directly. Instead it is used internally by the CouchPotato::Database.view method.
     class ViewQuery
-      def initialize(couchrest_database, design_document_name, view, list = nil, lib = nil, language = :javascript)
+      def initialize(couchrest_database, design_document_name, view, language = :javascript)
         @database = couchrest_database
         @design_document_name = design_document_name
         @view_name = view.keys[0]
         @map_function = view.values[0][:map]
         @reduce_function = view.values[0][:reduce]
-        @lib = lib
         @language = language
-        if list
-          @list_function = list.values[0]
-          @list_name = list.keys[0]
-        end
       end
 
       def query_view!(parameters = {})
@@ -42,34 +37,41 @@ module CouchPotato
       def update_view
         design_doc = @database.get "_design/#{@design_document_name}" rescue nil
         original_views = design_doc && design_doc['views'].dup
-        original_lists = design_doc && design_doc['lists'] && design_doc['lists'].dup
-        view_updated unless design_doc.nil?
+        view_updated
         design_doc ||= empty_design_document
-        design_doc['views'][@view_name.to_s] = view_functions
-        if @lib
-          design_doc['views']['lib'] = (design_doc['views']['lib'] || {}).merge(@lib)
+        if CouchPotato::Config.single_design_document
+          design_doc['views'] = all_views
+        else
+          design_doc['views'][@view_name.to_s] = view_functions
         end
-        if @list_function
-          design_doc['lists'] ||= {}
-          design_doc['lists'][@list_name.to_s] = @list_function
+        if original_views != design_doc['views']
+          @database.save_doc(design_doc) 
         end
-        @database.save_doc(design_doc) if original_views != design_doc['views'] || original_lists != design_doc['lists']
       end
 
-      def view_functions
-        if @reduce_function
-          {'map' => @map_function, 'reduce' => @reduce_function}
-        else
-          {'map' => @map_function}
-        end
+      def all_views
+        CouchPotato.views.flat_map do |klass|
+          specs =  klass.views.map { |view_name, view| klass.execute_view(view_name, {}) }
+          specs.map do |klass_spec|
+            { klass_spec.view_name => view_functions(klass_spec.map_function, klass_spec.reduce_function) }
+          end
+        end.inject(&:merge)
+      end
+
+      def view_functions(map_function = @map_function, reduce_function = @reduce_function)
+        {'map' => map_function, 'reduce' => reduce_function}.compact
       end
 
       def empty_design_document
-        {'views' => {}, 'lists' => {}, "_id" => "_design/#{@design_document_name}", "language" => @language.to_s}
+        {'views' => {}, "_id" => "_design/#{@design_document_name}", "language" => @language.to_s}
       end
 
       def view_has_been_updated?
-        updated_views[[@design_document_name, @view_name]]
+        if CouchPotato::Config.single_design_document
+          updated_views.any?
+        else
+          updated_views[[@design_document_name, @view_name]]
+        end
       end
 
       def view_updated
@@ -81,11 +83,7 @@ module CouchPotato
       end
 
       def query_view(parameters)
-        if @list_name
-          @database.connection.get CouchRest.paramify_url("/#{@database.name}/_design/#{@design_document_name}/_list/#{@list_name}/#{@view_name}", parameters)
-        else
-          @database.view view_url, parameters
-        end
+        @database.view view_url, parameters
       end
 
       def view_url

data/lib/couch_potato.rb

@@ -9,9 +9,10 @@ JSON.create_id = 'ruby_class'
 CouchRest.decode_json_objects = true
 
 module CouchPotato
-  Config = Struct.new(:database_host, :database_name, :digest_view_names,
+  Config = Struct.new(:database_host, :database_name, :digest_view_names, :single_design_document,
                       :split_design_documents_per_view, :default_language, :additional_databases).new
   Config.split_design_documents_per_view = false
+  Config.single_design_document = false
   Config.digest_view_names = false
   Config.default_language = :javascript
   Config.database_host = 'http://127.0.0.1:5984'
@@ -29,6 +30,7 @@ module CouchPotato
       Config.database_host = config['database_host'] if config['database_host']
       Config.additional_databases = config['additional_databases'].stringify_keys if config['additional_databases']
       Config.split_design_documents_per_view = config['split_design_documents_per_view'] if config['split_design_documents_per_view']
+      Config.single_design_document = config['single_design_document'] if config['single_design_document']
       Config.digest_view_names = config['digest_view_names'] if config['digest_view_names']
       Config.default_language = config['default_language'] if config['default_language']
     end
@@ -40,6 +42,12 @@ module CouchPotato
     @models
   end
 
+  # returns all the classes that include the CouchPotato::View::CustomViews module
+  def self.views
+    @views ||= []
+    @views
+  end
+
   # Returns a database instance which you can then use to create objects and query views. You have to set the CouchPotato::Config.database_name before this works.
   def self.database
     Thread.current[:__couch_potato_database] ||= Database.new(couchrest_database)

data/spec/property_spec.rb

@@ -418,7 +418,7 @@ describe 'properties' do
 
     it "should include complex datatypes fully inspected" do
       comment.title = {'en' => 'Blog post'}
-      expect(comment.inspect).to include('title: {"en"=>"Blog post"}')
+      expect(comment.inspect).to match(/title: {"en"\s*=>\s*"Blog post"}/)
 
       comment.title = nil
       expect(comment.inspect).to include('title: nil')

data/spec/single_design_document_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'single design document' do
+  let(:db) { CouchPotato.database }
+  let(:couchrest_db) { db.couchrest_database }
+
+  class Thing1
+    include CouchPotato::Persistence
+
+    property :title
+
+    view :all, key: :title
+  end
+
+  class Thing2
+    include CouchPotato::Persistence
+
+    property :name
+
+    view :all, key: :name
+  end
+
+  class Thing3 < Thing1 # should work with inheritance
+    property :tag
+
+    view :by_tag, key: :tag
+  end
+
+  before(:each) do
+    recreate_db
+    CouchPotato::Config.single_design_document = true
+    CouchPotato.views.select! { |v| [Thing1, Thing2, Thing3].include?(v) } # clear classes from other specs
+  end
+
+  after(:each) do
+    CouchPotato::Config.single_design_document = false
+  end
+
+  it 'creates a single design document for all views' do
+    thing1 = Thing1.new title: 't1'
+    db.save! thing1
+    thing2 = Thing2.new name: 'n2'
+    db.save! thing2
+
+    db.view(Thing1.all) # create all views when querying the first one
+
+    expect(couchrest_db.get('_design/couch_potato')['views'].keys)
+      .to(eq(['thing1-all', 'thing2-all', 'thing3-by_tag']))
+  end
+
+  it 'returns the correct models' do
+    thing1 = Thing1.new title: 't1'
+    db.save! thing1
+    thing2 = Thing2.new name: 'n2'
+    db.save! thing2
+    thing3 = Thing3.new tag: 'tag1'
+    db.save! thing3
+
+    expect(db.view(Thing1.all('t1'))).to eq([thing1])
+    expect(db.view(Thing2.all('n2'))).to eq([thing2])
+    expect(db.view(Thing3.by_tag('tag1'))).to eq([thing3])
+  end
+end

data/spec/unit/attributes_spec.rb

@@ -87,7 +87,7 @@ describe 'attributes' do
       plant = Plant.new
       expect do
         plant.length
-      end.to raise_error(NoMethodError, /undefined method `length'/)
+      end.to raise_error(NoMethodError, /undefined method [`']length'/)
     end
   end