so_far_so_good 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab77e766152edb727d4513fc59371d119f0339b3
-  data.tar.gz: fd27195a2227fa669f86d93593a5eeded9c8310c
+  metadata.gz: c3de507b8e6d2e3821b5683474725eaffa542e24
+  data.tar.gz: 543852db29e69e7521469bf315e0d078fa5e139e
 SHA512:
-  metadata.gz: 305cdec6f88a0555b7af3504414b48814e8927efc19b42e93746f553a69f9b9d181e5bfe748db258ed242b7c51bd5d758faf47fa236f07fbf28329d5acb3263f
-  data.tar.gz: 09d6f2de3a92e53f8f3e7079b89fa18793fd588d522738ead0e9969f48a8ebd5ef09216d28365df55845b7dcc66470d43914d541566ffb8348126fb8149d2475
+  metadata.gz: 7f902bb7820a3bc257a77f04e1b627f8c59d0690ee4169bd8ac4b6e4e2360edc523cdd0e5205fea3700359694237d6424c14af3e3d951eb3ef7e303f8afba984
+  data.tar.gz: 1c731803816dea74afab78fec805e65f30113597cf3a33199cc7124c99a07151734415d7d4eca8fac74a6f3bc62cb200e58b0868b17b2a15e3f36b71b6e2440d

data/README.md

@@ -1,12 +1,12 @@
 # So FAR so Good
 
-A Ruby Gem to parse and manipulate the Federal Acquisition Regulation (FAR) and Defense Federal Acquisition Regulation Supplement (DFARs)
+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 (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.
+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:
 
@@ -27,7 +27,7 @@ It will give you access to this information in object-oriented Ruby, as JSON, or
 ```ruby
 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">]
+    #<SoFarSoGood::Subchapter year=2013 title=48 volume=3 chapter=2 name="DFARS">]
 
 # Get the FAR's subparts
 subparts = SoFarSoGood.far.subparts

data/bin/far

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/so_far_so_good"
+clause = SoFarSoGood[ARGV[0]]
+
+if ARGV[0].nil? || ARGV[0] == "--help"
+  puts "Usage: far [CLAUSE NUMBER]"
+elsif clause
+  puts clause.extract(:format => :markdown)
+else
+  puts "Not found."
+end

data/lib/so_far_so_good/subchapter.rb

@@ -75,8 +75,12 @@ module SoFarSoGood
       @source_path ||= File.expand_path filename, SoFarSoGood.vendor_directory
     end
 
+    def source_contents
+      File.open(source_path, :encoding => 'utf-8')
+    end
+
     def doc
-      @doc ||= Nokogiri::XML(File.open(source_path)) do |config|
+      @doc ||= Nokogiri::XML(source_contents) do |config|
         config.noblanks.nonet
       end
     end

data/lib/so_far_so_good/subpart.rb

@@ -6,15 +6,15 @@ module SoFarSoGood
     attr_reader :title
     attr_reader :volume
     attr_reader :chapter
-    attr_reader :document
+    attr_reader :subchapter
 
     def initialize(hash)
-      @year     = hash[:year]
-      @title    = hash[:title]
-      @volume   = hash[:volume]
-      @chapter  = hash[:chapter]
-      @document = hash[:name]
-      @node     = hash[:node]
+      @year       = hash[:year]
+      @title      = hash[:title]
+      @volume     = hash[:volume]
+      @chapter    = hash[:chapter]
+      @subchapter = hash[:name]
+      @node       = hash[:node]
       normalize!
     end
 
@@ -61,18 +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,
-        :document  => document,
+        :year        => year,
+        :title       => title,
+        :volume      => volume,
+        :chapter     => chapter,
+        :number      => number,
+        :subject     => subject,
+        :reserverd   => reserved,
+        :citation    => citation,
+        :extract     => extract(options),
+        :body        => body(options),
+        :link        => link,
+        :subchapter  => subchapter,
       }
     end
 
@@ -81,7 +81,7 @@ module SoFarSoGood
     end
 
     def inspect
-      "#<SoFarSoGood::Subpart year=#{year} title=#{title} volume=#{volume} chapter=#{chapter} number=\"#{number}\" subject=\"#{subject}\" document=\"#{document}\" reserved=#{reserved}>"
+      "#<SoFarSoGood::Subpart year=#{year} title=#{title} volume=#{volume} chapter=#{chapter} number=\"#{number}\" subject=\"#{subject}\" subchapter=\"#{subchapter}\" reserved=#{reserved}>"
     end
 
     private

data/lib/so_far_so_good/version.rb

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

data/lib/so_far_so_good.rb

@@ -19,7 +19,7 @@ module SoFarSoGood
     end
 
     def dfars
-      @dfars ||= SoFarSoGood::Subchapter.new(:name => "DFARs", :volume => 3, :chapter => 2)
+      @dfars ||= SoFarSoGood::Subchapter.new(:name => "DFARS", :volume => 3, :chapter => 2)
     end
 
     def subchapters

data/test/so_far_so_good_bin_test.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+class TestSoFarSoGoodBin < Minitest::Test
+  should "work via CLI" do
+    output = `bundle exec far 52.222-3`
+    assert output.include? "Convict Labor"
+  end
+end

data/test/so_far_so_good_test.rb

@@ -12,7 +12,7 @@ class TestSoFarSoGood < Minitest::Test
 
   should "know the DFARs" do
     assert_equal SoFarSoGood::Subchapter, SoFarSoGood.dfars.class
-    assert_equal "DFARs", SoFarSoGood.dfars.name
+    assert_equal "DFARS", SoFarSoGood.dfars.name
   end
 
   should "return subchapters" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: so_far_so_good
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -111,7 +111,8 @@ dependencies:
 description: ''
 email:
 - ben.balter@github.com
-executables: []
+executables:
+- far
 extensions: []
 extra_rdoc_files: []
 files:
@@ -121,6 +122,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/far
 - lib/so_far_so_good.rb
 - lib/so_far_so_good/subchapter.rb
 - lib/so_far_so_good/subpart.rb
@@ -132,6 +134,7 @@ files:
 - script/vendor
 - so_far_so_good.gemspec
 - test/helper.rb
+- test/so_far_so_good_bin_test.rb
 - test/so_far_so_good_subchapter_test.rb
 - test/so_far_so_good_subpart_test.rb
 - test/so_far_so_good_test.rb
@@ -163,6 +166,7 @@ specification_version: 4
 summary: ''
 test_files:
 - test/helper.rb
+- test/so_far_so_good_bin_test.rb
 - test/so_far_so_good_subchapter_test.rb
 - test/so_far_so_good_subpart_test.rb
 - test/so_far_so_good_test.rb