ru 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a3f2a29229d4d84159e1fc9a1ec135a2cb00a93
-  data.tar.gz: a6559f3dc45dc3cae09776036adffb04ea48677a
+  metadata.gz: 92351cd0d4f9df90afa8ea60e92f6abc6470c90e
+  data.tar.gz: 38256d881838535af9e122f2cdb270760c4ffca3
 SHA512:
-  metadata.gz: ca1b9747691d20c5cfe6af9167f8923f72dffe3e6cd79da88fb92c3a13f5eef8cd477e3eb9be34e700e39791a4ef9bdbd2f17da66d64030b1e6a7a51cd0b0ae7
-  data.tar.gz: 17dcc47340dfb7d84c5447f47816903d60901bf874e00d30a76658434e58c0d16267e0acd0a9bd74521aa3139509ca2fd77c03a59fabf0cc38aa9b2e99dede29
+  metadata.gz: 812326331d26647a18e8e9ce823f1b30bdd6a60eb91fa2940b4c07eaea916626e1562a65adfdde2fb380bd8549eabbfec7e444071861f30e91d5ac2a16184fe6
+  data.tar.gz: 950c4e17a04764fbc845b04390cd7cfbe1a52855ef1569f0bdf90430ffa6e91910cb60df8c236e464672f4ef1fcf9334f2ad3145dd4bafa6e275af9d771e48f8

data/README.md

@@ -98,6 +98,34 @@ The code argument is run as if it has `$stdin.each_line.map(&:chomp).` prepended
 
 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.
 
+### Saving commands
+
+You can save commands for future use using `save`:
+
+```bash
+$ ru save sum 'map(:to_i).sum'
+Saved command: sum is 'map(:to_i).sum'
+```
+
+And run them later using `run`:
+
+```bash
+$ echo "2\n3" | ru run sum
+5
+$ ru run sum myfile
+5
+```
+
+### Options
+
+#### -h, --help
+
+Print a help page.
+
+#### -v, --version
+
+Print the installed version of Ru.
+
 Examples
 --------
 

data/bin/ru

@@ -3,21 +3,7 @@
 require_relative '../lib/ru'
 
 begin
-  args = ARGV
-  command = args.shift
-  stdin = nil
-  # If the command starts with a '!', run it without stdin
-  if command.present? && command.start_with?('! ')
-    command = command[2..-1]
-  # 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({
-    command: command,
-    args: args,
-    stdin: stdin
-  })
+  process = Ru::Process.new
   puts process.run
 rescue => e
   STDERR.puts e.message

data/gemfiles/activesupport_3.gemfile.lock

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

data/gemfiles/activesupport_4.gemfile.lock

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

data/lib/ru/command_manager.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+
+module Ru
+  class CommandManager
+    class InvalidCodeError < ArgumentError; end
+    class InvalidNameError < ArgumentError; end
+
+    def save(name, code)
+      raise InvalidCodeError.new("Invalid code. Code cannot be blank.") if code.blank?
+      validate_name(name)
+      commands = get_commands
+      commands[name] = code
+      save_commands(commands)
+    end
+
+    def get(name)
+      validate_name(name)
+      commands = get_commands
+      commands[name]
+    end
+
+    private
+
+    def save_commands(commands)
+      lines = []
+      commands.each do |name, code|
+        lines << "#{name},#{code}"
+      end
+      content = lines.join("\n")
+      ::File.open(path, 'w') { |file| file.write(content) }
+    end
+
+    def get_commands
+      if ::File.exists?(path)
+        commands = {}
+        ::File.readlines(path).each do |line|
+          pieces = line.chomp.split(',', 2)
+          commands[pieces[0]] = pieces[1]
+        end
+        commands
+      else
+        {}
+      end
+    end
+
+    def validate_name(name)
+      if name !~ /^[\w_]+$/
+        raise InvalidNameError.new("Invalid command name '#{name}'. Command names may only contain alphanumerics and underscores.")
+      end
+    end
+
+    def path
+      Pathname.new(::File.expand_path('~')).join('.ru_commands')
+    end
+  end
+end

data/lib/ru/{options.rb → option_printer.rb}

@@ -1,8 +1,7 @@
 require 'erb'
 
-# TODO: If more options are added, we should use OptionParser
 module Ru
-  class Options
+  class OptionPrinter
     def exists?(option_key)
       options[option_key].present?
     end
@@ -15,10 +14,8 @@ module Ru
 
     def options
       {
-        '-h' => :get_help,
-        '--help' => :get_help,
-        '-v' => :get_version,
-        '--version' => :get_version
+        help: :get_help,
+        version: :get_version
       }
     end
 

data/lib/ru/process.rb

@@ -1,30 +1,64 @@
+require 'optparse'
+
 module Ru
   class Process
     def initialize(options={})
