natophone 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8693ad33322d311963546584e9635a68ba9b96d
-  data.tar.gz: 8ccee5d5594de21dda8499f13c3e458665a0e5a1
+  metadata.gz: c22b9ae46a28af9e9a4cdfc480b3d0494bca20c3
+  data.tar.gz: 169d1119299ce35c9bf6995f3ea4293f21ac2f4a
 SHA512:
-  metadata.gz: 7bf488683604a5acfa65e8c491eb05f50e3e4cc134bd0f8e225b1ba1ba7e888dabbd0eb47705f15e0ef6712f718417e6945f98bf9c5a977977d7ba341c5236fb
-  data.tar.gz: 704c52b58d500fdb355b0bad165691f2d7cac12c591375f09483bc7356f6c21476d2c533a32b8bfaadba283349c32568f137201b0f9deb6b50fbc8ce7059f455
+  metadata.gz: aee62cce368e20f3ddb50ea72638ab8d1daa2d3c4ef76a25dfb31801259cf7a2d7ff04775e3a8b6639824c90c9656c6dee1d990343d0b46b5eae02cb9d97d7c7
+  data.tar.gz: 78efa1aa284404573692b281d514a247f9f324d22dfb2b7fcd138b906227848af6d077bff2c515f8502e1dbabcb68e55d9a7dfc05f3bdf56ef487e55f05f378e

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.0.3 
+- Map shortcuts to commands
+- Check input type
+- More tests
+
 # 0.0.2 2014-09-07
 - Fixes
 - Tests

data/README.md

