gorge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 571d1f13502e6d024792ccccfc30a1435853cffe
+  data.tar.gz: f99170a717884e083852bf6ff05d862013ca8415
+SHA512:
+  metadata.gz: ca907bd8db031a9f3f89f2ceb1e644faaace6403694022034461ee3c9bd8c20c19d993a2e69e6e1e9f00bead1703f86144979710b590164450b5a11211329495
+  data.tar.gz: 321cc40244782e13794c8bc55ba3e42be4f776ea2f9867a303897fe207db676959aaf7837285f9a0e47b93d60660b91b08ddb9481e69269bc7d4ca48f626736d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gorge.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonathan Hefner
+
+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,48 @@
+# gorge
+
+Convenient access to Ruby's Digest module via extensions to Ruby core
+objects.  *gorge* also provides an idiomatic `Digest::CRC32` wrapper
+over the CRC32 functionality provided by Ruby's built-in Zlib module.
+
+
+## API
+
+- [Digest](http://www.rubydoc.info/gems/gorge/Digest/Instance)
+  - [#io](http://www.rubydoc.info/gems/gorge/Digest%2FInstance:io)
+- [Digest::CRC32](http://www.rubydoc.info/gems/gorge/Digest/CRC32)
+- [Pathname](http://www.rubydoc.info/gems/gorge/Pathname)
+  - [#file_crc32](http://www.rubydoc.info/gems/gorge/Pathname:file_crc32)
+  - [#file_md5](http://www.rubydoc.info/gems/gorge/Pathname:file_md5)
+  - [#file_sha1](http://www.rubydoc.info/gems/gorge/Pathname:file_sha1)
+  - [#file_sha256](http://www.rubydoc.info/gems/gorge/Pathname:file_sha256)
+- [String](http://www.rubydoc.info/gems/gorge/String)
+  - [#crc32](http://www.rubydoc.info/gems/gorge/String:crc32)
+  - [#md5](http://www.rubydoc.info/gems/gorge/String:md5)
+  - [#sha1](http://www.rubydoc.info/gems/gorge/String:sha1)
+  - [#sha256](http://www.rubydoc.info/gems/gorge/String:sha256)
+
+
+## Installation
+
+Install from [Ruby Gems](https://rubygems.org/gems/gorge):
+
+```bash
+$ gem install gorge
+```
+
+Then require in your Ruby script:
+
+```ruby
+require "gorge"
+```
+
+
+## Contributing
+
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  require "gorge"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/gorge.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gorge/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gorge"
+  spec.version       = Gorge::VERSION
+  spec.authors       = ["Jonathan Hefner"]
+  spec.email         = ["jonathan.hefner@gmail.com"]
+
+  spec.summary       = %q{Convenient access to Ruby's Digest module}
+  spec.homepage      = "https://github.com/jonathanhefner/gorge"
+  spec.license       = "MIT"
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/gorge.rb

@@ -0,0 +1,7 @@
+require "digest"
+require "zlib" # for Zlib.crc32
+require_relative "gorge/version"
+require_relative "gorge/digest/crc32"
+require_relative "gorge/digest/instance"
+require_relative "gorge/pathname"
+require_relative "gorge/string"

data/lib/gorge/digest/crc32.rb

@@ -0,0 +1,47 @@
+class Digest::CRC32 < Digest::Class
+
+  def initialize
+    reset
+  end
+
+  # Returns the block length of the Digest.
+  #
+  # @return [Integer]
+  def block_length
+    1
+  end
+
+  # Returns the length in bytes of the hash value of the Digest.
+  #
+  # @return [Integer]
+  def digest_length
+    4
+  end
+
+  # Resets the Digest to its initial state, and returns the Digest
+  # modified.
+  #
+  # @return [self]
+  def reset
+    @crc32 = 0
+  end
+
+  # Updates the Digest using the given string, and returns the Digest
+  # modified.
+  #
+  # @return [self]
+  def update(string)
+    @crc32 = Zlib.crc32_combine(@crc32, Zlib.crc32(string), string.length)
+    self
+  end
+
+  alias :<< :update
+
+  # Returns the hash value of the Digest packed into a string.
+  #
+  # @return [String]
+  def finish
+    [@crc32].pack("N")
+  end
+
+end

data/lib/gorge/digest/instance.rb

@@ -0,0 +1,24 @@
+module Digest::Instance
+
+  # Updates the Digest using the entire contents of the given IO-like,
+  # and returns the Digest modified.  Seeks to the beginning of the
+  # IO-like before reading, and restores its initial position after
+  # reading.  See also +Digest::Instance#file+.
+  #
+  # @param io_like [IO, StringIO, IO-like]
+  # @return [self]
+  def io(io_like)
+    pos = io_like.pos # save position
+    io_like.seek(0)
+
+    buffer = ""
+    while io_like.read(16384, buffer)
+      self.update(buffer)
+    end
+
+    io_like.seek(pos) # restore position
+
+    self
+  end
+
+end

data/lib/gorge/pathname.rb

@@ -0,0 +1,37 @@
+require "pathname"
+
+class Pathname
+
+  # Returns the CRC32 checksum (in hexadecimal format) of the contents
+  # of the file indicated by the Pathname.
+  #
+  # @return [String]
+  def file_crc32
+    Digest::CRC32.file(self).hexdigest
+  end
+
+  # Returns the MD5 hash (in hexadecimal format) of the contents of the
+  # file indicated by the Pathname.
+  #
+  # @return [String]
+  def file_md5
+    Digest::MD5.file(self).hexdigest
+  end
+
+  # Returns the SHA1 hash (in hexadecimal format) of the contents of the
+  # file indicated by the Pathname.
+  #
+  # @return [String]
+  def file_sha1
+    Digest::SHA1.file(self).hexdigest
+  end
+
+  # Returns the SHA256 hash (in hexadecimal format) of the contents of
+  # the file indicated by the Pathname.
+  #
+  # @return [String]
+  def file_sha256
+    Digest::SHA256.file(self).hexdigest
+  end
+
+end

data/lib/gorge/string.rb

@@ -0,0 +1,31 @@
+class String
+
+  # Returns the CRC32 checksum (in hexadecimal format) of the String.
+  #
+  # @return [String]
+  def crc32
+    Digest::CRC32.hexdigest(self)
+  end
+
+  # Returns the MD5 hash (in hexadecimal format) of the String.
+  #
+  # @return [String]
+  def md5
+    Digest::MD5.hexdigest(self)
+  end
+
+  # Returns the SHA1 hash (in hexadecimal format) of the String.
+  #
+  # @return [String]
+  def sha1
+    Digest::SHA1.hexdigest(self)
+  end
+
+  # Returns the SHA256 hash (in hexadecimal format) of the String.
+  #
+  # @return [String]
+  def sha256
+    Digest::SHA256.hexdigest(self)
+  end
+
+end

data/lib/gorge/version.rb

@@ -0,0 +1,3 @@
+module Gorge
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gorge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gorge.gemspec
+- lib/gorge.rb
+- lib/gorge/digest/crc32.rb
+- lib/gorge/digest/instance.rb
+- lib/gorge/pathname.rb
+- lib/gorge/string.rb
+- lib/gorge/version.rb
+homepage: https://github.com/jonathanhefner/gorge
+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.8
+signing_key: 
+specification_version: 4
+summary: Convenient access to Ruby's Digest module
+test_files: []