ackr 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e83eb5b6deec8ee36c134d18917a71493eee1846
-  data.tar.gz: 55e85123c33211d73fdbe654972ebe82cefe1093
+  metadata.gz: c7786a41cb79edccf41532324d4a365511863ede
+  data.tar.gz: d2eef2e79dcd3a6d5d2fb14f80fa6dad7baf134d
 SHA512:
-  metadata.gz: dfbe9e788405465c1b404872de36b286cf2e177ec7bc20d7370baa0e9376a4bd1d8ebe5e01cc811f753fc0ff461d6a364088acc14f59f8b51cb02c6bcb15bd28
-  data.tar.gz: 948724acebfad1ffd591f1282667b8a5f8767bb30c78544e48538809d2f748b3ea4dc10384992a9b5f41ac3c89c52452e2b7af0446de362425b4ac2306d48717
+  metadata.gz: 57cd732e678cc9f5c0a766bf8d84a52daaaf994438209d11e8b9846d37016ee0af2650650df205679f625c3cf0fbed54799d6c455778fa7e4618d96227d430bd
+  data.tar.gz: 87063c8935cd140db729723c01281ec10e9c138ed3b49f8e8498c6abe06cd3ffb413416f14c238cdb0bb1dc7855dfe0eb037498eb9e37c3a07ada6d0898ae8c3

data/.gitignore

@@ -0,0 +1,4 @@
+TODO
+*.gem
+coverage/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.2"
+  - "2.3"
+  - "2.4"

data/Gemfile

@@ -2,5 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rake', '>= 10.1.0'
-gem 'rspec'
+gem 'rake', '>= 12.0.0'
+gem 'rspec', '>= 3.6.0'

data/Gemfile.lock

@@ -1,28 +1,37 @@
 PATH
   remote: .
   specs:
