Module: CouchDesignDocs

Defined in:
lib/couch_design_docs.rb,
lib/couch_design_docs/store.rb,
lib/couch_design_docs/directory.rb

Defined Under Namespace

Classes: Directory, Store

Constant Summary collapse

VERSION =

:stopdoc:

'1.0.2'
LIBPATH = 
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



31
32
33
 
# File 'lib/couch_design_docs.rb', line 31

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



39
40
41
 
# File 'lib/couch_design_docs.rb', line 39

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



48
49
50
51
52
53
54
 
# File 'lib/couch_design_docs.rb', line 48

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.upload_dir(db_uri, dir) ⇒ Object

For a CouchDB database described by db_uri and a directory, dir containing design documents, creates design documents in the CouchDB database



21
22
23
24
25
 
# File 'lib/couch_design_docs.rb', line 21

def self.upload_dir(db_uri, dir)
  store = Store.new(db_uri)
  dir = Directory.new(dir)
  store.load(dir.to_hash)
end

.version ⇒ Object

Returns the version string for the library.



13
14
15
 
# File 'lib/couch_design_docs.rb', line 13

def self.version
  VERSION
end