dryml-firemarker 0.0.8 → 0.0.9

data/README.md

@@ -7,19 +7,16 @@ Adds DRYML markers viewable with FireMarker (a Firefox/Firebug extension)
 Dryml FireMarker is a tool composed by 2 components:
 
 1. "FireMarker": a Firebug extension that graphically shows special markers embedded in any HTML page.
-2. "dryml-firemarker": a gem to use with Dryml/Hobo that simply marks (with FireMarker markers),
-specific parts of HTML with their related metainfo.
+2. "dryml-firemarker": a gem to use with Dryml/Hobo that simply marks (with FireMarker markers), specific parts of HTML with their related metainfo.
 
 ## 1. FireMarker (FF extension)
 
-FireMarker is an extension for Firebug that graphically shows special markers embedded in any HTML page. Its main
-benefit is that you can easily read the metainfo related to any specific part of the HTML by just hovering the
-mouse on the page-item. It also adds a few interactive features to Firebug and an inline file viewer/editor.
+FireMarker is an extension for Firebug that graphically shows special markers embedded in any HTML page. Its main benefit is that you can easily read the metainfo related to any specific part of the HTML by just hovering the mouse on the page-item. It also adds a few interactive features to Firebug and an inline file viewer/editor.
 
 ### 1.1 Requirements
 
 - Recent Firefox >= 3.6
-- Recent Firebug (I use the 1.7.1 but it might work on older versions too)
+- Recent Firebug
 
 ### 1.2 Installation
 
@@ -35,47 +32,49 @@ Dryml FireMarker is a ruby gem, so you can istall it as usual:
 
     $ [sudo] gem install dryml-firemarker
 
-Since Dryml is implemented in 3 different ways in Hobo 1.0.x, Dryml 1.1.x and Dryml >= 1.3,
-you must setup your app consistently with the dryml version it uses.
+Since Dryml is implemented in 3 different ways in Hobo 1.0.x, Dryml 1.1.x and Dryml >= 1.3, you must setup your app consistently with the dryml version it uses.
 
-### 2.1 Hobo 1.0.x and Hobo/Dryml 1.1.x
+### 2.1 Hobo 1.0.x and Hobo/Dryml 1.1.x Setup
 
-#### Setup
+In an initializer file:
 
-In the `environment.rb` file:
-
-    config.gem 'dryml-firemarker', :lib => 'dryml<version>-firemarker'
+    DRYML_METAINFO = RAILS_ENV == 'development'
+    require 'dryml<version>-firemarker'
 
 \<version\> is '10' for Hobo 1.0.x or '11' for Hobo/Dryml 1.1.x
 
-If you use the `rapid` taglib (i.e. Hobo) you have also to add a tag in the `views/auto/taglibs/application.dryml` file:
+You must set the `DRYML_METAINFO` in order to include the metainfo in the page.
 
-    <include plugin="dryml-firemarker"/>
+### 2.2. Hobo/Dryml >= 1.3 Setup
 
-Notice that you must add it after the inclusion of the `rapid` taglib.
+Add just one line to the `Gemfile` file:
 
-#### Notes
+    gem 'dryml-firemarker', :require => 'dryml13-firemarker', :group => :development
 
-If your app uses the `rapid` taglib, the gem for the 1.0.x and 1.1.x should be loaded in the regular `environment.rb`
-(i.e. not just in `development.rb`), since it fixes a few consolidated bugs coded in that taglib. Besides,
-you can safely load it in all environments, because - by default - it will add the matainfo to the page only in
-development mode, and will keep the fixes consistent in all environments.
+There are no bugs to fix in the Hobo/Dryml >= 1.3.0 version, so you don't need to set the `DRYML_METAINFO` in order to include the metainfo in the page. You can add or skip the metainfo by just adding or commenting out the previous statement (and restart the app).
 
-You can also force the inclusion or the skipping of the metainfo in the page, by setting the `DRYML_METAINFO`
-boolean constant just before the `config.gem 'dryml-firemarker',...` statement.
+### Notes
 
-If your application needs to override one of `hobo-rapid-javascripts`, `part-contexts-javascripts` or
-`page-scripts` helpers/tags, you must take into account that the tags that your application uses are defined in
-the `dryml-firemarker.dryml` taglib included in this gem (and not the same tags defined in the regular rapid taglib).
+With an initializer file you can ignore the file from version control, in order to avoid to impose its use to anybody else in your team.
 
-### 2.2. Hobo/Dryml >= 1.3
+If your app uses the `rapid` taglib, the gem for the 1.0.x and 1.1.x should be loaded in all environments, since it fixes a few consolidated bugs coded in that taglib. Besides, you can safely load it in all environments, because - by default - it will add the matainfo to the page only in development mode, and will keep the fixes consistent in all environments.
 
