phraser 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47d3b4f15fe1f6e4a563d9553f24c12d0564b6b5
-  data.tar.gz: d5e0153471471f551df639155d1b8cf664379b73
+  metadata.gz: 522719da67afc029bc104b623515b5662a8d624c
+  data.tar.gz: 727b82949406c6dbec53365c234be49b9af86654
 SHA512:
-  metadata.gz: ecb6cfe7015a7a3c1ef62bb98a5555988cb4ab206755ef42ee2ddd7a0e10655f6d91aa3ffaea5e0bb95db45dfd9df9138c700c9be65d63f488aa1f288516d69b
-  data.tar.gz: 2a2ffb52fe8b0a3d59a03bf12661108d8a0c61e1640700af168ad365a64f0d4aa5000014313cf468b470c41cae9ad84ad1a1d53533bc47dcf9fd2bfdf9dbdcb9
+  metadata.gz: d32ee2d2595cb777f6fdb1431586ff1c5d593a08ebb7eafc3b13d125ea2960de32e87e7445dc08479b2960ec46970e348b20d6f493cedd07300b980d534ced2a
+  data.tar.gz: 693a013093a9b4271235bc254583c9474e603572eca90c433340cd3774d8228832d0db62e138b80f43042a874c2136ee3d87bcb97b072483b15fc74ba88e8376

data/.rubocop.yml

@@ -1,4 +1,8 @@
 Metrics/LineLength:
   Max: 120
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
+  ExcludedMethods: ['describe', 'context']
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false

data/README.md

@@ -20,22 +20,40 @@ Or install it yourself as:
 
 ## Usage
 
-Generate array of strings:
-``` ruby
-TokenPhrase.generate([prefix: proc{}, postfix: proc{}])
-> ['red', 'massive', 'elephant']
+Full 
+```ruby
+Phraser.generate(prefix: proc{ Time.now.to_i }, postfix: "the-end")
+Phraser.generate_string(separator: '*', prefix: proc{ Time.now.to_i }, postfix: "the-end")
 ```
 
-Generate completely string:
-```
-TokenPhrase.generate_string([separator: '-', prefix: proc{}, postfix: proc{}])
-> "1792123-red-massive-elephant-68912223"
+All parameters are optional (just use named arguments):
+
+- `separator` is "-" by default but if you would like a different separator, just pass a string
+- `prefix` String or Proc going to be 1st element in the resulted array or string
+- `postfix` String or Proc will be last element in the resulted array or string
+
+### Examples
+
+Generate array:
+```ruby
+Phraser.generate
+> ["marked", "purple", "joke", "on", "presence"]
 ```
+
+Generate string:
+```ruby
+Phraser.generate_string
+> 'convinced-brown-hop-at-South"
 ```
-prefix = proc{ 'begin' }
-postfix = proc{ 'end' }
-TokenPhrase.generate_string(prefix: prefix, postfix: postfix)
-> "begin-red-massive-elephant-end"
+
+Different separator, prefix is Timestamp and 'the-end' string added to the end of the string
+```ruby
+separator = '*'
+prefix = proc{ Time.now.to_i }
+postfix = "the-end"
+Phraser.generate_string(separator: separator, prefix: prefix, postfix: postfix)
+> "1496842603*red*massive*elephant*the-end"
+
 ```
 
 ## Development
@@ -54,6 +72,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Phraser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phraser/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Phraser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mpakus/phraser/blob/master/CODE_OF_CONDUCT.md).
 
 [![CircleCI](https://circleci.com/gh/mpakus/phraser.svg?style=svg)](https://circleci.com/gh/mpakus/phraser)

data/lib/phraser/version.rb

@@ -1,3 +1,3 @@
 module Phraser
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/phraser.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Renat Ibragimov']
   spec.email         = ['mrak69@gmail.com']
 
-  spec.summary       = 'Generate random phrases'
+  spec.summary       = 'Generate random phrases and tokens'
   spec.description   = 'Phraser is a gem that generates unique phrases to use in your app as password, url and tokens'
   spec.homepage      = 'https://github.com/mpakus/phraser'
   spec.license       = 'MIT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phraser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Renat Ibragimov
@@ -126,5 +126,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Generate random phrases
+summary: Generate random phrases and tokens
 test_files: []