@@ -1,3 +1,7 @@
+![travis](https://travis-ci.org/ericdke/NATOPhone.svg?branch=master)
+
+[![Coverage Status](https://img.shields.io/coveralls/ericdke/NATOPhone.svg)](https://coveralls.io/r/ericdke/NATOPhone?branch=master)
+
 # NATOPhone
 
 Simple tool to encode/decode [NATO alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet).
@@ -6,7 +10,9 @@ Simple tool to encode/decode [NATO alphabet](https://en.wikipedia.org/wiki/NATO_
 
 ### CLI
 
-    $ gem install natophone
+```raw
+gem install natophone
+```  
 
 ### Library
 
@@ -18,23 +24,24 @@ gem 'natophone'
 
 And then execute:
 
-    $ bundle
+`bundle`
 
 ## Usage
 
 ### CLI
 
-    $ natophone encode Hello world.
-
-    $ natophone encode --yell Hello world.
-
-    $ natophone encode --json Hello world.
-
-    $ natophone decode hotel echo lima lima oscar - whiskey oscar romeo lima delta stop
-
-    $ natophone decode --yell hotel echo lima lima oscar - whiskey oscar romeo lima delta stop
-
-    $ natophone decode --json hotel echo lima lima oscar - whiskey oscar romeo lima delta stop
+```raw
+natophone encode Hello world.
+natophone -E Hello world.
+natophone -E 'Hello world.' 'Goodbye!'
+natophone -E --yell Hello world.
+natophone -E --json Hello world.
+natophone decode hotel echo lima lima oscar - whiskey oscar romeo lima delta stop
+natophone -D hotel echo lima lima oscar - whiskey oscar romeo lima delta stop
+natophone -D 'hotel echo lima lima oscar' 'whiskey oscar romeo lima delta stop'
+natophone -D --yell hotel echo lima lima oscar
+natophone -D --json hotel echo lima lima oscar
+```  
 
 ### Library
 

data/lib/app.rb

@@ -21,9 +21,7 @@ module NATOPhone
 
     def otan_alphabet_decode
       otan = otan_alphabet_encode.invert
-      otan.merge!({
-          "point" => "."
-        })
+      otan.merge!({"point" => "."})
     end
 
     def sanitize(string)
@@ -53,15 +51,33 @@ module NATOPhone
       }.to_json
     end
 
+    def to_s
+      @translate
+    end
+
+    def to_a
+      @encode
+    end
+
     private
 
     def convert(input)
-      input = input.join(' ') if input.is_a?(Array)
+      input = check_input(input)
       characters = sanitize(input).downcase.chars
       res = characters.map {|char| @dic[char]}.compact
       uniq_separator(res)
     end
 
+    def check_input(input)
+      if input.is_a?(String)
+        return input
+      elsif input.is_a?(Array)
+        return input.join(' ')
+      else
+        raise TypeError, "Error: Encoder accepts only Strings or Arrays."
+      end
+    end
+
     def uniq_separator(input)
       bucket = []
       input.each do |c|
@@ -93,22 +109,39 @@ module NATOPhone
       }.to_json
     end
 
+    def to_s
+      @translate
+    end
+
+    def to_a
+      @decode
+    end
+
     private
 
     def convert(args)
+      words = if args.is_a?(String)
+        convert_string(args)
+      elsif args.is_a?(Array)
+        convert_array(args)
+      else
+        raise TypeError, "Error: Decoder accepts only Strings or Arrays."
+      end
+      words.map {|word| @dic[word]}
+    end
+
+    def convert_string args
+      args.split(' ').map {|word| word}
+    end
+
+    def convert_array args
       words = []
-      if args.is_a?(String)
-        args.split(' ').each do |word|
+      args.each do |string|
+        string.split(' ').each do |word|
           words << word
         end
-      else
-        args.each do |string|
-          string.split(' ').each do |word|
-            words << word
-          end
-        end
       end
-      words.map {|word| @dic[word]}
+      return words
     end
 
   end # End of class Decoder

data/lib/cli.rb

@@ -7,6 +7,7 @@ module NATOPhone
   class NATOPhoneCLI < Thor
 
     desc "encode WORD(S)", "Encode to NATO alphabet"
+    map "-E" => "encode"
     option :yell, aliases: '-Y', type: :boolean, desc: "Option to YELL the translation"
     option :json, aliases: '-J', type: :boolean, desc: "Option to export the translation in JSON"
     def encode(*args)
@@ -16,11 +17,12 @@ module NATOPhone
       elsif options[:json]
         puts enc.to_json
       else
-        puts "\n#{enc.translate}\n\n"
+        puts "\n#{enc}\n\n"
       end
     end
 
     desc "decode NATO", "Decode from NATO alphabet"
+    map "-D" => "decode"
     option :yell, aliases: '-Y', type: :boolean, desc: "Option to YELL the translation"
     option :json, aliases: '-J', type: :boolean, desc: "Option to export the translation in JSON"
     def decode(*args)
@@ -30,7 +32,7 @@ module NATOPhone
       elsif options[:json]
         puts dec.to_json
       else
-        puts "\n#{dec.translate}\n\n"
+        puts "\n#{dec}\n\n"
       end
     end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module NATOPhone
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/natophone_spec.rb

@@ -7,11 +7,12 @@ describe NATOPhone::Encoder do
   let(:enc2) { NATOPhone::Encoder.new(['1.0 Hello World.']) }
 
   describe "#args" do
+    str = '1.0 Hello World.'
     it "shows args" do
-      expect(enc.args).to eq '1.0 Hello World.'
+      expect(enc.args).to eq str
     end
     it "shows args" do
-      expect(enc2.args).to eq ["1.0 Hello World."]
+      expect(enc2.args).to eq [str]
     end
   end
 
@@ -21,14 +22,17 @@ describe NATOPhone::Encoder do
       expect(enc.translate).to eq str
     end
     it "shows translation" do
-      expect(enc2.translate).to eq str
+      expect(enc2.to_s).to eq str
+    end
+    it "shows translation" do
+      expect(NATOPhone::Encoder.new('uniq   spaces').to_s).to eq 'uniform november india quebec - sierra papa alpha charlie echo sierra'
     end
   end
 
   describe "#encode" do
     arr = ["one", "stop", "zero", "-", "hotel", "echo", "lima", "lima", "oscar", "-", "whiskey", "oscar", "romeo", "lima", "delta", "stop"]
     it "shows encoded result" do
-      expect(enc.encode).to eq arr
+      expect(enc.to_a).to eq arr
     end
     it "shows encoded result" do
       expect(enc2.encode).to eq arr
@@ -46,19 +50,29 @@ describe NATOPhone::Encoder do
   end
 
   describe "#to_json" do
+    arg = '1.0 Hello World.'
+    trans = 'one stop zero - hotel echo lima lima oscar - whiskey oscar romeo lima delta stop'
+    deco = ["one", "stop", "zero", "-", "hotel", "echo", "lima", "lima", "oscar", "-", "whiskey", "oscar", "romeo", "lima", "delta", "stop"]
+    ye = 'ONE STOP ZERO - HOTEL ECHO LIMA LIMA OSCAR - WHISKEY OSCAR ROMEO LIMA DELTA STOP'
     it "outputs json" do
       j = JSON.parse(enc.to_json)
-      expect(j['args']).to eq '1.0 Hello World.'
-      expect(j['translate']).to eq 'one stop zero - hotel echo lima lima oscar - whiskey oscar romeo lima delta stop'
-      expect(j['encode']).to eq ["one", "stop", "zero", "-", "hotel", "echo", "lima", "lima", "oscar", "-", "whiskey", "oscar", "romeo", "lima", "delta", "stop"]
-      expect(j['yell']).to eq 'ONE STOP ZERO - HOTEL ECHO LIMA LIMA OSCAR - WHISKEY OSCAR ROMEO LIMA DELTA STOP'
+      expect(j['args']).to eq arg
+      expect(j['translate']).to eq trans
+      expect(j['encode']).to eq deco
+      expect(j['yell']).to eq ye
     end
     it "outputs json" do
       j = JSON.parse(enc2.to_json)
-      expect(j['args']).to eq ['1.0 Hello World.']
-      expect(j['translate']).to eq 'one stop zero - hotel echo lima lima oscar - whiskey oscar romeo lima delta stop'
-      expect(j['encode']).to eq ["one", "stop", "zero", "-", "hotel", "echo", "lima", "lima", "oscar", "-", "whiskey", "oscar", "romeo", "lima", "delta", "stop"]
-      expect(j['yell']).to eq 'ONE STOP ZERO - HOTEL ECHO LIMA LIMA OSCAR - WHISKEY OSCAR ROMEO LIMA DELTA STOP'
+      expect(j['args']).to eq [arg]
+      expect(j['translate']).to eq trans
+      expect(j['encode']).to eq deco
+      expect(j['yell']).to eq ye
+    end
+  end
+
+  describe "type error" do
+    it "raises a type error" do
+      expect(lambda {NATOPhone::Encoder.new({'test' => 'Run, you fools!'})}).to raise_error(TypeError)
     end
   end
 
@@ -82,10 +96,10 @@ describe NATOPhone::Decoder do
   describe "#translate" do
     str = '1.0 hello world.'
     it "shows translation" do
-      expect(dec.translate).to eq str
+      expect(dec.to_s).to eq str
     end
     it "shows translation" do
-      expect(dec2.translate).to eq str
+      expect(dec2.to_s).to eq str
     end
   end
 
@@ -130,5 +144,11 @@ describe NATOPhone::Decoder do
     end
   end
 
+  describe "type error" do
+    it "raises a type error" do
+      expect(lambda {NATOPhone::Decoder.new({'test' => 'Run, you fools!'})}).to raise_error(TypeError)
+    end
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natophone
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor