wrapify 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46882c990c833be9eec428161e711869de91d2c2ee45204b2022d89f8e11b4fd
-  data.tar.gz: 9da50c7299fa35eaaa3448955ba16ff8661dc74d5c7feaa90f564bc0231bc711
+  metadata.gz: cc4d00eec7c721d08079dfd04d01775ac8ed1795ea64e82d476da366ba6b397e
+  data.tar.gz: 8e470a50652486291b6f3bdbb21faccb81c7b125dfc6664f1ae4ba6992826473
 SHA512:
-  metadata.gz: 7db8232a984beeb94e5de8e45aa1ec89164582972eba6df4a09a973880bd2097a1491229b6bd250182400e1eddead7f280ff6ad383cebc9314e81ae856952f02
-  data.tar.gz: cd2cced512cbca5c49bb48c0267b3d1d209750aad61a2e5518e7afbc74d50ad3d3089b95f06cc0e4a23e5759d89c8e8a77cdafa09b2d6efcff1b70431a848c5f
+  metadata.gz: 7a7cd4d5fecba7fcfce741727634369ba2320ce0c44fbccfc092fc8a45d20e59a86b70203fae9a16471959b40a0da6289f7252ebf0518f587050417b65f8783e
+  data.tar.gz: 6f786dbf119c90378022c07afcf94d91da0602ee73b4ae68959f05ace1e61c2e88063a344abb205f64cd806d5f03a55955b448cce54a34f8f89d6d2dcfa2edcb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wrapify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    wrapify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.7, >= 3.7.0)
+  wrapify!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Frank Germano
+
+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,47 @@
+# Wrapify
+
+Wrapify is a gem that extends the string class to add a method wrapify(wraplimit).
+This gem supports wrapping text to a specified boundary, e.g. 20. The string can include multiple newlines.
+
+Algorithm: Convert all runs of white space (spaces, tabs, new lines, carriage returns) to single spaces.
+Define the runs of characters between the spaces as "words". Add words to a line until they no longer
+fit (hitting the word wrap limit). Once a line is complete, add it to the final result, with a closing new line. Continue adding lines to the result until there is no more to process. The result can be a multiline string.
+
+If a word is longer than the wraplimit, it is added to its own "long" line; this line will extend past the wordwrap limit. This is by design. One could add an option to the method to force wrap the line to avoid lines. This alternative has not been implemented.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrapify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wrapify
+
+## Usage
+
+For a given string, mystring, invoke the string method, wrap_to_string, with a wraplimit.
+
+mystring.wrap_to_string(20)
+
+## 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/fgermanojr/wrapify.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). More generally, do whatever you want with it.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rspec/core/rake_task'
+ 
+RSpec::Core::RakeTask.new(:spec) do |t|
+t.pattern = Dir.glob('spec/**/*_spec.rb')
+t.rspec_opts = '--format documentation'
+# t.rspec_opts << ' more options'
+# t.rcov = true  # ADD GEM LATER
+end
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wrapify"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# 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/wrapify.rb

@@ -0,0 +1,73 @@
+require "wrapify/version"
+
+class String
+
+  # Wrap string to given wraplimit.
+  #
+  # @param decimal wraplimit
+  # @return [String]
+  #
+  # @example
+
+  # doc1 = <<-DOC1HERE
+  # line 1 contains a lot of         stuff
+  # line 2 contains even more, which    we will wrap to a fixed short
+  # line 3 boundry if we are lucky. Who knows    what will really     happen.
+  # line 4
+  # DOC1HERE
+
+  # doc1.wrap_to_limit(20) === doc1_wrapped
+
+  # doc1_ wrapped = <<-RESULT
+  # line 1 contains a 
+  # lot of stuff line 
+  # 2 contains even 
+  # more, which we 
+  # will wrap to a 
+  # fixed short line 3 
+  # boundry if we are 
+  # lucky. Who knows 
+  # what will really 
+  # happen. line 4
+  # RESULT
+
+  def wrap_to_limit(wrap_limit)
+    str = self.gsub(/\s+/, ' ') # convert runs of white space to single space
+    String.wrap_process(str, wrap_limit)
+  end
+
+  private
+
+  def self.wrap_process(str, wrap_limit)
+    # Wrap units into line not to exceed wrap_limit of line
+    # In case where next_up is longer than wrap we include with overlength.
+    # Could add option, :force, 'xxxyy\n'.wrap_to_limit(4) = 'xxxy\ny\n'
+    # Thnik about.
+
+    str_array = str.split(' ')
+    run_index = 0
+    result = ''
+    line = ''
+
+    until str_array.empty? do
+      next_up = str_array.shift
+      # puts "next_up=#{next_up}"
+      if (line.length + next_up.length + 1 < wrap_limit)
+        # got room add it in
+        line += next_up + ' '
+        run_index += 1
+      else
+        line = next_up if line.empty? # edge case, test 4
+        # start new line
+        result += line + "\n" unless str_array.empty? # edge case, test 2
+        # puts 'reset'
+        line = next_up + ' '
+        run_index += 1
+      end
+    end
+
+    result += line.strip + "\n" if line.length > 0 # Don't lose what is left
+    result
+  end
+
+end

data/lib/wrapify/version.rb

@@ -0,0 +1,3 @@
+module Wrapify
+  VERSION = "0.1.2" # changed repo in spec
+end

data/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/wrapify.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wrapify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wrapify"
+  spec.version       = Wrapify::VERSION
+  spec.authors       = ["Frank Germano"]
+  spec.email         = ["fgermano@earthlink.net"]
+
+  spec.summary       = "Wrap lines at given char limit"
+  spec.description   = "Wrap lines at given char limit"
+  spec.homepage      = "https://github.com/fgermanojr/wrapify.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.7", ">= 3.7.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrapify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Frank Germano
@@ -64,8 +64,23 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/fgermanojr/emrbear_repo.git
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wrapify.rb
+- lib/wrapify/version.rb
+- tasks/rspec.rake
+- wrapify-0.1.0.gem
+- wrapify-0.1.1.gem
+- wrapify.gemspec
+homepage: https://github.com/fgermanojr/wrapify.git
 licenses:
 - MIT
 metadata: {}