couch-shell 0.0.5 → 0.0.6

data/lib/couch-shell-plugin/core.rb

@@ -0,0 +1,241 @@
+# -*- encoding: utf-8 -*-
+
+require "couch-shell/plugin"
+
+module CouchShell
+
+  class CorePlugin < Plugin
+
+    var "A fresh uuid from the CouchDB server."
+    def lookup_uuid
+      shell.execute "uuids"
+      if shell.responses.current(&:ok?)
+        json = shell.responses.current.json_value
+        if json && (uuids = json["uuids"]) && uuids.array? && uuids.length > 0
+          uuids[0]
+        else
+          raise ShellError, "unkown json structure"
+        end
+      else
+        raise ShellError, "uuids request failed"
+      end
+    end
+
+    var "Value of the id or _id member of the last response."
+    def lookup_id
+      shell.responses.current { |r| r.attr "id", "_id" } or raise VarNotSet
+    end
+
+    var "Value of the rev or _rev member of the last response."
+    def lookup_rev
+      @responses.current { |r| r.attr "rev", "_rev" } or raise VarNotSet
+    end
+
+    var "Shortcut for $(id)?rev=$(rev)."
+    def lookup_idr
+      shell.interpolate "$(id)?rev=$(rev)"
+    end
+
+    var "Content-Type of the last response."
+    def lookup_content_type
+      shell.responses.current(&:content_type)
+    end
+
+    var "Current server url."
+    def lookup_server
+      raise VarNotSet unless shell.server_url
+      u = shell.server_url
+      "#{u.scheme}://#{u.host}:#{u.port}#{u.path}"
+    end
+
+    var "Get response with index X."
+    def lookup_prefix_r(name)
+      i = name.to_i
+      raise VarNotSet unless shell.responses.readable_index?(i)
+      shell.responses[i]
+    end
+
+    var "Get json of response with index X."
+    def lookup_prefix_j(name)
+      i = name.to_i
+      if shell.responses.readable_index?(i)
+        if shell.responses[i].json_value
+          shell.responses[i].json_value
+        else
+          raise ShellError, "no json in response #{i}"
+        end
+      else
+        raise ShellError, "no response index #{i}"
+      end
+    end
+
+    def request_command_with_body(method, argstr)
+      if argstr =~ CouchShell::JSON_DOC_START_RX
+        url, bodyarg = nil, argstr
+      else
+        url, bodyarg= argstr.split(/\s+/, 2)
+      end
+      if bodyarg && bodyarg.start_with?("@")
+        filename, content_type = bodyarg[1..-1].split(/\s+/, 2)
+        body = CouchShell::FileToUpload.new(filename, content_type)
+      else
+        body = bodyarg
+      end
+      real_url = shell.interpolate(url)
+      shell.request method, real_url, body
+      real_url
+    end
+
+    cmd "Perform a GET http request.", synopsis: "[URL]"
+    def execute_get(argstr)
+      shell.request "GET", shell.interpolate(argstr)
+    end
+
+    cmd "Perform a PUT http request.",
+      synopsis: "[URL] [JSON|@FILENAME]"
+    def execute_put(argstr)
+      request_command_with_body("PUT", argstr)
+    end
+
+    cmd "put, followed by cd if put was successful"
+    def execute_cput(argstr)
+      url = request_command_with_body("PUT", argstr)
+      cd url if shell.responses.current(&:ok?)
+    end
+
+    cmd "Perform a POST http request.",
+      synopsis: "[URL] [JSON|@FILENAME]"
+    def execute_post(argstr)
+      request_command_with_body("POST", argstr)
+    end
+
+    cmd "Perform a DELETE http request.", synopsis: "[URL]"
+    def execute_delete(argstr)
+      shell.request "DELETE", shell.interpolate(argstr)
+    end
+
+    cmd "Change current path which will be used to interpret relative urls.",
+      synopsis: "[PATH]"
+    def execute_cd(argstr)
+      shell.cd shell.interpolate(argstr), false
+    end
+
+    cmd "cd followed by get",
+      synopsis: "[PATH]"
+    def execute_cg(argstr)
+      shell.cd shell.interpolate(argstr), true
+    end
+
+    cmd "quit shell"
+    def execute_exit(argstr)
+      raise Quit
+    end
+
+    cmd "quit shell"
+    def execute_quit(argstr)
+      raise Quit
+    end
+
+    cmd "Request uuid(s) from CouchDB server.",
+      synopsis: "[COUNT]"
+    def execute_uuids(argstr)
+      count = argstr ? argstr.to_i : 1
+      shell.request "GET", "/_uuids?count=#{count}"
+    end
+
+    cmd "Echos ARG after interpolating $(...) expressions.",
+      synopsis: "[ARG]"
+    def execute_echo(argstr)
+      if argstr
+        shell.stdout.puts shell.interpolate(argstr)
+      end
+    end
+
+    cmd "Evaluate EXPR and print the result in a compact form.",
+      synopsis: "EXPR"
+    def execute_print(argstr)
+      raise ShellError, "expression required" unless argstr
+      shell.stdout.puts shell.eval_expr(argstr)
+    end
+
+    cmd "Evaluate EXPR and print the result in a pretty form.",
+      synopsis: "EXPR"
+    def execute_format(argstr)
+      raise ShellError, "expression required" unless argstr
+      val = shell.eval_expr(argstr)
+      if val.respond_to?(:couch_shell_format_string!)
+        shell.stdout.puts val.couch_shell_format_string!
+      else
+        shell.stdout.puts val
+      end
+    end
+
+    cmd "Set URL of CouchDB server.",
+      synopsis: "[URL]"
+    def execute_server(argstr)
+      shell.server = argstr
+    end
+
+    cmd "Show full url for PATH after interpolation.",
+      synopsis: "[PATH]"
+    def execute_expand(argstr)
+      shell.stdout.puts shell.expand(shell.interpolate(argstr))
+    end
+
+    cmd "Execute COMMAND in your operating system's shell.",
+      synopsis: "COMMAND"
+    def execute_sh(argstr)
+      raise ShellError, "argument required" unless argstr
+      unless system(argstr)
+        shell.errmsg "command exited with status #{$?.exitstatus}"
+      end
+    end
+
+    cmd "Set member KEY of document at current path to VALUE.",
+      synopsis: "KEY VALUE"
+    def execute_member(argstr)
+      id, rev = nil, nil
+      json = shell.responses.current(&:json_value)
+      unless json && (id = json.attr_or_nil!("_id")) &&
+          (rev = json.attr_or_nil!("_rev")) &&
+          (shell.pathstack.size > 0) &&
+          (shell.pathstack.last == id.to_s)
+        raise ShellError,
+          "`cg' the desired document first, e.g.: `cg /my_db/my_doc_id'"
+      end
+      # TODO: read json string as attribute name if argstr starts with double
+      # quote
+      attr_name, new_valstr = argstr.split(/\s+/, 2)
+      unless attr_name && new_valstr
+        raise ShellError,
+          "attribute name and new value argument required"
+      end
+      if new_valstr == "remove"
+        json.delete_attr!(attr_name)
+      else
+        new_val = JsonValue.parse(new_valstr)
+        json.set_attr!(attr_name, new_val)
+      end
+      shell.request "PUT", "?rev=#{rev}", json.to_s
+    end
+
+    cmd "Set the USERNAME and password for authentication in requests.",
+      synopsis: "USERNAME",
+      doc_text: "Prompts for password."
+    def execute_user(argstr)
+      shell.prompt_msg("Password:", false)
+      shell.password = shell.read_secret
+      # we save the username only after the password was entered
+      # to allow cancellation during password input
+      shell.username = argstr
+    end
+
+    cmd "Use PLUGIN.",
+      synopsis: "PLUGIN"
+    def execute_plugin(argstr)
+      shell.plugin argstr
+    end
+
+  end
+
+end

