act 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3936088dcf64820eb627fd2a7e4fbe3640dc9782
-  data.tar.gz: bc4c3220f8e74657df4246d715e63027f3a62313
+  metadata.gz: 684ed5ccb021e0950d357fa0157cdb631d1852ad
+  data.tar.gz: d1fc364445937bb80789188bb88b6119af63da22
 SHA512:
-  metadata.gz: 045fdafee182130af6c785b992b08677b317c66cf03fa9cd561ed8c76e2d7a907d080e0e3dcf5ccac729d7b26c7261832d8a14023d3e557ce711831d9acc5595
-  data.tar.gz: 237036db380d5e761742c5be30b41daa8a598d6581d47f26370326b072604bcf345f97a77fc21981c22639bd0de2707b8a716166e3cf9690e944e749dc4c05cc
+  metadata.gz: 2077bc99056dcbbc185fa82aee2eb87f5bcd744fd9fbe0e5de4ba4653f36bd85b9fca8d92ad471b23ee6c722823e5d0595a045724269fb5de2a122895f938be9
+  data.tar.gz: 86b85a404e763e410fb3a3a8c333b150a008fc1b7e822264d18e80c91dca2b885986ee3c715ac5a1d71f423f59547ad3164dd5c7a125c35c28bb1403167634c5

data/.kick

@@ -0,0 +1,30 @@
+recipe :ruby
+
+Kicker::Recipes::Ruby.runner_bin = 'bacon --quiet'
+
+process do |files|
+  specs = files.take_and_map do |file|
+    if file =~ %r{lib/cocoapods-core/(.+?)\.rb$}
+      s = Dir.glob("spec/**/#{File.basename(file, '.rb')}_spec.rb")
+      s.uniq unless s.empty?
+    end
+  end
+  Kicker::Recipes::Ruby.run_tests(specs)
+end
+
+# Have written this so many times, probably should make a recipe out of it.
+process do |files|
+  files.each do |file|
+    case file
+    when 'Gemfile'
+      files.delete(file)
+      execute 'bundle install'
+    end
+  end
+end
+
+recipe :ignore
+ignore(/.*\/?tags/)
+ignore(/.*\/?\.git/)
+ignore(/^tmp/)
+

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+bundler_args: --without debugging
+rvm:
+  - 2.0.0
+
+install: NOEXEC=skip rake bootstrap
+script: bundle exec rake spec

data/Gemfile

@@ -1,4 +1,15 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in act.gemspec
 gemspec
+
+group :development do
+  gem "bacon"
+  gem "mocha-on-bacon"
+  gem 'prettybacon'
+  gem 'rubocop'
+end
+
+group :debugging do
+  gem "kicker"
+end
+

data/README.md

@@ -1,29 +1,106 @@
 # Act
