tm_helper 0.0.1

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2010 Capital Thought, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use any part of this software or its source code except
+in compliance with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,58 @@
+== tm_helper
+
+Some useful utilities for Ruby development in TextMate.
+
+== Features
+
+* Formats +puts+ output when running RSpec specs in TextMate using the RSpec TextMate bundle.
+  * Namely, it escapes HTML and converts +\n+ characters to +<br/>+.
+  * This is useful when using +puts+ to debug code while running specs in TextMate.
+* Supports forcing of logs to the Textmate window.
+  * Defining TM_SHOW_LOGS in your TextMate Preferences->Shell Variables will cause all logs issued using the Logger class be to redirected to the TextMate runner window.
+  * This is useful when you want to see your application's logs while running an RSpec spec in TextMate.
+
+== Installation
+
+Include tm_helper into your Gemfile.
+
+  gem 'tm_helper'
+
+== Usage
+
+Simply use +puts+ as you would normally.  Output will be automatically formatted when running in an RSpec window.
+
+Define TM_SHOW_LOGS in your TextMate Preferences->Shell Variables to cause Logger logs issued by your application be to redirected to the TextMate runner window.
+
+=== Advanced Usage
+
+To test whether your code is running in TextMate, use the +running_in_textmate?+ function:
+
+  if TmHelper.running_in_textmate? 
+    puts "I am running in TextMate."
+  end
+  
+To test whether your spec is being executed using the RSpec TextMate bundle, use the +running_rspec_bundle?+ function:
+
+  if TmHelper.running_rspec_bundle? 
+    puts "I am running in TextMate with the RSpec TextMate bundle loaded."
+  end
+  
+== NOTES
+
+== LICENSE
+
+  Copyright 2010 Capital Thought, LLC
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use any part of this software or its source code except
+  in compliance with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tm_helper"
+    gem.summary = %Q{Helper for Ruby development in TextMate.}
+    gem.description = %Q{}
+    gem.email = "billdoughty@capitalthought.com"
+    gem.homepage = "http://github.com/capitalthought/tm_helper"
+    gem.authors = ["shock"]
+    gem.add_development_dependency "activesupport", ">= 2.3.8"    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new( :spec ) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format progress'
+#  t.rcov = true
+end
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsBridge'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tm_helper/tm_helper.rb

@@ -0,0 +1,50 @@
+require 'cgi'
+require 'logger'
+
+module TmHelper
+  def self.convert_to_html string
+    CGI.escapeHTML(string).gsub("\n", "<br/>")
+  end
+  
+  def self.textmate_wrap string
+    if self.running_rspec_bundle?
+      self.convert_to_html string
+    else
+      string
+    end
+  end
+  
+  def self.running_in_textmate?
+    ENV["TM_PROJECT_DIRECTORY"] || ENV["TM_FILEPATH"]
+  end
+
+  def self.running_rspec_bundle?
+    defined? ::RSpec::Mate || defined? ::SpecMate
+  end
+end
+
+if TmHelper.running_in_textmate? && TmHelper.running_rspec_bundle?
+  module Kernel
+    alias :orig_puts :puts
+    def puts string
+      orig_puts TmHelper.convert_to_html( string ) + "<br/>"
+    end
+  end
+end
+  
+if TmHelper.running_in_textmate? && ENV["TM_SHOW_LOGS"]
+  require 'active_support/core_ext/logger'
+  class Logger
+    alias :orig_info :info
+    alias :orig_debug :debug
+    alias :orig_warn :warn
+    alias :orig_error :error
+    
+    def info string; puts TmHelper.textmate_wrap( string ); end
+    def debug string; puts TmHelper.textmate_wrap( string ); end
+    def warn string; puts TmHelper.textmate_wrap( string ); end
+    def error string; puts TmHelper.textmate_wrap( string ); end
+    
+  end
+end
+

data/lib/tm_helper.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'tm_helper', 'tm_helper')
+

data/tm_helper.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tm_helper}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["shock"]
+  s.date = %q{2010-12-31}
+  s.description = %q{}
+  s.email = %q{billdoughty@capitalthought.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tm_helper.rb",
+     "lib/tm_helper/tm_helper.rb",
+     "tm_helper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/capitalthought/tm_helper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Helper for Ruby development in TextMate.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<activesupport>, [">= 2.3.8"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: tm_helper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- shock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-31 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :development
+  version_requirements: *id001
+description: ""
+email: billdoughty@capitalthought.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tm_helper.rb
+- lib/tm_helper/tm_helper.rb
+- tm_helper.gemspec
+has_rdoc: true
+homepage: http://github.com/capitalthought/tm_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Helper for Ruby development in TextMate.
+test_files: []
+