sipp 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cd7a87af83d4a601d88f62e8db3ecad8bf946b4
-  data.tar.gz: 8fc8999221846975d2de8ba8b9395b4ca20c6af5
+  metadata.gz: f19fbec80dadd3c4c7d351ad605666722a7f628c
+  data.tar.gz: fde3f3ccec2ac4c43bc0c345f7ddc26004435e60
 SHA512:
-  metadata.gz: 434b594842591b348e6dec6454086e50c5e7100b70f7726ed15311583954218a9243ad239b1c6b7d16260547f3aa5b8d84646022c50b95f6469a045f94ed32f8
-  data.tar.gz: 41f77d27e86a4f70a77f9b7b2f8bbab624f1197303c87dd6b4125a415b084a90820f37e9170221fbc544d55c95cd6dda0067c92b6515cc57e9decf3347b1dc9c
+  metadata.gz: 5043f858559c2019a89b2795ec381617a172d5aebe78bf32d9543a463a8c991d237c7f775acf611515aac7eaac9df26abd4bd78aa4b750ea05a00ad9aa0e476a
+  data.tar.gz: 6dd7d7fd130c6607cfbc0b93c49b554ca4610930403992c3a730d110f10af5368295608ca78c04e6efe42754c14fd1ee34464a15430da68013840675d6e53e37

data/README.md

@@ -93,12 +93,69 @@ ua:
       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
 - [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
-- [ ] add query methods for common checks (like `.diesel?` etc)
 
 
 ## Development

data/config/locales/en.yml

@@ -55,11 +55,15 @@ en:
     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

data/config/locales/ru.yml

@@ -55,11 +55,15 @@ ru:
     transmission:
       manual: МКПП
       auto: АКПП
+      robot: Робот
 
     drive:
       unspecified: привод не указан
       four_wd: 4WD
       awd: AWD
+      single: Монопривод
+      front: Передний
+      rear: Задний
 
     fuel_ac:
       unspecified_air: топливо не указано, кондиционер

data/lib/sipp/code.rb

@@ -103,14 +103,16 @@ module SIPP
       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].map(&:as_json).inject(&:merge).merge({code: @code})
+      [category, type, transmission, drive, fuel, ac].compact.map(&:as_json).inject(&:merge).merge({code: @code})
     end
 
     private

data/lib/sipp/dictionary.rb

@@ -30,7 +30,7 @@ module SIPP
       'L' => :limousine_sedan,
       'S' => :sport,
       'T' => :convertible,
-      'F' => :sUV,
+      'F' => :suv,
       'J' => :open_air_all_terrain,
       'X' => :special,
       'P' => :pick_up_2_door,

data/lib/sipp/extended.rb

@@ -0,0 +1,114 @@
+require 'sipp/extended_dictionary'
+module SIPP
+
+  class Extended
+    include ExtendedDictionary
+
+      def self.generate(capabilities)
+        capabilities = capabilities.inject({}) do |caps, (k, v)|
+          val = v.respond_to?(:to_sym) ? v.to_sym : v
+          caps[k&.to_sym] = val
+          caps
+        end
+        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/version.rb

@@ -1,3 +1,3 @@
 module SIPP
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/lib/sipp.rb

@@ -48,6 +48,10 @@ module SIPP
 end
 require "sipp/code"
 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]

data/sipp.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["max@buslaev.net"]
 
   spec.summary       = %q{SIPP aka ACRISS code dictionary}
-  spec.description   = %q{Translates car SIPP codes into something meaningful}
+  spec.description   = %q{Translates car SIPP/ACRISS codes into something meaningful}
   spec.homepage      = "https://github.com/austerlitz/sipp"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sipp
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Translates car SIPP codes into something meaningful
+description: Translates car SIPP/ACRISS codes into something meaningful
 email:
 - max@buslaev.net
 executables: []
@@ -103,6 +103,10 @@ files:
 - 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