eee-c-couch_design_docs 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-07-08
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,50 @@
+couch_design_docs
+    by Chris Strom
+    http://github.com/eee-c/couch_design_docs
+
+== DESCRIPTION:
+
+Manage CouchDB views.
+
+== FEATURES/PROBLEMS:
+
+* Not acutally working just yet :)
+
+== SYNOPSIS:
+
+  CouchDesignDocs.load(COUCHDB_VIEW_DIRECTORY)
+
+== REQUIREMENTS:
+
+* CouchDB
+* JSON
+* RestClient
+
+== INSTALL:
+
+* sudo gem install couch_view
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'couch_design_docs'
+
+task :default => 'spec:run'
+
+PROJ.name = 'couch_design_docs'
+PROJ.authors = 'Chris Strom'
+PROJ.email = 'chris@eeecooks.com'
+PROJ.url = 'http://github.com/eee-c/couch_design_docs'
+PROJ.version = CouchDesignDocs::VERSION
+PROJ.rubyforge.name = 'couch_design_docs'
+
+PROJ.spec.opts << '--color'
+
+PROJ.gem.dependencies = %w{json jchris-couchrest}
+
+# EOF

data/bin/couch_design_docs

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib couch_design_docs]))
+
+# Put your code here
+
+# EOF

data/fixtures/a/b/c.js

@@ -0,0 +1 @@
+function(doc) { return true; }

data/fixtures/a/b/d.js

@@ -0,0 +1 @@
+function(doc) { return true; }

data/lib/couch_design_docs.rb

@@ -0,0 +1,49 @@
+
+module CouchDesignDocs
+
+  # :stopdoc:
+  VERSION = '1.0.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # 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.
+  #
+  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
+
+end  # module CouchDesignDocs
+
+CouchDesignDocs.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/couch_design_docs/directory.rb

@@ -0,0 +1,48 @@
+require 'pp'
+
+class Hash
+  def deep_merge(other)
+    self.merge(other) do |key, oldval, newval|
+      oldval.deep_merge(newval)
+    end
+  end
+end
+
+module CouchDesignDocs
+  class Directory
+
+    attr_accessor :couch_view_dir
+
+    def self.a_to_hash(a)
+      key = a.first
+      if (a.length > 2)
+        { key => a_to_hash(a[1,a.length]) }
+      else
+        { key => a.last }
+      end
+    end
+
+    def initialize(path)
+      Dir.new(path) # Just checkin'
+      @couch_view_dir = path
+    end
+
+    def to_hash
+      Dir["#{couch_view_dir}/**/*.js"].inject({}) do |memo, filename|
+        Directory.
+          a_to_hash(expand_file(filename)).
+          deep_merge(memo)
+      end
+    end
+
+    def expand_file(filename)
+      File.dirname(filename).
+        gsub(/#{couch_view_dir}\/?/, '').
+        split(/\//) +
+      [
+       File.basename(filename, '.js'),
+       File.new(filename).read
+      ]
+    end
+  end
+end

data/lib/couch_design_docs/store.rb

@@ -0,0 +1,20 @@
+require 'rest_client'
+require 'json'
+
+module CouchDesignDocs
+  class Store
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def load(h)
+      h.each_pair do |document_name, doc|
+        RestClient.put "#{url}/_design/#{document_name}",
+          doc.to_json,
+          :content_type => 'application/json'
+      end
+    end
+  end
+end

data/spec/couch_design_docs_spec.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Store do
+  it "should require a CouchDB URL Root for instantiation" do
+    lambda { Store.new }.
+      should raise_error
+
+    lambda { Store.new("uri") }.
+      should_not raise_error
+  end
+
+  context "a valid store" do
+    before(:each) do
+      @it = Store.new("uri")
+
+      @hash = {
+        'a' => {
+          'b' => {
+            'c' => 'function(doc) { return true; }'
+          }
+        }
+      }
+    end
+
+    it "should be able to load a hash into design docs" do
+      RestClient.
+        should_receive(:put).
+        with("uri/_design/a",
+             '{"b":{"c":"function(doc) { return true; }"}}',
+             :content_type => 'application/json')
+      @it.load(@hash)
+    end
+  end
+end
+
+describe Directory do
+  it "should require a root directory for instantiation" do
+    lambda { Directory.new }.
+      should raise_error
+
+    lambda { Directory.new("foo") }.
+      should raise_error
+
+    lambda { Directory.new("fixtures")}.
+      should_not raise_error
+  end
+
+  it "should convert arrays into deep hashes" do
+    Directory.
+      a_to_hash(%w{a b c d}).
+      should == {
+      'a' => {
+        'b' => {
+          'c' => 'd'
+        }
+      }
+    }
+  end
+
+  context "a valid directory" do
+    before(:each) do
+      @it = Directory.new("fixtures")
+    end
+
+    it "should list dirs, basename and contents of a file" do
+      @it.expand_file("fixtures/a/b/c.js").
+        should == ['a', 'b', 'c', 'function(doc) { return true; }']
+    end
+
+    it "should assemble all documents into a single docs structure" do
+      @it.to_hash.
+        should == {
+        'a' => {
+          'b' => {
+            'c' => 'function(doc) { return true; }',
+            'd' => 'function(doc) { return true; }'
+          }
+        }
+
+      }
+    end
+  end
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib couch_design_docs]))
+
+include CouchDesignDocs
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: eee-c-couch_design_docs
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Chris Strom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-11 00:00:00 -07:00
+default_executable: couch_design_docs
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jchris-couchrest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.1
+    version: 
+description: Manage CouchDB views.
+email: chris@eeecooks.com
+executables: 
+- couch_design_docs
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+- bin/couch_design_docs
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- bin/couch_design_docs
+- fixtures/a/b/c.js
+- fixtures/a/b/d.js
+- lib/couch_design_docs.rb
+- lib/couch_design_docs/directory.rb
+- lib/couch_design_docs/store.rb
+- spec/couch_design_docs_spec.rb
+- spec/spec_helper.rb
+- test/test_couch_design_docs.rb
+has_rdoc: true
+homepage: http://github.com/eee-c/couch_design_docs
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: couch_design_docs
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Manage CouchDB views
+test_files: 
+- test/test_couch_design_docs.rb