redcar-dev 0.12.17dev

data/plugins/project_search/features/support/env.rb

@@ -0,0 +1,6 @@
+
+Before do
+end
+
+After do
+end

data/plugins/project_search/features/word_search.feature

@@ -0,0 +1,34 @@
+# Feature: Word search
+#   As a user
+#   I want to search for the occurrences of complete words in my project
+# 
+#   Background:
+#     Given I will choose "plugins/project_search/spec/fixtures/project" from the "open_directory" dialog
+#     And I open a directory
+#     When I open the "Word Search" from the "Project" menu
+#     And I wait "3" seconds
+
+  # Scenario: See the search interface
+  #   Then I should see "Search for complete words only" in the web view
+  # 
+  # Scenario: Run a search
+  #   When I fill in "#query" with "foo" in the web view
+  #   And I press "Find In Project" in the web view
+  #   Then I should see "foo bar baz" in the web view
+
+  #Scenario: Opening the TODO list shows the todo items and their action texts without colons
+  #  Then the HTML tab should say "a course of action"
+  #  And the HTML tab should not say ": a course of action"
+  #
+  #Scenario: Opening the TODO list shows the todo item's file names
+  #  Then the HTML tab should say "OPTIMIZE_colon.file"
+  #  And the HTML tab should say "FIXME.file"
+  #
+  #Scenario: Opening the TODO list shows the todo item's line numbers
+  #  Then the HTML tab should say "OPTIMIZE_colon.file:1"
+  #  And the HTML tab should say "FIXME.file:3"
+  #
+  #Scenario: Clicking a TODO item's file name should open it in an edit tab
+  #  When I click "FIXME.file" in the HTML tab
+  #  Then my active tab should be "FIXME.file"
+  #  And the contents should be "#\n#\n<c># FIXME note"

data/plugins/project_search/lib/project_search.rb

@@ -0,0 +1,82 @@
+
+require 'lucene'
+
+require 'project_search/word_search_controller'
+require 'project_search/lucene_index'
+require 'project_search/lucene_refresh'
+require 'project_search/binary_data_detector'
+require 'project_search/commands'
+require 'project_search/hit'
+require 'project_search/word_search'
+
+class ProjectSearch
+  def self.menus
+    Redcar::Menu::Builder.build do
+      sub_menu "Project" do
+        group :priority => 1 do
+          item "Word Search",  :command => ProjectSearch::WordSearchCommand
+        end
+        sub_menu "Refresh", :priority => 31 do
+          item "Search index", :command => ProjectSearch::RefreshIndex
+        end
+      end
+    end
+  end
+  
+  def self.keymaps
+    osx = Redcar::Keymap.build("main", :osx) do
+      link "Cmd+Shift+F",     ProjectSearch::WordSearchCommand
+    end
+    linwin = Redcar::Keymap.build("main", [:linux, :windows]) do
+      link "Ctrl+Shift+F",     ProjectSearch::WordSearchCommand
+    end
+    [osx, linwin]
+  end
+
+  def self.toolbars
+    Redcar::ToolBar::Builder.build do
+      item "Word Search", :command => WordSearchCommand,
+        :icon => File.join(Redcar.icons_directory, "application-search-result.png"),
+        :barname => :project
+    end
+  end
+
+  def self.storage
+    @storage ||= begin
+      storage = Redcar::Plugin::Storage.new('find_in_project')
+      storage.set_default('recent_queries', [])
+      storage.set_default('excluded_dirs', ['.git', '.svn', '.redcar'])
+      storage.set_default('excluded_files', [])
+      storage.set_default('excluded_patterns', [/tags$/, /\.log$/])
+      storage.set_default('literal_match', false)
+      storage.set_default('match_case', false)
+      storage.set_default('with_context', false)
+      storage.set_default('context_lines', 2)
+      storage.save
+    end
+  end
+  
+  def self.shared_storage
+    @shared_storage ||= begin
+      storage = Redcar::Plugin::SharedStorage.new('shared__ignored_files')
+      storage.set_or_update_default('ignored_file_patterns', [/tags$/, /\.log$/])
+      storage.save
+    end
+  end
+  
+  Lucene::Config.use do |config|
+    config[:store_on_file] = true
+    config[:storage_path]  = ""
+    config[:id_field]      = :id
+  end
+  
+  def self.project_refresh_task_type
+    LuceneRefresh
+  end
+  
+  def self.indexes
+    @indexes ||= {}
+  end
+end
+
+

data/plugins/project_search/lib/project_search/binary_data_detector.rb

