bismas 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533b760c35ba8c4d29776069ba3777b33f393769
-  data.tar.gz: e432c79eaa46cdc5f6a2f6d8dc83c63d89062ade
+  metadata.gz: 8ae215ed4b1adaed8471ecaf319041ae06770705
+  data.tar.gz: d4e5afa18a2477746e3992ac4196dd0748be119f
 SHA512:
-  metadata.gz: 3c8394bd9f4b7884affa87a4db9aa74ef7d6259c1c72fda722f3d720b70c83afc8831b3d6181fe1a9f0f2c56a801eefcf0e75ba35f40256090f2f530eec68206
-  data.tar.gz: 8ede1a58a6ff0575d756449c70beeaa1ccafcbcf9a8ede32b35e72171b8d24e4a32dfc718df5d4f52d91dea17e65c91ff182755bf637ae8b411a97e3f52da54d
+  metadata.gz: 74b319b187ee8d4588ff4c0e56f2587bcbf492090191bd20d3081db375c102de4256c0f6b9509228f19b0a367537c993245440b7120a88d79d8828c099654a69
+  data.tar.gz: a103746577801923d8536bdc30fd02c370c1c5a70b1c6db50a96b0e9df8f10cec5075ee4efbc021739b46c2e36f0fb85537d4b8e6b3d75916182c6c985ae8386

data/ChangeLog

@@ -2,6 +2,13 @@
 
 = Revision history for bismas
 
+== 0.5.0 [2016-06-06]
+
+* +bismas2xml+: Learned type +solr+.
+* +bismas2xml+: Learned option +output-encoding+.
+* +bismas2xml+, +bismas-filter+: Learned options +execute-before+ and
+  +execute-after+.
+
 == 0.4.0 [2016-02-02]
 
 * +bismas2xml+: Include input file's modification time.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to bismas version 0.4.0.
+This documentation refers to bismas version 0.5.0.
 
 
 == DESCRIPTION

data/Rakefile

@@ -13,7 +13,7 @@ begin
       email:        %q{jens.wille@gmail.com},
       license:      %q{AGPL-3.0},
       homepage:     :blackwinter,
-      dependencies: { cyclops: '~> 0.2', nuggets: '~> 1.4' },
+      dependencies: { cyclops: '~> 0.2', nuggets: '~> 1.5' },
 
       required_ruby_version: '>= 2.0'
     }

data/lib/bismas.rb

@@ -74,9 +74,27 @@ module Bismas
     XML.run(options, &block)
   end
 
+  def input_options(options, category_length = options[:category_length])
+    {
+      encoding:        options[:input_encoding],
+      key:             options[:input_key],
+      strict:          options[:strict],
+      silent:          options[:silent],
+      legacy:          options[:legacy],
+      category_length: category_length
+    }
+  end
+
+  def execute_options(options, keys = nil, &block)
+    execute(options.values_at(*keys ||
+      %i[execute_before execute execute_mapped execute_after]), &block)
+  end
+
   def execute(execute, &block)
     block ||= method(:abort)
 
+    outer_binding = nil
+
     execute.map { |value|
       value = Array(value).map { |code| case code
         when /\.rb\z/i then File.readable?(code) ?
@@ -85,7 +103,13 @@ module Bismas
         else block["Invalid code: #{code.inspect}"]
       end }
 
-      lambda { |bind| value.each { |code| eval(code, bind) } }
+      lambda { |bind|
+        !outer_binding ? outer_binding = bind :
+          (outer_binding.local_variables - bind.local_variables).each { |v|
+            bind.local_variable_set(v, outer_binding.local_variable_get(v)) }
+
+        value.each { |code| eval(code, bind) }
+      }
     }
   end
 

data/lib/bismas/cli.rb

@@ -43,6 +43,55 @@ module Bismas
       Bismas.require_gem(*args, &method(:abort))
     end
 
+    def unsupported_type(type, types = self.class::TYPES)
+      quit "Unsupported type: #{type}. Must be one of: #{types.join(', ')}."
+    end
+
+    def input_options(opts)
+      opts.separator
+      opts.separator 'Input options:'
+
+      opts.option(:input_encoding__ENCODING, :N, "Input encoding [Default: #{DEFAULT_ENCODING}]")
+
+      opts.separator
+
+      opts.option(:input_key__KEY, :K, 'ID key of input file')
+
+      opts.separator
+
+      opts.switch(:strict, :S, 'Turn parse warnings into errors')
+
+      opts.switch(:silent, :T, 'Silence parse warnings')
+
+      opts.separator
+
+      opts.switch(:legacy, :L, 'Use the legacy parser')
+    end
+
+    def type_option(opts, types = self.class::TYPES)
+      opts.option(:type__TYPE, "Output file type (#{types.join(', ')}) [Default: #{types.first}]")
+    end
+
+    def execute_options(opts)
+      opts.option(:execute__FILE_OR_CODE, 'Code to execute for each _record_ before mapping') { |e|
+        (options[:execute] ||= []) << e
+      }
+
+      opts.option(:execute_mapped__FILE_OR_CODE, :E, 'Code to execute for each _record_ after mapping') { |e|
+        (options[:execute_mapped] ||= []) << e
+      }
+
+      opts.separator
+
+      opts.option(:execute_before__FILE_OR_CODE, :B, 'Code to execute before processing records') { |e|
+        (options[:execute_before] ||= []) << e
+      }
+
+      opts.option(:execute_after__FILE_OR_CODE, :A, 'Code to execute after processing records') { |e|
+        (options[:execute_after] ||= []) << e
+      }
+    end
+
   end
 
 end

