Base64encoding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59d6b379e9bc715c286aa96da44923ec05e14bf0b0724860292e008e5b57f53b
+  data.tar.gz: 8fccf8fc50b4bab21e81824c227bdd73b2ee9daaab05e5dae625c0355c1f2ef7
+SHA512:
+  metadata.gz: b76bccc46990a62f664ff14f77056e860a1786677565a754a7a96374be3517f653e291e6afc80123bb0158bb55c106805eb558197f4d082c42608ded82cf7b84
+  data.tar.gz: 6047f8b818fffe9e837ab0a5739352bc8d10ea27912a4ffc0fcfecfd95a978c05669a3e6bf52e62749c967a4f358638ac61de003906d7a83de1c2a8ebf3d292c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3.5
+
+Layout/IndentationStyle:
+  IndentationWidth: 1
+  EnforcedStyle: tabs
+
+Layout/IndentationWidth:
+  Width: 1
+
+Layout/EndOfLine:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/Base64encoding.rb"
+    - "spec/Base64encoding_spec.rb"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/README.md

@@ -0,0 +1,35 @@
+# Base64encoding
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/Base64encoding`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/Base64encoding.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/Base64encoding/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Constants
+	AUTHOR = '"Base64encoding" by Shkilnyi V. CS31'
+	BASE64_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
+	COMPLEMENTARY_CHARACTER = '='
+end

data/lib/Base64encoding/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Base64encoding
+	VERSION = '0.1.0'
+end

data/lib/Base64encoding.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'Base64encoding/version'
+require_relative 'Base64encoding/constants'
+
+# module Base64encoding encodes and decodes base64 strings
+module Base64encoding
+	class Error < StandardError; end
+
+	# The method encodes the input string in base64, returns the result in UTF-8
+	def self.encode_base64(input) # rubocop:disable Metrics/AbcSize
+		return '' if input.empty?
+
+		binary_string = input.bytes.map { |b| b.to_s(2).rjust(8, '0') }.join
+		six_bit_groups = binary_string.scan(/.{1,6}/)
+		six_bit_groups[-1] = six_bit_groups[-1].ljust(6, '0') if six_bit_groups[-1].size < 6
+		encoded = six_bit_groups.map { |bits| Constants::BASE64_ALPHABET[bits.to_i(2)] }
+		padding = 3 - (input.size % 3)
+		encoded.join + (Constants::COMPLEMENTARY_CHARACTER * padding)
+	end
+
+	# The method decodes the encoded string from base64, returns the result in UTF-8
+	def self.decode_base64(encoded)
+		return '' if encoded.empty?
+
+		encoded = encoded.gsub(Constants::COMPLEMENTARY_CHARACTER, '')
+		binary_string = encoded.chars.map { |char| Constants::BASE64_ALPHABET.index(char).to_s(2).rjust(6, '0') }.join
+		eight_bit_groups = binary_string.scan(/.{8}/)
+		decoded_bytes = eight_bit_groups.map { |bits| bits.to_i(2) }
+		decoded_bytes.pack('C*').force_encoding('UTF-8')
+	end
+end

data/sig/Base64encoding.rbs

@@ -0,0 +1,4 @@
+module Base64encoding
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: Base64encoding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DarkCard1nal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies: []
+description: This gem has the encode_base64 method that encodes UTF-8 strings tobase64
+  (UTF-8) string, the decode_base64 method that decodes base64 string to UTF-8 string.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- '2'
+- README.md
+- Rakefile
+- lib/Base64encoding.rb
+- lib/Base64encoding/constants.rb
+- lib/Base64encoding/version.rb
+- sig/Base64encoding.rbs
+homepage: https://github.com/DarkCard1nal/STP_Base64encoding.git.
+licenses: []
+metadata:
+  homepage_uri: https://github.com/DarkCard1nal/STP_Base64encoding.git.
+  source_code_uri: https://github.com/DarkCard1nal/STP_Base64encoding.git.
+  changelog_uri: https://github.com/DarkCard1nal/STP_Base64encoding.git.
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A gem for Base64 encoding and decoding.
+test_files: []