vehicle_coding_ph 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc0616b90c86b72c8cca57b1c565f60f06d8d8516969eb87c4ce47c21999556
-  data.tar.gz: 0d4b7e37ae873cafa2f5a09bc1991f7b3e016c5579fff48ad8ff2418f401aa68
+  metadata.gz: ce3082de37eaf01f116650c3f08c65c42a5ff17ab5ccbbb0eb2063f4e7cbb408
+  data.tar.gz: a90fcd77170c3698f7bbf67233fa59ce5d1ca31d69fc4e3d25b5fe069052cc31
 SHA512:
-  metadata.gz: 2ad16c1745314249a63a32370c8d52d46ce287e1fbd923c6af46c0d44d897ef50c7380a098f8c93fbcb0163120b6ce27e8a807e2b7966d5fe134cd398ff1bb07
-  data.tar.gz: 67b1f47d2469f4a620e2aef2c64958d0f7113e4cad2ba0650a3045cb3f966a80a84c59a4475dd8d8140462916bc6df446ece9df856ce9efa609bd4147dd6bf63
+  metadata.gz: 0c04dafd33bd52e31b21c145319eb2b0b766463af48e10aa7125171c7683cbd7004a92d9099a8a1d6fbedd16320de7fa074e5d6e46c52d5e80181523ae9c0c6e
+  data.tar.gz: 76e02fd654d3ab61e9eaada8f0fed98c17716c032616071552976376961f7e6aa98168df701a3c73150a6a920dde5567c9637791353a775adc2bdd2aa62ede89

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vehicle_coding_ph (0.2.0)
+    vehicle_coding_ph (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,6 +4,13 @@
 
 Helps you figure out if your car is legally okay to drive on a given date in the Philippines.
 
+## Version 1.0 roadmap
+
+- [x] Response object
+- [x] Consider window hours
+- [ ] Helpful return messages for the Gem users e.g. "areas you're allowed or
+  not allowed to go to" because areas have particular coding scheme applied
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,11 +30,16 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# Returns true if allowed to drive today; otherwise it's false
-VehicleCodingPh::Checker.(
+result = VehicleCodingPh::Checker.(
   plate_number_of_your_vehicle, 
-  date # if not passed, defaults to date today
+  datetime # if not passed, defaults to datetime today
 )
+
+# result is a hash that has the ff. data structure
+{
+  coding: boolean,
+  allowed_areas: [] # array of areas in Metro Manila
+}
 ```
 
 ## Development

data/lib/vehicle_coding_ph/checker.rb

@@ -1,22 +1,47 @@
 module VehicleCodingPh
   class Checker
 
-    def self.call(plate_no, date = Date.today)
-      return true if weekend?(date)
+    def self.call(plate_no, datetime = Time.now)
+      return allowed_anywhere if weekend?(datetime)
+      return allowed_anywhere if not coding?(plate_no, datetime)
 
-      last_digit = plate_no[-1]
-      day_today = Date::DAYNAMES[date.cwday]
+      hour_of_the_day = datetime.hour
+
+      allowed_areas = VehicleCodingPh::AREA_TO_HOUR_MAPPING.reduce([]) do |hash, mapping|
+        hash ||= []
+        area = mapping[0]
+        coding_hours = mapping[1]
+
+        if coding_hours.empty? || !coding_hours.include?(hour_of_the_day)
+          hash << area
+        end
+
+        hash
+      end
+
+      Response.new(true, allowed_areas)
+    end
+
+    def self.weekend?(datetime)
+      datetime.saturday? || datetime.sunday?
+    end
+    private_class_method :weekend?
+
+    def self.coding?(plate, datetime)
+      last_digit = plate[-1]
+      day_today = Date::DAYNAMES[datetime.wday]
 
       mapping = VehicleCodingPh::PLATE_TO_DAY_MAPPING.
         select { |day, digits| day == day_today }
 
-      !mapping[day_today].include?(last_digit) 
+      mapping[day_today].include?(last_digit)
     end
+    private_class_method :coding?
 
-    def self.weekend?(date)
-      date.saturday? || date.sunday?
+    def self.allowed_anywhere
+      Response.new(false, [:anywhere])
     end
-    private_class_method :weekend?
+    private_class_method :allowed_anywhere
 
   end
 end

data/lib/vehicle_coding_ph/response.rb

@@ -0,0 +1,12 @@
+module VehicleCodingPh
+  class Response
+
+    attr_reader :coding, :allowed_areas
+
+    def initialize(coding, areas)
+      @coding = coding
+      @allowed_areas = areas
+    end
+
+  end
+end

data/lib/vehicle_coding_ph/version.rb

@@ -1,3 +1,3 @@
 module VehicleCodingPh
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/vehicle_coding_ph.rb

@@ -1,6 +1,7 @@
 require "date"
 require "vehicle_coding_ph/version"
 require "vehicle_coding_ph/checker"
+require "vehicle_coding_ph/response"
 
 module VehicleCodingPh
   class Error < StandardError; end
@@ -14,4 +15,24 @@ module VehicleCodingPh
     "Saturday"  => [],
     "Sunday"    => [],
   }
+
+  AREA_TO_HOUR_MAPPING = {
+    "Marikina" => [],
+    "Muntinlupa" => [],
+    "Taguig" => [],
+    "Pasig" => [7, 8, 9, 16, 17, 18, 19],
+    "Makati" => [7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19],
+    "Mandaluyong" => [7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20],
+    "Pasay" => [7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20],
+    "Las Pinas" => [7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20],
+    "Paranaque" => [7, 8, 9, 16, 17, 18, 19],
+    "Caloocan" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Quezon City" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Valenzuela" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Malabon" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "San Juan" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Navotas" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Manila" => [7, 8, 9, 10, 16, 17, 18, 19],
+    "Pateros" => [7, 8, 9, 10, 16, 17, 18, 19],
+  }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vehicle_coding_ph
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Chavez
@@ -100,6 +100,7 @@ files:
 - bin/setup
 - lib/vehicle_coding_ph.rb
 - lib/vehicle_coding_ph/checker.rb
+- lib/vehicle_coding_ph/response.rb
 - lib/vehicle_coding_ph/version.rb
 - vehicle_coding_ph.gemspec
 homepage: http://www.localhost.com