data/lib/bismas/cli/filter.rb

@@ -50,7 +50,7 @@ module Bismas
             options[:output_encoding] ||= Midos::DEFAULT_ENCODING
             Midos::Writer
           else
-            quit "Unsupported type: #{type}. Must be one of: #{TYPES.join(', ')}."
+            unsupported_type(type)
         end
 
         Bismas.filter(klass, options, &method(:quit))
@@ -65,29 +65,12 @@ module Bismas
 
         opts.option(:output__FILE, 'Path to output file [Default: STDOUT]')
 
-        opts.separator
-        opts.separator 'Input options:'
-
-        opts.option(:input_encoding__ENCODING, :N, "Input encoding [Default: #{DEFAULT_ENCODING}]")
-
-        opts.separator
-
-        opts.option(:input_key__KEY, :K, 'ID key of input file')
-
-        opts.separator
-
-        opts.switch(:strict, :S, 'Turn parse warnings into errors')
-
-        opts.switch(:silent, :T, 'Silence parse warnings')
-
-        opts.separator
-
-        opts.switch(:legacy, :L, 'Use the legacy parser')
+        input_options(opts)
 
         opts.separator
         opts.separator 'Output options:'
 
-        opts.option(:type__TYPE, "Output file type (#{TYPES.join(', ')}) [Default: #{TYPES.first}]")
+        type_option(opts)
 
         opts.separator
 
@@ -108,13 +91,7 @@ module Bismas
 
         opts.separator
 
-        opts.option(:execute__FILE_OR_CODE, 'Code to execute for each _record_ before mapping') { |e|
-          (options[:execute] ||= []) << e
-        }
-
-        opts.option(:execute_mapped__FILE_OR_CODE, :E, 'Code to execute for each _record_ after mapping') { |e|
-          (options[:execute_mapped] ||= []) << e
-        }
+        execute_options(opts)
 
         opts.separator
 

data/lib/bismas/cli/xml.rb

@@ -30,10 +30,20 @@ module Bismas
 
     class XML < self
 
+      TYPES = %w[bismas solr]
+
+      def self.defaults
+        super.merge(type: TYPES.first)
+      end
+
       def run(arguments)
         quit unless arguments.empty?
 
-        Bismas.to_xml(options, &method(:quit))
+        if TYPES.include?(type = options[:type])
+          Bismas.to_xml(options, &method(:quit))
+        else
+          unsupported_type(type)
+        end
       end
 
       private
@@ -47,33 +57,24 @@ module Bismas
 
         opts.option(:schema__FILE, 'Path to schema file [Required]')
 
-        opts.separator
-
-        opts.option(:encoding__ENCODING, :N, "Input encoding [Default: #{DEFAULT_ENCODING}]")
+        input_options(opts)
 
         opts.separator
+        opts.separator 'Output options:'
 
-        opts.option(:key__KEY, :K, 'ID key of input file')
+        type_option(opts)
 
         opts.separator
 
-        opts.option(:mapping__FILE_OR_YAML, 'Path to mapping file or YAML string')
+        opts.option(:output_encoding__ENCODING, :n, 'Output encoding')
 
         opts.separator
 
-        opts.option(:execute__FILE_OR_CODE, 'Code to execute for each _record_ before mapping') { |e|
-          (options[:execute] ||= []) << e
-        }
-
-        opts.option(:execute_mapped__FILE_OR_CODE, :E, 'Code to execute for each _record_ after mapping') { |e|
-          (options[:execute_mapped] ||= []) << e
-        }
+        opts.option(:mapping__FILE_OR_YAML, 'Path to mapping file or YAML string')
 
         opts.separator
 
-        opts.switch(:strict, :S, 'Turn parse warnings into errors')
-
-        opts.switch(:silent, :T, 'Silence parse warnings')
+        execute_options(opts)
       end
 
     end

data/lib/bismas/filter.rb