+[![Build Status](https://travis-ci.org/irrationalfab/act.svg?branch=master)](https://travis-ci.org/irrationalfab/act)
 
-TODO: Write a gem description
+Allows to act on files from the command line efficiently... `cat` for the twenty first century!
 
-## Installation
+<img src="http://cl.ly/image/0A2p320r442D/Image%202014-04-04%20at%202.59.18%20pm.png" height="50%" width="50%">
 
-Add this line to your application's Gemfile:
+### Features
 
-    gem 'act'
+- Flexible input handling
+  - Support for colon syntax
+  - Support for GitHub like URLs
+- Automatic syntax highlighting based on the file extension (via [Pygments](http://pygments.org))
+- Fast enoguht for the task
 
-And then execute:
+## Installation
 
-    $ bundle
+```console
+$ [sudo] gem install act
+$ [sudo] easy_install Pygments #optional
+```
 
-Or install it yourself as:
+## Help needed
 
-    $ gem install act
+Follow [@fabiopelosin](https://twitter.com/fabiopelosin) to help me beat [@orta](https://twitter.com/orta) in followers count.
 
 ## Usage
 
-TODO: Write usage instructions here
+Print a complete file:
+
+```console
+$ act lib/act/command.rb
+
+0    require 'colored'
+1    require 'claide'
+2    require 'active_support/core_ext/string/strip'
+[...]
+```
+
+Print the line 10 with the default context (5 lines):
+
+```console
+$ act lib/act/command.rb:10
+
+5    module Act
+6      class Command < CLAide::Command
+7
+8        self.command = 'act'
+9        self.description = 'Act the command line tool to act on files'
+10
+11       def self.options
+12         [
+13           ['--open', "Open the file in $EDITOR instead of printing it"],
+14           ['--no-line-numbers', "Show output without line numbers"],
+15           ['--version', 'Show the version of Act'],
+
+```
+
+Open in `$EDITOR` the file at the given line:
+
+```console
+$ act lib/act/command.rb:10 --open
+```
+
+Print from line 8 to line 12:
+
+```console
+$ act lib/act/command.rb:8-12
+
+8    self.command = 'act'
+9    self.description = 'Act the command line tool to act on files'
+10
+11   def self.options
+12     [
+
+```
+
+Print from line 10 with 2 lines of context:
+
+```console
+$ act lib/act/command.rb:10+2
+
+8    self.command = 'act'
+9    self.description = 'Act the command line tool to act on files'
+10
+11   def self.options
+12     [
+
+```
+
+Show ./lib/act/command.rb from line 8 to line 9:
+
+```console
+$ act https://github.com/irrationalfab/act/blob/master/lib/act/command.rb\#L8-L9
+
+8    self.command = 'act'
+9    self.description = 'Act the command line tool to act on files'
+
+```
+
+Open `$EDITOR` ./lib/act/command.rb at line 8:
 
-## Contributing
+```console
+$ act https://github.com/irrationalfab/act/blob/master/lib/act/command.rb\#L8-L9
+```
 
-1. Fork it ( https://github.com/[my-github-username]/act/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,62 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+Rake::Task[:release].enhance [:spec]
+
+# Bootstrap
+#-----------------------------------------------------------------------------#
+
+desc 'Initializes your working copy to run the specs'
+task :bootstrap do
+  sh "bundle install"
+end
+
+# Spec
+#-----------------------------------------------------------------------------#
+
+desc 'Run all specs'
+task :spec => 'spec:all'
+
+namespace :spec do
+  def specs(dir)
+    FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+  end
+
+  desc 'Automatically run specs for updated files'
+  task :kick do
+    exec 'bundle exec kicker -c'
+  end
+
+  task :all do
+    title 'Running Unit Tests'
+    sh "bundle exec bacon #{specs('**')}"
+
+    # title 'Checking code style...'
+    # Rake::Task['rubocop'].invoke
+  end
+end
+
+# Rubocop
+#-----------------------------------------------------------------------------#
+
+desc 'Checks code style'
+task :rubocop do
+  require 'rubocop'
+  cli = Rubocop::CLI.new
+  result = cli.run(FileList['lib/**/*.rb'].exclude('lib/cocoapods-core/vendor/**/*').to_a)
+  abort('RuboCop failed!') unless result == 0
+end
+
+#-----------------------------------------------------------------------------#
+
+def title(title)
+  cyan_title = "\033[0;36m#{title}\033[0m"
+  puts
+  puts '-' * 80
+  puts cyan_title
+  puts '-' * 80
+  puts
+end
+
 

data/act.gemspec

@@ -8,9 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Act::VERSION
   spec.authors       = ["Fabio Pelosin"]
   spec.email         = ["fabiopelosin@gmail.com"]
-  spec.summary       = %q{Act the command line tool to act on files}
-  # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.summary       = %q{Act the command line tool to act on files.}
+  spec.homepage      = "https://github.com/irrationalfab/act"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -22,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "colored", "~> 1.2"
   spec.add_runtime_dependency "activesupport"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 end

data/bin/act

@@ -2,11 +2,10 @@
 
 if $PROGRAM_NAME == __FILE__ && !ENV['COCOAPODS_NO_BUNDLER']
   ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
-  require "rubygems"
-  require "bundler/setup"
+  require 'rubygems'
+  require 'bundler/setup'
   $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 end
 
-
 require 'act'
 Act::Command.run(ARGV)

data/lib/act.rb

@@ -1,6 +1,9 @@
-require "act/version"
 
 module Act
-  require 'act/helper'
+  require 'act/version'
+  require 'act/argument_parser'
   require 'act/command'
+  require 'act/helper'
+  require 'act/user_interface'
+  require 'pathname'
 end

data/lib/act/argument_parser.rb

@@ -0,0 +1,64 @@
+module Act
+  module ArgumentParser
+    FileInformation = Struct.new(:path, :from_line, :to_line, :highlight_line)
+
+    # @return [FileInformation]
+    #
+    def self.parse_file_information(file, context_lines = nil)
+      if file && file != ''
+        if file =~ /:/
+          components = file.split(':')
+          path = components[0]
+          line = components[1]
+
+          if line
+            if line =~ /^\d+$/
+              highlight_line = line.to_i
+              from_line = highlight_line - context_lines
+              to_line = highlight_line + context_lines
+            elsif line =~ /^\d+-\d+$/
+              line_components = line.split('-')
+              from_line = line_components[0].to_i
+              to_line = line_components[1].to_i
+            elsif line =~ /^\d+\+\d+$/
+              line_components = line.split('+')
+              highlight_line = line_components[0].to_i
+              context = line_components[1].to_i
+              from_line = highlight_line - context
+              to_line = highlight_line + context
+            else
+              UI.warn 'Unable to parse line data'
+            end
+          end
+        elsif file =~ /#/
+          components = file.split('#')
+          path = components[0]
+          line = components[1]
+
+          if line
+            if line =~ /^L\d+$/
+              highlight_line = line[1..-1].to_i
+              from_line = highlight_line - context_lines
+              to_line = highlight_line + context_lines
+            elsif line =~ /^L\d+-L\d+$/
+              line_components = line.split('-')
+              from_line = line_components[0][1..-1].to_i
+              to_line = line_components[1][1..-1].to_i
+            else
+              UI.warn 'Unable to parse line data'
+            end
+          end
+        else
+          path = file
+        end
+
+        result = FileInformation.new
+        result.path = path
+        result.from_line = from_line
+        result.to_line = to_line
+        result.highlight_line = highlight_line
+        result
+      end
+    end
+  end
+end

data/lib/act/command.rb

@@ -4,14 +4,13 @@ require 'active_support/core_ext/string/strip'
 
 module Act
   class Command < CLAide::Command
-
     self.command = 'act'
     self.description = 'Act the command line tool to act on files'
 
     def self.options
       [
-        ['--open', "Open the file in $EDITOR instead of printing it"],
-        ['--no-line-numbers', "Show output without line numbers"],
+        ['--open', 'Open the file in $EDITOR instead of printing it'],
+        ['--no-line-numbers', 'Show output without line numbers'],
         ['--version', 'Show the version of Act'],
       ].concat(super)
     end
@@ -19,7 +18,7 @@ module Act
     def self.run(argv)
       argv = CLAide::ARGV.new(argv)
       if argv.flag?('version')
-        puts VERSION
+        UI.puts VERSION
         exit 0
       end
       super(argv)
@@ -28,47 +27,83 @@ module Act
     def initialize(argv)
       @open = argv.flag?('open')
       @number_lines = argv.flag?('line-numbers', true)
-      @file = argv.shift_argument
+      @file_string = argv.shift_argument
       super
     end
 
     def validate!
       super
-      help! "A file is required." unless @file
+      help! 'A file is required.' unless @file_string
     end
 
+    CONTEXT_LINES = 5
+
     def run
-      file_information = @file.split(':')
-      path = file_information[0]
-      line = file_information[1]
-      context_lines = 5
+      clean_file_string = pre_process_file_string(@file_string)
+      file = ArgumentParser.parse_file_information(clean_file_string, CONTEXT_LINES)
 
-      if @open
-        command = Helper.open_in_editor_command(path, line)
-        system(command)
-      else
-        string = File.read(path) if File.exists?(path)
+      path_exists = File.exist?(file.path)
+      unless path_exists
+        inferred = infer_local_path(file.path)
+        file.path = inferred
+        path_exists = true if inferred
+      end
 
-        if string
-          if line
-            line = line.to_i
-            start_line = Helper.start_line(string, line, context_lines)
-            end_line = Helper.end_line(string, line, context_lines)
-            string = Helper.select_lines(string, start_line, end_line)
-            puts "Showing from line #{start_line} to #{end_line}"
-          end
+      if path_exists
+        if @open
+          open_file(file)
+        else
+          cat_file(file)
+        end
+      else
+        UI.warn '[!] File not found'
+      end
+    end
 
-          string = Helper.strip_indentation(string)
-          string = Helper.syntax_highlith(string, path) if self.ansi_output?
-          string = Helper.add_line_numbers(string, start_line, line) if @number_lines
+    # @return [String]
+    #
+    def pre_process_file_string(string)
+      string.sub(/https?:\/\//, '')
+    end
 
-          puts
-          puts string
-        else
-          puts "[!] File not found"
+    # @return [String, Nil]
+    #
+    def infer_local_path(path)
+      path_components = Pathname(path).each_filename.to_a
+      until path_components.empty?
+        path_components.shift
+        candidate = File.join(path_components)
+        if File.exist?(candidate)
+          return candidate
         end
       end
     end
 
+    # @return [void]
+    #
+    def open_file(file)
+      line = file.highlight_line || file.from_line
+      command = Helper.open_in_editor_command(file.path, line)
+      UI.puts command if self.verbose?
+      system(command)
+    end
+
+    # @return [void]
+    #
+    def cat_file(file)
+      string = File.read(file.path)
+      if file.from_line && file.to_line
+        string = Helper.select_lines(string, file.from_line, file.to_line)
+      end
+
+      if string
+        string = Helper.strip_indentation(string)
+        string = Helper.syntax_highlith(string, file.path) if self.ansi_output?
+        string = Helper.add_line_numbers(string, file.from_line, file.highlight_line) if @number_lines
+        UI.puts "\n#{string}"
+      else
+        UI.warn '[!] Nothing to show'
+      end
+    end
   end
 end

data/lib/act/helper.rb

@@ -4,7 +4,6 @@ require 'open3'
 
 module Act
   module Helper
-
     # @return [String]
     #
     def self.open_in_editor_command(path, line)
@@ -31,10 +30,15 @@ module Act
       end_line = line + context_lines - 1
     end
 
-    # @return [String]
+    # @return [String, Nil]
     #
     def self.select_lines(string, start_line, end_line)
-      string.lines[start_line..end_line].join
+      start_line = start_line - 1
+      end_line = end_line - 1
+      start_line = 0 if start_line < 0
+      end_line = 0 if end_line < 0
+      components = string.lines[start_line..end_line]
+      components.join if components && !components.empty?
     end
 
     # @return [String]
@@ -46,13 +50,14 @@ module Act
     # @return [String]
     #
     def self.add_line_numbers(string, start_line, highlight_line = nil)
+      start_line ||= 0
       line_count = start_line
       numbered_lines = string.lines.map do |line|
-        line_count += 1
         number = line_count.to_s.ljust(3)
         if highlight_line && highlight_line == line_count
           number = number.yellow
         end
+        line_count += 1
         "#{number}  #{line}"
       end
       numbered_lines.join
@@ -73,4 +78,3 @@ module Act
     end
   end
 end
-

data/lib/act/user_interface.rb

@@ -0,0 +1,15 @@
+module Act
+  # Manages the UI output.
+  #
+  module UserInterface
+    def self.puts(message)
+      STDOUT.puts message
+    end
+
+    def self.warn(message)
+      STDERR.puts message
+    end
+  end
+
+  UI = UserInterface
+end

data/lib/act/version.rb

@@ -1,3 +1,3 @@
 module Act
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/spec/argument_parser_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Act
+  describe ArgumentParser do
+
+    before do
+      @subject = ArgumentParser
+    end
+
+    #-------------------------------------------------------------------------#
+
+    describe 'parse_file_information' do
+
+      it 'handles paths' do
+        file = 'lib/act/command.rb'
+        context_lines = 5
+        result = @subject.parse_file_information(file)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should.be.nil
+        result.to_line.should.be.nil
+        result.highlight_line.should.be.nil
+      end
+
+      it 'returns nil if no file information has been provided' do
+        file = nil
+        result = @subject.parse_file_information(file)
+        result.should.be.nil
+      end
+
+      it 'handles paths where the line number is specified by a colon' do
+        file = 'lib/act/command.rb:10'
+        context_lines = 5
+        result = @subject.parse_file_information(file, context_lines)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 5
+        result.to_line.should == 15
+        result.highlight_line.should == 10
+      end
+
+      it 'handles paths which include the column number' do
+        file = 'lib/act/command.rb:10:2'
+        context_lines = 5
+        result = @subject.parse_file_information(file, context_lines)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 5
+        result.to_line.should == 15
+        result.highlight_line.should == 10
+      end
+
+      it 'handles line ranges' do
+        file = 'lib/act/command.rb:10-12'
+        context_lines = 5
+        result = @subject.parse_file_information(file, context_lines)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 10
+        result.to_line.should == 12
+        result.highlight_line.should.be.nil
+      end
+
+      it 'handles the specification of a custom context' do
+        file = 'lib/act/command.rb:10+2'
+        context_lines = 5
+        result = @subject.parse_file_information(file, context_lines)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 8
+        result.to_line.should == 12
+        result.highlight_line.should == 10
+      end
+
+      it 'supports GitHub style line specification' do
+        file = 'lib/act/command.rb#L10'
+        context_lines = 5
+        result = @subject.parse_file_information(file, context_lines)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 5
+        result.to_line.should == 15
+        result.highlight_line.should == 10
+      end
+
+      it 'supports GitHub style line specification' do
+        file = 'lib/act/command.rb#L10-L12'
+        result = @subject.parse_file_information(file)
+        result.path.should == 'lib/act/command.rb'
+        result.from_line.should == 10
+        result.to_line.should == 12
+        result.highlight_line.should.be.nil
+      end
+
+    end
+
+    #-------------------------------------------------------------------------#
+
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Act
+  describe Command do
+    describe 'In general' do
+      it 'runs without exceptions' do
+        argv = [__FILE__]
+        should.not.raise do
+          Act::Command.run(argv)
+        end
+      end
+    end
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module Act
+  describe Helper do
+
+    before do
+      @subject = Helper
+    end
+
+    #-------------------------------------------------------------------------#
+
+    describe 'select_lines' do
+
+      it 'returns the lines corresponding to the given range' do
+        string = "1\n2\n3\n4"
+        result = @subject.select_lines(string, 1, 2)
+        result.should == "1\n2\n"
+      end
+
+      it 'use a one-based index' do
+        string = "index\nanother"
+        result = @subject.select_lines(string, 1, 1)
+        result.should == "index\n"
+      end
+
+      it 'returns nil if the range is malformed' do
+        string = "1\n2\n3\n4"
+        result = @subject.select_lines(string, 2, 1)
+        result.should.nil
+      end
+
+      it 'returns nil if the range is outside the lines of the string' do
+        string = "1\n2\n3\n4"
+        result = @subject.select_lines(string, 10, 11)
+        result.should.nil
+      end
+
+      it 'returns the matched part if the range is partially outside the lines of the string' do
+        string = "1\n2\n3\n4"
+        result = @subject.select_lines(string, 3, 10)
+        result.should == "3\n4"
+      end
+
+      it 'handles negative line numbers' do
+        string = "1\n2\n3\n4"
+        result = @subject.select_lines(string, -2, 2)
+        result.should == "1\n2\n"
+      end
+
+    end
+
+    #-------------------------------------------------------------------------#
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# Set up
+#-----------------------------------------------------------------------------#
+
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'act'
+
+# Silence the output
+#--------------------------------------#
+
+module Act
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+    end
+
+    def self.puts(message)
+      @output << message
+    end
+
+    def self.warn(message)
+      @warnings << message
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fabio Pelosin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".kick"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,10 +98,16 @@ files:
 - act.gemspec
 - bin/act
 - lib/act.rb
+- lib/act/argument_parser.rb
 - lib/act/command.rb
 - lib/act/helper.rb
+- lib/act/user_interface.rb
 - lib/act/version.rb
-homepage: ''
+- spec/argument_parser_spec.rb
+- spec/command_spec.rb
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/irrationalfab/act
 licenses:
 - MIT
 metadata: {}
@@ -122,6 +130,10 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Act the command line tool to act on files
-test_files: []
+summary: Act the command line tool to act on files.
+test_files:
+- spec/argument_parser_spec.rb
+- spec/command_spec.rb
+- spec/helper_spec.rb
+- spec/spec_helper.rb
 has_rdoc: