ruby-marc-spec 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f746cbe6bce86ac23cfc75c9b01c96c7127788af8ddffa81fa8e720bc015e3bd
-  data.tar.gz: ff794cf138047fc798728671174c916069dba82da231cc0f306519cfba982772
+  metadata.gz: 54b13628142e544532fa38aff52eae04766e17c1bdfbfab6736c1ad1d6aa9a38
+  data.tar.gz: 498bd3f6ee88e2c41ef1ae95de9fabc1f5987d59944128f6853f54ec205168a8
 SHA512:
-  metadata.gz: 328630cb81f72b2653b6bae02a16a957b0a1eeb55ae9be7b74eb79c68225046db0a937dbf09ebcf82f4529346849e5736462e1afc6c52b889ec32adec214e29c
-  data.tar.gz: 6364636fdc30a08461f9636dd9cf99027f161a953487b64053a0c0a93feffc78236bc003f2973233a58d8947220d9bc1b1e694b08f9ef1b75b380cb17bc383ad
+  metadata.gz: 2c4cc664defc35600518fef9eb9ee1c8a3241b654cee78e114b8284399e965d9d4e09de4ea7232579198032b54a93543292d5c5cbc5697bfd10462b0ff4f816a
+  data.tar.gz: 0c8891024722e38dbc4a1f776f356b8d4411cb2f439f01904dad5b9ec8c0a12692147fb86805a38edea376fb8ac25d7159c75c5762f1e1b59fd492367539fe34

data/.idea/{marc_spec.iml → marc-spec.iml}

@@ -69,7 +69,7 @@
           </RakeTaskImpl>
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Run tests, check test coverage, check code style" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build marc-spec.gemspec as marc-spec-0.1.0.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build ruby-marc-spec.gemspec as ruby-marc-spec-0.1.0.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop with auto-correct, and output results to console" fullCommand="ra" id="ra" />
           <RakeTaskImpl description="Run rubocop with HTML output" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">

data/.idea/modules.xml

@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ProjectModuleManager">
     <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/marc_spec.iml" filepath="$PROJECT_DIR$/.idea/marc_spec.iml" />
+      <module fileurl="file://$PROJECT_DIR$/.idea/marc-spec.iml" filepath="$PROJECT_DIR$/.idea/marc-spec.iml" />
     </modules>
   </component>
-</project>
+</project>

data/CHANGES.md