-Add just one line to the `Gemfile` file:
+There is no clean way to have a local only solution in Rails 3 when you changes the Gemfile, since you have to list all the gems in the Gemfile. If you are working with a team and don't want to impose your Gemfile to the rest of the team and if you are using git, you can use the `git update-index --assume-unchanged Gemfile` command after your change to the Gemfile (and eventually the Gemfile.lock, and git will not bother you as long as you will not change the file again.
 
-    gem 'dryml-firemarker', :require => 'dryml13-firemarker', :group => :development
+Notice that you must restart the app when you want to enable/disable the metainfo, since Hobo adds them at template-compilation time (i.e. it's not a limitation of the Dryml FireMarker gem), and since sometimes, some metainfo added to the HTML, may break some non standard tag or javascript, you can use 2 different applications running on 2 different ports: with and without the metainfo. You can load/skip the loading of Dryml FireMarker by using an ENV variable set at server launch:
+
+    # wrap the loading in the code
+    if ENV["DRYML_METAINFO"]
+      ...
+    end
+
+    # rails 2
+    $ export DRYML_METAINFO=true; script/server -p 3001
+
+    # rails 3
+    $ export DRYML_METAINFO=true; rails s -p 3001
 
-There are no bugs to fix in the Hobo/Dryml >= 1.3.0 version, so you can add or skip the metainfo by just
-adding or commenting out the previous statement (and restart the app).
+In the very rare case your application needs to override one of `hobo-rapid-javascripts`, `part-contexts-javascripts` or `page-scripts` helpers/tags, you must take into account that the tags that your application uses are defined in the `dryml-firemarker.dryml` taglib included in this gem (and not the same tags defined in the regular rapid taglib). The current implementation does not support that overriding, unless you also manually load the tag `<include plugin="dryml-firemarker"\>` right after the rapid tag inclusion in the application.dryml file.
 
 ## Mini Tutorial
 
@@ -88,27 +87,17 @@ adding or commenting out the previous statement (and restart the app).
 5. Select the "HTML" tab
 6. Uncheck "Show Comments" in the HTML tab menu
 7. Select the "Markers" tab in the Firebug HTML side panel
-8. Check "dryml" option in the Markers tab menuUsage
+8. Check "dryml" option in the Markers tab menu
 
 ### Usage
 
-Select any node in the HTML panel or click on the Firebug's inspect icon and hover the mouse on any part of the page,
-then click on it to select the node: the Markers panel will be populated with all the markers that include that
-specific node. They are listed from close to far. The closest are the most specific markers that wrap the selected
-node: e.g. an \<a\> tag that produces a specific link; the farest are the most general: e.g. a \<page\> tag that wraps
-the whole page (including the \<a\> tag listed at the beginning).
+Select any node in the HTML panel or click on the Firebug's inspect icon and hover the mouse on any part of the page, then click on it to select the node: the Markers panel will be populated with all the markers that include that specific node. They are listed from close to far. The closest are the most specific markers that wrap the selected node: e.g. an \<a\> tag that produces a specific link; the farest are the most general: e.g. a \<page\> tag that wraps the whole page (including the \<a\> tag listed at the beginning).
 
-Hovering up and down in the Markers list may be useful to understand what specific dryml statement is creating the
-specific highlighted part in the page and HTML source, and eventually helps to chose what to override. (Notice that
-invisible page-parts are highlighted only in the source and have a dimmed color.)
+Hovering up and down in the Markers list may be useful to understand what specific dryml statement is creating the specific highlighted part in the page and HTML source, and eventually helps to chose what to override. (Notice that invisible page-parts are highlighted only in the source and have a dimmed color.)
 
-You can open any dryml file (at the right line) by clicking on the path listed in the marker's table. You can close
-it by clicking on it again. If you hold the "Ctrl" or the "Alt" key while you click on a path,
-you will open the file in a new FF tab instead: that might be useful when you need to explore a large file.
+You can open any dryml file (at the right line) by clicking on the path listed in the marker's table. You can close it by clicking on it again. If you hold the "Ctrl" or the "Alt" key while you click on a path, you will open the file in a new FF tab instead: that might be useful when you need to explore a large file.
 
-The green paths (with an ending "+") are editable because they are application files,
-while the blue paths are just viewable, because they are libraries or auto-generated files that doesn't make sense to
-edit.
+The green paths (with an ending "+") are editable because they are application files, while the blue paths are just viewable because they are libraries or auto-generated files that doesn't make sense to edit. Note: if you installed hobo as a pplugin (version
 
 If you want to save an edited file, just close it and FireMarker will ask if you want to save it.
 

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/dryml-firemarker.gemspec

@@ -1,9 +1,9 @@
-name    = File.basename( __FILE__, '.gemspec' )
 version = File.read(File.expand_path('../VERSION', __FILE__)).strip
 require 'date'
 
 Gem::Specification.new do |s|
 
+  s.name        = 'dryml-firemarker'
   s.summary     = 'Adds DRYML markers viewable with FireMarker'
   s.description = 'Dryml FireMarker annotates the output of Hobo and Rails apps that use the DRYML templating system.',
   s.authors     = ["Domizio Demichelis"]
@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
 
   s.files       = `git ls-files -z`.split("\0")
 
-  s.name        = name
   s.version     = version
   s.date        = Date.today.to_s
 

data/lib/dryml-firemarker-shared-overrides.rb

@@ -0,0 +1,19 @@
+module DrymlFireMarker
+  module SharedOverrides
+
+    def compile_renderer_class_with_firemarker(*args)
+      taglibs = args.pop
+      taglibs << {:plugin => 'dryml-firemarker'}
+      args.push(taglibs)
+      compile_renderer_class_without_firemarker(*args)
+    end
+
+    def included(base)
+      base.class_eval do
+        alias_method_chain :compile_renderer_class, :firemarker
+        private :compile_renderer_class_with_firemarker, :compile_renderer_class_without_firemarker
+      end
+    end
+
+  end
+end

data/lib/dryml-firemarker.rb

@@ -1,13 +1,16 @@
 require 'pathname'
 require 'rbconfig'
+require 'dryml-firemarker-shared-overrides'
 
 module DrymlFireMarker
 
+  extend self
+
   VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
 
   WINDOZE = RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw32|windows/i
 
-  def self.metadata_to_json(template_path, kind, name, line, *args)
+  def metadata_to_json(template_path, kind, name, line, *args)
     keys            = [ ] # we need to keep track of the key order for ruby 1.8.x unordered hashes
     metadata        = { }
     metadata[kind]  = name
@@ -27,17 +30,13 @@ module DrymlFireMarker
 
   private
 
-  def self.auto_path
-    if @auto_path.nil?
-      @auto_path = Object.const_defined?(:Dryml) ?
-                       Dryml::DrymlGenerator.output_directory.to_s :
-                       Hobo::Dryml::DrymlGenerator::OUTPUT.to_s
-    else
-      @auto_path
-    end
+  def auto_path
+    @auto_path ||= Object.const_defined?(:Dryml) ?
+        Dryml::DrymlGenerator.output_directory.to_s :
+        Hobo::Dryml::DrymlGenerator::OUTPUT.to_s
   end
 
-  def self.rails_root
+  def rails_root
     @rails_root ||= Object.const_defined?(:Rails) ? Rails.root.to_s : RAILS_ROOT
   end
 

data/lib/dryml-overrides.rb

@@ -1,7 +1,7 @@
-DRYML_METAINFO = RAILS_ENV == "development" unless Object.const_defined?( :DRYML_METAINFO )
-
 module DrymlRootModule
 
+  include DrymlFireMarker::SharedOverrides
+
   class TemplateEnvironment
     undef_method :part_contexts_javascripts
   end

data/lib/dryml13-firemarker.rb

@@ -2,6 +2,9 @@ require 'dryml/template'
 require 'dryml-firemarker'
 
 module Dryml
+
+  include DrymlFireMarker::SharedOverrides
+
   class Template
 
     def wrap_source_with_metadata(content, kind, name, line, *args)

metadata

@@ -1,67 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dryml-firemarker
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.9
   prerelease: 
-  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - Domizio Demichelis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-06 00:00:00 -04:00
-default_executable: 
+date: 2011-11-10 00:00:00.000000000Z
 dependencies: []
-
-description: "[\"Dryml FireMarker annotates the output of Hobo and Rails apps that use the DRYML templating system.\", [\"Domizio Demichelis\"]]"
+description: ! '["Dryml FireMarker annotates the output of Hobo and Rails apps that
+  use the DRYML templating system.", ["Domizio Demichelis"]]'
 email: dd.nexus@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - dryml-firemarker.gemspec
+- lib/dryml-firemarker-shared-overrides.rb
 - lib/dryml-firemarker.dryml
 - lib/dryml-firemarker.rb
 - lib/dryml-overrides.rb
 - lib/dryml10-firemarker.rb
-- lib/dryml11_firemarker.rb
+- lib/dryml11-firemarker.rb
 - lib/dryml13-firemarker.rb
-has_rdoc: true
-homepage: http://github.com/ddnexus/dryml-firemarker
+homepage: http://github.com/ddnexus/Gem::Specification
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Adds DRYML markers viewable with FireMarker
 test_files: []
-
+has_rdoc: