abstractifier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bacbd5f6a3e64e0218dd8bd75b850047d7cb4e21
+  data.tar.gz: 5ff554bb64332d3dcd3ea8efb05d3f366cf8dc1a
+SHA512:
+  metadata.gz: 6a8bbd4b65ffbe08dedc1ecb8c1729dda951c663b5f755622034b20a581995c542c2f384bb10ac85f003b4fcb775bd3845f670c9181c88608f6a38a2851521a7
+  data.tar.gz: 50698eb3aaec5ab56abbbfb70090de5b1c03c8c360603b70379e615a9cbc272a646b0544680cf2db5f135b4f2d35b108550bfc21f146a7f771fc8a650f2524db

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Altmetric LLP
+
+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,45 @@
+# Abstractifier [![Build Status](https://travis-ci.org/altmetric/abstractifier.svg?branch=master)](https://travis-ci.org/altmetric/abstractifier)
+
+Builds a short abstract of a supplied text by extracting the first couple of
+sentences and trimming off punctuation etc.
+
+## Usage
+
+### Basic usage
+
+```ruby
+require 'abstractifier'
+
+abstractifier = Abstractifier.new
+#=> #<Abstractifier:0x007ffe350993c8 @elider="…", @max_length=250, @min_length=80>
+
+abstractifier.abstractify("This is a longish piece of text. It contains several sentences. It is long enough that we will need to build an abstract for it, but the first two sentences are quite short, so we will need to include some content from the third sentence so that we can fulfill both our minimum and maximum abstract lengths.")
+#=> "This is a longish piece of text. It contains several sentences. It is long enough that we will need to build an abstract for it, but the first two sentences are quite short, so we will need to include some content from the third sentence so that we…"
+```
+
+It's possible to set minimum and maximum lengths on the abstract
+
+```ruby
+abstractifier = Abstractifier.new(max: 100, min: 20)
+#=> #<Abstractifier:0x007fca72d64040 @elider="…", @max_length=100, @min_length=20>
+
+abstractifier.abstractify("This abstract should be much shorter. It should only include the first sentence.")
+#=> "This abstract should be much shorter."
+```
+
+We can also change the character used to elide sentences (though I don't really know why you'd do this)
+
+```ruby
+abstractifier = Abstractifier.new(max: 30, min: 20, elider: '!!!')
+#=> #<Abstractifier:0x007fca72d64040 @elider="!!!", @max_length=100, @min_length=30>
+
+abstractifier.abstractify("This abstract should be much shorter but long enough that we have to truncate the sentence in the middle")
+#=> "This abstract should be much!!!"
+```
+
+
+## License
+
+Copyright © 2015 Altmetric LLP
+
+Distributed under the MIT License.

data/lib/abstractifier.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+class Abstractifier
+  DEFAULT_MINIMUM_LENGTH = 80
+  DEFAULT_MAXIMUM_LENGTH = 250
+
+  attr_accessor :max_length, :min_length, :elider
+
+  def initialize(options = {})
+    @min_length = options.fetch(:min, DEFAULT_MINIMUM_LENGTH)
+    @max_length = options.fetch(:max, DEFAULT_MAXIMUM_LENGTH)
+    @elider = options.fetch(:elider, '…')
+  end
+
+  def abstractify(string)
+    output = ''
+
+    extract_sentences(string).each do |sentence|
+      output << "#{sentence}. "
+      break if output.length >= min_length
+    end
+
+    output = forcibly_truncate(output) if output.length > max_length
+    output = tidy(output)
+
+    output
+  end
+
+  private
+
+  def forcibly_truncate(string)
+    truncated = string[0, max_length + 1].strip.split(/\s\b\w+$/).first
+
+    strip_trailing_punctuation(truncated)
+  end
+
+  def extract_sentences(string)
+    string
+      .gsub(/[[:space:]]+/, ' ')
+      .split(/\.(?:\s|$)/)
+  end
+
+  def strip_trailing_punctuation(string)
+    if string[-1] =~ /[\.\?\!]/
+      string
+    elsif string[-1] =~ /[[:punct:]]/
+      string[0..-2] + elider
+    else
+      string + elider
+    end
+  end
+
+  def tidy(string)
+    string
+      .gsub(/[[:space:]]+/, ' ')
+      .gsub(/[[:space:]](,|\.)/, '\1')
+      .strip
+  end
+end

data/spec/abstractifier_spec.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+# rubocop:disable Metrics/LineLength
+
+require 'abstractifier'
+
+RSpec.describe Abstractifier do
+  let(:instance) { described_class.new(max: 50, min: 20) }
+
+  it 'elides to sentence boundaries' do
+    expect(
+      instance.abstractify(
+        'This is the first sentence. This is the second sentence.'
+      )
+    ).to eq('This is the first sentence.')
+  end
+
+  it 'elides mid-sentence when no suitable sentence boundary.' do
+    expect(
+      instance.abstractify(
+        'This is short. This is much longer second sentence, which much be elided mid-sentence.'
+      )
+    ).to eq('This is short. This is much longer second sentence…')
+  end
+
+  it 'elides mid-word when too long' do
+    expect(
+      instance.abstractify(
+        'Supercalifragilisticexpialidociousisareallylongwordthatmustbetruncated'
+      )
+    ).to eq('Supercalifragilisticexpialidociousisareallylongword…')
+  end
+
+  it 'retains trailing punctuation from sentence boundaries' do
+    expect(
+      instance.abstractify(
+        'I really think this is a good idea, personally! But whatever you think, I guess.'
+      )
+    ).to eq('I really think this is a good idea, personally!')
+  end
+
+  it 'retains trailing punctuation from sentence boundaries' do
+    expect(
+      instance.abstractify(
+        'I really think this is a good idea, personally! But whatever you think, I guess.'
+      )
+    ).to eq('I really think this is a good idea, personally!')
+  end
+
+  it 'removes trailing punctuation from word boundaries' do
+    expect(
+      instance.abstractify(
+        'This sentence should be truncated in a few words, but should have no trailing punctuation'
+      )
+    ).to eq('This sentence should be truncated in a few words…')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: abstractifier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew MacLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+      Simple abstract generation library for Ruby.
+email: support@altmetric.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/abstractifier.rb
+- spec/abstractifier_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/altmetric/abstractifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A small library to generate abstracts from text.
+test_files:
+- spec/abstractifier_spec.rb
+- spec/spec_helper.rb