mortar 0.1.0

data/lib/mortar/command/describe.rb

@@ -0,0 +1,97 @@
+#
+# Copyright 2012 Mortar Data Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "mortar/command/base"
+require "mortar/snapshot"
+
+# manage pig scripts
+#
+class Mortar::Command::Describe < Mortar::Command::Base
+  
+  include Mortar::Snapshot
+    
+  # describe [PIGSCRIPT] [ALIAS]
+  #
+  # Describe the schema of an alias and all of its ancestors.
+  #
+  # -p, --parameter NAME=VALUE  # Set a pig parameter value in your script.
+  # -f, --param-file PARAMFILE  # Load pig parameter values from a file.
+  #
+  # Examples:
+  #
+  # $ mortar describe
+  # 
+  # TBD
+  #
+  def index
+    pigscript_name = shift_argument
+    alias_name = shift_argument
+    unless pigscript_name && alias_name
+      error("Usage: mortar describe PIGSCRIPT ALIAS\nMust specify PIGSCRIPT and ALIAS.")
+    end
+    validate_arguments!
+    validate_git_based_project!
+    pigscript = validate_pigscript!(pigscript_name)
+    git_ref = create_and_push_snapshot_branch(git, project)
+    
+    describe_id = nil
+    action("Starting describe") do
+      describe_id = api.post_describe(project.name, pigscript.name, alias_name, git_ref, :parameters => pig_parameters).body["describe_id"]
+    end
+        
+    describe_result = nil
+    display
+    ticking(polling_interval) do |ticks|
+      describe_result = api.get_describe(describe_id, :exclude_result => true).body
+      is_finished =
+        Mortar::API::Describe::STATUSES_COMPLETE.include?(describe_result["status_code"])
+        
+      redisplay("Status: %s %s" % [
+        describe_result['status_description'] + (is_finished ? "" : "..."),
+        is_finished ? " " : spinner(ticks)],
+        is_finished) # only display newline on last message
+      if is_finished
+        display
+        break
+      end
+    end
+    
+    case describe_result['status_code']
+    when Mortar::API::Describe::STATUS_FAILURE
+      error_message = "Describe failed with #{describe_result['error_type'] || 'error'}"
+      if line_number = describe_result["line_number"]
+        error_message += " at Line #{line_number}"
+        if column_number = describe_result["column_number"]
+          error_message += ", Column #{column_number}"
+        end
+      end
+      error_context = get_error_message_context(describe_result['error_message'])
+      error_message += ":\n\n#{describe_result['error_message']}\n\n#{error_context}"
+      error(error_message)
+    when Mortar::API::Describe::STATUS_KILLED
+      error("Describe killed by user.")
+    when Mortar::API::Describe::STATUS_SUCCESS
+      web_result_url = describe_result['web_result_url']
+      display("Results available at #{web_result_url}")
+      action("Opening web browser to show results") do
+        require "launchy"
+        Launchy.open(web_result_url).join
+      end
+    else
+      raise RuntimeError, "Unknown describe status: #{describe_result['status']} for describe_id: #{describe_id}"
+    end
+  end
+end

data/lib/mortar/command/generate.rb

@@ -0,0 +1,121 @@
+#
+# Copyright 2012 Mortar Data Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "mortar/generators/project_generator"
+require "mortar/generators/udf_generator"
+require "mortar/generators/pigscript_generator"
+require "mortar/generators/macro_generator"
+require "mortar/command/base"
+
+# generate new projects and scaffolding
+#
+class Mortar::Command::Generate < Mortar::Command::Base
+
+  # generate:project
+  #
+  # generate new project
+  # 
+  #
+  # Examples:
+  #
+  # $ mortar generate:project
+  # 
+  # TBD
+  # 
+  def _project
+    project_name = shift_argument
+    unless project_name
+      error("Usage: mortar new PROJECTNAME\nMust specify PROJECTNAME.")
+    end
+    pigscript_name = project_name
+    app_generator = Mortar::Generators::ProjectGenerator.new
+    app_generator.generate_project(project_name, options)
+  end
+  alias_command "new", "generate:_project"
+  alias_command "generate:project", "generate:_project"
+
+
+
+  # generate:python_udf
+  #
+  # generate new python user defined function
+  # 
+  #
+  # Examples:
+  #
+  # $ mortar generate:python_udf UDFNAME
+  # 
+  # TBD
+  # 
+  def python_udf
+    udf_name = shift_argument
+    unless udf_name
+      error("Usage: mortar generate:python_udf UDFNAME\nMust specify UDFNAME.")
+    end
+    udf_generator = Mortar::Generators::UDFGenerator.new
+    udf_generator.generate_python_udf(udf_name, project, options)
+
+  end
+
+  # generate:pigscript
+  #
+  # generate new pig script
+  #
+  # --skip-udf # Create the pig script without a partnered python udf 
+  #
+  # Examples:
+  #
+  # $ mortar generate:pigscript SCRIPTNAME
+  # 
+  # TBD
+  # 
+  def pigscript
+    script_name = shift_argument
+    unless script_name
+      error("Usage: mortar generate:pigscript SCRIPTNAME\nMust specify SCRIPTNAME.")
+    end
+    options[:skip_udf] ||= false
+    
+    script_generator = Mortar::Generators::PigscriptGenerator.new
+    script_generator.generate_pigscript(script_name, project, options)
+
+  end
+
+  # generate:macro
+  #
+  # generate new macro
+  #
+  #
+  # Examples:
+  #
+  # $ mortar generate:macro MACRONAME
+  # 
+  # TBD
+  # 
+  def macro
+    macro_name = shift_argument
+    unless macro_name
+      error("Usage: mortar generate:macro MACRONAME\nMust specify MACRONAME.")
+    end
+    
+    macro_generator = Mortar::Generators::MacroGenerator.new
+    macro_generator.generate_macro(macro_name, project, options)
+
+  end
+
+
+  
+end

