string_entropy 0.1.0

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6
+after_script: codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in string_entropy.gemspec
+gemspec
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 anothermh
+
+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,137 @@
+# string_entropy
+
+[![Build Status](https://travis-ci.org/anothermh/string_entropy.svg?branch=master)](https://travis-ci.org/anothermh/string_entropy)
+[![Code Climate](https://codeclimate.com/github/anothermh/string_entropy/badges/gpa.svg)](https://codeclimate.com/github/anothermh/string_entropy)
+[![Test Coverage](https://codeclimate.com/github/anothermh/string_entropy/badges/coverage.svg)](https://codeclimate.com/github/anothermh/string_entropy/coverage)
+
+Outputs the information entropy, Shannon entropy, and metric entropy of any given `ASCII_8BIT` string.
+
+More information on entropy:
+
+* https://en.wikipedia.org/wiki/Entropy_%28information_theory%29
+* https://en.wikibooks.org/wiki/An_Intuitive_Guide_to_the_Concept_of_Entropy_Arising_in_Various_Sectors_of_Science
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string_entropy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string_entropy
+
+## Usage
+
+As an extension to the `String` class:
+
+```ruby
+"password".entropy
+=> 52.55884486664758
+```
+
+With the `StringEntropy::Info` class:
+
+```ruby
+string_entropy = StringEntropy.info("password")
+=> #<StringEntropy::Info:0x007fb864091590
+ @count={"p"=>1.0, "a"=>1.0, "s"=>2.0, "w"=>1.0, "o"=>1.0, "r"=>1.0, "d"=>1.0},
+ @frequency=
+  {"p"=>0.125,
+   "a"=>0.125,
+   "s"=>0.25,
+   "w"=>0.125,
+   "o"=>0.125,
+   "r"=>0.125,
+   "d"=>0.125},
+ @information_entropy=52.55884486664758,
+ @metric_entropy=0.34375,
+ @shannon_entropy=2.75,
+ @shannon_formulas=
+  ["H(X) = -[ ((0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.25 * Math.log2(0.25))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))) ]",
+   "H(X) = -[ ((-0.375)+(-0.375)+(-0.5)+(-0.375)+(-0.375)+(-0.375)+(-0.375)) ]",
+   "H(X) = -[ (-2.75) ]",
+   "H(X) = 2.75"],
+ @string="password">
+
+# Original string
+string_entropy.string
+=> "password"
+
+# String encoding, currently only supports ASCII_8BIT
+string_entropy.encoding
+=> "ASCII-8BIT"
+
+# The commonly described "entropy" of a string; Math.log2(total_possible_chars^string_length)
+string_entropy.entropy
+=> 52.55884486664758
+
+# Alias for .entropy method
+string_entropy.information_entropy
+=> 52.55884486664758
+
+# The Shannon entropy value
+string_entropy.shannon_entropy
+=> 2.75
+
+# The metric entropy value (Shannon entropy divided by string length)
+string_entropy.metric_entropy
+=> 0.34375
+
+# The count of each character
+string_entropy.count
+=> {
+    "p" => 1.0,
+    "a" => 1.0,
+    "s" => 2.0,
+    "w" => 1.0,
+    "o" => 1.0,
+    "r" => 1.0,
+    "d" => 1.0
+}
+
+# The frequency/percentage of each character
+string_entropy.frequency
+=> {
+    "p" => 0.125,
+    "a" => 0.125,
+    "s" => 0.25,
+    "w" => 0.125,
+    "o" => 0.125,
+    "r" => 0.125,
+    "d" => 0.125
+}
+
+# This is how the Shannon entropy is calculated
+string_entropy.shannon_formulas
+=> [
+    [0] "H(X) = -[ ((0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.25 * Math.log2(0.25))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))+(0.125 * Math.log2(0.125))) ]",
+    [1] "H(X) = -[ ((-0.375)+(-0.375)+(-0.5)+(-0.375)+(-0.375)+(-0.375)+(-0.375)) ]",
+    [2] "H(X) = -[ (-2.75) ]",
+    [3] "H(X) = 2.75"
+]
+```
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Credits
+
+Inspired by http://www.shannonentropy.netmark.pl.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anothermh/string_entropy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_entropy"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/string_entropy.rb

@@ -0,0 +1,16 @@
+require "string_entropy/error"
+require "string_entropy/info"
+require "string_entropy/version"
+require "string_entropy/string"
+
+module StringEntropy
+ 
+  def self.info(string)
+    StringEntropy::Info.new(string)
+  end
+
+  def self.example
+    StringEntropy::Info.new("password")
+  end
+
+end

data/lib/string_entropy/error.rb

@@ -0,0 +1,23 @@
+module StringEntropy
+
+  class Error < StandardError; end
+
+  class BadEncoding < Error
+    def initialize
+      super("The string could not be converted to ASCII_8BIT encoding")
+    end
+  end
+
+  class StringMismatch < Error
+    def initialize
+      super("The string contains invalid ASCII_8BIT characters (only character codes 32..126 are valid)")
+    end
+  end
+
+  class NilHasZeroEntropy < Error
+    def initialize
+      super("nil values cannot be evaluated as strings and have zero entropy")
+    end
+  end
+
+end

data/lib/string_entropy/info.rb

@@ -0,0 +1,64 @@
+module StringEntropy
+  class Info
+
+    attr_reader :string,
+                :encoding,
+                :count,
+                :frequency,
+                :information_entropy,
+                :shannon_entropy,
+                :metric_entropy
+
+    # The common defintion of "entropy" when working with strings
+    alias_method :entropy, :information_entropy
+
+    # Supports only ASCII_8BIT encoding
+    POSSIBLE_CHARS = 95.freeze
+
+    def initialize(string=nil)
+      @string    = ascii(string)
+      @count     = @string.split("").each.with_object(Hash.new(0.to_f)) { |char, hash| hash[char] += 1 }.freeze
+      @frequency = @count.each_with_object(Hash.new) { |(char,count),frequency| frequency[char] = (count / @string.length) }.freeze
+
+      @information_entropy = Math.log2(POSSIBLE_CHARS**@string.length).freeze
+      @shannon_entropy     = -(@frequency.values.map { |x| x * Math.log2(x) }.inject(:+)).freeze
+      @metric_entropy      = (@shannon_entropy / @string.length).freeze
+
+      @shannon_formulas    = shannon_formulas
+
+      self.freeze
+    end
+
+    # Show the math behind calculating Shannon Entropy as an array of the steps taken
+    def shannon_formulas
+      formulas = []
+      formulas << @frequency.values.map { |x| "(#{x} * Math.log2(#{x}))" }.join("+")
+      formulas << @frequency.values.map { |x| "(#{x * Math.log2(x)})" }.join("+")
+      formulas << "#{@frequency.values.map { |x| x * Math.log2(x) }.inject(:+)}"
+      formulas.map! { |x| "-[ (#{x}) ]" }
+      formulas << "#{@shannon_entropy}"
+      formulas.map! { |x| "H(X) = #{x}"}
+      formulas.freeze
+    end
+
+    private
+
+    def ascii(string)
+      raise NilHasZeroEntropy unless string
+
+      begin
+        ascii = string.encode(Encoding::ASCII_8BIT)
+      rescue Encoding::UndefinedConversionError
+        raise BadEncoding
+      end
+
+      safe_ascii = ascii.split("").select { |x| true if (32..126) === x.ord }.join("")
+      raise StringMismatch unless ascii == safe_ascii && ascii == string
+
+      @encoding = Encoding::ASCII_8BIT.name
+
+      safe_ascii.freeze
+    end
+
+  end
+end

data/lib/string_entropy/string.rb

@@ -0,0 +1,5 @@
+class String
+  def entropy
+    StringEntropy::Info.new(self).information_entropy
+  end
+end

data/lib/string_entropy/version.rb

@@ -0,0 +1,3 @@
+module StringEntropy
+  VERSION = "0.1.0"
+end

data/string_entropy.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string_entropy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_entropy"
+  spec.version       = StringEntropy::VERSION
+  spec.authors       = ["anothermh"]
+
+  spec.summary       = "Gets the entropy for a given string"
+  spec.description   = "Outputs a variety of information on the entropy of a given string"
+  spec.homepage      = "https://github.com/anothermh/string_entropy"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: string_entropy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- anothermh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: Outputs a variety of information on the entropy of a given string
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string_entropy.rb
+- lib/string_entropy/error.rb
+- lib/string_entropy/info.rb
+- lib/string_entropy/string.rb
+- lib/string_entropy/version.rb
+- string_entropy.gemspec
+homepage: https://github.com/anothermh/string_entropy
+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.1
+signing_key: 
+specification_version: 4
+summary: Gets the entropy for a given string
+test_files: []