wookie-translator 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rbenv-gemsets

@@ -0,0 +1 @@
+wookie-translator

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p125

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb --title WookieTranslator --private --protected

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in WookieTranslator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+# WookieTranslator
+
+*2012/04/01*
+
+This gem is based on http://selarips.free.fr/wookieetranslator/ and built after
+a tweet from [@MikeSwole](https://twitter.com/#!/MikeSwole/status/185882254432677888).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wookie-translator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wookie-translator
+
+## Usage
+
+The gem comes with a command line interface:
+
+    $ wookie -e "enter your text here!"
+    $ wookie -w "wowhaoworc rooohurc aowokao acworcwo!"
+
+You may also use the gem's API:
+
+    require 'wookie-translator'
+    t = Wookie::Translator.new
+    wookie = t.to_wookie "Hello World."
+    english = t.from_wookie wookie #=> "hello world."
+
+If you want to use another wookie dialect, you want to inherit from
+`Wookie::Dialect::Base` and implement the methods `#to_wookie` and `#from_wookie`:
+
+    require 'wookie-translator'
+    class ReverseWookie < Wookie::Dialect::Base
+      def to_wookie(english)
+        english.reverse
+      end
+
+      def from_wookie(wookie)
+        wookie.reverse
+      end
+    end
+
+    t = Wookie::Translator.new(dialect: ReverseWookie)
+    wookie = t.to_wookie "Hello World." #=> ".dlroW olleH"
+    english = t.from_wookie wookie #=> "Hello World."
+
+## Contributing
+
+The wookie translator lacks of translations for the three main dialects:
+Shyriiwook, Xaczik and Thykarann. If you are a native speaker (or at least
+familiar with one of those dialects), you're encouraged to follow these steps:
+
+1. Fork it
+2. Create your dialect branch (`git checkout -b dialect-X`)
+3. Build a new dialect class
+4. Commit your changes (`git commit -am 'Added missing dialect'`)
+5. Push to the branch (`git push origin dialect-X`)
+6. Create new Pull Request
+
+## License
+
+This code is public domain. Remember that »Wookie« and »Star Wars« are courtesy
+of [LucasArts](http://www.lucasarts.com/).

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/wookie

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'wookie'
+begin
+  Wookie::CLI.new(ARGV).run
+rescue => e
+  $stderr.puts "An error occured: #{e.message}"
+  raise
+  exit 1
+end
+exit 0

data/lib/wookie.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+module Wookie
+  # Semantic version
+  VERSION = '0.1.0'
+
+  autoload :Translator, 'wookie/translator'
+  autoload :Dialect,    'wookie/dialect'
+  autoload :CLI,        'wookie/cli'
+end

data/lib/wookie/cli.rb

@@ -0,0 +1,89 @@
+require 'optparse'
+
+# Command line interface for this gem.
+#
+# == Usage
+#
+#     wookie [options] string
+#     wookie [options] -
+#
+# == Common Options
+#
+# +-w+ or +--from-wookie+::
+#   Translate from wookiespeak to english.
+#
+# +-e+ or +--to-wookie+::
+#   Translate from english to wookiespeak.
+#
+# +-dDIALECT+ or +--dialect DIALECT+::
+#   Use a specific dialect (default and currently only available option: simple).
+#
+# +-v+ or +--version+::
+#   Prints the version and exits.
+#
+# == Read from STDIN
+#
+# When the option +-+ is given, any non-option argument is ignored and reads from STDIN.
+#
+# == Examples
+#
+#     $ wookie -e 'Hello World!'
+#     acwoananoo ohoorcanwa!
+#     $ wookie -w 'acwoananoo ohoorcanwa!' --dialect simple
+#     hello world!
+#     $ echo 'rchurhro ahc raohwocooscwo :-)' | wookie -w -
+#     ruby is awesome :-)
+class Wookie::CLI
+
+  # Initializes the command line interface with the command line parameters (or
+  # any given argument array). See above.
+  #
+  # @param [Array] argv The command line arguments (`ARGV` is substituted, if `nil`).
+  def initialize(argv)
+    @argv = argv || ARGV
+    @options = {
+      use_stdin: false,
+      dialect: :simple
+    }
+    OptionParser.new do |opts|
+      opts.banner = "Usage: wookie [options] string\n       wookie [options] -"
+      opts.separator ""
+      opts.separator "Common Options"
+      opts.on('-w', '--from-wookie', 'Translate from wookiespeak to english') do
+        @options[:translation] = :from_wookie
+      end
+      opts.on('-e', '--to-wookie', 'Translate from english to wookiespeak') do
+        @options[:translation] = :to_wookie
+      end
+      opts.on('-d', '--dialect DIALECT', [:simple], 'Use a specific dialect (defaults to simple)', 'Currently available: simple') do |dialect|
+        @options[:dialect] = dialect
+      end
+      opts.on('-v', '--version', 'Prints the version and exits') do
+        puts "Wookie Translator v#{Wookie::VERSION}.\nThis software is public domain."
+        exit 0
+      end
+      opts.separator ""
+      opts.separator "Read from STDIN"
+      opts.separator '    -                                When given, ignore any non-option arguments'
+      opts.separator '                                     and read from STDIN.'
+    end.parse!(@argv)
+  end
+
+  # Actually executes the arguments and prints a translation.
+  # @return [void]
+  def run
+    dialect = case @options[:dialect]
+    when :simple
+      @options[:dialect] = Wookie::Dialect::Simple
+    else
+      raise ArgumentError, "Unknown dialact."
+    end
+    string = if @argv.include?('-')
+      ARGF.read
+    else
+      @argv.join(' ')
+    end
+    t = Wookie::Translator.new(dialect: dialect)
+    puts t.send(@options[:translation], string)
+  end
+end

data/lib/wookie/dialect.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+module Wookie::Dialect
+
+  # Basic class to be inherited from, when building new dialects.
+  # Though currently not implemented, a future version of the {Wookie::Translator}
+  # may check, if any given dialect is actually a subclass of {Wookie::Dialect::Base}.
+  class Base
+
+    # Keeps track of available subclasses.
+    # @param [Class] sub The subclass.
+    def self.inherited(sub)
+      @@subclasses ||= []
+      @@subclasses << sub
+    end
+
+    # Returns the known subclasses
+    # @return [Array] A list of known subclasses.
+    def self.subclasses
+      @@subclasses
+    end
+
+    # Translates an english string to wookiespeack.
+    #
+    # @note Must be implemented in the sub class.
+    # @param [String] The string to be translated.
+    # @return [String] The translation.
+    # @raise NotImplementedError
+    def to_wookie(str)
+      raise NotImplementedError
+    end
+
+    # Translates a wookiespeak string to english.
+    #
+    # @note Must be implemented in the sub class.
+    # @param [String] The string to be translated.
+    # @return [String] The translation.
+    # @raise NotImplementedError
+    def from_wookie(str)
+      raise NotImplementedError
+    end
+  end
+
+  autoload :Simple, 'wookie/dialects/simple'
+end

data/lib/wookie/dialects/simple.rb

@@ -0,0 +1,60 @@
+# -*- encoding: utf-8 -*-
+
+module Wookie::Dialect
+
+  # A simple wookie dialect found on the net. Works case insensitive (i.e. any
+  # string to be translated will be converted to downcase).
+  #
+  # @see http://selarips.free.fr/wookieetranslator/
+  class Simple < Base
+    # The basic lookup table.
+    LOOKUP = {
+      'a' => 'ra', 'b' => 'rh', 'c' => 'oa', 'd' => 'wa', 'e' => 'wo', 'f' => 'ww',
+      'g' => 'rr', 'h' => 'ac', 'i' => 'ah', 'j' => 'sh', 'k' => 'or', 'l' => 'an',
+      'm' => 'sc', 'n' => 'wh', 'o' => 'oo', 'p' => 'ak', 'q' => 'rq', 'r' => 'rc',
+      's' => 'c',  't' => 'ao', 'u' => 'hu', 'v' => 'ho', 'w' => 'oh', 'x' => 'k',
+      'y' => 'ro', 'z' => 'uf'
+    }.freeze
+
+    # A short code is defined by a length of 1 of a lookup value.
+    SHORT_CODES = LOOKUP.map{|_,v| v if v.length == 1 }.compact.join
+
+    # Translates an english string to wookiespeack.
+    #
+    # @param [String] The string to be translated.
+    # @return [String] The translation.
+    def to_wookie(str)
+      wookie = ''
+      str.downcase.each_char do |c|
+        wookie << (LOOKUP[c].nil? ? c : LOOKUP[c])
+      end
+      wookie
+    end
+
+    # Translates a wookiespeak string to english.
+    #
+    # @param [String] The string to be translated.
+    # @return [String] The translation.
+    def from_wookie(str)
+      chars = str.downcase.split('')
+      lookup = Hash[ LOOKUP.to_a.map(&:reverse) ]
+      english = ''
+      offset = 0
+      while offset < chars.length
+        cur = chars[offset]
+        nxt = chars[offset,2].join
+        if lookup.keys.include?(cur)
+          english << lookup[cur]
+        elsif lookup.keys.include?(nxt)
+          english << lookup[nxt]
+          offset += 1
+        else
+          english << cur
+        end
+        offset += 1
+      end
+      english
+    end
+
+  end
+end

data/lib/wookie/translator.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+# Translates a given string either from wookie to english or vice versa.
+class Wookie::Translator
+
+  # Contructor, defines the dialect ({Wookie::Dialect::Simple} by default).
+  # @param [Hash] options The instance options.
+  # @option options [#to_wookie,#from_wookie] :dialect A wookie dialect.
+  def initialize(options={ dialect: Wookie::Dialect::Simple })
+    @dialect = options[:dialect].new
+  end
+
+  # Translates an english string to wookiespeak using the dialect given to the
+  # initializer.
+  #
+  # @param [#to_s] str The string to be translated.
+  # @return [String] The translated string.
+  def to_wookie(str)
+    @dialect.to_wookie(str.to_s)
+  end
+
+  # Translates a string from wookiespeak to english using the dialect given to
+  # the initializer.
+  #
+  # @param [#to_s] str The string to be translated.
+  # @return [String] The english translation.
+  def from_wookie(str)
+    @dialect.from_wookie(str.to_s)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'wookie'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/wookie/identity_dialect_spec.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+class IdentityDialect < Wookie::Dialect::Base
+  def to_wookie(str); str; end
+  def from_wookie(str); str; end
+end
+
+describe Wookie::Translator do
+  before do
+    @t       = Wookie::Translator.new(dialect: IdentityDialect)
+    @english = 'enter your text here!'
+    @wookie  = 'wowhaoworc rooohurc aowokao acworcwo!'
+  end
+
+  it "translates english to english" do
+    @t.to_wookie(@english).should eq(@english)
+  end
+
+  it "translates wookie to wookie" do
+    @t.from_wookie(@wookie).should eq(@wookie)
+  end
+end

data/spec/wookie/simple_dialect_spec.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Wookie::Dialect::Simple do
+  before do
+    @dialect = Wookie::Dialect::Simple.new
+    @english = 'enter your text here!'
+    @wookie  = 'wowhaoworc rooohurc aowokao acworcwo!'
+  end
+
+  it "should have a distinct set of short codes" do
+    Wookie::Dialect::Simple::SHORT_CODES.should eq("ck")
+  end
+
+  it "translates to wookie" do
+    @dialect.to_wookie(@english).should eq(@wookie)
+  end
+
+  it "translates back to english" do
+    @dialect.from_wookie(@wookie).should eq(@english)
+  end
+end

data/spec/wookie/translator_spec.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Wookie::Translator do
+  before do
+    @english = 'enter your text here!'
+    @wookie  = 'wowhaoworc rooohurc aowokao acworcwo!'
+  end
+
+  it "should load the default dialect, if not otherwise specified" do
+    t = Wookie::Translator.new
+    t.to_wookie(@english).should eq(@wookie)
+    t.from_wookie(@wookie).should eq(@english)
+  end
+
+  it "should translate with the simple default dialect (hash form)" do
+    t = Wookie::Translator.new dialect: Wookie::Dialect::Simple
+    t.to_wookie(@english).should eq(@wookie)
+    t.from_wookie(@wookie).should eq(@english)
+  end
+
+  it "should raise a NotImplementedError if using an incomplete dialect" do
+    t = Wookie::Translator.new dialect: Wookie::Dialect::Base
+    expect {
+      t.to_wookie(@english).should eq(@wookie)
+    }.to raise_error(NotImplementedError)
+    expect {
+      t.from_wookie(@wookie).should eq(@english)
+    }.to raise_error(NotImplementedError)
+  end
+end

data/wookie-translator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/wookie', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dominik Menke\n"]
+  gem.email         = ['wookie-translator@dmke.org']
+  gem.description   = 'Translates an english string to wookie speak and vice versa.'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/dmke/wookie-translator'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'wookie-translator'
+  gem.require_paths = ['lib']
+  gem.version       = Wookie::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.0'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: wookie-translator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- ! 'Dominik Menke
+
+'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18289820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *18289820
+description: Translates an english string to wookie speak and vice versa.
+email:
+- wookie-translator@dmke.org
+executables:
+- wookie
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- .rbenv-version
+- .rspec
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- bin/wookie
+- lib/wookie.rb
+- lib/wookie/cli.rb
+- lib/wookie/dialect.rb
+- lib/wookie/dialects/simple.rb
+- lib/wookie/translator.rb
+- spec/spec_helper.rb
+- spec/wookie/identity_dialect_spec.rb
+- spec/wookie/simple_dialect_spec.rb
+- spec/wookie/translator_spec.rb
+- wookie-translator.gemspec
+homepage: https://github.com/dmke/wookie-translator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 785250080120456516
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 785250080120456516
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Translates an english string to wookie speak and vice versa.
+test_files:
+- spec/spec_helper.rb
+- spec/wookie/identity_dialect_spec.rb
+- spec/wookie/simple_dialect_spec.rb
+- spec/wookie/translator_spec.rb