RubyGems - rails_dt - Versions diffs - 0.1.4 → 1.2.0 - Mend

rails_dt 0.1.4 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

checksums.yaml +7 -0
data/.gitignore +16 -0
data/.yardopts +2 -0
data/Gemfile +14 -0
data/MIT-LICENSE +1 -1
data/README.md +43 -135
data/lib/dt.rb +31 -215
data/lib/dt/config.rb +74 -0
data/lib/dt/instance.rb +117 -0
data/lib/rails_dt.rb +3 -2
data/lib/rails_dt/version.rb +4 -0
data/rails_dt.gemspec +12 -50
data/spec/lib/dt/config_spec.rb +76 -0
data/spec/lib/dt/instance_spec.rb +173 -0
data/spec/lib/dt_spec.rb +14 -0
data/spec/lib/rails_dt_spec.rb +6 -0
data/spec/lib/spec/alias_method_matcher_spec.rb +16 -0
data/spec/lib/spec/context_when_spec.rb +32 -0
data/spec/lib/spec/let_m_spec.rb +104 -0
data/spec/lib/spec/use_custom_let_spec.rb +46 -0
data/spec/spec_helper.rb +6 -0
data/spec/support/00extend_x.rb +23 -0
data/spec/support/alias_method_matcher.rb +20 -0
data/spec/support/context_when.rb +39 -0
data/spec/support/let_m.rb +27 -0
data/spec/support/use_custom_let.rb +80 -0
metadata +43 -52
data/README.html +0 -171
data/Rakefile +0 -68
data/VERSION.yml +0 -4
data/generators/rails_dt/USAGE +0 -11
data/generators/rails_dt/WARNING +0 -2
data/generators/rails_dt/rails_dt_generator.rb +0 -9
data/generators/rails_dt/templates/INSTALL +0 -20
data/generators/rails_dt/templates/dt.css +0 -27
data/generators/rails_dt/templates/dt.rb +0 -4
data/init.rb +0 -2
data/lib/dt/action_controller_extensions.rb +0 -29
data/lib/generators/rails_dt/USAGE +0 -11
data/lib/generators/rails_dt/rails_dt_generator.rb +0 -9
data/lib/generators/rails_dt/templates/INSTALL +0 -20
data/lib/generators/rails_dt/templates/dt.css +0 -27
data/lib/generators/rails_dt/templates/dt.rb +0 -4

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 758529d91d7f145d04459c0c1d7b6226ce3c5930
+  data.tar.gz: 1e5173df99b36bc35fa87eafdd072c7b5bcdf85e
+SHA512:
+  metadata.gz: d86a581e0b288354b8e7159e56bd962e3270a5f92b8ebc474035eaabfd6bd3fa37a66501c03764d30e7280680b016e67ea430ba01297c87456bdc00609099396
+  data.tar.gz: ff96eb4fad398507f708c2bbe599969140e51a5bde1a9aa3db8dd20a627546d5377e09e667ecdd210e01420d53adbe7e6b804edd6a468623295a7825337bc08f

data/.gitignore ADDED

