annoy 0.5.0

data/CHANGES.txt

@@ -0,0 +1,7 @@
+ANNOY, CHANGES
+
+
+#### 0.5 (2009-05-07) ###############################
+
+* First public release. See commit history for solutious-rudy. 
+

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Delano Mandelbaum, Solutious Inc
+
+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,23 @@
+= Annoy - v0.5
+
+All your system-independent infoz in one handy class. 
+
+== Installation
+
+Via Rubygems, one of:
+
+    $ sudo gem install annoy
+    $ sudo gem install delano-annoy --source http://gems.github.com/
+
+or via download:
+* annoy-latest.tar.gz[http://github.com/delano/annoy/tarball/latest]
+* annoy-latest.zip[http://github.com/delano/annoy/zipball/latest]
+ 
+
+== Credits
+
+* Delano Mandelbaum (delano@solutious.com)
+
+== License
+
+See: LICENSE.txt

data/Rakefile

@@ -0,0 +1,104 @@
+require 'rubygems'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'hanna/rdoctask'
+require 'fileutils'
+include FileUtils
+ 
+task :default => :package
+ 
+# CONFIG =============================================================
+
+# Change the following according to your needs
+README = "README.rdoc"
+CHANGES = "CHANGES.txt"
+LICENSE = "LICENSE.txt"
+
+# Files and directories to be deleted when you run "rake clean"
+CLEAN.include [ 'pkg', '*.gem', '.config']
+
+# Virginia assumes your project and gemspec have the same name
+name = (Dir.glob('*.gemspec') || ['virginia']).first.split('.').first
+load "#{name}.gemspec"
+version = @spec.version
+
+# That's it! The following defaults should allow you to get started
+# on other things. 
+
+
+# TESTS/SPECS =========================================================
+
+
+
+# INSTALL =============================================================
+
+Rake::GemPackageTask.new(@spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :release => [ :rdoc, :package ]
+task :install => [ :rdoc, :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+
+# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
+
+if @spec.rubyforge_project
+  desc 'Publish website to rubyforge'
+  task 'publish:rdoc' => 'doc/index.html' do
+    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+  end
+
+  desc 'Public release to rubyforge'
+  task 'publish:gem' => [:package] do |t|
+    sh <<-end
+      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
+    end
+  end
+end
+
+
+
+# RUBY DOCS TASK ==================================
+
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'doc'
+	t.title    = @spec.summary
+	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.options << '--charset' << 'utf-8'
+	t.rdoc_files.include(LICENSE)
+	t.rdoc_files.include(README)
+	t.rdoc_files.include(CHANGES)
+	#t.rdoc_files.include('bin/*')
+	t.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+#Hoe.new('rspec', Spec::VERSION::STRING) do |p|
+#  p.summary = Spec::VERSION::SUMMARY
+#  p.description = "Behaviour Driven Development for Ruby."
+#  p.rubyforge_name = 'rspec'
+#  p.developer('RSpec Development Team', 'rspec-devel@rubyforge.org')
+#  p.extra_dev_deps = [["cucumber",">= 0.1.13"]]
+#  p.remote_rdoc_dir = "rspec/#{Spec::VERSION::STRING}"
+#  p.rspec_options = ['--options', 'spec/spec.opts']
+#  p.history_file = 'History.rdoc'
+#  p.readme_file  = 'README.rdoc'
+#  p.post_install_message = <<-POST_INSTALL_MESSAGE
+##{'*'*50}
+#
+#  Thank you for installing rspec-#{Spec::VERSION::STRING}
+#
+#  Please be sure to read History.rdoc and Upgrade.rdoc
+#  for useful information about this release.
+#
+#{'*'*50}
+#POST_INSTALL_MESSAGE
+#end

data/annoy.gemspec

@@ -0,0 +1,56 @@
+@spec = Gem::Specification.new do |s|
+	s.name = "annoy"
+  s.rubyforge_project = "annoy"
+	s.version = "0.5.0"
+	s.summary = "Annoy: Like your annoying friend that asks you questions all the time."
+	s.description = s.summary
+  s.author = "Delano Mandelbaum"
+  s.email = "delano@solutious.com"
+  s.homepage = "http://solutious.com/"
+  
+  
+  # = EXECUTABLES =
+  # The list of executables in your project (if any). Don't include the path, 
+  # just the base filename.
+  s.executables = %w[]
+  
+  # = DEPENDENCIES =
+  # Add all gem dependencies
+  #s.add_dependency ''
+  s.add_dependency 'highline', '>= 1.5.0'
+    
+  # = MANIFEST =
+  # The complete list of files to be included in the release. When GitHub packages your gem, 
+  # it doesn't allow you to run any command that accesses the filesystem. You will get an
+  # error. You can ask your VCS for the list of versioned files:
+  # git ls-files
+  # svn list -R
+  s.files = %w(
+  CHANGES.txt
+  LICENSE.txt
+  README.rdoc
+  Rakefile
+  lib/annoy.rb
+  annoy.gemspec
+  )
+  
+  s.extra_rdoc_files = %w[README.rdoc LICENSE.txt]
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--title", s.summary, "--main", "README.rdoc"]
+  s.require_paths = %w[lib]
+  s.rubygems_version = '1.3.0'
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+ 
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<RedCloth>, [">= 4.0.4"])
+    else
+      s.add_dependency(%q<RedCloth>, [">= 4.0.4"])
+    end
+  else
+    s.add_dependency(%q<RedCloth>, [">= 4.0.4"])
+  end
+  
+end

data/lib/annoy.rb

@@ -0,0 +1,297 @@
+#---
+# TODO: Use Matrix to give a more accurate annoyance factor
+# TODO: Add trivia questions
+#+++
+
+require 'timeout'
+require 'highline'
+
+# = Annoy 
+#
+# Like your annoying friend that asks you questions all the time.
+#
+# Rudy uses Annoy to present the user with a simple question before
+# continuing with a destructive action. 
+#
+class Annoy
+  
+  attr_accessor :factor
+  attr_accessor :flavor
+  attr_accessor :answer
+  attr_accessor :writer
+  attr_accessor :period
+  attr_accessor :system
+  
+  @@operators = {
+    :low      => %w(+ -),
+    :medium   => %w(* -),
+    :high     => %w(& * -),
+    :insane   => %w(** << | & *)
+  }.freeze
+  
+  @@strlen = {
+    :low      => 2,
+    :medium   => 3,
+    :high     => 4,
+    :insane   => 32
+  }.freeze
+  
+  @@randsize = {
+    :low      => 10,
+    :medium   => 12,
+    :high     => 50,
+    :insane   => 1000
+  }.freeze
+  
+  @@period = 60.freeze    # max seconds to wait
+  @@flavors = [:numeric, :string].freeze
+  @@skip = false          # skip questions
+  
+  # Calling this method tells Annoy to not prompt for
+  # a response. All questions will return true. 
+  def Annoy.enable_skip; @@skip = true; end
+  # Tells annoy to prompt for a response. 
+  def Annoy.disable_skip; @@skip = false; end
+  # Returns true of Annoy is in skip mode
+  def Annoy.skip?; @@skip; end
+  
+  # * +factor+ annoyance factor, one of :low (default), :medium, :high, :insane
+  # * +flavor+ annoyance flavor, one of :rand (default), :numeric, string
+  # * +writer+ an IO object to write to. Default: STDERR
+  # * +period+ the amount of time to wait in seconds. Default: 60
+  def initialize(opts={:factor=>:medium, :flavor=>:rand, :writer=>STDOUT, :period=>nil})
+    @factor = opts[:factor]
+    @flavor = Annoy.get_flavor(opts[:flavor])
+    @writer = opts[:writer]
+    @period = opts[:period] || @@period
+    unless Annoy.respond_to?("#{@flavor}_question")
+      raise "Hey, hey, hey. I don't know that flavor! (#{@flavor})" 
+    end
+  end
+  
+  # Generates and returns a question. The correct response is available
+  # as +@answer+.
+  def question
+    q, @answer =Annoy.question(@factor, @flavor)
+    q
+  end
+  
+  # A wrapper for string_question and numberic_question
+  def Annoy.question(factor=:medium, flavor=:rand)
+    raise "Come on, you ruined the flavor!" unless flavor
+    Annoy.send("#{flavor}_question", factor)
+  end
+  
+  # Generates a random string
+  def Annoy.string_question(factor=:medium)
+    # Strings don't need to be evaluated so the answer is the
+    # same as the question.
+    str = strand @@strlen[factor]
+    [str,str]
+  end
+  
+  # * Generates a rudimentary numeric equation in the form: (Integer OPERATOR Integer).
+  # * Returns [equation, answer]
+  def Annoy.numeric_question(factor=:medium)
+    equation = answer = 0
+    while answer < 10
+      vals = [rand(@@randsize[factor])+1, 
+              @@operators[factor][ rand(@@operators[factor].size) ],
+              rand(@@randsize[factor])+1 ]
+      equation = "(%d %s %d)" % vals
+      answer = eval(equation)
+    end
+    [equation, answer]
+  end
+  
+  # Prints a question to +writer+ and waits for a response on STDIN. 
+  # It checks whether STDIN is connected a tty so it doesn't block on gets
+  # when there's no human around to annoy. It will return <b>TRUE</b> when
+  # STDIN is NOT connected to a tty (when STDIN.tty? returns false).
+  # * +msg+ The message to print. Default: "Please confirm."
+  # Returns true when the answer is correct, otherwise false.
+  def Annoy.challenge?(msg="Please confirm.", factor=:medium, flavor=:rand, writer=STDOUT, period=nil)
+    return true unless STDIN.tty? # Humans only!
+    return true if Annoy.skip?
+    begin
+      success = Timeout::timeout(period || @@period) do
+        flavor = Annoy.get_flavor(flavor)
+        question, answer = Annoy.question(factor, flavor)
+        msg = "#{msg} To continue, #{Annoy.verb(flavor)} #{question}: "
+        #writer.print msg
+        #if ![:medium, :high, :insane].member?(factor) && flavor == :numeric
+        #writer.print "(#{answer}) " 
+        #writer.flush
+        #end
+        #response = Annoy.get_response(writer)
+                
+        highline = HighLine.new 
+        response = highline.ask(msg) { |q| 
+          q.echo = '*'             # Don't display response
+          q.overwrite = true       # Erase the question afterwards
+          q.whitespace = :strip    # Remove whitespace from the response
+          q.answer_type = Integer  if flavor == :numeric
+        }
+        
+        ret = (response == answer)
+        writer.puts "Incorrect" unless ret
+        ret
+      end
+    rescue Interrupt
+      writer.puts $/, "Giving up!"
+      false
+    rescue Annoy::GiveUp => ex
+      writer.puts $/, "Giving up!"
+      false
+    rescue Timeout::Error => ex
+      writer.puts $/, "Times up!"
+      false
+    end
+  end
+  
+  # Runs a challenge with the message, "Are you sure?"
+  # See: Annoy.challenge?
+  def Annoy.are_you_sure?(factor=:medium, flavor=:rand, writer=STDOUT)
+    Annoy.challenge?("Are you sure?", factor, flavor, writer)
+  end
+  
+  # Runs a challenge with the message, "Proceed?"
+  # See: Annoy.challenge?
+  def Annoy.proceed?(factor=:medium, flavor=:rand, writer=STDOUT)
+    Annoy.challenge?("Proceed?", factor, flavor, writer)
+  end
+  
+  # See: Annoy.challenge?
+  # Uses the value of @flavor, @factor, and @writer
+  def challenge?(msg="Please confirm.")
+    Annoy.challenge?(msg, @factor, @flavor, @writer)
+  end
+  
+  # See: Annoy.pose_question
+  # Uses the value of @writer
+  def pose_question(msg, regexp)
+    Annoy.pose_question(msg, regexp, @writer)
+  end
+  
+  # Prints a question to writer and waits for a response on STDIN. 
+  # It checks whether STDIN is connected a tty so it doesn't block on gets.
+  # when there's no human around to annoy. It will return <b>TRUE</b> when
+  # STDIN is NOT connected to a tty.
+  # * +msg+ The question to pose to the user
+  # * +regexp+ The regular expression to match the answer. 
+  def Annoy.pose_question(msg, regexp, writer=STDOUT, period=nil)
+    return true unless STDIN.tty? # Only ask a question if there's a human
+    return true if Annoy.skip?
+    begin
+      success = Timeout::timeout(period || @@period) do
+        regexp &&= Regexp.new regexp
+        highline = HighLine.new 
+        response = highline.ask(msg) { |q| 
+          q.echo = '*'             # Don't display response
+          q.overwrite = true       # Erase the question afterwards
+          q.whitespace = :strip    # Remove whitespace from the response
+        }
+        regexp.match(response)
+      end
+    rescue Timeout::Error => ex
+      writer.puts $/, "Times up!"
+      false
+    end
+  end
+ 
+ 
+  def Annoy.timed_display(msg, writer, period=nil)
+    return true unless STDIN.tty? # Only ask a question if there's a human
+    if Annoy.skip?
+      #writer.puts msg 
+      return true
+    end
+    begin
+      period ||= @@period
+      success = Timeout::timeout(period) do
+        writer.puts "Message will display for #{period} seconds"
+        writer.print msg
+        writer.flush if writer.respond_to?(:flush)
+        sleep period+1
+      end
+    rescue Timeout::Error => ex
+      writer.print "\r" << ' '*msg.size
+    end
+    
+    true
+  end
+  
+ private 
+  def Annoy.get_response(writer=STDOUT)
+    return true unless STDIN.tty? # Humans only
+    return true if Annoy.skip?
+    # TODO: Count the number of keystrokes to prevent copy/paste.
+    # We can probably use Highline. 
+    # We likely need to be more specific but this will do for now.
+    #if ::SysInfo.new.os == :unix 
+    #  begin
+    #    response = []
+    #    char = nil
+    #    system("stty raw -echo") # Raw mode, no echo
+    #    while char != "\r" || response.size > 5
+    #      char = STDIN.getc.chr
+    #      writer.print char
+    #      writer.flush
+    #      response << char
+    #    end
+    #    writer.print "\n\r"
+    #    response = response.join('')
+    #  rescue => ex
+    #  ensure
+    #    system("stty -raw echo") # Reset terminal mode
+    #  end
+    #else
+      response = (STDIN.gets || "")
+    #end
+    response.chomp.gsub(/["']/, '')
+  end
+  # Returns a verb appropriate to the flavor.
+  # * :numeric => resolve
+  # * :string => type
+  def Annoy.verb(flavor)
+    case flavor
+    when :numeric then "resolve"
+    when :string then "type"
+    else
+      nil
+    end
+  end
+ 
+  # 
+  # Generates a string of random alphanumeric characters.
+  # * +len+ is the length, an Integer. Default: 8
+  # * +safe+ in safe-mode, ambiguous characters are removed (default: true):
+  #       i l o 1 0
+  def Annoy.strand( len=8, safe=true )
+     chars = ("a".."z").to_a + ("0".."9").to_a
+     chars.delete_if { |v| %w(i l o 1 0).member?(v) } if safe
+     str = ""
+     1.upto(len) { |i| str << chars[rand(chars.size-1)] }
+     str
+  end
+  
+  # * +f+ a prospective flavor name
+  def Annoy.get_flavor(f)
+    f.to_sym == :rand ? flavor_rand : f.to_sym
+  end
+  
+  # Return a random flavor
+  def Annoy.flavor_rand
+    @@flavors[rand(@@flavors.size)]
+  end
+
+  
+end
+
+# = Annoy::GiveUp
+#
+# This is what happens when you don't answer Annoy's questions. 
+class Annoy::GiveUp < RuntimeError
+end
+
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: annoy
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Delano Mandelbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.0.4
+    version: 
+description: "Annoy: Like your annoying friend that asks you questions all the time."
+email: delano@solutious.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- CHANGES.txt
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/annoy.rb
+- annoy.gemspec
+has_rdoc: true
+homepage: http://solutious.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --title
+- "Annoy: Like your annoying friend that asks you questions all the time."
+- --main
+- README.rdoc
+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: annoy
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 2
+summary: "Annoy: Like your annoying friend that asks you questions all the time."
+test_files: []
+