wolf 0.1.0

data/.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/wolf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wolf"
+  s.version     = Wolf::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://github.com/cldwalker/wolf"
+  s.summary = "Devour wolfram's computational knowledge in your shell"
+  s.description =  "Devour computational knowledge on the commandline with wolframalpha."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = 'tagaholic'
+  s.executables = ['wolf']
+  s.add_dependency 'hirb', '>= 0.3.6'
+  s.add_dependency 'wolfram', '>= 0.1.1'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.1.0
+* Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Gabriel Horner
+
+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/README.rdoc

@@ -0,0 +1,182 @@
+== Description
+Devour computational knowledge on the commandline with {wolframalpha}[http://wolframalpha.com].
+
+== Install
+
+To install this gem:
+
+    gem install wolf
+
+== Setup
+
+Get a free Wolfram Appid (api key) by {creating an account
+here}[http://developer.wolframalpha.com/portal/apisignup.html] and
+then clicking on the 'Get an APPID' button.
+
+Once you have your own appid, set it in your shell, preferably in your ~/.zshrc or ~/.bashrc:
+
+    export WOLFRAM_APPID='YOURKEY'
+
+Or you can set your appid in your ~/.wolfrc:
+  
+    Wolfram.appid = "YOURKEY"
+
+== Usage
+
+wolf displays results to wolfram queries as tables:
+
+    # Calculate distance and travel time between places
+    $ wolf boston to new york
+    Distance
+    +-------------+
+    | 184.3 miles |
+    +-------------+
+
+    Direct travel times
+    +---------------------+-------------------------+
+    | aircraft  (550 mph) | 20 minutes              |
+    | sound               | 14 minutes  30 seconds  |
+    | light in fiber      | 1.39 ms  (milliseconds) |
+    | light in vacuum     | 0.99 ms  (milliseconds) |
+    +---------------------+-------------------------+
+    ...
+
+    # Solve an equation
+    ru wolf 'x^3 - sinx = e^-x'
+    +--------------------+---------------------------+
+    | Input              | x^3-sin(x) = e^(-x)       |
+    | Numerical solution | x ~~ 1.068531813164789... |
+    +--------------------+---------------------------+
+
+    # Compare stocks
+    $ wolf goog, apple, microsoft
+    Latest trades
+    +------+---------------+--------+----------------+--------------------+
+    | GOOG | $600.30 (GOOG | NASDAQ | 4:02:42 pm EST | 5 hrs 41 mins ago) |
+    | AAPL | $339.30 (AAPL | NASDAQ | 4:21:45 pm EST | 5 hrs 22 mins ago) |
+    | MSFT | $27.73 (MSFT  | NASDAQ | 4:00:00 pm EST | 5 hrs 43 mins ago) |
+    +------+---------------+--------+----------------+--------------------+
+
+    Fundamentals and financials
+    +--------------------------+----------------+----------------+----------------+
+    |                          | Google         | Apple          | Microsoft      |
+    +--------------------------+----------------+----------------+----------------+
+    | market cap               | $192 billion   | $312.6 billion | $233 billion   |
+    | revenue                  | $27.55 billion | $76.28 billion | $66.69 billion |
+    | employees                | 23331          | 49400          | 89000          |
+    ...
+
+    # Display local weather info
+    $ wolf weather
+    Latest recorded weather for boston, massachusetts
+    +-------------------+----------------------------+
+    | temperature       | 34 °F  (wind chill: 25 °F) |
+    | conditions        | cloudy                     |
+    | relative humidity | 47%  (dew point: 16 °F)    |
+    | wind speed        | 12 mph                     |
+    +-------------------+----------------------------+
+    ...
+
+In some cases wolf displays information more concisely than the website itself. Compare {the
+website}[http://www.wolframalpha.com/input/?i=pi] to:
+ 
+    $ wolf pi
+    +-----------------------------+---------------------------------------------------------------------------------------+
+    | Input                       | pi                                                                                    |
+    | Decimal approximation       | 3.1415926535897932384626433832795028841971693993751058209749...                       |
+    | Property                    | pi is a transcendental number                                                         |
+    | Continued fraction          | [3; 7, 15, 1, 292, 1, 1, 1, 2, 1, 3, 1, 14, 2, 1, 1, 2, 2, 2, 2, 1, 84, 2, 1, 1, ...] |
+    | Alternative representations | pi = 180 °                                                                            |
+    | Series representations      | pi = 4 sum_(k=0)^infinity(-1)^k/(2 k+1)                                               |
+    | Integral representations    | pi = 2 integral_0^infinity1/(t^2+1) dt                                                |
+    +-----------------------------+---------------------------------------------------------------------------------------+
+
+If you clicked on the previous link, you'll notice links to more information about the current result.
+wolf makes this available via the menu option (-m):
+
+    $ wolf pi -m
+
+    +-----------------------------+---------------------------------------------------------------------------------------+
+    | Input                       | pi                                                                                    |
+    | Decimal approximation       | 3.1415926535897932384626433832795028841971693993751058209749...                       |
+    | Property                    | pi is a transcendental number                                                         |
+    | Continued fraction          | [3; 7, 15, 1, 292, 1, 1, 1, 2, 1, 3, 1, 14, 2, 1, 1, 2, 2, 2, 2, 1, 84, 2, 1, 1, ...] |
+    | Alternative representations | pi = 180 °                                                                            |
+    | Series representations      | pi = 4 sum_(k=0)^infinity(-1)^k/(2 k+1)                                               |
+    | Integral representations    | pi = 2 integral_0^infinity1/(t^2+1) dt                                                |
+    +-----------------------------+---------------------------------------------------------------------------------------+
+
+    ** LINKS **
+    +--------+-----------------------------+---------------+
+    | number | Section                     | Choice        |
+    +--------+-----------------------------+---------------+
+    | 1      | Decimal approximation       | More digits   |
+    | 2      | Continued fraction          | Fraction form |
+    | 3      | Continued fraction          | More terms    |
+    | 4      | Alternative representations | More          |
+    | 5      | Series representations      | More          |
+    | 6      | Integral representations    | More          |
+    +--------+-----------------------------+---------------+
+    Choose one link to requery: 
+
+    # User types '1'
+    Choose one link to requery: 1
+
+    # To get back
+    +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
+    | Input                       | pi                                                                                                                      |
+    | Decimal approximation       | 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086513282... |
+    | Property                    | pi is a transcendental number                                                                                           |
+    | Continued fraction          | [3; 7, 15, 1, 292, 1, 1, 1, 2, 1, 3, 1, 14, 2, 1, 1, 2, 2, 2, 2, 1, 84, 2, 1, 1, ...]                                   |
+    | Alternative representations | pi = 180 °                                                                                                              |
+    | Series representations      | pi = 4 sum_(k=0)^infinity(-1)^k/(2 k+1)                                                                                 |
+    | Integral representations    | pi = 2 integral_0^infinity1/(t^2+1) dt                                                                                  |
+    +-----------------------------+-------------------------------------------------------------------------------------------------------------------------+
+
+wolf has more options you can explore with:
+
+    $ wolf -h
+
+Some examples of options:
+
+    # Only display tables whose titles match the case insensitive regex
+    $ wolf .me -t=name
+    Name
+    +------------------+------------------------+
+    | full name        | Republic of Montenegro |
+    | full native name | Republika Crna Gora    |
+    | internet code    | .me                    |
+    +------------------+------------------------+
+
+    # Print a query's xml response
+    $ wolf -x 4th monday in march
+    <queryresult success="true" error="false" numpods="9" datatypes="CalendarEvent,City" timedout=""
+    timing="1.985" parsetiming="0.559" parsetimedout="false" recalculate="" version="2.0">
+    ...
+
+    # Load local xml file(s) to read in console
+    $ wolf -l fourth_monday.xml
+    Result
+    +------------------------+
+    | Monday, March 28, 2011 |
+    +------------------------+
+    ...
+
+    # Append additional params to a query with --PARAM=VALUE
+    # Read API docs for available query params
+    $ wolf --format=html 50 euros
+    <queryresult success="true" error="false" numpods="4" datatypes="Quantity" timedout=""
+    timing="2.566" parsetiming="0.115" parsetimedout="false" recalculate="" version="2.0">
+     <pod title="Input interpretation" scanner="Identity" id="Input" position="100" error="false"
+     numsubpods="0">
+       <markup>
+       ...
+
+== Links
+* {Many query examples}[http://www.wolframalpha.com/examples/]
+* {API docs (pdf)}[https://products.wolframalpha.com/docs/WolframAlpha-API-Reference.pdf]
+
+== Todo
+* Tests!
+* Better aliasing of commands
+* option to tab delimit results for easy nix slicing + dicing

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
+end
+
+task :default => :test

data/bin/wolf

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'wolf'
+Wolf.devour

data/deps.rip

@@ -0,0 +1,2 @@
+hirb >=0.3.6
+wolfram >=0.1.1

data/lib/wolf.rb

@@ -0,0 +1,62 @@
+require 'wolfram'
+require 'hirb'
+require 'wolf/stomach'
+require 'wolf/mouth'
+require 'wolf/version'
+
+module Wolf
+  extend self
+
+  ALIASES = {}
+  OPTIONS = {:o => :open, :m => :menu, :x => :xml, :v => :verbose, :h => :help,
+    :a => :all, :l => :load, :t => :title, :V => :version}
+  HELP_OPTIONS = [
+    ['-m, --menu', 'Choose from links in a menu and requery with one'],
+    ['-a, --all', 'Print all tables and rows (uninteresting ones are hidden by default)'],
+    ['-t, --title=TITLE', 'Only display tables whose title match TITLE'],
+    ['-x, --xml', 'Print raw xml response instead of printing tables'],
+    ['-l, --load', "Load one or more xml files to print"],
+    ['-o, --open', 'Open query in the browser (mac only)'],
+    ['-v, --verbose', 'Print additional information'],
+    ['-V, --version', 'Print version'],
+    ['-h, --help', 'Print help']
+  ]
+
+  def devour(argv=ARGV)
+    options, fetch_options = parse_options(argv)
+    return puts(VERSION) if options[:version]
+    return puts(help) if argv.empty? || options[:help]
+    Mouth.eat(argv, options, fetch_options)
+  end
+
+  def help
+    name_max = HELP_OPTIONS.map {|e| e[0].length }.max
+    desc_max = HELP_OPTIONS.map {|e| e[1].length }.max
+    ["Usage: wolf [OPTIONS] [ARGS]", "\nOptions:",
+      HELP_OPTIONS.map {|k,v| "  %-*s  %-*s" % [name_max, k, desc_max, v] },
+      "", "Append parameters to a query with options in the format --PARAM=VALUE i.e.",
+    "    --reinterpret=true --format=html"]
+  end
+
+  def parse_options(argv)
+    options, fetch_options = {}, {}
+    arg = argv.find {|e| e[/^-/] }
+    index = argv.index(arg)
+    while arg =~ /^-/
+      if arg[/^--?(\w+)=(\S+)/]
+        opt = $1.to_sym
+        option?(opt) ? options[OPTIONS[opt] || opt] = $2 :
+          fetch_options[$1.to_sym] = $2
+      elsif (opt = arg[/^--?(\w+)/, 1]) && option?(opt.to_sym)
+        options[OPTIONS[opt.to_sym] || opt.to_sym] = true
+      end
+      argv.delete_at(index)
+      arg = argv[index]
+    end
+    [options, fetch_options]
+  end
+
+  def option?(opt)
+    OPTIONS.key?(opt) || OPTIONS.value?(opt)
+  end
+end

data/lib/wolf/mouth.rb

@@ -0,0 +1,85 @@
+module Wolf
+  module Mouth
+    extend self
+
+    def eat(argv, options, fetch_options)
+      load_rc '~/.wolfrc'
+      options[:load] ? eat_at_home(argv, options) :
+        eat_out(build_query(argv), options, fetch_options)
+    end
+
+    def eat_at_home(files, options)
+      Hirb.enable
+      files.each {|file|
+        Mouth.swallow Wolfram::Result.new(File.read(@file = file)), options
+      }
+    rescue Errno::ENOENT
+      abort "Wolf Error: File '#{@file}' does not exist"
+    end
+
+    def load_rc(file)
+      load file if File.exists?(File.expand_path(file))
+    rescue StandardError, SyntaxError, LoadError => e
+      warn "Wolf Error while loading #{file}:\n"+
+        "#{e.class}: #{e.message}\n    #{e.backtrace.join("\n    ")}"
+    end
+
+    def build_query(args)
+      cmd = args.shift
+      cmd_alias = ALIASES[cmd]  || ALIASES[cmd.to_sym]
+      if cmd_alias.to_s.include?('%s')
+        cmd_alias % args
+      else
+        cmd = cmd_alias || cmd
+        ([cmd] + args).join(' ')
+      end
+    rescue ArgumentError
+      abort "Wolf Error: Wrong number of arguments"
+    end
+
+    def eat_out(query, options, fetch_options)
+      # Can't display other formats except as raw xml
+      options[:xml] = true if fetch_options[:format] && !options.key?(:xml)
+      if options[:open]
+        open Wolfram.query(query,
+          :query_uri => "http://www.wolframalpha.com/input/").uri(:i => query)
+      elsif options[:xml]
+        puts Wolfram.fetch(query, fetch_options).xml
+      else
+        Hirb.enable
+        result = Wolfram.fetch(query, fetch_options)
+        swallow result, options
+        menu(result) if options[:menu]
+      end
+    end
+
+    def menu(result)
+      choices = []
+      result.pods.select {|e| e.states.size > 0 }.each {|e|
+        choices += e.states.map {|s| [e.title, s.name] } }
+      puts "\n** LINKS **"
+      choice = Hirb::Menu.render(choices, :change_fields => ['Section', 'Choice'],
+        :prompt =>"Choose one link to requery: ", :description => false,
+        :directions => false)[0]
+      if choice && (pod = result[choice[0]]) && state = pod.states.find {|e| e.name == choice[1] }
+        swallow state.refetch, options
+      else
+        abort "Wolf Error: Unable to find this link to requery it"
+      end
+    end
+
+    def swallow(result, options={})
+      if result.success
+        puts Stomach.digest(result, options)
+      else
+        warn "No results found"
+      end
+      puts "\nURI: #{result.uri}", "Fetched in #{result.timing}s",
+        "Found #{result.pods.size} pods" if options[:verbose]
+    end
+
+    def open(uri)
+      system('open', uri)
+    end
+  end
+end

data/lib/wolf/stomach.rb

@@ -0,0 +1,57 @@
+module Wolf
+  module Stomach
+    extend self
+
+    def digest(result, options)
+      body = ''
+      pods = options[:all] ? result.pods :
+        result.pods.reject {|e| e.title == 'Input interpretation' || e.plaintext == '' }
+      pods = pods.select {|e| e.title[/#{options[:title]}/i] } if options[:title]
+      # multiple 1-row tables i.e. math results
+      if pods.all? {|e| !e.plaintext.include?('|') }
+        body << render_table(pods.map {|e| [e.title, e.plaintext] })
+      # one one-row table i.e. word results
+      elsif pods.size == 1 && pod_rows(pods[0]).size == 1
+        body << pods[0].title.capitalize << "\n"
+        body << render_table(pod_rows(pods[0])[0])
+      else
+        pods.each do |pod|
+          body << pod.title.capitalize << "\n"
+
+          # Handle multiple tables divided by graphs i.e. when comparing stocks
+          if pod.plaintext.include?("\n\n") && pod.states.empty?
+            strip(pod.plaintext).split(/\n{2,}/).each {|text|
+              body << render_pod_rows(text_rows(text), text, options)
+            }
+          else
+            body << render_pod_rows(pod_rows(pod), strip(pod.plaintext), options)
+          end
+        end
+      end
+      body
+    end
+
+    def render_pod_rows(rows, text, options)
+      # delete comments
+      rows.delete_if {|e| e.size == 1 } if rows.size > 1 && !options[:all]
+      headers = text[/^\s*\|/] ? rows.shift : false
+      render_table(rows, headers) << "\n\n"
+    end
+
+    def render_table(rows, headers=false)
+      Hirb::Helpers::AutoTable.render(rows, :description => false, :headers => headers)
+    end
+
+    def pod_rows(pod)
+      text_rows strip(pod.plaintext)
+    end
+
+    def strip(text)
+      text.sub(/\A(\s+\|){2,}/m, '').sub(/(\s+\|){2,}\s*\Z/, '').strip
+    end
+
+    def text_rows(text)
+      text.split(/\n+/).map {|e| e.split(/\s*\|\s+/) }
+    end
+  end
+end

data/lib/wolf/version.rb

@@ -0,0 +1,3 @@
+module Wolf
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: wolf
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hirb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: wolfram
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id002
+description: Devour computational knowledge on the commandline with wolframalpha.
+email: gabriel.horner@gmail.com
+executables: 
+- wolf
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- lib/wolf/mouth.rb
+- lib/wolf/stomach.rb
+- lib/wolf/version.rb
+- lib/wolf.rb
+- bin/wolf
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.rdoc
+- deps.rip
+- Rakefile
+- .gemspec
+has_rdoc: true
+homepage: http://github.com/cldwalker/wolf
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: tagaholic
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Devour wolfram's computational knowledge in your shell
+test_files: []
+