sipp 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b070afc9f31b4d758cffb81730c1cf2f66c8f77
-  data.tar.gz: 0172f9196c6f4207143e8c18a8b2dfa5d159f761
+  metadata.gz: 950a78c54189d24a5d4a9159c2c83d74647b867b
+  data.tar.gz: 3a25d2e6be0a30821d1473db85ae7b31048cd2af
 SHA512:
-  metadata.gz: 4f1dd007f766d6ec94dc27e07ee3f5115974a09547b4875bbe13f4625685234d378c34a9df427d25ac63e55895e64db9f0b880ed0a9631e8ea519b12c4ef5ee4
-  data.tar.gz: ad55e279ed148f69b247afe77300d7d75bfc216720677662a5676a0db9521e6b36eb9bdd75b735e3826a2d651faac05e929b8a2ac46b55eec9b2c370d4f9b6c1
+  metadata.gz: a12870aa3d1ee2edba06d09015d08a9b708ab23c61cbafc62293f253f8a4217f87af052b2a41aeb3ff415fe126237364e08580bdd01a67c0037ae4ec48c965f4
+  data.tar.gz: 87a73c7cd626016cb6e473584d3ca2c0ad04e564089c785b79d7cf58064b46fa5252eaf59051eab50931aacac4fc24179d448968ce5c820dcb4f6036dea02adb

data/Gemfile

@@ -5,4 +5,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in sipp.gemspec
 gemspec
 
-gem 'activesupport', '~> 4.1'
+gem 'i18n'
+

data/README.md

@@ -24,17 +24,138 @@ Or install it yourself as:
 code = SIPP::Code.new 'CCMN'
 code.to_s # "Compact - 2/4 Door - Manual Unspecified Drive - Unspecified Fuel/Power Without Air"
 
+code.category.to_s # Compact
+code.type.to_s # 2/4 Door
+code.transmission_drive.to_s # Manual Unspecified Drive
+code.transmission.to_s # Manual
+code.drive.to_s # Unspecified Drive
+code.transmission_manual? # true
+code.transmission_auto? # false
+code.fuel_ac.to_s # Unspecified Fuel/Power Without Air
+code.fuel.to_s # Unspecified Fuel/Power
+code.ac.to_s # No Air
 code.ac? # false
 ```
 If the code is invalid, it will return `nil` on all checks.
 
+If only some of the letters are valid, it will translate them:
+```ruby
+code = SIPP::Code.new '**DR'
+code.valid? # false
+code.to_s # #N/A - #N/A - Auto AWD - Unspecified Fuel/Power With Air
+```
+
 Calling `code.validate!` will throw validation errors with exceptions.
 
+### #as_json
+A convenient hash that lists car capabilities.
+```ruby
+ SIPP::Code.new('CCDD').as_json
+{
+      category: :compact,
+          type: :two_four_door,
+  transmission: :auto,
+         drive: :awd,
+          fuel: :diesel,
+            ac: :air,
+          code: "CCDD"
+}
+
+```
+
+## I18n
+
+**NOTE**: a simpler version without i18n is kept in `v.1.4`, you can use it as `gem 'sipp', git: 'https://github.com/austerlitz/sipp.git', tag: 'v1.4'`
+
+For more flexibility methods like `category`, `drive` etc. return a simple 
+Wrapper object to provide either symbol or an i18n-sed string. 
+Thus, when `#to_s` is implied, it will return a translated message. 
+For use in code or elsewhere, use `#to_sym`:
+```ruby
+if :diesel == code.fuel.to_sym
+  puts 'This car has a diesel engine'
+end
+```
+
+_This seems to be not an elegant solution. If you have any ideas on improving it, please make a pull request._
+
+
+You can override existing or add your own translations an put them under the 
+`sipp` scope:
+```yaml
+ua:
+  sipp:
+    category:
+      mini: міні
+    type:
+      convertible: кабріолет
+    transmission:
+      manual: МКПП
+      auto: АКПП      
+```
+## Inverted
+_A very early beta. But beta than nothin'_
+
+It's also able to generate a SIPP code from car capabilities. 
+The capabilities are expected in the same format as produced by `#as_json`.
+If something invalid is supplied it generates `'*'`.
+
+```ruby
+SIPP::Inverted.generate({ category: :compact, type: :two_four_door, transmission: :manual, drive: :unspecified, fuel: :petrol, ac: :air})
+# => 'CCMV'
+SIPP::Inverted.generate({ category: :compact, type: :two_four_door, fuel: :petrol, ac: :air })
+# => 'CC*V'
+```
+
+## Extended
+
+Works most similar to Inverted but produces a more consistent approach to encoding car capabilities.
+
+Generates an Extended-SIPP code from capabilities provided and translates capabilities list into an Extended-SIPP code.
+
+Should be tried and discussed.
+
+```ruby
+SIPP::Extended.new('CCMFDA55').as_json
+
+{
+        category:     :compact,
+        type:         :two_four_door,
+        transmission: :manual,
+        drive:        :front,
+        fuel:         :diesel,
+        ac:           :air,
+        doors:        5,
+        seats:        5,
+        bags_big:     :unspecified,
+        bags_small:   :unspecified,
+}
+
+SIPP::Extended.new('CBMFPN2234').as_json
+{
+        category:     :compact,
+        type:         :two_three_door,
+        transmission: :manual,
+        drive:        :front,
+        fuel:         :petrol,
+        ac:           :no_air,
+        doors:        2,
+        seats:        2,
+        bags_big:     3,
+        bags_small:   4,
+}
+
+```
+
 ## TODO
