qf 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a45fe35781e069c9028f32df2267757cec043ba0
4
- data.tar.gz: 4d2aa921777c30967b2cc9b3abbb64c5a6f4501b
3
+ metadata.gz: ecf4922ec4914b17d4bf532d70cd43d7adccc103
4
+ data.tar.gz: c460156e797ba6dc45ddee4f3f08cd6519b4d3d6
5
5
  SHA512:
6
- metadata.gz: 01a309693226acaafea9f3fbd39b64edc6b1ca2393582219cc683e685767e3c8577bb2b105744a2d878dd6554204a798d9c6d10c667094ed601a150c8e88175f
7
- data.tar.gz: b4f1722098f3142a84f42dc75cf32820beb2f303db29a4244331913aab5c9e2048933e7622bedfd20979bf694c82d2e821e6e08507de7b6146f75351c6469da5
6
+ metadata.gz: 753eee3d97df970a29d1aa02dab6d77b430b97919dd3047c9c857283b108e10a932ff6f4f917a06f94b54afc3ade32925dcd2cd0ab6b92b0e464933d29df083f
7
+ data.tar.gz: 74d79e5d2a2c8c2204bf81654af01d8e9b65accc0af8ed6afc15dbfa310c3e9cfdf9a881514487ea5a9ad6013796b7fb25f57f41555eb54d7d1b2fa92cb4bf91
@@ -1,4 +1,4 @@
1
1
  language: ruby
2
2
  rvm:
3
- - 2.2.3
3
+ - 2.3.0
4
4
  before_install: gem install bundler -v 1.11.2
data/README.md CHANGED
@@ -1,6 +1,7 @@
1
- # qf
1
+ # ![fq-logo][logo] qf
2
2
 
3
3
  [![Travis](https://img.shields.io/travis/krmbzds/qf.svg)](https://travis-ci.org/krmbzds/qf)
4
+ [![Code Climate](https://img.shields.io/codeclimate/github/krmbzds/qf.svg)](https://codeclimate.com/github/krmbzds/qf)
4
5
  [![Gem](https://img.shields.io/gem/dv/qf/stable.svg)](https://rubygems.org/gems/qf)
5
6
 
6
7
  qf is a ruby gem that extracts specific substrings from a block of text. Examples of substrings are the following, but not limited to: emails, URIs, magnets links, ipv4, ipv6 addresses, etc.
@@ -23,8 +24,52 @@ Or install it yourself as:
23
24
 
24
25
  ## Usage
25
26
 
26
- TODO: Write usage instructions here
27
+ ```
28
+ Usage: qf [filter]
29
+
30
+ Options
31
+ -h, --help Prints this help page
32
+ -l, --list Lists available filters
33
+
34
+ Examples
35
+ qf url
36
+ qf magnet
37
+ qf creditcard
38
+ qf creditcard:visa
39
+
40
+ This application standard input and output.
41
+ ```
42
+
43
+ ## Examples
44
+
45
+ qf behaves like a standard unix application.
46
+
47
+ Let's say you want to extract URLs from a website:
48
+
49
+ ```sh
50
+ curl kerembozdas.com | qf url
51
+ ```
52
+
53
+ Or credit cards from some csv file:
54
+
55
+ ```sh
56
+ cat customers.csv | qf creditcard
57
+ ```
58
+
59
+ Emails from some contact page:
60
+
61
+ ```sh
62
+ curl www.linux.com/contact | qf email
63
+ ```
64
+
65
+ To see all the options you can use:
66
+
67
+ ```sh
68
+ qf --list
69
+ ```
27
70
 
28
71
  ## Contributing
29
72
 
30
73
  Bug reports and pull requests are welcome on GitHub at https://github.com/krmbzds/qf.
74
+
75
+ [logo]: http://i.imgur.com/PQxBoRI.png
@@ -1,3 +1,3 @@
1
1
  class Qf
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
data/qf.gemspec CHANGED
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ["krmbzds.github@gmail.com", "besirkurtulmus@gmail.com", "cediddi@gmail.com"]
11
11
 
12
12
  spec.summary = "Extract specific substrings from a block of text"
13
- spec.description = "qf is a ruby gem that extracts specific substrings from a block of text. Examples of substrings are the following, but not limited to: emails, URIs, magnets links, ipv4, ipv6 addresses, etc."
13
+ spec.description = "Extract specific substrings from a block of text"
14
14
  spec.homepage = "http://krmbzds.github.io/qf"
15
15
 
16
16
  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: qf
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kerem Bozdas
@@ -54,9 +54,7 @@ dependencies:
54
54
  - - "~>"
55
55
  - !ruby/object:Gem::Version
56
56
  version: '3.0'
57
- description: 'qf is a ruby gem that extracts specific substrings from a block of text.
58
- Examples of substrings are the following, but not limited to: emails, URIs, magnets
59
- links, ipv4, ipv6 addresses, etc.'
57
+ description: Extract specific substrings from a block of text
60
58
  email:
61
59
  - krmbzds.github@gmail.com
62
60
  - besirkurtulmus@gmail.com