coffee_trace 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Chris Aitchison
+
+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,45 @@
+Coffee Trace
+============
+
+A dead simple way to add trace logging to your coffeescript code... and then remove it when you're done.
+
+To install
+----------    
+    
+    gem install coffee_trace
+     
+To turn trace logging on
+----------------------------------
+    coffee_trace on
+
+Coffee Trace will find all .coffee files below your current directory and insert a log statement after every method it finds.
+     
+    class MyCoffee   
+      initialize: (arg1, arg2) ->
+        @doStuff()
+       
+      doStuff: ->
+        alert("ok")
+
+will become
+
+    class MyCoffee   
+      initialize: (arg1, arg2) ->
+        console.log "mycoffee-initialize", arg1, arg2 #coffee_trace
+        @doStuff()
+       
+      doStuff: ->
+        console.log "mycoffee-doStuff" #coffee_trace
+        alert("ok")
+
+To turn trace logging off
+----------------------------------       
+    coffee_trace off
+
+Coffee Trace will remove all log statements that it added to files below the current directory.
+
+***
+
+Copyright (c) 2011 Chris Aitchison. See LICENSE for details.
+    
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/coffee_trace

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require "rubygems" 
+require "thor"
+require "coffee_trace"
+
+class App < Thor
+  desc "on FILES", "Inserts trace logging into all .coffee files below the current directory"
+  def on
+    CoffeeTrace::CLI.new.insert_logging
+  end
+
+  desc "off", "Removes trace logging all .coffee files below the current directory"
+  def off
+    CoffeeTrace::CLI.new.remove_logging 
+  end
+  
+end
+
+App.start
+

data/coffee_trace.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "coffee_trace/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "coffee_trace"
+  gem.authors     = ["Chris Aitchison"]
+  gem.email       = ["cmaitchison@gmail.com"]
+  gem.homepage    = "https://github.com/cmaitchison/coffee_trace"
+  gem.summary     = %q{Add and remove trace logging to coffeescript}
+  gem.description = %q{Add and remove trace logging to coffeescript}
+
+  gem.version     = CoffeeTrace::VERSION
+  gem.platform    = Gem::Platform::RUBY
+
+  gem.add_runtime_dependency("thor", "~> 0.14.6")
+  gem.add_development_dependency("rspec", "~> 2.6.0")
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

data/lib/coffee_trace.rb

@@ -0,0 +1,7 @@
+require "coffee_trace/version"
+require "coffee_trace/insert_logging"
+require "coffee_trace/insert_log_statement"
+require "coffee_trace/cli"
+module CoffeeTrace
+  # Your code goes here...
+end

data/lib/coffee_trace/cli.rb

@@ -0,0 +1,34 @@
+module CoffeeTrace
+  class CLI
+
+    def initialize insert_logging=CoffeeTrace::InsertLogging.new
+      @insert_logging = insert_logging
+      @files = Dir.glob "**/*.coffee"
+    end
+
+    def insert_logging
+      @files.each do |file|
+	prefix =File.basename file, ".coffee"
+	result = @insert_logging.into File.readlines(file), prefix
+	write_lines file, result 
+      end
+    end
+
+    def remove_logging
+      @files.each do |file|
+	lines = @insert_logging.into File.readlines(file)
+        result = lines.select do |line|
+	  /console\.log.*#coffee_trace.*/.match(line).nil?
+	end
+	write_lines file, result
+      end
+    end
+
+    def write_lines(path, data)
+      File.open(path, "wb") do |file|
+        file.puts data
+      end
+    end
+  
+  end
+end

data/lib/coffee_trace/insert_log_statement.rb