@@ -0,0 +1,16 @@
+# General Ruby, sorted by first letter.
+/.bundle/
+/doc/*
+/.rspec
+/vendor/bundle/
+/.yardoc/
+# Project-specific.
+/Gemfile.lock
+/log/
+# Bak/old/orig etc.
+*.old*
+*.orig
+/*.patch
+*.ref*

data/.yardopts ADDED

	@@ -0,0 +1,2 @@
1	+
2	+ --private

data/Gemfile ADDED

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+# Self.
+gem "rails_dt", path: (Pathname(__FILE__) + "..").realpath
+group :development do
+  gem "rspec"
+  # YARD and friends.
+  gem "rdoc"
+  gem "redcarpet"
+  gem "yard"
+end

data/MIT-LICENSE CHANGED

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Alex Fortuna
+Copyright (c) 2010-2017 Alex Fortuna
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED

@@ -1,162 +1,70 @@
-Rails Debug Toolkit
-===================
-Introduction
-------------
+Ruby/Rails debug toolkit
+========================
-`rails_dt` gem gives you `DT.p()` method you can use anywhere in your project to print your debug messages.
+`rails_dt` gem gives you the `DT.p()` method to print debug messages.
-It's somewhat similar to Ruby's native `p()` with output being sent to log, console and web.
-For example, `DT.p "Hello, world!"` invoked in `RootController` will give you a:
-    [DT app/controllers/root_controller.rb:3] Hello, world!
-The Ideas Behind It
--------------------
-* Debug message printer must **not require initialization**.
-* Debug message printer must be **nothing else**, but a debug message printer.
-* Debug message printer must be simple and invoked **always the same way** regardless of where you call it from.
-* Debug message printer calls must be **clearly visible** in the code.
-* Debug message printer must **print its location in code** so you can find and modify/remove it as easy as possible.
-Express Setup (Rails 3)
------------------------
+## Usage
 In your `Gemfile`, add:
-    gem "rails_dt"
-Then do a `bundle install`.
-This gives you an express (zero-conf) setup, which outputs messages to log, `log/dt.log` and console.
-Express Setup (Rails 2)
------------------------
-    $ gem sources --add http://rubygems.org
-    $ gem install rails_dt
-In your `config/environment.rb`, add:
-    config.gem "rails_dt"
-Setting Up Web Output (Both Rails 3 and Rails 2)
-------------------------------------------------
-In your application root, do a:
-    $ rails generate rails_dt     # Rails 3
-    $ script/generate rails_dt    # Rails 2
-Follow the instructions the generator gives you then. They are listed below.
-Inside your `ApplicationController` class, add:
-    handles_dt
-Inside your `app/views/layouts/application.html.erb` `<head>` section, add:
-    <%= stylesheet_link_tag "dt" %>
-Inside your `app/views/layouts/application.html.erb` `<body>` section, add:
-    <div class="DT">
-      <%= DT.web_messages_as_html %>
-    </div>
-Checking Setup
---------------
-Somewhere in your `app/views/layouts/application.html.erb`, add:
-    <% DT.p "hello, world!" %>
-Refresh the page. You should see "hello, world!":
-* In your application log.
-* In `log/dt.log`.
-* On the web page, if you've set it up (see above).
-Debugging...
-------------
-### ...Models ###
-    def before_save
-      DT.p "in before_save"
-    end
-### ...Controllers ###
-    def action
-      DT.p "hi, I'm #{action_name}"
-    end
-### ...Views ###
-    <div class="body">
-      <% DT.p "@users", @users %>
-    </div>
-### ...Filters ###
-Insert debugging code:
+```ruby
+gem "rails_dt", "git: https://github.com/dadooda/rails_dt.git"
+```
-    before_filter do
-      DT.p "in before_filter xyz"
-    end
+Now, in your code, do something like:
-    after_filter do
-      DT.p "in after_filter xyz"
-    end
+```ruby
+DT.p "checkpoint 1"
+DT.p "user", user
+```
-See it in action:
+Debug messages are printed to:
-    $ tail -f log/dt.log
+* `Rails.logger` in Rails mode (auto-detected);
+* `STDERR` in non-Rails mode;
+* `log/dt.log` if `log/` exists in project root and is writable.
-### ...Anything! ###
+This is often handy:
-Just use `DT.p` anywhere you want.
+```
+$ tail -f log/dt.log
+```
-Customizing Output Format
--------------------------
+## The ideas behind it
-Create a sample initializer, by doing a:
+1. Debug message printer **must not require initialization**.
+2. Debug message printer **must be nothing else**, but a debug message printer.
+3. Debug message printer **must be invoked the same way** regardless of place of invocation.
+4. Debug message printer calls **must be clearly visible** in code.
+5. Debug message printer **must print its location in code** so you can easily remove the call once debugging is over.
-    $ rails generate rails_dt     # Rails 3
-    $ script/generate rails_dt    # Rails 2
-In `config/initializers/dt.rb` you'll see something like:
+### A few out-of-the-box implementations review
-    # Customize your DT output.
-    #DT.log_prefix = "[DT <%= file_rel %>:<%= line %>] "
-    #DT.console_prefix = "[DT <%= file_rel %>:<%= line %>] "
-    #DT.web_prefix = '<a href="txmt://open?url=file://<%= file %>&line=<%= line %>"><%= file_rel %>:<%= line %></a> '
+Let me check a few popular out-of-the box implementation used by many of developers against "the ideas" items listed above.
-Uncomment and edit lines appropriately. Restart server for changes to take effect.
+`Rails.logger`:
-Values are in ERB format. The following macros are available:
+1. Fail. It only works in Rails. Rails requires initialization.
+2. (!) Fail. Logger is a production facility.
+3. So-so. It's not possible to use Rails logger to debug parts of Rails itself.
+4. (!) Fail. Debugging logger calls look the same as production logger calls.
+5. Fail. Location in code is not printed.
-* `file` -- full path to file.
-* `file_base` -- file base name.
-* `file_rel` -- file name relative to Rails application root.
-* `line` -- line number.
+`Kernel::p`:
-You can also disable particular output target by setting its prefix to `nil`:
+1. OK.
+2. OK.
+3. OK.
+4. So-so. `p` calls hide well among lines of meaningful code and it isn't always easy to spot them.
+5. Fail. Location in code is not printed.
-    DT.console_prefix = nil     # Disable console output.
+## Cheers!
-Feedback
---------
+Feedback of any kind is greatly appreciated.
-Send bug reports, suggestions and criticisms through [project's page on GitHub](http://github.com/dadooda/rails_dt).
+&mdash; Alex Fortuna, &copy; 2010-2017

data/lib/dt.rb CHANGED

@@ -1,227 +1,43 @@
-require "cgi"
-require "erb"
-Dir[File.join(File.dirname(__FILE__), "dt/**/*.rb")].each {|fn| require fn}
+require "logger"
+require "pathname"
-# Debug toolkit.
+# Ruby/Rails debug toolkit.
 #