data/lib/couch-shell-plugin/core_designs.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require "couch-shell/plugin"
+
+module CouchShell
+
+  class CoreDesignsPlugin < Plugin
+
+    def all_designs_url
+      '/' + dbname! + '/_all_docs?startkey="_design/"&endkey="_design0"'
+    end
+
+    cmd "Get a list of design names in current database."
+    def execute_designs(argstr)
+      raise ShellError, "argument not allowed" if argstr
+      res = request!("GET", all_designs_url, nil, false)
+      res.json["rows"].each { |row|
+        shell.stdout.puts row["key"].sub(%r{\A_design/}, '')
+      }
+    end
+
+  end
+
+end

data/lib/couch-shell-plugin/core_edit.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+require "couch-shell/plugin"
+
+module CouchShell
+
+  class CoreEditPlugin < Plugin
+
+    def plugin_initialization
+      @edittext = nil
+    end
+
+    var "Text saved by the last invocation of edit."
+    def lookup_edittext
+      @edittext or raise VarNotSet
+    end
+
+    cmd "Edit a document in your editor.",
+      synopsis: "[URL]"
+    def execute_edit(argstr)
+      url = shell.interpolate(argstr)
+      res = request! "GET", url, nil, false
+      doc = res.json_value.to_s(true)
+      new_doc = edittext!(doc)
+      if new_doc == doc
+        shell.msg "Document hasn't changed. Nothing to submit."
+        return
+      end
+      continue? "Press ENTER to PUT updated document on server " +
+                "or CTRL+C to cancel "
+      unless shell.request("PUT", url, new_doc).ok?
+        shell.msg "recover document text with `print edittext'"
+      end
+    end
+
+  end
+
+end

