ackr 0.1.1 → 0.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    ackr (0.2)
+      rainbow (>= 1.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rainbow (1.1.4)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ackr!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 lkdjiin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,14 +1,33 @@
-Ackr
+Ackr [![Build Status](https://travis-ci.org/lkdjiin/ackr.png)](https://travis-ci.org/lkdjiin/ackr) 
 ================
 
-Ackr is a very light grep/ack/rak replacement for lazy developers.
+Ackr is a very small subset of grep/ack/rak, for **lazy developers**.
 
 Description
 -----------
 
-TODO. Work in progress.
+Grep is a great tool. A very powerful tool. But most of the time, it is
+too powerful for my needs. I can never remember its syntax nor its options.
 
-Run on linux. Maybe run on mac os. I guess it doesn't run on windows.
+Ack is great and powerful too. But here again it has so many options.
+
+As a developer I have really simple needs. As a lazy developer I want the
+most possible simple tool.
+
+Here comes ackr:
+
+  * Ackr look for a search term into all text files, into all subfolders, 
+    from the working directory
+  * A search term is either **a string** (in this case Ackr is *case insensitive*)
+    or **a regexp**
+  * Ackr has **no options**
+  * Ackr doesn't look into hidden folders/files
+  * Search term is displayed in bold font
+
+It runs on linux. It maybe runs on mac os. I guess it won't run on windows.
+
+And one more thing: ackr **is not a replacement to grep/ack**. If you
+need grep power, just use grep!
 
 Install
 -------------------------
@@ -18,14 +37,48 @@ Install
 Usage
 --------------------------
 
-TODO. Work in progress.
+To look for a string (case insensitive):
+
+    $ ackr fixme
+    lib/ackr/search.rb
+       8|   # FIXME Separate behaviours: search / print
+
+    README.markdown
+      21| $ackr fixme
+
+Using a regexp (same search as above):
+
+    $ ackr /fixme/i
+
+More to come
+--------------------------
+
+Next version may include
 
+  * fuzzy search
+  * configuration
 
 Dependencies
 --------------------------
 
   * ruby >= 1.9.2
 
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+### There is many other ways to contibute to ackr
+
+1. Reports any bug
+2. Give me ideas
+3. Correct my poor english syntax
+4. Blog about ackr
+5. Tell ackr to your friends or colleagues
+
 License
 --------------------------
 

data/Rakefile

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 
+require 'rake/dsl_definition'
 require 'rake'
 require 'rspec/core/rake_task'
 

data/TODO

@@ -1,27 +1,29 @@
-Écrire le readme
-travis-ci
 
----------------------------
+[ok]supprimer les espaces/tab avant
+[ok]$ ackr /tel \d{10}/i
+[ok]terme de la regex en gras dans le terminal
+[ok]Bug invalid byte sequence
 
-[ok]Dans tout les fichiers texte.
-[ok]case insensitive
-[ok]nom du fichier en couleur
-[ok]terme de la recherche en gras
-[ok]ne pas chercher dans les dossiers/fichiers cachés
-supprimer les espaces/tab avant/après
-  1|.le point signale que un (ou des) espaces ont été supprimés
-une ligne sur le terminal fait 80 char max
+Exclure dossier temp/ tmp/ et d'autres
 
 ---------------------------
+fichier de config
 
-$ ackr /tel \d{10}/i
+---------------------------
+Site web
 
+---------------------------
+Écrire à rainbow owner pour lui dire que j'utilise son truc
+dans ce projet.
 
 ---------------------------
-fichier de config
+Améliorer les perfs
 
 ---------------------------
 fuzzy search:
 $ ackf abc
 path/to/file
 00001| a123 b 2 568 c
+
+---------------------------
+une ligne sur le terminal fait 80 char max

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2

data/bin/ackr

@@ -7,7 +7,9 @@ $ACKR_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
 require 'ackr'
 
 if ARGV[0].nil?
-  puts "usage:
+  puts "ackr version " + File.read('VERSION').strip
+  puts "
+  usage:
 
   ackr search_string
 

data/lib/ackr.rb

@@ -1,10 +1,15 @@
 # -*- encoding: utf-8 -*-
 
+require 'ackr/extensions/string'
 require 'ackr/search'
 require 'ackr/colorizer'
 require 'ackr/finder'
+require 'ackr/formatter'
 
 module Ackr
+
+  EXCLUDE_DIRS = %w(blib CVS _darcs RCS SCCS pkg tmp temp log)
+
   # Method taken from: https://github.com/djberg96/ptools
   # --
   #

data/lib/ackr/colorizer.rb

@@ -23,9 +23,11 @@ module Ackr
     #
     # Returns the String line highlighted.
     def self.for_line string, search
-      reg = Regexp.new(search, Regexp::IGNORECASE)
-      string.gsub(reg) do |exp|
-        exp.bright
+      search = Regexp.new(search, Regexp::IGNORECASE) if search.is_a?(String)
+      begin
+        string.gsub(search) {|exp| exp.bright }
+      rescue Exception => ex
+        puts "Error ".background(:red) + ex.message
       end
     end
   end

data/lib/ackr/extensions/string.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+class String
+
+  # Public: Transform itself in a Regexp.
+  #
+  # Returns a Regexp if successful, nil otherwise.
+  # ---
+  # Credit to Josh Cheek: http://www.ruby-forum.com/topic/193809
+  #
+  # Note: there is also a gem:
+  #   https://github.com/seamusabshere/to_regexp 
+  #   Could be useful if I later want to parse things like
+  #     $ ackr %r{regexp}
+  #   or if bugs are discovered in the following code.
+  def to_regexp
+    return nil unless self.strip.match(/\A\/(.*)\/(.*)\Z/mx)
+    regexp , flags = $1 , $2
+    return nil if !regexp || flags =~ /[^xim]/m
+
+    x = /x/.match(flags) && Regexp::EXTENDED
+    i = /i/.match(flags) && Regexp::IGNORECASE
+    m = /m/.match(flags) && Regexp::MULTILINE
+
+    Regexp.new regexp , [x,i,m].inject(0){|a,f| f ? a+f : a }
+  end
+end

data/lib/ackr/finder.rb

@@ -16,6 +16,10 @@ module Ackr
     def self.all_files
       Dir.glob('**/*').each do |file|
         next if (File.directory?(file) || Ackr::binary?(file))
+        next if EXCLUDE_DIRS.any? do |dir|
+          file.start_with?(dir + File::Separator) || 
+            file.include?(File::Separator + dir + File::Separator)
+        end
         yield(file)
       end
     end

data/lib/ackr/formatter.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+module Ackr
+
+  # Format strings to be displayed on terminal.
+  class Formatter
+
+    # Public:
+    #
+    # search_term - The String or Regexp to look for.
+    def initialize search_term
+      @search_term = search_term
+    end
+
+    # Public: format a line with matched term(s).
+    #
+    # line - The String line to be displayed.
+    # num  - The Integer number of the line (in base 1).
+    #
+    # Returns a formatted String.
+    def line line, num
+      begin
+        line.strip!
+      rescue Exception => ex
+        puts "Error ".background(:red) + ex.message
+      end
+      "#{'%4i' % num}| #{Colorizer::for_line(line, @search_term)}"
+    end
+  end
+end
+

data/lib/ackr/search.rb

@@ -11,8 +11,17 @@ module Ackr
     # Public:
     #
     # search_term - The String to look for.
+    #               This param could be a 'real' string or a String
+    #               representing a regexp. If the string looks like
+    #               a regexp, it will be treated like a regexp.
+    #
+    # Examples:
+    #   Search.new("abc")
+    #   Search.new("/abc/i")
     def initialize search_term
-      @search_term = search_term.downcase
+      @search_term = search_term.to_regexp
+      @search_term = search_term.downcase if @search_term.nil?
+      @format = Formatter.new @search_term
     end
 
     # Public: Launch the search.
@@ -37,12 +46,22 @@ module Ackr
       def search_into_file
         result = []
         File.readlines(@file).each_with_index do |line, idx|
-          if line.downcase.include?(@search_term)
-            result << "#{'%4i' % (idx + 1)}| #{Colorizer::for_line(line, @search_term)}"
-          end
+          found = search_into_line(line)
+          result << @format.line(line, idx + 1) if found
         end
         result
       end
 
+      def search_into_line line
+        begin
+          if @search_term.is_a?(String)
+            line.downcase.include?(@search_term)
+          else
+            @search_term =~ line
+          end
+        rescue #Exception => ex
+        end
+      end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ackr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.4
-description: Ackr is a very light grep/ack/rak replacement for lazy developers.
+description: Ackr is a very small subset of grep/ack/rak, for lazy developers
 email: xavier.nayrac@gmail.com
 executables:
 - ackr
@@ -37,12 +37,17 @@ files:
 - lib/ackr.rb
 - lib/ackr/finder.rb
 - lib/ackr/search.rb
+- lib/ackr/formatter.rb
+- lib/ackr/extensions/string.rb
 - lib/ackr/colorizer.rb
 - bin/ackr
+- LICENSE.txt
 - VERSION
 - README.markdown
+- Gemfile
 - Rakefile
 - TODO
+- Gemfile.lock
 homepage: https://github.com/lkdjiin/ackr
 licenses:
 - MIT
@@ -67,5 +72,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Ackr is a very light grep/ack/rak replacement for lazy developers.
+summary: Ackr is a very small subset of grep/ack/rak, for lazy developers
 test_files: []