herbgobbler 0.1.0

data/lib/nodes/herb_node_retaining_text_node.rb

@@ -0,0 +1,107 @@
+class HerbNodeRetainingTextNode < HerbNodeRetainingNode
+  include TextNode
+
+  def add_all( nodes )
+    nodes.each do |node|
+      self << node
+    end
+  end
+  
+  def can_remove_starting_or_ending_html_tags?
+    if( find_first_non_whitespace_node.node_name == "html_start_tag" && find_last_non_whitespace_node.node_name == "html_end_tag"  )
+      if( find_first_non_whitespace_node.tag_name.text_value == find_last_non_whitespace_node.tag_name.text_value )
+        true
+      else
+        false
+      end
+    elsif( find_last_non_whitespace_node.node_name == "html_start_tag" || find_first_non_whitespace_node.node_name == "html_end_tag" )
+      true
+    else
+      false
+    end
+    
+  end
+
+  def break_out_start_and_end_tags
+    if( find_first_non_whitespace_node.node_name == "html_start_tag" && find_last_non_whitespace_node.node_name == "html_end_tag"  )
+( can_remove_starting_or_ending_html_tags? )
+      start_tag = extract_leading_tag
+      end_tag = extract_trailing_tag
+      middle_tag = HerbNodeRetainingTextNode.new
+      middle_tag.add_all( nodes[start_tag.nodes.length..nodes.length - (end_tag.nodes.length + 1 ) ] )
+      [start_tag, middle_tag, end_tag]
+    elsif(find_last_non_whitespace_node.node_name == "html_start_tag")
+      end_tag = extract_trailing_tag
+      start_tag = HerbNodeRetainingTextNode.new
+      start_tag.add_all( nodes[0..nodes.length - (end_tag.nodes.length + 1 ) ] )
+      [start_tag, end_tag]
+    elsif(find_first_non_whitespace_node.node_name == "html_end_tag" )
+      start_tag = extract_leading_tag
+      end_tag = HerbNodeRetainingTextNode.new
+      end_tag.add_all( nodes[start_tag.nodes.length..nodes.length ] )
+      [start_tag, end_tag]
+    else
+      [self]
+    end
+  end
+  
+  
+  def extract_text( text_extractor, node_tree )
+    self.nodes.each do |node|
+      if( node.is_a?( MethodCallNode ) )
+        node.extract_text( text_extractor, node_tree, self.nodes )
+      else
+        node.extract_text( text_extractor, node_tree )
+      end
+    end
+  end
+  
+  def can_be_combined?
+    true
+  end
+  
+  def to_s
+    @text_value
+  end  
+  
+  def find_first_non_whitespace_node
+    nodes.each do |node|
+      return node unless node.text_value.strip.empty?
+    end
+  end
+
+  def find_last_non_whitespace_node
+    nodes.reverse.each do |node|
+      return node unless node.text_value.strip.empty?
+    end
+  end
+
+
+  private
+
+  
+  def extract_leading_tag
+    node = find_first_non_whitespace_node
+    to_return = []
+    nodes.each do |current_node|
+      to_return << current_node
+      if( node == current_node )
+        return HerbNodeRetainingNonTextNode.create_from_nodes( to_return )
+      end
+    end
+  end
+
+  def extract_trailing_tag
+    node = find_last_non_whitespace_node
+    to_return = []
+    nodes.reverse.each do |current_node|
+      to_return << current_node
+      if( node == current_node )
+        return HerbNodeRetainingNonTextNode.create_from_nodes( to_return.reverse )
+      end
+    end
+    
+  end
+  
+  
+end

data/lib/nodes/herb_non_text_node.rb

@@ -0,0 +1,21 @@
+class HerbNonTextNode
+  include NonTextNode
+  attr_accessor :text_value
+  def initialize( text )
+    @text_value = text
+  end
+
+  def can_be_combined?
+    false
+  end
+
+  def node_name
+    "non_text_node"
+  end
+  
+  def to_s
+    @text_value
+  end
+  
+  
+end

data/lib/nodes/herb_string_variable.rb

