ru 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d87a8521fa49c32d596d3ce2262e4290d6bcd59
-  data.tar.gz: 35e812eb5e9d7f9363eee79f6db24534aa8de4bd
+  metadata.gz: 8a3f2a29229d4d84159e1fc9a1ec135a2cb00a93
+  data.tar.gz: a6559f3dc45dc3cae09776036adffb04ea48677a
 SHA512:
-  metadata.gz: 65186bcdf73bdd0dbc649ea53deed817d6f9eea00cef20698095289b17d6ee4fdf85f5544d6be40cc9ec355843fbf3c2551269b52ce32028592fa199b0e8c17d
-  data.tar.gz: a4f3e8b3e722d3533a76ffdd8651c92c2080354d697327573311487462fa6d1738d710cbfb61362113427f6f5241065a3db823823e41aa12066d9157f26d20d5
+  metadata.gz: ca1b9747691d20c5cfe6af9167f8923f72dffe3e6cd79da88fb92c3a13f5eef8cd477e3eb9be34e700e39791a4ef9bdbd2f17da66d64030b1e6a7a51cd0b0ae7
+  data.tar.gz: 17dcc47340dfb7d84c5447f47816903d60901bf874e00d30a76658434e58c0d16267e0acd0a9bd74521aa3139509ca2fd77c03a59fabf0cc38aa9b2e99dede29

data/README.md

@@ -4,6 +4,8 @@ Ruby in your shell!
 
 <img src="https://raw.github.com/tombenner/ru/master/doc/logo.png" />
 