@@ -0,0 +1,30 @@
+module CoffeeTrace
+  
+  class InsertLogStatement
+    
+    def for line, prefix=nil
+      leading_spaces, method_name, args = parse_function line
+      return unless leading_spaces
+      method_name = (prefix + "-" + method_name) if prefix 
+      result = "#{leading_spaces}  console.log '#{method_name}'"
+      result += ", #{args}" if args 
+      result += " #coffee_trace"
+      result 
+    end
+
+    private
+      
+    def parse_function line
+      no_arg_function_match = line.scan(/^( *)(\w+): * \(? *\)? *[-=]> *$/)
+      return parse_function_with_args(line) if no_arg_function_match.empty?
+      no_arg_function_match[0]
+    end
+
+    def parse_function_with_args line
+      arg_function_match = line.scan(/^( *)(\w+): *\((.*)\) *[-=]> *$/)
+      return if arg_function_match.empty?
+      return arg_function_match[0]
+    end
+  end
+
+end

data/lib/coffee_trace/insert_logging.rb

@@ -0,0 +1,22 @@
+module CoffeeTrace
+  class InsertLogging
+    
+    def initialize insert_log_statement=CoffeeTrace::InsertLogStatement.new
+      @insert_log_statement = insert_log_statement
+    end
+    
+    def into lines, prefix=nil
+      result = []
+      lines.each do |line|
+        result.pop if is_coffee_trace_log?(line)  
+	result << line
+	result << (@insert_log_statement.for line, prefix)
+      end
+      result.compact
+    end 
+
+    def is_coffee_trace_log? line
+      return true if /#coffee_trace$/.match line
+    end
+  end	
+end

data/lib/coffee_trace/version.rb

@@ -0,0 +1,3 @@
+module CoffeeTrace
+  VERSION = "0.0.2"
+end

data/spec/cli_spec.rb

@@ -0,0 +1,32 @@
+require 'coffee_trace'
+
+describe CoffeeTrace::CLI do
+
+  before do
+    @insert_logging = CoffeeTrace::InsertLogging.new
+    Dir.should_receive(:glob).with("**/*.coffee").and_return(["a.coffee","b.coffee"])
+    @cli = CoffeeTrace::CLI.new @insert_logging
+  end
+
+  it "inserts logging into each file" do
+    file1 = ["a","b"]
+    file2 = ["c","d"]
+    File.should_receive(:readlines).with("a.coffee").and_return(file1)
+    File.should_receive(:readlines).with("b.coffee").and_return(file2)
+    @insert_logging.should_receive(:into).with(file1,"a").and_return(["z","y"])
+    @insert_logging.should_receive(:into).with(file2,"b").and_return(["w","x"])
+    @cli.should_receive(:write_lines).with("a.coffee",["z","y"])
+    @cli.should_receive(:write_lines).with("b.coffee",["w","x"])
+    @cli.insert_logging
+  end
+
+  it "removes logging from each file" do
+    file1 = ["a","b","console.log blah #coffee_trace"]
+    file2 = ["c","console.log blahblah #coffee_trace", "d"]
+    File.should_receive(:readlines).with("a.coffee").and_return(file1)
+    File.should_receive(:readlines).with("b.coffee").and_return(file2)
+    @cli.should_receive(:write_lines).with("a.coffee",["a","b"])
+    @cli.should_receive(:write_lines).with("b.coffee",["c","d"])
+    @cli.remove_logging
+  end
+end

data/spec/insert_log_statement_spec.rb

