burek 0.5.2 → 0.5.3

data/README.md

@@ -0,0 +1,4 @@
+burek
+=====
+
+A ruby/rails gem for managing translations easy way.

data/lib/config.rb

@@ -17,4 +17,5 @@ module Burek
     raise 'Unknown config key!' unless @@config_hash.has_key? key
     @@config_hash[key]
   end
+  
 end

data/lib/core/burek_finder.rb

@@ -0,0 +1,56 @@
+require 'file_helpers'
+
+module Burek
+  module Finder
+
+    # Searches all files within search folders for burek calls.
+    #
+    # ==== Returns
+    # Hash in whichs values represent burek call captions and keys represent locales file paths in which
+    # those captions were found
+    #
+    def self.find_burek_calls_in_files
+      new_translations = {}
+      Burek::FileHelpers.open_each_file do |contents, file_name|      
+        filtered_path = filter_path(file_name)
+        matches = find_burek_calls(contents)
+        matches.each do |caption|
+          key = filtered_path + "/" + caption.downcase.gsub(' ','_')
+          new_translations[key] = caption
+        end
+      end
+      return new_translations
+    end
+
+
+    # Finds burek calls in a string
+    #
+    # ==== Attributes
+    # * +string+ - A string that (possibly) contains burek calls
+    #
+    # ==== Returns
+    # Array of burek call captions
+    #
+    def self.find_burek_calls(string)
+      string.scan(Burek::Core.burek_call_regex).flatten 
+    end
+
+    # Removes file extension from a path as well as any folder that is specified as ignored folder in config
+    #
+    # ==== Attributes
+    # * +file_name+ - path in string format that needs to be filtered
+    #
+    # ==== Returns
+    # Filtered path as a string
+    #
+    def self.filter_path(file_name)
+      path = file_name.split('/')
+      path.delete_if do |item|
+        Burek.config(:ignore_folders_for_key).include? item
+      end
+      path.last.gsub!(/\.(.*?)$/,'').gsub!(/^_/,'') #strip extenison from file name
+      return path.join('/')
+    end
+
+  end
+end

data/lib/core/burek_replacer.rb

@@ -0,0 +1,32 @@
+require 'file_helpers'
+require 'core/burek_finder'
+
+module Burek
+  module Replacer
+
+    def self.replace_burek_calls_in_files(to_replace)
+      Burek::FileHelpers.open_each_file do |content,file_name|      
+        processed_content = replace_burek_calls(content, to_replace)
+        unless processed_content.nil?
+          File.open(file_name, 'w') do |output_file|
+            output_file.print processed_content
+          end
+        end
+      end
+    end
+
+    def self.replace_burek_calls(contents, to_replace)
+      matches = Burek::Finder.find_burek_calls(contents)
+      changes_made = false
+      matches.each do |value|
+        if to_replace.has_key?(value)
+          contents.gsub!(Burek::Core.burek_call_regex(value)," t('#{to_replace[value]}')") 
+          changes_made = true
+        end
+      end
+
+      return contents if changes_made
+    end
+
+  end
+end

data/lib/core/core.rb

@@ -0,0 +1,43 @@
+require 'config'
+require 'yaml'
+require 'core/burek_replacer'
+require 'core/burek_finder'
+require 'core/locales_creator'
+require 'file_helpers'
+
+module Burek
+
+  module Core
+
+    # Main method in burek. It works in three steps:
+    #
+    # 1. find all burek calls within folders specified in config
+    # 2. add new translations to locales files
+    # 3. replace all burek calls with regular translation calls
+    #
+    def self.run_burek
+      Burek::FileHelpers.create_folder_if_missing Burek.config(:translations_path)
+
+      new_translations = Burek::Finder.find_burek_calls_in_files
+      to_replace = Burek::LocalesCreator.create_locales(new_translations)
+      Burek::Replacer.replace_burek_calls_in_files(to_replace)
+    end
+
+    # A regex for finiding burek calls
+    # 
+    # It is used by Burek::Finder and Burek::Replacer.
+    # Example calls it can find
+    # * burek('Hello world')
+    # * burek("Hello world")
+    # * burek ( "Hello world" )
+    #
+    # ==== Attributes
+    # * +caption+ - Use it to find burek call with specific caption.
+    #               By default it will accept any string and capture it in group named 'key'.
+    #
+    def self.burek_call_regex(caption="(?<key>[^\\)]*)")
+      Regexp.new("[^a-zA-Z0-9_]burek[ \\t]*\\([ \\t]*('|\")#{caption}\('|\")[^\\)]*\\)")
+    end
+    
+  end
+end

data/lib/core/locales_creator.rb

