dryml-firemarker 0.0.8

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## Eclipse
+.loadpath
+.project

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 by Barquin International
+Designed and developed by Domizio Demichelis
+
+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,123 @@
+# Dryml FireMarker
+
+Adds DRYML markers viewable with FireMarker (a Firefox/Firebug extension)
+
+## Overview
+
+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.
+
+## 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.
+
+### 1.1 Requirements
+
+- Recent Firefox >= 3.6
+- Recent Firebug (I use the 1.7.1 but it might work on older versions too)
+
+### 1.2 Installation
+
+Download the latest compiled extension from:
+
+  https://github.com/ddnexus/firemarker/downloads
+
+Install in Firefox with Tools > Add-ons > Install Add-on From File...
+
+## 2. Dryml FireMarker (gem)
+
+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.
+
+### 2.1 Hobo 1.0.x and Hobo/Dryml 1.1.x
+
+#### Setup
+
+In the `environment.rb` file:
+
+    config.gem 'dryml-firemarker', :lib => '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:
+
+    <include plugin="dryml-firemarker"/>
+
+Notice that you must add it after the inclusion of the `rapid` taglib.
+
+#### Notes
+
+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.
+
+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.
+
+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).
+
+### 2.2. Hobo/Dryml >= 1.3
+
+Add just one line to the `Gemfile` file:
+
+    gem 'dryml-firemarker', :require => 'dryml13-firemarker', :group => :development
+
+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).
+
+## Mini Tutorial
+
+### Check list
+
+1. Install and setup the FF Extension component and the gem
+2. Start/restart the app
+3. Render any page in Firefox
+4. Open Firebug (F12)
+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
+
+### 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).
+
+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.
+
+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.
+
+If you want to save an edited file, just close it and FireMarker will ask if you want to save it.
+
+## TO DO
+
+Add "edit in external editor" feature to allow to open the dryml file in your preferred IDE.
+
+## Copyright
+
+Copyright (c) 2011 by Barquin International<br>
+Designed and developed by Domizio Demichelis<br>
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+name = 'dryml-firemarker'
+
+def ensure_clean(action, force=false)
+  if !force && ! `git status -s`.empty?
+    puts <<-EOS.gsub(/^ {6}/, '')
+      Rake task aborted: the working tree is dirty!
+      If you know what you are doing you can use \`rake #{action}[force]\`"
+    EOS
+    exit(1)
+  end
+end
+
+desc "Install the gem"
+task :install, :force do |t, args|
+  ensure_clean(:install, args.force)
+  orig_version = version = File.read('VERSION').strip
+  begin
+    commit_id = `git log -1 --format="%h" HEAD`.strip
+    version = "#{orig_version}.#{commit_id}"
+    File.open('VERSION', 'w') {|f| f.puts version }
+    gem_name = "#{name}-#{version}.gem"
+    sh %(gem build #{name}.gemspec)
+    sh %(gem install #{gem_name} --local --no-rdoc --no-ri)
+    puts <<-EOS.gsub(/^ {6}/, '')
+
+      *******************************************************************************
+      *                                   NOTICE                                    *
+      *******************************************************************************
+      * The version id of locally installed gems is comparable to a --pre version:  *
+      * i.e. it is alphabetically ordered (not numerically ordered), besides it     *
+      * includes the sah1 commit id which is not aphabetically ordered, so be sure  *
+      * your application picks the version you really intend to use                 *
+      *******************************************************************************
+
+    EOS
+  ensure
+    remove_entry_secure gem_name, true
+    File.open('VERSION', 'w') {|f| f.puts orig_version }
+  end
+end
+
+desc %(Remove all the "#{name}" installed gems and executables and install this version)
+task :clean_install, :force do |t, args|
+  ensure_clean(:install, args.force)
+  sh %(gem uninstall #{name} --all --ignore-dependencies --executables)
+  Rake::Task['install'].invoke(args.force)
+end
+
+desc "Push the gem to rubygems.org"
+task :push, :force do |t, args|
+  begin
+    ensure_clean(:push, args.force)
+    version = File.read('VERSION').strip
+    gem_name = "#{name}-#{version}.gem"
+    sh %(gem build #{name}.gemspec)
+    sh %(gem push #{gem_name})
+  ensure
+    remove_entry_secure gem_name, true
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.8

data/dryml-firemarker.gemspec

@@ -0,0 +1,25 @@
+name    = File.basename( __FILE__, '.gemspec' )
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+require 'date'
+
+Gem::Specification.new do |s|
+
+  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"]
+  s.email       = 'dd.nexus@gmail.com'
+  s.homepage    = "http://github.com/ddnexus/#{name}"
+
+  s.files       = `git ls-files -z`.split("\0")
+
+  s.name        = name
+  s.version     = version
+  s.date        = Date.today.to_s
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rdoc_options              = ["--charset=UTF-8"]
+  s.extra_rdoc_files          = ["README.md"]
+  s.require_paths             = ["lib"]
+
+end
+

data/lib/dryml-firemarker.dryml

@@ -0,0 +1,40 @@
+<!-- overrides rapid_core.dryml -->
+<!-- Renders some standard JavaScript code that various features of the Rapid library rely on. This tag would typicallu be called from your `<page>` tag. The default Rapid pages include this already. -->
+<def tag="hobo-rapid-javascripts">
+  <script type="text/javascript" param="default"><%=
+    res = 'var hoboParts = {};'
+    # FIXME: This should interrogate the model-router - not the models
+    unless Hobo::Model.all_models.empty?
+      # Tell JS code how to pluralize names, unless they follow the simple rule
+      names = Hobo::Model.all_models.map do |m|
+        m = m.name.underscore
+        "#{m}: '#{m.pluralize}'" unless m.pluralize == m + 's'
+      end.compact
+      res << "var pluralisations = {#{names * ', '}}; "
+    end
+    base = [base_url, subsite].compact.join("/")
+    res << "urlBase = '#{base}'; hoboPagePath = '#{view_name}'"
+    if protect_against_forgery?
+      res << "; formAuthToken = { name: '#{request_forgery_protection_token}', value: '#{form_authenticity_token}' }"
+    end
+    res
+  %></script>
+</def>
+
+<!-- adds tag in place of (undefined) method -->
+<def tag="part-contexts-javascripts">
+  <% unless (storage = part_contexts_storage).blank? %>
+    <script type="text/javascript"><%=
+        storage
+    %></script>
+  <% end %>
+</def>
+
+<!-- overrides rapid_pages.dryml -->
+<!-- Renderes dynamically generated JavaScript required by `hobo-rapid.js`, including the information required to perform automatic part updates -->
+<def tag="page-scripts">
+  <do param="default">
+    <hobo-rapid-javascripts/>
+    <part-contexts-javascripts/>
+  </do>
+</def>

data/lib/dryml-firemarker.rb

@@ -0,0 +1,45 @@
+require 'pathname'
+require 'rbconfig'
+
+module DrymlFireMarker
+
+  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)
+    keys            = [ ] # we need to keep track of the key order for ruby 1.8.x unordered hashes
+    metadata        = { }
+    metadata[kind]  = name
+    keys.push(kind)
+    path            = Pathname.new(template_path).realpath.to_s
+    writeable       = path.match(/^#{Regexp.quote(rails_root)}\//) &&
+                      ( auto_path.blank? ||! path.match(/^#{Regexp.quote(auto_path)}\//) )
+    path.gsub!(%r{/}, '\\\\\\\\') if WINDOZE # ridiculous escaping needed !!!
+    unless args.empty?
+      metadata['args'] = args.join(' | ')
+      keys.push('args')
+    end
+    metadata['path'] = path + ':' + line.to_s + (writeable ? '+' : '')
+    keys.push('path')
+    "{#{ keys.map{|k| k.inspect + ':' + metadata[k].inspect}.join(',') }}"
+  end
+
+  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
+  end
+
+  def self.rails_root
+    @rails_root ||= Object.const_defined?(:Rails) ? Rails.root.to_s : RAILS_ROOT
+  end
+
+end
+

data/lib/dryml-overrides.rb

@@ -0,0 +1,32 @@
+DRYML_METAINFO = RAILS_ENV == "development" unless Object.const_defined?( :DRYML_METAINFO )
+
+module DrymlRootModule
+
+  class TemplateEnvironment
+    undef_method :part_contexts_javascripts
+  end
+
+  if DRYML_METAINFO
+    class Template
+      def wrap_source_with_metadata(content, kind, name, line, *args)
+        return content if name.in?(NO_METADATA_TAGS)
+        json = DrymlFireMarker.metadata_to_json(@template_path, kind, name, line, *args)
+        "<!--[dryml]#{json}-->" + content + "<!--[/dryml]-->"
+      end
+    end
+  end
+
+  class Taglib
+    class << self
+      def taglib_filename_with_firemarker(options)
+        if options[:plugin] == "dryml-firemarker"
+          File.expand_path('../dryml-firemarker.dryml', __FILE__)
+        else
+          taglib_filename_without_firemarker(options)
+        end
+      end
+      alias_method_chain :taglib_filename, :firemarker
+    end
+  end
+
+end

data/lib/dryml10-firemarker.rb

@@ -0,0 +1,8 @@
+require 'hobo/dryml/template_environment'
+require 'hobo/dryml/template'
+require 'hobo/dryml/taglib'
+require 'dryml-firemarker'
+
+DrymlRootModule = Hobo::Dryml
+
+require 'dryml-overrides'

data/lib/dryml11_firemarker.rb

@@ -0,0 +1,10 @@
+require 'dryml'
+require 'dryml/template_environment'
+require 'dryml/template'
+require 'dryml/taglib'
+require 'dryml-firemarker'
+
+DrymlRootModule = Dryml
+
+require 'dryml-overrides'
+

data/lib/dryml13-firemarker.rb

@@ -0,0 +1,14 @@
+require 'dryml/template'
+require 'dryml-firemarker'
+
+module Dryml
+  class Template
+
+    def wrap_source_with_metadata(content, kind, name, line, *args)
+      return content if name.in?(NO_METADATA_TAGS)
+      json = DrymlFireMarker.metadata_to_json(@template_path, kind, name, line, *args)
+      "<% safe_concat(%(<!--[dryml]#{json}-->)) %>" + content + "<% safe_concat(%(<!--[/dryml]-->)) %>"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: dryml-firemarker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.8
+platform: ruby
+authors: 
+- Domizio Demichelis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+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: 
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- dryml-firemarker.gemspec
+- lib/dryml-firemarker.dryml
+- lib/dryml-firemarker.rb
+- lib/dryml-overrides.rb
+- lib/dryml10-firemarker.rb
+- lib/dryml11_firemarker.rb
+- lib/dryml13-firemarker.rb
+has_rdoc: true
+homepage: http://github.com/ddnexus/dryml-firemarker
+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 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Adds DRYML markers viewable with FireMarker
+test_files: []
+