fearoffish-britify 0.0.1

data/History.txt

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

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.markdown
+Rakefile
+bin/britify
+bin/yankify
+britify.gemspec
+data/translations.yml
+lib/britify.rb
+lib/britify/command_line_parser/command_line_parser.rb
+lib/britify/translate/translate.rb
+spec/britify/command_line_parser/command_line_parser_spec.rb
+spec/britify/translate/translate_spec.rb
+spec/spec_helper.rb

data/README.markdown

@@ -0,0 +1,52 @@
+# britify
+    
+by Jamie van Dyke [http://blog.fearoffish.com/](http://blog.fearoffish.com/)
+
+## DESCRIPTION:
+
+### History
+
+A clear language barrier has been evolving between Britain and the US over the years, and this gem hopes to help both sides of this barrier by translating some of the common phrases used on a daily basis by both sides.  Let's look at a timeline to describe the necessity of this gem.
+
+- England rules the waves
+- Some Spanish fella 'discovered' the America's
+- Nuclear weapons were created
+- The US became a super power
+- The US forgot about everyone else
+
+Now, this timeline is roughly accurate bar one major fact.  We're missing:
+
+- Education was neglected, particularly in the spelling and grammar department
+
+The common misconception is that there are two English languages.  Actually, there is one correct language and one mispronounced, incorrectly spelt one.  
+
+Now, because the US has more nuclear weapons than us Brits, I have also included a yankify binary that will translate from British to Yank.
+
+## INSTALL:
+
+  $ sudo gem install fearoffish-britify --sources=http://gems.github.com
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jamie van Dyke
+
+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,24 @@
+# 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.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'britify'
+
+task :default => 'spec:run'
+
+PROJ.name = 'britify'
+PROJ.version = '0.0.1'
+PROJ.authors = 'Jamie van Dyke'
+PROJ.email = 'jamie@parfa.it'
+PROJ.url = 'http://blog.fearoffish.com/'
+PROJ.homepage = 'http://github.com/fearoffish/britify'
+PROJ.rubyforge.name = 'britify'
+PROJ.summary = 'British <-> American Translator'
+PROJ.description = 'Britify is an amusement project, for translating the differences between British and American slangs.'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/britify

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'britify'))
+
+parser = Britify::CommandLineParser.new(ARGV)
+words = parser.words
+
+if ARGV.empty?
+  puts "Translate American terms into British"
+  puts "  Usage:   britify american words"
+  exit
+end
+
+begin
+  translator = Britify::Translate.new
+  translation = translator.translate( words.join(" "), :reverse )
+  puts "\"#{words.join(" ")}\" => \"#{translation}\""
+rescue
+  puts "Hell no!  There's nothing like that in British!"
+end
+
+# EOF

data/bin/yankify

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), '..', 'lib', 'britify'))
+
+parser = Britify::CommandLineParser.new(ARGV)
+words = parser.words
+
+if ARGV.empty?
+  puts "Translate British terms into American"
+  puts "  Usage:   yankify british words"
+  exit
+end
+
+begin
+  translator = Britify::Translate.new
+  translation = translator.translate( words.join(" ") )
+  puts "\"#{words.join(" ")}\" => \"#{translation}\""
+rescue
+  puts "On yer bike!  There's nothing like that in American!"
+end
+
+# EOF

data/britify.gemspec

@@ -0,0 +1,43 @@
+Gem::Specification.new do |s|
+  s.name     = "britify"
+  s.version  = "0.0.1"
+  s.date     = "2008-07-31"
+  s.summary  = "British <-> American Translator"
+  s.email    = "jamie@parfa.it"
+  s.homepage = "http://github.com/fearoffish/britify"
+  s.description = "Britify is an amusement project, for translating the differences between British and American slangs."
+  s.has_rdoc = true
+  s.authors  = ["Jamie van Dyke"]
+  s.files    = %w[
+    History.txt
+    Manifest.txt
+    README.markdown
+    Rakefile
+    bin/britify
+    bin/yankify
+    britify.gemspec
+    data/translations.yml
+    lib/britify.rb
+    lib/britify/command_line_parser/command_line_parser.rb
+    lib/britify/translate/translate.rb
+    spec/britify/command_line_parser/command_line_parser_spec.rb
+    spec/britify/translate/translate_spec.rb
+    spec/spec_helper.rb
+    tasks/ann.rake
+    tasks/bones.rake
+    tasks/gem.rake
+    tasks/git.rake
+    tasks/manifest.rake
+    tasks/notes.rake
+    tasks/post_load.rake
+    tasks/rdoc.rake
+    tasks/rubyforge.rake
+    tasks/setup.rb
+    tasks/spec.rake
+    tasks/svn.rake
+    tasks/test.rake
+  ]
+  s.executables = ['britify','yankify']
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.markdown"]
+end

data/data/translations.yml

@@ -0,0 +1,93 @@
+--- 
+# British: American
+shut your gob: shut your mouth
+snog: make out  
+wonky: not straight
+wellies: rubber boots
+toffee nosed: stuck up 
+titchie: small 
+ticket tout: scalper
+thick as a plank: stupid 
+telly advert: commercial 
+ta: thanks
+ta-ra: goodbye
+telly: television
+suss out: find out
+swanky: good appearance
+swot up: study 
+sticking plaster: bandage
+skint: poor or broke
+spot on: exactly
+skive: play hooky
+slag: slut or lowlife
+smarmy: creepy
+smashing: great or wonderful
+shirty: smart alecky
+righto: alright okay
+do a runner: run off or away
+rubber: eraser
+round the twist: gone mad or crazy
+rasher: bacon
+rabbit on: talk to much
+queue: waiting line 
+podgy: chubby, plump
+posh: ritzy
+poppet: affectionate nickname
+pub crawl: bar hopping
+i agree: like totally
+i dont agree: like whatever
+big girls blouse: pansy
+saige dillingham: bitch
+bean: punch
+chav: deliquent
+bam: deliquent
+bender: binge drink
+rough: disgusting
+ace: awesome
+melon: head
+badger: bother
+bollocks: testicles
+barmy: crazy
+bent: illegal
+bog: toilet
+bonkers: crazy
+trousers: pants
+pants: crap
+cacks: underwear
+caned: hurt a lot
+chap: man
+anti-clockwise: counter-clockwise
+arse: ass
+arsehole: asshole
+baccy: rolling tabacco
+bees knees: great
+blatant: obvious
+knackers: testicles
+knackered: tired
+blimey: wow
+blunt: dull
+bonk: sex
+bum: bottom
+cheerio: good bye
+chin wag: chat
+chuffed: pleased
+cock up: mistake
+diddle: con
+faff: procrastinate
+fanny: vagina
+fanny around: procrastinate
+fit: sexy
+grub: food
+gutted: upset
+hash: pound sign
+nick: steal
+nicked: arrested
+pissed: drunk
+angry: pissed
+porkies: lies
+roger: sex
+scrummy: tasty
+skive: evade
+old sod: old bastard
+todger: penis
+

data/lib/britify.rb

@@ -0,0 +1,56 @@
+# $Id$
+
+# Equivalent to a header guard in C/C++
+# Used to prevent the class/module from being loaded more than once
+unless defined? Britify
+
+module Britify
+
+  # :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)
+  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)
+  end
+
+  # Utility method used to rquire 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 Britify
+
+Britify.require_all_libs_relative_to __FILE__
+
+end  # unless defined?
+
+# EOF

data/lib/britify/command_line_parser/command_line_parser.rb

@@ -0,0 +1,13 @@
+module Britify
+  class CommandLineParser
+    attr_reader :arguments
+    
+    def initialize(args)
+      @arguments = args.flatten
+    end
+    
+    def words
+      return @arguments
+    end
+  end
+end

data/lib/britify/translate/translate.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+
+module Britify
+  class Translate
+    attr_reader :translations
+  
+    def initialize
+      translations_file = File.join(File.dirname(__FILE__), %w[ .. .. .. data translations.yml ])
+      @translations = YAML.load( IO.read(translations_file) )
+    end  
+  
+    def translate( string, option = :normal )
+      raise ArgumentError unless string.kind_of? String
+      string.gsub!(/'/, '')
+      string.gsub!(/\W+/, ' ')
+      string.squeeze!(" ")
+      string.strip!
+      found = case option
+      when :normal
+        @translations[string.downcase]
+      when :reverse
+        v = @translations.find {|k,v| v == string.downcase }
+        v.first if v.is_a? Array
+      end
+      raise("No idea what you meant.") unless found
+      found
+    end
+    
+  end
+end

data/spec/britify/command_line_parser/command_line_parser_spec.rb

@@ -0,0 +1,18 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper ])
+
+include Britify
+
+describe CommandLineParser do
+  setup do
+    @p = CommandLineParser.new(["some", "commandline", "arguments"])
+  end
+  
+  it "should parse an array and return a string" do
+    @p.words.should == %w{ some commandline arguments }
+  end
+  
+end
+
+# EOF

data/spec/britify/translate/translate_spec.rb

@@ -0,0 +1,53 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper])
+
+include Britify
+
+describe Translate do
+  setup do
+    @t = Translate.new
+  end
+  
+  it "should be instantiated without any arguments" do
+    lambda { Translate.new(  ) }.should_not raise_error
+    lambda { Translate.new( "moo" ) }.should raise_error(ArgumentError)
+  end
+  
+  it "should have all translations in an accessor" do
+    @t.translations.should be_a_kind_of(Hash)
+  end
+  
+  it "should load the translations in from the data file on instantiation" do
+    IO.should_receive(:read).and_return(
+      "--- \nshut your gob: shut your mouth\nsnog: make out"
+    )
+    t = Translate.new
+    t.translations.should be_a_kind_of(Hash)
+    t.translations.keys.size.should == 2
+  end
+  
+  it "should accept a string on a translate method, and return a string" do
+    @t.translate("wonky").should be_instance_of(String)
+  end
+  
+  it "should match up American terms in any case with the British equivalent" do
+    @t.translate( "shut your gob" ).should == "shut your mouth"
+    @t.translate( "POPPET" ).should == "affectionate nickname"
+  end
+  
+  it "should do British to American if given a :reverse option" do
+    @t.translate( "shut your mouth", :reverse ).should == "shut your gob"
+  end
+    
+  it "should raise an error message if it doesn't have a translation" do
+    lambda { @t.translate('what the buggering hell') }.should raise_error(RuntimeError)
+  end
+  
+  it "should strip out any non alphabetic words" do
+    @t.translate( "shut, your gob????").should == "shut your mouth"
+    @t.translate( "big girl's blouse").should == "pansy"
+  end
+end
+
+# EOF