ctags_reader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9689fd7ce96e3dbd6933637c1747693dfa5510fd
+  data.tar.gz: 91ec113a5e0660b9228f1df560cc12edc554a408
+SHA512:
+  metadata.gz: 54202224751b723409202ea14fdd994ad7dc34a713b74216596270c75495a7df8f312730dd12933a8aa448c112aa2705d98e97c70eba2170af0855d1287d85df
+  data.tar.gz: b2bf7bfa87f3abd0c0c5933aea03ce92ff06fbc29ac8716ba79bd142818dc9af4996083c573b9a375cc5075017ecbc624e613cbbe89ef8c5d33e51587f1cd8a2

data/LICENSE

@@ -0,0 +1,5 @@
+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.md

@@ -0,0 +1,26 @@
+Ctags "tags" files provide a treasure trove of information on the locations of symbols in a project. Since ruby is such a strongly opinionated language, we can also make some educated guesses in order to get even more useful information out of it.
+
+For now, the project only reads the tags and provides a very simple interface to them, but in the future, more stuff may be added.
+
+## Usage
+
+``` ruby
+require 'ctags_reader'
+
+reader = CtagsReader.read('~/src/rails/tags')
+
+# Look for a direct match
+puts reader.find('Rails')
+
+# Get a single tag that starts with the given string
+puts reader.find('^Active')
+
+# Get all matching tags
+puts reader.find_all('^Active').shuffle.take(5)
+
+# Use Array#bsearch if available
+puts reader.fast_find('^Active')
+
+# Use some heuristics for advanced matching
+puts reader.find('ActionController::Metal#initialize')
+```

data/lib/ctags_reader.rb

@@ -0,0 +1,17 @@
+require 'ctags_reader/reader'
+
+module CtagsReader
+  # Convenience method to parse a tags file into a Reader object.
+  #
+  def self.read(filename)
+    Reader.new(filename)
+  end
+
+  # While the reader attempts to parse different formats of ctags, the
+  # .generate method generates ruby tags in the most convenient way for the
+  # reader.
+  #
+  def self.generate
+    system 'ctags --languages=ruby --excmd=number -R .'
+  end
+end

data/lib/ctags_reader/reader.rb

@@ -0,0 +1,125 @@
+require 'active_support/inflector/methods'
+require 'ctags_reader/tag'
+
+module CtagsReader
+  # A Reader can be initialized either with a file (or any IO stream), or with
+  # a filename. In the second case, the filename is opened in read-only mode
+  # and parsed for tags.
+  #
+  # Note that parsing is done immediately upon initialization.
+  #
+  class Reader
+    def initialize(file)
+      if file.is_a? String
+        @filename = File.expand_path(file)
+      else
+        @file = file
+      end
+
+      @tag_index = nil
+    end
+
+    def tag_index
+      parse if not @tag_index
+      @tag_index
+    end
+
+    def file(&block)
+      if @file
+        yield @file
+      else
+        File.open(@filename, 'r') do |file|
+          yield file
+        end
+      end
+    end
+
+    def names
+      @names ||= tag_index.keys
+    end
+
+    def tags
+      @tags ||= tag_index.values.flatten
+    end
+
+    def tag_count
+      tags.count
+    end
+
+    if [].respond_to?(:bsearch)
+      def fast_find(query)
+        if query.start_with?('^')
+          # drop the ^, look for a prefix
+          prefix = query[1..-1]
+          tags.bsearch { |tag| prefix <=> tag.name[0...prefix.length] }
+        else
+          # should be a direct match
+          (tag_index[query] || []).first
+        end
+      end
+    else
+      def fast_find(query)
+        find(query)
+      end
+    end
+
+    def find(query)
+      find_all(query).first
+    end
+
+    def find_all(query)
+      if query.include?('#')
+        class_name, method_name = query.split('#')
+        class_filenames = find_all(class_name).map(&:filename).uniq
+
+        find_all(method_name).select do |tag|
+          class_filenames.include?(tag.filename)
+        end
+      elsif query.include?('::')
+        filename = class_to_filename(query)
+        class_name = query.split('::').last
+
+        direct_find_all(class_name).select do |tag|
+          tag.filename =~ /#{filename}$/
+        end
+      else
+        direct_find_all(query)
+      end
+    end
+
+    def to_s
+      "#<CtagsReader::Reader:#{object_id} (#{tag_count} tags)>"
+    end
+
+    private
+
+    def class_to_filename(full_class_name)
+      ActiveSupport::Inflector.underscore(full_class_name) + '.rb'
+    end
+
+    def direct_find_all(query)
+      if query.start_with?('^')
+        # consider it a regex
+        pattern = Regexp.new(query)
+        tag_index.select { |name, tags| name =~ pattern }.map(&:last).flatten
+      else
+        # should be a direct match
+        tag_index[query] || []
+      end
+    end
+
+    def parse
+      @tag_index = {}
+
+      file do |handle|
+        handle.each_line do |line|
+          next if line.start_with?('!_TAG_')
+
+          tag = Tag.from_string(line)
+          @tag_index[tag.name] ||= []
+          @tag_index[tag.name] << tag
+        end
+      end
+    end
+  end
+end

data/lib/ctags_reader/tag.rb

@@ -0,0 +1,44 @@
+module CtagsReader
+  # The Tag is the representation of each tag in the tags file. It can be
+  # initialized manually by giving it its four components, but it can also be
+  # created from a tab-delimited line from the file.
+  #
+  class Tag < Struct.new(:name, :filename, :ex_command, :type)
+    def self.from_string(string)
+      name, filename, ex_command, type = string.split("\t")
+      new(name, filename, ex_command, type)
+    end
+
+    def line_number
+      @line_number ||= calculate_line_number
+    end
+
+    private
+
+    def calculate_line_number
+      if ex_command.to_i > 0
+        return ex_command.to_i
+      end
+
+      if not File.readable?(filename)
+        return 1
+      end
+
+      # remove wrapping / and /;"
+      pattern = ex_command.gsub(/^\//, '').gsub(/\/(;")?$/, '')
+      regex   = Regexp.new(pattern)
+
+      # try to find line number from file
+      File.open(filename, 'r') do |file|
+        index = 1
+        file.each_line do |line|
+          return index if line =~ regex
+          index += 1
+        end
+      end
+
+      # pattern wasn't found, fall back to line 1
+      return 1
+    end
+  end
+end

data/lib/ctags_reader/version.rb

@@ -0,0 +1,3 @@
+module CtagsReader
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: ctags_reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Radev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Ctags "tags" files provide a treasure trove of information on the locations
+      of symbols in a project. Since ruby is such a strongly opinionated
+      language, we can also make some educated guesses in order to get even more
+      useful information out of it.
+email:
+- andrey.radev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ctags_reader.rb
+- lib/ctags_reader/reader.rb
+- lib/ctags_reader/version.rb
+- lib/ctags_reader/tag.rb
+- LICENSE
+- README.md
+homepage: http://github.com/AndrewRadev/ctags_reader
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ctags_reader
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Read a ctags "tags" file and provide an interface to its information
+test_files: []