-- add pseudo codes
-- add van codes
-- add i18n helpers or redo strings into symbols to be i18n-ised
-- add query methods for common checks (like `.diesel?` etc)
+- [x] add i18n helpers or redo strings into symbols to be i18n-sed
+- [x] add SIPP code generation from car capabilities
+  - [ ] add input validation of some kind?
+- [x] add Extended SIPP codes
+  - [ ] add more adequate tests
+- [ ] add query methods for common checks (like `.diesel?` etc)
+- [ ] add pseudo codes
+- [ ] add van codes
 
 
 ## Development

data/bin/console

@@ -7,8 +7,8 @@ require "sipp"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+require "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/config/locales/en.yml

@@ -0,0 +1,104 @@
+en:
+  sipp:
+    category:
+      mini: Mini
+      mini_elite: Mini Elite
+      economy: Economy
+      economy_elite: Economy Elite
+      compact: Compact
+      compact_elite: Compact Elite
+      intermediate: Intermediate
+      intermediate_elite: Intermediate Elite
+      standard: Standard
+      standard_elite: Standard Elite
+      fullsize: Fullsize
+      fullsize_elite: Fullsize Elite
+      premium: Premium
+      premium_elite: Premium Elite
+      luxury: Luxury
+      luxury_elite: Luxury Elite
+      oversize: Oversize
+      special: Special
+
+    type:
+      two_three_door: 2-3 Door
+      two_four_door: 2/4 Door
+      four_five_door: 4-5 Door
+      wagon_estate: Wagon/Estate
+      passenger_van: Passenger Van
+      limousine_sedan: Limousine/Sedan
+      sport: Sport
+      convertible: Convertible
+      suv: SUV
+      open_air_all_terrain: Open Air All Terrain
+      special: Special
+      pick_up_2_door: Pick up (single/extended cab) 2 door
+      pick_up_4_door: Pick up (double cab) 4 door
+      special_offer_car: Special Offer Car
+      coupe: Coupe
+      monospace: Monospace
+      recreational_vehicle: Recreational Vehicle
+      motor_home: Motor Home
+      two_wheel_vehicle: 2 Wheel Vehicle
+      roadster: Roadster
+      crossover: Crossover
+      commercial: Commercial Van/Truck
+
+    transmission_drive:
+      manual_unspecified_drive: Manual Unspecified Drive
+      manual_4wd: Manual 4WD
+      manual_awd: Manual AWD
+      auto_unspecified_drive: Auto Unspecified Drive
+      auto_4wd: Auto 4WD
+      auto_awd: Auto AWD
+
+    transmission:
+      manual: Manual
+      auto: Auto
+      robot: Robot
+
+    drive:
+      unspecified: Unspecified
+      four_wd: 4WD
+      awd: AWD
+      single: Single
+      front: Front
+      rear: Rear
+
+    fuel_ac:
+      unspecified_air: Unspecified Fuel/Power With Air
+      unspecified_no_air: Unspecified Fuel/Power Without Air
+      diesel_air: Diesel Air
+      diesel_no_air: Diesel No Air
+      hybrid_air: Hybrid Air
+      hybrid_plug_in_air: Hybrid Plug in Air
+      electric_air: Electric (Distance < 250mi/400km) Air
+      electric_plus_air: Electric Plus (Distance ≥ 250mi/400km) Air
+      compressed_gas_air: LPG/Compressed Gas Air
+      compressed_gas_no_air: LPG/Compressed Gas No Air
+      hydrogen_air: Hydrogen Air
+      hydrogen_no_air: Hydrogen No Air
+      multi_fuel_air: Multi Fuel/Power Air
+      multi_fuel_no_air: Multi fuel/power No Air
+      petrol_air: Petrol Air
+      petrol_no_air: Petrol No Air
+      ethanol_air: Ethanol Air
+      ethanol_no_air: Ethanol No Air
+
+    fuel:
+      unspecified: Unspecified Fuel/Power
+      diesel: Diesel
+      hybrid: Hybrid
+      hybrid_plug_in: Hybrid Plug in
+      electric: Electric (Distance < 250mi/400km)
+      electric_plus: Electric Plus (Distance ≥ 250mi/400km)
+      compressed_gas: LPG/Compressed Gas
+      hydrogen: Hydrogen
+      multi_fuel: Multi fuel/power
+      petrol: Petrol
+      ethanol: Ethanol
+
+    ac:
+      air: Air
+      no_air: No Air
+