-      @command = options[:command]
-      @args = options[:args]
-      @stdin = options[:stdin]
-      if @command.kind_of?(String) && @command.start_with?('[')
-        @command = 'to_stdout' + @command
-      end
-      @options = Options.new
+      @command_manager = CommandManager.new
+      @option_printer = OptionPrinter.new
     end
 
     def run
-      if @command.nil?
-        STDERR.puts @options.run('--help')
+      output = process_options
+      return output if output
+
+      args = ARGV
+      first_arg = args.shift
+
+      if first_arg == 'save'
+        name = args[0]
+        code = args[1]
+        @command_manager.save(name, code)
+        return "Saved command: #{name} is '#{code}'"
+      elsif first_arg == 'run'
+        name = args.shift
+        @code = @command_manager.get(name)
+        if @code.blank?
+          STDERR.puts "Unable to find command '#{name}'"
+          exit 1
+          return
+        end
+      elsif first_arg.blank?
+        STDERR.puts @option_printer.run(:help)
         exit 1
+        return
+      else
+        @code = first_arg
       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")
-      end
+
+      @stdin = get_stdin(args) unless @code.start_with?('! ')
+      @code = prepare_code(@code) if @code
+
       lines = @stdin.present? ? @stdin.split("\n") : []
       array = Ru::Array.new(lines)
-      output = array.instance_eval(@command) || @stdin
+      output = array.instance_eval(@code) || @stdin
+      output = prepare_output(output)
+      output
+    end
+
+    private
+
+    def prepare_code(code)
+      if code.kind_of?(String)
+        if code.start_with?('[')
+          code = 'to_stdout' + code
+        elsif code.start_with?('! ')
+          code = code[2..-1]
+        end
+      end
+      code
+    end
+
+    def prepare_output(output)
       if output.respond_to?(:to_dotsch_output)
         output = output.to_dotsch_output
       end
@@ -33,5 +67,38 @@ module Ru
       end
       output.to_s
     end
+
+    def process_options
+      @options = get_options
+      @options.each do |option, value|
+        if @option_printer.exists?(option)
+          return @option_printer.run(option)
+        end
+      end
+      nil
+    end
+
+    def get_options
+      options = {}
+      OptionParser.new do |opts|
+        opts.on("-h", "--help", "Print help") do |help|
+          options[:help] = true
+        end
+
+        opts.on("-v", "--version", "Print version") do |version|
+          options[:version] = true
+        end
+      end.parse!
+      options
+    end
+
+    def get_stdin(args)
+      paths = args
+      if paths.present?
+        paths.map { |path| ::File.open(path).read }.join("\n")
+      else
+        STDIN.read
+      end
+    end
   end
 end

data/lib/ru/version.rb

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

data/spec/examples/misc_examples_spec.rb

@@ -8,7 +8,7 @@ describe 'misc examples' do
   context "summing integers" do
     it "sums" do
       lines = (1..10).to_a.map(&:to_s)
-      out = run(lines, 'map(:to_i).sum')
+      out = run('map(:to_i).sum', lines)
       out.should == '55'
     end
   end
@@ -17,7 +17,7 @@ describe 'misc examples' do
   context "printing the nth line" do
     it "prints" do
       lines = (1..10).to_a.map(&:to_s)
-      out = run(lines, '[4]')
+      out = run('[4]', lines)
       out.should == '5'
     end
   end
@@ -26,7 +26,7 @@ describe 'misc examples' do
   context "sorting an Apache access log by response time" do
     it "sorts" do
       file = fixture_path('files', 'access.log')
-      out = run('', 'map { |line| [line[/(\d+)( ".+"){2}$/, 1].to_i, line] }.sort.reverse.map(:join, " ")', file)
+      out = run(['map { |line| [line[/(\d+)( ".+"){2}$/, 1].to_i, line] }.sort.reverse.map(:join, " ")', file])
       out.should == <<-EOF.strip
 584912 66.249.64.14 - - [18/Sep/2004:11:07:48 +1000] "GET /file.txt HTTP/1.0" 200 584912 "-" "Googlebot/2.1"
 6433 66.249.64.14 - - [18/Sep/2004:11:07:48 +1000] "GET / HTTP/1.0" 200 6433 "-" "Googlebot/2.1"

data/spec/examples/sed_examples_spec.rb

@@ -8,7 +8,7 @@ describe 'sed examples' do
   context "centering lines" do
     it "centers" do
       lines = %w{john paul george} + ['             ringo      ']
-      out = run(lines, 'each_line.strip.center(10)')
+      out = run('each_line.strip.center(10)', lines)
       out.should == "   john   \n   paul   \n  george  \n  ringo   "
     end
   end
@@ -16,7 +16,7 @@ describe 'sed examples' do
   context "increment a number" do
     it "increments" do
       lines = ('5'..'10').to_a
