pipewrench 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb3fe83f805ee02ecc16847b508fe05c4acd54e1
-  data.tar.gz: bbc7fb1bf620f6b61fe814969310d526a6fba47d
+  metadata.gz: 2f2152e145d0f7941faa0049ffe67a330d45d0e1
+  data.tar.gz: c7121bf392717c30ebab9fadb44bc7293dfb0bf1
 SHA512:
-  metadata.gz: 497ee217ed9c1101babba0749a4a0252a914cb2fbd1e71f1756faf233ecb240fe0cff4d13115fdcd47944683107cd01d6eb1a4c328cfc731b914834756a5994c
-  data.tar.gz: 085218714ba6d0365c83c5b065efee4377ce5c198bd784eef263f660994ebaf0e60002da8e29ff41cd42372a4c316ed8e1d3b00c5454b81863988b89301826a1
+  metadata.gz: 5e7b7455d135f7e0bef841362d5f791812f48e75f4fd4e7660ac0083658cad202f76639ddafad9f0ce3ef51cf6f0b5ba767223343f3a179813f0088e7eab4d85
+  data.tar.gz: 929b38bd8f5145910e4323a3faf4d0f9441d2bf765b0896865b876233d3688fa7b10e37593b3fb2d6155a6f9783b31990356f6acb03b1c655a87018616592681

data/README.md

@@ -8,7 +8,70 @@ General purpose command line pipe processing tool.
 
 ## Usage
 
-*Coming soon...*
+```
+Usage: pipewrench [options] expression
+    -c, --compact                    Remove nil lines from output
+    -m, --map                        Run each line through the expression
+    -s, --strip                      Strip trailing whitespace from each line before running
+    -h, --help                       Show this message
+        --version                    Show version
+```
+
+Pipewrench evaluates the given expression against standard input.
+This allows you to write powerful ruby expressions as part of your pipeline.
+
+Here are some examples:
+
+```
+# Given a list of integers, add them up
+$ seq 1 10 | pipewrench 'map(&:to_i).inject(:+)'
+55
+
+# Extract regex from matching lines
+$ echo "My Cat" >> pipewrench.txt
+$ echo "His Dog" >> pipewrench.txt
+$ echo "Her Fish" >> pipewrench.txt
+$ echo "My Frog" >> pipewrench.txt
+$ cat pipewrench.txt | pipewrench 'grep(/^My (\w+)/) {$1}'
+Cat
+Frog
+```
+
+### -m, --map
+
+Evaluate the expression for each line of input.
+
+```
+# Convert input to upper case
+$ cat pipewrench.txt | pipewrench -m upcase
+MY CAT
+HIS DOG
+HER FISH
+MY FROG
+```
+
+### -c, --compact
+
+Remove nils from the output. This is primarily useful in conjunction with `--map` but can be used on its own as well.
+
+```
+# Only show lines less than 5
+$ seq 1 10 | pipewrench -c -m 'self if to_i < 5'
+1
+2
+3
+4
+```
+
+### -s, --strip
+
+Remove trailing whitespace from each line before evaluating the expression.
+
+```
+# Join a list of numbers as a comma separated list
+$ seq 1 10 | pipewrench -s 'join(", ")'
+1, 2, 3, 4, 5, 6, 7, 8, 9, 10
+```
 
 ## Development
 

data/exe/pipewrench

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 require "pipewrench"
 
-puts Pipewrench::Shell.new($stdin).run(ARGV.join(" "))
+options = Pipewrench::Options.new.parse!
+puts Pipewrench.new($stdin, options).run(ARGV.join(" ")) || []

data/lib/pipewrench.rb

@@ -1,18 +1,35 @@
 require "pipewrench/version"
+require "pipewrench/options"
 
-module Pipewrench
-  class Shell
-    include Enumerable
+class Pipewrench
+  attr_reader :options
+  include Enumerable
 
-    def initialize(stdin)
-      @stdin = stdin
+  def initialize(stdin, options=Options.new)
+    @stdin = stdin
+    @options = options
+  end
+
+  def run(cmd)
+    if options.compact
+      evaluate(cmd).compact
+    else
+      evaluate(cmd)
     end
+  end
 
-    def run(cmd)
-      instance_eval(cmd)
+  def evaluate(cmd)
+    if options.map
+      map { |line| line.instance_eval(cmd) }
+    else
+      to_a.instance_eval(cmd)
     end
+  end
 
-    def each(&blk)
+  def each(&blk)
+    if options.strip
+      @stdin.each_line.map(&:rstrip).map(&blk)
+    else
       @stdin.each_line(&blk)
     end
   end

data/lib/pipewrench/options.rb

@@ -0,0 +1,54 @@
+require "optparse"
+require "pipewrench/version"
+
+class Pipewrench
+  class Options
+    attr_reader :map, :strip, :compact
+
+    def parse!(*args)
+      parser.parse!(*args)
+      self
+    rescue OptionParser::InvalidOption => e
+      puts e
+      help
+    end
+
+    def to_s
+      parser.to_s
+    end
+
+    def help
+      puts self
+      exit
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: pipewrench [options] expression"
+
+        opts.on("-c", "--compact", "Remove nil lines from output") do |m|
+          @compact = true
+        end
+
+        opts.on("-m", "--map", "Run each line through the expression") do |m|
+          @map = true
+        end
+
+        opts.on("-s", "--strip", "Strip trailing whitespace from each line before running") do |m|
+          @strip = true
+        end
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          help
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts "Pipewrench #{Pipewrench::VERSION}"
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/pipewrench/version.rb

@@ -1,3 +1,3 @@
-module Pipewrench
-  VERSION = "0.1.0"
+class Pipewrench
+  VERSION = "0.2.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: pipewrench
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Olive
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
 - !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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -60,9 +60,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -70,6 +70,7 @@ files:
 - bin/setup
 - exe/pipewrench
 - lib/pipewrench.rb
+- lib/pipewrench/options.rb
 - lib/pipewrench/version.rb
 - pipewrench.gemspec
 homepage: https://github.com/sionide21/pipewrench
@@ -81,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: General purpose command line pipe processing tool.