data/config/locales/ru.yml

@@ -0,0 +1,104 @@
+ru:
+  sipp:
+    category:
+      mini: мини
+      mini_elite: мини элит
+      economy: эконом
+      economy_elite: эконом элит
+      compact: компакт
+      compact_elite: компакт элит
+      intermediate: средний
+      intermediate_elite: средний элит
+      standard: стандартный
+      standard_elite: стандартный элит
+      fullsize: полноразмерный
+      fullsize_elite: полноразмерный элит
+      premium: премиум
+      premium_elite: premium элит
+      luxury: люкс
+      luxury_elite: люкс элит
+      oversize: оверсайз
+      special: специальный
+
+    type:
+      two_three_door: 2-3 двери
+      two_four_door: 2/4 двери
+      four_five_door: 4-5 двери
+      wagon_estate: универсал
+      passenger_van: пассажирский фургон
+      limousine_sedan: седан
+      sport: спорт
+      convertible: кабриолет
+      suv: SUV
+      open_air_all_terrain: внедорожник
+      special: специального назначения
+      pick_up_2_door: двухдверный пикап
+      pick_up_4_door: четырехдверный пикап
+      special_offer_car: автомобиль спецпредложения
+      coupe: купе
+      monospace: однообъемник
+      recreational_vehicle: автомобиль для отдыха
+      motor_home: дом на колесах
+      two_wheel_vehicle: двухколесное транспортное средство
+      roadster: родстер
+      crossover: кроссовер
+      commercial: коммерческий фургон
+
+    transmission_drive:
+      manual_unspecified_drive: МКПП, привод не указан
+      manual_4wd: МКПП, 4WD
+      manual_awd: МКПП, AWD
+      auto_unspecified_drive: АКПП, привод не указан
+      auto_4wd: АКПП, 4WD
+      auto_awd: АКПП, AWD
+
+    transmission:
+      manual: МКПП
+      auto: АКПП
+      robot: Робот
+
+    drive:
+      unspecified: привод не указан
+      four_wd: 4WD
+      awd: AWD
+      single: Монопривод
+      front: Передний
+      rear: Задний
+
+    fuel_ac:
+      unspecified_air: топливо не указано, кондиционер
+      unspecified_no_air: топливо не указано, без кондиционера
+      diesel_air: дизель, кондиционер
+      diesel_no_air: дизель, без кондиционера
+      hybrid_air: гибрид, кондиционер
+      hybrid_plug_in_air: гибрид с подзарядкой, кондиционер
+      electric_air: электрический (до  250 миль/400 км), кондиционер
+      electric_plus_air: электрический плюс (от 250 миль/400 км), кондиционер
+      compressed_gas_air: сжиженный газ, кондиционер
+      compressed_gas_no_air: сжиженный газ, без кондиционера
+      hydrogen_air: водород, кондиционер
+      hydrogen_no_air: водород, без кондиционера
+      multi_fuel_air: мультитопливный, кондиционер
+      multi_fuel_no_air: мультитопливный, без кондиционера
+      petrol_air: бензин, кондиционер
+      petrol_no_air: бензин, без кондиционера
+      ethanol_air: спирт, кондиционер
+      ethanol_no_air: спирт, без кондиционера
+
+    fuel:
+      unspecified: топливо не указано
+      diesel: дизель
+      hybrid: гибрид
+      hybrid_plug_in: гибрид с подзарядкой
+      electric: электрический (до  250 миль/400 км)
+      electric_plus: электрический плюс (от 250 миль/400 км)
+      compressed_gas: сжиженный газ
+      hydrogen: водород
+      multi_fuel: мультитопливный
+      petrol: бензин
+      ethanol: спирт
+
+    ac:
+      air: кондиционер
+      no_air: без кондиционера
+

data/lib/sipp/code.rb

@@ -1,4 +1,5 @@
 require 'sipp/dictionary'
+require 'sipp/localiser'
 
 module SIPP
   class Code
@@ -27,91 +28,97 @@ module SIPP
 
     def category
       validate_category
-      CATEGORY[code[0]]
+      Category.new CATEGORY[code[0]]
     rescue CategoryError => e
       nil
     end
 
     def type
       validate_type