-      out = run(lines, '(each_line.to_i+1)')
+      out = run('(each_line.to_i+1)', lines)
       out.should == ('6'..'11').to_a.join("\n")
     end
   end
@@ -24,7 +24,7 @@ describe 'sed examples' do
   context "reverse characters of lines" do
     it "reverses" do
       lines = %w{john paul george ringo}
-      out = run(lines, 'each_line.reverse')
+      out = run('each_line.reverse', lines)
       out.should == "nhoj\nluap\negroeg\nognir"
     end
   end
@@ -32,7 +32,7 @@ describe 'sed examples' do
   context "numbering lines" do
     it "numbers" do
       lines = %w{john paul george ringo}
-      out = run(lines, 'map.with_index { |line, index| "#{(index+1).to_s.rjust(6)}  #{line}" }')
+      out = run('map.with_index { |line, index| "#{(index+1).to_s.rjust(6)}  #{line}" }', lines)
       out.should == "     1  john\n     2  paul\n     3  george\n     4  ringo"
     end
   end
@@ -40,7 +40,7 @@ describe 'sed examples' do
   context "counting lines" do
     it "counts" do
       lines = %w{john paul george ringo}
-      out = run(lines, 'length')
+      out = run('length', lines)
       out.should == "4"
     end
   end
@@ -48,7 +48,7 @@ describe 'sed examples' do
   context "printing the first lines" do
     it "prints" do
       lines = %w{john paul george ringo}
-      out = run(lines, '[0,2]')
+      out = run('[0,2]', lines)
       out.should == "john\npaul"
     end
   end
@@ -56,7 +56,7 @@ describe 'sed examples' do
   context "printing the last lines" do
     it "prints" do
       lines = %w{john paul george ringo}
-      out = run(lines, '[2..-1]')
+      out = run('[2..-1]', lines)
       out.should == "george\nringo"
     end
   end
@@ -64,7 +64,7 @@ describe 'sed examples' do
   context "make duplicate lines unique" do
     it "dedupes" do
       lines = %w{john john paul george george george ringo}
-      out = run(lines, 'uniq')
+      out = run('uniq', lines)
       out.should == "john\npaul\ngeorge\nringo"
     end
   end
@@ -72,7 +72,7 @@ describe 'sed examples' do
   context "print duplicated lines of input" do
     it "prints" do
       lines = %w{john john paul george george george ringo}
-      out = run(lines, 'select { |line| self.count(line) > 1 }')
+      out = run('select { |line| self.count(line) > 1 }', lines)
       out.should == "john\njohn\ngeorge\ngeorge\ngeorge"
     end
   end
@@ -80,7 +80,7 @@ describe 'sed examples' do
   context "remove all duplicated lines" do
     it "removes" do
       lines = %w{john john paul george george george ringo}
-      out = run(lines, 'select { |line| self.count(line) == 1 }')
+      out = run('select { |line| self.count(line) == 1 }', lines)
       out.should == "paul\nringo"
     end
   end
@@ -88,7 +88,7 @@ describe 'sed examples' do
   context "squeezing blank lines" do
     it "squeezes" do
       lines = "john\n\npaul\ngeorge\n\n\nringo"
-      out = run(lines, 'to_s.squeeze("\n")')
+      out = run('to_s.squeeze("\n")', lines)
       out.should == "john\npaul\ngeorge\nringo"
     end
   end

data/spec/lib/process_spec.rb

@@ -7,7 +7,7 @@ describe Ru::Process do
   describe "#run" do
     it "runs []" do
       lines = %w{john paul george ringo}
-      out = run(lines, '[1,2]')
+      out = run('[1,2]', lines)
       out.should == "paul\ngeorge"
     end
 
@@ -16,7 +16,7 @@ describe Ru::Process do
         fixture_path('files', 'bar.txt'),
         fixture_path('files', 'foo.txt')
       ]
-      out = run(paths, 'files')
+      out = run('files', paths)
       out.should == "bar.txt\nfoo.txt"
     end
 
@@ -25,7 +25,7 @@ describe Ru::Process do
         fixture_path('files', 'bar.txt'),
         fixture_path('files', 'foo.txt')
       ]
-      out = run(paths, "files.format('l')")
+      out = run("files.format('l')", paths)
       lines = out.split("\n")
       lines.length.should == 2
       lines.each do |line|
@@ -36,59 +36,123 @@ describe Ru::Process do
 
     it "runs grep" do
       lines = %w{john paul george ringo}
-      out = run(lines, "grep(/o[h|r]/)")
+      out = run("grep(/o[h|r]/)", lines)
       out.should == "john\ngeorge"
     end
 
     it "runs map with two arguments" do
       lines = %w{john paul george ringo}
