charshift 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e93427a0056651708796614d95babdb69ed48cce
+  data.tar.gz: 7e68b07ef714040b7be31de6789dc2a32b6251a1
+SHA512:
+  metadata.gz: eb90ecb90fdfedb901cda1fade292ea7970a8e173687fa2fbbd59291ee7ebf15360ca752369e88e2cbf7a96050b21304d3dd885a554a83545d0da6c9f7e1e998
+  data.tar.gz: ab7c345e18f1cbfd98a57d2e229ea1bf75caff4995b88cc895da0617d6aba5f184fa87ab41e3167d3ff1964740a5302ee1c932aed571cc17cc88c6ff27c79bf9

data/lib/charshift.rb

@@ -0,0 +1,49 @@
+require 'charshifthelper'
+
+class String
+  def charshift char_shift_val, custom_encoding = nil
+    begin
+      CharshiftHelper.confirm_fixnum(char_shift_val)
+    rescue TypeError => e
+      raise
+    else
+      output = ""
+      split_string = CharshiftHelper.encoding_ind_split(self)
+      if custom_encoding
+        if CharshiftHelper.check_for_valid_array_elements(custom_encoding) == false
+          raise ArgumentError, "Custom encoding must only contain single character string elements"
+        elsif CharshiftHelper.check_for_uniqueness(custom_encoding) == false
+          raise ArgumentError, "All elements in custom encoding must be unique"
+        else
+          split_string.each_with_index do |char, index|
+            encoding_length = custom_encoding.length
+            current_char_ord = custom_encoding.index(char)
+            if current_char_ord.nil?
+              raise RuntimeError, "Given custom encoding does not contain all characters in the target string"
+            end
+            shifted_position = CharshiftHelper.get_shift_position(current_char_ord, char_shift_val, encoding_length)
+            output << custom_encoding[shifted_position]
+          end
+        end
+      else
+        split_string.each do |char|
+          char_encoding_type = CharshiftHelper.get_encoding(char)
+          encoding_length = CharshiftHelper.get_encoding_length(char_encoding_type) - 1
+          current_char_ord = CharshiftHelper.get_ord_by_char(char)
+          shifted_position = CharshiftHelper.get_shift_position(current_char_ord, char_shift_val, encoding_length)
+          output << CharshiftHelper.get_char_by_ord(shifted_position, char_encoding_type)
+        end
+      end
+      return output
+    end
+  end
+
+  def charshift! char_shift_val, custom_encoding = nil
+    updated_string = charshift char_shift_val, custom_encoding = nil
+    return self.replace(updated_string)
+  end
+
+  def getEncodingLength
+    return CharshiftHelper.get_encoding_length(self.encoding)
+  end
+end

data/lib/charshifthelper.rb

@@ -0,0 +1,93 @@
+module CharshiftHelper
+
+  def self.confirm_fixnum input_val
+    if !input_val.instance_of? Fixnum
+      raise TypeError, 'Input value must be of type fixnum'
+    else
+      return true
+    end
+  end
+
+  def self.encoding_ind_split input_string
+    split_string = []
+
+    input_string.each_char do |chr|
+      split_string << chr
+    end
+    return split_string
+  end
+
+  def self.get_shift_distance_minus_loops input_val, collection_length
+    absloute_input_val = input_val.abs
+    remaining_difference = absloute_input_val % collection_length
+    if absloute_input_val > collection_length
+      return input_val > 0 ? remaining_difference : 0 - remaining_difference
+    else
+      return input_val
+    end
+  end
+
+  def self.get_shift_position starting_pos, shift_val, encoding_length
+    collection_length = encoding_length
+    shift_difference = self.get_shift_distance_minus_loops(shift_val, collection_length)
+    start_plus_shift = starting_pos + shift_difference
+    if shift_difference + starting_pos == encoding_length
+      return 0
+    elsif start_plus_shift > collection_length
+      return 0 + start_plus_shift - collection_length
+    elsif start_plus_shift < 0
+      return collection_length + start_plus_shift
+    else
+      return start_plus_shift
+    end
+  end
+
+  def self.get_char_by_ord ordinal_value, char_encoding_type
+    return ordinal_value.chr(char_encoding_type)
+  end
+
+  def self.get_ord_by_char character
+    return character.ord
+  end
+
+  def self.get_encoding string
+    return string.encoding.to_s
+  end
+
+  def self.get_encoding_length encoding
+    max = 100000000000
+    min = 0
+    guess = 50000000000
+
+    while true
+      begin guess.chr(encoding)
+        if (min > max)
+          return max + 1
+        else
+          min = guess + 1
+          guess = (max + min) / 2
+        end
+      rescue
+        if min > max
+          return max + 1
+        else
+          max = guess - 1
+          guess = (max + min) / 2
+        end
+      end
+    end
+  end
+
+  def self.check_for_valid_array_elements string_array
+    string_array.each do |chr|
+      if !chr.is_a?(String) || chr.length != 1
+        return false
+      end
+    end
+    return true
+  end
+
+  def self.check_for_uniqueness string_array
+    return string_array.uniq.length == string_array.length
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: charshift
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Jonathon Nordquist
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-10 00:00:00.000000000 Z
+dependencies: []
+description: "                  Charshift is a simple gem which adds functionality
+  to the\n                  String class.  It's primary function is to act on a given\n
+  \                 string, taking a fixnum parameter, then shifting each \n                  character
+  in that string to a higher or lower ordinal \n                  position in that
+  strings encoding.\n\n                  Charshift works with all of Ruby's included
+  encodings and \n                  also works with devloper supplied 'custom encodings.'
+  \ \n                  Simply provide an ordered set of characters as an optional\n
+  \                 parameter and charshift will work on the string using that\n                  set
+  instead of the strings native encoding.\n\n                  Charshift also includes
+  a '.getEncodingLength' method which\n                  returns the number of of
+  characters which a given strings \n                  encoding contains.  Finally,
+  strings can be shifted in place\n                  using the '.charshift!' method.\n\n"
+email: https://github.com/cugamer/charshift
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/charshift.rb
+- lib/charshifthelper.rb
+homepage: http://www.jonathonnordquist.com
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Facilitate character change by ordinal position
+test_files: []