smart_excerpt 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1030e6791609813f86fbddb62230288bc284da2a
+  data.tar.gz: 7da1ff34432fae665f1ed103c1cb00ab57ab188f
+SHA512:
+  metadata.gz: dcd5703df6a4878197600218d86d60d591bd31756171b6de1b4a788df4c1b7cd16bfee3aadaaa4ac6f91d4a3a1bd365f34fb4d445a744d58c3b81ccd1e65da13
+  data.tar.gz: 79774148a0db326c9c98effb087467529716f63997943fc5c0341d44ddbce59001db0a36216c45ca6a404c543e8f368b3e5fdee5eac7f40d8fe956a999cd4f21

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_excerpt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 glebtv
+
+MIT License
+
+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,67 @@
+[![Gem Version](https://badge.fury.io/rb/smart_excerpt.svg)](http://badge.fury.io/rb/smart_excerpt)
+
+# SmartExcerpt
+
+Allows to create intellegent excerpt fields.
+
+This is an extraction from [RocketCMS](https://github.com/rs-pro/rocket_cms)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_excerpt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_excerpt
+
+## What it does
+
+You have two fields: a mandatory ```text``` and an optional ```excerpt```.
+If your ```excerpt``` field is empty, it generates an excerpt of a given length from ```text```.
+It will also truncate excerpts if they are more than 20% longer then allowed value
+
+## Usage
+
+Add two fields: ```excerpt``` and ```text```
+
+Add it to your model:
+
+    class Article
+      ...
+      include SmartExcerpt
+      smart_excerpt :excerpt, :text
+    end
+
+Then display excerpt:
+
+    Article.first.get_excerpt
+
+All excerpts are passed through strip_tags and html entity decode.
+
+## Options
+
+    Article.first.get_excerpt(25) # same as {words: 25}
+    Article.first.get_excerpt(letters: 25)
+    Article.first.get_excerpt(sentences: 5)
+    Article.first.get_excerpt(trust_multiplier: 3) # allow for much longer manual excerpts
+    Article.first.get_excerpt(trust_excerpts: true) # allow any manual excerpts
+    Article.first.get_excerpt(keep_headers: true) # do not remove HTML headers from excerpt
+    Article.first.get_excerpt(keep_newlines: true) # do not remove newlines from excerpt
+    Article.first.get_excerpt(keep_html: true) # do not remove HTML tags from excerpt (might be unsafe/dangerous!)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/smart_excerpt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/smart_excerpt.rb

@@ -0,0 +1,75 @@
+require "smart_excerpt/version"
+require 'htmlentities'
+require "smart_excerpt/util"
+require "smart_excerpt/helper"
+
+module SmartExcerpt
+  extend Util
+
+  @@h = Helper.new
+  @@he = HTMLEntities.new
+  mattr_reader :h
+  mattr_reader :he
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+
+  def smart_truncate(obj, base_field, excerpt_field, words)
+    trust_multiplier = 1.2
+    if words.is_a?(Hash) && words[:trust_multiplier]
+      trust_multiplier = words[:trust_multiplier]
+    end
+
+    if obj.send(excerpt_field).blank?
+      tx = obj.send(base_field)
+    else
+      tx = obj.send(excerpt_field)
+      if words.is_a?(Fixnum)
+        words *= trust_multiplier
+      elsif words.is_a?(Hash)
+        if words[:trust_excerpts]
+          words = {words: Float::INFINITY}
+        else
+          words = Hash[words.map {|k, v| [k, v.is_a?(Fixnum) ? (v * trust_multiplier).to_i : v] }]
+        end
+      end
+    end
+
+    if words.is_a?(Numeric)
+      options = {words: words.to_i}
+    elsif words.is_a?(Hash)
+      options = words
+    else
+      raise 'bad parameter for get_excerpt'
+    end
+
+    if tx.blank?
+      ''
+    else
+      # kill headers and newlines
+      unless options[:keep_headers]
+        tx = tx.gsub(/<h\d[^>]*?>(.*?)<\/h\d>/mi, '')
+      end
+      unless options[:keep_newlines]
+        tx = tx.gsub("\n", ' ').gsub("\r", '').gsub("\t", '').strip
+      end
+      tx = @@he.decode(tx)
+      unless options[:keep_html]
+        tx = @@h.strip_tags(tx)
+      end
+      @@h.smart_truncate(tx, options)
+    end
+  end
+
+
+  module ClassMethods
+    def smart_excerpt(excerpt_field, base_field, words = 25)
+      define_method("get_#{excerpt_field}".to_sym) do |c_words = words|
+        smart_truncate(self, base_field, excerpt_field, c_words)
+      end
+    end
+  end
+end
+

data/lib/smart_excerpt/helper.rb

@@ -0,0 +1,30 @@
+module SmartExcerpt
+  class Helper
+    include ActionView::Helpers::TextHelper
+
+    def smart_truncate(s, opts = {})
+      return '' if s.blank?
+      opts = {words: 25}.merge(opts)
+      if opts[:sentences]
+        return s.split(/\.(\s|$)+/)[0, opts[:sentences]].map{|s| s.strip}.join('. ') + '.'
+      end
+      if opts[:letters]
+        return truncate(s, length: opts[:letters], separator: ' ', omission: '...')
+      end
+      n = opts[:words]
+      if n === Float::INFINITY
+        return s
+      end
+      a = s.split(/\s/) # or /[ ]+/ to only split on spaces
+      r = a[0...n].join(' ') + (a.size > n ? '...' : '')
+
+      # replace   with regular spaces
+      r.gsub!(' ', ' ')
+
+      # strip newlines
+      r = r.strip.gsub("\r", '').gsub("\n", ' ')
+
+      r.gsub(/\s+/, ' ')
+    end
+  end
+end

data/lib/smart_excerpt/util.rb

@@ -0,0 +1,28 @@
+module SmartExcerpt
+  module Util
+    def decode(str)
+      SmartExcerpt.he.decode(str)
+    end
+
+    def encode(str)
+      SmartExcerpt.he.encode(str)
+    end
+
+    def strip_tags(str)
+      SmartExcerpt.h.strip_tags(str)
+    end
+
+    def decode_and_strip(str)
+      self.strip_tags(self.decode(str))
+    end
+
+    def truncate(str, opts = {})
+      return '' if str.blank?
+      tx = str.gsub(/<h\d[^>]*?>(.*)<\/h\d>/mi, '').gsub("\n", ' ').gsub("\r", '').gsub("\t", '').strip
+      tx = SmartExcerpt.he.decode(tx)
+      tx = SmartExcerpt.h.strip_tags(tx)
+      SmartExcerpt.h.smart_truncate(tx, opts)
+    end
+  end
+end
+

data/lib/smart_excerpt/version.rb

@@ -0,0 +1,3 @@
+module SmartExcerpt
+  VERSION = "0.1.4"
+end

data/smart_excerpt.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_excerpt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_excerpt"
+  spec.version       = SmartExcerpt::VERSION
+  spec.authors       = ["glebtv"]
+  spec.email         = ["glebtv@gmail.com"]
+  spec.summary       = %q{Allows to create intellegent excerpt fields.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/rs-pro/smart_excerpt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'htmlentities'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: smart_excerpt
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- glebtv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: ''
+email:
+- glebtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_excerpt.rb
+- lib/smart_excerpt/helper.rb
+- lib/smart_excerpt/util.rb
+- lib/smart_excerpt/version.rb
+- smart_excerpt.gemspec
+homepage: https://github.com/rs-pro/smart_excerpt
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allows to create intellegent excerpt fields.
+test_files: []