sipp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e823ae979f2ceef4999a253bf86f204dec06313e
+  data.tar.gz: fd26206453b273c66c0fed4eddfa6d675be7d8a8
+SHA512:
+  metadata.gz: f3661ba71eec6117c0056b3e1ffc124ffcdfb64d24e19542bdb66d5564f03113d70720b5eec6303503ff4512e90c6c4c10f0d858a70d9ffd74ce726cceb6e1c8
+  data.tar.gz: 20c4cb082839d425516cd5d21abb955a883a0fc64cf92d61dd01b20e9510e3f49c28fb3e67b380ae1402484e0449ec9990649c8712b6b1842b1885bc850fdc82

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at max@buslaev.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sipp.gemspec
+gemspec
+
+gem 'activesupport', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Max Buslaev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Sipp
+
+A simple wrapper to decode [SIPP/ACRISS](https://www.acriss.org/car-codes/) car codes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sipp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sipp
+
+## Usage
+
+```ruby
+code = SIPP::Code.new 'CCMN'
+code.to_s # "Compact - 2/4 Door - Manual Unspecified Drive - Unspecified Fuel/Power Without Air"
+
+code.ac? # false
+```
+If the code is invalid, it will return `nil` on all checks.
+
+Calling `code.validate!` will throw validation errors with exceptions.
+
+## TODO
+- add pseudo codes
+- add van codes
+- add i18n helpers
+- add query methods for common checks (like `.diesel?` etc)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/austerlitz/sipp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sipp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/austerlitz/sipp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sipp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# 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 "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sipp/code.rb

@@ -0,0 +1,106 @@
+require 'sipp/dictionary'
+
+module SIPP
+  class Code
+    include Dictionary
+
+    attr_reader :code
+
+    def initialize(code = nil)
+      @code = code.to_s.upcase
+
+    end
+
+    def validate!
+      validate_code &&
+        validate_category &&
+        validate_type &&
+        validate_transmission &&
+        validate_fuel_ac
+    end
+
+    def valid?
+      validate!
+    rescue CodeError, CategoryError, TypeError, TransmissionError, FuelACError
+      false
+    end
+
+    def category
+      CATEGORY[code[0]] if valid?
+    end
+
+    def type
+      TYPE[code[1]] if valid?
+    end
+
+    def transmission
+      TRANSMISSION[code[2]] if valid?
+    end
+
+    def fuel_ac
+      FUEL_AC[code[3]] if valid?
+    end
+
+    def fuel
+      FUEL[code[3]] if valid?
+    end
+
+    def ac
+      AC[code[3]] if valid?
+    end
+
+    def ac?
+      if valid?
+        'Air' == ac ? true : false # TODO fix magic string
+      else
+        nil
+      end
+    end
+
+    def to_s
+      [category, type, transmission, fuel_ac].join(' - ')
+    end
+
+    private
+
+    def validate_code
+      if @code.blank? || 4 != @code.length
+        raise CodeError, :invalid_code
+      else
+        true
+      end
+    end
+
+    def validate_category
+      if @code[0].blank? || !CATEGORY.keys.include?(@code[0])
+        raise CategoryError, :invalid_category
+      else
+        true
+      end
+    end
+
+    def validate_type
+      if @code[1].blank? || !TYPE.keys.include?(@code[1])
+        raise TypeError, :invalid_type
+      else
+        true
+      end
+    end
+
+    def validate_transmission
+      if @code[2].blank? || !TRANSMISSION.keys.include?(@code[2])
+        raise TransmissionError, :invalid_transmission
+      else
+        true
+      end
+    end
+
+    def validate_fuel_ac
+      if @code[3].blank? || !FUEL_AC.keys.include?(@code[3])
+        raise FuelACError, :invalid_fuel_ac
+      else
+        true
+      end
+    end
+  end
+end

data/lib/sipp/dictionary.rb

@@ -0,0 +1,122 @@
+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',
+    }
+
+    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',
+    }
+
+    TRANSMISSION = {
+      'M' => 'Manual Unspecified Drive',
+      'N' => 'Manual 4WD',
+      'C' => 'Manual AWD',
+      'A' => 'Auto Unspecified Drive',
+      'B' => 'Auto 4WD',
+      'D' => 'Auto 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',
+    }
+
+    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',
+    }
+
+    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',
+    }
+  end
+end
+

data/lib/sipp/version.rb

@@ -0,0 +1,3 @@
+module SIPP
+  VERSION = "0.1.0"
+end

data/lib/sipp.rb

@@ -0,0 +1,15 @@
+require "sipp/version"
+
+module SIPP
+  class Error < StandardError; end
+  class CodeError < StandardError; end
+  class CategoryError < StandardError; end
+  class TypeError < StandardError; end
+  class TransmissionError < StandardError; end
+  class FuelACError < StandardError; end
+  # Your code goes here...
+end
+
+require 'active_support/all'
+require "sipp/code"
+require "sipp/dictionary"

data/sipp.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sipp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sipp"
+  spec.version       = SIPP::VERSION
+  spec.authors       = ["Max Buslaev"]
+  spec.email         = ["max@buslaev.net"]
+
+  spec.summary       = %q{SIPP aka ACRISS code dictionary}
+  spec.description   = %q{Translates car SIPP codes into something meaningful}
+  spec.homepage      = "https://github.com/austerlitz/sipp"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "activesupport", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sipp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Buslaev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Translates car SIPP codes into something meaningful
+email:
+- max@buslaev.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sipp.rb
+- lib/sipp/code.rb
+- lib/sipp/dictionary.rb
+- lib/sipp/version.rb
+- sipp.gemspec
+homepage: https://github.com/austerlitz/sipp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: SIPP aka ACRISS code dictionary
+test_files: []