@@ -0,0 +1,9 @@
+class HerbStringVariable < Treetop::Runtime::SyntaxNode
+  include TextNode
+  
+  def extract_text( text_extractor, node_tree )
+    text_extractor.add_variable( I18nKey.new( self.variable.text_value, get_key_hash(text_extractor, node_tree) ).to_s , self.variable.text_value )    
+  end
+  
+  
+end

data/lib/nodes/herb_text_node.rb

@@ -0,0 +1,23 @@
+class HerbTextNode
+  include TextNode
+  attr_accessor :text_value
+  
+  def initialize( text, strip_whitespace = true )
+    @text_value = text
+    @strip_whitespace = strip_whitespace
+  end
+
+  def can_be_combined?
+    true
+  end
+
+  def strip_whitespace?
+    @strip_whitespace
+  end
+  
+  def to_s
+    @text_value
+  end
+  
+  
+end

data/lib/nodes/herb_white_space_text_node.rb

@@ -0,0 +1,14 @@
+class HerbWhiteSpaceTextNode < HerbTextNode
+
+  def extract_text( text_extractor, node_tree )
+    text_extractor.white_space( self )
+  end
+  
+  def node_name
+    "herb_white_space_text_node"
+  end
+  
+  def white_space?
+    true
+  end
+end

data/lib/nodes/nodes.rb

@@ -0,0 +1,13 @@
+require 'nodes/herb_text_node'
+require 'nodes/herb_non_text_node'
+require 'nodes/herb_white_space_text_node'
+require 'nodes/herb_erb_text_call_node'
+require 'nodes/herb_combined_node'
+require 'nodes/herb_string_variable'
+require 'nodes/combindable_herb_non_text_node'
+require 'nodes/herb_node_retaining_node'
+require 'nodes/herb_node_retaining_text_node'
+require 'nodes/herb_node_retaining_node'
+require 'nodes/herb_node_retaining_text_node'
+require 'nodes/herb_node_retaining_non_text_node'
+require 'nodes/rails_text_variable_node'

data/lib/nodes/rails_text_variable_node.rb

@@ -0,0 +1,19 @@
+class RailsTextVariableNode
+  include TextNode
+  
+  def initialize( key, value )
+    @key = key
+    @value = value
+  end
+
+  def text_value
+    "%{#{@key}}"
+  end
+
+  def to_s
+    ":#{@key} => (#{@value})"
+  end
+  
+  
+end
+

data/scripts/display_syntax_tree.rb

@@ -0,0 +1,18 @@
+require 'lib/herbgobbler'
+
+
+file_name = ARGV.first
+erb_file = ErbFile.load( file_name )
+top_levels = erb_file.flatten_elements
+
+puts "---------- Original ----------------"
+puts File.read( file_name )
+puts "---------- Un-Combined Syntax Tree -------------"
+top_levels.each_with_index do |top_level, index|
+  puts "(#{index}): #{top_level.text_value}"
+end
+puts "---------- Combined Syntax Tree -------------"
+erb_file.combine_nodes( erb_file.flatten_elements ).each do |element|
+  puts "`#{element.text_value}`(text=#{element.is_a?(TextNode)})(combindable=#{element.is_a?(NonTextNode) && element.can_be_combined?})(class=#{element.class})"
+end
+

data/scripts/extract_text_from_erb.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'lib/herbgobbler'
+
+file_name = ARGV.first
+text_extractor = RailsTextExtractor.new
+erb_file = ErbFile.load( file_name )
+erb_file.extract_text( text_extractor )
+
+print erb_file.to_s
+
+
+

data/scripts/extract_yml_from_erb.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'lib/herbgobbler'
+
+file_name = ARGV.first
+rails_translation_store = RailsTranslationStore.new
+text_extractor = RailsTextExtractor.new( rails_translation_store )
+rails_translation_store.start_new_context( file_name.split('.').first )
+erb_file = ErbFile.load( file_name )
+erb_file.extract_text( text_extractor )
+
+print rails_translation_store.serialize
+

data/scripts/rails_gobble_file.rb

