so_far_so_good 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0ca888a79d1abea3f16bac6d5fa7706cc1b2c10
-  data.tar.gz: fa8aa37486a39179474fdbef201352217ae3f596
+  metadata.gz: 89ca68bf267662afde3f952d21d46565546f8278
+  data.tar.gz: 76dc75b71d6764960d11e45c4a6f6d4b2b39312f
 SHA512:
-  metadata.gz: 2f54bb0f2a247aaeb8a2b4199f5c98d573e815494634821f1f6c7c8a9c2c4d33b40519723b8bc1a56767d8d4d0a31bfff7c9ef1388d7da2053596dfadeadd545
-  data.tar.gz: 42aa3e271d119b52e5ed3a646838e82f5a8c5a830a246ff1f5bab5dfbde384c03d61a11d0ccf7b3b35d8e8ffa396b3fb9f2f17d79d698d06937a5b11342945d0
+  metadata.gz: d6a7d2876d9c40b48d0f6b504bd52e184865634f6667c76e995c04175a1fbd512d69a44e67742e2c888ae893f660f019f529882fa510248493eff648005270a1
+  data.tar.gz: dd43c8d95edb8a176f242bc596c4c0ca99533e588962f6efe81c5f7c25d9f1912f836ba328d30e122258d4922e7d4300907ff141bbdbf4bca043827cecb8e492

data/README.md

@@ -75,11 +75,17 @@ clause.extract
 
 ### Using clause data elsewhere
 
+#### As JSON
+
 ```ruby
 
 SoFarSoGood::Clauses.list.to_json
 => "[{\"number\":\"52.200\",\"subject\":\"Scope of subpart.\",\"reserverd\":false,\"citation\":..."
+```
+
+#### As a markdown table
 
+```ruby
 puts SoFarSoGood::Clauses.to_md
 |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Clause    | Description                                                                                                                                                   |
@@ -89,8 +95,36 @@ puts SoFarSoGood::Clauses.to_md
 | 52.203-2  | Certificate of Independent Price Determination.                                                                                                               |
 | 52.203-3  | Gratuities.                                                                                                                                                   |
 | 52.203-5  | Covenant Against Contingent Fees.                                                                                                                             |
+...
+
+# Table without reserved clauses
+puts SoFarSoGood::Clauses.to_md(:exclude_reserved => true)
+
+# Table with links to text
+puts SoFarSoGood::Clauses.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.                                                                                                                               |
+| [52.222-36](http://www.law.cornell.edu/cfr/text/48/52.222-36) | Affirmative Action for Workers With Disabilities.                                                                                                             |
+| [52.222-37](http://www.law.cornell.edu/cfr/text/48/52.222-37) | Employment Reports on Veterans.                                                                                                                               |
+| [52.222-38](http://www.law.cornell.edu/cfr/text/48/52.222-38) | Compliance with Veterans' Employment Reporting Requirements.                                                                                                  |
+| [52.222-41](http://www.law.cornell.edu/cfr/text/48/52.222-41) | Service Contract Act of 1965.
+...
 ```
 
+#### Individual clauses as markdown
+
+```ruby
+# The body
+puts SoFarSoGood::Clauses["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)
+=> ### 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— ...
+```
 
 ## Installation
 

data/lib/so_far_so_good.rb

@@ -1,6 +1,7 @@
 require "nokogiri"
 require "terminal-table"
 require "json"
+require "reverse_markdown"
 require_relative "so_far_so_good/version"
 require_relative "so_far_so_good/clauses"
 require_relative "so_far_so_good/clause"

data/lib/so_far_so_good/clause.rb

@@ -1,43 +1,79 @@
 module SoFarSoGood
   class Clause
 
-    attr_reader :number
-    attr_reader :subject
-    attr_reader :reserved
-    attr_reader :citation
-    attr_reader :extract
-    attr_reader :body
+    attr_reader :node
 
     def initialize(node)
-      @number = node.css("SECTNO").text.strip
-      @subject = node.css("SUBJECT, RESERVED").text.strip
-      @reserved = !node.css("RESERVED").text.empty?
-      @citation = node.css("CITA").text.strip
-      @extract = node.css("EXTRACT").text.strip
-      @body = node.children.css("P").text.strip
+      @node = node
+      normalize!
+    end
+
+    def number
+      @number ||= node.css("SECTNO").text.strip
+    end
+
+    def subject
+      @subject ||= node.css("SUBJECT, RESERVED").text.strip
     end
 
     def reserved?
-      !!@reserved
+      @reserved ||= !node.css("RESERVED").text.empty?
+    end
+    alias_method :reserved, :reserved?
+
+    def citation
+      @citation ||= node.css("CITA").text.strip
+    end
+
+    def link
+      @link ||= "http://www.law.cornell.edu/cfr/text/48/#{number}"
     end
 
-    def to_hash
+    def extract(options = {})
+      options = {:format => :html}.merge(options)
+      @extract ||= node.css("EXTRACT").inner_html
+      if options[:format] == :markdown
+        ReverseMarkdown.convert @extract
+      else
+        @extract
+      end
+    end
+
+    def body(options = {})
+      options = {:format => :html}.merge(options)
+      @body ||= node.css("> P").to_html
+      if options[:format] == :markdown
+        ReverseMarkdown.convert @body
+      else
+        @body
+      end
+    end
+
+    def to_hash(options={})
       {
-        :number    => @number,
-        :subject   => @subject,
-        :reserverd => @reserved,
-        :citation  => @citation,
-        :extract   => @extract,
-        :body      => @body
+        :number    => number,
+        :subject   => subject,
+        :reserverd => reserved,
+        :citation  => citation,
+        :extract   => extract(options),
+        :body      => body(options),
+        :link      => link
       }
     end
 
     def to_json(options = {})
