regeng 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793b1fe234f31d0436bd4897e1790b58866446ab38d26e7bafef3a2c259abaf2
-  data.tar.gz: 20b8ee94808bfa33dca2bebec6a370892f18aebdf545b949a5ca4797fb618d29
+  metadata.gz: b08c143342913d8a64a5cce550f2d1fa132acd8f92b543f833ac3fb631661cf8
+  data.tar.gz: 4121b024940ece38acec13398b97630fd65e7d369d1c91dad03b8a2c805da1ca
 SHA512:
-  metadata.gz: 8abc45f0202349ae23642cf86d5ce9ce03a7340dc757cce58f2449c092352874d1dbc1b315aa3ae8ef124b5f1ebc09e70ce5d5f59c6d9e227355e29c766709eb
-  data.tar.gz: 5a30c9135b3b2d6b662258c996bbc281603346d4d8380d6bfeeee8a168afeb4b892a8f8914de736af65224a730c942f86119d8ee7c4e81f646c9c36a796db8ef
+  metadata.gz: 4862c021d796fa74b5ac55ae15f069ff3f4c7f03d15b45da3fa3a52cf7b0ed7f7dea97f4f4bc1829fe3ae5c37c4051d0d29919e5e9b0b3b5d492a6bf44b489ca
+  data.tar.gz: 720e2344a7670dc5509c3a5b5a53931b9523ba7b1dfa645466e1f869f291676c6251b4d98656d77e1fc6bd490a7f0fdf8b4d17bec2c437972cf084302a0e470c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    regeng (0.2.4)
+    regeng (0.2.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,4 @@
-# Regeng
-
-# (WIP)
+# Regeng (WIP) {docsify-ignore-all}
 
 Regeng or regular english, is a gem aimed to make regular expressions a bit more noob friendly.
 
@@ -27,11 +25,11 @@ Or install it yourself as:
 ```ruby
 require 'regeng'
 => true
-Regeng.new 'any character except e-z at start of string'
-=> /\A[^e-z]/
+Regeng.new 'any characters except e through z at start of string'
+=> /\A[^e-z]+/
 ```
 
-Documentation in progress...
+More examples in the [Documentation](https://luchighwalker.github.io/regeng/)
 
 ## Development
 

data/docs/README.md

@@ -0,0 +1,58 @@
+# Regeng (WIP) {docsify-ignore-all}
+
+Regeng or regular english, is a gem aimed to make regular expressions a bit more noob friendly.
+
+[Regeng Gem](https://rubygems.org/gems/regeng)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'regeng'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install regeng
+
+## Usage
+
+### Quick Start 
+
+```ruby
+require 'regeng'
+=> true
+Regeng.new 'any characters except e through z at start of string'
+=> /\A[^e-z]+/
+```
+
+[Characters](/usage/characters.md ':include')
+
+[Numbers](/usage/numbers.md ':include')
+
+[AtModifier](/usage/atmodifier.md ':include')
+
+[ExceptMod](/usage/exceptmod.md ':include')
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LucHighwalker/regeng.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+[Changelog](/changelog.md ':include')

data/docs/changelog.md

@@ -0,0 +1,18 @@
+    [01-04-19] [0.2.5]: Now handles uppercase/lowercase with specified characters.
+
+    [01-02-19] [0.2.4]: Now processes more complex numbers.
+
+    [12-11-18] [0.2.3]: Now raises errors when expression fails to process. 
+
+    [12-11-18] [0.2.2]: Now can use .new to mimic Regex behaviour.
+                        Slightly expanded functionality.
+
+    [12-11-18] [0.2.1d]: Dev Build: At modifiers and simple digit expressions.
+
+    [12-10-18] [0.2.0d]: Dev Build: Refactored gem, refactored character functionality.
+
+    [12-09-18] [0.1.1]: Fixed changelog link... oops.
+
+    [12-09-18] [0.1.0]: Refactored prototype, now returns regular expressions.
+
+    [12-09-18] [0.0.1]: Initial prototype.

data/docs/index.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="https://unpkg.com/docsify-themeable/dist/css/theme-simple-dark.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+</html>

data/docs/usage/atmodifier.md

@@ -0,0 +1,14 @@
+### At Modifier
+
+The 'at' modifier can be used to indicate the start or end of a line or string.
+
+```ruby
+Regeng.new 'any characters at start of line'
+=> /^[A-Za-z]+/
+Regeng.new 'any characters at end of line'
+=> /$[A-Za-z]+/
+Regeng.new 'any characters at start of string'
+=> /\A[A-Za-z]+/
+Regeng.new 'any characters at end of string'
+=> /\z[A-Za-z]+/
+```

data/docs/usage/characters.md

@@ -0,0 +1,43 @@
+### Characters
+
+Use the 'to', 'through' or '-' indicator for ranges.
+You can also use the 'and' indicator for ranges if the characters are preceeded with 'between' or 'from'.
+
+```ruby
+Regeng.new 'character e to z'
+Regeng.new 'character e through z'
+Regeng.new 'character e-z'
+Regeng.new 'character between e and z'
+Regeng.new 'character from e and z'
+=> /[E-Ze-z]/
+```
+
+Using 'and' as an indicator without 'between' or 'from' will result in exact matches.
+
+```ruby
+Regeng.new 'character s o e and z'
+=> /[SOEZsoez]/
+```
+
+Pluralizing 'character' will result in multiples.
+
+```ruby
+Regeng.new 'characters e through z'
+=> /[E-Ze-z]+/
+```
+
+Indicate 'any character(s)'
+
+```ruby
+Regeng.new 'any characters'
+=> /[A-Za-z]+/
+```
+
+Use an 'uppercase' or 'lowercase' modifier
+
+```ruby
+Regeng.new 'any uppercase character e through z'
+=> /[E-Z]/
+Regeng.new 'any lowercase character e through z'
+=> /[e-z]/
+```

data/docs/usage/exceptmod.md

@@ -0,0 +1,8 @@
+### Except Modifier
+
+The 'except' modifier can be used to exclude matches. 
+
+```ruby
+Regeng.new 'any character except e through z'
+=> /[^E-Ze-z]/
+```

data/docs/usage/numbers.md

@@ -0,0 +1,43 @@
+### Numbers
+
+Use either the 'number' or 'digit' keywords.
+
+Use the 'to', 'through' or '-' indicator for ranges.
+You can also use the 'and' indicator for ranges if the numbers are preceeded with 'between' or 'from'.
+
+```ruby
+Regeng.new 'number 2 to 4'
+Regeng.new 'number 2 through 4'
+Regeng.new 'number 2-4'
+Regeng.new 'number between 2 and 4'
+Regeng.new 'number from 2 and 4'
+=> /[2-4]/
+```
+
+Using the 'and' keyword will result in exact matches.
+
+```ruby
+Regeng.new 'number 2 1 5 and 4'
+=> /[2154]/
+```
+
+Pluralizing 'number' will result in multiples.
+
+```ruby
+Regeng.new 'numbers 2 through 4'
+=> /[2-4]+/
+```
+
+Indicate 'any number(s)'
+
+```ruby
+Regeng.new 'any numbers'
+=> /[0-9]+/
+```
+
+Regeng supports multiples of 10s. Currently both numbers must have the same amount of zeros.
+
+```ruby
+Regeng.new 'number between 400 and 600'
+=> /(4[0-9][0-9])|(5[0-9][0-9])|(600)/
+```

data/lib/regeng.rb

@@ -61,6 +61,16 @@ module Regeng
       character_mod = unfiltered_mod.to_s.gsub(/( )|(and )/, '')
     end
 
+    character_mod = character_mod.to_s
+
+    character_mod = if /(uppercase)/.match?(string)
+                      character_mod.upcase
+                    elsif /(lowercase)/.match?(string)
+                      character_mod.downcase
+                    else
+                      "#{character_mod.upcase}#{character_mod.downcase}"
+                    end
+
     Error.invalid_expression if character_mod.nil? || character_mod == '-'
 
     "[#{except}#{character_mod}]#{multiples}"
@@ -68,7 +78,7 @@ module Regeng
 
   # Processes simple character expressions.
   def self.characters_simple(string)
-    character_mod = 'a-zA-Z'
+    character_mod = 'A-Za-z'
     multiples = '+' if /(character)(s)/.match?(string)
     if /(uppercase)/.match?(string)
       character_mod = 'A-Z'
@@ -103,7 +113,7 @@ module Regeng
     Error.invalid_expression if digit_mod.nil? || digit_mod == '-'
 
     if complex
-      "#{digit_mod}"
+      digit_mod.to_s
     else
       "[#{except}#{digit_mod}]#{multiples}"
     end

data/lib/regeng/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Regeng
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/regeng.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'A gem which converts plain english to regular expressions.'
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = 'https://rubygems.org/gems/regeng'
+  spec.homepage      = 'https://luchighwalker.github.io/regeng/'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
 
     spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/LucHighwalker/regeng.git'
-    spec.metadata['changelog_uri'] = 'https://github.com/LucHighwalker/regeng/blob/master/changelog.md'
+    spec.metadata['documentation_uri'] = 'https://luchighwalker.github.io/regeng/'
+    spec.metadata['changelog_uri'] = 'https://luchighwalker.github.io/regeng/#/?id=changelog'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regeng
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - LucHighwalker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,18 +69,26 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- changelog.md
+- docs/.nojekyll
+- docs/README.md
+- docs/changelog.md
+- docs/index.html
+- docs/usage/atmodifier.md
+- docs/usage/characters.md
+- docs/usage/exceptmod.md
+- docs/usage/numbers.md
 - lib/regeng.rb
 - lib/regeng/version.rb
 - regeng.gemspec
-homepage: https://rubygems.org/gems/regeng
+homepage: https://luchighwalker.github.io/regeng/
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://rubygems.org/gems/regeng
+  homepage_uri: https://luchighwalker.github.io/regeng/
   source_code_uri: https://github.com/LucHighwalker/regeng.git
-  changelog_uri: https://github.com/LucHighwalker/regeng/blob/master/changelog.md
+  documentation_uri: https://luchighwalker.github.io/regeng/
+  changelog_uri: https://luchighwalker.github.io/regeng/#/?id=changelog
 post_install_message: 
 rdoc_options: []
 require_paths:

data/changelog.md

@@ -1,16 +0,0 @@
-[01-02-19][0.2.4]: Now processes more complex numbers.
-
-[12-11-18][0.2.3]: Now raises errors when expression fails to process. 
-
-[12-11-18][0.2.2]: Now can use .new to mimic Regex behaviour.
-                    Slightly expanded functionality.
-
-[12-11-18][0.2.1d]: Dev Build: At modifiers and simple digit expressions.
-
-[12-10-18][0.2.0d]: Dev Build: Refactored gem, refactored character functionality.
-
-[12-09-18][0.1.1]: Fixed changelog link... oops.
-
-[12-09-18][0.1.0]: Refactored prototype, now returns regular expressions.
-
-[12-09-18][0.0.1]: Initial prototype.