-# Allows to print debug messages from anywhere in your Rails project. Do a:
+# Features:
 #
-#   DT.p "Hello, world!"
+# * As simple as possible.
+# * Suits Rails projects and stand-alone Ruby projects.
+# * Has none or minimal dependencies.
+# * Compatible with Ruby 1.9 and up.
 #
-# , and see the message in log, <tt>log/dt.log</tt>, console and web.
-#
-# To set up web output, in your application root do a:
-#
-#   $ rails generate rails_dt     # Rails 3
-#   $ script/generate rails_dt    # Rails 2
-#
-# Follow the instructions the generator gives you then.
-module DT   #:doc:
-  # Maximum number of stored messages, if they're not cleared.
-  # If web output is configured, messages are cleared before every request.
-  MAX_WEB_MESSAGES = 100
-  # Initializer.
-  def self._initialize    #:nodoc:
-    clear_web_messages
-    # NOTES:
-    # * Stuffing is inserted in order to work around buggy RDoc parser.
-    #   "a""bc" => "abc", just in case.
-    # * Don't forget to update generator/initializers/dt.rb with these.
-    # * "Canonical" order of imporance: log, console, web.
-    @log_prefix = "[DT <""%= file_rel %>:<""%= line %>] "
-    @console_prefix = @log_prefix.dup
-    @web_prefix = '<a href="txmt://open?url=file://<''%= file %>&line=<''%= line %>"><''%= file_rel %>:<''%= line %></a> '
-    # In case of path problems @log will be nil.
-    @log = Logger.new(Rails.root + "log/dt.log") rescue nil
-  end
-  # On-the-fly initializer.
-  def self._otf_init    #:nodoc:
-    # Consider job done, replace self with a blank.
-    class_eval {
-      def self._otf_init    #:nodoc:
-      end
-    }
-    _initialize
-  end
-  # Set message prefix for console. See <tt>log_prefix=</tt>.
-  def self.console_prefix=(s)
-    _otf_init
-    @console_prefix = s
-  end
-  def self.console_prefix
-    _otf_init
-    @console_prefix
-  end
-  # Set logger to use. Must be a <tt>Logger</tt>.
-  #
-  #   log = Logger.new("log/my.log")
-  def self.log=(obj)
-    _otf_init
-    raise "Logger expected, #{obj.class} given" if not obj.is_a? Logger
-    @log = obj
-  end
-  def self.log
-    _otf_init
-    @log
-  end
-  # Set message prefix for log. Syntax is ERB.
-  #
-  #   log_prefix = "[DT <""%= file_rel %>:<""%= line %>] "
-  #
-  # NOTE: In the above example some stuffing was made to satisfy the buggy RDoc parser.
-  # Just in case, <tt>"a""bc"</tt> is <tt>"abc"</tt> in Ruby.
-  #
-  # Template variables:
-  #
-  # * <tt>file</tt> -- full path to file.
-  # * <tt>file_base</tt> -- file base name.
-  # * <tt>file_rel</tt> -- file name relative to Rails application root.
-  # * <tt>line</tt> -- line number.
-  #
-  # By setting prefix to <tt>nil</tt> you disable respective output.
-  #
-  #   web_prefix = nil      # Disable web output.
-  def self.log_prefix=(s)
-    _otf_init
-    @log_prefix = s
-  end
-  def self.log_prefix
-    _otf_init
-    @log_prefix
-  end
-  # Return messages accumulated since last cleared.
-  def self.web_messages
-    _otf_init
-    @web_messages
-  end
-  # Set message prefix for web. See <tt>log_prefix=</tt>.
-  def self.web_prefix=(s)
-    _otf_init
-    @web_prefix = s
-  end
-  def self.web_prefix
-    _otf_init
-    @web_prefix
-  end
+# @see DT.p
+module DT
+  require_relative "dt/config"
+  require_relative "dt/instance"
-  #---------------------------------------
+  class << self
+    attr_writer :conf, :instance
-  # Clear messages.
-  def self.clear_web_messages
-    _otf_init
-    @web_messages = []
-  end
-  # Print a debug message or dump a value. Somewhat similar to Ruby's native <tt>p</tt>.
-  #
-  #   p "Hello, world!"
-  #   p "myvar", myvar
-  def self.p(*args)
-    _otf_init
-    # Fetch caller information.
-    # NOTE: May be lacking file information, e.g. when in an irb session.
-    file, line = caller.first.split(":")
-    # Assign template variables.
-    hc = {
-      :file => file,
-      :line => line,
-      :file_base => (begin; File.basename(file); rescue; file; end),
-      :file_rel => (begin; Pathname(file).relative_path_from(Rails.root).to_s; rescue; file; end),
-    }
-    args.each do |r|
-      s = r.is_a?(String) ? r : r.inspect
-      # To log.
-      if @log_prefix
-        ##Kernel.p "@log", @log   #DEBUG
-        if @log
-          pfx = ERB.new(@log_prefix, nil, "-").result(_hash_kbinding(hc))
-          msg = [pfx, s].join
-          @log.info msg
-          Rails.logger.info msg rescue nil    # In case something's wrong with `Rails.logger`.
-        end
-      end
-      # To console.
-      if @console_prefix
-        pfx = ERB.new(@console_prefix, nil, "-").result(_hash_kbinding(hc))
-        puts [pfx, s].join
-      end
-      # To web.
-      if @web_prefix
-        pfx = ERB.new(@web_prefix, nil, "-").result(_hash_kbinding(hc))
-        pcs = []
-        pcs << pfx
-        pcs << CGI.escapeHTML(s).gsub("\n", "<br/>\n")
-        @web_messages << pcs.join
-        # Rotate messages.
-        @web_messages.slice!(0..-(MAX_WEB_MESSAGES + 1))
-      end
+    # @return [Config]
+    def conf
+      @conf ||= Config.new
     end