data/lib/couch-shell-plugin/core_lucene.rb

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+require "couch-shell/plugin"
+
+module CouchShell
+
+  class CoreLucenePlugin < Plugin
+
+    def plugin_initialization
+      @ftitext = nil
+    end
+
+    var "Text saved by the last invocation of editfti."
+    def lookup_ftitext
+      @ftitext or raise VarNotSet
+    end
+
+    cmd "Edit fulltext index function in your editor.",
+      synopsis: "DESIGN FULLTEXTINDEX"
+    def execute_editfti(argstr)
+      dbname = dbname!
+      design_name, index_name = argstr.split(/\s+/, 2) if argstr
+      if design_name.nil? || index_name.nil?
+        raise ShellError, "design and fulltext index name required"
+      end
+      res = request! "GET", "/#{dbname}/_design/#{design_name}", nil, false
+      design = res.json_value
+      index = design.fulltext[index_name] if design["fulltext"]
+      indexfun = index && index["index"]
+      new_indexfun = edittext!(indexfun ||
+        "function(doc) {\n  var ret = Document.new();\n\n  return ret;\n}\n")
+      @ftitext = new_indexfun
+      if new_indexfun == indexfun
+        shell.msg "Index function hasn't changed. Nothing to submit."
+        return
+      end
+      continue? "Press ENTER to submit #{indexfun ? 'updated' : 'new'} " +
+                "index function, CTRL+C to cancel "
+      if design["fulltext"].nil?
+        design.set_attr!("fulltext", {})
+      end
+      if index.nil?
+        design.fulltext.set_attr!(index_name, {})
+        index = design.fulltext[index_name]
+      end
+      index.set_attr!("index", new_indexfun)
+      unless shell.request("PUT", "/#{dbname}/_design/#{design_name}", design.to_s).ok?
+        shell.msg "recover index text with `print ftitext'"
+      end
+    end
+
+  end
+
+end

data/lib/couch-shell-plugin/core_views.rb

