so_far_so_good 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9521b2d0cb4777d080a409ff1631f60c70bff35e
-  data.tar.gz: 248816b662685c753f72d37e0ee42be875f7af8b
+  metadata.gz: c0ca888a79d1abea3f16bac6d5fa7706cc1b2c10
+  data.tar.gz: fa8aa37486a39179474fdbef201352217ae3f596
 SHA512:
-  metadata.gz: ef818c8d2c48bad1bd567654aa5f0e16b91063575d414afd63153d019239801ef160181b890072c84c5eeed87a89ef1fa26adf849fd72e054d266052a2f35f41
-  data.tar.gz: 1cdf454823ef2468c531c86d06e9e3a7a4e2e5e6b58e5bafb81a828f0aa9309b6c2ec38271e9b0da355aa3cea0308f5e16ad54606c11349aa96e39ba54a530e2
+  metadata.gz: 2f54bb0f2a247aaeb8a2b4199f5c98d573e815494634821f1f6c7c8a9c2c4d33b40519723b8bc1a56767d8d4d0a31bfff7c9ef1388d7da2053596dfadeadd545
+  data.tar.gz: 42aa3e271d119b52e5ed3a646838e82f5a8c5a830a246ff1f5bab5dfbde384c03d61a11d0ccf7b3b35d8e8ffa396b3fb9f2f17d79d698d06937a5b11342945d0

data/.travis.yml

@@ -0,0 +1,2 @@
+langauage: ruby
+script: "script/cibuild"

data/README.md

@@ -2,21 +2,96 @@
 
 A Ruby Gem to parse and manipulate the Federal Acquisition Regulation
 
