bismas 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a7bfa4d757177bec894da5ec52a0e5c19aa9d9e
-  data.tar.gz: fd631175f071d9b1815e30d14c634878824eaeca
+  metadata.gz: 533b760c35ba8c4d29776069ba3777b33f393769
+  data.tar.gz: e432c79eaa46cdc5f6a2f6d8dc83c63d89062ade
 SHA512:
-  metadata.gz: 5afed0589b2e33679976c397e032610e25fb7bc9b997fb4ede71ea53c2d81162cfefe2a20d16bc3e9d8f423419c87eeb8d97fff628bfa937340ada17ab727c4c
-  data.tar.gz: 84e252197825b23ed413abbe78eaebf6675148db8ca1c7c64e9bcc29acbbc11082c1616a1067682a765f76ec362c86c39ddbe1ca29e4225d07517c6446265c27
+  metadata.gz: 3c8394bd9f4b7884affa87a4db9aa74ef7d6259c1c72fda722f3d720b70c83afc8831b3d6181fe1a9f0f2c56a801eefcf0e75ba35f40256090f2f530eec68206
+  data.tar.gz: 8ede1a58a6ff0575d756449c70beeaa1ccafcbcf9a8ede32b35e72171b8d24e4a32dfc718df5d4f52d91dea17e65c91ff182755bf637ae8b411a97e3f52da54d

data/ChangeLog

@@ -2,6 +2,13 @@
 
 = Revision history for bismas
 
+== 0.4.0 [2016-02-02]
+
+* +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.
+
 == 0.3.0 [2015-12-11]
 
 * Added +bismas2xml+ executable.

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to bismas version 0.3.0.
+This documentation refers to bismas version 0.4.0.
 
 
 == DESCRIPTION
@@ -25,7 +25,7 @@ Travis CI::     https://travis-ci.org/blackwinter/bismas
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2015 Jens Wille
+Copyright (C) 2015-2016 Jens Wille
 
 bismas is free software: you can redistribute it and/or modify it
 under the terms of the GNU Affero General Public License as published by

data/lib/bismas.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -26,6 +26,8 @@
 
 module Bismas
 
+  extend self
+
   # Default file encoding
   DEFAULT_ENCODING = 'CP850'
 
@@ -47,103 +49,99 @@ module Bismas
   # See parameter +FUELLZEICHEN+ in BISMAS <tt>*.CFG</tt>
   DEFAULT_PADDING_LENGTH = 20
 
-  class << self
-
-    def chars(options = {})
-      encoding = amend_encoding(options).split(':').last
-
-      Hash[CHARS.map { |k, v| [k, begin
-        v.encode(encoding)
-      rescue Encoding::UndefinedConversionError
-        v.dup.force_encoding(encoding)
-      end] }]
-    end
-
-    def regex(options = {}, chars = chars(options))
-      category_length = options[:category_length] || DEFAULT_CATEGORY_LENGTH
-
-      Hash[REGEX.map { |k, v| [k, Regexp.new(v % chars)] }].update(category:
-        /[^#{chars.values_at(*CATEGORY_CHAR_SKIP).join}]{#{category_length}}/)
-    end
-
-    def filter(klass, options, &block)
-      execute = %i[execute execute_mapped].map { |key|
-        value = Array(options[key]); lambda { |bind|
-        value.each { |code| eval(code, bind) } } }
-
-      mapping = mapping(options[:mapping], &block)
-
-      key_format = options[:key_format]
-
-      writer_options = {
-        encoding:        encoding = options[:output_encoding],
-        key:             options[:output_key],
-        sort:            options[:sort],
-        padding_length:  options[:padding_length],
-        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]
-      }
-
-      klass.open(options[:output], writer_options) { |writer|
-        Reader.parse_file(options[:input], reader_options) { |id, record|
-          execute[0][bind = binding]
-          record = mapping.apply(encode(record, encoding))
-
-          execute[1][bind]
-          writer[key_format % id] = record
-        }
-      }
-    end
-
-    def mapping(mapping, &block)
-      block ||= method(:abort)
-
-      Mapping[case mapping
-        when nil, Hash    then mapping
-        when /\A\{.*\}\z/ then SafeYAML.load(mapping)
-        when String       then File.readable?(mapping) ?
-          SafeYAML.load_file(mapping) : block["No such file: #{mapping}"]
-        else block["Invalid mapping: #{mapping.inspect}"]
-      end]
-    end
-
-    def encode(record, encoding)
-      return record unless encoding
-
-      fallback = Hash.new { |h, k| h[k] = '?' }
-
-      record.each { |key, values|
-        values.each { |value| value.encode!(encoding, fallback: fallback) }
-
-        unless fallback.empty?
-          chars = fallback.keys.map(&:inspect).join(', '); fallback.clear
-          warn "Undefined characters at #{$.}:#{key}: #{chars}"
-        end
-      }
-    end
-
-    def amend_encoding(options, default_encoding = DEFAULT_ENCODING)
-      encoding = (options[:encoding] || default_encoding).to_s
-
-      options[:encoding] = encoding.start_with?(':') ?
-        default_encoding.to_s + encoding : encoding
-    end
+  def chars(options = {})
+    encoding = amend_encoding(options).split(':').last
+
+    Hash[CHARS.map { |k, v| [k, begin
+      v.encode(encoding)
+    rescue Encoding::UndefinedConversionError
+      v.dup.force_encoding(encoding)
+    end] }]
+  end
+
+  def regex(options = {}, chars = chars(options))
+    category_length = options[:category_length] || DEFAULT_CATEGORY_LENGTH
+
+    Hash[REGEX.map { |k, v| [k, Regexp.new(v % chars)] }].update(category:
+      /[^#{chars.values_at(*CATEGORY_CHAR_SKIP).join}]{#{category_length}}/)
+  end
+
+  def filter(klass, options, &block)
+    Filter.run(klass, options, &block)
+  end
+
+  def to_xml(options, &block)
+    XML.run(options, &block)
+  end
+
+  def execute(execute, &block)
+    block ||= method(:abort)
+
+    execute.map { |value|
+      value = Array(value).map { |code| case code
+        when /\.rb\z/i then File.readable?(code) ?
+          File.read(code) : block["No such file: #{code}"]
+        when String    then code
+        else block["Invalid code: #{code.inspect}"]
+      end }
+
+      lambda { |bind| value.each { |code| eval(code, bind) } }
+    }
+  end
+
+  def mapping(mapping, &block)
+    block ||= method(:abort)
+
+    Mapping[case mapping
+      when nil, Hash    then mapping
+      when /\A\{.*\}\z/ then safe_yaml.load(mapping)
+      when String       then File.readable?(mapping) ?
+        safe_yaml.load_file(mapping) : block["No such file: #{mapping}"]
+      else block["Invalid mapping: #{mapping.inspect}"]
+    end]
+  end
+
+  def encode(record, encoding)
+    return record unless encoding
+
+    fallback = Hash.new { |h, k| h[k] = '?' }
+
+    record.each { |key, values|
+      values.each { |value| value.encode!(encoding, fallback: fallback) }
+
+      unless fallback.empty?
+        chars = fallback.keys.map(&:inspect).join(', '); fallback.clear
+        warn "Undefined characters at #{$.}:#{key}: #{chars}"
+      end
+    }
+  end
+
+  def amend_encoding(options, default_encoding = DEFAULT_ENCODING)
+    encoding = (options[:encoding] || default_encoding).to_s
+
+    options[:encoding] = encoding.start_with?(':') ?
+      default_encoding.to_s + encoding : encoding
+  end
+
+  def require_gem(gem, lib = gem, &block)
+    require lib
+  rescue LoadError => err
+    block ||= method(:abort)
+    block["Please install the `#{gem}' gem. (#{err})"]
+  end
 
+  def safe_yaml
+    require_gem 'safe_yaml', 'safe_yaml/load'
+    SafeYAML
   end
 
 end
 
+require_relative 'bismas/xml'
 require_relative 'bismas/base'
 require_relative 'bismas/schema'
 require_relative 'bismas/reader'
 require_relative 'bismas/writer'
+require_relative 'bismas/filter'
 require_relative 'bismas/mapping'
 require_relative 'bismas/version'

data/lib/bismas/cli.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -39,10 +39,8 @@ module Bismas
       )
     end
 
-    def require_gem(gem, lib = gem)
-      require lib
-    rescue LoadError => err
-      abort "Please install the `#{gem}' gem. (#{err})"
+    def require_gem(*args)
+      Bismas.require_gem(*args, &method(:abort))
     end
 
   end

data/lib/bismas/cli/filter.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -59,6 +59,8 @@ module Bismas
       private
 
       def opts(opts)
+        opts.summary_width = 34
+
         opts.option(:input__FILE, 'Path to input file [Default: STDIN]')
 
         opts.option(:output__FILE, 'Path to output file [Default: STDOUT]')
@@ -106,12 +108,12 @@ module Bismas
 
         opts.separator
 
-        opts.option(:execute__CODE, 'Code to execute for each _record_ before mapping') { |e|
-          options[:execute] << e
+        opts.option(:execute__FILE_OR_CODE, 'Code to execute for each _record_ before mapping') { |e|
+          (options[:execute] ||= []) << e
         }
 
-        opts.option(:execute_mapped__CODE, :E, 'Code to execute for each _record_ after mapping') { |e|
-          options[:execute_mapped] << e
+        opts.option(:execute_mapped__FILE_OR_CODE, :E, 'Code to execute for each _record_ after mapping') { |e|
+          (options[:execute_mapped] ||= []) << e
         }
 
         opts.separator

data/lib/bismas/cli/xml.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -31,44 +31,16 @@ module Bismas
     class XML < self
 
       def run(arguments)
-        require_gem 'builder'
-
         quit unless arguments.empty?
 
-        quit 'Schema file is required' unless schema_file = options[:schema]
-        quit "No such file: #{schema_file}" unless File.readable?(schema_file)
-
-        schema = Schema.parse_file(schema_file)
-
-        reader_options = {
-          encoding:        options[:encoding],
-          key:             options[:key],
-          strict:          options[:strict],
-          silent:          options[:silent],
-          category_length: schema.category_length
-        }
-
-        File.open_file(options[:output], {}, 'wb') { |f|
-          xml = Builder::XmlMarkup.new(indent: 2, target: f)
-          xml.instruct!
-
-          xml.records(name: schema.name, description: schema.title) {
-            Reader.parse_file(options[:input], reader_options) { |id, record|
-              xml.record(id: id) {
-                record.sort_by { |key,| key }.each { |key, values|
-                  values.each { |value|
-                    xml.field(value, name: key, description: schema[key])
-                  }
-                }
-              }
-            }
-          }
-        }
+        Bismas.to_xml(options, &method(:quit))
       end
 
       private
 
       def opts(opts)
+        opts.summary_width = 34
+
         opts.option(:input__FILE, 'Path to input file [Default: STDIN]')
 
         opts.option(:output__FILE, 'Path to output file [Default: STDOUT]')
@@ -85,6 +57,20 @@ module Bismas
 
         opts.separator
 
+        opts.option(:mapping__FILE_OR_YAML, 'Path to mapping file or YAML string')
+
+        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.separator
+
         opts.switch(:strict, :S, 'Turn parse warnings into errors')
 
         opts.switch(:silent, :T, 'Silence parse warnings')

data/lib/bismas/filter.rb

@@ -0,0 +1,71 @@
+#--
+###############################################################################
+#                                                                             #
+# bismas -- A Ruby client for BISMAS databases                                #
+#                                                                             #
+# Copyright (C) 2015-2016 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# bismas is free software; you can redistribute it and/or modify it           #
+# under the terms of the GNU Affero General Public License as published by    #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# bismas is distributed in the hope that it will be useful, but               #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with bismas. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+module Bismas
+
+  module Filter
+
+    extend self
+
+    extend Bismas
+
+    def run(klass, options, &block)
+      execute = execute(options.values_at(*%i[execute execute_mapped]), &block)
+      mapping = mapping(options[:mapping], &block)
+
+      key_format = options[:key_format]
+
+      writer_options = {
+        encoding:        encoding = options[:output_encoding],
+        key:             options[:output_key],
+        sort:            options[:sort],
+        padding_length:  options[:padding_length],
+        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]
+      }
+
+      klass.open(options[:output], writer_options) { |writer|
+        Reader.parse_file(options[:input], reader_options) { |id, record|
+          execute[0][bind = binding]
+          record = mapping.apply(encode(record, encoding))
+
+          execute[1][bind]
+          writer[key_format % id] = record
+        }
+      }
+    end
+
+  end
+
+end

data/lib/bismas/mapping.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -53,7 +53,7 @@ module Bismas
 
     def apply(hash, new_hash = default_hash)
       hash.each { |key, value| map(key) { |new_key|
-        new_hash[new_key].concat(value)
+        new_hash[new_key].concat(Array(value))
       } }
 
       new_hash

data/lib/bismas/schema.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # bismas -- A Ruby client for BISMAS databases                                #
 #                                                                             #
-# Copyright (C) 2015 Jens Wille                                               #
+# Copyright (C) 2015-2016 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@gmail.com>                                       #
@@ -24,10 +24,16 @@
 ###############################################################################
 #++
 
+require 'forwardable'
+
 module Bismas
 
   class Schema
 
+    include Enumerable
+
+    extend Forwardable
+
     FIELD_RE = %r{\Afeld\s+=\s+(\d+)}i
 
     CATEGORY_RE = lambda { |category_length|
@@ -52,6 +58,10 @@ module Bismas
 
     attr_accessor :title, :name, :category_length
 
+    def_delegators :@categories, :[], :[]=, :each
+
+    def_delegator :@categories, :keys, :categories
+
     def parse(io)
       category_re = nil
 
@@ -72,18 +82,6 @@ module Bismas
       self
     end
 
-    def categories
-      @categories.keys
-    end
-
-    def [](key)
-      @categories[key]
-    end
-
-    def []=(key, value)
-      @categories[key] = value
-    end
-
   end
 
 end

data/lib/bismas/version.rb

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

data/lib/bismas/xml.rb

@@ -0,0 +1,93 @@
+#--
+###############################################################################
+#                                                                             #
+# bismas -- A Ruby client for BISMAS databases                                #
+#                                                                             #
+# Copyright (C) 2015-2016 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@gmail.com>                                       #
+#                                                                             #
+# bismas is free software; you can redistribute it and/or modify it           #
+# under the terms of the GNU Affero General Public License as published by    #
+# the Free Software Foundation; either version 3 of the License, or (at your  #
+# option) any later version.                                                  #
+#                                                                             #
+# bismas is distributed in the hope that it will be useful, but               #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public      #
+# License for more details.                                                   #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with bismas. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'time'
+
+module Bismas
+
+  module XML
+
+    extend self
+
+    extend Bismas
+
+    def run(options, &block)
+      block ||= method(:abort)
+
+      require_gem 'builder'
+
+      block['Schema file is required'] unless schema_file = options[:schema]
+      block["No such file: #{schema_file}"] unless File.readable?(schema_file)
+
+      schema = Schema.parse_file(schema_file)
+
+      execute = execute(options.values_at(*%i[execute execute_mapped]), &block)
+      mapping = mapping(options[:mapping], &block)
+
+      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
+      }
+
+      schema = mapping.apply(schema)
+
+      File.open_file(options[:output], {}, 'wb') { |f|
+        xml = Builder::XmlMarkup.new(indent: 2, target: f)
+        xml.instruct!
+
+        xml.records(records_attributes) {
+          Reader.parse_file(options[:input], reader_options) { |id, record|
+            xml.record(id: id) {
+              execute[0][bind = binding]
+              record = mapping.apply(record)
+
+              execute[1][bind]
+              record.sort_by { |key,| key }.each { |key, values|
+                field_attributes = {
+                  name:        key,
+                  description: Array(schema[key]).join('/')
+                }
+
+                Array(values).each { |value| xml.field(value, field_attributes) }
+              }
+            }
+          }
+        }
+      }
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bismas
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cyclops
@@ -111,12 +111,14 @@ files:
 - lib/bismas/cli/chardiff.rb
 - lib/bismas/cli/filter.rb
 - lib/bismas/cli/xml.rb
+- lib/bismas/filter.rb
 - lib/bismas/mapping.rb
 - lib/bismas/parser.rb
 - lib/bismas/reader.rb
 - lib/bismas/schema.rb
 - lib/bismas/version.rb
 - lib/bismas/writer.rb
+- lib/bismas/xml.rb
 - spec/bismas/parser_spec.rb
 - spec/bismas/reader_spec.rb
 - spec/bismas/schema_spec.rb
@@ -129,19 +131,16 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  bismas-0.3.0 [2015-12-11]:
+  bismas-0.4.0 [2016-02-02]:
 
-  * Added +bismas2xml+ executable.
-  * Added +bismas-chardiff+ executable.
-  * Renamed +bismas+ executable to +bismas-filter+.
-  * Renamed Bismas::Categories to Bismas::Schema and extended scope.
-  * Fixed Bismas.amend_encoding to use default encoding when encoding option is
-    +nil+.
-  * Changed Bismas::Writer to insert key field at beginning of record.
+  * +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.
 
 rdoc_options:
 - "--title"
-- bismas Application documentation (v0.3.0)
+- bismas Application documentation (v0.4.0)
 - "--charset"
 - UTF-8
 - "--line-numbers"