@@ -0,0 +1,56 @@
+require 'coffee_trace'
+
+describe CoffeeTrace::InsertLogStatement do
+  
+  before do
+    @insert_log_statement = CoffeeTrace::InsertLogStatement.new
+  end
+
+  it "returns nil if line is not a function" do
+    assert "some code", nil
+    assert "  more code", nil 
+  end
+
+  it "returns a log statement for a function with no arguments" do
+    assert "  initialize: ->", "    console.log 'initialize' #coffee_trace"
+    assert "    render: ->", "      console.log 'render' #coffee_trace"
+  end
+
+  it "returns a log statement for a function with arguments" do
+    assert "  doStuff: (arg1, arg2, arg3) ->", "    console.log 'doStuff', arg1, arg2, arg3 #coffee_trace"
+  end
+
+  it "returns a correct log statement for a function with an empty arguments list" do
+    assert "  doStuff: () ->", "    console.log 'doStuff' #coffee_trace"
+  end
+
+  it "returns a log statement for a fat arrow function" do
+    assert "  doStuff: (arg1, arg2, arg3) =>", "    console.log 'doStuff', arg1, arg2, arg3 #coffee_trace"
+    assert "  initialize: =>", "    console.log 'initialize' #coffee_trace"
+    assert "  placeSelectedHandler: (e, placeId) =>", "    console.log 'placeSelectedHandler', e, placeId #coffee_trace"
+    assert "  renderPoi: (poi) =>", "    console.log 'renderPoi', poi #coffee_trace"
+  end
+
+
+  it "handles trailing spaces" do
+    assert "  initialize: -> ", "    console.log 'initialize' #coffee_trace"
+  end
+
+  it "adds a prefix if given" do
+    assert_with_prefix "  initialize: -> ","trace_logger","    console.log 'trace_logger-initialize' #coffee_trace"
+  end
+  it "indents correctly" do
+    assert "a: ->", "  console.log 'a' #coffee_trace"
+    assert "  a: ->", "    console.log 'a' #coffee_trace"
+    assert "    a: ->", "      console.log 'a' #coffee_trace"
+    assert "      a: ->", "        console.log 'a' #coffee_trace"
+  end
+  
+  def assert line, expected_value
+    @insert_log_statement.for(line).should == expected_value
+  end
+  
+  def assert_with_prefix line, prefix, expected_value
+    @insert_log_statement.for(line, prefix).should == expected_value
+  end
+end

data/spec/insert_logging_spec.rb

@@ -0,0 +1,30 @@
+require 'coffee_trace'
+
+describe CoffeeTrace::InsertLogging do
+ 
+  before do
+    @insert_log_statement = "insert_log_statement"
+    @insert_logging = CoffeeTrace::InsertLogging.new @insert_log_statement
+    @insert_log_statement.should_receive(:for).with("line1", "prefix").and_return(nil)
+    @insert_log_statement.should_receive(:for).with("line2", "prefix").and_return("prefix-log1")
+    @insert_log_statement.should_receive(:for).with("line3", "prefix").and_return(nil)
+    @insert_log_statement.should_receive(:for).with("line4", "prefix").and_return("prefix-log2")
+  end
+
+  it "inserts a logging line after each function" do
+    lines = ["line1", "line2", "line3","line4"]
+
+    result = @insert_logging.into lines, "prefix"
+    result.should == 
+      ["line1","line2","prefix-log1","line3","line4","prefix-log2"]
+  end
+
+  it "does not add a log statement for a method if it already has a coffee_trace log statement" do
+    lines = ["line1", "line2", "line3","line4","console.log #coffee_trace"]
+    @insert_log_statement.should_receive(:for).with("console.log #coffee_trace", "prefix").and_return(nil)
+    result = @insert_logging.into lines, "prefix"
+    result.should == 
+      ["line1","line2","prefix-log1","line3","line4","console.log #coffee_trace"]
+  end
+  
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: coffee_trace
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Chris Aitchison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-12 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: Add and remove trace logging to coffeescript
+email: 
+- cmaitchison@gmail.com
+executables: 
+- coffee_trace
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/coffee_trace
+- coffee_trace.gemspec
+- lib/coffee_trace.rb
+- lib/coffee_trace/cli.rb
+- lib/coffee_trace/insert_log_statement.rb
+- lib/coffee_trace/insert_logging.rb
+- lib/coffee_trace/version.rb
+- spec/cli_spec.rb
+- spec/insert_log_statement_spec.rb
+- spec/insert_logging_spec.rb
+has_rdoc: true
+homepage: https://github.com/cmaitchison/coffee_trace
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Add and remove trace logging to coffeescript
+test_files: 
+- spec/cli_spec.rb
+- spec/insert_log_statement_spec.rb
+- spec/insert_logging_spec.rb