-      out = run(lines, 'map(:[], 0)')
+      out = run('map(:[], 0)', lines)
       out.should == %w{j p g r}.join("\n")
     end
 
     it "runs sort" do
       lines = %w{john paul george ringo}
-      out = run(lines, 'sort')
+      out = run('sort', lines)
       out.should == lines.sort.join("\n")
     end
 
     it "takes files as arguments" do
-      out = run('', 'to_s', fixture_path('files', 'foo.txt'))
+      out = run(['to_s', fixture_path('files', 'foo.txt')])
       out.should == "foo\nfoo\nfoo"
     end
 
+    it "runs code prepended by '! '" do
+      out = run('! 2 + 3')
+      out.should == '5'
+    end
+
+    context "no arguments" do
+      it "prints help" do
+        STDERR.should_receive(:puts) do |out|
+          out.should include('Ruby in your shell!')
+        end
+        Ru::Process.any_instance.should_receive(:exit).with(1)
+        run('')
+      end
+    end
+
     context "an undefined method" do
       it "raises a NoMethodError" do
         lines = %w{john paul george ringo}
-        expect { out = run(lines, 'foo') }.to raise_error(NoMethodError)
+        expect { out = run('foo', lines) }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "command management" do
+      describe "run" do
+        it "runs the command" do
+          Ru::CommandManager.any_instance.stub(:get_commands).and_return({ 'sum' => 'map(:to_i).sum' })
+          out = run(['run', 'sum'], "2\n3")
+          out.should == '5'
+        end
+
+        context "no command name" do
+          it "raises an InvalidNameError" do
+            expect { run(['run']) }.to raise_error(Ru::CommandManager::InvalidNameError)
+          end
+        end
+      end
+
+      describe "save" do
+        it "saves the command" do
+          Ru::CommandManager.any_instance.should_receive(:save_commands)
+          run(['save', 'foo', 'map(:to_i).sum'])
+        end
+
+        context "no code" do
+          it "raises an InvalidCodeError" do
+            expect { run(['save', 'foo']) }.to raise_error(Ru::CommandManager::InvalidCodeError)
+          end
+        end
+
+        context "invalid command name" do
+          it "raises an InvalidNameError" do
+            expect { run(['save', 'foo-bar', 'map(:to_i).sum']) }.to raise_error(Ru::CommandManager::InvalidNameError)
+          end
+        end
       end
     end
 
     describe "options" do
       context "-h" do
         it "shows help" do
-          out = run('', '--help')
+          out = run('--help')
           out.should include('Ruby in your shell!')
         end
       end
 
       context "--help" do
         it "shows help" do
-          out = run('', '-h')
+          out = run('-h')
+          out.should include('Ruby in your shell!')
+        end
+      end
+
+      context "help with a second argument" do
+        it "shows help" do
+          out = run(['--help', 'foo'])
           out.should include('Ruby in your shell!')
         end
       end
 
       context "-v" do
         it "shows the version" do
-          out = run('', '--version')
+          out = run('-v')
           out.should == Ru::VERSION
         end
       end
 
       context "--version" do
         it "shows the version" do
-          out = run('', '--version')
+          out = run('--version')
+          out.should == Ru::VERSION
+        end
+      end
+
+      context "version with a second argument" do
+        it "shows the version" do
+          out = run(['--version', 'foo'])
           out.should == Ru::VERSION
         end
       end

data/spec/support/fixtures_helper.rb

@@ -1,6 +1,6 @@
 module FixturesHelper
   def fixture_path(*args)
     directory = Pathname.new(File.dirname(File.absolute_path(__FILE__)))
-    directory.join('..', 'fixtures', *args)
+    directory.join('..', 'fixtures', *args).to_s
   end
 end

data/spec/support/process_helper.rb

@@ -1,14 +1,18 @@
 module ProcessHelper
-  def run(stdin, *args)
+  def run(args, stdin=nil)
+    if args.kind_of?(String)
+      args = [args]
+    end
+    stub_const('ARGV', args)
+
     if stdin.kind_of?(Array)
       stdin = stdin.join("\n")
     end
-    command = args.shift
-    process = Ru::Process.new({
-      command: command,
-      args: args,
-      stdin: stdin
-    })
+    stdin_double = double
+    stdin_double.stub(:read).and_return(stdin)
+    stub_const('STDIN', stdin_double)
+
+    process = Ru::Process.new
     process.run
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ru
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Tom Benner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,9 +76,10 @@ files:
 - gemfiles/activesupport_4.gemfile.lock
 - lib/ru.rb
 - lib/ru/array.rb
+- lib/ru/command_manager.rb
 - lib/ru/file.rb
 - lib/ru/iterator.rb
-- lib/ru/options.rb
+- lib/ru/option_printer.rb
 - lib/ru/process.rb
 - lib/ru/version.rb
 - ru.gemspec