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/ghost_attributes.rb,
lib/couch_potato/persistence/magic_timestamps.rb,
lib/couch_potato/forbidden_attributes_protection.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
Defined Under Namespace
Modules: Attachments, ForbiddenAttributesProtection, GhostAttributes, MagicTimestamps, Persistence, 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).new
- VERSION =
'1.7.1'.freeze
- RSPEC_VERSION =
'3.4.0'.freeze
Class Method Summary collapse
-
.couchrest_database ⇒ Object
Returns the underlying CouchRest database object if you want low level access to your CouchDB.
-
.couchrest_database_for_name(database_name) ⇒ Object
Returns a CouchRest-Database for directly accessing that functionality.
-
.couchrest_database_for_name!(database_name) ⇒ Object
Creates a CouchRest-Database for directly accessing that functionality.
-
.database ⇒ Object
Returns a database instance which you can then use to create objects and query views.
- .full_url_to_database(database_name = CouchPotato::Config.database_name, database_host = CouchPotato::Config.database_host) ⇒ Object
-
.models ⇒ Object
returns all the classes that include the CouchPotato::Persistence module.
- .rails_init ⇒ Object
-
.use(database_name) ⇒ Object
Returns a specific database instance.
-
.with_database(database_name) {|| ... } ⇒ Object
Executes a block of code and yields a datbase with the given name.
Class Method Details
.couchrest_database ⇒ Object
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.
32 33 34 |
# File 'lib/couch_potato.rb', line 32 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.
57 58 59 |
# File 'lib/couch_potato.rb', line 57 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.
62 63 64 |
# File 'lib/couch_potato.rb', line 62 def self.couchrest_database_for_name!(database_name) CouchRest.database!(full_url_to_database(database_name)) end |
.database ⇒ Object
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.
27 28 29 |
# File 'lib/couch_potato.rb', line 27 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
66 67 68 69 70 71 72 73 |
# File 'lib/couch_potato.rb', line 66 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 |
.models ⇒ Object
returns all the classes that include the CouchPotato::Persistence module
21 22 23 24 |
# File 'lib/couch_potato.rb', line 21 def self.models @models ||= [] @models end |
.rails_init ⇒ Object
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
# File 'lib/couch_potato/railtie.rb', line 4 def self.rails_init require File.(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.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 |
.use(database_name) ⇒ Object
Returns a specific database instance
37 38 39 40 41 |
# File 'lib/couch_potato.rb', line 37 def self.use(database_name) Thread.current[:__couch_potato_databases] ||= {} Thread.current[:__couch_potato_databases][database_name] = Database.new(couchrest_database_for_name!(database_name)) unless Thread.current[:__couch_potato_databases][database_name] Thread.current[:__couch_potato_databases][database_name] end |
.with_database(database_name) {|| ... } ⇒ Object
Executes a block of code and yields a datbase with the given name.
example:
CouchPotato.with_database('couch_customer') do |couch|
couch.save @customer
end
50 51 52 53 54 |
# File 'lib/couch_potato.rb', line 50 def self.with_database(database_name) Thread.current[:__couch_potato_databases] ||= {} Thread.current[:__couch_potato_databases][database_name] = Database.new(couchrest_database_for_name(database_name)) unless Thread.current[:__couch_potato_databases][database_name] yield Thread.current[:__couch_potato_databases][database_name] end |