-    # Be like `puts`, return nil.
-    nil
-  end
-  # Format accumulated web messages as HTML. Usually called from a view template.
-  #
-  #   web_messages_as_html    # => Something like "<ul><li>Message 1</li><li>Message 2</li>...</ul>".
-  def self.web_messages_as_html
-    _otf_init
-    pcs = []
-    pcs << "<ul>"
-    @web_messages.each do |s|
-      pcs << ["<li>", s, "</li>"].join
-    end
-    pcs << "</ul>"
-    if (out = pcs.join).respond_to? :html_safe
-      out.html_safe
-    else
-      out
+    # @return [Instance]
+    def instance
+      @instance ||= Instance.new
     end
-  end
-  #---------------------------------------
-  # NOTE: Singletons can't be private, so mark them syntactically.
-  # Turn hash's entries into locals and return binding.
-  # Useful for simple templating.
-  def self._hash_kbinding(h)    #:nodoc:
-    # NOTE: This IS important, since assignment is eval'd in this context.
-    bnd = binding
-    _value = nil
-    h.each do |k, v|
-      ##puts "-- k-#{k.inspect} v-#{_value.inspect}"    #DEBUG
-      _value = v      # IMPORTANT: Ruby 1.9 compatibility hack.
-      eval("#{k} = _value", bnd)
+    # Print a debug message, dump values etc.
+    #
+    #   DT.p "checkpoint 1"
+    #   DT.p "user", user
+    #
+    # @return [nil]
+    # @see Instance#_p
+    def p(*args)
+      instance._p(caller, *args)
     end
-    bnd
-  end
-  # DO NOT invoke `_initialize` load-time, it won't see Rails3 stuff.
-end # DT
+  end # class << self
+end