+[![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
 
-Right now, it simply gives you a hash of FAR 52.2x clauses and their description, but soon, much, much more!
+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.
+
+For any contract clause, it will provide:
+
+* The section number
+* The subject
+* Whether it's a reserved section
+* The formal citation
+* The body (full clause text)
+* The extract (what's inserted into the contract)
+
+It will give you access to this information in object-oriented Ruby, as JSON, or as a markdown table for use elsewhere.
 
 ## Usage
 
+### Basic usage
+
 ```ruby
-SoFarSoGood.clauses
-> {"52.200"=>"Scope of subpart.",
- "52.201"=>"[Reserved]",
- "52.202-1"=>"Definitions.",
- "52.203-1"=>"[Reserved]",...
- }
+# 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
+=> ["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)
+=> ["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
+=> ["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"
+
+clause.number
+=> "52.202-1"
+
+clause.subject
+=> "Definitions"
+
+clause.reserved?
+=> false
+
+clause.citation
+=> "[69 FR 34228, June 18, 2004]"
+
+# The full clause body
+clause.body
+=> "As prescribed in 2.201, insert the following clause:..."
+
+# The actual clause text to be inserted in the contract
+clause.extract
+=> "Definitions (JUL 2004)(a) When a solicitation provision or contract clause uses a word..."
+```
+
+### Using clause data elsewhere
+
+```ruby
+
+SoFarSoGood::Clauses.list.to_json
+=> "[{\"number\":\"52.200\",\"subject\":\"Scope of subpart.\",\"reserverd\":false,\"citation\":..."
+
+puts SoFarSoGood::Clauses.to_md
+|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 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.                                                                                                                             |
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/so_far_so_good.rb

@@ -7,12 +7,12 @@ require_relative "so_far_so_good/clause"
 
 module SoFarSoGood
   class << self
-    def vendor_directory
-      File.expand_path "../vendor", File.dirname(__FILE__)
+    def clauses(options = {})
+      SoFarSoGood::Clauses.clauses(options)
     end
 
-    def clauses
-      SoFarSoGood::Clauses.clauses
+    def vendor_directory
+      File.expand_path "../vendor", File.dirname(__FILE__)
     end
   end
 end

data/lib/so_far_so_good/clause.rb

@@ -17,6 +17,10 @@ module SoFarSoGood
       @body = node.children.css("P").text.strip
     end
 
+    def reserved?
+      !!@reserved
+    end
+
     def to_hash
       {
         :number    => @number,
@@ -31,5 +35,9 @@ module SoFarSoGood
     def to_json(options = {})
       to_hash.to_json(options)
     end
+
+    def inspect
+      "#<SoFarSoGood::Clause @number=\"#{@number}\" @subject=\"#{@subject}\" @reserved=\"#{@reserved}\""
+    end
   end
 end

data/lib/so_far_so_good/clauses.rb

@@ -4,17 +4,23 @@ module SoFarSoGood
 
       HEADINGS = ["Clause", "Description"]
 
-      def numbers
-        @numbers ||= clauses.map { |c| c.number }
+      def numbers(options = {})
+        @numbers ||= clauses(options).map { |c| c.number }
       end
 
-      def subjects
-        @subjects ||= clauses.map { |c| c.subject }
+      def subjects(options = {})
+        @subjects ||= clauses(options).map { |c| c.subject }
       end
       alias_method :descriptions, :subjects
 
-      def clauses
+      def clauses(options = {})
+        options = {:exclude_reserved => false}.merge(options)
         @clauses ||= sections.map { |node| SoFarSoGood::Clause.new(node) }
+        if options[:exclude_reserved]
+          @clauses.reject { |c| c.reserved }
+        else
+          @clauses
+        end 
       end
       alias_method :list, :clauses
 
@@ -23,7 +29,11 @@ module SoFarSoGood
       end
 
       def to_json
-        @json ||= sections.to_json
+        @json ||= clauses.to_json
+      end
+
+      def [](number)
+        clauses.find { |c| c.number == number }
       end
 
       private
@@ -42,8 +52,8 @@ module SoFarSoGood
         @subpart ||= doc.css("PART SUBPART")[4].children.css("SECTION")
       end
 
-      def rows
-        @rows ||= clauses.reject { |c| c.reserved }.map { |c| [c.number, c.subject]}
+      def rows(options={})
+        @rows ||= clauses(options).map { |c| [c.number, c.subject]}
       end
     end
   end

data/lib/so_far_so_good/version.rb

@@ -1,3 +1,3 @@
 module SoFarSoGood
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/so_far_so_good_clause_test.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestSoFarSoGoodClause < Minitest::Test
+
+  def setup
+    @nodes = SoFarSoGood::Clauses.send(:sections)
+  end
+
+  should "parse a section node" do
+    clause = SoFarSoGood::Clause.new(@nodes[6])
+    assert_equal "52.203-5", clause.number
+    assert_equal "Covenant Against Contingent Fees.", clause.subject
+    refute clause.reserved
+    assert_includes clause.citation, "48 FR 42478"
+    assert_includes clause.body, "As prescribed in 3.404,"
+    assert_includes clause.extract, "The Contractor warrants that no person or agency"
+  end
+
+  should "know if its reserved" do
+    refute SoFarSoGood::Clauses["52.203-5"].reserved?
+    assert SoFarSoGood::Clauses["52.203-1"].reserved?
+  end
+
+  should "put out valid json" do
+    assert JSON.parse SoFarSoGood::Clauses["52.203-5"].to_json
+  end
+end

data/test/so_far_so_good_clauses_test.rb

@@ -10,7 +10,7 @@ class TestSoFarSoGoodClauses < Minitest::Test
   end
 
   should "parse the rows" do
-    assert_equal 567, SoFarSoGood::Clauses.send(:rows).count
+    assert_equal 616, SoFarSoGood::Clauses.send(:rows).count
     assert_equal ["52.200", "Scope of subpart."], SoFarSoGood::Clauses.send(:rows).first
   end
 
@@ -27,4 +27,16 @@ class TestSoFarSoGoodClauses < Minitest::Test
   should "put out valid JSON" do
     assert !!JSON.parse(SoFarSoGood::Clauses.list.to_json)
   end
+
+  should "return a particular clause" do
+    assert_equal "52.202-1", SoFarSoGood::Clauses["52.202-1"].number
+  end
+
+  should "return all clauses" do
+    assert_equal 616, SoFarSoGood::Clauses.list.count
+  end
+
+  should "filter reserved clauses" do
+    assert_equal 567, SoFarSoGood::Clauses.list(:exclude_reserved => true).count
+  end
 end

data/test/so_far_so_good_test.rb

@@ -9,4 +9,8 @@ class TestSoFarSoGood < Minitest::Test
     assert_equal Array, SoFarSoGood.clauses.class
     assert_equal 616, SoFarSoGood.clauses.count
   end
+
+  should "accept clause options" do
+    assert_equal 567, SoFarSoGood.clauses(:exclude_reserved => true).count
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: so_far_so_good
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Balter
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -118,6 +119,7 @@ files:
 - script/vendor
 - so_far_so_good.gemspec
 - test/helper.rb
+- test/so_far_so_good_clause_test.rb
 - test/so_far_so_good_clauses_test.rb
 - test/so_far_so_good_test.rb
 - vendor/CFR-2010-title48-vol2-chap1-subchapH.xml
@@ -147,5 +149,6 @@ specification_version: 4
 summary: ''
 test_files:
 - test/helper.rb
+- test/so_far_so_good_clause_test.rb
 - test/so_far_so_good_clauses_test.rb
 - test/so_far_so_good_test.rb