anystyle-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3c832096f90a3cc1f233ecdd4f500c2bb63460cc733142f764616cd33fc95f9
+  data.tar.gz: 11d151afafd488b955ba8f51863e60497007daf11fa192ec608769b9a670ac6e
+SHA512:
+  metadata.gz: 783c9e5ec5dcf5d456fda3d1a0db502da61670e525dff9927f0af3f1f3c120f8929fb47006173a0c5b2ce70925043811a4ff65d42913b68f69d3af7ad87a4425
+  data.tar.gz: a1a737c36024f02252458a16c25f212594d658b5b825876b8c358c73e9b2b72c8c1010261c732a6fe1382bb2021787576d0552e5291386912a62eaaca0370774

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Sylvester Keil
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,119 @@
+AnyStyle Command Line Interface
+===============================
+
+anystyle --help
+---------------
+    NAME
+        anystyle - Finds and parses bibliographic references
+
+    SYNOPSIS
+        anystyle [global options] command [command options] [arguments...]
+
+    VERSION
+        1.0.0 (cli 1.0.0, data 1.2.0)
+
+    GLOBAL OPTIONS
+        --adapter=name       - Set the dictionary adapter (default: ruby)
+        -f, --format=name    - Set the output format (default: ["json"])
+        --help               - Show this message
+        --[no-]stdout        - Print results directly to stdout
+        --[no-]verbose       - Print status messages to stderr
+        --version            - Display the program version
+        -w, --[no-]overwrite - Allow overwriting existing files
+
+    COMMANDS
+        find    - Find and extract references from text documents
+        help    - Shows a list of commands or help for one command
+        license - Print license information
+        parse   - Parse and convert references
+
+anystyle help find
+------------------
+    NAME
+        find - Find and extract references from text documents
+
+    SYNOPSIS
+        anystyle [global options] find [command options] input [output]
+
+    DESCRIPTION
+        This manual page documents the AnyStyle `find' command. AnyStyle `find'
+        analyzes PDF or text documents and extracts all references it finds.
+
+        The input argument can be a single PDF or text document, or a folder
+        containing multiple documents. The (optional) output argument specifies
+        the folder where the results shall be saved; if no output folder is
+        specified, results will be saved in the folder containing the input.
+
+        AnyStyle `find' supports the following formats:
+            bib     BibTeX (references only);
+            csl     CSL/JSON (references only);
+            json    AnyStyle JSON (references only);
+            ref     One reference per line, suitable for parser input;
+            txt     Plain text document;
+            ttx     Tagged document format, used for training the finder model;
+            xml     References only, XML, suitable for training the parser model.
+
+        You can specify multiple output formats, separated by commas.
+
+        Anlyzing PDF documents currently depends on `pdftotext' which must be
+        installed separately.
+
+    EXAMPLES
+        anystyle -f csl,xml find thesis.pdf
+
+        Extract references from `thesis.pdf' and save them in `thesis.csl' and
+        `thesis.xml'.
+
+        anystyle -f bib find --no-layout thesis.pdf bib
+
+        Extract references from `thesis.pdf' in `no-layout' mode (e.g., use this
+        if your document uses a multi-column layout) and save them in BibTeX in
+        `./bib/thesis.bib'.
+
+anystyle help parse
+-------------------
+    COMMAND OPTIONS
+        --[no-]layout - Use layout mode for PDF text extraction (default: enabled)
+    NAME
+        parse - Parse and convert references
+
+    SYNOPSIS
+        anystyle [global options] parse input [output]
+
+    DESCRIPTION
+        This manual page documents the AnyStyle `parse' command. AnyStyle `parse'
+        segments references (one per line) and converts them into structured
+        formats.
+
+        The input argument can be a single text document containing one full
+        reference per line (blank lines will be ignored), or a folder containing
+        multiple documents. The (optional) output argument specifies
+        the folder where the results shall be saved; if no output folder is
+        specified, results will be saved in the folder containing the input.
+
+        AnyStyle `parse' supports the following formats:
+            bib     BibTeX (normalized);
+            csl     CSL/JSON (normalized);
+            json    AnyStyle JSON (normalized);
+            ref     One reference per line, suitable for parser input;
+            txt     Same as `ref';
+            xml     XML, suitable for training the parser model.
+
+        You can specify multiple output formats, separated by commas.
+
+    EXAMPLES
+        anystyle -f json,xml parse biblio.txt
+
+        Extract references from `biblio.txt' and save them in `biblio.json' and
+        `biblio.xml'.
+
+        anystyle --stdout -f csl parse input.txt
+
+        Extract references from `input.txt' and print them to STDOUT in CSL/JSON.
+
+License
+-------
+Copyright 2011-2018 Sylvester Keil. All rights reserved.
+
+AnyStyle is distributed under a BSD-style license.
+See LICENSE for details.

data/bin/anystyle

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'anystyle/cli'
+
+include GLI::App
+include AnyStyle::CLI
+
+program_desc 'Finds and parses bibliographic references'
+
+version '%s (cli %s, data %s)' % [
+  AnyStyle::VERSION, VERSION, AnyStyle::Data::VERSION
+]
+
+subcommand_option_handling :normal
+arguments :strict
+
+wrap_help_text :verbatim
+
+accept(Array) { |value| value.split(',') }
+
+#config_file '.anystyle'
+
+switch 'verbose',
+  desc: 'Print status messages to stderr'
+
+switch ['w', 'overwrite'],
+  desc: 'Allow overwriting existing files'
+
+switch 'stdout',
+  desc: 'Print results directly to stdout'
+
+flag 'adapter',
+  default_value: 'ruby',
+  arg_name: 'name',
+  must_match: %w{ ruby memory gdbm },
+  desc: 'Set the dictionary adapter'
+
+flag ['f', 'format'],
+  default_value: ['json'],
+  arg_name: 'name',
+  type: Array,
+  must_match: /(bib|csl|json|ref|ttx|txt|xml)(,(bib|csl|json|ref|ttx|txt|xml))*/,
+  desc: 'Set the output format'
+
+
+pre do |opts|
+  AnyStyle::Dictionary.defaults[:adapter] = opts[:adapter]
+end
+
+
+desc 'Find and extract references from text documents'
+long_desc %{
+    This manual page documents the AnyStyle `find' command. AnyStyle `find'
+    analyzes PDF or text documents and extracts all references it finds.
+
+    The input argument can be a single PDF or text document, or a folder
+    containing multiple documents. The (optional) output argument specifies
+    the folder where the results shall be saved; if no output folder is
+    specified, results will be saved in the folder containing the input.
+
+    AnyStyle `find' supports the following formats:
+        bib     BibTeX (references only);
+        csl     CSL/JSON (references only);
+        json    AnyStyle JSON (references only);
+        ref     One reference per line, suitable for parser input;
+        txt     Plain text document;
+        ttx     Tagged document format, used for training the finder model;
+        xml     References only, XML, suitable for training the parser model.
+
+    You can specify multiple output formats, separated by commas.
+
+    Anlyzing PDF documents currently depends on `pdftotext' which must be
+    installed separately.
+
+EXAMPLES
+    anystyle -f csl,xml find thesis.pdf
+
+    Extract references from `thesis.pdf' and save them in `thesis.csl' and
+    `thesis.xml'.
+
+    anystyle -f bib find --no-layout thesis.pdf bib
+
+    Extract references from `thesis.pdf' in `no-layout' mode (e.g., use this
+    if your document uses a multi-column layout) and save them in BibTeX in
+    `./bib/thesis.bib'.
+}.lstrip
+
+arg :input
+arg :output, :optional
+command :find do |cmd|
+  cmd.switch 'layout',
+    default_value: true,
+    desc: 'Use layout mode for PDF text extraction'
+
+  cmd.action do |opts, params, args|
+    Commands::Find.new(opts).run(args, params)
+  end
+end
+
+
+desc 'Parse and convert references'
+long_desc %{
+    This manual page documents the AnyStyle `parse' command. AnyStyle `parse'
+    segments references (one per line) and converts them into structured
+    formats.
+
+    The input argument can be a single text document containing one full
+    reference per line (blank lines will be ignored), or a folder containing
+    multiple documents. The (optional) output argument specifies
+    the folder where the results shall be saved; if no output folder is
+    specified, results will be saved in the folder containing the input.
+
+    AnyStyle `parse' supports the following formats:
+        bib     BibTeX (normalized);
+        csl     CSL/JSON (normalized);
+        json    AnyStyle JSON (normalized);
+        ref     One reference per line, suitable for parser input;
+        txt     Same as `ref';
+        xml     XML, suitable for training the parser model.
+
+    You can specify multiple output formats, separated by commas.
+
+EXAMPLES
+    anystyle -f json,xml parse biblio.txt
+
+    Extract references from `biblio.txt' and save them in `biblio.json' and
+    `biblio.xml'.
+
+    anystyle --stdout -f csl parse input.txt
+
+    Extract references from `input.txt' and print them to STDOUT in CSL/JSON.
+}.lstrip
+
+arg :input
+arg :output, :optional
+command :parse do |cmd|
+  cmd.action do |opts, params, args|
+    Commands::Parse.new(opts).run(args, params)
+  end
+end
+
+desc 'Print license information'
+command :license do |cmd|
+  cmd.action do
+    puts 'AnyStyle.'
+    puts 'Copyright (C) 2011-%d Sylvester Keil.' % Time.now.year
+    puts <<~EOL
+
+      Wapiti.
+      Copyright (C) 2009-2013 CNRS.
+
+      All rights reserved.
+
+      Redistribution and use in source and binary forms, with or without
+      modification, are permitted provided that the following conditions are met:
+
+      * Redistributions of source code must retain the above copyright notice, this
+        list of conditions and the following disclaimer.
+
+      * Redistributions in binary form must reproduce the above copyright notice,
+        this list of conditions and the following disclaimer in the documentation
+        and/or other materials provided with the distribution.
+
+      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
+      IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+      EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+      BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+      DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+      OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+      NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+      EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+    EOL
+  end
+end
+
+exit run(ARGV)
+
+# vim: syntax=ruby

data/lib/anystyle/cli.rb

@@ -0,0 +1,8 @@
+require 'json'
+require 'pathname'
+require 'anystyle'
+
+require 'anystyle/cli/version'
+require 'anystyle/cli/commands/base'
+require 'anystyle/cli/commands/find'
+require 'anystyle/cli/commands/parse'

data/lib/anystyle/cli/commands/base.rb

@@ -0,0 +1,114 @@
+module AnyStyle
+  module CLI
+    module Commands
+      class Base
+        attr_reader :options, :output_folder
+
+        def initialize(options)
+          @options = options
+        end
+
+        def run(args, params)
+          raise NotImplementedYet
+        end
+
+        def verbose?
+          !!options[:verbose]
+        end
+
+        def stdout?
+          !!options[:stdout]
+        end
+
+        def overwrite?
+          !!options[:overwrite]
+        end
+
+        def each_format(&block)
+          options[:format].each(&block)
+        end
+
+        def find(input, **opts)
+          AnyStyle.find(input, format: :wapiti, **opts)
+        end
+
+        def parse(input)
+          AnyStyle.parse(input, format: :wapiti)
+        end
+
+        def format(dataset, fmt)
+          case fmt
+          when 'bib'
+            AnyStyle.parser.format_bibtex(dataset).to_s
+          when 'csl'
+            JSON.pretty_generate AnyStyle.parser.format_csl(dataset)
+          when 'json'
+            JSON.pretty_generate AnyStyle.parser.format_hash(dataset)
+          when 'ref', 'txt'
+            dataset.to_txt
+          when 'xml'
+            dataset.to_xml(indent: 2).to_s
+          else
+            raise ArgumentError, "format not supported: #{fmt}"
+          end
+        end
+
+        def extsub(path, new_extname)
+          basename = path.basename(path.extname)
+          path.dirname.join("#{basename}#{new_extname}")
+        end
+
+        def transpose(path, base_path)
+          if output_folder.nil?
+            path
+          else
+            output_folder.join(path.relative_path_from(base_path))
+          end
+        end
+
+        def set_output_folder(path)
+          @output_folder = Pathname.new(path).expand_path unless path.nil?
+        ensure
+          unless @output_folder.nil?
+            if @output_folder.exist?
+              raise ArgumentError,
+                "not a directory: #{path}" unless @output_folder.directory?
+            else
+              @output_folder.mkdir
+            end
+          end
+        end
+
+        def say(*args)
+          STDERR.print(*args) if verbose?
+        end
+
+        def walk(input)
+          path = Pathname(input).expand_path
+          raise ArgumentError, "path does not exist: #{input}" unless path.exist?
+
+          if path.directory?
+            path.each_child do |file|
+              yield file, path unless file.directory?
+            end
+          else
+            yield path, path.dirname
+          end
+        end
+
+        def write(content, path, base_path)
+          if stdout?
+            STDOUT.puts(content)
+          else
+            path = transpose(path, base_path)
+            if !overwrite? && path.exist?
+              raise RuntimeError,
+                "file exists, use --overwrite to force saving: #{path}"
+            end
+            File.write path, content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anystyle/cli/commands/find.rb