data/lib/mortar/command/help.rb

@@ -0,0 +1,166 @@
+#
+# Copyright 2012 Mortar Data Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Portions of this code from heroku (https://github.com/heroku/heroku/) Copyright Heroku 2008 - 2012,
+# used under an MIT license (https://github.com/heroku/heroku/blob/master/LICENSE).
+#
+
+require "mortar/command/base"
+
+# list commands and display help
+#
+class Mortar::Command::Help < Mortar::Command::Base
+
+  PRIMARY_NAMESPACES = []
+
+  # help [COMMAND]
+  #
+  # list available commands or display help for a specific command
+  #
+  #Examples:
+  #
+  # $ mortar help
+  # Usage: mortar COMMAND [command-specific-options]
+  #
+  # Primary help topics, type "mortar help TOPIC" for more details:
+  #
+  #   ...
+  #
+  # Additional topics:
+  #
+  #   ...
+  #
+  def index
+    if command = args.shift
+      help_for_command(command)
+    else
+      help_for_root
+    end
+  end
+
+  alias_command "-h", "help"
+  alias_command "--help", "help"
+
+  def self.usage_for_command(command)
+    command = new.send(:commands)[command]
+    "Usage: mortar #{command[:banner]}" if command
+  end
+
+private
+
+  def commands_for_namespace(name)
+    Mortar::Command.commands.values.select do |command|
+      command[:namespace] == name && command[:command] != name
+    end
+  end
+
+  def namespaces
+    namespaces = Mortar::Command.namespaces
+    namespaces.delete("app")
+    namespaces
+  end
+
+  def commands
+    Mortar::Command.commands
+  end
+
+  def legacy_help_for_namespace(namespace)
+    instance = Mortar::Command::Help.groups.map do |group|
+      [ group.title, group.select { |c| c.first =~ /^#{namespace}/ }.length ]
+    end.sort_by { |l| l.last }.last
+    return nil unless instance
+    return nil if instance.last.zero?
+    instance.first
+  end
+
+  def legacy_help_for_command(command)
+    Mortar::Command::Help.groups.each do |group|
+      group.each do |cmd, description|
+        return description if cmd.split(" ").first == command
+      end
+    end
+    nil
+  end
+
+  def primary_namespaces
+    PRIMARY_NAMESPACES.map { |name| namespaces[name] }.compact
+  end
+
+  def additional_namespaces
+    (namespaces.values - primary_namespaces)
+  end
+
+  def summary_for_namespaces(namespaces)
+    size = longest(namespaces.map { |n| n[:name] })
+    namespaces.sort_by {|namespace| namespace[:name]}.each do |namespace|
+      name = namespace[:name]
+      namespace[:description] ||= legacy_help_for_namespace(name)
+      puts "  %-#{size}s  # %s" % [ name, namespace[:description] ]
+    end
+  end
+
+  def help_for_root
+    puts "Usage: mortar COMMAND [command-specific-options]"
+    puts
+    puts "Primary help topics, type \"mortar help TOPIC\" for more details:"
+    puts
+    summary_for_namespaces(primary_namespaces)
+    puts
+    puts "Additional topics:"
+    puts
+    summary_for_namespaces(additional_namespaces)
+    puts
+  end
+
+  def help_for_namespace(name)
+    namespace_commands = commands_for_namespace(name)
+
+    unless namespace_commands.empty?
+      size = longest(namespace_commands.map { |c| c[:banner] })
+      namespace_commands.sort_by { |c| c[:banner].to_s }.each do |command|
+        next if command[:help] =~ /DEPRECATED/
+        command[:summary] ||= legacy_help_for_command(command[:command])
+        puts "  %-#{size}s  # %s" % [ command[:banner], command[:summary] ]
+      end
+    end
+  end
+
+  def help_for_command(name)
+    if command_alias = Mortar::Command.command_aliases[name]
+      display("Alias: #{name} redirects to #{command_alias}")
+      name = command_alias
+    end
+    if command = commands[name]
+      puts "Usage: mortar #{command[:banner]}"
+
+      if command[:help].strip.length > 0
+        puts command[:help].split("\n")[1..-1].join("\n")
+      else
+        puts
+        puts " " + legacy_help_for_command(name).to_s
+      end
+      puts
+    end
+
+    if commands_for_namespace(name).size > 0
+      puts "Additional commands, type \"mortar help COMMAND\" for more details:"
+      puts
+      help_for_namespace(name)
+      puts
+    elsif command.nil?
+      error "#{name} is not a mortar command. See `mortar help`."
+    end
+  end
+end

data/lib/mortar/command/illustrate.rb

@@ -0,0 +1,97 @@
+#
+# Copyright 2012 Mortar Data Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "mortar/command/base"
+require "mortar/snapshot"
+
+# manage pig scripts
+#
+class Mortar::Command::Illustrate < Mortar::Command::Base
+  
+  include Mortar::Snapshot
+    
+  # illustrate [PIGSCRIPT] [ALIAS]
+  #
+  # Illustrate the effects and output of a pigscript.
+  #
+  # -p, --parameter NAME=VALUE  # Set a pig parameter value in your script.
+  # -f, --param-file PARAMFILE  # Load pig parameter values from a file.
+  #
+  # Examples:
+  #
+  # $ mortar illustrate
+  # 
+  # TBD
+  #
+  def index
+    pigscript_name = shift_argument
+    alias_name = shift_argument
+    unless pigscript_name && alias_name
+      error("Usage: mortar illustrate PIGSCRIPT ALIAS\nMust specify PIGSCRIPT and ALIAS.")
+    end
+    validate_arguments!
+    validate_git_based_project!
+    pigscript = validate_pigscript!(pigscript_name)
+    git_ref = create_and_push_snapshot_branch(git, project)
+    
+    illustrate_id = nil
+    action("Starting illustrate") do
+      illustrate_id = api.post_illustrate(project.name, pigscript.name, alias_name, git_ref, :parameters => pig_parameters).body["illustrate_id"]
+    end
+        
+    illustrate_result = nil
+    display
+    ticking(polling_interval) do |ticks|
+      illustrate_result = api.get_illustrate(illustrate_id, :exclude_result => true).body
+      is_finished =
+        Mortar::API::Illustrate::STATUSES_COMPLETE.include?(illustrate_result["status_code"])
+        
+      redisplay("Status: %s %s" % [
+        illustrate_result['status_description'] + (is_finished ? "" : "..."),
+        is_finished ? " " : spinner(ticks)],
+        is_finished) # only display newline on last message
+      if is_finished
+        display
+        break
+      end
+    end
+    
+    case illustrate_result['status_code']
+    when Mortar::API::Illustrate::STATUS_FAILURE
+      error_message = "Illustrate failed with #{illustrate_result['error_type'] || 'error'}"
+      if line_number = illustrate_result["line_number"]
+        error_message += " at Line #{line_number}"
+        if column_number = illustrate_result["column_number"]
+          error_message += ", Column #{column_number}"
+        end
+      end
+      error_context = get_error_message_context(illustrate_result['error_message'])
+      error_message += ":\n\n#{illustrate_result['error_message']}\n\n#{error_context}"
+      error(error_message)
+    when Mortar::API::Illustrate::STATUS_KILLED
+      error("Illustrate killed by user.")
+    when Mortar::API::Illustrate::STATUS_SUCCESS
+      web_result_url = illustrate_result['web_result_url']
+      display("Results available at #{web_result_url}")
+      action("Opening web browser to show results") do
+        require "launchy"
+        Launchy.open(web_result_url).join
+      end
+    else
+      raise RuntimeError, "Unknown illustrate status: #{illustrate_result['status_code']} for illustrate_id: #{illustrate_id}"
+    end
+  end
+end