@@ -0,0 +1,114 @@
+module Burek
+  module LocalesCreator
+
+    # Creates new or updates exisitng locales files. Called by Burek::Finder
+    #
+    # ==== Attributes
+    # * +new_translations+ - A hash of new translations that were found in search folders.
+    #                        Values represent burek call captions and keys represent locales file paths in which those captions were found.
+    #
+    # ==== Returns
+    # A hash of burek calls that need to be replaced by translation calls.
+    # Keys contain captions of burek calls and values contain key which translation keys should contain.
+    #
+    def self.create_locales(new_translations)
+      to_replace = {}
+      # Create files for each locale
+      Burek.config(:locales).each do |locale|    
+        new_translations.each do |key,value|
+          path_parts = key.split("/")
+          item_name = path_parts.pop
+          path_parts_no_filename = path_parts[0..-2]
+
+          translation_file = key_to_file_path(key, locale)
+          translations_hash = initialize_translations_hash(translation_file, locale)
+
+          # Save info for replacing burek calls with translation calls.
+          # Keys are burek call captions and values are keys to be used in translation calls.
+          to_replace[value] = path_parts_to_key(path_parts_no_filename, item_name)
+
+          # Nest in hashes
+          cur_hash = translations_hash[locale.dup.force_encoding("UTF-8")]
+          path_parts_no_filename.each do |item|
+            cur_hash[item] = {} unless cur_hash.has_key?(item)
+            cur_hash = cur_hash[item]
+          end
+          cur_hash[item_name] = ( locale == Burek.config(:locales).first ? value.dup.force_encoding("UTF-8") : Burek.config(:translation_placeholder) )
+
+          # Save to file
+          Burek::LocalesCreator.translations_hash_to_file(translations_hash, translation_file)
+        end
+      end
+
+      return to_replace
+    end
+
+    # Stores a translation hash in to a file
+    #
+    def self.translations_hash_to_file(translations_hash, translation_file)
+      clean_yaml = yaml_to_i18n_file(translations_hash.to_yaml) 
+      translation_file.gsub!("//","/")
+      File.write(translation_file, clean_yaml) #Store
+    end
+
+    # Removes a first line from a yaml file which is added to standard YAML files
+    # but rails does not like it. It continas ---- or something like that
+    #
+    def self.yaml_to_i18n_file(yaml)
+      yaml.lines.to_a[1..-1].join
+    end
+  
+    # Intializes a translation hash by either loading existing translation file
+    # or creating a hash that contains an empty hash under key which is name of current locale.
+    def self.initialize_translations_hash(translation_file, locale)
+      if File.exists?(translation_file)
+        translations_hash = YAML::load_file(translation_file) #Load
+      else
+        translations_hash = {}
+        translations_hash[locale.dup.force_encoding("UTF-8")] = {} 
+      end
+      return translations_hash
+    end
+
+    # Creates a translation call key from path where burek call was found and burek call caption
+    #
+    def self.path_parts_to_key(path_parts, item_name)
+      regular_translation_key = path_parts.join('.') 
+      regular_translation_key += "." unless regular_translation_key.nil? || regular_translation_key.empty?
+      regular_translation_key += "#{item_name}"
+    end
+
+    # Generates a file path to locales file from a file path where burek call was found.
+    # It will nest locales file under same subfolders in which burek call was found.
+    # If burek call was nested deeper then defined as subfolder depth limit in config file
+    # it will nest it under first X folders (where x is subfolder depth limit)
+    #
+    # ==== Attributes
+    # * +key+ - file path where burek call was found
+    # * +locale+ - locale for which this file is created
+    #
+    # ==== Returns
+    # A string that contains a path where locale file should be created.
+    # NOTE: Even though subfolders are created, the actuall locale file is NOT created.
+    #
+    def self.key_to_file_path(key, locale)
+      path_parts = key.split("/")
+      path_parts.pop
+
+      translation_file = Burek.config(:translations_path) 
+      path_parts.each_with_index do |item, index|
+        if index == Burek.config(:subfolder_depth) || item == path_parts.last
+          translation_file += "#{item}.#{locale}.yml"
+          break
+        else
+          translation_file += "/#{item}/"
+          unless File.directory?(translation_file)
+            Dir.mkdir(translation_file)
+          end
+        end
+      end
+      return translation_file
+    end
+
+  end
+end

data/lib/file_helpers.rb

@@ -0,0 +1,28 @@
+module Burek
+  module FileHelpers
+
+     def self.open_each_file 
+      for_each_file do |file_name|      
+        File.open(file_name, "rb") do |file|
+          contents = file.read
+          yield contents, file_name
+        end
+      end
+    end
+
+    def self.for_each_file
+      Burek.config(:search_folders).each do |folder|
+        Dir.glob(folder) do |file_name|
+          unless File.directory?(file_name)
+             yield file_name
+          end
+        end
+      end
+    end
+
+    def self.create_folder_if_missing(path)
+      Dir.mkdir(path) unless File.directory?(path)
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: burek
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -17,12 +17,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- tasks/tasks.rb
 - lib/burek.rb
 - lib/config.rb
-- lib/core.rb
-- lib/parser.rb
-- lib/view_helpers.rb
-- tasks/tasks.rb
+- lib/core/burek_finder.rb
+- lib/core/burek_replacer.rb
+- lib/core/core.rb
+- lib/core/locales_creator.rb
+- lib/file_helpers.rb
+- lib/rails/view_helpers.rb
+- README.md
 homepage: https://github.com/dabrorius/burek
 licenses:
 - MIT