@@ -0,0 +1,44 @@
+module AnyStyle
+  module CLI
+    module Commands
+      class Find < Base
+        def run(args, params)
+          set_output_folder args[1]
+          walk args[0] do |path, base_path|
+            say "Analyzing #{path.relative_path_from(base_path)} ..."
+            doc = find(path.to_s.untaint, layout: params[:layout])
+            ref = doc[0].references
+
+            if ref.length == 0
+              say "no references found.\n"
+            else
+              say "#{ref.length} references found.\n"
+              dst = nil
+              each_format do |fmt|
+                case fmt
+                when 'ttx'
+                  say "Formatting document as #{fmt} ...\n"
+                  res = doc.to_txt tagged: true
+                when 'txt'
+                  say "Formatting document as #{fmt} ...\n"
+                  res = doc.to_txt tagged: false
+                when 'ref'
+                  say "Formatting references as #{fmt} ...\n"
+                  res = ref.join("\n")
+                else
+                  say "Formatting references as #{fmt} ...\n"
+                  dst ||= parse(ref.join("\n"))
+                  res = format(dst, fmt)
+                end
+
+                out = extsub(path, ".#{fmt}")
+                say "Writing #{out.relative_path_from(base_path)} ...\n"
+                write res, out, base_path
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anystyle/cli/commands/parse.rb

@@ -0,0 +1,23 @@
+module AnyStyle
+  module CLI
+    module Commands
+      class Parse < Base
+        def run(args, params)
+          set_output_folder args[1]
+          walk args[0] do |path, base_path|
+            say "Parsing #{path.relative_path_from(base_path)} ..."
+            dataset = parse(path.to_s.untaint)
+            say "#{dataset.length} references found.\n"
+            each_format do |fmt|
+              say "Formatting references as #{fmt} ...\n"
+              res = format(dataset, fmt)
+              out = extsub(path, ".#{fmt}")
+              say "Writing #{out.relative_path_from(base_path)} ...\n"
+              write res, out, base_path
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anystyle/cli/version.rb

@@ -0,0 +1,5 @@
+module AnyStyle
+  module CLI
+    VERSION = '1.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: anystyle-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sylvester Keil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anystyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+description: A command line interface to the AnyStyle Parser and Finder.
+email:
+- http://sylvester.keil.or.at
+executables:
+- anystyle
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/anystyle
+- lib/anystyle/cli.rb
+- lib/anystyle/cli/commands/base.rb
+- lib/anystyle/cli/commands/find.rb
+- lib/anystyle/cli/commands/parse.rb
+- lib/anystyle/cli/version.rb
+homepage: http://anystyle.io
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: AnyStyle CLI
+test_files: []