@@ -33,12 +33,12 @@ module Bismas
     extend Bismas
 
     def run(klass, options, &block)
-      execute = execute(options.values_at(*%i[execute execute_mapped]), &block)
+      execute = execute_options(options, &block)
       mapping = mapping(options[:mapping], &block)
 
       key_format = options[:key_format]
 
-      writer_options = {
+      reader_options, writer_options = input_options(options), {
         encoding:        encoding = options[:output_encoding],
         key:             options[:output_key],
         sort:            options[:sort],
@@ -46,24 +46,19 @@ module Bismas
         category_length: options[:category_length]
       }
 
-      reader_options = {
-        encoding:        options[:input_encoding],
-        key:             options[:input_key],
-        strict:          options[:strict],
-        silent:          options[:silent],
-        legacy:          options[:legacy],
-        category_length: options[:category_length]
-      }
+      execute[0][bind1 = binding]
 
       klass.open(options[:output], writer_options) { |writer|
         Reader.parse_file(options[:input], reader_options) { |id, record|
-          execute[0][bind = binding]
+          execute[1][bind2 = binding]
           record = mapping.apply(encode(record, encoding))
 
-          execute[1][bind]
+          execute[2][bind2]
           writer[key_format % id] = record
         }
       }
+
+      execute[3][bind1]
     end
 
   end

data/lib/bismas/version.rb

@@ -3,7 +3,7 @@ module Bismas
   module Version
 
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     TINY  = 0
 
     class << self

data/lib/bismas/xml.rb

@@ -44,41 +44,42 @@ module Bismas
 
       schema = Schema.parse_file(schema_file)
 
-      execute = execute(options.values_at(*%i[execute execute_mapped]), &block)
+      execute = execute_options(options, &block)
       mapping = mapping(options[:mapping], &block)
 
+      records_element, record_element = case options[:type].to_s
+        when 'solr' then %w[add doc]
+        else             %w[records record]
+      end
+
       records_attributes = {
         name:        schema.name,
         description: schema.title,
         mtime:       File.mtime(options[:input]).xmlschema
       }
 
-      reader_options = {
-        encoding:        options[:encoding],
-        key:             options[:key],
-        strict:          options[:strict],
-        silent:          options[:silent],
-        category_length: schema.category_length
-      }
+      reader_options = input_options(options, schema.category_length)
 
-      schema = mapping.apply(schema)
+      schema, encoding = mapping.apply(schema), options[:output_encoding]
+
+      execute[0][bind1 = binding]
 
       File.open_file(options[:output], {}, 'wb') { |f|
         xml = Builder::XmlMarkup.new(indent: 2, target: f)
+        xml.instance_eval("@encoding = #{encoding.inspect}") if encoding
         xml.instruct!
 
-        xml.records(records_attributes) {
+        xml.method_missing(records_element, records_attributes) {
           Reader.parse_file(options[:input], reader_options) { |id, record|
-            xml.record(id: id) {
-              execute[0][bind = binding]
-              record = mapping.apply(record)
+            xml.method_missing(record_element, id: id) {
+              execute[1][bind2 = binding]
+              record = mapping.apply(encode(record, encoding))
 
-              execute[1][bind]
+              execute[2][bind2]
               record.sort_by { |key,| key }.each { |key, values|
-                field_attributes = {
-                  name:        key,
-                  description: Array(schema[key]).join('/')
-                }
+                field_attributes = { name: key }
+                desc = Array(schema[key]).join('/')
+                field_attributes[:description] = desc unless desc.empty?
 
                 Array(values).each { |value| xml.field(value, field_attributes) }
               }
@@ -86,6 +87,8 @@ module Bismas
           }
         }
       }
+
+      execute[3][bind1]
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bismas
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cyclops
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: hen
   requirement: !ruby/object:Gem::Requirement
@@ -47,7 +47,7 @@ dependencies:
         version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.8.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,16 +131,16 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  bismas-0.4.0 [2016-02-02]:
+  bismas-0.5.0 [2016-06-06]:
 
-  * +bismas2xml+: Include input file's modification time.
-  * +bismas2xml+: Learned options +mapping+, +execute+ and +execute-mapped+.
-  * +bismas-filter+: Accept code file in addition to string for +execute+ and
-    +execute-mapped+ options.
+  * +bismas2xml+: Learned type +solr+.
+  * +bismas2xml+: Learned option +output-encoding+.
+  * +bismas2xml+, +bismas-filter+: Learned options +execute-before+ and
+    +execute-after+.
 
 rdoc_options:
 - "--title"
-- bismas Application documentation (v0.4.0)
+- bismas Application documentation (v0.5.0)
 - "--charset"
 - UTF-8
 - "--line-numbers"
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A Ruby client for BISMAS databases.