morse_me_nicely 0.0.1

checksums.yaml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rspec', '3.6.0'
+gem 'rake', '12.0.0'
+gem 'thor', '0.19.4'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thor (0.19.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (= 12.0.0)
+  rspec (= 3.6.0)
+  thor (= 0.19.4)
+
+BUNDLED WITH
+   1.14.3

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "-f doc"
+  end
+
+  task :default => :spec
+rescue LoadError
+  raise "No Rspec available"
+end

data/bin/morse_me_nicely

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+require_relative '../lib/morse_me_nicely'
+
+MorseMeNicely::CLI.start(ARGV)

data/data/morse_reference.yml

@@ -0,0 +1,42 @@
+characters:
+  "a": ".-"
+  "b": "-..."
+  "c": "-.-."
+  "d": "-.."
+  "e": "."
+  "f": "..-."
+  "g": "--."
+  "h": "...."
+  "i": ".."
+  "j": ".---"
+  "k": "-.-"
+  "l": ".-.."
+  "m": "--"
+  "n": "-."
+  "o": "---"
+  "p": ".--."
+  "q": "--.-"
+  "r": ".-."
+  "s": "..."
+  "t": "-"
+  "u": "..-"
+  "v": "...-"
+  "w": ".--"
+  "x": "-..-"
+  "y": "-.--"
+  "z": "--.."
+  "0": "-----"
+  "1": ".----"
+  "2": "..---"
+  "3": "...--"
+  "4": "....-"
+  "5": "....."
+  "6": "-...."
+  "7": "--..."
+  "8": "---.."
+  "9": "----."
+  ".": ".-.-.-"
+  ",": "--..--"
+separators:
+  character: '|'
+  word: '/'

data/lib/morse_me_nicely.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+require 'thor'
+
+MORSE_ME_NICELY_PATH = File.dirname(__FILE__) + "/morse_me_nicely/"
+
+[
+  "encoder",
+  "obfuscator",
+  "cli"
+].each do |utility|
+  require MORSE_ME_NICELY_PATH + utility
+end
+
+module MorseMeNicely
+  class InvalidInputError < StandardError; end
+
+  class Processor
+
+    def self.encode(input_text, without_obfuscation=false)
+      text = Encoder.new(input_text).encoded_input
+      text = Obfuscator.new(text).obfuscated_input unless without_obfuscation
+      text
+    end
+
+  end
+end

data/lib/morse_me_nicely/cli.rb

@@ -0,0 +1,30 @@
+module MorseMeNicely
+
+  class CLI < Thor
+
+    desc "encode [--without-obfuscation] [--input-file=path/to/input_file] [--output-file=path/to/output_file]", "Encode message using obfuscated morse code"
+    method_options :without_obfuscation => :boolean
+    method_options :input_file => :string
+    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)
+      end
+    end
+
+  end
+
+end

data/lib/morse_me_nicely/encoder.rb

@@ -0,0 +1,51 @@
+module MorseMeNicely
+
+  class Encoder
+
+    ENCODING_REFERENCE_PATH = MORSE_ME_NICELY_PATH + "../../data/morse_reference.yml"
+
+    def initialize(input_text)
+      @input_text = input_text
+      @encoding_reference = YAML::load_file(ENCODING_REFERENCE_PATH)
+    end
+
+    def encoded_input
+      validate_input_text
+      @input_text.split(/\n/).map do |line|
+        line.scan(/\w+\.?\,?/).map do |word|
+          translate_word(word)
+        end.join(@encoding_reference["separators"]["word"])
+      end.join("\n")
+    end
+
+    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(" ")}"
+      end
+    end
+
+    def get_input_invalid_characters
+      input_copy = @input_text.downcase.dup
+      @encoding_reference["characters"].keys.each do |character|
+        input_copy.gsub!(character, '')
+      end
+      input_copy.gsub(/\s+/, '').split('').uniq
+    end
+
+    def translate_word(word)
+      word.split('').map do |character|
+        translate_character(character)
+      end.join(@encoding_reference["separators"]["character"])
+    end
+
+    def translate_character(character)
+      @encoding_reference["characters"][character.downcase]
+    end
+
+  end
+
+end