-    ackr (0.2.4)
-      rainbow (= 1.99.2)
+    ackr (0.3.0)
+      rainbow (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    rainbow (1.99.2)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
+    diff-lcs (1.3)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   ackr!
-  rake (>= 10.1.0)
-  rspec
+  rake (>= 12.0.0)
+  rspec (>= 3.6.0)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 lkdjiin
+Copyright (c) 2013-2017 Xavier Nayrac
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -16,12 +16,12 @@ most possible simple tool.
 
 Here comes ackr:
 
-  * Ackr look for a search term into all text files, into all subfolders, 
+  * 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
+  * Ackr doesn't search inside hidden folders, **but** looks to hidden files
   * Search term is displayed in bold font
 
 It runs on unixes. I guess it won't run on windows.
@@ -80,12 +80,12 @@ you must use:
 
 ### Ignored files and directories
 
-Ackr doesn't look into hidden files or directories. In addition, ackr
+Ackr doesn't look into directories. In addition, ackr
 ignores the following list of directories:
-  
+
   * `blib`
   * `CVS`
-  * `_darcs` 
+  * `_darcs`
   * `RCS`
   * `SCCS`
   * `pkg`
@@ -93,7 +93,7 @@ ignores the following list of directories:
   * `temp`
   * `log`
 
-If you really want to search into a such directory anyway, simply `cd`
+If you want to search into such a directory anyway, simply `cd`
 into it and make the search.
 
 ### Caveats
@@ -101,27 +101,6 @@ into it and make the search.
 Ackr is slow, very slow...
 May be I will consider performance in a future version.
 
-Dependencies
---------------------------
-
-  * ruby >= 1.9.3
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature develop`)
-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. Report any bug
-2. Give me ideas
-3. Correct my poor english syntax
-4. Blog about ackr
-5. Tell ackr to your friends and colleagues
-
 License
 --------------------------
 

data/Rakefile

@@ -1,22 +1,6 @@
-# -*- encoding: utf-8 -*-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rake/dsl_definition'
-require 'rake'
-require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'Test GEM'
 task :default => :spec
-
-desc 'Test GEM with rspec'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ['--color']
-end
-
-desc 'Check for code smells'
-task :reek do
-  puts 'Checking for code smells...'
-  files = Dir.glob 'lib/**/*.rb'
-  # files.delete FILE_TO_EXCLUDE
-  args = files.join(' ')
-  sh "reek --quiet #{args} | ./reek.sed"
-end

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/ackr.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'ackr'
+  s.version = File.read('VERSION').strip
+  s.authors = ['Xavier Nayrac']
+  s.email = 'xavier.nayrac@gmail.com'
+  s.summary = 'The smallest subset of ack/rak/ag. For lazy developers'
+  s.homepage = 'https://github.com/lkdjiin/ackr'
+  s.description = %q{Ackr is the smallest subset of ack/rak/ag I can think of. For lazy developers}
+
+  s.files = `git ls-files -z`.split("\x0")
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+	s.license = 'MIT'
+	s.required_ruby_version = '>= 2.2.0'
+	s.executables = ['ackr']
+  s.add_dependency 'rainbow', '~> 2.2'
+end

data/bin/ackr

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 $ACKR_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
@@ -7,7 +6,7 @@ $ACKR_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
 require 'ackr'
 
 if ARGV[0].nil?
-  puts "ackr version " + File.read('VERSION').strip
+  puts "ackr version " + File.read($ACKR_PATH + '/VERSION').strip
   puts "
   usage:
 

data/lib/ackr.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require 'ackr/extensions/string'
 require 'ackr/search'
 require 'ackr/colorizer'

data/lib/ackr/colorizer.rb

@@ -1,6 +1,4 @@
-# -*- encoding: utf-8 -*-
-
-gem 'rainbow', '= 1.99.2'
+gem 'rainbow', '~> 2.2'
 require 'rainbow'
 
 module Ackr
@@ -14,7 +12,7 @@ module Ackr
     #
     # Returns the String filename highlighted.
     def self.for_file string
-      string.foreground(:blue).bright.underline
+      Rainbow(string).fg(:blue).bright.underline
     end
 
     # Public: Highlight a matched file line.
@@ -26,9 +24,9 @@ module Ackr
     def self.for_line string, search
       search = Regexp.new(search, Regexp::IGNORECASE) if search.is_a?(String)
       begin
-        string.gsub(search) {|exp| exp.bright }
+        string.gsub(search) {|exp| Rainbow(exp).bright }
       rescue Exception => ex
-        puts "Error ".background(:red) + ex.message
+        puts Rainbow("Error ").bg(:red) + ex.message
       end
     end
   end

data/lib/ackr/finder.rb

@@ -1,27 +1,44 @@
-# -*- encoding: utf-8 -*-
-
 module Ackr
 
   # All 'find a file' relatives.
   module Finder
 
-    # Public: Get all files to look for.
+    # Get all files to look for.
     #
     # Files of interest are those who are
     #   + not directory
     #   + not binary
-    #   + not hidden
+    #   + not inside a hidden folder
+    #
+    # Returns nothing.
     #
-    # Returns an Enumerator of String filename.
     def self.all_files
-      Dir.glob('**/*').each do |file|
-        next if (File.directory?(file) || Ackr::binary?(file))
+      Dir.glob('**/*', File::FNM_DOTMATCH).each do |file|
+        next if File.directory?(file)
+        next if inside_hidden_folder?(file)
+        next if Ackr.binary?(file)
+
         next if EXCLUDE_DIRS.any? do |dir|
-          file.start_with?(dir + File::Separator) || 
+          file.start_with?(dir + File::Separator) ||
             file.include?(File::Separator + dir + File::Separator)
         end
+
         yield(file)
       end
     end
+
+    def self.inside_hidden_folder?(file)
+      part_of_hidden_folder?(file) || part_of_hidden_subfolder?(file)
+    end
+
+    private
+
+    def self.part_of_hidden_folder?(file)
+      file.start_with?('.') && file.include?(File::Separator)
+    end
+
+    def self.part_of_hidden_subfolder?(file)
+      file =~ /\/\..*\//
+    end
   end
 end

data/spec/colorizer_spec.rb

@@ -0,0 +1,33 @@
+require './spec/helper'
+
+describe Colorizer do
+
+  describe "#for_file" do
+    it "should colorize filename" do
+      string = "path/to/file"
+      expected = Rainbow(string).fg(:blue).bright.underline
+      expect(Colorizer::for_file(string)).to eq(expected)
+    end
+  end
+
+  describe "#for_line" do
+    it "should colorize matched term" do
+      string = "123 456 789"
+      expected = "123 " + Rainbow("456").bright + " 789"
+      expect(Colorizer::for_line(string, "456")).to eq(expected)
+    end
+
+    it "should colorize matched terms" do
+      string = "123 456 789 456"
+      expected = "123 " + Rainbow("456").bright + " 789 " + Rainbow("456").bright
+      expect(Colorizer::for_line(string, "456")).to eq(expected)
+    end
+
+    it "should be case insensitive" do
+      string = "AAA BBB CCC"
+      expected = "AAA " + Rainbow("BBB").bright + " CCC"
+      expect(Colorizer::for_line(string, "bbb")).to eq(expected)
+    end
+  end
+end
+

data/spec/example1/folder/folder/level2

@@ -0,0 +1 @@
+level2

data/spec/example1/folder/level1

@@ -0,0 +1,2 @@
+level1
+ALICE

data/spec/example1/root

@@ -0,0 +1,5 @@
+root
+root
+root
+root
+xavier

data/spec/example1/tmp/tmp.txt

@@ -0,0 +1 @@
+tmp

data/spec/finder_spec.rb

@@ -0,0 +1,75 @@
+require './spec/helper'
+
+# spec/example1/
+# ├── CVS
+# │   └── cvs.txt
+# ├── folder
+# │   ├── CVS
+# │   │   └── cvs.txt
+# │   ├── folder
+# │   │   ├── CVS
+# │   │   │   └── cvs.txt
+# │   │   └── level2
+# │   ├── .hidden-subfoder
+# │   │   └── not-me
+# │   └── level1
+# ├── .hidden-folder
+# │   ├── file
+# │   └── .file
+# ├── root
+# ├── tmp
+# │   └── tmp.txt
+# └── .visible-file
+
+describe Finder do
+
+  describe "#all_files" do
+    before do
+      @results = []
+      Dir.chdir('spec/example1/') do
+        Finder::all_files {|file| @results << file }
+      end
+    end
+
+    it "doesnt return a directory" do
+      expect(@results.include?('folder/')).to be_falsey
+    end
+
+    it "doesnt return a binary" do
+      expect(@results.include?('ackr-0.1.gem')).to be_falsey
+    end
+
+    it "returns root file" do
+      expect(@results.include?('root')).to be_truthy
+    end
+
+    it "returns files in subfolders" do
+      expect(@results.include?('folder/level1')).to be_truthy
+      expect(@results.include?('folder/folder/level2')).to be_truthy
+    end
+
+    it "doesnt return files in tmp/" do
+      expect(@results.include?('tmp/tmp.txt')).to be_falsey
+    end
+
+    it "doesnt return files in CVS/" do
+      expect(@results.include?('CVS/cvs.txt')).to be_falsey
+    end
+
+    it "doesnt return files in CVS/ subfolders" do
+      expect(@results.include?('folder/CVS/cvs.txt')).to be_falsey
+      expect(@results.include?('folder/folder/CVS/cvs.txt')).to be_falsey
+    end
+
+    it "returns hidden files" do
+      expect(@results).to include('.visible-file')
+      expect(@results).to include('folder/folder/.visible-file')
+    end
+
+    it "doesnt look into hidden folders" do
+      expect(@results).not_to include('.hidden-folder/file')
+      expect(@results).not_to include('.hidden-folder/.file')
+      expect(@results).not_to include /not-me$/
+    end
+  end
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,35 @@
+require './spec/helper'
+
+describe Formatter do
+  before do
+    @format = Formatter.new("search")
+  end
+
+  describe "#line" do
+
+    it "should format line number" do
+      result = @format.line("abc search", 1)
+      expect(result.start_with?("   1")).to be_truthy
+    end
+
+    it "should add a pipe and a space after line number" do
+      result = @format.line("abc search", 1)
+      expect(result.start_with?("   1| ")).to be_truthy
+    end
+
+    it "should colorize search term" do
+      result = @format.line("abc search", 1)
+      expect(result).to eq("   1| abc " + Rainbow("search").bright)
+    end
+
+    it "should suppress trailing spaces" do
+      result = @format.line("     abc search", 1)
+      expect(result).to eq("   1| abc " + Rainbow("search").bright)
+    end
+
+    it "should suppress trailing tabs" do
+      result = @format.line("\t\tabc search", 1)
+      expect(result).to eq("   1| abc " + Rainbow("search").bright)
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+$ACKR_PATH = File.expand_path(File.join(File.expand_path(File.dirname(__FILE__)), '..'))
+
+require './lib/ackr'
+include Ackr

data/spec/search_spec.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe Search do
+
+  context "when looking for a string" do
+
+    it "should print file, line number and line" do
+      Dir.chdir('spec/example1/') do
+        @search = Search.new("xavier")
+        expect($stdout).to receive(:puts).with("\e[34m\e[1m\e[4mroot\e[0m")
+        expect($stdout).to receive(:puts).with("   5| \e[1mxavier\e[0m")
+        expect($stdout).to receive(:puts).with("")
+        @search.run
+      end
+    end
+
+    it "should be case insensitive" do
+      Dir.chdir('spec/example1/') do
+        @search = Search.new("alice")
+        expect($stdout).to receive(:puts).with("\e[34m\e[1m\e[4mfolder/level1\e[0m")
+        expect($stdout).to receive(:puts).with("   2| \e[1mALICE\e[0m")
+        expect($stdout).to receive(:puts).with("")
+        @search.run
+      end
+    end
+
+  end
+
+  context "when looking for a regexp" do
+    it "should print file, line number and line" do
+      Dir.chdir('spec/example1/') do
+        @search = Search.new('/xavier/')
+        expect($stdout).to receive(:puts).with("\e[34m\e[1m\e[4mroot\e[0m")
+        expect($stdout).to receive(:puts).with("   5| \e[1mxavier\e[0m")
+        expect($stdout).to receive(:puts).with("")
+        @search.run
+      end
+    end
+  end
+
+end

data/spec/string_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe "String#to_regexp" do
+ 
+  context "fail cases" do
+    specify { expect("reg".to_regexp).to be_nil }
+    specify { expect("/reg".to_regexp).to be_nil }
+    specify { expect("reg/".to_regexp).to be_nil }
+    specify { expect("reg/i".to_regexp).to be_nil }
+    specify { expect("/reg/mk".to_regexp).to be_nil }
+  end
+
+  context "pass cases" do
+    specify { expect("/reg/".to_regexp).to eq(/reg/) }
+    specify { expect("/reg/i".to_regexp).to eq(/reg/i) }
+    specify { expect("/reg/m".to_regexp).to eq(/reg/m) }
+    specify { expect("/reg/x".to_regexp).to eq(/reg/x) }
+    specify { expect("/reg/im".to_regexp).to eq(/reg/im) }
+    specify { expect("/reg/ix".to_regexp).to eq(/reg/ix) }
+    specify { expect("/reg/imx".to_regexp).to eq(/reg/imx) }
+    specify { expect("  /reg/i ".to_regexp).to eq(/reg/i) }
+    specify { expect("   /reg/    ".to_regexp).to eq(/reg/) }
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ackr
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Xavier Nayrac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.99.2
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.99.2
+        version: '2.2'
 description: Ackr is the smallest subset of ack/rak/ag I can think of. For lazy developers
 email: xavier.nayrac@gmail.com
 executables:
@@ -31,13 +31,16 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.markdown
 - Rakefile
-- TODO
 - VERSION
+- ackr.gemspec
 - bin/ackr
 - lib/ackr.rb
 - lib/ackr/colorizer.rb
@@ -45,6 +48,24 @@ files:
 - lib/ackr/finder.rb
 - lib/ackr/formatter.rb
 - lib/ackr/search.rb
+- spec/colorizer_spec.rb
+- spec/example1/.hidden-folder/.file
+- spec/example1/.hidden-folder/file
+- spec/example1/.visible-file
+- spec/example1/CVS/cvs.txt
+- spec/example1/folder/.hidden-subfoder/not-me
+- spec/example1/folder/CVS/cvs.txt
+- spec/example1/folder/folder/.visible-file
+- spec/example1/folder/folder/CVS/cvs.txt
+- spec/example1/folder/folder/level2
+- spec/example1/folder/level1
+- spec/example1/root
+- spec/example1/tmp/tmp.txt
+- spec/finder_spec.rb
+- spec/formatter_spec.rb
+- spec/helper.rb
+- spec/search_spec.rb
+- spec/string_spec.rb
 homepage: https://github.com/lkdjiin/ackr
 licenses:
 - MIT
@@ -57,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -65,9 +86,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: The smallest subset of ack/rak/ag. For lazy developers
-test_files: []
-has_rdoc: 
+test_files:
+- spec/colorizer_spec.rb
+- spec/example1/.hidden-folder/.file
+- spec/example1/.hidden-folder/file
+- spec/example1/.visible-file
+- spec/example1/CVS/cvs.txt
+- spec/example1/folder/.hidden-subfoder/not-me
+- spec/example1/folder/CVS/cvs.txt
+- spec/example1/folder/folder/.visible-file
+- spec/example1/folder/folder/CVS/cvs.txt
+- spec/example1/folder/folder/level2
+- spec/example1/folder/level1
+- spec/example1/root
+- spec/example1/tmp/tmp.txt
+- spec/finder_spec.rb
+- spec/formatter_spec.rb
+- spec/helper.rb
+- spec/search_spec.rb
+- spec/string_spec.rb

data/TODO

@@ -1,22 +0,0 @@
-[x] Ruby 2.1 sur travis à la place de 2.1.0
-[x] Remove 1.9.2 on travis
-[x] Fix the rainbow issue (test 1.99.2)
-[ ] Make it pipeable
-[ ] Make it themeable
-
----------------------------
-annonce release sur freecode, mon blog
-ajouter screenshot sur freecode
-
----------------------------
-Site web
-
----------------------------
-Écrire à rainbow owner pour lui dire que j'utilise son truc
-dans ce projet.
-
----------------------------
-Améliorer les perfs
-
----------------------------
-une ligne sur le terminal fait 80 char max