jcrvalidator 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1092c1613500ed477ee3eb26367ed73fee3a940f
-  data.tar.gz: 824cdfcc22c6dc6a03d55bc10ad75857c881c627
+  metadata.gz: 61807efb31326c093b5f71984a9ee55e41710598
+  data.tar.gz: d6184f8217ff27d09729397af1a43a493d972cff
 SHA512:
-  metadata.gz: 6f6f55143125ef7cf87457a53bb66edb4c3b353fb710e8513cf85e893f969d7cb3b95a78d98429fef5c55b8b25fb4306455ecb1cf9c77c449c71d1ad2dedba84
-  data.tar.gz: 9539a3d5ad7577a119f30bb69596c8cb279d1d45818574b26f22c1f71613cac0ba785268a56797f57266b5533de8cc159fa42f9055643d8272a141642b024813
+  metadata.gz: 90dce4aefb3417a50651f442b5e14d329f339b7c9ddafb9dbddfdac8ef21c52555354024a776420ef619bc75398ba9935f682b90c905bd0db58fab4f19ba5d0a
+  data.tar.gz: 432da197590f3454f5eca393b33d9e43b7ce54a27b8a938af0a0397961e328ff6f8c6c62605819d6407c0ed7544df587fa55b0f52040205facea3c255b66cae9

data/lib/jcr/jcr.rb

@@ -24,6 +24,7 @@ require 'jcr/find_roots'
 require 'jcr/map_rule_names'
 require 'jcr/process_directives'
 require 'jcr/version'
+require 'jcr/parts'
 
 module JCR
 
@@ -198,6 +199,10 @@ module JCR
         options[:testjcr] = true
       end
 
+      opt.on("--process-parts", "creates smaller files for specification writing" ) do |parts|
+        options[:process_parts] = true
+      end
+
       opt.on("-S STRING","name of root rule. All roots will be tried if none is specified") do |root_name|
         if options[:root_name]
           puts "A root has already been specified. Use -h for help.", ""
@@ -283,6 +288,11 @@ module JCR
           end
         end
 
+        if options[:process_parts]
+          parts = JCR::JcrParts.new
+          parts.process_ruleset( options[:ruleset] )
+        end
+
         if options[:testjcr]
           #we got this far which means the JCR was already parsed without
           #issue. therefore return 0

data/lib/jcr/parts.rb

@@ -0,0 +1,107 @@
+# Copyright (c) 2017 American Registry for Internet Numbers
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+# IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+module JCR
+
+  # This class extracts parts of a JCR file into multiple files based
+  # on comments in the file. It can also create a new file without the
+  # comments. This is useful for JCR going into specification documents
+  # where it is nice to break the JCR up for illustrative purposes in
+  # the specification but to also have one JCR file for programmatic
+  # testing purposes.
+  #
+  # The file parts are extracted using the comments
+  #   ; start_part FILENAME
+  # and
+  #   ; end_part
+  # The comments must also be the only thing present on the line
+  # though leading whitespace is allowed if desired.
+  #
+  # To get a new file with all parts be these comments, use this
+  #   ; all_parts FILENAME
+
+  class JcrParts
+
+    # Determines if the the line is a start_part comment.
+    # Return the file name otherwise nil
+    def get_start( line )
+      retval = nil
+      m = /^\s*;\s*start_part\s*(.+)[^\s]*/.match( line )
+      if m && m[1]
+        retval = m[1]
+      end
+      return retval
+    end
+
+    # Determines if the the line is an all_parts comment.
+    # Return the file name otherwise nil
+    def get_all( line )
+      retval = nil
+      m = /^\s*;\s*all_parts\s*(.+)[^\s]*/.match( line )
+      if m && m[1]
+        retval = m[1]
+      end
+      return retval
+    end
+
+    # Determines if the the line is an end_parts comment.
+    # Return true otherwise nil
+    def get_end( line )
+      retval = nil
+      m = /^\s*;\s*end_part/.match( line )
+      if m
+        retval = true
+      end
+      return retval
+    end
+
+    # processes the lines
+    # ruleset is to be a string read in using File.read
+    def process_ruleset( ruleset )
+      all_parts = []
+      all_parts_name = nil
+      current_part = nil
+      current_part_name = nil
+      ruleset.lines do |line|
+        if !all_parts_name && ( all_parts_name = get_all( line ) )
+          # do_nothing
+        elsif ( current_part_name = get_start( line ) )
+          if current_part
+            current_part.close
+          end
+          current_part = File.open( current_part_name, "w" )
+        elsif get_end( line ) && current_part
+          current_part.close
+          current_part = nil
+        elsif current_part
+          current_part.puts line
+          all_parts << line
+        else
+          all_parts << line
+        end
+      end
+      if current_part
+        current_part.close
+      end
+      if all_parts_name
+        f = File.open( all_parts_name, "w" )
+        all_parts.each do |line|
+          f.puts( line )
+        end
+        f.close
+      end
+    end
+
+  end
+end

data/lib/jcr/version.rb

@@ -15,6 +15,6 @@
 
 module JCR
 
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jcrvalidator
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrew Newton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-03 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -68,7 +68,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.4
 description: A JSON Content Rules (JCR) Validator library and command line utility.
-  Version 0.6.x is closely following -07 of the draft.
 email: andy@arin.net
 executables:
 - jcr
@@ -88,6 +87,7 @@ files:
 - lib/jcr/jcr.rb
 - lib/jcr/map_rule_names.rb
 - lib/jcr/parser.rb
+- lib/jcr/parts.rb
 - lib/jcr/process_directives.rb
 - lib/jcr/version.rb
 homepage: https://github.com/arineng/jcrvalidator