data/lib/morse_me_nicely/obfuscator.rb

@@ -0,0 +1,68 @@
+module MorseMeNicely
+
+  class Obfuscator
+
+    def initialize(input_text)
+      @input_text = input_text
+    end
+
+    def obfuscated_input
+      process_dashes(
+        process_dots(
+          @input_text
+        )
+      )
+    end
+
+    private
+
+    def process_dots(text)
+      text_copy = text.dup
+      get_ordered_unique_consecutive_chars(text, :dot).each do |uniq_consecutive_dots|
+        text_copy.gsub!(uniq_consecutive_dots, encode_consecutive_dots(uniq_consecutive_dots))
+      end
+      text_copy
+    end
+
+    def process_dashes(text)
+      text_copy = text.dup
+      get_ordered_unique_consecutive_chars(text, :dash).each do |uniq_consecutive_dashes|
+        text_copy.gsub!(uniq_consecutive_dashes, encode_consecutuve_dashes(uniq_consecutive_dashes))
+      end
+      text_copy
+    end
+
+    def get_ordered_unique_consecutive_chars(text, character)
+      regex = case character
+              when :dot
+                /\.+/
+              when :dash
+                /\-+/
+              end
+      text.scan(regex).uniq.sort do |v1, v2|
+        v2.length <=> v1.length
+      end
+    end
+
+    def encode_consecutive_dots(dots)
+      length = dots.length
+      if length > 9
+        raise InvalidInputError, "Number of consecutive dots can't be greater than 9"
+      else
+        length.to_s
+      end
+    end
+
+    def encode_consecutuve_dashes(dashes)
+      ascii_idx_addition = ("A".ord - 1)
+      ascii_nr = dashes.length + ascii_idx_addition
+      if ascii_nr > "Z".ord
+        raise InvalidInputError, "Number of consecutive dashes can't be greater than the size of alphabet"
+      else
+        ascii_nr.chr
+      end
+    end
+
+  end
+
+end

data/spec/morse_me_nicely/encoder_spec.rb

@@ -0,0 +1,100 @@
+require_relative '../spec_helper'
+
+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
+        described_class.new("I'm to stupid; 2 > 1")
+      end
+
+      it "raises InvalidInput error with invalid characters listed" do
+        expect { subject.encoded_input }.to raise_error(MorseMeNicely::InvalidInputError, "Input text contains invalid characters: ' ; >")
+      end
+
+    end
+
+  end
+
+  context "when input text is valid" do
+
+    context "translation of characters" do
+
+      subject do
+        described_class.new("l")
+      end
+
+      it "returns correct translation based on provided reference" do
+        expect(subject.encoded_input).to eq ".-.."
+      end
+
+    end
+
+    context "characters separation" do
+
+      subject do
+        described_class.new("l2")
+      end
+
+      it "returns translated characters separated by pipe '|'" do
+        expect(subject.encoded_input).to eq ".-..|..---"
+      end
+
+    end
+
+    context "words separation" do
+
+      it "separates with forward slash '/'" do
+        encoder = described_class.new("jm 13")
+        expect(encoder.encoded_input).to eq ".---|--/.----|...--"
+      end
+
+      it "considers coma and full stop as part of the preceding word" do
+        encoder = described_class.new("you, me and he.")
+        expect(encoder.encoded_input).to eq "-.--|---|..-|--..--/--|./.-|-.|-../....|.|.-.-.-"
+      end
+
+    end
+
+    context "case sensitivity" do
+
+      it "does ignore character case" do
+        encoder_downcase = described_class.new("dominik")
+        encoder_uppercase = described_class.new("DOMINIK")
+        expect(encoder_downcase.encoded_input).to eq encoder_uppercase.encoded_input
+      end
+
+    end
+
+    context "whitespaces" do
+
+      it "considers multiple spaces as one" do
+        encoder_single_space = described_class.new("foo bar")
+        encoder_multiple_spaces = described_class.new("foo    bar")
+        expect(encoder_single_space.encoded_input).to eq encoder_multiple_spaces.encoded_input
+      end
+
+      it "respects new line characters" do
+        encoder = described_class.new("a\nbc\nbc cd")
+        expect(encoder.encoded_input).to eq ".-\n-...|-.-.\n-...|-.-./-.-.|-.."
+      end
+
+    end
+
+  end
+
+end

