ruby_on_etags 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+/tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby_on_etags.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    ruby_on_etags (0.0.1)
+      bundler (~> 1.0.0)
+      rake (~> 0.8.7)
+      watchr (~> 0.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    aruba (0.2.6)
+      background_process
+      cucumber (~> 0.9.4)
+    background_process (1.2)
+    builder (2.1.2)
+    columnize (0.3.2)
+    cucumber (0.9.4)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    term-ansicolor (1.0.5)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.2.6)
+  bundler (~> 1.0.0)
+  cucumber (~> 0.9.0)
+  rake (~> 0.8.7)
+  rspec (~> 2.1.0)
+  ruby-debug19 (~> 0.11.6)
+  ruby_on_etags!
+  watchr (~> 0.7)

data/README.rdoc

@@ -0,0 +1,42 @@
+== Ruby on ETags
+
+Ruby on ETags is a set of rake tasks to help a developer keep TAGS file up to
+date.
+
+== Installation
+
+  gem install ruby_on_etags
+
+Add the following to Rakefile:
+
+  require 'ruby_on_etags'
+  RubyOnEtags.install_tasks
+
+== Usage
+
+To build TAGS file which includes definitions of your project modules, all
+dependecies gems and ruby version you use, run the following:
+
+  rake ruby_on_etags:build
+
+This task maintain cache to avoid building tags for static files like gems or
+ruby sources.
+
+Also, you can use the following task to build TAGS everytime you change
+something in the project:
+
+  rake ruby_on_etags:watch
+
+== Maintainers
+
+* Aleksei Gusev (http://github.com/hron)
+
+== Bugs and Feedback
+
+If you discover any bugs, please create an issue on GitHub.
+
+http://github.com/hron/ruby_on_etags/issues
+
+== License
+
+MIT License. Copyright 2010 Aleksei Gusev.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = "features"
+end
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.skip_bundler = true
+end

data/features/ruby_project.feature

@@ -0,0 +1,29 @@
+Feature: Integration with any ruby project
+  As a developer I want to able to easy install Ruby On ETags
+  To have ability build TAGS with all ruby modules involved in a project
+
+  Scenario: Installing to use with rake
+    Given a standard ruby project directory structure
+    When I append to "Rakefile" with:
+      """
+      require 'ruby_on_etags'
+      RubyOnEtags.install_tasks
+      """
+    And I run "rake -T ruby_on_etags"
+    Then the output should contain:
+      """
+      rake ruby_on_etags:build  # Build TAGS for whole project.
+      rake ruby_on_etags:watch  # Watch for changes in project directory and build TAGS when needed.
+      """
+
+  Scenario: Building TAGS with rake
+    Given a standard ruby project directory structure
+    And Ruby On ETags is installed
+    When I run "rake ruby_on_etags:build"
+    Then a file named "TAGS" should exist
+    # project sources
+    And the file "TAGS" should contain "StandardRubyProject"
+    # ruby standard library
+    And the file "TAGS" should contain "Array"
+    # used gem
+    And the file "TAGS" should contain "RubyOnEtags"

data/features/step_definitions/custom_steps.rb

@@ -0,0 +1,28 @@
+Given /^a standard ruby project directory structure$/ do
+  steps %Q{
+    Given a file named "Rakefile" with:
+      """
+      require 'bundler'
+      Bundler.setup
+
+      """
+    And a file named "lib/standard_ruby_project.rb" with:
+      """
+      module StandardRubyProject
+      end
+      """
+  }
+  install_gems <<-G
+    gem 'ruby_on_etags', :path => '../..'
+  G
+end
+
+Given /^Ruby On ETags is installed$/ do
+  steps %Q{
+    When I append to "Rakefile" with:
+      """
+      require 'ruby_on_etags'
+      RubyOnEtags.install_tasks
+      """
+  }
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require 'aruba'
+
+ENV['RUBY_ON_ETAGS_CACHE'] = File.join("tmp", "ruby_on_etags_cache")
+
+Before do
+  FileUtils.rm_rf(ENV['RUBY_ON_ETAGS_CACHE'])
+  FileUtils.mkdir_p(ENV['RUBY_ON_ETAGS_CACHE'])
+  unset_bundler_env_vars
+  @aruba_timeout_seconds = 3
+end

data/lib/ruby_on_etags/version.rb

@@ -0,0 +1,3 @@
+module RubyOnEtags
+  VERSION = "0.0.1"
+end

data/lib/ruby_on_etags.rb

@@ -0,0 +1,106 @@
+require 'tempfile'
+require 'bundler'
+
+module RubyOnEtags
+
+  def install_tasks
+    Core.install_tasks
+  end
+  module_function :install_tasks
+
+  class Core
+
+    def self.install_tasks
+
+      namespace :ruby_on_etags do
+
+        desc "Build TAGS for whole project. GEMS='some_gem-1.0.0, another_gem-0.2.1'."
+        task :build do
+          self.new.build_tags
+        end
+
+        desc "Watch for changes in project directory and build TAGS when needed."
+        task :watch do
+          system "watchr -e 'watch(\"\.rb\") { system \"rake ruby_on_etags:build &>/dev/null\" }'"
+        end
+
+      end
+
+    end
+
+    def build_tags
+      remove_tags
+      tags_files = []
+      tags_files << build_tags_for_standard_library
+      tags_files += build_tags_for_gems
+      tags_files << build_tags_current_dir
+      concatenate_tags_files(tags_files)
+    end
+
+    def build_tags_for_gems
+      loaded_gems.map do |gem_spec|
+        tags_filename = File.join(cache_dir,
+                                  'gems',
+                                  "#{gem_spec.name}-#{gem_spec.version.version}",
+                                  'TAGS')
+        etags(gem_spec.load_paths.join(' '), tags_filename)
+        tags_filename
+      end
+    end
+
+    def build_tags_for_standard_library
+      File.join(cache_dir, 'rubies', RUBY_VERSION, 'TAGS').tap do |tags_filename|
+        dirs = $:.delete_if { |path| path =~ %r|/gems/| }
+        etags(dirs.join(' '), tags_filename)
+      end
+    end
+
+    def build_tags_current_dir
+      tags_file = Tempfile.new('ruby_on_etags-project-TAGS')
+      tags_file.close
+      etags(".", tags_file.path)
+      tags_file.path
+    end
+
+    def concatenate_tags_files(tags_files)
+      File.open("TAGS", 'w') do |tags|
+        tags_files.each do |tags_filename|
+          tags << IO.read(tags_filename)
+        end
+      end
+    end
+
+    def remove_tags
+      FileUtils.rm_f("TAGS")
+    end
+
+    def loaded_gems
+      File.exists?("Gemfile") ? Bundler.load.specs : []
+    end
+
+
+    private
+
+    def run(cmd)
+      system_with_rvm(cmd)
+    end
+
+    def system_with_rvm(cmd)
+      system "$SHELL -c 'cd .; #{cmd}'"
+    end
+
+    def etags(dirs, output)
+      if !File.exists?(output) || File.zero?(output)
+        FileUtils.mkdir_p(File.dirname(output))
+        run "etags -R -o #{output} #{dirs}"
+      end
+    end
+
+    def cache_dir
+      ENV['RUBY_ON_ETAGS_CACHE'] ||
+        File.join(ENV['HOME'], '.ruby_on_tags', 'cache')
+    end
+
+  end
+
+end

data/ruby_on_etags.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_on_etags/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_on_etags"
+  s.version     = RubyOnEtags::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aleksei Gusev"]
+  s.email       = ["aleksei.gusev@gmail.com"]
+  s.homepage    = "https://github.com/hron/dotfiles"
+  s.summary     = "Automatic generation of TAGS for all ruby modules a project use."
+  s.description = "Ruby on ETags is a set of rake tasks to help a developer keep TAGS file up to
+date."
+
+  s.rubyforge_project = "ruby_on_etags"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("cucumber", "~>0.9.0")
+  s.add_development_dependency("rspec", "~>2.1.0")
+  s.add_development_dependency("aruba", "~>0.2.6")
+  s.add_development_dependency("ruby-debug19", "~>0.11.6")
+
+  s.add_dependency("bundler", "~>1.0.0")
+  s.add_dependency("watchr", "~>0.7")
+  s.add_dependency("rake", "~>0.8.7")
+end

data/spec/lib/ruby_on_etags_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe RubyOnEtags do
+
+  subject { RubyOnEtags::Core.new }
+
+  it "should be able to detect paths of used gems with Bundler" do
+    unset_bundler_env_vars
+    install_gems <<-G
+      gem 'mechanize'
+      gem 'org-ruby'
+    G
+
+    in_current_dir do
+      should have(5).loaded_gems
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'ruby_on_etags'
+require 'aruba/api'
+
+RSpec.configure do |config|
+  config.include Aruba::Api
+end

data/tests.watchr

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+if __FILE__ == $0
+  puts "Run with: watchr #{__FILE__}. \n\nRequired gems: watchr rev"
+  exit 1
+end
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def system_with_rvm(cmd)
+  system "$SHELL -c 'cd .; #{cmd}'"
+end
+
+def run(cmd)
+  puts(cmd)
+  system_with_rvm(cmd)
+end
+
+def run_all_tests
+  run "rake SPEC_OPTS=\"--format progress\" spec && rake cucumber CUCUMBER_FORMAT='progress'"
+end
+
+def run_single_spec *spec
+  spec = spec.join(' ')
+  run "rspec --format documentation #{spec}"
+end
+
+def run_specs_with_shared_examples(shared_example_filename, spec_path = 'spec')
+
+  # Returns the names of the shared examples in filename
+  def shared_examples(filename)
+    lines = File.readlines(filename)
+    lines.grep(/shared_examples_for[\s'"]+(.+)['"]\s*[do|\{]/) do |matching_line|
+      $1
+    end
+  end
+
+  # Returns array with filenames of the specs using shared_example
+  def specs_with_shared_example(shared_example, path)
+    command = "grep -lrE 'it_should_behave_like .(#{shared_example}).' #{path}"
+    `#{command}`.split
+  end
+
+  shared_examples(shared_example_filename).each do |shared_example|
+    specs_to_run = specs_with_shared_example(shared_example, spec_path)
+    run_single_spec(specs_to_run) unless specs_to_run.empty?
+  end
+
+end
+
+def run_cucumber_scenario scenario_path
+  run "rake cucumber CUCUMBER_FORMAT=\"pretty\" FEATURE=#{scenario_path}"
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch( '^spec/spec_helper\.rb'                    ) {     run_all_tests }
+watch( '^spec/shared_behaviors/.*\.rb'            ) { |m| run_specs_with_shared_examples(m[0]) }
+watch( '^spec/.*_spec\.rb'                        ) { |m| run_single_spec(m[0]) }
+watch( '^app/(.*)\.rb'                            ) { |m| run_single_spec("spec/%s_spec.rb" % m[1]) }
+watch( '^app/views/(.*)\.haml'                    ) { |m| run_single_spec("spec/views/%s.haml_spec.rb" % m[1]) }
+watch( '^lib/(.*)\.rb'                            ) { |m| run_single_spec("spec/lib/%s_spec.rb" % m[1] ) }
+watch( '^features/.*\.feature'                    ) { |m| run_cucumber_scenario(m[0]) }
+
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-C
+Signal.trap('INT') do
+  puts "\n\n --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+# Ctrl-\
+Signal.trap('QUIT') { abort("\n") }
+
+puts "Погладь вотчр... ;]"

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification 
+name: ruby_on_etags
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Aleksei Gusev
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 6
+        version: 0.11.6
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: watchr
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id007
+description: |-
+  Ruby on ETags is a set of rake tasks to help a developer keep TAGS file up to
+  date.
+email: 
+- aleksei.gusev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- features/ruby_project.feature
+- features/step_definitions/custom_steps.rb
+- features/support/env.rb
+- lib/ruby_on_etags.rb
+- lib/ruby_on_etags/version.rb
+- ruby_on_etags.gemspec
+- spec/lib/ruby_on_etags_spec.rb
+- spec/spec_helper.rb
+- tests.watchr
+has_rdoc: true
+homepage: https://github.com/hron/dotfiles
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ruby_on_etags
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatic generation of TAGS for all ruby modules a project use.
+test_files: []
+