-      TYPE[code[1]]
+      Type.new TYPE[code[1]]
     rescue TypeError => e
       nil
     end
 
     def transmission_drive
       validate_transmission_drive
-      TRANSMISSION_DRIVE[code[2]]
+      TransmissionDrive.new TRANSMISSION_DRIVE[code[2]]
     rescue TransmissionDriveError => e
       nil
     end
 
     def transmission
       validate_transmission_drive
-      TRANSMISSION[code[2]]
+      Transmission.new TRANSMISSION[code[2]]
     rescue TransmissionDriveError => e
       nil
     end
 
     def transmission_manual?
       validate_transmission_drive
-      'Manual' == transmission ? true : false # TODO fix magic string
+      :manual == transmission.to_sym ? true : false
     rescue TransmissionDriveError => e
       nil
     end
 
     def transmission_auto?
       validate_transmission_drive
-      'Auto' == transmission ? true : false # TODO fix magic string
+      :auto == transmission.to_sym ? true : false
     rescue TransmissionDriveError => e
       nil
     end
 
     def drive
       validate_transmission_drive
-      DRIVE[code[2]]
+      Drive.new DRIVE[code[2]]
     rescue TransmissionDriveError => e
       nil
     end
 
     def fuel_ac
       validate_fuel_ac
-      FUEL_AC[code[3]]
+      FuelAC.new FUEL_AC[code[3]]
     rescue FuelACError => e
       nil
     end
 
     def fuel
       validate_fuel_ac
-      FUEL[code[3]]
+      Fuel.new FUEL[code[3]]
     rescue FuelACError => e
       nil
     end
 
     def ac
       validate_fuel_ac
-      AC[code[3]]
+      Ac.new AC[code[3]]
     rescue FuelACError => e
       nil
     end
 
     def ac?
       validate_fuel_ac
-      'Air' == ac ? true : false # TODO fix magic string
+      :air == ac.to_sym ? true : false
     rescue FuelACError => e
       nil
     end
 
+    SEPARATOR = ' - '
+
     def to_s
-      [category, type, transmission_drive, fuel_ac].map{|c| c.nil? ? '#N/A' : c}.join(' - ')
+      [category, type, transmission_drive, fuel_ac].map{|c| c.nil? ? '#N/A' : c}.join(SEPARATOR)
     rescue CodeError, CategoryError, TypeError, TransmissionDriveError, FuelACError
       ''
     end
 
+    def as_json(options = nil)
+      [category, type, transmission, drive, fuel, ac].compact.map(&:as_json).inject(&:merge).merge({code: @code})
+    end
+
     private
 
     def validate_code
-      if @code.blank? || 4 != @code.length
+      if !@code || @code.empty? || 4 != @code.length
         raise CodeError, :invalid_code
       else
         true
@@ -119,7 +126,7 @@ module SIPP
     end
 
     def validate_category
-      if @code[0].blank? || !CATEGORY.keys.include?(@code[0])
+      if !@code[0] || @code[0].empty? || !CATEGORY.keys.include?(@code[0])
         raise CategoryError, :invalid_category
       else
         true
@@ -127,7 +134,7 @@ module SIPP
     end
 
     def validate_type
-      if @code[1].blank? || !TYPE.keys.include?(@code[1])
+      if !@code[1] || @code[1].empty? || !TYPE.keys.include?(@code[1])
         raise TypeError, :invalid_type
       else
         true
@@ -135,7 +142,7 @@ module SIPP
     end
 
     def validate_transmission_drive
-      if @code[2].blank? || !TRANSMISSION_DRIVE.keys.include?(@code[2])
+      if !@code[2] || @code[2].empty? || !TRANSMISSION_DRIVE.keys.include?(@code[2])
         raise TransmissionDriveError, :invalid_transmission_drive
       else
         true
@@ -143,7 +150,7 @@ module SIPP
     end
 
     def validate_fuel_ac
-      if @code[3].blank? || !FUEL_AC.keys.include?(@code[3])
+      if !@code[3] || @code[3].empty? || !FUEL_AC.keys.include?(@code[3])
         raise FuelACError, :invalid_fuel_ac
       else
         true

data/lib/sipp/dictionary.rb

