sanetitle 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42359086950b2c27ccdf088053a75afe7cc9d6b3
+  data.tar.gz: 2d9566449da08027f478e1324a225451c2ef937a
+SHA512:
+  metadata.gz: c37935cb4d618fe7c17a33a74aed5befdc35b0c0deb22dc61a6a42f2d18587b06641661d087f45e209f19e4b51f5c23f4fa7ea246ade13ad4d67bd88c5ff88e0
+  data.tar.gz: 31069558a9744849365ea6db59528d723a4de22697b7bf2887b31cbab355787eedb63e3e3b05da9193a82bc018e10e0a88271ac5d917fd0c32c15e253aa3a6f4

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: 4rcQKlhInCbdu5FcMdQ5zF9FqsUT9Cdr0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+sanetitle

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: require
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.3.2
+  - 2.3.1
+  - 2.2.5
+  - 2.2.4
+  - 2.2.3
+  - 2.2.2
+  - 2.2.1
+  - 2.2.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+
+# Specify your gem's dependencies in sanetitle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edvaldo Silva de Almeida Júnior
+
+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,104 @@
+# SaneTitle
+
+[![GitHub version](https://badge.fury.io/gh/MIT-Licensed-gems%2Fsanetitle.svg)](https://badge.fury.io/gh/MIT-Licensed-gems%2Fsanetitle)
+[![Build status](https://travis-ci.org/EdDeAlmeidaJr/sanetitle.svg?branch=master)](https://travis-ci.org/EdDeAlmeidaJr/sanetitle.svg?branch=master)
+[![Code Climate](https://codeclimate.com/repos/56b8b4bb67fabe0fbc00274f/badges/ff71f9b0b75afbb85416/gpa.svg)](https://codeclimate.com/repos/56b8b4bb67fabe0fbc00274f/feed)
+[![Issue Count](https://codeclimate.com/repos/56b8b4bb67fabe0fbc00274f/badges/ff71f9b0b75afbb85416/issue_count.svg)](https://codeclimate.com/repos/56b8b4bb67fabe0fbc00274f/feed)
+
+
+This gem generates a sane hyfen-separated text to serve as URL address to a page, based on a given string. It is ideal to generate a URL based on a title of a blog post or article, thus the name of the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanetitle'
+```
+
+And then execute:
+
+```bash
+    $ bundle
+```
+
+Or install it yourself as:
+
+```bash
+    $ gem install sanetitle
+```
+
+## Usage
+
+The usage is quite simple. 
+
+Just create a SaneTitle::Sanitize object, passing the string you want to make sane, like:
+
+```ruby
+    obj = SaneTitle::Sanifier.new("Este é um exemplo de string que será corrigida no curso da programação")
+```
+
+and then store the sane string in a variable with
+
+```ruby
+    sane_title = obj.result
+```
+
+In this particular case, the variable sane_title shall contain "este-e-um-exemplo-de-string-que-sera-corrigida-no-curso-da-programacao".
+
+From release 0.3.0 on, one may also call
+
+```ruby
+    sane_title = obj.result_imp(<limit>,<html>,<tstamp>)
+```
+
+where:
+
+<limit> is an integer value used to require that the size of the result string is limited to this size, and
+<html> is a boolean value to require (true) or not (false) that the extension .html is appended to the result.
+<tstamp> is a boolean value to indicating if the result string must be prepended with a timestamp in the format "yyyy-mm-dd-hh-mm-ss-"
+
+Note two important things:
+
+1) If you use
+
+```ruby
+    sane_title = obj.result_imp(20,true)
+```
+
+the result string shall have, in fact, a lenght of 25. 20 from the limit you asked, plus five, which is the size of the extension .html. If you want a total of 20 positions you should say
+
+```ruby
+    sane_title = obj.result_imp(15,true)
+```
+
+## Important advice
+
+This gem makes no assumption about filesystems. Then, if you intend to use the filename obtained here as a name of a file to be written, **please take care of duplicate names before writing**. We won't accept any responsability on data loss.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Donating
+
+Cosider supporting my work [donating](https://gratipay.com/~EdDeAlmeidaJr/) some money. This will help me to create more and more useful gems to enrich Ruby's ecosystem.
+
+## Contributing
+
+If you want to contribute to this project, your help is welcome, for sure. But please, take some note before you start, so you won't tell me you didn't knew these things beforehand:
+
+01) We are here to develop some software, not to discuss politics, race, religion, gender or any other issue the 'politically correct' people like to raise to disguise their inability to make things happen.
+
+02) Opinions given by any developer outside the scope of this project are not our business. We don't care about what what you think, as long as you do NOT bring your opinions to this development space.
+
+03) You may not raise issues about things not related to this project. This includes issues related to other developer's opinions given outside here.
+
+04) Just to summarize all things said before: **Keep your personal stuff far away from this project and discuss only the project in its context**.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sanetitle"
+
+# 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

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/sanetitle.rb

@@ -0,0 +1,66 @@
+require "sanetitle/version"
+
+module SaneTitle
+
+  class Sanifier
+
+    def initialize(title)
+      raise ArgumentError.new('Invalid string.') unless (is_string?(title) and empty_string?(title))
+      step1 = title
+      step2 = to_lower(step1)
+      step3 = remove_special_chars(step2)
+      step4 = spaces_to_underlines(step3)
+      @@title_str = step4
+    end
+    
+    def to_lower(str)
+      str.downcase
+    end
+  
+    def spaces_to_underlines(str)
+      str.gsub(/\ /,"-")
+    end
+    
+    def remove_special_chars(str)
+      s1 = str.gsub(/[á|à|ã|ä|â]/,"a")
+      s1 = s1.gsub(/[é|è|ẽ|ë|ê]/,"e")
+      s1 = s1.gsub(/[í|ì|ĩ|ï|î]/,"i")
+      s1 = s1.gsub(/[ó|ò|õ|ö|ô]/,"o")
+      s1 = s1.gsub(/[ú|ù|ũ|ü|û]/,"u")
+      s1 = s1.gsub(/[ñ]/,"n")
+      s1 = s1.gsub(/[ç]/,"c")
+      s1 = s1.gsub(/[\+|\=|\_|\-|\(|\)|\*|\%|\&|\$|\#|\@|\!|\?|\/|\:|\;|\.|\,|\>|\<]/,"")
+      s1.gsub(/\ \ /," ")
+    end
+    
+    def result
+      @@title_str
+    end
+    
+    def result_imp(lim,html,tstamp = false)
+      resimp = result
+      resimp = resimp[0,lim]
+      if (html) then
+        resimp = resimp + '.html'
+      end
+      if (tstamp) then
+        dt = DateTime.now
+        yyyy = dt.year.to_s 
+        mm = (dt.month < 10) ? '0' + dt.month.to_s : dt.month.to_s
+        dd = (dt.day < 10) ? '0' + dt.day.to_s : dt.day.to_s 
+        resimp = "#{yyyy}-#{mm}-#{dd}-#{resimp}"
+      end
+      resimp
+    end
+  
+    def is_string?(title)
+      title.is_a? String
+    end
+  
+    def empty_string?(title)
+      title.length > 0
+    end
+  
+  end
+    
+end

data/lib/sanetitle/version.rb

@@ -0,0 +1,3 @@
+module SaneTitle
+  VERSION = "0.3.3"
+end

data/sanetitle.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sanetitle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sanetitle"
+  spec.version       = SaneTitle::VERSION
+  spec.authors       = ["Edvaldo Silva de Almeida Júnior"]
+  spec.email         = ["edvaldoajunior@gmail.com"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.summary       = "Generates a sane string which may be used as a URL, based on a sentence."
+  spec.description   = "This gem generates a sane hyfen-separated text to serve as URL address to a page, based on a given string. It is ideal to generate a URL based on a title of a blog post or article, thus the name of the gem."
+  spec.homepage      = "https://github.com/EdDeAlmeidaJr/sanetitle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: sanetitle
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+platform: ruby
+authors:
+- Edvaldo Silva de Almeida Júnior
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem generates a sane hyfen-separated text to serve as URL address
+  to a page, based on a given string. It is ideal to generate a URL based on a title
+  of a blog post or article, thus the name of the gem.
+email:
+- edvaldoajunior@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sanetitle.rb
+- lib/sanetitle/version.rb
+- sanetitle.gemspec
+homepage: https://github.com/EdDeAlmeidaJr/sanetitle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Generates a sane string which may be used as a URL, based on a sentence.
+test_files: []