@@ -0,0 +1,165 @@
+# -*- encoding: utf-8 -*-
+
+require "couch-shell/plugin"
+
+module CouchShell
+
+  class CoreViewsPlugin < Plugin
+
+    def plugin_initialization
+      @viewtext = nil
+    end
+
+    var "Text saved by the last invocation of editview."
+    def lookup_viewtext
+      @viewtext or raise VarNotSet
+    end
+
+    cmd "Edit map, and optionally reduce function in your editor.",
+      synopsis: "DESIGN VIEW"
+    def execute_editview(argstr)
+      ensure_at_database
+      design_name, view_name = argstr.split(/\s+/, 2)
+      if design_name.nil? || view_name.nil?
+        raise ShellError, "design and view name required"
+      end
+      shell.request "GET", "_design/#{design_name}", nil, false
+      return unless shell.responses.current(&:ok?)
+      design = shell.responses.current.json_value
+      view = design.views[view_name] if design["views"]
+      mapval = view && view["map"]
+      reduceval = view && view["reduce"]
+      t = Tempfile.new(["view", ".js"])
+      t.puts("map")
+      if mapval
+        t.puts mapval
+      else
+        t.puts "function(doc) {\n  emit(doc._id, doc);\n}"
+      end
+      if reduceval || view.nil?
+        t.puts
+        t.puts("reduce")
+        if reduceval
+          t.puts reduceval
+        else
+          t.puts "function(keys, values, rereduce) {\n\n}"
+        end
+      end
+      t.close
+      continue?("Press ENTER to edit #{view ? 'existing' : 'new'} view, " +
+                "CTRL+C to cancel ")
+      unless system(shell.editor_bin!, t.path)
+        raise ShellError, "editing command failed with exit status #{$?.exitstatus}"
+      end
+      text = t.open.read
+      @viewtext = text
+      t.close
+      mapf = nil
+      reducef = nil
+      inmap = false
+      inreduce = false
+      i = 0
+      text.each_line { |line|
+        i += 1
+        case line
+        when /^map\s*(.*)$/
+          unless $1.empty?
+            shell.msg "recover view text with `print viewtext'"
+            raise ShellError, "invalid map line at line #{i}"
+          end
+          unless mapf.nil?
+            shell.msg "recover view text with `print viewtext'"
+            raise ShellError, "duplicate map line at line #{i}"
+          end
+          inreduce = false
+          inmap = true
+          mapf = ""
+        when /^reduce\s*(.*)$/
+          unless $1.empty?
+            shell.msg "recover view text with `print viewtext'"
+            raise ShellError, "invalid reduce line at line #{i}"
+          end
+          unless reducef.nil?
+            shell.msg "recover view text with `print viewtext'"
+            raise ShellError, "duplicate reduce line at line #{i}"
+          end
+          inmap = false
+          inreduce = true
+          reducef = ""
+        else
+          if inmap
+            mapf << line
+          elsif inreduce
+            reducef << line
+          elsif line =~ /^\s*$/
+            # ignore
+          else
+            shell.msg "recover view text with `print viewtext'"
+            raise ShellError, "unexpected content at line #{i}"
+          end
+        end
+      }
+      mapf.strip! if mapf
+      reducef.strip! if reducef
+      mapf = nil if mapf && mapf.empty?
+      reducef = nil if reducef && reducef.empty?
+      shell.prompt_msg "View parsed, following actions would be taken:"
+      if mapf && mapval.nil?
+        shell.prompt_msg " Add map function."
+      elsif mapf.nil? && mapval
+        shell.prompt_msg " Remove map function."
+      elsif mapf && mapval && mapf != mapval
+        shell.prompt_msg " Update map function."
+      end
+      if reducef && reduceval.nil?
+        shell.prompt_msg " Add reduce function."
+      elsif reducef.nil? && reduceval
+        shell.prompt_msg " Remove reduce function."
+      elsif reducef && reduceval && reducef != reduceval
+        shell.prompt_msg " Update reduce function."
+      end
+      continue? "Press ENTER to submit, CTRL+C to cancel "
+      if !design.respond_to?(:views)
+        design.set_attr!("views", {})
+      end
+      if view.nil?
+        design.views.set_attr!(view_name, {})
+        view = design.views[view_name]
+      end
+      if mapf.nil?
+        view.delete_attr!("map")
+      else
+        view.set_attr!("map", mapf)
+      end
+      if reducef.nil?
+        view.delete_attr!("reduce")
+      else
+        view.set_attr!("reduce", reducef)
+      end
+      shell.request "PUT", "_design/#{design_name}", design.to_s
+      unless shell.responses.current(&:ok?)
+        shell.msg "recover view text with `print viewtext'"
+      end
+    ensure
+      if t
+        t.close
+        t.unlink
+      end
+    end
+
+    cmd "Shortcut to GET a view.",
+      synopsis: "DESIGN/VIEW[?params]"
+    def execute_view(argstr)
+      if shell.pathstack.size != 1
+        raise ShellError, "current directory must be database"
+      end
+      design_name, view_name = argstr.split("/", 2)
+      if design_name.nil? || view_name.nil?
+        raise ShellError, "argument in the form DESIGN/VIEW required"
+      end
+      shell.request "GET", "_design/#{design_name}/_view/#{view_name}"
+    end
+
+  end
+
+end