data/lib/core.rb

@@ -1,122 +0,0 @@
-require 'config'
-require 'yaml'
-
-module Burek
-
-  module Core
-
-    def self.key_to_file_path(key, locale)
-      path_parts = key.split("/")
-      path_parts.pop
-
-      translation_file = Burek.config(:translations_path) 
-      path_parts.each_with_index do |item, index|
-        if index == Burek.config(:subfolder_depth) || item == path_parts.last
-          translation_file += "#{item}.#{locale}.yml"
-          break
-        else
-          translation_file += "/#{item}/"
-          unless File.directory?(translation_file)
-            Dir.mkdir(translation_file)
-          end
-        end
-      end
-      return translation_file
-    end
-
-    def self.filter_path(file_name)
-      path = file_name.split('/')
-      path.delete_if do |item|
-        Burek.config(:ignore_folders_for_key).include? item
-      end
-      path.last.gsub!(/\.(.*?)$/,'').gsub!(/^_/,'') #strip extenison from file name
-      return path.join('/')
-    end
-
-    def self.run_burek
-      # Create translations folder if missing
-      unless File.directory?(Burek.config(:translations_path))
-        Dir.mkdir(Burek.config(:translations_path))
-      end
-
-      new_translations = {}
-      # Iterate all defined subfolders subfolders
-      for_each_file do |file_name|      
-        File.open(file_name, "rb") do |file|
-          contents = file.read
-
-          filtered_path = Burek::Core.filter_path(file_name)
-          matches = Burek::Parser.find_burek_calls(contents)
-          matches.each do |value|
-            key = filtered_path + "/" + value.downcase.gsub(' ','_')
-            new_translations[key] = value
-          end
-        end
-      end
-
-      to_replace = {}
-      # Create files for each locale
-      Burek.config(:locales).each do |locale|    
-        new_translations.each do |key,value|
-          path_parts = key.split("/")
-          item_name = path_parts.pop
-          path_parts_no_filename = path_parts[0..-2]
-
-          # Figure out file path
-          translation_file = Burek::Core.key_to_file_path(key, locale)
-
-          # Initialize translations hash
-          if File.exists?(translation_file)
-            translations_hash = YAML::load_file(translation_file) #Load
-          else
-            translations_hash = {}
-            translations_hash[locale.dup.force_encoding("UTF-8")] = {} 
-          end
-
-          # Save info for replacing burek calls with translation calls
-          regular_translation_key = path_parts_no_filename.join('.') + ".#{item_name}"
-          to_replace[value] = regular_translation_key
-
-          # Nest in hashes
-          cur_hash = translations_hash[locale.dup.force_encoding("UTF-8")]
-          path_parts_no_filename.each do |item|
-            cur_hash[item] = {} unless cur_hash.has_key?(item)
-            cur_hash = cur_hash[item]
-          end
-          cur_hash[item_name] = ( locale == Burek.config(:locales).first ? value.dup.force_encoding("UTF-8") : Burek.config(:translation_placeholder) )
-
-          # Save to file
-          clean_yaml = Burek::Parser.yaml_to_i18n_file(translations_hash.to_yaml) 
-          translation_file.gsub!("//","/")
-          File.write(translation_file, clean_yaml) #Store
-        end
-
-        
-      end
-
-      # Replace all burek calls with regular translation calls
-      for_each_file do |file_name|      
-        File.open(file_name, 'r') do |file|
-          content = file.read
-          processed_content = Burek::Parser.replace_burek_calls(content, to_replace)
-          unless processed_content.nil?
-            File.open(file_name, 'w') do |output_file|
-              output_file.print processed_content
-            end
-          end
-        end
-      end
-    end
-
-    def self.for_each_file
-      Burek.config(:search_folders).each do |folder|
-        Dir.glob(folder) do |file_name|
-          unless File.directory?(file_name)
-             yield file_name
-          end
-        end
-      end
-    end
-
-  end
-end

data/lib/parser.rb

@@ -1,33 +0,0 @@
-module Burek
-
-  module Parser
-
-    def self.find_burek_calls(string)
-      string.scan(burek_call_regex).flatten 
-    end
-
-    def self.replace_burek_calls(contents, to_replace)
-      matches = find_burek_calls(contents)
-      changes_made = false
-      matches.each do |value|
-        if to_replace.has_key?(value)
-          contents.gsub!(burek_call_regex(value)," t('#{to_replace[value]}')") 
-          changes_made = true
-        end
-      end
-
-      return contents if changes_made
-    end
-
-    def self.yaml_to_i18n_file(yaml)
-      yaml.lines.to_a[1..-1].join
-    end
-
-    private 
-
-    def self.burek_call_regex(caption="(?<key>[^\\)]*)")
-      Regexp.new("[^a-zA-Z0-9_]burek[ \\t]*\\([ \\t]*('|\")#{caption}\('|\")[^\\)]*\\)")
-    end
-
-  end
-end