digest-crc 0.3.0 → 0.4.0

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.4.0 / 2013-02-13
+
+* Added {Digest::CRC16QT}.
+
 ### 0.3.0 / 2011-09-24
 
 * Added {Digest::CRC81Wire} (Henry Garner).

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Hal Brodigan
+Copyright (c) 2010-2013 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 # Digest CRC
 
-* [Source](http://github.com/postmodern/digest-crc)
-* [Issues](http://github.com/postmodern/digest-crc/issues)
+* [Source](https://github.com/postmodern/digest-crc)
+* [Issues](https://github.com/postmodern/digest-crc/issues)
 * [Documentation](http://rubydoc.info/gems/digest-crc/frames)
 * [Email](mailto:postmodern.mod3 at gmail.com)
 
@@ -24,6 +24,7 @@ module.
   * {Digest::CRC16USB CRC16 USB}
   * {Digest::CRC16XModem CRC16 XModem}
   * {Digest::CRC16ZModem CRC16 ZModem}
+  * {Digest::CRC16QT CRC16 QT}
   * {Digest::CRC24 CRC24}
   * {Digest::CRC32 CRC32}
   * {Digest::CRC32c CRC32c}
@@ -72,6 +73,6 @@ including their CRC Tables.
 
 ## License
 
-Copyright (c) 2010-2011 Hal Brodigan
+Copyright (c) 2010-2013 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.4'
-  require 'ore/tasks'
+  gem 'rubygems-tasks', '~> 0.1'
+  require 'rubygems/tasks'
 
-  Ore::Tasks.new
+  Gem::Tasks.new
 rescue LoadError => e
   warn e.message
-  warn "Run `gem install ore-tasks` to install 'ore/tasks'."
+  warn "Run `gem install rubygems-tasks` to install 'rubygems/tasks'."
 end
 
 begin
@@ -25,7 +25,7 @@ task :test => :spec
 task :default => :spec
 
 begin
-  gem 'yard', '~> 0.6.0'
+  gem 'yard', '~> 0.8'
   require 'yard'
 
   YARD::Rake::YardocTask.new  

data/digest-crc.gemspec

@@ -2,126 +2,59 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  files = if File.directory?('.git')
-            `git ls-files`.split($/)
-          elsif File.directory?('.hg')
-            `hg manifest`.split($/)
-          elsif File.directory?('.svn')
-            `svn ls -R`.split($/).select { |path| File.file?(path) }
-          else
-            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-          end
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  filter_files = lambda { |paths|
-    case paths
-    when Array
-      (files & paths)
-    when String
-      (files & Dir[paths])
-    end
-  }
-
-  version = {
-    :file => 'lib/digest/crc/version.rb',
-    :constant => 'Digest::CRC::VERSION'
-  }
-
-  defaults = {
-    'name' => File.basename(File.dirname(__FILE__)),
-    'files' => files,
-    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
-    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
-  }
-
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
-
-  gemspec.name = metadata.fetch('name',defaults[:name])
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    elsif File.file?(version[:file])
-                      require File.join('.',version[:file])
-                      eval(version[:constant])
-                    end
-
-  gemspec.summary = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
-
-  case metadata['license']
-  when Array
-    gemspec.licenses = metadata['license']
-  when String
-    gemspec.license = metadata['license']
-  end
-
-  case metadata['authors']
-  when Array
-    gemspec.authors = metadata['authors']
-  when String
-    gemspec.author = metadata['authors']
-  end
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  gemspec.email = metadata['email']
-  gemspec.homepage = metadata['homepage']
+                  require 'digest/crc/version'
+                  Digest::Crc::VERSION
+                end
 
-  case metadata['require_paths']
-  when Array
-    gemspec.require_paths = metadata['require_paths']
-  when String
-    gemspec.require_path = metadata['require_paths']
-  end
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
 
-  gemspec.files = filter_files[metadata['files']]
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gemspec.executables = metadata['executables']
-  gemspec.extensions = metadata['extensions']
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-  if Gem::VERSION < '1.7.'
-    gemspec.default_executable = gemspec.executables.first
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  gemspec.test_files = filter_files[metadata['test_files']]
-
-  unless gemspec.files.include?('.document')
-    gemspec.extra_rdoc_files = metadata['extra_doc_files']
-  end
-
-  gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements = metadata['requirements']
-
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: digest-crc
-version: 0.3.0
+version: 0.4.0
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.
 description:
   Adds support for calculating Cyclic Redundancy Check (CRC) to the
@@ -8,10 +8,10 @@ description:
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: http://github.com/postmodern/digest-crc
+homepage: https://github.com/postmodern/digest-crc#readme
 has_yard: true
 
 development_dependencies:
-  ore-tasks: ~> 0.4
+  rubygems-tasks: ~> 0.2
   rspec: ~> 2.4
-  yard: ~> 0.6.0
+  yard: ~> 0.8

data/lib/digest/crc16_qt.rb

@@ -0,0 +1,65 @@
+require 'digest/crc16_ccitt'
+
+module Digest
+  #
+  # Implements the CRC16_CCITT algorithm used in QT algorithms.
+  #
+  # @author Matthew Bednarski
+  #
+  class CRC16QT < CRC16CCITT
+
+    FINAL_XOR = 0xffff
+
+    REVERSE_CRC_RESULT = true
+
+    REVERSE_DATA = true
+
+    # Updates the CRC16 checksum.
+    #
+    # @param [String] data
+    #   The data to update the checksum with.
+    #
+    def update(data)
+      data.each_byte do |b|
+        b = revert_byte(b) if REVERSE_DATA
+        @crc = ((TABLE[((@crc >> 8) ^ b) & 0xff] ^ (@crc << 8)) & 0xffff)
+      end
+
+      return self
+    end
+
+    def checksum
+      crc = @crc + 0
+      crc ^= FINAL_XOR      if FINAL_XOR
+      crc = revert_bits crc if REVERSE_CRC_RESULT
+      return crc
+    end
+
+    protected
+
+    def revert_bits(cc)
+      ob = 0
+      b  = (1 << 15)
+
+      16.times do |t|
+        ob |= (1 << t) if (cc & b) != 0
+        b >>= 1
+      end
+
+      return ob
+    end
+
+    def revert_byte(cc)
+      ob = 0
+      b  = (1 << 7)
+
+      8.times do |t|
+        ob |= (1 << t) if (cc & b) != 0
+        b >>= 1
+      end
+
+      return ob
+    end
+
+  end
+end

data/spec/crc16_qt_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'crc_examples'
+require 'digest/crc16_qt'
+
+describe Digest::CRC16QT do
+  let(:string)   { '1234567890' }
+  let(:expected) { '4b13' }
+
+  it_should_behave_like "CRC"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digest-crc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ore-tasks
-  requirement: &22462380 !ruby/object:Gem::Requirement
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.2'
   type: :development
   prerelease: false
-  version_requirements: *22462380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22461360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,18 +37,28 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *22461360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &22459440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *22459440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Adds support for calculating Cyclic Redundancy Check (CRC) to the Digest
   module.
 email: postmodern.mod3@gmail.com
@@ -70,6 +85,7 @@ files:
 - lib/digest/crc16_ccitt.rb
 - lib/digest/crc16_dnp.rb
 - lib/digest/crc16_modbus.rb
+- lib/digest/crc16_qt.rb
 - lib/digest/crc16_usb.rb
 - lib/digest/crc16_xmodem.rb
 - lib/digest/crc16_zmodem.rb
@@ -83,6 +99,7 @@ files:
 - lib/digest/crc8_1wire.rb
 - spec/crc16_ccitt_spec.rb
 - spec/crc16_modbus_spec.rb
+- spec/crc16_qt_spec.rb
 - spec/crc16_spec.rb
 - spec/crc16_usb_spec.rb
 - spec/crc16_xmodem_spec.rb
@@ -99,7 +116,7 @@ files:
 - spec/crc_examples.rb
 - spec/crc_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/postmodern/digest-crc
+homepage: https://github.com/postmodern/digest-crc#readme
 licenses:
 - MIT
 post_install_message: 
@@ -120,24 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Cyclic Redundancy Check (CRC) library for Ruby.
-test_files:
-- spec/crc16_ccitt_spec.rb
-- spec/crc16_modbus_spec.rb
-- spec/crc16_spec.rb
-- spec/crc16_usb_spec.rb
-- spec/crc16_xmodem_spec.rb
-- spec/crc16_zmodem_spec.rb
-- spec/crc1_spec.rb
-- spec/crc24_spec.rb
-- spec/crc32_mpeg_spec.rb
-- spec/crc32_spec.rb
-- spec/crc32c_spec.rb
-- spec/crc5_spec.rb
-- spec/crc64_spec.rb
-- spec/crc8_1wire_spec.rb
-- spec/crc8_spec.rb
-- spec/crc_spec.rb
+test_files: []