pavement_condition_index 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bce66be6a47892909611a2a8d901e768c6053fb3
+  data.tar.gz: d34615aaa0769b0a4d9c59e25a358d3e7d263ea0
+SHA512:
+  metadata.gz: e7a05a5fc057b84965f60bedd0012053a0233f0c255152f1286fbf8266ea5beabe6cf129f9779593036815e39a1bb4ef3a1464909dc812b1acd5c9c35cd60c75
+  data.tar.gz: fe54407b12136ee20d4d0ab7ceec99284505bdb4f221815d75ff59eb81f55eca271384149ae1e8c3ea3b8ff5da289a1fac6465bb85835350614cc6fab85e3da6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pavement_condition_index.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andy Monroe
+
+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,100 @@
+# PavementConditionIndex
+
+The pavement_condition_index gem is a tool for generating Pavement Condition Inventory (PCI) scores for assessed sections of pavement. This gem follows the [ASTM Standard Practice for Forads and Parking Lots Pavement Condition Index Surveys](https://www.astm.org/Standards/D6433.htm).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pavement_condition_index'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pavement_condition_index
+
+## Usage
+
+To start using the pavement_condition_index gem, first you will need pavement distress data from a series of sample surveys from within a section of pavement. Once these samples have been assessed, one simply needs to create a SectionConditionSurvey object that contains SampleUnitConditionSurveys representing the pavement section and its samply surveys respectively. Once this is complete, you can now call various methods on your SectionConditionSurvey to the final PCI score, or even the intermediate values used to calculate the PCI if you would like to double check the process.
+
+Example Code:
+```
+@asphalt_sample_survey = PavementConditionIndex::SampleUnitConditionSurvey::AsphaltSurvey.new({
+  area: 2500,
+  distresses: [
+    {severity: :low, type: :alligator_cracking, quantity: 5},
+    {severity: :low, type: :alligator_cracking, quantity: 4},
+    {severity: :low, type: :alligator_cracking, quantity: 4},
+    {severity: :high, type: :alligator_cracking, quantity: 8},
+    {severity: :high, type: :alligator_cracking, quantity: 6},
+    {severity: :low, type: :edge_cracking, quantity: 32},
+    {severity: :low, type: :edge_cracking, quantity: 15},
+    {severity: :low, type: :edge_cracking, quantity: 18},
+    {severity: :low, type: :edge_cracking, quantity: 24},
+    {severity: :low, type: :edge_cracking, quantity: 41},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 20},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 15},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 35},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 27},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 23},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 10},
+    {severity: :medium, type: :joint_reflection_cracking, quantity: 13},
+    {severity: :high, type: :patching_and_utility_cut_patching, quantity: 12},
+    {severity: :high, type: :patching_and_utility_cut_patching, quantity: 10},
+    {severity: :low, type: :potholes, quantity: 1},
+    {severity: :low, type: :rutting, quantity: 4},
+    {severity: :low, type: :rutting, quantity: 9},
+    {severity: :low, type: :rutting, quantity: 8},
+    {severity: :low, type: :weathering, quantity: 250}
+  ]
+})
+
+@concrete_sample_survey = PavementConditionIndex::SampleUnitConditionSurvey::ConcreteSurvey.new({
+  area: 2500,
+  number_of_slabs: 20,
+  distresses: [
+    {severity: :high, type: :joint_seal_damage, quantity: 123}, # joint_seal_damage has no 'quantity'
+    {severity: :low, type: :corner_break, quantity: 3},
+    {severity: :medium, type: :corner_break, quantity: 1},
+    {severity: :medium, type: :divided_slab, quantity: 3},
+    {severity: :medium, type: :patching_small, quantity: 4},
+    {severity: :medium, type: :punchouts, quantity: 2},
+    {severity: :low, type: :spalling_corner, quantity: 6},
+    {severity: :high, type: :spalling_joint, quantity: 1},
+  ]
+})
+
+@section_survey = PavementConditionIndex::SectionConditionSurvey.new({
+  sample_unit_condition_surveys: [
+    @asphalt_sample_survey,
+    @concrete_sample_survey],
+  total_number_of_sample_units: 30
+})
+
+@section_survey.pci.score
+# => 49
+
+@section_survey.pci.rating
+# =>'Poor'
+
+@section_survey.pci.color
+# => 'fc2e1f'
+```
+## 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/andrew-monroe/pavement_condition_index.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+import "./lib/tasks/regression.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pavement_condition_index"
+
+# 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/pavement_condition_index/cdv_iteration.rb

@@ -0,0 +1,30 @@
+module PavementConditionIndex
+  class CdvIteration
+
+    attr_reader :deduct_values, :q
+
+    def initialize(deduct_values: ,pavement_type: ,q: )
+      @deduct_values = deduct_values
+      @q = q
+      @pavement_type = pavement_type
+    end
+
+    def adjusted_deduct_values
+      @adjusted_deduct_values ||= begin
+        c = @deduct_values.clone
+        a = c.shift(@q)
+        a += c.map {|dv| [dv,2.0].min }
+        a
+      end
+    end
+
+    def total_deduct_value
+      @total_deduct_value ||= adjusted_deduct_values.reduce(:+)
+    end
+
+    def corrected_deduct_value
+      @corrected_deduct_value ||= PavementConditionIndex::Lookups::CorrectedDeductValues.new(pavement_type: @pavement_type, q: @q).call(total_deduct_value)
+    end
+
+  end
+end

data/lib/pavement_condition_index/core_ext/numeric.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def clamp min, max
+    [[self, max].min, min].max
+  end
+end

data/lib/pavement_condition_index/distress_group.rb

@@ -0,0 +1,37 @@
+module PavementConditionIndex
+  class DistressGroup
+
+    attr_reader :type, :severity, :distresses
+    attr_reader :size_of_sample_unit, :pavement_type
+
+    def initialize(type:nil,severity:nil,distresses:nil,size_of_sample_unit:nil,pavement_type:nil)
+      @type = type
+      @severity = severity
+      @distresses = distresses
+      @size_of_sample_unit = size_of_sample_unit
+      @pavement_type = pavement_type
+    end
+
+    def total_quantity
+      @total_quantity ||= @distresses.map{|distress| distress[:quantity]}.reduce(:+)
+    end
+
+    def density
+      @density ||= begin
+        if @type == :joint_seal_damage 
+          1.0
+        else
+          total_quantity/@size_of_sample_unit.to_f
+        end
+      end
+    end
+
+    def density_percentage
+      @density_percentage ||= density * 100
+    end
+
+    def deduct_value
+      @deduct_value ||= PavementConditionIndex::Lookups::DeductValues.new(pavement_type: @pavement_type, distress_type: @type, severity: @severity).call(density_percentage)
+    end
+  end
+end

data/lib/pavement_condition_index/lookups/calculated_corrected_deduct_coefficients.rb

@@ -0,0 +1,50 @@
+# generate this whole file by running the following command:
+# rake regression:generate_calculated_corrected_deduct_coefficients_file > lib/pavement_condition_index/lookups/calculated_corrected_deduct_coefficients.rb
+
+module PavementConditionIndex
+  module Lookups
+    class CalculatedCorrectedDeductCoefficients
+
+# Output of `rake regression:generate_corrected_deduct_coefficients`
+COEFFICIENTS = 
+{:asphalt=>
+  {:coefficients=>
+    {:q1=>[0.0, 0.9999999999999999],
+     :q2=>[-4.767827657379179, 0.9204018317853505, -0.001751870485036131],
+     :q3=>[-7.225000000000371, 0.8352547729618199, -0.0013491357069143565],
+     :q4=>[-12.07301341589303, 0.8359713622291058, -0.0013966718266254004],
+     :q5=>[-12.825902992776388, 0.7672961816305504, -0.0011578947368421164],
+     :q6=>[-15.061893704850672, 0.7418633900928823, -0.0010566950464396384],
+     :q7=>[-18.186068111455448, 0.8352115583075376, -0.0016336429308565648],
+     :q8=>
+      [-11.661042311659124,
+       0.5804493464050489,
+       0.0012355521155837934,
+       -9.988820089439906e-06],
+     :q9=>
+      [-10.821138630889415,
+       0.5307870370368919,
+       0.0020743464052291917,
+       -1.4092420593968467e-05],
+     :q10=>
+      [-33.76740887897169,
+       2.045383029591749,
+       -0.033305999495864574,
+       0.00035829181520672087,
+       -1.7915566098874656e-06,
+       3.173417753551723e-09]}},
+ :concrete=>
+  {:coefficients=>
+    {:q1=>[0.0, 0.9999999999999999],
+     :q2=>[2.7629772961812407, 0.7731404798761636, -0.0010528250773993893],
+     :q3=>[-2.3389834881324347, 0.7286151960784343, -0.0008510706914344763],
+     :q4=>[-2.8658410732717314, 0.6712409700722424, -0.0007479360165118755],
+     :q5=>[-5.263725490196382, 0.6719569143446881, -0.000787796697626424],
+     :q6=>[-7.638157894737134, 0.6712648348813237, -0.0008214009287925783],
+     :q7=>[-7.904979360165406, 0.6438796439628511, -0.0007446465428276629],
+     :q8=>[-8.123555211558568, 0.6151412538699716, -0.0006607972136222964],
+     :q9=>[-8.39037667698684, 0.5877560629514988, -0.0005840428276573835],
+     :q10=>[-8.657198142415098, 0.5603708720330258, -0.0005072884416924711]}}}
+    end
+  end
+end