simply_couch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae31eaff1df5b1b5f92f31fc03ed41f757e8d790d5ed6a288bc57f8f15b41f80
+  data.tar.gz: 337be26593098ec144a9f89ea94f21e9614dea96ad44f0b6933191fb9ee9a72f
+SHA512:
+  metadata.gz: 60edce6ad7801d418943af609c9bef4b09cc5ffeec88acca6ea9e111030f2f9981981c4b26f862d2b013dd260573ea2096e1df890803a03b07ffc6546fefc14e
+  data.tar.gz: 21aca11008af8b4ed59fdb5adaf366cf9bdbc7e66db7cee4582879cf64411f44f9faf54658c5e143fc8dd5db5eed7ffa8c6a1d013b795927e5fbd927c80c794b

data/CHANGELOG.md

@@ -0,0 +1,182 @@
+Changelog
+=============
+
+1.0.0
+-----
+- Added Contaiment validator
+- Lots of other stuff
+
+0.6.8
+
+- Lax restriction on ActiveSupport version
+
+0.6.7
+
+- Rebuild with Ruby 1.8
+
+0.6.6
+
+- Bump supported CouchPotato version
+
+0.6.5
+
+- Retry on connection refused errors, useful when CouchDB takes a break in excessive test runs that teardown/re-create many databases
+
+0.6.4
+
+- Restore Ruby 1.9.2 compatibility
+
+0.6.3
+
+- Compatible with CouchPotato 0.5.6
+
+0.6.2
+
+- Decorate conflict exceptions with information about the conflict
+
+0.6.1
+
+- Fix warning of dynamically created views to point to the correct called
+
+0.6.0
+
+- Ruby 1.9.2 compatible
+
+- compatible with CouchPotato > 0.5 where the attributes are lazy loaded
+
+- Depends on ActiveSupport/ActiveModel 3.x
+  --> Does not longer work with Rails 2.x !
+
+0.5.4
+
+- Add Rake task to compact all views in a given database: 
+  DATABASE=http://localhost:5984/my_db rake simply_couch:compact_design_documents
+
+0.5.3
+
+- Change implementation of all_documents_without_deleted view so that it can now be passed view parameters
+
+0.5.1
+
+- Fix nullifying soft deleted objects when they are not deleted
+
+0.5.0
+
+- Add support for has_and_belongs_to_many relations:
+
+  n:m relations where the IDs are stored on one part as an array:
+  
+    class Server
+      include SimplyCouch::Couch
+
+      property :hostname
+
+      has_and_belongs_to_many :networks, :storing_keys => true
+    end
+
+    class Network
+      include SimplyCouch::Couch
+
+      property :klass
+
+      has_and_belongs_to_many :servers, :storing_keys => false
+    end 
+    
+    network = Network.create(:klass => "A")
+    server = Server.new(:hostname => 'www.example.com')
+    network.add_server(server)
+    server.network_ids # => [network.id]
+    network.servers # => [server]
+    server.networks # => [network]
+    
+  The array property holding the IDs of the other item will be used to constuct two view to lookup
+  the other part. Soft deleting is only supported on the class holding the IDs.
+
+- Add support for .last - which is the same as first by reverse order
+
+    User.last # => User.find(:first, :order => :desc)
+
+- Drop support for SimpleDB
+
+0.3.8
+
+- Fix loading of has_many/has_one associations for inherited relations.
+
+- Pre-populate the parent object on has_many and has_one associations so that user.posts.first.user
+  doesn't reload the user.
+
+- Add support for associations not named after the class [akm]
+
+0.3.3
+
+- Fix association counting bug
+
+- Introduce :ignore option to has_many :dependent option. If :dependent is set to :ignore, 
+  dependent objects will not be deleted or nullified but just ignored.
+
+0.3.0
+=============
+
+- SimplyCouch now automatically retries conflicted save operations if it is possible to resolve the conflict.
+  Solving the conflict means that if updated were done one different attributes the local object will 
+  refresh those attributes and try to save again. This will be tried two times by default. Afterwards the conflict
+  exception will be re-raised.
+  
+  This feature can be controlled on the class level like this: User.auto_conflict_resolution_on_save = true | false
+
+0.2.5
+=============
+
+- Allow to pass a custom logger to S3-attachments / RightAws
+
+- Support :order option to has_many associations and classes, e.g:
+
+    @user.posts(:order => :desc)
+    Post.find(:all, :order => :desc)
+    
+  Default to the CouchDB default of ascending.
+  Please update ALL design documents!
+
+
+- Support :limit option to has_many and has_many :through associations, e.g:
+
+    @user.posts(:limit => 5)
+
+0.1.14
+=============
+
+- Add ability to delete all design documents:
+    
+    SimplyCouch::Couch.delete_all_design_documents('http://localhost:5984/mydbname')
+
+- Add rake tasks to delete all design documents. In your Rakefile:
+
+    require 'simply_couch/rake'
+
+Then you can delete all design documents in a database like this:
+
+    DATABASE=http://localhost:5984/mydb rake simply_couch:delete_design_documents    
+
+0.1.13
+=============
+
+- Please delete all your design documents!
+- Auto-generate count-methods for has_many associations, e.g
+
+    class Blog
+      include SimplyCouch::Couch
+      has_many :posts
+    end
+    
+    class Post
+      include SimplyCouch::Couch
+      belongs_to :blog
+    end
+    
+    blog = Blog.create
+    blog.post_count
+    # => 0
+    
+    Post.create(:blog => blog)
+    blog.post_count(:force_reload => true)
+    # => 1