@@ -1,138 +1,138 @@
 module SIPP
   module Dictionary
     CATEGORY = {
-      'M' => 'Mini',
-      'N' => 'Mini Elite',
-      'E' => 'Economy',
-      'H' => 'Economy Elite',
-      'C' => 'Compact',
-      'D' => 'Compact Elite',
-      'I' => 'Intermediate',
-      'J' => 'Intermediate Elite',
-      'S' => 'Standard',
-      'R' => 'Standard Elite',
-      'F' => 'Fullsize',
-      'G' => 'Fullsize Elite',
-      'P' => 'Premium',
-      'U' => 'Premium Elite',
-      'L' => 'Luxury',
-      'W' => 'Luxury Elite',
-      'O' => 'Oversize',
-      'X' => 'Special',
+      'M' => :mini,
+      'N' => :mini_elite,
+      'E' => :economy,
+      'H' => :economy_elite,
+      'C' => :compact,
+      'D' => :compact_elite,
+      'I' => :intermediate,
+      'J' => :intermediate_elite,
+      'S' => :standard,
+      'R' => :standard_elite,
+      'F' => :fullsize,
+      'G' => :fullsize_elite,
+      'P' => :premium,
+      'U' => :premium_elite,
+      'L' => :luxury,
+      'W' => :luxury_elite,
+      'O' => :oversize,
+      'X' => :special,
     }
 
     TYPE = {
-      'B' => '2-3 Door',
-      'C' => '2/4 Door',
-      'D' => '4-5 Door',
-      'W' => 'Wagon/Estate',
-      'V' => 'Passenger Van',
-      'L' => 'Limousine/Sedan',
-      'S' => 'Sport',
-      'T' => 'Convertible',
-      'F' => 'SUV',
-      'J' => 'Open Air All Terrain',
-      'X' => 'Special',
-      'P' => 'Pick up (single/extended cab) 2 door',
-      'Q' => 'Pick up (double cab) 4 door',
-      'Z' => 'Special Offer Car',
-      'E' => 'Coupe',
-      'M' => 'Monospace',
-      'R' => 'Recreational Vehicle',
-      'H' => 'Motor Home',
-      'Y' => '2 Wheel Vehicle',
-      'N' => 'Roadster',
-      'G' => 'Crossover',
-      'K' => 'Commercial Van/Truck',
+      'B' => :two_three_door,
+      'C' => :two_four_door,
+      'D' => :four_five_door,
+      'W' => :wagon_estate,
+      'V' => :passenger_van,
+      'L' => :limousine_sedan,
+      'S' => :sport,
+      'T' => :convertible,
+      'F' => :suv,
+      'J' => :open_air_all_terrain,
+      'X' => :special,
+      'P' => :pick_up_2_door,
+      'Q' => :pick_up_4_door,
+      'Z' => :special_offer_car,
+      'E' => :coupe,
+      'M' => :monospace,
+      'R' => :recreational_vehicle,
+      'H' => :motor_home,
+      'Y' => :two_wheel_vehicle,
+      'N' => :roadster,
+      'G' => :crossover,
+      'K' => :commercial,
     }
 
     TRANSMISSION_DRIVE = {
-      'M' => 'Manual Unspecified Drive',
-      'N' => 'Manual 4WD',
-      'C' => 'Manual AWD',
-      'A' => 'Auto Unspecified Drive',
-      'B' => 'Auto 4WD',
-      'D' => 'Auto AWD',
+      'M' => :manual_unspecified_drive,
+      'N' => :manual_4wd,
+      'C' => :manual_awd,
+      'A' => :auto_unspecified_drive,
+      'B' => :auto_4wd,
+      'D' => :auto_awd,
     }
