truncate_html_text 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 086f01f8c351b7033c715cc1d272ca43ae91a0ed
-  data.tar.gz: 0b2c6323e6ccc4bdc5335c09aa7bd7612d5cd028
+  metadata.gz: da1dae46e4b0d66ed6ee47309a50aad00ef15866
+  data.tar.gz: 7635f874a28c14ee1b2527f6c65c5404b5b87ed5
 SHA512:
-  metadata.gz: 71cbf1b72c591316440fb61a34073f4bf3c32a24103dcb70834cbef18ce70765613f8797c7b8cfacf56cfe928e7227708b60f846030aad30cf439fb25e863cb9
-  data.tar.gz: 71e3efdd657b0eb24c161534b87f89b737cd65ad1225aff8282f31d6ff74e484e6350f1dae001f69b2d81836b4bbd9191d19812d771a77f85cb7a85d04af8197
+  metadata.gz: 0f5a561baac594e7ab8f2ecddc40d454e0d97528814b470aeb41ed362bfcfc2bbeb1d5e6accd75003838984ce9ce215db7a5309d7532199196e08777a029b99c
+  data.tar.gz: 5f8d8f2ca9b64498b72d95bd99bf252417bf3ec49b9e5c6485e38714a97d64328533e3ab7cce413477b3502e3f3210dc957ce3a9f8ebbc0b8eae97e9f055a355

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 TODO: Write your name
+Copyright (c) 2015-2017 Tarun Agrawal
 
 MIT License
 

data/README.md

@@ -1,6 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/truncate_html_text.svg)][gem]
+[![License](http://img.shields.io/license/MIT.png?color=green)][license]
+
+[gem]: http://badge.fury.io/rb/truncate_html_text
+[license]: http://opensource.org/licenses/MIT
+
 # TruncateHtmlText
 
-TODO: Write a gem description
+This gem allows users to truncate html or non-html text by using options.
+This gem provides an easy way to integrate `truncate_html_text` jQuery plugin with your Rails apps.
 
 ## Installation
 
@@ -20,7 +27,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To insert JavaScript files in your Rails app, add following line in your `app/assets/javascripts/application.js` file (make sure to add after requiring `jquery`).
+
+```javascript
+	//= require truncate_html_text_main
+```
+
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <i>text</i></p>')%>
+	<div class="truncate"><p>Truncate Html <i>text</i></p></div>
+```
+
+
+## Options
+
+Default options are...
+
+### length
+
+*Default: Infinity*
+
+The maximum length (including the ellipsis) of the truncated html.
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <i>text</i></p>', data:{length:20})%>
+	<div class="truncate" data-length="20"><p>Truncate Html <i>t...</i></p></div>
+```
+
+### stripTags
+
+*Default: false*
+
+If `stripTags` is truthy all html tags will be stipped, leaving only the text.
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <i>text</i></p>', data:{length:20, stripTags: true})%>
+	<div class="truncate" data-length="20" data-stripTags="true">Truncate Html t...</div>
+```
+
+### words
+
+*Default: false*
+
+If `words` is truthy the input will only be truncated at word boundaries.
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <i>text</i></p>', data:{length:20, words: true})%>
+	<div class="truncate" data-length="20" data-words="true"><p>Truncate Html...</p></div>
+```
+
+### noBreaks
+
+*Default: false*
+
+If `noBreaks` is truthy the input will contain no break elements.
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <br><i>text</i></p>', data:{length:20, noBreaks: true})%>
+	<div class="truncate" data-length="20" data-noBreaks="true"><p>Truncate Html <i>t...</i></p></div>
+```
+
+### ellipsis
+
+*Default: '…'*
+
+The `ellipsis` setting is used to provide a different character for the ellipsis.
+
+```rails
+	<%= truncate_html_text_tag(:div, '<p>Truncate Html <br><i>text</i></p>', data:{length:20, ellipsis: '~'})%>
+	<div class="truncate" data-length="20" data-ellipsis="true"><p>Truncate Html <i>t~</i></p></div>
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
+require 'rake/testtask'
 require "bundler/gem_tasks"
 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['lib/test/test*.rb']
+  t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test

data/lib/test/test_helper_method.rb

@@ -0,0 +1,9 @@
+require "minitest/autorun"
+
+class TestHelperMethod < Minitest::Test
+  
+	def test_that_kitty_can_eat
+    assert true
+  end
+
+end

data/lib/truncate_html_text/version.rb

@@ -1,3 +1,3 @@
 module TruncateHtmlText
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/truncate_html_text.rb

@@ -1,7 +1,7 @@
-require_relative "truncate_html_text/version"
-require_relative "truncate_html_text/engine"
-require_relative "truncate_html_text/truncate_html_text_helper"
-require_relative "truncate_html_text/railtie"
+require "truncate_html_text/version"
+require "truncate_html_text/engine"
+require "truncate_html_text/truncate_html_text_helper"
+require "truncate_html_text/railtie"
 
 #module TruncateHtmlText
   # Your code goes here...

data/truncate_html_text.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tarun Agrawal"]
   spec.email         = ["tarun7588@gmail.com"]
   spec.summary       = %q{Rails HTML Text Truncate}
-  spec.description   = %q{This is a Rails gem for Html Text Truncate}
-  spec.homepage      = ""
+  spec.description   = %q{This is a Rails gem for Truncate Html Text}
+  spec.homepage      = "https://github.com/iamtarun/truncate_html_text"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", '>= 1.0'
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: truncate_html_text
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tarun Agrawal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: This is a Rails gem for Html Text Truncate
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a Rails gem for Truncate Html Text
 email:
 - tarun7588@gmail.com
 executables: []
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,13 +68,14 @@ files:
 - app/assets/javascripts/truncate_html_text.js
 - app/assets/javascripts/truncate_html_text_initializer.js
 - app/assets/javascripts/truncate_html_text_main.js
+- lib/test/test_helper_method.rb
 - lib/truncate_html_text.rb
 - lib/truncate_html_text/engine.rb
 - lib/truncate_html_text/railtie.rb
 - lib/truncate_html_text/truncate_html_text_helper.rb
 - lib/truncate_html_text/version.rb
 - truncate_html_text.gemspec
-homepage: ''
+homepage: https://github.com/iamtarun/truncate_html_text
 licenses:
 - MIT
 metadata: {}