morse_me_nicely 0.0.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e242e84aa15495dc60ee404d8a4226fdaf7bbc2
-  data.tar.gz: 18fa718bd9455bbc6f9de8005449ded79de0a7b6
+  metadata.gz: c11725480689a2c0d7e3257085bf6e8cd8c7bfba
+  data.tar.gz: 04acb135021250615fd8780f841a0079ac325bd5
 SHA512:
-  metadata.gz: 3ffae5107884ed71c3d426baab6f9ff2fab652b4f0caf47115da386a33e38f5b443cc9def71e19d9067b5d3fb7fefbf3b428f7d0fb6ada01176736ae50ee40d9
-  data.tar.gz: dbf89c966f8eb7274df1b00b9e0391fcdcee873c2420cd14344d51735b5669d9b81ee822b64784656f0d569c4774c946ac84321813f8edd596e0be047eb1571d
+  metadata.gz: c34762c9a8323808473510ae9fd98841c85f7ccaed2930ad223f38d22ffdef30b37c8e9bdffc2ebb1053e79f08c4387fe9543c1e17560ea8f515adbfcee1dcba
+  data.tar.gz: d29edce759a07e86ac29185424be691fc4fdc47ed68fb62722dc1a68b468a4647cdfb37a325f69d8f6653240d0a6d6a828d51022fa78895483a8088617e0eb0f

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jared McFarland
+
+MIT License
+
+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.md

@@ -0,0 +1,74 @@
+# Morse Me Nicely
+
+A simple command line tool for text encoding from a file/stdin using Morse code with/without obfuscation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'morse_me_nicely'
+
+And then execute:
+
+    $ bundle
+
+Or install it manually:
+
+    $ gem install morse_me_nicely
+
+## Usage
+
+When no `--input-file` option passed the input data comes from standard input:
+
+  Example usage:
+
+    $ morse_me_nicely encode
+    $ Write the message: I NEED HELP
+    Encoded message:
+    2/A1|1|1|A2/4|1|1A2|1B1
+
+  Without obfuscation:
+
+    $ morse_me_nicely encode --without-obfuscation
+    $ Write the message: I NEED HELP
+    Encoded message:
+    ../-.|.|.|-../....|.|.-..|.--.
+
+  With input file option:
+
+    $ touch source.txt
+    $ echo "I NEED HELP" > source.txt
+    $ morse_me_nicely encode --input-file=source.txt
+    Encoded message:
+    2/A1|1|1|A2/4|1|1A2|1B1
+
+  With output file option:
+
+    $ morse_me_nicely encode --output-file=output.txt
+    $ Write the message: I NEED HELP
+    Encoded message has been saved to selected file.
+    $ cat output.txt
+    2/A1|1|1|A2/4|1|1A2|1B1
+
+### Compatibility
+
+Library currently supports only case insensitive alphanumeric characters, spaces, commas and full-stops in source text.
+For more information see: Development section.
+
+## Development
+
+### Downloading repositoty
+
+    $ git clone https://github.com/railis/morse_me_nicely.git
+    $ cd morse_me_nicely
+    $ bundle install
+
+### Running tests
+
+    $ rake
+
+### Updating allowed characters set
+
+Edit the YAML file in:
+
+    data/morse_reference.ytml

data/lib/morse_me_nicely/cli.rb

@@ -8,23 +8,37 @@ module MorseMeNicely
     method_options :output_file => :string
 
     def encode
-      if options[:input_file]
-        input_text = File.read(options[:input_file])
-      else
-        input_text = ask(set_color("Write the message:", Thor::Shell::Color::GREEN))
-      end
-      encoded_text = MorseMeNicely::Processor::encode(input_text, options[:without_obfuscation])
-      if options[:output_file]
-        output_file = File.new(options[:output_file], "w+")
-        output_file << encoded_text
-        output_file.close
-        say("Encoded message has been saved to selected file.", Thor::Shell::Color::GREEN)
-      else
-        say("Encoded message:", Thor::Shell::Color::GREEN)
-        say(encoded_text)
+      begin
+        if options[:input_file]
+          input_text = File.read(options[:input_file])
+        else
+          input_text = ask(set_color("Write the message:", Thor::Shell::Color::GREEN))
+        end
+        encoded_text = MorseMeNicely::Processor::encode(input_text, options[:without_obfuscation])
+        if options[:output_file]
+          output_file = File.new(options[:output_file], "w+")
+          output_file << encoded_text
+          output_file.close
+          say("Encoded message has been saved to selected file.", Thor::Shell::Color::GREEN)
+        else
+          say("Encoded message:", Thor::Shell::Color::GREEN)
+          say(encoded_text)
+        end
+      rescue MorseMeNicely::InvalidInputError => e
+        say_error(e)
+      rescue Errno::ENOENT
+        say_error("Input file '#{options[:input_file]}' does not exist")
+      rescue Errno::EACCES
+        say_error("You don't have permissions to read file '#{options[:input_file] || options[:output_file]}'")
       end
     end
 
+    private
+
+    def say_error(msg)
+      say("Error: #{msg}", Thor::Shell::Color::RED)
+    end
+
   end
 
 end

data/lib/morse_me_nicely/encoder.rb

@@ -21,7 +21,6 @@ module MorseMeNicely
     private
 
     def validate_input_text
-      raise InvalidInputError, "No text input found" unless @input_text.is_a?(String)
       invalid_characters = get_input_invalid_characters
       unless invalid_characters.empty?
         raise InvalidInputError, "Input text contains invalid characters: #{invalid_characters.join(" ")}"

data/morse_me_nicely.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.authors = ["Dominik Sito"]
+  s.email = "dominik.sito@gmail.com"
+  s.homepage = "https://github.com/railis/morse_me_nicely"
+
+  s.name = "morse_me_nicely"
+  s.version = "0.1.2"
+  s.date = '2017-08-11'
+  s.summary = "Morse Me Nicely!"
+  s.description = "A simple gem to encode and obfuscate text input using morse code"
+
+  s.files = `git ls-files`.split($\)
+  s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.license = "MIT"
+
+  s.add_dependency "thor", "~> 0.19"
+  s.add_development_dependency "rspec", "~> 3.6"
+  s.add_development_dependency "rake", "~> 12.0"
+end

data/spec/morse_me_nicely/encoder_spec.rb

@@ -4,18 +4,6 @@ RSpec.describe MorseMeNicely::Encoder, "#encoded_input" do
 
   context "when input text is not valid" do
 
-    context "when input is not a string" do
-
-      subject do
-        described_class.new(true)
-      end
-
-      it "raises InvalidInput error" do
-        expect { subject.encoded_input }.to raise_error(MorseMeNicely::InvalidInputError, "No text input found")
-      end
-
-    end
-
     context "when input text contains ambiguous characters" do
 
       subject do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: morse_me_nicely
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dominik Sito
@@ -61,6 +61,8 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- README.md
 - Rakefile
 - bin/morse_me_nicely
 - data/morse_reference.yml
@@ -68,6 +70,7 @@ files:
 - lib/morse_me_nicely/cli.rb
 - lib/morse_me_nicely/encoder.rb
 - lib/morse_me_nicely/obfuscator.rb
+- morse_me_nicely.gemspec
 - spec/morse_me_nicely/encoder_spec.rb
 - spec/morse_me_nicely/obfuscator_spec.rb
 - spec/spec_helper.rb