maverick_vin_parser 1.0.0 → 1.1.0

data/bin/maverick_vin_parser

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'maverick_vin_parser'
+require 'json'
 
 if ARGV.length != 1
   puts 'usage: maverick_vin_parser VIN'
@@ -9,7 +10,7 @@ end
 
 
 begin
-  puts MaverickVinParser.new.parse(ARGV[0])
+  puts JSON.pretty_generate( MaverickVinParser.new.parse(ARGV[0]) )
 rescue MaverickVinParser::ArgumentError
   puts $!.message
 end

data/lib/maverick_vin_parser.rb

@@ -1,6 +1,8 @@
 require 'vin_constants'
 
-
+# This class implements parsing of Vehicle Identification Numbers (VINs)
+# for Ford Mavericks and Mercury Comets from 1970-77
+#
 class MaverickVinParser
 
   include VinConstants
@@ -14,6 +16,15 @@ class MaverickVinParser
     @regex_main = /([0-7])(#{plant_code_regex})(#{body_code_regex})(#{engine_code_regex})([0-9]{6})/
   end
 
+  #
+  # Parses the provided VIN
+  #
+  # @param vin [string] The VIN to be parsed
+  # @return [hash] data parsed from the VIN
+  # @raise MaverickVinParser::ArgumentError if the VIN is invalid
+  # @example
+  #   MaverickVinParser.new.parse('0X91U100647') #=> "{:year=>1970, :plant=>"St. Thomas", :body=>"Maverick 2-Door Sedan Standard", :engine=>"170ci 6-Cylinder 1 bbl", :unit_number=>100647}"
+  #
   def parse(vin)
     @regex_main.match(vin) do
       return {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maverick_vin_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -47,3 +47,4 @@ signing_key:
 specification_version: 3
 summary: VIN parser for Ford Mavericks
 test_files: []
+has_rdoc: