marked 1.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem 'test-unit'
+  gem 'shoulda'
+  gem 'mocha'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jack Danger Canty
+
+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.markdown

@@ -0,0 +1,61 @@
+Marked
+=
+
+[http://github.com/JackDanger/marked](http://github.com/JackDanger/marked)
+
+DESCRIPTION
+==
+
+Ruby debugging often consists of printing out objects at various points in your code to inspect their current values. Do it fast and easy with Marked. the `mark()` method exists in global scope and always returns the values you pass into it, allowing your code to run as normal but giving you intermediate feedback.
+
+USAGE
+== 
+
+Before:
+
+    class User < ActiveRecord::Base
+      def some_method
+        complex_result
+      end
+    end
+
+How do you tell what the value of `complex_result` is inside this method?
+How do you tell if this method even ran?
+You write tests. Okay, but after that, if you're tracking down a bug?
+
+    class User < ActiveRecord::Base
+      def some_method
+        mark complex_result
+      end
+    end
+
+And you'll get the value of `complex_result` printed to your console and to the Rails log (if it exists)
+
+Can take multiple arguments, always returning the last:
+
+
+    class User < ActiveRecord::Base
+      def some_method
+        mark self, 'complex result: ', complex_result
+      end
+    end
+
+Also handles blocks smoothly, returning the block's result as if there were no block.
+
+    class User < ActiveRecord::Base
+      def some_method
+        mark self, 'complex result: ' do
+          complex_result
+        end
+      end
+    end
+
+
+
+INSTALL
+==
+
+    * gem install marked
+
+
+Copyright 2011 Jack Danger Canty. Patches welcome, forks celebrated

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "marked"
+    gem.summary = %Q{Fast debugging for Ruby. Output any objects or blocks to both Rails log and console output simultaneously}
+    gem.description = %Q{Quick Ruby debugger. Easily print any object or string to the console and to your logs while you're working.}
+    gem.email = "rubygems@6brand.com"
+    gem.homepage = "http://github.com/JackDanger/marked"
+    gem.authors = ["Jack Danger Canty"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << '.'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/marked.rb

@@ -0,0 +1,36 @@
+module Marked
+  def mark *objects
+
+    returnable = block_given? ? yield : objects.last
+
+    Marked.log "<MARK>"
+
+    if block_given?
+      Marked.print returnable
+      Marked.log   returnable
+    end
+
+    objects.each do |object|
+      Marked.print object
+      Marked.log   object
+    end
+
+    Marked.log "</MARK>"
+
+    returnable
+  end
+
+  def self.log object
+    if defined?(Rails)
+      Rails.logger.debug object.is_a?(String) ? object : object.inspect
+    end
+  end
+
+  def self.print object
+    STDOUT.puts object.is_a?(String) ? object : object.inspect
+  end
+end
+
+class Object
+  include Marked
+end

data/test/marked_test.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class MarkedTest < Test::Unit::TestCase
+  context "printing and logging a single argument" do
+    setup {
+      Rails.logger.expects(:debug).with("<MARK>")
+      Rails.logger.expects(:debug).with("this should be printed")
+      Rails.logger.expects(:debug).with("</MARK>")
+      Marked.expects(:print).with("this should be printed")
+    }
+    should "return its argument" do
+      assert_equal "this should be printed", mark("this should be printed")
+    end
+  end
+  context "printing and logging multiple arguments" do
+    setup {
+      Rails.logger.expects(:debug).with("<MARK>")
+      Rails.logger.expects(:debug).with("this should be printed")
+      Rails.logger.expects(:debug).with("this too")
+      Rails.logger.expects(:debug).with("</MARK>")
+      Marked.expects(:print).with("this should be printed")
+      Marked.expects(:print).with("this too")
+    }
+    should "return its last argument" do
+      assert_equal "this too", mark("this should be printed", "this too")
+    end
+  end
+  context "printing and logging non-strings" do
+    setup {
+      Marked.expects(:log).with("<MARK>")
+      Marked.expects(:log).with({:a =>'a'})
+      Marked.expects(:log).with([1, 2, 3])
+      Marked.expects(:log).with("</MARK>")
+      Marked.expects(:print).with({:a => 'a'})
+      Marked.expects(:print).with([1, 2, 3])
+    }
+    should "return its last argument as object" do
+      assert_equal [1,2,3], mark({:a => 'a'}, [1,2,3])
+    end
+  end
+  context "printing and logging blocks" do
+    setup {
+      @obj = {}
+      @obj.expects(:called!).returns('returned!').once
+      Rails.logger.expects(:debug).with("<MARK>")
+      Rails.logger.expects(:debug).with("first arg")
+      Rails.logger.expects(:debug).with("returned!")
+      Rails.logger.expects(:debug).with("</MARK>")
+      Marked.expects(:print).with("first arg")
+      Marked.expects(:print).with("returned!")
+    }
+    should "return its last argument as object" do
+      assert_equal 'returned!', mark('first arg') { @obj.called! }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require File.expand_path File.join(File.dirname(__FILE__), '..', 'lib', 'marked')
+require 'shoulda'
+require 'mocha'
+
+
+module Rails
+  Logger = {}
+  def self.logger
+    Logger
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: marked
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jack Danger Canty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Quick Ruby debugger. Easily print any object or string to the console and to your logs while you're working.
+email: rubygems@6brand.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/marked.rb
+- test/marked_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/JackDanger/marked
+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: Fast debugging for Ruby. Output any objects or blocks to both Rails log and console output simultaneously
+test_files: []
+