@@ -1,3 +1,18 @@
-# 0.1.0 (2021-03-15)
+# 0.1.1 (2021-10-18)
+
+- `MARC::Spec` methods now raise an `ArgumentError` for invalid query strings
+  instead of returning a raw `Parslet::ParseFailed`.
+- Add `MARC::Spec#parse_query` and `MARC::Spec#execute_query` to facilitate
+  caching parsed query objects. (Not that parsing is expensive, but sometimes
+  it's convenient to be able to treat the query as a structured object rather
+  than a string.)
+- Add `MARC::Spec::Queries::Query#tag_str` to retrieve the MARC tag specifier
+  from a query object. Note that this returns a MARCSpec `fieldTag` string
+  (which may include `.` wildcard characters), plus an optional, bracketed
+  `index`. For more information see 
+  [9.2 Reference to field data](http://marcspec.github.io/MARCspec/marc-spec.html#reference-to-field-data)
+  in the MARCSpec docs.
+
+# 0.1.0 (2021-10-15)
 
 - Initial release.

data/README.md

@@ -1,5 +1,5 @@
 [![Build Status](https://github.com/BerkeleyLibrary/marc-spec/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/BerkeleyLibrary/marc-spec/actions/workflows/build.yml)
-[![Gem Version](https://img.shields.io/gem/v/ruby-marc-spec.svg)](https://github.com/ruby-marc-spec/releases)
+[![Gem Version](https://img.shields.io/gem/v/ruby-marc-spec.svg)](https://rubygems.org/gems/ruby-marc-spec)
 
 # MARC::Spec
 

data/lib/marc/spec/module_info.rb

@@ -7,7 +7,7 @@ module MARC
       SUMMARY = 'MARCspec for Ruby'.freeze
       DESCRIPTION = 'An implementation of the MARCspec query language for Ruby and ruby-marc'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.1'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/marc-spec'.freeze
     end
   end

data/lib/marc/spec/queries/query.rb

@@ -18,6 +18,10 @@ module MARC
           @subqueries = subqueries.map { |sq| ensure_type(sq, Query) }
         end
 
+        def tag_str
+          tag.to_s if tag
+        end
+
         def to_s
           StringIO.new.tap do |out|
             out << tag if tag

data/lib/marc/spec/queries/query_executor.rb

@@ -41,6 +41,7 @@ module MARC
         private
 
         def as_query(root)
+          # TODO: unify these?
           return root if root.is_a?(Query)
           return Query.new(tag: root) if root.is_a?(Tag)
         end

data/lib/marc/spec.rb

@@ -3,15 +3,24 @@ Dir.glob(File.expand_path('spec/*.rb', __dir__)).sort.each(&method(:require))
 module MARC
   module Spec
     class << self
+
       def find(query_string, marc_record)
         root = parse_query(query_string)
-        executor = Queries::QueryExecutor.new(marc_record, root)
-        executor.execute
+        execute_query(root, marc_record)
       end
 
       def parse_query(query_string)
         parse_tree = parser.parse(query_string, reporter: reporter)
-        xform.apply(parse_tree)
+        xform_result = xform.apply(parse_tree)
+        # TODO: unify these?
+        xform_result.is_a?(Queries::Query) ? xform_result : Queries::Query.new(tag: xform_result)
+      rescue Parslet::ParseFailed => e
+        raise ArgumentError, "Unable to parse query: #{query_string.inspect}: #{e}"
+      end
+
+      def execute_query(query, marc_record)
+        executor = Queries::QueryExecutor.new(marc_record, query)
+        executor.execute
       end
 
       private

data/spec/marc/spec/queries/query_spec.rb

@@ -25,13 +25,12 @@ module MARC::Spec
         aggregate_failures { examples.each { |query_str, expected| verify_result(query_str, expected) } }
       end
 
-      def query_from(query_str)
-        parse_tree = parser.parse(query_str)
-        xform.apply(parse_tree)
+      def parse_query(query_str)
+        MARC::Spec.parse_query(query_str)
       end
 
       def verify_result(query_str, expected)
-        query = query_from(query_str)
+        query = parse_query(query_str)
         executor = QueryExecutor.new(marc_record, query)
         actual = executor.execute
 
@@ -62,7 +61,7 @@ module MARC::Spec
             '245^1{=\\0}',
             '245$a{$b=\\t}$c$d'
           ].each do |query_str|
-            query = query_from(query_str)
+            query = parse_query(query_str)
             str = query.to_s
             expect(str).not_to include('nil')
             all_elements = ([query.tag, query.selector] + query.subqueries).compact
@@ -73,6 +72,23 @@ module MARC::Spec
         end
       end
 
+      describe :tag_str do
+        it 'returns the tag' do
+          examples = {
+            '245$a{$b=\\t}$c$d' => '245',
+            '...$a$c' => '...',
+            '008/22{LDR/6=\b}' => '008',
+            '008[0]/3{/0=\a}' => '008[0]'
+          }
+          aggregate_failures do
+            examples.each do |query_str, expected|
+              query = parse_query(query_str)
+              expect(query.tag_str).to eq(expected)
+            end
+          end
+        end
+      end
+
       describe :to_s_inspect do
         it 'includes all elements' do
           # noinspection RubyLiteralArrayInspection
@@ -84,7 +100,7 @@ module MARC::Spec
             '245^1{=\\0}',
             '245$a{$b=\\t}$c$d'
           ].each do |query_str|
-            query = query_from(query_str)
+            query = parse_query(query_str)
             inspect_str = query.inspect
             expect(inspect_str).not_to include('nil')
             all_elements = ([query.tag, query.selector] + query.subqueries).compact

data/spec/{marc_spec_spec.rb → marc/spec_spec.rb}

@@ -38,6 +38,12 @@ describe MARC::Spec do
     end
   end
 
+  describe :parse_query do
+    it 'raises ArgumentError for an invalid query' do
+      expect { MARC::Spec.parse_query('not a query') }.to raise_error(ArgumentError)
+    end
+  end
+
   describe 'non-repeated subfields' do
     before(:each) do
       @marc_record = MARC::XMLReader.new('spec/data/sandburg.xml').first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-marc-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-16 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marc
@@ -224,7 +224,7 @@ files:
 - ".idea/codeStyles/codeStyleConfig.xml"
 - ".idea/go.imports.xml"
 - ".idea/inspectionProfiles/Project_Default.xml"
-- ".idea/marc_spec.iml"
+- ".idea/marc-spec.iml"
 - ".idea/misc.xml"
 - ".idea/modules.xml"
 - ".idea/templateLanguages.xml"
@@ -312,7 +312,7 @@ files:
 - spec/marc/spec/queries/subfield_value_spec.rb
 - spec/marc/spec/queries/tag_spec.rb
 - spec/marc/spec/queries/transform_spec.rb
-- spec/marc_spec_spec.rb
+- spec/marc/spec_spec.rb
 - spec/scratch_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/BerkeleyLibrary/marc-spec