@@ -0,0 +1,46 @@
+
+class ProjectSearch
+  # This class discriminates between binary and textual data. 
+  class BinaryDataDetector
+    # Is the data binary?
+    #
+    # @param [String] data 
+    def self.binary?(data)
+      not textual?(data)
+    end
+    
+    # Is the data plain text?
+    #
+    # @param [String] data 
+    def self.textual?(data)
+      found_good_byte = false
+      data.each_byte do |b|
+        return false if bad_byte?(b)
+        found_good_byte = found_good_byte || good_byte?(b)
+      end
+      found_good_byte
+    end
+    
+    INDIVIDUAL_GOOD_BYTES = [9, 10, 13]
+    
+    # At least one of these good bytes must be found for the text to be 
+    # discriminated as plain text.
+    #
+    # @param [Fixnum] byte
+    def self.good_byte?(byte)
+      (byte >= 32 and byte <= 255) or INDIVIDUAL_GOOD_BYTES.include?(byte)
+    end
+    
+    INDIVIDUAL_BAD_BYTES = [0, 6, 14]
+    
+    # If any of these bytes are found then we immediately discriminate the data 
+    # as binary.
+    #
+    # @param [Fixnum] byte
+    def self.bad_byte?(byte)
+      (byte >= 14 and byte <= 31) or INDIVIDUAL_BAD_BYTES.include?(byte)
+    end
+  end
+end
+
+

data/plugins/project_search/lib/project_search/commands.rb

@@ -0,0 +1,50 @@
+
+class ProjectSearch
+  class RefreshIndex < Redcar::Command
+    sensitize :open_project
+
+    def execute
+      if project = Redcar::Project::Manager.focussed_project
+        if index = ProjectSearch.indexes[project.path]
+          index.delete
+          project.refresh
+        end
+      end
+    end
+  end
+
+  class WordSearchCommand < Redcar::Command
+    sensitize :open_project
+
+    def find_open_instance
+      all_tabs = Redcar.app.focussed_window.notebooks.map { |nb| nb.tabs }.flatten
+      all_tabs.find do |t|
+        t.is_a?(Redcar::HtmlTab) && t.title == ProjectSearch::WordSearchController::TITLE
+      end
+    end
+
+    def execute
+      if project = Redcar::Project::Manager.focussed_project
+        if tab = find_open_instance
+          tab.html_view.refresh
+          tab.focus
+        else
+          index = ProjectSearch.indexes[project.path]
+          if index and index.has_content?
+            tab = win.new_tab(Redcar::HtmlTab)
+            tab.html_view.controller = ProjectSearch::WordSearchController.new
+            tab.icon = :blue_folder_search_result
+            tab.focus
+          else
+            Redcar::Application::Dialog.message_box("Your project is still being indexed.", :type => :error)
+          end
+        end
+      else
+        Redcar::Application::Dialog.message_box("You need an open project to be able to use Find In Project!", :type => :error)
+      end
+      return
+    end
+  end
+end
+
+

data/plugins/project_search/lib/project_search/hit.rb

@@ -0,0 +1,21 @@
+
+class ProjectSearch
+  class Hit
+    attr_reader :file, :line_num, :pre_context, :post_context
+    
+    def initialize(file, line_num, line, regex, 
+        pre_context, post_context)
+      @file, @line_num, @line, @regex = file, line_num, line, regex
+      @pre_context = pre_context
+      @post_context = post_context
+    end
+    
+    def line(start_with=nil, end_with=nil)
+      @line.gsub(@regex) { start_with.to_s + $& + end_with.to_s }
+    end
+    
+    def inspect
+      "<Hit #{file}:#{line_num}>"
+    end
+  end
+end

data/plugins/project_search/lib/project_search/lucene_index.rb

