Module: CouchPotato

Defined in:
lib/couch_potato.rb,
lib/couch_potato/railtie.rb,
lib/couch_potato/version.rb,
lib/couch_potato/database.rb,
lib/couch_potato/validation.rb,
lib/couch_potato/view/lists.rb,
lib/couch_potato/persistence.rb,
lib/couch_potato/view/view_query.rb,
lib/couch_potato/persistence/json.rb,
lib/couch_potato/view/custom_views.rb,
lib/couch_potato/view/raw_view_spec.rb,
lib/couch_potato/view/base_view_spec.rb,
lib/couch_potato/view/model_view_spec.rb,
lib/couch_potato/persistence/callbacks.rb,
lib/couch_potato/persistence/revisions.rb,
lib/couch_potato/view/custom_view_spec.rb,
lib/couch_potato/persistence/properties.rb,
lib/couch_potato/persistence/attachments.rb,
lib/couch_potato/persistence/type_caster.rb,
lib/couch_potato/view/properties_view_spec.rb,
lib/couch_potato/persistence/simple_property.rb,
lib/couch_potato/persistence/dirty_attributes.rb,
lib/couch_potato/persistence/magic_timestamps.rb,
lib/couch_potato/rspec/matchers/map_to_matcher.rb,
lib/couch_potato/rspec/matchers/list_as_matcher.rb,
lib/couch_potato/forbidden_attributes_protection.rb,
lib/couch_potato/rspec/matchers/reduce_to_matcher.rb,
lib/couch_potato/persistence/deep_dirty_attributes.rb,
lib/couch_potato/persistence/deep_tracked_property.rb,
lib/couch_potato/persistence/active_model_compliance.rb,
lib/couch_potato/rspec/matchers/map_reduce_to_matcher.rb

Defined Under Namespace

Modules: Attachments, ForbiddenAttributesProtection, MagicTimestamps, Persistence, RSpec, Validation, View Classes: Conflict, Database, NotFound, Railtie

Constant Summary collapse

Config =
Struct.new(:database_host, :database_name, :digest_view_names,
:split_design_documents_per_view, :default_language, :additional_databases).new
VERSION =
'1.7.1'.freeze
RSPEC_VERSION =
'3.4.0'.freeze

Class Method Summary collapse

Class Method Details

.couchrest_databaseObject

Returns the underlying CouchRest database object if you want low level access to your CouchDB. You have to set the CouchPotato::Config.database_name before this works.


34
35
36
# File 'lib/couch_potato.rb', line 34

def self.couchrest_database
  Thread.current[:__couchrest_database] ||= CouchRest.database(full_url_to_database(CouchPotato::Config.database_name, CouchPotato::Config.database_host))
end

.couchrest_database_for_name(database_name) ⇒ Object

Returns a CouchRest-Database for directly accessing that functionality.


63
64
65
# File 'lib/couch_potato.rb', line 63

def self.couchrest_database_for_name(database_name)
  CouchRest.database(full_url_to_database(database_name, CouchPotato::Config.database_host))
end

.couchrest_database_for_name!(database_name) ⇒ Object

Creates a CouchRest-Database for directly accessing that functionality.


68
69
70
# File 'lib/couch_potato.rb', line 68

def self.couchrest_database_for_name!(database_name)
  CouchRest.database!(full_url_to_database(database_name))
end

.databaseObject

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.


29
30
31
# File 'lib/couch_potato.rb', line 29

def self.database
  Thread.current[:__couch_potato_database] ||= Database.new(couchrest_database)
end

.full_url_to_database(database_name = CouchPotato::Config.database_name, database_host = CouchPotato::Config.database_host) ⇒ Object


72
73
74
75
76
77
78
79
# File 'lib/couch_potato.rb', line 72

def self.full_url_to_database(database_name = CouchPotato::Config.database_name, database_host = CouchPotato::Config.database_host)
  raise('No Database configured. Set CouchPotato::Config.database_name') unless database_name
  if database_name.match(%r{https?://})
    database_name
  else
    "#{database_host}/#{database_name}"
  end
end

.modelsObject

returns all the classes that include the CouchPotato::Persistence module


23
24
25
26
# File 'lib/couch_potato.rb', line 23

def self.models
  @models ||= []
  @models
end

.rails_initObject


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# File 'lib/couch_potato/railtie.rb', line 4

def self.rails_init
  require File.expand_path(File.dirname(__FILE__) + '/../../rails/reload_classes') if Rails.env.development?
  path = Rails.root.join('config/couchdb.yml')
  if File.exist?(path)
    require 'yaml'
    config = YAML::load(ERB.new(File.read(path)).result)[Rails.env]
    if config.is_a?(String)
      CouchPotato::Config.database_name = config
    else
      CouchPotato::Config.database_name = config['database']
      CouchPotato::Config.additional_databases = config['additional_databases'] if config['additional_databases']
      CouchPotato::Config.split_design_documents_per_view = config['split_design_documents_per_view'] if config['split_design_documents_per_view']
      CouchPotato::Config.digest_view_names = config['digest_view_names'] if config['digest_view_names']
      CouchPotato::Config.default_language = config['default_language'] if config['default_language']
    end
  else
    Rails.logger.warn "Rails.root/config/couchdb.yml does not exist. Not configuring a database."
  end
end

.resolve_database_name(database_name) ⇒ Object

resolves a name to a database name/full url configured under additional databases


47
48
49
# File 'lib/couch_potato.rb', line 47

def self.resolve_database_name(database_name)
  Config.additional_databases[database_name] || database_name
end

.use(database_name) ⇒ Object

Returns a specific database instance


39
40
41
42
43
44
# File 'lib/couch_potato.rb', line 39

def self.use(database_name)
  resolved_database_name = resolve_database_name(database_name)
  Thread.current[:__couch_potato_databases] ||= {}
  Thread.current[:__couch_potato_databases][resolved_database_name] = Database.new(couchrest_database_for_name!(resolved_database_name)) unless Thread.current[:__couch_potato_databases][resolved_database_name]
  Thread.current[:__couch_potato_databases][resolved_database_name]
end

.with_database(database_name) {|use(database_name)| ... } ⇒ Object

Executes a block of code and yields a database with the given name.

example:

CouchPotato.with_database('couch_customer') do |couch|
  couch.save @customer
end

Yields:

  • (use(database_name))

58
59
60
# File 'lib/couch_potato.rb', line 58

def self.with_database(database_name)
  yield use(database_name)
end