ChunkyText 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2e90bc4405aad6565a25ffede0b8850be4118cf
+  data.tar.gz: e226157c071bc84131b332e858579c1b5f1d484c
+SHA512:
+  metadata.gz: 43c849dd97370417af2a6c2a734335bf93359fb9b830564a06e53796458a4d58f9e2228f99bb590037ed10bf0786e5c825c46ad10ce03737d62f1fb7fa0edf14
+  data.tar.gz: 046c045899c47714c0b24501956c860687d47eace0224932b898abcd1000c1003b805fea3bf15c2dacb53683ac56eadd75f52d4686512ed0b171cfc105f973c5

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - ruby
+  - 2.1.5
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - dstein-phins@hotmail.com
+    on_failure: change
+    on_success: never

data/ChunkyText.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ChunkyText/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ChunkyText"
+  spec.version       = ChunkyText::VERSION
+  spec.authors       = ["Doug Steinberg", "Jason Parker"]
+  spec.email         = ["dstein-phins@hotmail.com"]
+  spec.summary       = %q{ Break up a long string of text into smaller strings for Twitter }
+  spec.description   = %q{ Break up a long string of text into nicely formated 140 character strings for Twitter and keping links and punctuation intact. }
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "faker"
+end

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Doug Steinberg
+
+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,45 @@
+[![Build Status](https://travis-ci.org/Integralist/Sinderella.png?branch=master)](https://travis-ci.org/Integralist/Sinderella)  [![Gem Version](https://badge.fury.io/rb/sinderella.png)](http://badge.fury.io/rb/sinderella) [![Coverage Status](https://coveralls.io/repos/Integralist/Sinderella/badge.png)](https://coveralls.io/r/Integralist/Sinderella)
+
+# ChunkyText
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ChunkyText'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ChunkyText
+
+## Usage
+
+You have a given string. Example:
+    
+    string = "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
+
+Initialize the ChunkyText object with the string and a max length
+    
+    text = ChunkyText::Chunker.new(string, 140)
+
+Call `.chunk_array` on the object and get an array back.
+
+```ruby
+  text.chunk_array #=> ["Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, ... , ... , ...]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ChunkyText/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,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/ChunkyText.rb

@@ -0,0 +1,16 @@
+require "ChunkyText/version"
+require "ChunkyText/chunker" 
+
+
+
+
+#
+#  get the first 140 characters
+#  find the location of the last punctuation mark
+#  save all characters from that puncuation mark to the beging of the string to a variable
+#  save that variable to the end of a "chunks" array
+#  remove the characters from the input string
+#  repeat the process untill the input string is empty
+#  return the "chunks" array
+#  
+#  if any neighboring elements in the array add up to 140 chars or less, then merge them together

data/lib/ChunkyText/chunker.rb

@@ -0,0 +1,45 @@
+module ChunkyText
+  class Chunker
+    
+    attr_reader :max_length, :chunk_array, :get_chunk
+    attr_accessor :string
+
+    def initialize(string, max_length)
+      @string = string
+      @max_length = max_length
+    end 
+
+    def get_chunk(input_string)
+      smaller_string = input_string.slice(0,max_length)
+
+      if last_punctuation_mark(smaller_string)
+        smaller_string.slice(0,last_punctuation_mark(smaller_string) + 1)
+      else
+        smaller_string
+      end
+    end
+
+    def chunk_array
+      input_string = string.clone
+      array = []
+      while input_string.length > 0 do
+        array << get_chunk(input_string)
+        
+        input_string.slice!(0..max_length)
+      end
+      input_string = string.clone
+      array
+    end
+
+    private
+
+    def last_punctuation_mark(string)
+      punctuation_mark_positions = []
+      ['!','?','.'].each do |p_mark|
+        punctuation_mark_positions <<  string.rindex(p_mark)
+      end
+      punctuation_mark_positions.reject! { |item| item == nil }
+      punctuation_mark_positions.max
+    end
+  end
+end

data/lib/ChunkyText/version.rb

@@ -0,0 +1,3 @@
+module ChunkyText
+  VERSION = "0.0.1"
+end

data/spec/models/chunker_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe ChunkyText::Chunker do
+  let(:punctuation_mark) { ['!','?','.'].sample }
+  let(:long_text) { Faker::Lorem.paragraph(30) }
+  
+  let(:string_with_punctuation_before_140_chars) do
+    string = Faker::Lorem.characters(130)
+    string + punctuation_mark + string 
+  end
+  
+  let(:string_with_punctuation_at_140_chars) do
+    string = Faker::Lorem.characters(139)
+    string + punctuation_mark
+  end
+
+  let(:string_with_no_punctuation_before_140_chars) do
+    string = Faker::Lorem.characters(150)
+  end
+
+  describe '#get_chunk' do
+    it '[returns a string]' do
+      text = ChunkyText::Chunker.new(long_text, 140)
+      expect(text.get_chunk(text.string)).to be_a(String)
+    end
+
+    it '[returns a string <= the max length]' do
+      text = ChunkyText::Chunker.new(long_text, 140)
+      expect(text.get_chunk(text.string).length).to be <= 140
+    end
+
+
+    context '[a punctuation mark occurs before the max length character]' do
+      it '[returns a string < the max length]' do
+        text = ChunkyText::Chunker.new(string_with_punctuation_before_140_chars, 140)
+        expect(text.get_chunk(text.string).length).to be < 140
+      end
+
+      it '[returns a string that ends in a punctuation mark]' do
+        text = ChunkyText::Chunker.new(long_text, 140)
+        expect(['!','?','.']).to include(text.get_chunk(text.string)[-1]) 
+      end
+    end
+
+    context '[a punctuation mark occurs at the max length character]' do
+      it '[returns a string == the max length]' do
+        text = ChunkyText::Chunker.new(string_with_punctuation_at_140_chars, 140)
+        expect(text.get_chunk(text.string).length).to eq(140)
+      end
+    end
+
+    context '[there is no punctuation mark within the max length]' do
+      it '[returns a string == the max length]' do
+        text = ChunkyText::Chunker.new(string_with_no_punctuation_before_140_chars, 140)
+        expect(text.get_chunk(text.string).length).to eq(140)
+      end
+    end
+
+
+  end
+
+  describe '#chunk_array' do
+    it '[returns an array]' do
+      array = ChunkyText::Chunker.new(long_text, 140).chunk_array
+      expect(array).to be_a(Array)
+    end
+
+    it '[each element in the array is a string]' do
+      array = ChunkyText::Chunker.new(long_text, 140).chunk_array
+      array.each do |elem|
+        expect(elem).to be_a(String)
+      end
+    end
+
+    it '[each element is <= the max_length]' do
+      array = ChunkyText::Chunker.new(long_text, 140).chunk_array
+      array.each do |elem|
+        expect(elem.length).to be <= 140
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'pry'
+require 'faker'
+require 'ChunkyText'

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: ChunkyText
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doug Steinberg
+- Jason Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-14 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'
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: " Break up a long string of text into nicely formated 140 character strings
+  for Twitter and keping links and punctuation intact. "
+email:
+- dstein-phins@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ChunkyText.gemspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ChunkyText.rb
+- lib/ChunkyText/chunker.rb
+- lib/ChunkyText/version.rb
+- spec/models/chunker_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Break up a long string of text into smaller strings for Twitter
+test_files:
+- spec/models/chunker_spec.rb
+- spec/spec_helper.rb