-      to_hash.to_json(options)
+      to_hash(options).to_json(options)
     end
 
     def inspect
       "#<SoFarSoGood::Clause @number=\"#{@number}\" @subject=\"#{@subject}\" @reserved=\"#{@reserved}\""
     end
+
+    private
+
+    def normalize!
+      node.children.css("E").each { |n| n.name = "em" }
+      node.children.css("HD").each { |n| n.name = "h3" }
+    end
   end
 end

data/lib/so_far_so_good/clauses.rb

@@ -20,16 +20,18 @@ module SoFarSoGood
           @clauses.reject { |c| c.reserved }
         else
           @clauses
-        end 
+        end
       end
       alias_method :list, :clauses
 
-      def to_md
-        @md ||= Terminal::Table.new(:rows => rows, :style => { :border_i => "|" }, :headings => HEADINGS).to_s
+      def to_md(options = {})
+        options = {:exclude_reserved => false, :links => false}.merge(options)
+        rows = clauses(options).map { |c| [ options[: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
-        @json ||= clauses.to_json
+      def to_json(options = {})
+        clauses(options).to_json(options)
       end
 
       def [](number)
@@ -39,7 +41,7 @@ module SoFarSoGood
       private
 
       def source_path
-        File.expand_path "CFR-2010-title48-vol2-chap1-subchapH.xml", SoFarSoGood.vendor_directory
+        @source_path ||= File.expand_path "CFR-2010-title48-vol2-chap1-subchapH.xml", SoFarSoGood.vendor_directory
       end
 
       def doc
@@ -51,10 +53,6 @@ module SoFarSoGood
       def sections
         @subpart ||= doc.css("PART SUBPART")[4].children.css("SECTION")
       end
-
-      def rows(options={})
-        @rows ||= clauses(options).map { |c| [c.number, c.subject]}
-      end
     end
   end
 end

data/lib/so_far_so_good/version.rb

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

data/so_far_so_good.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "nokogiri"
   spec.add_dependency "terminal-table"
+  spec.add_dependency "reverse_markdown"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency('pry', '~> 0.9')

data/test/so_far_so_good_clause_test.rb

@@ -4,16 +4,35 @@ class TestSoFarSoGoodClause < Minitest::Test
 
   def setup
     @nodes = SoFarSoGood::Clauses.send(:sections)
+    @clause = SoFarSoGood::Clause.new(@nodes[6])
   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"
+  should "Store the node" do
+    assert Nokogiri::XML::Element, @clause.node.class
+  end
+
+  should "expose the clause number" do
+    assert_equal "52.203-5", @clause.number
+  end
+
+  should "expose the clause subject" do
+    assert_equal "Covenant Against Contingent Fees.", @clause.subject
+  end
+
+  should "know the cite" do
+    assert_includes @clause.citation, "48 FR 42478"
+  end
+
+  should "know the clause body" do
+    assert_includes @clause.body, "As prescribed in 3.404,"
+  end
+
+  should "not include the extract in the clause body" do
+    refute_includes @clause.body, "The Contractor warrants that no person or agency"
+  end
+
+  should "know the clause extract" do
+    assert_includes @clause.extract, "The Contractor warrants that no person or agency"
   end
 
   should "know if its reserved" do
@@ -21,6 +40,18 @@ class TestSoFarSoGoodClause < Minitest::Test
     assert SoFarSoGood::Clauses["52.203-1"].reserved?
   end
 
+  should "convert the body to markdown" do
+    assert_includes @clause.body(:format => :markdown), "As prescribed in 3.404, insert the following clause:\n\n"
+  end
+
+  should "convert the extract to markdown" do
+    assert_includes @clause.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", @clause.link
+  end
+
   should "put out valid json" do
     assert JSON.parse SoFarSoGood::Clauses["52.203-5"].to_json
   end

data/test/so_far_so_good_clauses_test.rb

@@ -9,11 +9,6 @@ class TestSoFarSoGoodClauses < Minitest::Test
     assert Nokogiri::XML::Document, SoFarSoGood::Clauses.send(:doc).class
   end
 
-  should "parse the rows" do
-    assert_equal 616, SoFarSoGood::Clauses.send(:rows).count
-    assert_equal ["52.200", "Scope of subpart."], SoFarSoGood::Clauses.send(:rows).first
-  end
-
   should "parse section numbers" do
     assert_equal 616, SoFarSoGood::Clauses.numbers.count
     assert_equal "52.200", SoFarSoGood::Clauses.numbers.first
@@ -39,4 +34,16 @@ class TestSoFarSoGoodClauses < Minitest::Test
   should "filter reserved clauses" do
     assert_equal 567, SoFarSoGood::Clauses.list(:exclude_reserved => true).count
   end
+
+  should "build the markdown table" do
+    assert_includes SoFarSoGood::Clauses.to_md, "-|\n| 52.200              | Scope of subpart."
+  end
+
+  should "exclude reserved in markdown table when asked" do
+    refute_includes SoFarSoGood::Clauses.to_md(:exclude_reserved => true), "[Reserved]"
+  end
+
+  should "inlcude links in markdown table when asked" do
+    assert_includes SoFarSoGood::Clauses.to_md(:links => true), "[52.252-6](http://www.law.cornell.edu/cfr/text/48/52.252-6)"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: so_far_so_good
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Balter
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement