so_far_so_good 0.0.3 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ca68bf267662afde3f952d21d46565546f8278
-  data.tar.gz: 76dc75b71d6764960d11e45c4a6f6d4b2b39312f
+  metadata.gz: ab77e766152edb727d4513fc59371d119f0339b3
+  data.tar.gz: fd27195a2227fa669f86d93593a5eeded9c8310c
 SHA512:
-  metadata.gz: d6a7d2876d9c40b48d0f6b504bd52e184865634f6667c76e995c04175a1fbd512d69a44e67742e2c888ae893f660f019f529882fa510248493eff648005270a1
-  data.tar.gz: dd43c8d95edb8a176f242bc596c4c0ca99533e588962f6efe81c5f7c25d9f1912f836ba328d30e122258d4922e7d4300907ff141bbdbf4bca043827cecb8e492
+  metadata.gz: 305cdec6f88a0555b7af3504414b48814e8927efc19b42e93746f553a69f9b9d181e5bfe748db258ed242b7c51bd5d758faf47fa236f07fbf28329d5acb3263f
+  data.tar.gz: 09d6f2de3a92e53f8f3e7079b89fa18793fd588d522738ead0e9969f48a8ebd5ef09216d28365df55845b7dcc66470d43914d541566ffb8348126fb8149d2475

data/README.md

@@ -1,12 +1,12 @@
 # So FAR so Good
 
-A Ruby Gem to parse and manipulate the Federal Acquisition Regulation
+A Ruby Gem to parse and manipulate the Federal Acquisition Regulation (FAR) and Defense Federal Acquisition Regulation Supplement (DFARs)
 
 [![Gem Version](https://badge.fury.io/rb/so_far_so_good.svg)](http://badge.fury.io/rb/so_far_so_good) [![Build Status](https://travis-ci.org/benbalter/so_far_so_good.svg)](https://travis-ci.org/benbalter/so_far_so_good)
 
 ## What it does
 
-So FAR so Good is a Ruby Gem to interact with the Federal Acquisition Regulation. Right now, it only supports section 52.20x, the FAR standard contracting clause templates.
+So FAR so Good is a Ruby Gem to interact with the Federal Acquisition Regulation (FAR) and Defense Federal Acquisition Regulation Supplement (DFARs). Right now, it supports section 52.20x and 252.20x, the FAR and DFARs standard contracting clause templates.
 
 For any contract clause, it will provide:
 
@@ -16,6 +16,7 @@ For any contract clause, it will provide:
 * The formal citation
 * The body (full clause text)
 * The extract (what's inserted into the contract)
+* A link to the full text online
 
 It will give you access to this information in object-oriented Ruby, as JSON, or as a markdown table for use elsewhere.
 
@@ -24,69 +25,77 @@ It will give you access to this information in object-oriented Ruby, as JSON, or
 ### Basic usage
 
 ```ruby
-# Get all clauses
-clauses = SoFarSoGood.clauses
-=> [#<SoFarSoGood::Clause @number="52.200" @subject="Scope of subpart." @reserved="false",
- #<SoFarSoGood::Clause @number="52.202-1" @subject="Definitions." @reserved="false",
- #<SoFarSoGood::Clause @number="52.203-1" @subject="[Reserved]" @reserved="true",
- #<SoFarSoGood::Clause @number="52.203-2" @subject="Certificate of Independent Price Determination." @reserved="false",
- #<SoFarSoGood::Clause @number="52.203-3" @subject="Gratuities." @reserved="false", ... ]
-
-# Get a list of clause numbers
-SoFarSoGood::Clauses.numbers
+subchapters = SoFarSoGood.subchapters
+=> [#<SoFarSoGood::Subchapter year=2013 title=48 volume=2 chapter=1 name="FAR">,
+    #<SoFarSoGood::Subchapter year=2013 title=48 volume=3 chapter=2 name="DFARs">]
+
+# Get the FAR's subparts
+subparts = SoFarSoGood.far.subparts
+=> [#<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.200" subject="Scope of subpart." document="FAR" reserved=false>,
+  #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.202-1" subject="Definitions." document="FAR" reserved=false>,
+  #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.203-1" subject="[Reserved]" document="FAR" reserved=true>,
+  #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.203-2" subject="Certificate of Independent Price Determination." document="FAR" reserved=false>,
+  #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.203-3" subject="Gratuities." document="FAR" reserved=false>,
+  #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.203-4" subject="[Reserved]" document="FAR" reserved=true>...]
+
+# Get a list of subpart numbers
+SoFarSoGood.far.numbers
 => ["52.200", "52.202-1", "52.203-1", "52.203-2", "52.203-3", "52.203-4", "52.203-5", ... ]
 
-# Get a list of clause numbers, excluding reserved clauses
-SoFarSoGood::Clauses.numbers(:exclude_reserved => true)
+# Get a list of subpart numbers, excluding reserved clauses
+SoFarSoGood.far.numbers(:reserved => false)
 => ["52.200", "52.202-1", "52.203-1", "52.203-2", "52.203-3", "52.203-4", "52.203-5", ... ]
 
-# Get a list of clause subjects
-SoFarSoGood::Clauses.subjects
+# Get a list of subpart subjects
+SoFarSoGood.far.subjects
 => ["Scope of subpart.", "Definitions.", "[Reserved]", "Certificate of Independent Price Determination.", ... ]
 ```
 
 ### Working with individual clauses
 
 ```ruby
-# Get a specific clause
-clause = SoFarSoGood::Clauses["52.202-1"]
-=> #<SoFarSoGood::Clause @number="52.202-1" @subject="Definitions." @reserved="false"
+# Get a specific subpart
+subpart = SoFarSoGood["52.202-1"]
+=> #<SoFarSoGood::Subpart year=2013 title=48 volume=2 chapter=1 number="52.202-1" subject="Definitions." document="FAR" reserved=false>
 
-clause.number
+subpart.number
 => "52.202-1"
 
-clause.subject
+subpart.subject
 => "Definitions"
 
-clause.reserved?
+subpart.reserved?
 => false
 
-clause.citation
+subpart.citation
 => "[69 FR 34228, June 18, 2004]"
 
 # The full clause body
-clause.body
+subpart.body
 => "As prescribed in 2.201, insert the following clause:..."
 
 # The actual clause text to be inserted in the contract
-clause.extract
+subpart.extract
 => "Definitions (JUL 2004)(a) When a solicitation provision or contract clause uses a word..."
+
+subpart.link
+=> "http://www.law.cornell.edu/cfr/text/48/52.202-1"
 ```
 
-### Using clause data elsewhere
+### Using subpart data elsewhere
 
 #### As JSON
 
 ```ruby
 
-SoFarSoGood::Clauses.list.to_json
+SoFarSoGood.far.to_json
 => "[{\"number\":\"52.200\",\"subject\":\"Scope of subpart.\",\"reserverd\":false,\"citation\":..."
 ```
 
 #### As a markdown table
 
 ```ruby
-puts SoFarSoGood::Clauses.to_md
+puts SoFarSoGood.far.to_md
 |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Clause    | Description                                                                                                                                                   |
 |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -97,11 +106,11 @@ puts SoFarSoGood::Clauses.to_md
 | 52.203-5  | Covenant Against Contingent Fees.                                                                                                                             |
 ...
 
-# Table without reserved clauses
-puts SoFarSoGood::Clauses.to_md(:exclude_reserved => true)
+# Table without reserved subparts
+puts SoFarSoGood.dfars.to_md(:reserved => false)
 
 # Table with links to text
-puts SoFarSoGood::Clauses.to_md(:links => true)
+puts SoFarSoGood.far.to_md(:links => true)
 ...
 | [52.222-34](http://www.law.cornell.edu/cfr/text/48/52.222-34) | Project Labor Agreement.                                                                                                                                      |
 | [52.222-35](http://www.law.cornell.edu/cfr/text/48/52.222-35) | Equal Opportunity for Veterans.                                                                                                                               |
@@ -112,15 +121,26 @@ puts SoFarSoGood::Clauses.to_md(:links => true)
 ...
 ```
 
-#### Individual clauses as markdown
+#### As a CSV
+```ruby
+puts SoFarSoGood.far.to_csv(:reserved => false)
+Clause,Description
+52.200,Scope of subpart.
+52.202-1,Definitions.
+52.203-2,Certificate of Independent Price Determination.
+52.203-3,Gratuities.
+52.203-5,Covenant Against Contingent Fees.
+```
+
+#### Individual subparts as markdown
 
 ```ruby
 # The body
-puts SoFarSoGood::Clauses["52.202-1"].body(:format => :markdown)
+puts SoFarSoGood["52.202-1"].body(:format => :markdown)
 => As prescribed in 2.201, insert the following clause:
 
 # The extract
-puts SoFarSoGood::Clauses["52.202-1"].extract(:format => :markdown)
+puts SoFarSoGood["52.202-1"].extract(:format => :markdown)
 => ### Definitions (JUL 2004)
 
 (a) When a solicitation provision or contract clause uses a word or term that is defined in the Federal Acquisition Regulation (FAR), the word or term has the same meaning as the definition in FAR 2.101 in effect at the time the solicitation was issued, unless— ...

data/lib/so_far_so_good/subchapter.rb

@@ -0,0 +1,88 @@
+module SoFarSoGood
+  class Subchapter
+
+    attr_reader :year
+    attr_reader :title
+    attr_reader :volume
+    attr_reader :chapter
+    attr_reader :name
+
+    def initialize(hash)
+      @volume  = hash[:volume]
+      @chapter = hash[:chapter]
+      @name    = hash[:name]
+      @year    = SoFarSoGood::YEAR
+      @title   = SoFarSoGood::TITLE
+    end
+
+    def numbers(options = {})
+      @numbers ||= subparts(options).map { |s| s.number }
+    end
+
+    def subjects(options = {})
+      @subjects ||= subparts(options).map { |s| s.subject }
+    end
+
+    def subparts(options = {})
+      @subparts ||= sections.map { |node| SoFarSoGood::Subpart.new(to_hash.merge(:node => node)) }
+      @subparts.select { |subpart| options.all? { |k,v| subpart.send(k) == v } }
+    end
+
+    def to_md(options = {})
+      links = options.delete(:links) == true
+      rows = subparts(options).map { |c| [ links ? "[#{c.number}](#{c.link})" : c.number , c.subject] }
+      Terminal::Table.new(:rows => rows, :style => { :border_i => "|" }, :headings => HEADINGS).to_s
+    end
+
+    def to_json(options = {})
+      subparts(options).to_json(options)
+    end
+
+    def to_csv(options = {})
+      CSV.generate do |csv|
+        csv << HEADINGS
+        subparts(options).each do |c|
+          csv << [c.number , c.subject]
+        end
+      end
+    end
+
+    def to_hash
+      {
+        :year    => year,
+        :title   => title,
+        :volume  => volume,
+        :chapter => chapter,
+        :name    => name
+      }
+    end
+
+    def [](number)
+      subparts.find { |s| s.number == number }
+    end
+
+    def inspect
+      "#<SoFarSoGood::Subchapter year=#{year} title=#{title} volume=#{volume} chapter=#{chapter} name=\"#{name}\">"
+    end
+
+    private
+
+    def filename
+      "CFR-#{YEAR}-title#{TITLE}-vol#{volume}-chap#{chapter}-subchapH.xml"
+    end
+
+    def source_path
+      @source_path ||= File.expand_path filename, SoFarSoGood.vendor_directory
+    end
+
+    def doc
+      @doc ||= Nokogiri::XML(File.open(source_path)) do |config|
+        config.noblanks.nonet
+      end
+    end
+
+    def sections
+      @subpart ||= doc.css("PART SUBPART")[name == "FAR" ? 4 : 3].children.css("SECTION")
+    end
+  end
+end

data/lib/so_far_so_good/{clause.rb → subpart.rb}

@@ -1,10 +1,20 @@
 module SoFarSoGood
-  class Clause
+  class Subpart
 
     attr_reader :node
+    attr_reader :year
+    attr_reader :title
+    attr_reader :volume
+    attr_reader :chapter
+    attr_reader :document
 
-    def initialize(node)
-      @node = node
+    def initialize(hash)
+      @year     = hash[:year]
+      @title    = hash[:title]
+      @volume   = hash[:volume]
+      @chapter  = hash[:chapter]
+      @document = hash[:name]
+      @node     = hash[:node]
       normalize!
     end
 
@@ -51,13 +61,18 @@ module SoFarSoGood
 
     def to_hash(options={})
       {
+        :year      => year,
+        :title     => title,
+        :volume    => volume,
+        :chapter   => chapter,
         :number    => number,
         :subject   => subject,
         :reserverd => reserved,
         :citation  => citation,
         :extract   => extract(options),
         :body      => body(options),
-        :link      => link
+        :link      => link,
+        :document  => document,
       }
     end
 
@@ -66,7 +81,7 @@ module SoFarSoGood
     end
 
     def inspect
-      "#<SoFarSoGood::Clause @number=\"#{@number}\" @subject=\"#{@subject}\" @reserved=\"#{@reserved}\""
+      "#<SoFarSoGood::Subpart year=#{year} title=#{title} volume=#{volume} chapter=#{chapter} number=\"#{number}\" subject=\"#{subject}\" document=\"#{document}\" reserved=#{reserved}>"
     end
 
     private

data/lib/so_far_so_good/version.rb

@@ -1,3 +1,3 @@
 module SoFarSoGood
-  VERSION = "0.0.3"
+  VERSION = "1.0.1"
 end

data/lib/so_far_so_good.rb

@@ -1,15 +1,37 @@
 require "nokogiri"
 require "terminal-table"
-require "json"
 require "reverse_markdown"
+require "json"
+require 'csv'
 require_relative "so_far_so_good/version"
-require_relative "so_far_so_good/clauses"
-require_relative "so_far_so_good/clause"
+require_relative "so_far_so_good/subchapter"
+require_relative "so_far_so_good/subpart"
 
 module SoFarSoGood
+
+  HEADINGS = ["Clause", "Description"]
+  YEAR = 2013
+  TITLE = 48
+
   class << self
-    def clauses(options = {})
-      SoFarSoGood::Clauses.clauses(options)
+    def far
+      @far ||= SoFarSoGood::Subchapter.new(:name => "FAR",   :volume => 2, :chapter => 1)
+    end
+
+    def dfars
+      @dfars ||= SoFarSoGood::Subchapter.new(:name => "DFARs", :volume => 3, :chapter => 2)
+    end
+
+    def subchapters
+      [far, dfars]
+    end
+
+    def subparts(options = {})
+      subchapters.map { |d| d.subparts(options) }.flatten
+    end
+
+    def [](subpart)
+      subparts.find { |s| s.number == subpart }
     end
 
     def vendor_directory

data/script/release

@@ -1,3 +1,38 @@
 #!/bin/sh
+# Tag and push a release.
 
-bundle exec rake release
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf so_far_so_good-*.gem
+gem build -q so_far_so_good.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls so_far_so_good-*.gem | sed 's/^so_far_so_good-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push so_far_so_good-*.gem && git tag "$tag" &&
+git push origin master && git push origin "$tag"

data/script/vendor

@@ -1,4 +1,5 @@
 #!/bin/sh
 
 rm -Rf ./vendor/*
-wget http://www.gpo.gov/fdsys/pkg/CFR-2010-title48-vol2/xml/CFR-2010-title48-vol2-chap1-subchapH.xml -P vendor
+wget http://www.gpo.gov/fdsys/pkg/CFR-2013-title48-vol2/xml/CFR-2013-title48-vol2-chap1-subchapH.xml -P vendor
+wget http://www.gpo.gov/fdsys/pkg/CFR-2013-title48-vol3/xml/CFR-2013-title48-vol3-chap2-subchapH.xml -P vendor

data/test/so_far_so_good_subchapter_test.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestSoFarSoGoodSubchapter < Minitest::Test
+
+  def setup
+    @subchapter = SoFarSoGood.far
+  end
+
+  should "know the subchapter file" do
+    assert File.exists? @subchapter.send :source_path
+  end
+
+  should "parse the XML" do
+    assert Nokogiri::XML::Document, @subchapter.send(:doc).class
+  end
+
+  should "parse subpart numbers" do
+    assert_equal 626, @subchapter.numbers.count
+    assert_equal "52.200", @subchapter.numbers.first
+  end
+
+  should "parse subpart descriptions" do
+    assert_equal 626, @subchapter.subjects.count
+    assert_equal "Scope of subpart.", @subchapter.subjects.first
+  end
+
+  should "put out valid JSON" do
+    assert !!JSON.parse(@subchapter.subparts.to_json)
+  end
+
+  should "return a particular subpart" do
+    assert_equal "52.202-1", @subchapter["52.202-1"].number
+  end
+
+  should "return all subparts" do
+    assert_equal 626, @subchapter.subparts.count
+  end
+
+  should "filter reserved subparts" do
+    assert_equal 576, @subchapter.subparts(:reserved => false).count
+  end
+
+  should "build the markdown table" do
+    assert_includes @subchapter.to_md, "-|\n| 52.200              | Scope of subpart."
+  end
+
+  should "exclude reserved in markdown table when asked" do
+    refute_includes @subchapter.to_md(:reserved => false), "[Reserved]"
+  end
+
+  should "include links in markdown table when asked" do
+    assert_includes @subchapter.to_md(:links => true), "[52.252-6](http://www.law.cornell.edu/cfr/text/48/52.252-6)"
+  end
+
+  should "output valid CSV" do
+    csv = CSV.parse @subchapter.to_csv
+    assert_equal ["52.200", "Scope of subpart."], csv[1]
+  end
+end

data/test/so_far_so_good_subpart_test.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestSoFarSoGoodSubpart < Minitest::Test
+
+  def setup
+    @subchapter = SoFarSoGood.far
+    @nodes = @subchapter.send(:sections)
+    @subpart = SoFarSoGood::Subpart.new(:node => @nodes[6])
+  end
+
+  should "Store the node" do
+    assert Nokogiri::XML::Element, @subpart.node.class
+  end
+
+  should "expose the subpart number" do
+    assert_equal "52.203-5", @subpart.number
+  end
+
+  should "expose the subpart subject" do
+    assert_equal "Covenant Against Contingent Fees.", @subpart.subject
+  end
+
+  should "know the cite" do
+    assert_includes @subpart.citation, "48 FR 42478"
+  end
+
+  should "know the subpart body" do
+    assert_includes @subpart.body, "As prescribed in 3.404,"
+  end
+
+  should "not include the extract in the subpart body" do
+    refute_includes @subpart.body, "The Contractor warrants that no person or agency"
+  end
+
+  should "know the subpart extract" do
+    assert_includes @subpart.extract, "The Contractor warrants that no person or agency"
+  end
+
+  should "know if its reserved" do
+    refute @subchapter["52.203-5"].reserved?
+    assert @subchapter["52.203-1"].reserved?
+  end
+
+  should "convert the body to markdown" do
+    assert_includes @subpart.body(:format => :markdown), "As prescribed in 3.404, insert the following clause:\n\n"
+  end
+
+  should "convert the extract to markdown" do
+    assert_includes @subpart.extract(:format => :markdown), "### Covenant Against Contingent Fees (APR 1984)\n\n(a)"
+  end
+
+  should "build the link" do
+    assert_equal "http://www.law.cornell.edu/cfr/text/48/52.203-5", @subpart.link
+  end
+
+  should "put out valid json" do
+    assert JSON.parse @subchapter["52.203-5"].to_json
+  end
+end

data/test/so_far_so_good_test.rb

@@ -2,15 +2,28 @@ require 'helper'
 
 class TestSoFarSoGood < Minitest::Test
   should "figure out the vendor directory" do
-    assert File.exists?(SoFarSoGood.vendor_directory)
+    assert File.exists?(SoFarSoGood.send(:vendor_directory))
   end
 
-  should "return the clause hash" do
-    assert_equal Array, SoFarSoGood.clauses.class
-    assert_equal 616, SoFarSoGood.clauses.count
+  should "know the FAR" do
+    assert_equal SoFarSoGood::Subchapter, SoFarSoGood.far.class
+    assert_equal "FAR", SoFarSoGood.far.name
   end
 
-  should "accept clause options" do
-    assert_equal 567, SoFarSoGood.clauses(:exclude_reserved => true).count
+  should "know the DFARs" do
+    assert_equal SoFarSoGood::Subchapter, SoFarSoGood.dfars.class
+    assert_equal "DFARs", SoFarSoGood.dfars.name
+  end
+
+  should "return subchapters" do
+    assert_equal 2, SoFarSoGood.subchapters.count
+  end
+
+  should "return subparts" do
+    assert_equal 981, SoFarSoGood.subparts.count
+  end
+
+  should "accept subpart options" do
+    assert_equal 907, SoFarSoGood.subparts(:reserved => false).count
   end
 end