fillertext 0.2.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1854927a266ff9936d37c2f1e90a0d14f1a044c283657ace868b85184cb063a2
-  data.tar.gz: 48e171c6f3516c02a603f42469ee8de3163814aa514078010b5ac2fb023975f0
+  metadata.gz: 1e2a17035c765225113cd70e39955295f581f7fc70927f6dba1d16f39a1c2b45
+  data.tar.gz: 8c82337dc95152006fa2f2b3729ad98cf50f78a5e0a5ade2d9c30a56e7ad591b
 SHA512:
-  metadata.gz: 7771d06da89be76deb07919cb786a1cb5414d7d24e0c203ed40c9c092723edf5da904cc389051cb1ba07ac63f33b89928bb3ed142ae70e30ef411031dbc7f394
-  data.tar.gz: fe5d627fa044ad8009937d24898560d9d0ab6a103503f745f93ff10faa7f4323b8d8624417e08ede0a2c41b3575139ee3da240ae8d888c706a3a5ec885cd0b77
+  metadata.gz: 2f576cd27a968bdd9e02488dabf6a017f8fa3af467fc1af5c21e74457e14a509e18864484a5a9a829dbfd489743a4fcf50d55d36d01e98bd3b1dc1ecd720eb22
+  data.tar.gz: c0604d8a1ee5f7bce4a9b96736e9a34651a2d98c278f98546cf31c0ffc8e4f31126fec752a3c4a9dfc194e36fce92ba7133711e9f049bc9c859bb3ea2389d6b3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,183 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'lib/fillertext/styles/*.rb'
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/RequireMFA:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/EmptyInPattern:
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Lint/UselessRuby2Keywords:
+  Enabled: true
+
+Naming/BlockForwarding:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
+Style/ArgumentsForwarding:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/EndlessMethod:
+  Enabled: true
+
+Style/FileRead:
+  Enabled: true
+
+Style/FileWrite:
+  Enabled: true
+
+Style/HashConversion:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/InPatternThen:
+  Enabled: true
+
+Style/MapToHash:
+  Enabled: true
+
+Style/MultilineInPatternThen:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/NumberedParameters:
+  Enabled: true
+
+Style/NumberedParametersLimit:
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: true
+
+Style/QuotedSymbols:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true
+
+Metrics/MethodLength:
+  Enabled: true
+  Exclude:
+    - 'lib/fillertext/styles/*.rb'
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'spec/*_spec.rb'

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.5](https://github.com/colindean/fillertext/compare/v0.3.4...v0.3.5) (2022-10-21)
+
+
+### Bug Fixes
+
+* Update README.md, add instructions for: ([61e8e6f](https://github.com/colindean/fillertext/commit/61e8e6fa26f410badac701cdd3b064f29b0f222a))
+
+### [0.3.4](https://github.com/colindean/fillertext/compare/v0.3.3...v0.3.4) (2022-02-07)
+
+
+### Bug Fixes
+
+* Fixes URL to Ashvith's profile ([256f4d3](https://github.com/colindean/fillertext/commit/256f4d353f19a9cec08d9a6ac76e95d8129933c2))
+
+### [0.3.3](https://github.com/colindean/fillertext/compare/v0.3.2...v0.3.3) (2022-02-07)
+
+
+### Bug Fixes
+
+* Get all git tags during release process ([fc54124](https://github.com/colindean/fillertext/commit/fc54124f77e218a5ae4f383f4f101e5d1404bcdc))
+* Satisfies Rubocop checks ([531ad51](https://github.com/colindean/fillertext/commit/531ad5191f40a23b28006db41cd66eda499c35c8))
+
+### [0.3.2](https://github.com/colindean/fillertext/compare/v0.3.1...v0.3.2) (2022-02-07)
+
+
+### Bug Fixes
+
+* Set git user/email in release workflow ([806b49a](https://github.com/colindean/fillertext/commit/806b49a46256688c7101cc621d188236deb9fc33))
+
+### [0.3.1](https://github.com/colindean/fillertext/compare/v0.3.0...v0.3.1) (2022-02-07)
+
+
+### Bug Fixes
+
+* Source gemspec version from version.rb ([fc791c5](https://github.com/colindean/fillertext/commit/fc791c5009ff4dc4ceb2f640687aff1bcfcb7007))
+
+## [0.3.0](https://github.com/colindean/fillertext/compare/v0.2.1...v0.3.0) (2022-02-07)
+
+
+### Features
+
+* Adds release instructions and tests an automated release ([2dd6c80](https://github.com/colindean/fillertext/commit/2dd6c80d83eac2b7c05e431a505fbb4a4b5da175))
+
+
+## [0.2.1](https://www.github.com/colindean/fillertext/compare/v0.2.0...v0.2.1) (2021-10-27)
+
+### Added
+
+* `MikeLange` style, comprised of phrases from the [famous Pittsburgh Penguins hockey announcer](https://en.wikipedia.org/wiki/Mike_Lange) in honor of his retirement
+* Development: Adds `rake irb` to drop to a console for interaction (@m3xq)
+* Development: CI is now testing on the latest JRuby and TruffleRuby as well as Ruby 3.0
+
+### Changed
+
+* Updated CI links and badges in README
+* Development: Now using GitHub Actions for CI instead of Travis
+* Development: Prepare for Minitest 6 by updating test syntax and pinning Minitest 5+.
+
+### Fixed
+
+* Gemfile & Gemfile.lock to reduce vulnerabilities ([4f2c55b](https://www.github.com/colindean/fillertext/commit/4f2c55b29868d8e9ea174e53508d17167a36c3d7))
+
+### Deprecated
+
+* Ruby 2.5 support. Future releases will cease testing against Ruby 2.5 as it is end-of-life as of March 2021.
+* Ruby 2.6 support. The first release after March 2022 will cease testing against Ruby 2.6 as it is end-of-life as of March 2022.
+
+### Removed
+
+* `Gemfile.lock` dropped from versioning to follow gem development [best practices](https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/).

data/CITATION.cff

@@ -0,0 +1,13 @@
+cff-version: 1.2.0
+message: >
+  If you use this software in research or other work
+  wherein you are citing references and tools,
+  please consider citing fillertext as indicated below.
+authors:
+- family-names: "Dean"
+  given-names: "Colin"
+  orcid: "https://orcid.org/0000-0002-3374-6891"
+title: "fillertext"
+version: 0.2.2
+date-released: 2022-01-26
+url: "https://github.com/colindean/fillertext"

data/Gemfile

@@ -1,13 +1,16 @@
-source "http://rubygems.org"
-
-group :test do
-  gem 'rake'
-  gem 'minitest'
-end
-
-group :development do
-  gem "rdoc"
-  gem "jeweler"
-  gem "simplecov"
-  gem "turn"
-end
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fillertext.gemspec
+gemspec
+
+gem "rake"
+
+gem "rspec"
+
+gem "rubocop"
+
+gem "rubocop-rake"
+
+gem "rubocop-rspec"

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2012 Colin Dean
+FillerText is licensed under the 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:
+Copyright (C) 2011-2022 by Colin Dean
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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,117 @@
+FillerText
+==========
+
+by @colindean
+
+[![Testing Build Status](https://github.com/colindean/fillertext/actions/workflows/testing.yml/badge.svg)](https://github.com/colindean/fillertext/actions/workflows/testing.yml)
+[![Release Build Status](https://github.com/colindean/fillertext/actions/workflows/release.yml/badge.svg)](https://github.com/colindean/fillertext/actions/workflows/release.yml)
+[![Gem Version](https://badge.fury.io/rb/fillertext.svg)](https://badge.fury.io/rb/fillertext)
+
+Introduction
+------------
+
+FillerText is a gem useful for generating, well, filler text. It can do the standard "lorem ipsum" text or a variety of other clever substitute texts.
+
+Installing FillerText
+---------------------
+
+Install using:
+
+```sh
+gem install fillertext
+```
+
+or add the gem to your project's `Gemfile`:
+
+```ruby
+gem 'fillertext'
+```
+
+Using FillerText
+----------------
+
+Here's how you use FillerText.
+
+There are two main ways. One is cleaner because it keeps FillerText within its
+own namespace. The other method will add `Fixnum#filler` to keep some tasty
+syntactical sugar.
+
+```ruby
+FillerText::FillerText.sentences 5
+FillerText::FillerText.words 2
+FillerText::FillerText.characters 5
+FillerText::FillerText.bytes 4
+FillerText::FillerText.paragraphs 1
+```
+
+or the *much* easier and intended method:
+
+```ruby
+2.filler.sentences
+1.filler.paragraphs
+```
+
+You can also change the style from the default "lorem ipsum" to something else.
+
+```ruby
+# the old favorite
+FillerText::FillerText.style = FillerText::Style::LoremIpsum
+# a mash of words
+FillerText::FillerText.style = FillerText::Style::HipsterIpsum
+# handmade just like grandma's pierogies
+FillerText::FillerText.style = FillerText::Style::YinzerIpsum
+# homage to the great Pittsburgh Penguins announcer
+FillerTest::FillerText.style = FillerText::Style::MikeLange
+```
+
+Contributing to FillerText
+--------------------------
+### Setting up the project
+1. [Create a fork](https://github.com/colindean/fillertext/fork) of the GitHub project repo.
+2. `git clone` the forked repository to your local system.
+3. Make sure that the version of Ruby you're using meets the [minimum requirement in the gemspec](https://github.com/colindean/fillertext/blob/master/fillertext.gemspec#L15). 
+4. Run `bundle install` to install dependencies. It should tell you at this point if you don't have an adequate Ruby version installed.
+5. Check basic sanity by running `bundle exec rake` to run tests and checks _before_ you make any changes.
+6. Make your changes and commit them to a feature branch. If you're picking a particular GitHub issue, please put `gh-##-topic` in the branch where `##` is the ticket number and `topic` is a few words about it.
+7. Push to your own repo and then submit a pull request to this one!
+
+### Testing the project
+FillerText uses [RSpec](https://github.com/rspec/rspec-core) for unit testing and [SimpleCov](https://github.com/simplecov-ruby/simplecov) for code coverage. New specifications can be added inside the `spec/` directory.
+
+1. Make sure that the project is set up properly (see [Setting up the project](#setting-up-the-project))
+2.
+	1. Run `rspec` to run all the tests by default
+	2. To run only a selected few tests, run `rspec spec/<test_you're_interested_in>_spec.rb`
+3. To access code coverage details, run `xdg-open coverage/index.html` (on Linux) or `open coverage/index.html` (on Mac)
+
+Patches welcome. Please file using Github issues.
+
+I sincerely thank [Ashvith Shetty](https://github.com/Ashvith) for modernizing the build system
+for this software in 2022. Things are a lot easier to handle now than they were
+in 2011!
+
+
+### Releases
+
+As of 0.2.3, FillerText uses
+[release-please](https://github.com/googleapis/release-please) along with
+[release-please-action](https://github.com/google-github-actions/release-please-action)
+for release automation in GitHub Actions.
+
+Following [Conventional Commits v1.0
+standard](https://www.conventionalcommits.org/en/v1.0.0/),
+prefix a commit with `fix:` to increment the patch version in a future release,
+prefix with `feat:` to increment the minor version, and
+prefix with `feat!:` or `fix!:` or `refactor!:` to mark a breaking change and
+a major version increment.
+
+For more information, read the [release-please-action
+documentation](https://github.com/google-github-actions/release-please-action#how-release-please-works)
+on releasing.
+
+License
+-------
+
+FillerText is licensed under the MIT license.
+Copyright (C) 2011-2022 by Colin Dean.
+See [LICENSE.txt](LICENSE.txt) for more.

data/Rakefile

@@ -1,51 +1,12 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-require 'rake/testtask'
-require 'jeweler'
-require 'simplecov'
-require 'rdoc/task'
+# frozen_string_literal: true
 
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "fillertext"
-  gem.homepage = "http://github.com/colindean/fillertext"
-  gem.license = "MIT"
-  gem.summary = %Q{Generates filler/placeholder text in a Rubyistic way}
-  gem.description = %Q{Generates filler text through a direct interface or by monkeypatching Fixnum}
-  gem.email = "git+gems@cad.cx"
-  gem.authors = ["Colin Dean"]
-  # dependencies defined in Gemfile
-end
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-Jeweler::RubygemsDotOrgTasks.new
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new(:spec) do |t|
-  t.libs.push 'lib'
-  t.test_files = FileList['spec/*_spec.rb']
-  t.verbose = true
-end
+require "rubocop/rake_task"
 
-desc "Run :spec with code coverage"
-task :coverage do
-  `rake spec COVERAGE=true`
-  `open coverage/index.html`
-end
+RuboCop::RakeTask.new
 
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "fillertext #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-task :default => :spec
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "fillertext"
+
+# 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/fillertext/fillertext.rb

@@ -1,71 +1,36 @@
-module FillerText
-  #this has to be here because of file require order issues
-  #todo: fix this
-  module Style; class LoremIpsum; end; end
+# frozen_string_literal: true
 
-  def self.paragraphs(n=nil)
-    FillerText.paragraphs n
-  end
-  def self.words(n=nil)
-    FillerText.words n
-  end
-  def self.bytes(n=nil)
-    FillerText.bytes n
+Dir[File.join(__dir__, "styles/*.rb")].sort.each { |file| require_relative file }
+
+# Helper module to choose styles
+module FillerText
+  class << self
+    attr_accessor :style, :num
   end
-  def self.characters(n=nil)
-    FillerText.characters n
+
+  @style = FillerText::Style::LoremIpsum
+
+  def self.bytes(num = nil)
+    num ||= self.num
+    style.text[0, num]
   end
-  def self.sentences(n=nil)
-    FillerText.sentences n
+
+  def self.characters(num = nil)
+    bytes(num)
   end
-  
-  class FillerText
 
-    @@style = Style::LoremIpsum
-  
-    def self.style=(style)
-      @@style = style
-    end
+  def self.words(num = nil)
+    num ||= self.num
+    style.text.split[0, num].join(" ").gsub(/[^\w\s]/, "")
+  end
 
-    def self.style
-      @@style
-    end
+  def self.sentences(num = nil)
+    num ||= self.num
+    style.text.split(".").slice(0, num).join(". ")
+  end
 
-    @@num = 0
-  
-    def self.n=(n)
-      @@num = n
-    end
-    
-    def self.n
-      @@num
-    end
-  
-    def self.bytes(n=nil)
-      n ||= self.n
-      self.style.text[0,n]
-    end
-    
-    def self.characters(n=nil)
-      #same thing for now
-      self.bytes(n)
-    end
-    
-    def self.words(n=nil)
-      n ||= self.n
-      #the idea here is to find the nth space and return everything before it
-      self.style.text.split[0,n].join(" ").gsub(/[^\w\s]/,'')
-    end
-    
-    def self.sentences(n=nil)
-      n ||= self.n
-      self.style.text.split('.').slice(0,n).join(". ")
-    end
-    
-    def self.paragraphs(n=nil)
-      n ||= self.n
-      self.style.text.split("\n").slice(0,n).join("\n")
-    end
-    
+  def self.paragraphs(num = nil)
+    num ||= self.num
+    style.text.split("\n").slice(0, num).join("\n")
   end
 end

data/lib/fillertext/integer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FillerText
+  # Modification for Integer class
+  module Integer
+    def filler
+      FillerText.num = self
+      FillerText
+    end
+  end
+end
+
+class Integer
+  include FillerText::Integer
+end