@@ -0,0 +1,37 @@
+require 'lib/herbgobbler'
+
+def print_usage
+  puts "ruby scripts/rails_gobble_file.rb <rails_root> <relative_erb_file_path> <locale_file_name>"
+end
+
+# remove the file extension and the app/views/ so that
+# when the context is set that rails will be able to find
+# it through the default . key syntax
+def convert_path_to_key_path( path )
+  path.split('.').first.gsub( "app/views/", '')  
+end
+
+if ARGV.length < 3
+  print_usage()
+else
+  rails_root = ARGV[0]
+  erb_file_path = ARGV[1]
+  locale_file_name = ARGV[2]
+  full_erb_file_path = "#{rails_root}/#{erb_file_path}"
+  full_yml_file_path = "#{rails_root}/config/locales/#{locale_file_name}"
+  
+  rails_translation_store = RailsTranslationStore.new
+  text_extractor = RailsTextExtractor.new( rails_translation_store )
+  rails_translation_store.start_new_context( convert_path_to_key_path( erb_file_path ) )
+  erb_file = ErbFile.load( full_erb_file_path )
+  erb_file.extract_text( text_extractor )
+
+  File.open(full_erb_file_path, 'w') {|f| f.write(erb_file.to_s) }
+  puts "Wrote #{full_erb_file_path}"
+  
+  File.open(full_yml_file_path, 'w') {|f| f.write(rails_translation_store.serialize) }
+  puts "Wrote #{full_yml_file_path}"
+end
+
+
+

data/scripts/save_result.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+test_to_save = ARGV.first
+test_name = test_to_save.split( '/' ).last
+
+`ruby scripts/extract_text_from_erb.rb #{test_to_save} > tests/integration/result/erb/#{test_name}.result`
+
+`ruby scripts/extract_yml_from_erb.rb #{test_to_save} > tests/integration/result/yml/#{test_name}.yml.result`
+
+puts "Wrote: tests/integration/result/erb/#{test_name}.result"
+puts "Wrote: tests/integration/result/yml/#{test_name}.yml.result"

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: herbgobbler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Douglas Sellers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: polyglot
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 4
+        - 8
+        version: 1.4.8
+  type: :runtime
+  version_requirements: *id003
+description: Allows english text extraction, for internationalization and localization, from Ruby on Rails ERB files
+email: douglas.sellers@gmail.com
+executables: 
+- gobble
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/gobble
+- lib/core/base_node.rb
+- lib/core/base_text_extractor.rb
+- lib/core/base_translation_store.rb
+- lib/core/core.rb
+- lib/core/double_quoted_text_node.rb
+- lib/core/erb_file.rb
+- lib/core/erb_string_non_text_content.rb
+- lib/core/i18n_key.rb
+- lib/core/ignorable_tag_node.rb
+- lib/core/method_call_node.rb
+- lib/core/node_processing.rb
+- lib/core/non_extracting_non_text_node.rb
+- lib/core/non_text_node.rb
+- lib/core/rails_text_extractor.rb
+- lib/core/rails_translation_store.rb
+- lib/core/text_extractor.rb
+- lib/core/text_node.rb
+- lib/herbgobbler.rb
+- lib/nodes/combindable_herb_non_text_node.rb
+- lib/nodes/herb_combined_node.rb
+- lib/nodes/herb_erb_text_call_node.rb
+- lib/nodes/herb_node_retaining_node.rb
+- lib/nodes/herb_node_retaining_non_text_node.rb
+- lib/nodes/herb_node_retaining_text_node.rb
+- lib/nodes/herb_non_text_node.rb
+- lib/nodes/herb_string_variable.rb
+- lib/nodes/herb_text_node.rb
+- lib/nodes/herb_white_space_text_node.rb
+- lib/nodes/nodes.rb
+- lib/nodes/rails_text_variable_node.rb
+- scripts/display_syntax_tree.rb
+- scripts/extract_text_from_erb.rb
+- scripts/extract_yml_from_erb.rb
+- scripts/rails_gobble_file.rb
+- scripts/save_result.rb
+- grammer/erb_grammer.treetop
+has_rdoc: true
+homepage: https://github.com/douglasjsellers/herbgobbler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Allows english text extraction, for internationalization and localization, from Ruby on Rails ERB files
+test_files: []
+