data/LICENSE.txt

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2010 Peritor GmbH <info@peritor.com>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */

data/README.md

@@ -0,0 +1,294 @@
+# SimplyCouch
+
+[![Gem Version](https://badge.fury.io/rb/simply_couch.svg)](https://rubygems.org/gems/simply_couch)
+[![License](https://img.shields.io/badge/license-BSD--2--Clause-blue.svg)](LICENSE.txt)
+
+**Simple CouchDB ORM for Rails** — ActiveModel-compliant, driver-agnostic.
+
+Zero driver dependencies. Your app brings its own CouchDB client (couchrest, couchbase, etc.).
+
+## History
+
+SimplyCouch is based on **[simply_stored](https://github.com/peritor/simply_stored)** (140 ★), created by [Mathias Meyer](https://github.com/roidrage) and [Jonathan Weiss](https://github.com/jweiss) at [Peritor Consulting](https://github.com/peritor) in Berlin (~2010). simply_stored was a convenience layer on top of [CouchPotato](https://github.com/langalex/couch_potato).
+
+This fork evolved over a decade with substantial additions — pagination, ancestry trees, embedded documents, include relations, multi-database support, and a migration toward ActiveModel. In 2026, the CouchPotato dependency was fully removed (~930 lines of view system + persistence ported directly into the gem), couchrest was removed from the gemspec, and the gem was renamed to **SimplyCouch** as its own project.
+
+**Where are the original authors?** Jonathan Weiss (jweiss) co-founded Scalarium and is active in the Berlin tech scene. Mathias Meyer (roidrage) moved to Amazon Web Services Germany. Peritor's [webistrano](https://github.com/peritor/webistrano) (868 ★) was widely used in the Capistrano era.
+
+## Installation
+
+```ruby
+gem 'simply_couch'
+```
+
+Or from git:
+
+```ruby
+gem 'simply_couch', git: 'https://github.com/bterkuile/simply_couch.git'
+```
+
+You must also add a CouchDB client to your Gemfile (the gem doesn't force one):
+
+```ruby
+gem 'couchrest'  # or couchbase, or any CouchDB HTTP client
+```
+
+## Quick Start
+
+```ruby
+class User
+  include SimplyCouch::Model
+
+  property :name
+  property :email
+  property :active, type: Boolean
+  property :last_login, type: Time
+  property :tags, type: Array
+
+  has_many :posts
+  belongs_to :company
+
+  view :by_name, key: :name
+  view :active_by_created, key: :created_at, conditions: 'doc.active == true'
+end
+
+class Post
+  include SimplyCouch::Model
+
+  property :title
+  property :body
+
+  belongs_to :user
+end
+
+# CRUD
+user = User.create(name: 'Alice', email: 'alice@example.com', active: true)
+user.update(name: 'Alice B.')
+user.destroy
+
+# Queries
+User.find_by_name('Alice')
+User.find_all_by_active(true)
+User.active_by_created(descending: true)
+User.all(page: 1, per_page: 40)
+
+# Associations
+user.posts                     # => [Post, ...]
+user.posts(limit: 5, order: :desc)
+user.post_count                # => 42
+```
+
+## Features
+
+### Properties & Type Casting
+
+```ruby
+property :name
+property :age,        type: Integer
+property :price,      type: Float
+property :active,     type: Boolean   # stored as true/false
+property :last_login, type: Time
+property :tags,       type: Array
+property :metadata,   type: Hash
+```
+
+### Associations
+
+`belongs_to`, `has_many`, `has_many_embedded`, `has_and_belongs_to_many`, `has_one`, `embedded_in`.
+
+```ruby
+class Post
+  include SimplyCouch::Model
+  has_many :comments, dependent: :destroy
+  has_many :authors, through: :comments, source: :user
+  belongs_to :category
+end
+
+class User
+  include SimplyCouch::Model
+  has_and_belongs_to_many :networks, storing_keys: true
+end
+```
+
+### Validations
+
+Standard ActiveModel validations plus a `containment` validator for array properties:
+
+```ruby
+class Page
+  include SimplyCouch::Model
+  property :categories
+  validates_containment_of :categories, in: %w[news blog docs]
+end
+```
+
+### Callbacks
+
+`before_save`, `after_save`, `before_create`, `after_create`, `before_destroy`, `after_destroy` — all standard ActiveModel callbacks.
+
+### Views
+
+CouchDB views are auto-generated from your model's property declarations. JavaScript only (Erlang dropped in 2026 port).
+
+```ruby
+view :by_status, key: :status
+view :published, key: :created_at, conditions: 'doc.status == "published"'
+view :by_tags, key: :tags  # array properties work too
+```
+
+Custom views and raw map/reduce are supported via view spec classes.
+
+### Pagination
+
+```ruby
+Post.all(page: 2, per_page: 25)
+User.active_by_created(page: 1, per_page: 50, descending: true)
+```
+
+### Soft Delete
+
+```ruby
+class Document
+  include SimplyCouch::Model
+  enable_soft_delete  # defaults to :deleted_at
+end
+
+doc = Document.create(title: 'draft')
+doc.destroy
+Document.all                          # => [] (soft-deleted filtered out)
+Document.all(with_deleted: true)      # => [doc] (recoverable)
+```
+
+### Ancestry (Tree Structures)
+
+```ruby
+class Page
+  include SimplyCouch::Model
+  property :title
+  has_ancestry
+end
+
+# Build trees
+parent = Page.create(title: 'Products')
+child = Page.create(title: 'Widgets', parent: parent)
+
+# Query trees
+Page.roots                    # pages with no parent
+Page.full_tree                # entire tree loaded in one query
+parent.children               # direct children
+parent.descendants            # all descendants (flattened)
+child.ancestors               # path to root
+
+# Scoped trees (different trees per property)
+has_ancestry by_property: :locale
+```
+
+### Dynamic Finders
+
+```ruby
+User.find_by_name('Alice')
+User.find_all_by_active(true)
+User.count_by_active(true)
+```
+
+### Include Relations
+
+Eager-load associations to avoid N+1 queries on CouchDB:
+
+```ruby
+Post.all(include: :user)              # loads users with posts
+Post.all(include: [:user, :comments]) # multiple associations
+```
+
+### Conflict Resolution
+
+Auto-merge on CouchDB conflicts by default (can be disabled):
+
+```ruby
+User.auto_conflict_resolution_on_save = false  # disable
+```
+
+### Multi-Database Support
+
+```ruby
+class ArchivedPost
+  include SimplyCouch::Model
+  use_database 'http://couchdb:5984/archive'
+end
+```
+
+### Design Document Splitting
+
+Prevent full view reindexing when adding a new view:
+
+```ruby
+class Post
+  include SimplyCouch::Model
+  split_design_documents_per_view  # each view → own _design doc
+
+  view :by_user_id, key: :user_id   # → _design/Post_view_by_user_id
+  view :by_status,  key: :status    # → _design/Post_view_by_status
+end
+```
+
+Without splitting, changing any view reindexes all views. On large databases, this can take hours.
+With splitting, only the new/changed view reindexes.
+
+### Attachments
+
+SimplyCouch supports **two** attachment strategies — use the one that fits your use case:
+
+#### 1. CouchDB Native Inline Attachments
+
+```ruby
+class Invoice
+  include SimplyCouch::Model
+  include SimplyCouch::Model::Attachments
+end
+
+invoice.put_attachment('receipt.pdf', file, content_type: 'application/pdf')
+invoice.fetch_attachment('receipt.pdf')
+invoice.delete_attachment('receipt.pdf')
+invoice.attachment_names  # => ['receipt.pdf', 'logo.png']
+```
+
+Attachments are stored inline in the CouchDB document — atomic, no extra storage, replicable.
+
+#### 2. ActiveStorage Compatibility
+
+*Coming soon — `has_one_attached` / `has_many_attached` backed by CouchDB attachments.*
+
+See `docs/attachments.md` for a detailed comparison of approaches.
+
+### Legacy: S3 Attachments
+
+The `has_s3_attachment` method (using RightAws) exists but is **unmaintained and untested**.
+It was part of the original simply_stored and has not been verified in years. Use CouchDB
+native attachments or ActiveStorage instead.
+
+## Dependencies
+
+| Gem | Version | Notes |
+|-----|---------|-------|
+| activemodel | >= 6.0 | Validations, callbacks, dirty tracking |
+| activesupport | >= 6.0 | Inflections, callbacks, concern |
+
+**No CouchDB driver dependency.** Add `couchrest` or `couchbase` to your app's Gemfile.
+
+## Testing
+
+Uses RSpec with an in-memory CouchDB via [RockingChair](https://github.com/jweiss/rocking_chair).
+
+```bash
+bundle exec rspec
+```
+
+## License
+
+BSD 2-Clause — see [LICENSE.txt](LICENSE.txt)
+
+## Credits
+
+- **Original simply_stored:** [Mathias Meyer](https://github.com/roidrage) & [Jonathan Weiss](https://github.com/jweiss) at [Peritor Consulting](https://github.com/peritor)
+- **Fork & simply_couch:** [Benjamin ter Kuile](https://github.com/bterkuile)
+- **CouchPotato removal + 2026 port:** BenClaw & Benjamin ter Kuile

data/lib/core_ext/date.rb

@@ -0,0 +1,15 @@
+# use ISO8601 as timeformat
+class Date
+  def to_json(*a)
+    %|"#{as_json}"|
+  end
+
+  def as_json(*args)
+    iso8601
+  end
+
+  def self.json_create string
+    return nil if string.nil?
+    Date.parse(string)
+  end
+end

data/lib/core_ext/time.rb

@@ -0,0 +1,23 @@
+require 'active_support/time'
+# use ISO8601 as timeformat
+class Time
+  def to_json(*a)
+    %|"#{as_json}"|
+  end
+
+  def as_json(*args)
+    getutc.iso8601
+  end
+
+  def self.json_create string
+    return nil if string.nil?
+    d = DateTime.parse(string.to_s).new_offset
+    self.utc(d.year, d.month, d.day, d.hour, d.min, d.sec).in_time_zone
+  end
+end
+
+ActiveSupport::TimeWithZone.class_eval do
+  def as_json(*args)
+    utc.iso8601
+  end
+end

data/lib/simply_couch/class_methods_base.rb

@@ -0,0 +1,72 @@
+module SimplyCouch
+  module ClassMethods
+    module Base
+      def get_class_from_name(klass_name)
+        # Try to find class from property definition
+        if property = _find_property(klass_name) and property.respond_to?(:options) and property.options[:class_name].present?
+          property.options[:class_name].constantize
+        else # Fall back to name guessing
+          base = klass_name.to_s.gsub('__','/')
+          base = base.classify unless base[0,1] =~ /[A-Z]/
+          base.constantize
+        end
+      end
+
+      def foreign_key
+        name.underscore.gsub('/','__').gsub('::','__') + "_id"
+      end
+
+      def foreign_property
+        name.underscore.gsub('/','__').gsub('::','__')
+      end
+
+      def attr_protected(*args)
+        @_protected_attributes ||= []
+        @_protected_attributes += args.to_a
+      end
+
+      def attr_accessible(*args)
+        @_accessible_attributes ||= []
+        @_accessible_attributes += args.to_a
+      end
+
+      def _find_property(name)
+        properties.find{|property| property.name == name}
+      end
+
+      # Namespace aware method of creating proper class names
+      def find_association_class_name(association_name)
+        (name.split('::')[0..-2] + [association_name.to_s.singularize.camelize]).join('::')
+      end
+
+      # More compatibility with active record plugins
+      def primary_key
+        'id'
+      end
+
+      def view(view_name, options)
+        options[:reduce] = options.delete(:reduce_function) if options[:reduce_function]
+        options[:map] = options.delete(:map_function) if options[:map_function]
+        super(view_name, options)
+      end
+
+      # Fix for paperclip > 3.5.2
+      def after_commit(*); end
+
+      # Get documents by ids and bulk update attributes
+      def bulk_update(ids, pairs)
+        # Bulk load documents
+        # Map to doc
+        # Filter out errors, or none founds (compact)
+        # Select the Couch objects
+        docs = database.couchrest_database.bulk_load(ids)['rows'].map{|r| r['doc']}.compact.select{|d| d.is_a?(SimplyCouch::Model)}
+        for doc in docs
+          pairs.each_pair do |k, v|
+            doc.send("#{k}=", v) if doc.respond_to?("#{k}=")
+          end
+          doc.save # Should become a bulk update in the future
+        end
+      end
+    end
+  end
+end