-    TRANSMISSION = {
-      'M' => 'Manual',
-      'N' => 'Manual',
-      'C' => 'Manual',
-      'A' => 'Auto',
-      'B' => 'Auto',
-      'D' => 'Auto',
+    TRANSMISSION       = {
+      'M' => :manual,
+      'N' => :manual,
+      'C' => :manual,
+      'A' => :auto,
+      'B' => :auto,
+      'D' => :auto,
     }
 
     DRIVE = {
-      'M' => 'Unspecified',
-      'N' => '4WD',
-      'C' => 'AWD',
-      'A' => 'Unspecified',
-      'B' => '4WD',
-      'D' => 'AWD',
+      'M' => :unspecified,
+      'N' => :four_wd,
+      'C' => :awd,
+      'A' => :unspecified,
+      'B' => :four_wd,
+      'D' => :awd,
     }
 
     FUEL_AC = {
-      'R' => 'Unspecified Fuel/Power With Air',
-      'N' => 'Unspecified Fuel/Power Without Air',
-      'D' => 'Diesel Air',
-      'Q' => 'Diesel No Air',
-      'H' => 'Hybrid Air',
-      'I' => 'Hybrid Plug in Air',
-      'E' => 'Electric (Distance < 250mi/400km) Air',
-      'C' => 'Electric Plus (Distance ≥ 250mi/400km) Air',
-      'L' => 'LPG/Compressed Gas Air',
-      'S' => 'LPG/Compressed Gas No Air',
-      'A' => 'Hydrogen Air',
-      'B' => 'Hydrogen No Air',
-      'M' => 'Multi Fuel/Power Air',
-      'F' => 'Multi fuel/power No Air',
-      'V' => 'Petrol Air',
-      'Z' => 'Petrol No Air',
-      'U' => 'Ethanol Air',
-      'X' => 'Ethanol No Air',
+      'R' => :unspecified_air,
+      'N' => :unspecified_no_air,
+      'D' => :diesel_air,
+      'Q' => :diesel_no_air,
+      'H' => :hybrid_air,
+      'I' => :hybrid_plug_in_air,
+      'E' => :electric_air,
+      'C' => :electric_plus_air,
+      'L' => :compressed_gas_air,
+      'S' => :compressed_gas_no_air,
+      'A' => :hydrogen_air,
+      'B' => :hydrogen_no_air,
+      'M' => :multi_fuel_air,
+      'F' => :multi_fuel_no_air,
+      'V' => :petrol_air,
+      'Z' => :petrol_no_air,
+      'U' => :ethanol_air,
+      'X' => :ethanol_no_air
     }
 
     FUEL = {
-      'R' => 'Unspecified Fuel/Power',
-      'N' => 'Unspecified Fuel/Power',
-      'D' => 'Diesel',
-      'Q' => 'Diesel',
-      'H' => 'Hybrid',
-      'I' => 'Hybrid Plug in',
-      'E' => 'Electric (Distance < 250mi/400km)',
-      'C' => 'Electric Plus (Distance ≥ 250mi/400km)',
-      'L' => 'LPG/Compressed Gas',
-      'S' => 'LPG/Compressed Gas',
-      'A' => 'Hydrogen',
-      'B' => 'Hydrogen',
-      'M' => 'Multi Fuel/Power',
-      'F' => 'Multi fuel/power',
-      'V' => 'Petrol',
-      'Z' => 'Petrol',
-      'U' => 'Ethanol',
-      'X' => 'Ethanol',
+      'R' => :unspecified,
+      'N' => :unspecified,
+      'D' => :diesel,
+      'Q' => :diesel,
+      'H' => :hybrid,
+      'I' => :hybrid_plug_in,
+      'E' => :electric,
+      'C' => :electric_plus,
+      'L' => :compressed_gas,
+      'S' => :compressed_gas,
+      'A' => :hydrogen,
+      'B' => :hydrogen,
+      'M' => :multi_fuel,
+      'F' => :multi_fuel,
+      'V' => :petrol,
+      'Z' => :petrol,
+      'U' => :ethanol,
+      'X' => :ethanol
     }
 
     AC = {
-      'R' => 'Air',
-      'N' => 'No Air',
-      'D' => 'Air',
-      'Q' => 'No Air',
-      'H' => 'Air',
-      'I' => 'Air',
-      'E' => 'Air',
-      'C' => 'Air',
-      'L' => 'Air',
-      'S' => 'No Air',
-      'A' => 'Air',
-      'B' => 'No Air',
-      'M' => 'Air',
-      'F' => 'No Air',
-      'V' => 'Air',
-      'Z' => 'No Air',
-      'U' => 'Air',
-      'X' => 'No Air',
+      'R' => :air,
+      'N' => :no_air,
+      'D' => :air,
+      'Q' => :no_air,
+      'H' => :air,
+      'I' => :air,
+      'E' => :air,
+      'C' => :air,
+      'L' => :air,
+      'S' => :no_air,
+      'A' => :air,
+      'B' => :no_air,
+      'M' => :air,
+      'F' => :no_air,
+      'V' => :air,
+      'Z' => :no_air,
+      'U' => :air,
+      'X' => :no_air
     }
   end
 end

data/lib/sipp/engine.rb

@@ -0,0 +1,8 @@
+module SIPP
+  class Engine < ::Rails::Engine
+    isolate_namespace SIPP
+    initializer 'SIPP', before: :load_config_initializers do
+      Rails.application.config.i18n.load_path += Dir["#{config.root}/config/locales/**/*.yml"]
+    end
+  end
+end

data/lib/sipp/extended.rb

@@ -0,0 +1,109 @@
+require 'sipp/extended_dictionary'
+module SIPP
+
+  class Extended
+    include ExtendedDictionary
+
+      def self.generate(capabilities)
+        category = CATEGORY[capabilities[:category]]
+        type = TYPE[capabilities[:type]]
+        transmission = TRANSMISSION[capabilities[:transmission]]
+        drive = DRIVE[capabilities[:drive]]
+        fuel = FUEL[capabilities[:fuel]]
+        ac = AC[capabilities[:ac]]
+        capabilities[:bags_big] = capabilities.delete(:bags) unless capabilities[:bags].nil?
+        %i[doors seats bags_big bags_small].each do |cap|
+          capabilities[cap] = nil if :unspecified == capabilities[cap]
+        end
+
+        [
+          category, type, transmission, drive, fuel, ac,
+          capabilities[:doors],
+          capabilities[:seats],
+          (capabilities[:bags_big] || capabilities[:bags]),
+          capabilities[:bags_small],
+        ].map{|cap| cap || '*'}.join
+      end
+
+
+    attr_reader :code
+    def initialize(code = nil)
+      @code = code.to_s.strip.upcase
+                  .ljust(10, '*') # pad everything absent as :unspecified
+    end
+
+
+
+    def category
+      Category.new CATEGORY.invert[code[0]]
+    end
+
+    def type
+      Type.new TYPE.invert[code[1]]
+    end
+
+    def transmission
+      Transmission.new TRANSMISSION.invert[code[2]]
+    end
+    def drive
+      Drive.new DRIVE.invert[code[3]]
+    end
+    def fuel
+      Fuel.new FUEL.invert[code[4]]
+    end
+    def ac
+      Ac.new AC.invert[code[5]]
+    end
+    def doors
+      result = code[6]&.to_i
+      if result.zero?
+        :unspecified
+      else
+        result
+      end
+    end
+    def seats
+      result = code[7]&.to_i
+      if result.zero?
+        :unspecified
+      else
+        result
+      end
+    end
+    def bags
+      result = code[8]&.to_i
+      if result.zero?
+        :unspecified
+      else
+        result
+      end
+    end
+    alias_method :bags_big, :bags
+    def bags_small
+      result = code[9]&.to_i
+      if result.zero?
+        :unspecified
+      else
+        result
+      end
+    end
+
+    def to_s
+      [
+        category, type, transmission, drive, fuel, ac,
+        doors, seats, bags_big, bags_small,
+      ].join(Code::SEPARATOR)
+    end
+
+    def as_json(options = nil)
+
+      [category, type, transmission, drive, fuel, ac].compact.map(&:as_json).inject(&:merge).merge(
+        {
+          doors: doors,
+          seats: seats,
+          bags_big: bags,
+          bags_small: bags_small
+        })
+    end
+  end
+end

data/lib/sipp/extended_dictionary.rb

@@ -0,0 +1,57 @@
+module SIPP
+  WILDCARDS = {
+    nil          => '*',
+    :unspecified => '*',
+  }
+  module ExtendedDictionary
+    # SIPP-compatible category
+    CATEGORY = SIPP::Code::CATEGORY.invert.merge(WILDCARDS)
+
+    # SIPP-compatible body type
+    TYPE = SIPP::Code::TYPE.invert.merge(WILDCARDS)
+
+    # Transmission type. SIPP-compatible but extended with robot/tiptronic (I wonder if anyone needs it)
+    TRANSMISSION = {
+      manual: 'M',
+      auto:   'A',
+      robot:  'R', # variations of robot/tiptronic etc
+    }.merge(WILDCARDS)
+
+    # Drive type. Incompatible with SIPP because the original SIPP is completely weird and more transmission-oriented
+    DRIVE = {
+      single: 'S',
+      front:  'F',
+      rear:   'R',
+      all:    'A', # AWD
+      fwd: 'X', # 4x4
+    }.merge(WILDCARDS)
+
+    # Fuel type. Mostly compatible with SIPP but you know... Made more human-guessable
+    FUEL = {
+      compressed_gas: "G",
+      diesel:         "D",
+      electric:       "E",
+      electric_plus:  "C",
+      ethanol:        "U",
+      hybrid:         "H",
+      hybrid_plug_in: "I",
+      hydrogen:       "A",
+      multi_fuel:     "M",
+      petrol:         "P",
+    }.merge(WILDCARDS)
+
+    # Most probably is subject to change in the future
+    # Surprisingly is compatible with SIPP
+    AC = {
+      multi_zone: 'M',
+      present:    'A',
+      absent:     'N',
+      false       => 'N',
+      true        => 'A',
+      air:        'A',
+      no_air:     'N',
+    }.merge(WILDCARDS)
+
+  end
+end
+

data/lib/sipp/inverted.rb

@@ -0,0 +1,15 @@
+require 'sipp/inverted_dictionary'
+module SIPP
+  class Inverted
+    include InvertedDictionary
+
+      def self.generate(capabilities)
+        category = CATEGORY[capabilities[:category]]
+        type = TYPE[capabilities[:type]]
+        transmission_drive = TRANSMISSION_DRIVE[[capabilities[:transmission], (capabilities[:drive] || :unspecified)]]
+        fuel_ac = FUEL_AC[[(capabilities[:fuel] || :unspecified), capabilities[:ac]]]
+
+        [category, type, transmission_drive, fuel_ac].map{|cap| cap || '*'}.join
+      end
+  end
+end

data/lib/sipp/inverted_dictionary.rb

@@ -0,0 +1,38 @@
+module SIPP
+  module InvertedDictionary
+    CATEGORY = SIPP::Code::CATEGORY.invert
+
+    TYPE = SIPP::Code::TYPE.invert
+
+    TRANSMISSION_DRIVE = {
+      [:manual, :unspecified] => "M",
+      [:manual, :four_wd]     => "N",
+      [:manual, :awd]         => "C",
+      [:auto, :unspecified]   => "A",
+      [:auto, :four_wd]       => "B",
+      [:auto, :awd]           => "D"
+    }
+
+    FUEL_AC = {
+      [:unspecified, :air]       => "R",
+      [:unspecified, :no_air]    => "N",
+      [:diesel, :air]            => "D",
+      [:diesel, :no_air]         => "Q",
+      [:hybrid, :air]            => "H",
+      [:hybrid_plug_in, :air]    => "I",
+      [:electric, :air]          => "E",
+      [:electric_plus, :air]     => "C",
+      [:compressed_gas, :air]    => "L",
+      [:compressed_gas, :no_air] => "S",
+      [:hydrogen, :air]          => "A",
+      [:hydrogen, :no_air]       => "B",
+      [:multi_fuel, :air]        => "M",
+      [:multi_fuel, :no_air]     => "F",
+      [:petrol, :air]            => "V",
+      [:petrol, :no_air]         => "Z",
+      [:ethanol, :air]           => "U",
+      [:ethanol, :no_air]        => "X",
+    }
+  end
+end
+

data/lib/sipp/localiser.rb

@@ -0,0 +1,8 @@
+module SIPP
+  module Localiser
+    def translate(scope, item)
+      I18n.translate("sipp.#{scope}.#{item}")
+    end
+    alias_method :t, :translate
+  end
+end

data/lib/sipp/version.rb

@@ -1,3 +1,3 @@
 module SIPP
-  VERSION = "0.1.4"
+  VERSION = "0.1.7"
 end

data/lib/sipp.rb

@@ -1,15 +1,60 @@
 require "sipp/version"
 
+require "sipp/localiser"
 module SIPP
-  class Error < StandardError; end
-  class CodeError < StandardError; end
-  class CategoryError < StandardError; end
-  class TypeError < StandardError; end
-  class TransmissionDriveError < StandardError; end
-  class FuelACError < StandardError; end
-  # Your code goes here...
-end
+  Error                  = Class.new StandardError
+  CodeError              = Class.new Error
+  CategoryError          = Class.new Error
+  TypeError              = Class.new Error
+  TransmissionDriveError = Class.new Error
+  FuelACError            = Class.new Error
+
+  class SIPPCodeWrapper
+    include Localiser
+
+    def initialize(symbol)
+      @sym = symbol
+    end
+
+    def to_s
+      t klass_name, @sym
+    end
+
+    def klass_name
+      self.class.name.split('::').last
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr(' ', '_')
+          .downcase
+    end
 
-require 'active_support/core_ext/object'
+    def to_sym
+      @sym
+    end
+
+    def as_json
+      { klass_name.to_sym => @sym }
+    end
+  end
+
+  Category          = Class.new SIPPCodeWrapper
+  Type              = Class.new SIPPCodeWrapper
+  TransmissionDrive = Class.new SIPPCodeWrapper
+  Transmission      = Class.new SIPPCodeWrapper
+  Drive             = Class.new SIPPCodeWrapper
+  FuelAC            = Class.new SIPPCodeWrapper
+  Fuel              = Class.new SIPPCodeWrapper
+  Ac                = Class.new SIPPCodeWrapper
+end
 require "sipp/code"
-require "sipp/dictionary"
+require "sipp/dictionary"
+require "sipp/inverted"
+require "sipp/inverted_dictionary"
+require "sipp/extended"
+require "sipp/extended_dictionary"
+require 'i18n'
+I18n.load_path += Dir[File.expand_path("config/locales") + "/*.yml"]
+# I18n.available_locales = [:en, :ru]
+if defined?(Rails)
+  require 'sipp/engine'
+end

data/sipp.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 
-  spec.add_dependency "activesupport", "~> 4.1"
+  spec.add_dependency "i18n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sipp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
 description: Translates car SIPP codes into something meaningful
 email:
 - max@buslaev.net
@@ -83,9 +97,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/locales/en.yml
+- config/locales/ru.yml
 - lib/sipp.rb
 - lib/sipp/code.rb
 - lib/sipp/dictionary.rb
+- lib/sipp/engine.rb
+- lib/sipp/extended.rb
+- lib/sipp/extended_dictionary.rb
+- lib/sipp/inverted.rb
+- lib/sipp/inverted_dictionary.rb
+- lib/sipp/localiser.rb
 - lib/sipp/version.rb
 - sipp.gemspec
 homepage: https://github.com/austerlitz/sipp