maxmind-db 1.0.0.beta → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0783d0fa6b13e4fa43dd70dd24c876452e1d5911a8de8296669bd4f806e38ec9'
-  data.tar.gz: 22720864310267dc946e90f1b6b7fb12ee506e2959414b7214539479401a24a6
+  metadata.gz: 604697b9d2de00a32fec3ee2b84c53703f532ecf708ca6cfcd4898fa934d830e
+  data.tar.gz: cdaeb5d99ca07f8c9f6af0354dc23fb3f8678a40e0ea67fe74b7b7dcaabc7ec5
 SHA512:
-  metadata.gz: 2705b919ec933748987b7495ce750361eb62643e8f5cf8ef142215af61c4f6f6b539cdec47976b58346cad0748241d362aee16f054a14a9986cdcee8c7c534ff
-  data.tar.gz: a7f994be60c64df42176ef98131433812a739eef6533fafde8a867eeb8e097b18127e276cb49eaf42d5d93f84ef807958b4f4cf84d5c6276b49fc56b0decd298
+  metadata.gz: 3939f3025d4a715537d6284ac49cfa691bf733711afd6143ec73e586aec96cbcf717115c340214903fd4a8bcc1c4b8c4973d0fa9517491b2c48c5d710cdc9e87
+  data.tar.gz: 54dbe0bebe152e151234b0b0026492d38a80858174c3342d12ff665026d858295b29434d3ea7c8ea56b3b7c669b0d2f921c018b7dba9c16aad996143f9c66ede

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 # Changelog
 
-## 0.0.1.pre - 2018-12-24
+## 1.0.0 - 2019-01-04
+* We no longer include the database's buffer in inspect output. This avoids
+  showing excessive output when creating a memory reader in irb. Reported
+  by Wojciech Wnętrzak. GitHub #6.
+
+## 1.0.0.beta - 2018-12-24
 * Initial implementation.

data/README.dev.md

@@ -2,12 +2,15 @@
 * Update changelog and set release date
 * Bump version in `maxmind-db.gemspec`
 * Commit: `git commit -m v1.0.0`
-* Push: `git push`
 * Tag: `git tag -a v1.0.0 -m v1.0.0`
-* Push tag: `git push --tags`
-* Create `.gem` file: `gem build maxmind-db.spec`
+* Clean up to be sure nothing stray gets into gem: `git clean -dxff`
+* Create `.gem` file: `gem build maxmind-db.gemspec`
 * Complete prerequisites (see below)
-* Upload to rubygems.org: `gem push <.gem>`
+* Upload to rubygems.org: `gem push maxmind-db-1.0.0.gem`
+* Push: `git push`
+* Push tag: `git push --tags`
+* Double check it looks okay at https://rubygems.org/gems/maxmind-db and
+  https://www.rubydoc.info/gems/maxmind-db
 
 
 # Prerequisites

data/README.md

@@ -6,6 +6,20 @@ This is the Ruby API for reading [MaxMind
 DB](https://maxmind.github.io/MaxMind-DB/) files. MaxMind DB is a binary
 file format that stores data indexed by IP address subnets (IPv4 or IPv6).
 
+
+## Installation
+
+```
+gem install maxmind-db
+```
+
+Or from source:
+
+```
+gem build maxmind-db.spec
+gem install ./maxmind-db-xxx.gem
+```
+
 ## Usage
 
 ```ruby
@@ -24,6 +38,9 @@ end
 reader.close
 ```
 
+For more information see the
+[documentation](https://www.rubydoc.info/gems/maxmind-db).
+
 ## Requirements
 
 This code requires Ruby version 2.3 or higher. Older versions may work, but
@@ -48,7 +65,7 @@ This library uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
-This software is Copyright (c) 2018 by MaxMind, Inc.
+This software is Copyright (c) 2018 - 2019 by MaxMind, Inc.
 
 This is free software, licensed under the [Apache License, Version
 2.0](LICENSE-APACHE) or the [MIT License](LICENSE-MIT), at your option.

data/bin/mmdb-benchmark.rb

@@ -22,7 +22,7 @@ def parse_args
 
   {
     database: database,
-    ip_file:  ip_file,
+    ip_file: ip_file,
   }
 end
 

data/lib/maxmind/db.rb

@@ -167,6 +167,7 @@ module MaxMind # :nodoc:
       node_count = @node_count
       bit_count.times do |i|
         break if node >= node_count
+
         c = packed[i >> 3].ord
         bit = 1 & (c >> 7 - (i % 8))
         node = read_node(node, bit)
@@ -187,6 +188,7 @@ module MaxMind # :nodoc:
       node = 0
       96.times do
         break if node >= @metadata.node_count
+
         node = read_node(node, 0)
       end
 
@@ -250,6 +252,7 @@ module MaxMind # :nodoc:
       index = @size - METADATA_START_MARKER_LENGTH
       while index >= stop_index
         return index + METADATA_START_MARKER_LENGTH if at_metadata?(index)
+
         index -= 1
       end
 

data/lib/maxmind/db/decoder.rb

@@ -58,6 +58,7 @@ module MaxMind # :nodoc:
 
       def verify_size(expected, actual)
         return if expected == actual
+
         raise InvalidDatabaseError,
               'The MaxMind DB file\'s data section contains bad data (unknown data type or corrupt data)'.freeze
       end
@@ -152,15 +153,15 @@ module MaxMind # :nodoc:
       end
 
       TYPE_DECODER = {
-        1  => :decode_pointer,
-        2  => :decode_utf8_string,
-        3  => :decode_double,
-        4  => :decode_bytes,
-        5  => :decode_uint16,
-        6  => :decode_uint32,
-        7  => :decode_map,
-        8  => :decode_int32,
-        9  => :decode_uint64,
+        1 => :decode_pointer,
+        2 => :decode_utf8_string,
+        3 => :decode_double,
+        4 => :decode_bytes,
+        5 => :decode_uint16,
+        6 => :decode_uint32,
+        7 => :decode_map,
+        8 => :decode_int32,
+        9 => :decode_uint64,
         10 => :decode_uint128,
         11 => :decode_array,
         14 => :decode_boolean,

data/lib/maxmind/db/memory_reader.rb

@@ -14,6 +14,12 @@ module MaxMind # :nodoc:
 
       attr_reader :size
 
+      # Override to not show @buf in inspect to avoid showing it in irb.
+      def inspect
+        s = "#<#{self.class.name}:0x#{self.class.object_id.to_s(16)} "
+        s << '@size=' << @size.inspect << '>'
+      end
+
       def close; end
 
       def read(offset, size)

data/maxmind-db.gemspec

@@ -3,17 +3,17 @@ Gem::Specification.new do |s|
   s.files       = Dir['**/*']
   s.name        = 'maxmind-db'
   s.summary     = 'A gem for reading MaxMind DB files.'
-  s.version     = '1.0.0.beta'
+  s.version     = '1.0.0'
 
   s.description = 'A gem for reading MaxMind DB files. MaxMind DB is a binary file format that stores data indexed by IP address subnets (IPv4 or IPv6).'
   s.email       = 'wstorey@maxmind.com'
   s.homepage    = 'https://github.com/maxmind/MaxMind-DB-Reader-ruby'
   s.licenses    = ['Apache-2.0', 'MIT']
   s.metadata = {
-    'bug_tracker_uri'   => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby/issues',
-    'changelog_uri'     => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby/issues',
+    'changelog_uri' => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/master/CHANGELOG.md',
     'documentation_uri' => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby',
-    'homepage_uri'      => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby',
-    'source_code_uri'   => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby',
+    'homepage_uri' => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby',
+    'source_code_uri' => 'https://github.com/maxmind/MaxMind-DB-Reader-ruby',
   }
 end

data/test/test_decoder.rb

@@ -96,15 +96,15 @@ class DecoderTest < Minitest::Test # :nodoc:
         'languages' => %w[en zh]
       },
       MMDBUtil.make_metadata_map(28) => {
-        'node_count'                  => 0,
-        'record_size'                 => 28,
-        'ip_version'                  => 4,
-        'database_type'               => 'test',
-        'languages'                   => ['en'],
+        'node_count' => 0,
+        'record_size' => 28,
+        'ip_version' => 4,
+        'database_type' => 'test',
+        'languages' => ['en'],
         'binary_format_major_version' => 2,
         'binary_format_minor_version' => 0,
-        'build_epoch'                 => 0,
-        'description'                 => 'hi',
+        'build_epoch' => 0,
+        'description' => 'hi',
       },
     }
     validate_type_decoding('maps', maps)

data/test/test_reader.rb

@@ -41,7 +41,7 @@ class ReaderTest < Minitest::Test # :nodoc:
     assert_equal(
       {
         'mapX' => {
-          'arrayX'       => [7, 8, 9],
+          'arrayX' => [7, 8, 9],
           'utf8_stringX' => 'hello',
         },
       },
@@ -111,7 +111,7 @@ class ReaderTest < Minitest::Test # :nodoc:
     e = assert_raises ArgumentError do
       reader.get('not_ip')
     end
-    assert_equal('invalid address', e.message)
+    assert(e.message.match(/invalid address/))
     reader.close
   end
 
@@ -270,28 +270,28 @@ class ReaderTest < Minitest::Test # :nodoc:
       {
         record_size: 24,
         # Left record + right record
-        node_bytes:  "\xab\xcd\xef".b + "\xbc\xfe\xfa".b,
-        left:        11_259_375,
-        right:       12_386_042,
-        check_left:  "\x00\xab\xcd\xef".b.unpack('N')[0],
+        node_bytes: "\xab\xcd\xef".b + "\xbc\xfe\xfa".b,
+        left: 11_259_375,
+        right: 12_386_042,
+        check_left: "\x00\xab\xcd\xef".b.unpack('N')[0],
         check_right: "\x00\xbc\xfe\xfa".b.unpack('N')[0],
       },
       {
         record_size: 28,
         # Left record (part) + middle byte + right record (part)
-        node_bytes:  "\xab\xcd\xef".b + "\x12".b + "\xfd\xdc\xfa".b,
-        left:        28_036_591,
-        right:       50_191_610,
-        check_left:  "\x01\xab\xcd\xef".b.unpack('N')[0],
+        node_bytes: "\xab\xcd\xef".b + "\x12".b + "\xfd\xdc\xfa".b,
+        left: 28_036_591,
+        right: 50_191_610,
+        check_left: "\x01\xab\xcd\xef".b.unpack('N')[0],
         check_right: "\x02\xfd\xdc\xfa".b.unpack('N')[0],
       },
       {
         record_size: 32,
         # Left record + right record
-        node_bytes:  "\xab\xcd\xef\x12".b + "\xfd\xdc\xfa\x15".b,
-        left:        2_882_400_018,
-        right:       4_259_117_589,
-        check_left:  "\xab\xcd\xef\x12".b.unpack('N')[0],
+        node_bytes: "\xab\xcd\xef\x12".b + "\xfd\xdc\xfa\x15".b,
+        left: 2_882_400_018,
+        right: 4_259_117_589,
+        check_left: "\xab\xcd\xef\x12".b.unpack('N')[0],
         check_right: "\xfd\xdc\xfa\x15".b.unpack('N')[0],
       },
     ]
@@ -350,10 +350,10 @@ class ReaderTest < Minitest::Test # :nodoc:
     end
 
     pairs = {
-      '1.1.1.3'  => '1.1.1.2',
-      '1.1.1.5'  => '1.1.1.4',
-      '1.1.1.7'  => '1.1.1.4',
-      '1.1.1.9'  => '1.1.1.8',
+      '1.1.1.3' => '1.1.1.2',
+      '1.1.1.5' => '1.1.1.4',
+      '1.1.1.7' => '1.1.1.4',
+      '1.1.1.9' => '1.1.1.8',
       '1.1.1.15' => '1.1.1.8',
       '1.1.1.17' => '1.1.1.16',
       '1.1.1.31' => '1.1.1.16',
@@ -388,7 +388,7 @@ class ReaderTest < Minitest::Test # :nodoc:
     end
 
     pairs = {
-      '::2:0:1'  => '::2:0:0',
+      '::2:0:1' => '::2:0:0',
       '::2:0:33' => '::2:0:0',
       '::2:0:39' => '::2:0:0',
       '::2:0:41' => '::2:0:40',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxmind-db
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta
+  version: 1.0.0
 platform: ruby
 authors:
 - William Storey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies: []
 description: A gem for reading MaxMind DB files. MaxMind DB is a binary file format
   that stores data indexed by IP address subnets (IPv4 or IPv6).
@@ -114,9 +114,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6