@@ -0,0 +1,81 @@
+
+class ProjectSearch
+  class LuceneIndex
+    attr_accessor :last_updated, :lucene_index
+
+    def initialize(project)
+      @project     = project
+      @has_content = false
+      load
+    end
+
+    def timestamp_file_path
+      File.join(@project.config_dir, 'lucene_last_updated')
+    end
+
+    def lucene_index_dir
+      File.join(@project.config_dir, "lucene")
+    end
+
+    def delete
+      FileUtils.rm(timestamp_file_path)
+      FileUtils.rm_r(lucene_index_dir)
+      load
+    end
+
+    def load
+      @last_updated = Time.at(0)
+      if File.exist?(timestamp_file_path)
+        @last_updated = Time.at(File.read(timestamp_file_path).chomp.to_i)
+        @has_content = true
+      end
+    end
+
+    def dump
+      File.open(timestamp_file_path, "w") do |fout|
+        fout.puts(last_updated.to_i.to_s)
+      end
+    end
+
+    def has_content?
+      @has_content
+    end
+
+    MAX_FILE_SIZE = 500 * 1024
+
+    def update
+      changed_files = @project.file_list.changed_since(last_updated)
+      @last_updated = Time.now
+      changed_files.reject! do |fn, ts|
+        fn.index(@project.config_dir) or Redcar::Project::FileList.hide_file_path?(fn)
+      end
+      Lucene::Transaction.run do
+        @lucene_index ||= Lucene::Index.new(lucene_index_dir)
+        begin
+          @lucene_index.field_infos[:contents][:store] = true
+          @lucene_index.field_infos[:contents][:tokenized] = true
+          changed_files.each do |fn, ts|
+            begin
+              next if File.size(fn) > MAX_FILE_SIZE
+              pre_contents = File.new(fn).read(200)
+              unless !pre_contents or BinaryDataDetector.binary?(pre_contents)
+                contents = File.read(fn)
+                adjusted_contents = contents.gsub(/\.([^\s])/, '. \1')
+                @lucene_index << { :id => fn, :contents => adjusted_contents }
+              end
+            rescue => e
+              Redcar.log.error("[project_search] error indexing file #{fn}: #{e.message}")
+            end
+          end
+          @lucene_index.commit
+          @has_content = true
+        rescue => e
+          puts e.message
+          puts e.backtrace
+        end
+      end
+      dump
+    end
+
+  end
+end

data/plugins/project_search/lib/project_search/lucene_refresh.rb

@@ -0,0 +1,22 @@
+
+class ProjectSearch
+  
+  class LuceneRefresh < Redcar::Task
+    def initialize(project)
+      @project     = project
+    end
+    
+    def description
+      "#{@project.path}: refresh index"
+    end
+    
+    def execute
+      return if @project.remote?
+      unless index = ProjectSearch.indexes[@project.path]
+        index = ProjectSearch::LuceneIndex.new(@project)
+        ProjectSearch.indexes[@project.path] = index
+      end
+      index.update
+    end
+  end
+end

data/plugins/project_search/lib/project_search/project.rb

@@ -0,0 +1,14 @@
+
+module Redcar
+  class Project
+    def search(query, options)
+      options ||= {}
+      
+      strategy   = (options[:regex] || false) ? RegexSearch : WordSearch
+      match_case = options[:match_case] || true
+      context    = options[:context]    || 0
+      
+      strategy.new(ProjectSearch.indexes[self], query, match_case, context)
+    end
+  end
+end

data/plugins/project_search/lib/project_search/query.rb

@@ -0,0 +1,29 @@
+
+class ProjectSearch
+  class Query
+    attr_reader :query_string
+    
+    # Construct a 
+    #
+    #
+    def initialize(project, query_string, regex, match_case, context)
+      @project      = project
+      @query_string = query_string
+      @regex        = regex
+      @match_case   = match_case
+      @context      = context
+    end
+    
+    def match_case?
+      @match_case
+    end
+    
+    def context
+      @context
+    end
+    
+    def regex?
+      @regex
+    end
+  end
+end

data/plugins/project_search/lib/project_search/stylesheets/style.css

