simple_text_extract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f684f9268c632c7531a7c4e453f8c7f75f895146c50db9c0af5cbb78188839e0
+  data.tar.gz: '0902f893a23d00b8f3ee22b9a2f386962f1886ee312fc1d851baffc7e3a8d58f'
+SHA512:
+  metadata.gz: 365538ffe696d3ef3345b44e4cc0e64eccf5490c15d667919bbb978d11a4972b84b87b2f603e75eb4782806af805a6d1d857b2436722489210283c8abb111e15
+  data.tar.gz: ca200f066331919161710e8076d13192225e5e8d5fd2b2b9fccecee8ab1bd1f75c4a5af07bc149f6ceab42030be505e2b959a1c673c78cd9f48f7e34f92defd9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nickweiland@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "pry"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    simple_text_extract (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+  simple_text_extract!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nick Weiland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# 📄 SimpleTextExtract
+
+SimpleTextExtract attempts extract text from various file types and is recommended as a guard before resorting to something more extreme like Apache Tika. It is built specifically with ActiveStorage in mind and originally built for the purpose of extracting text from attachments in order to index the text in ElasticSearch using [SearchKick](https://github.com/ankane/searchkick).
+
+SimpleTextExtract handles parsing text from:
+
+- `.pdf`
+- `.docx`
+- `.doc`
+- `.txt` 😜
+
+If no text is parsed (for `pdf`), or a file format is not supported (like images), then `nil` is returned and you can move on to the heavy-duty tools like [Henkei](https://github.com/abrom/henkei) 💪.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "simple_text_extract"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_text_extract
+
+## Usage
+
+Text can be parsed from raw file content or files in the filesystem t by calling `SimpleTextExtract.extract`:
+
+```ruby
+    # raw file content using ActiveStorage
+    SimpleTextExtract.extract(filename: attachment.blob.filename, raw: attachment.download)
+
+    # filesystem
+    SimpleTextExtract.extract(filepath: "path_to_file.pdf")
+```
+
+### Usage Dependencies
+
+You can choose to use SimpleTextExtract without the following dependencies, but it won't work for specific file types:
+
+`pdf` parsing requires `poppler-utils`
+- `brew install poppler`
+
+`doc` parsing requires `antiword`
+- `brew install antiword`
+
+### Usage on Heroku
+
+To use on Heroku you'll have to add some custom buildpacks.
+
+
+##### heroku-buildpack-activestorage-preview
+
+If you're using ActiveStorage, you might already have the [heroku-buildpack-activestorage-preview](https://github.com/heroku/heroku-buildpack-activestorage-preview) added, which means you already have `poppler-utils` installed 🎉
+
+If not, you can either add that buildpack, or add `poppler-utils` to your `Aptfile` (see below).
+
+##### heroku-buildpack-apt
+
+To add `antiword` as a dependency on Heroku, install the [heroku-buildpack-apt](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-apt) buildpack and follow the install instructions.
+
+In your `Aptfile`, add:
+```
+antiword
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_text_extract. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleTextExtract project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_text_extract/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_text_extract"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_text_extract/file_extractor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  class FileExtractor < TextExtractor
+    attr_reader :filepath
+
+    def initialize(filepath:)
+      @filepath = filepath
+    end
+
+    private
+
+      def file
+        @file ||= File.new(filepath)
+      end
+  end
+end

data/lib/simple_text_extract/format_extractor/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module SimpleTextExtract
+  module FormatExtractor
+    class Base
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+      end
+
+      def extract
+      end
+    end
+  end
+end

data/lib/simple_text_extract/format_extractor/doc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  module FormatExtractor
+    class Doc < Base
+      def extract
+        return nil if `command -v antiword`.empty?
+
+        `antiword #{Shellwords.escape(file.path)}`
+      end
+    end
+  end
+end

data/lib/simple_text_extract/format_extractor/doc_x.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  module FormatExtractor
+    class DocX < Base
+      def extract
+        return nil if `command -v unzip`.empty?
+
+        `unzip -p #{Shellwords.escape(file.path)} | grep '<w:t' | sed 's/<[^<]*>//g' | grep -v '^[[:space:]]*$'`
+      end
+    end
+  end
+end

data/lib/simple_text_extract/format_extractor/pdf.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  module FormatExtractor
+    class PDF < Base
+      def extract
+        return nil if `command -v pdftotext`.empty?
+
+        `pdftotext #{Shellwords.escape(file.path)} -`
+      end
+    end
+  end
+end

data/lib/simple_text_extract/format_extractor/plain_text.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  module FormatExtractor
+    class PlainText < Base
+      def extract
+        file.read
+      end
+    end
+  end
+end

data/lib/simple_text_extract/format_extractor_factory.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "simple_text_extract/format_extractor/base"
+require "simple_text_extract/format_extractor/plain_text"
+require "simple_text_extract/format_extractor/pdf"
+require "simple_text_extract/format_extractor/doc_x"
+require "simple_text_extract/format_extractor/doc"
+
+module SimpleTextExtract
+  class FormatExtractorFactory
+    def self.call(file) # rubocop:disable Metrics/MethodLength
+      case file.path
+      when /.txt$/i
+        FormatExtractor::PlainText.new(file)
+      when /.pdf$/i
+        FormatExtractor::PDF.new(file)
+      when /.docx$/i
+        FormatExtractor::DocX.new(file)
+      when /.doc$/i
+        FormatExtractor::Doc.new(file)
+      else
+        FormatExtractor::Base.new(file)
+      end
+    end
+  end
+end

data/lib/simple_text_extract/tempfile_extractor.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  class TempfileExtractor < TextExtractor
+    attr_reader :filename, :raw
+
+    def initialize(filename:, raw:)
+      @filename = filename
+      @raw = String.new(raw, encoding: Encoding::UTF_8)
+
+      write_raw
+    end
+
+    private
+
+      def file
+        @file ||= Tempfile.new(filepath)
+      end
+
+      def write_raw
+        file.write(raw)
+        file.rewind
+      end
+
+      def cleanup
+        file.close
+        file.unlink
+      end
+
+      def filepath
+        @filepath ||= filename.split(".").yield_self { |parts| [parts[0], ".#{parts[1]}"] }
+      end
+  end
+end

data/lib/simple_text_extract/text_extractor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  class TextExtractor
+    def self.call(filename: nil, raw: nil, filepath: nil)
+      if !filename.nil? && !raw.nil?
+        TempfileExtractor.new(filename: filename.to_s, raw: raw).extract
+      elsif !filepath.nil? && File.exist?(filepath)
+        FileExtractor.new(filepath: filepath).extract
+      end
+    end
+
+    def extract
+      text = FormatExtractorFactory.call(file).extract
+      cleanup
+
+      text
+    end
+
+    private
+
+      def cleanup
+      end
+  end
+end

data/lib/simple_text_extract/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleTextExtract
+  VERSION = "0.1.0"
+end

data/lib/simple_text_extract.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "simple_text_extract/version"
+require "simple_text_extract/text_extractor"
+require "simple_text_extract/file_extractor"
+require "simple_text_extract/tempfile_extractor"
+require "simple_text_extract/format_extractor_factory"
+
+module SimpleTextExtract
+  class Error < StandardError; end
+
+  def self.extract(filename: nil, raw: nil, filepath: nil)
+    TextExtractor.call(filename: filename, raw: raw, filepath: filepath).to_s
+  end
+end

data/simple_text_extract.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_text_extract/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_text_extract"
+  spec.version       = SimpleTextExtract::VERSION
+  spec.authors       = ["Nick Weiland"]
+  spec.email         = ["nickweiland@gmail.com"]
+
+  spec.summary       = "Attempts to quickly extract text from various file types before resorting to something more extreme like Apache Tika."
+  spec.description   = "Attempts to quickly extract text from various file types before resorting to something more extreme like Apache Tika. Built with ActiveStorage in mind."
+  spec.homepage      = "https://github.com/weilandia/simple_text_extract"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.requirements << "Antiword"
+  spec.requirements << "pdftotext/poppler"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/tags

@@ -0,0 +1,17 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_OUTPUT_MODE	u-ctags	/u-ctags or e-ctags/
+!_TAG_PROGRAM_AUTHOR	Universal Ctags Team	//
+!_TAG_PROGRAM_NAME	Universal Ctags	/Derived from Exuberant Ctags/
+!_TAG_PROGRAM_URL	https://ctags.io/	/official site/
+!_TAG_PROGRAM_VERSION	0.0.0	/54afb0f/
+Error	lib/simple_text_extract.rb	/^  class Error < StandardError; end$/;"	c	module:SimpleTextExtract
+SimpleTextExtract	lib/simple_text_extract.rb	/^module SimpleTextExtract$/;"	m
+SimpleTextExtract	lib/simple_text_extract/version.rb	/^module SimpleTextExtract$/;"	m
+TextExtractor	lib/simple_text_extract/text_extractor.rb	/^class SimpleTextExtract::TextExtractor$/;"	c	module:SimpleTextExtract
+VERSION	lib/simple_text_extract/version.rb	/^  VERSION = "0.1.0"$/;"	c
+call	lib/simple_text_extract/text_extractor.rb	/^  def self.call(filename:, raw_content:, filepath:)$/;"	S	class:TextExtractor
+extract	lib/simple_text_extract.rb	/^  def self.extract(filename: nil, raw_content: nil, filepath: nil)$/;"	S	module:SimpleTextExtract
+extract	lib/simple_text_extract/text_extractor.rb	/^  def extract$/;"	f	class:TextExtractor
+filepath	lib/simple_text_extract/text_extractor.rb	/^  attr_reader :filename, :raw_content, :filepath$/;"	A
+initialize	lib/simple_text_extract/text_extractor.rb	/^  def initialize(filename:, raw_content:, filepath:)$/;"	f	class:TextExtractor

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: simple_text_extract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Weiland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Attempts to quickly extract text from various file types before resorting
+  to something more extreme like Apache Tika. Built with ActiveStorage in mind.
+email:
+- nickweiland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_text_extract.rb
+- lib/simple_text_extract/file_extractor.rb
+- lib/simple_text_extract/format_extractor/base.rb
+- lib/simple_text_extract/format_extractor/doc.rb
+- lib/simple_text_extract/format_extractor/doc_x.rb
+- lib/simple_text_extract/format_extractor/pdf.rb
+- lib/simple_text_extract/format_extractor/plain_text.rb
+- lib/simple_text_extract/format_extractor_factory.rb
+- lib/simple_text_extract/tempfile_extractor.rb
+- lib/simple_text_extract/text_extractor.rb
+- lib/simple_text_extract/version.rb
+- simple_text_extract.gemspec
+- tags
+homepage: https://github.com/weilandia/simple_text_extract
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Antiword
+- pdftotext/poppler
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Attempts to quickly extract text from various file types before resorting
+  to something more extreme like Apache Tika.
+test_files: []