data/spec/morse_me_nicely/obfuscator_spec.rb

@@ -0,0 +1,76 @@
+require_relative '../spec_helper'
+
+RSpec.describe MorseMeNicely::Obfuscator, "#obfuscated_input" do
+
+  context "when input text is invalid" do
+
+    context "when number of consecutive dots is greater than 9" do
+
+      subject do
+        described_class.new("...........")
+      end
+
+      it "raises InvalidInput error" do
+        expect { subject.obfuscated_input }.to(
+          raise_error(MorseMeNicely::InvalidInputError,
+            "Number of consecutive dots can't be greater than 9")
+        )
+      end
+
+    end
+
+    context "when number of consecutive dashes is greater than size of alphabet" do
+
+      subject do
+        described_class.new("---------------------------")
+      end
+
+      it "raises InvalidInput error" do
+        expect { subject.obfuscated_input }.to(
+          raise_error(MorseMeNicely::InvalidInputError,
+            "Number of consecutive dashes can't be greater than the size of alphabet")
+        )
+      end
+
+    end
+
+  end
+
+  context "when input text is valid" do
+
+    context "consecutive dots" do
+
+      it "replaces number of consecutive dots with count number" do
+        expect(described_class.new(".").obfuscated_input).to eq "1"
+        expect(described_class.new("..").obfuscated_input).to eq "2"
+        expect(described_class.new("...").obfuscated_input).to eq "3"
+        expect(described_class.new("....").obfuscated_input).to eq "4"
+        expect(described_class.new(".....").obfuscated_input).to eq "5"
+      end
+
+    end
+
+    context "consecutive dashes" do
+
+      it "replaces number of consecutive dashes with the uppercase letter of alphabet at that position" do
+        expect(described_class.new("-").obfuscated_input).to eq "A"
+        expect(described_class.new("--").obfuscated_input).to eq "B"
+        expect(described_class.new("---").obfuscated_input).to eq "C"
+        expect(described_class.new("----").obfuscated_input).to eq "D"
+        expect(described_class.new("-----").obfuscated_input).to eq "E"
+      end
+
+    end
+
+    context "misc" do
+
+      it "replaces number of consecutive dots and dashes in text block based on rules above" do
+        obfuscator = described_class.new("../.-|--/..|-./-|.-.|---|..-|-...|.-..|.")
+        expect(obfuscator.obfuscated_input).to eq "2/1A|B/2|A1/A|1A1|C|2A|A3|1A2|1"
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/morse_me_nicely'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: morse_me_nicely
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dominik Sito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: A simple gem to encode and obfuscate text input using morse code
+email: dominik.sito@gmail.com
+executables:
+- morse_me_nicely
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/morse_me_nicely
+- data/morse_reference.yml
+- lib/morse_me_nicely.rb
+- lib/morse_me_nicely/cli.rb
+- lib/morse_me_nicely/encoder.rb
+- lib/morse_me_nicely/obfuscator.rb
+- spec/morse_me_nicely/encoder_spec.rb
+- spec/morse_me_nicely/obfuscator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/railis/morse_me_nicely
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Morse Me Nicely!
+test_files:
+- spec/morse_me_nicely/encoder_spec.rb
+- spec/morse_me_nicely/obfuscator_spec.rb
+- spec/spec_helper.rb