@@ -0,0 +1,279 @@
+* {
+  margin: 0;
+  padding: 0;
+  font-weight: normal;
+  font-size: 14px;
+  font-family: Myriad, Helvetica Neue, Sawasdee, Lucida Grande, sans-serif;
+}
+
+body {
+  background-color:#ddd;
+  font-size: 14px;
+}
+
+#search_form_container {
+  background-color: #eee;
+  width: 100%;
+  margin: -8px 0px 20px -40px;
+  padding: 16px 40px 10px 0;
+  border-bottom: 2px solid #ddd;
+  position: fixed;
+  top: 0;
+  left: 0;
+  -webkit-box-shadow: 0px 0px 10px rgba(0,0,0,.5);
+  -moz-box-shadow: 0px 0px 10px rgba(0,0,0,.5);
+  box-shadow: 0px 0px 10px rgba(0,0,0,.5);
+}
+
+#search_form_container table {
+  width: 100%;
+}
+
+#search_form_container table td {
+  padding: 3px 0;
+  vertical-align: top;
+  padding-left: 10px;
+}
+
+#search_form_container .input .label {
+  width: 100px;
+  text-align: right;
+}
+
+#search_form_container .input .field #query {
+  width: 100%;
+}
+
+#search_form_container .input .field input {
+  height: 25px;
+}
+
+#search_form_container .input .expand {
+  width: 100px;
+  padding: 3px 0px;
+}
+
+#search_form_container .input .expand #search {
+  width: 60px;
+  padding:0 4px;
+  font-size:11px;
+}
+
+#search_form_container .input .expand a {
+  background-color: #bcbcbc;
+  text-decoration: none;
+  display: block;
+  width: 20px;
+  height: 20px;
+  color: #d0d0d0;
+  border: 1px solid #b0b0b0;
+  font-size:12px;
+  text-align: center;
+  margin-top:1px;
+  margin-left:-3px;
+  z-index:9999;
+  -moz-border-radius-topright:4px;
+  -moz-border-radius-bottomright:4px;
+}
+
+#search_form_container .controls label {
+  font-size: 13px;
+  margin-right: 10px;
+}
+
+#search_form_container .controls #search,
+#search_form_container .controls #spinner {
+  float: right;
+}
+
+#search_form_container .controls #spinner {
+  margin-right: 7px;
+}
+
+#search_copy {
+  font-size:80%;
+  display:block;
+}
+
+#search {
+  float:right;
+  width:20%;
+}
+
+#recent_queries {
+  position: absolute;
+  top: 45px;
+  left: 124px;
+  right: 122px;
+  border: 1px solid #acacac;
+  background-color: #fff;
+  box-shadow:2px 3px 5px #bbb;
+  -moz-box-shadow:2px 3px 5px #ccc;
+}
+
+#recent_queries ul {
+  list-style: none;
+  height: 120px;
+  overflow: auto;
+}
+
+#recent_queries ul li {
+  padding: 3px 10px;
+}
+
+#recent_queries ul li:hover {
+  background-color: #EDEDED;
+  cursor: hand;
+}
+
+#results_container {
+  margin-top: 120px;
+  margin-bottom: 25px;
+}
+
+#no_results,
+#searching {
+  font-weight: bold;
+  font-size: 16px;
+  text-align: center;
+}
+
+#results {
+/*  padding: 0 10px 10px 10px;*/
+}
+
+#results table {
+  width: 100%;
+  padding: 0px;
+  margin: 0px;
+  border-spacing: 0px;
+}
+
+#results .filename,
+#results .line_num {
+  background-color: #eee;
+  padding: 3px 10px;
+  border-right:1px solid #ddd;
+}
+
+#results .even {
+  background-color: #F9F9F9;
+}
+
+#results .odd {
+  background-color: #fff;
+}
+
+#results .file_heading {
+/*  background-color: #ccc;*/
+  padding: 4px 4px 4px 12px;
+  font-weight: bold;
+  font-family: Myriad, Helvetica Neue, Sawasdee, Lucida Grande, sans-serif;
+  border-bottom: 1px dotted #aaa;
+}
+
+#results .file_heading img {
+  float: left;
+  margin-right: 2px;
+}
+
+#results .file_heading a {
+  font-weight: bold;
+}
+
+#results .line_num {
+  text-align: right;
+  padding: 0 5px;
+  min-width: 20px;
+  cursor: hand;
+}
+
+#results .divider .line_num {
+  cursor: default;
+  text-align: center;
+/*  background-color: #ddd;*/
+
+  color: #555;
+}
+
+#results .text {
+  padding: 3px 10px;
+  width: 100%;
+  cursor: pointer;
+}
+
+#results .divider .text {
+  cursor: default;
+  -moz-box-shadow:1px 1px 3px #bbb inset;
+}
+
+#results .text pre span {
+  background-color: #fff319;
+  border:1px solid #efda17;
+  box-shadow:1px 1px 1px #c49e28;
+  -moz-box-shadow:1px 1px 1px #c49e28;
+  border-radius:3px;
+  -moz-border-radius:3px;
+}
+
+#results .text pre span:hover {
+  padding: 1px 0;
+}
+
+#results .break {
+  height: 12px;
+}
+
+#results_summary {
+  position: fixed;
+  bottom: 0;
+  left: 0;
+  right: 0;
+  font-size: 1.5em;
+  -moz-border-radius: 4px;
+  opacity:0.5;
+}
+
+#results_summary:hover {
+  opacity:1.0;
+  cursor:pointer;
+}
+
+#results_summary .text {
+  width: 300px;
+  margin: 0 auto;
+  background-color: #eee;
+  border: 1px solid #ddd;
+  text-align: center;
+  border-top-left-radius: 1em;
+  border-top-right-radius: 1em;
+  padding: 3px 5px;
+}
+
+#files_nav {
+  text-align:left;
+}
+
+#files_nav a:link,#files_nav a:visited,#files_nav a:hover {
+  text-decoration:none;
+  color:#212121;
+}
+
+#files_nav a:hover {
+  background-color: #fff319;
+  border:1px solid #efda17;
+  font-weight: bold;
+  box-shadow:1px 1px 1px #c49e28;
+  -moz-box-shadow:1px 1px 1px #c49e28;
+  border-radius:3px;
+  -moz-border-radius:3px;
+}
+
+#files_nav_container {
+  max-height:300px;
+  overflow-y:scroll;
+}
+
+ul {
+  list-style-type: none;
+}