+[<img src="https://secure.travis-ci.org/tombenner/ru.png" />](http://travis-ci.org/tombenner/ru)
+
 Overview
 --------
 
@@ -33,7 +35,7 @@ ru 'map(:to_i).sum' myfile
 awk '{s+=$1} END {print s}' myfile
 ```
 
-Any method from Ruby Core and Active Support can be used. Ru also provides some new methods to make transformations easier. Here are some variations on the above example:
+Any method from Ruby Core and Active Support can be used. Ru also provides new methods to make transformations easier. Here are some variations on the above example:
 
 ```bash
 ru 'map(:to_i, 10).sum' myfile
@@ -92,6 +94,8 @@ $ ru '! 2 + 3'
 5
 ```
 
+The code argument is run as if it has `$stdin.each_line.map(&:chomp).` prepended to it. The result is converted to a string and printed. So, if you run `ru 'map(&:to_i).sum'`, you can think of it as running `puts $stdin.each_line.map(&:chomp).map(&:to_i).sum`.
+
 In addition to the methods provided by Ruby Core and Active Support, Ru provides other methods for performing transformations, like `each_line`, `files`, and `grep`. See [Methods](#methods) for more.
 
 Examples
@@ -266,7 +270,7 @@ The [`files`](#files) method returns an enumerable of `Ru::File`s, which are sim
 Testing
 -------
 
-Nested Hstore is tested against ActiveRecord 3 and 4. If you'd like to submit a PR, please be sure to use [Appraisal](https://github.com/thoughtbot/appraisal) to test your changes in both contexts:
+Ru is tested against Active Support 3 and 4. If you'd like to submit a PR, please be sure to use [Appraisal](https://github.com/thoughtbot/appraisal) to test your changes in both contexts:
 
 ```bash
 appraisal rspec

data/bin/ru

@@ -9,8 +9,8 @@ begin
   # If the command starts with a '!', run it without stdin
   if command.present? && command.start_with?('! ')
     command = command[2..-1]
-  # If args is empty, read from stdin
-  elsif args.empty?
+  # If args is empty and an option (e.g. -h, --help, -v, --version) isn't present, read from stdin
+  elsif args.empty? && !command.try(:start_with?, '-')
     stdin = STDIN.read
   end
   process = Ru::Process.new({

data/doc/help.erb

@@ -0,0 +1,33 @@
+Ru (version <%= version %>)
+Ruby in your shell!
+
+Ru brings Ruby's expressiveness, cleanliness, and readability to the command line. It lets you avoid looking up pesky options in man pages and Googling how to write a transformation in bash that would take you approximately 1s to write in Ruby.
+
+For example, to center a file's lines, use String#center:
+ru 'map(:center, 80)' myfile
+
+To sum the lines of a list of integers:
+ru 'map(:to_i).sum' myfile
+
+Ru reads from stdin:
+$ echo "2\n3" | ru 'map(:to_i).sum'
+5
+$ cat myfile | ru 'map(:to_i).sum'
+5
+
+Or from file(s):
+$ ru 'map(:to_i).sum' myfile
+5
+$ ru 'map(:to_i).sum' myfile myfile
+10
+
+You can also run Ruby code without any input by prepending a `! `:
+$ ru '! 2 + 3'
+5
+
+The code argument is run as if it has `$stdin.each_line.map(&:chomp).` prepended to it. The result is converted to a string and printed. So, if you run `ru 'map(:to_i).sum'`, you can think of it as `puts $stdin.each_line.map(&:chomp).map(:to_i).sum`.
+
+In addition to the methods provided by Ruby Core and Active Support, Ru provides other methods for performing transformations, like `each_line`, `files`, and `grep`.
+
+To read more, see the README:
+https://github.com/tombenner/ru

data/gemfiles/activesupport_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    ru (0.0.1)
+    ru (0.0.3)
       activesupport
 
 GEM

data/gemfiles/activesupport_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    ru (0.0.1)
+    ru (0.0.3)
       activesupport
 
 GEM

data/lib/ru/options.rb

@@ -0,0 +1,36 @@
+require 'erb'
+
+# TODO: If more options are added, we should use OptionParser
+module Ru
+  class Options
+    def exists?(option_key)
+      options[option_key].present?
+    end
+
+    def run(option_key, option_value=nil)
+      send(options[option_key], *option_value)
+    end
+
+    private
+
+    def options
+      {
+        '-h' => :get_help,
+        '--help' => :get_help,
+        '-v' => :get_version,
+        '--version' => :get_version
+      }
+    end
+
+    def get_help
+      namespace = OpenStruct.new(version: Ru::VERSION)
+      template_path = ::File.expand_path("../../../doc/help.erb", __FILE__)
+      template = ::File.open(template_path).read
+      ERB.new(template).result(namespace.instance_eval { binding })
+    end
+
+    def get_version
+      Ru::VERSION
+    end
+  end
+end

data/lib/ru/process.rb

@@ -7,9 +7,17 @@ module Ru
       if @command.kind_of?(String) && @command.start_with?('[')
         @command = 'to_stdout' + @command
       end
+      @options = Options.new
     end
 
     def run
+      if @command.nil?
+        STDERR.puts @options.run('--help')
+        exit 1
+      end
+      if @options.exists?(@command)
+        return @options.run(@command)
+      end
       paths = @args
       if @stdin.blank? && paths.present?
         @stdin = paths.map { |path| ::File.open(path).read }.join("\n")

data/lib/ru/version.rb

@@ -1,3 +1,3 @@
 module Ru
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/lib/process_spec.rb

@@ -63,5 +63,35 @@ describe Ru::Process do
         expect { out = run(lines, 'foo') }.to raise_error(NoMethodError)
       end
     end
+
+    describe "options" do
+      context "-h" do
+        it "shows help" do
+          out = run('', '--help')
+          out.should include('Ruby in your shell!')
+        end
+      end
+
+      context "--help" do
+        it "shows help" do
+          out = run('', '-h')
+          out.should include('Ruby in your shell!')
+        end
+      end
+
+      context "-v" do
+        it "shows the version" do
+          out = run('', '--version')
+          out.should == Ru::VERSION
+        end
+      end
+
+      context "--version" do
+        it "shows the version" do
+          out = run('', '--version')
+          out.should == Ru::VERSION
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ru
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-11 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,6 +68,7 @@ files:
 - README.md
 - Rakefile
 - bin/ru
+- doc/help.erb
 - doc/logo.png
 - gemfiles/activesupport_3.gemfile
 - gemfiles/activesupport_3.gemfile.lock
@@ -77,6 +78,7 @@ files:
 - lib/ru/array.rb
 - lib/ru/file.rb
 - lib/ru/iterator.rb
+- lib/ru/options.rb
 - lib/ru/process.rb
 - lib/ru/version.rb
 - ru.gemspec